/** * Copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // @ts-check // This file is injected into the registry as text, no dependencies are allowed. import * as React from 'react'; import { createRoot } from 'react-dom/client'; /** @typedef {import('../playwright-test/types/component').Component} Component */ /** @typedef {import('react').FunctionComponent} FrameworkComponent */ /** @type {Map} */ const registry = new Map(); /** @type {Map} */ const rootRegistry = new Map(); /** * @param {{[key: string]: FrameworkComponent}} components */ export function register(components) { for (const [name, value] of Object.entries(components)) registry.set(name, value); } /** * @param {Component} component */ function render(component) { if (typeof component !== 'object' || Array.isArray(component)) return component; let componentFunc = registry.get(component.type); if (!componentFunc) { // Lookup by shorthand. for (const [name, value] of registry) { if (component.type.endsWith(`_${name}`)) { componentFunc = value; break; } } } if (!componentFunc && component.type[0].toUpperCase() === component.type[0]) throw new Error(`Unregistered component: ${component.type}. Following components are registered: ${[...registry.keys()]}`); const componentFuncOrString = componentFunc || component.type; if (component.kind !== 'jsx') throw new Error('Object mount notation is not supported'); return React.createElement(componentFuncOrString, component.props, ...component.children.map(child => { if (typeof child === 'string') return child; return render(child); }).filter(child => { if (typeof child === 'string') return !!child.trim(); return true; })); } window.playwrightMount = async (component, rootElement, hooksConfig) => { let App = () => render(component); for (const hook of window.__pw_hooks_before_mount || []) { const wrapper = await hook({ App, hooksConfig }); if (wrapper) App = () => wrapper; } if (rootRegistry.has(rootElement)) { throw new Error( 'Attempting to mount a component into an container that already has a React root' ); } const root = createRoot(rootElement); rootRegistry.set(rootElement, root); root.render(App()); for (const hook of window.__pw_hooks_after_mount || []) await hook({ hooksConfig }); }; window.playwrightUnmount = async rootElement => { const root = rootRegistry.get(rootElement); if (root === undefined) throw new Error('Component was not mounted'); root.unmount(); rootRegistry.delete(rootElement); }; window.playwrightUpdate = async (rootElement, component) => { const root = rootRegistry.get(rootElement); if (root === undefined) throw new Error('Component was not mounted'); root.render(render(/** @type {Component} */ (component))); };