/** * 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 { createApp, setDevtoolsHook, h } from 'vue'; /** @typedef {import('@playwright/test/types/component').Component} Component */ /** @typedef {import('vue').Component} FrameworkComponent */ /** @type {Map} */ const registry = new Map(); /** * @param {{[key: string]: FrameworkComponent}} components */ export function register(components) { for (const [name, value] of Object.entries(components)) registry.set(name, value); } const allListeners = []; /** * @param {Component | string} child * @returns {import('vue').VNode | string} */ function renderChild(child) { return typeof child === 'string' ? child : render(child); } /** * @param {Component} component * @returns {import('vue').VNode} */ function render(component) { if (typeof component === 'string') return component; /** * @type {import('vue').Component | string | undefined} */ let componentFunc = registry.get(component.type); if (!componentFunc) { // Lookup by shorthand. for (const [name, value] of registry) { if (component.type.endsWith(`_${name}_vue`)) { 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()]}`); componentFunc = componentFunc || component.type; const isVueComponent = componentFunc !== component.type; /** * @type {(import('vue').VNode | string)[]} */ const children = []; /** @type {{[key: string]: any}} */ const slots = {}; const listeners = {}; /** @type {{[key: string]: any}} */ let props = {}; if (component.kind === 'jsx') { for (const child of component.children || []) { if (typeof child !== 'string' && child.type === 'template' && child.kind === 'jsx') { const slotProperty = Object.keys(child.props).find(k => k.startsWith('v-slot:')); const slot = slotProperty ? slotProperty.substring('v-slot:'.length) : 'default'; slots[slot] = child.children.map(renderChild); } else { children.push(renderChild(child)); } } for (const [key, value] of Object.entries(component.props)) { if (key.startsWith('v-on:')) { const event = key.substring('v-on:'.length); if (isVueComponent) listeners[event] = value; else props[`on${event[0].toUpperCase()}${event.substring(1)}`] = value; } else { props[key] = value; } } } if (component.kind === 'object') { // Vue test util syntax. for (const [key, value] of Object.entries(component.options?.slots || {})) { if (key === 'default') children.push(value); else slots[key] = value; } props = component.options?.props || {}; for (const [key, value] of Object.entries(component.options?.on || {})) listeners[key] = value; } let lastArg; if (Object.entries(slots).length) { lastArg = slots; if (children.length) slots.default = children; } else if (children.length) { lastArg = children; } // @ts-ignore const wrapper = h(componentFunc, props, lastArg); allListeners.push([wrapper, listeners]); return wrapper; } /** * @returns {any} */ function createDevTools() { return { emit(eventType, ...payload) { if (eventType === 'component:emit') { const [, componentVM, event, eventArgs] = payload; for (const [wrapper, listeners] of allListeners) { if (wrapper.component !== componentVM) continue; const listener = listeners[event]; if (!listener) return; listener(...eventArgs); } } } }; } const appKey = Symbol('appKey'); const componentKey = Symbol('componentKey'); window.playwrightMount = async (component, rootElement, hooksConfig) => { const wrapper = render(component); const app = createApp({ render: () => wrapper }); setDevtoolsHook(createDevTools(), {}); for (const hook of /** @type {any} */(window).__pw_hooks_before_mount || []) await hook({ app, hooksConfig }); const instance = app.mount(rootElement); rootElement[appKey] = app; rootElement[componentKey] = wrapper; for (const hook of /** @type {any} */(window).__pw_hooks_after_mount || []) await hook({ app, hooksConfig, instance }); }; window.playwrightUnmount = async rootElement => { const app = /** @type {import('vue').App} */ (rootElement[appKey]); if (!app) throw new Error('Component was not mounted'); app.unmount(); }; window.playwrightRerender = async (rootElement, options) => { const component = rootElement[componentKey].component; if (!component) throw new Error('Component was not mounted'); for (const [key, value] of Object.entries(options.props || {})) component.props[key] = value; };