playwright/packages/playwright-ct-react/registerSource.mjs

/**
 * 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 __pwReact from 'react';
import { createRoot as __pwCreateRoot } from 'react-dom/client';

/** @typedef {import('../playwright-ct-core/types/component').JsxComponentChild} JsxComponentChild */
/** @typedef {import('../playwright-ct-core/types/component').JsxComponent} JsxComponent */
/** @typedef {import('react').FunctionComponent} FrameworkComponent */

/** @type {Map<string, () => Promise<FrameworkComponent>>} */
const __pwLoaderRegistry = new Map();
/** @type {Map<string, FrameworkComponent>} */
const __pwRegistry = new Map();
/** @type {Map<Element, import('react-dom/client').Root>} */
const __pwRootRegistry = new Map();

/**
 * @param {Record<string, () => Promise<FrameworkComponent>>} components
 */
export function pwRegister(components) {
  for (const [name, value] of Object.entries(components))
    __pwLoaderRegistry.set(name, value);
}

/**
 * @param {any} component
 * @returns {component is JsxComponent}
 */
function isComponent(component) {
  return component.__pw_component_marker === true && component.kind === 'jsx';
}

/**
 * @param {JsxComponent | JsxComponentChild} component
 */
async function __pwResolveComponent(component) {
  if (!isComponent(component))
    return;

  let componentFactory = __pwLoaderRegistry.get(component.type);
  if (!componentFactory) {
    // Lookup by shorthand.
    for (const [name, value] of __pwLoaderRegistry) {
      if (component.type.endsWith(`_${name}`)) {
        componentFactory = value;
        break;
      }
    }
  }

  if (!componentFactory && component.type[0].toUpperCase() === component.type[0])
    throw new Error(`Unregistered component: ${component.type}. Following components are registered: ${[...__pwRegistry.keys()]}`);

  if (componentFactory)
    __pwRegistry.set(component.type, await componentFactory());

  if (component.children?.length)
    await Promise.all(component.children.map(child => __pwResolveComponent(child)));

  if (component.props)
    await __resolveProps(component.props);
}

/**
  * @param {Record<string, any>} props
  */
async function __resolveProps(props) {
  for (const prop of Object.values(props)) {
    if (Array.isArray(prop))
      await Promise.all(prop.map(child => __pwResolveComponent(child)));
    else if (isComponent(prop))
      await __pwResolveComponent(prop);
    else if (typeof prop === 'object' && prop !== null)
      await __resolveProps(prop);
  }
}

/**
 * @param {JsxComponentChild} child
 */
function __renderChild(child) {
  if (Array.isArray(child))
    return child.map(grandChild => __renderChild(grandChild));
  if (isComponent(child))
    return __pwRender(child);
  return child;
}

/**
  * @param {Record<string, any>} props
  */
function __renderProps(props) {
  const newProps = {};
  for (const [key, prop] of Object.entries(props)) {
    if (Array.isArray(prop))
      newProps[key] = prop.map(child => __renderChild(child));
    else if (isComponent(prop))
      newProps[key] = __renderChild(prop);
    else if (typeof prop === 'object' && prop !== null)
      newProps[key] = __renderProps(prop);
    else
      newProps[key] = prop;
  }
  return newProps;
}

/**
 * @param {JsxComponent} component
 */
function __pwRender(component) {
  const componentFunc = __pwRegistry.get(component.type);
  const props = __renderProps(component.props || {});
  const children = component.children?.map(child => __renderChild(child)).filter(child => {
    if (typeof child === 'string')
      return !!child.trim();
    return true;
  });
  const reactChildren = Array.isArray(children) && children.length === 1 ? children[0] : children;
  return __pwReact.createElement(componentFunc || component.type, props, reactChildren);
}

window.playwrightMount = async (component, rootElement, hooksConfig) => {
  if (component.kind !== 'jsx')
    throw new Error('Object mount notation is not supported');

  await __pwResolveComponent(component);
  let App = () => __pwRender(component);
  for (const hook of window.__pw_hooks_before_mount || []) {
    const wrapper = await hook({ App, hooksConfig });
    if (wrapper)
      App = () => wrapper;
  }

  if (__pwRootRegistry.has(rootElement)) {
    throw new Error(
        'Attempting to mount a component into an container that already has a React root'
    );
  }
  const root = __pwCreateRoot(rootElement);
  __pwRootRegistry.set(rootElement, root);
  root.render(App());

  for (const hook of window.__pw_hooks_after_mount || [])
    await hook({ hooksConfig });
};

window.playwrightUnmount = async rootElement => {
  const root = __pwRootRegistry.get(rootElement);
  if (root === undefined)
    throw new Error('Component was not mounted');

  root.unmount();
  __pwRootRegistry.delete(rootElement);
};

window.playwrightUpdate = async (rootElement, component) => {
  if (component.kind !== 'jsx')
    throw new Error('Object mount notation is not supported');

  await __pwResolveComponent(component);
  const root = __pwRootRegistry.get(rootElement);
  if (root === undefined)
    throw new Error('Component was not mounted');

  root.render(__pwRender(component));
};