mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-14 21:53:35 +03:00
421 lines
15 KiB
TypeScript
421 lines
15 KiB
TypeScript
/**
|
|
* 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.
|
|
*/
|
|
|
|
import type { Suite } from 'playwright/types/testReporter';
|
|
import type { PlaywrightTestConfig as BasePlaywrightTestConfig, FullConfig } from 'playwright/test';
|
|
|
|
import type { InlineConfig, Plugin, ResolveFn, ResolvedConfig, UserConfig } from 'vite';
|
|
import type { TestRunnerPlugin } from '../../playwright/src/plugins';
|
|
import type { ComponentInfo } from './tsxTransform';
|
|
import type { AddressInfo } from 'net';
|
|
import type { PluginContext } from 'rollup';
|
|
import { debug } from 'playwright-core/lib/utilsBundle';
|
|
|
|
import fs from 'fs';
|
|
import path from 'path';
|
|
import { parse, traverse, types as t } from 'playwright/lib/transform/babelBundle';
|
|
import { stoppable } from 'playwright/lib/utilsBundle';
|
|
import { assert, calculateSha1 } from 'playwright-core/lib/utils';
|
|
import { getPlaywrightVersion } from 'playwright-core/lib/utils';
|
|
import { setExternalDependencies } from 'playwright/lib/transform/compilationCache';
|
|
import { collectComponentUsages, componentInfo } from './tsxTransform';
|
|
import { version as viteVersion, build, preview, mergeConfig } from 'vite';
|
|
|
|
const log = debug('pw:vite');
|
|
|
|
let stoppableServer: any;
|
|
const playwrightVersion = getPlaywrightVersion();
|
|
|
|
type CtConfig = BasePlaywrightTestConfig['use'] & {
|
|
ctPort?: number;
|
|
ctTemplateDir?: string;
|
|
ctCacheDir?: string;
|
|
ctViteConfig?: InlineConfig | (() => Promise<InlineConfig>);
|
|
};
|
|
|
|
const importReactRE = /(^|\n|;)import\s+(\*\s+as\s+)?React(,|\s+)/;
|
|
const compiledReactRE = /(const|var)\s+React\s*=/;
|
|
|
|
export function createPlugin(
|
|
registerSourceFile: string,
|
|
frameworkPluginFactory?: () => Promise<Plugin>): TestRunnerPlugin {
|
|
let configDir: string;
|
|
let config: FullConfig;
|
|
return {
|
|
name: 'playwright-vite-plugin',
|
|
|
|
setup: async (configObject: FullConfig, configDirectory: string) => {
|
|
config = configObject;
|
|
configDir = configDirectory;
|
|
},
|
|
|
|
begin: async (suite: Suite) => {
|
|
// We are going to have 3 config files:
|
|
// - the defaults that user config overrides (baseConfig)
|
|
// - the user config (userConfig)
|
|
// - frameworks overrides (frameworkOverrides);
|
|
|
|
const use = config.projects[0].use as CtConfig;
|
|
const baseURL = new URL(use.baseURL || 'http://localhost');
|
|
const relativeTemplateDir = use.ctTemplateDir || 'playwright';
|
|
|
|
// FIXME: use build plugin to determine html location to resolve this.
|
|
// TemplateDir must be relative, otherwise we can't move the final index.html into its target location post-build.
|
|
// This regressed in https://github.com/microsoft/playwright/pull/26526
|
|
const templateDir = path.join(configDir, relativeTemplateDir);
|
|
|
|
// Compose base config from the playwright config only.
|
|
const baseConfig: InlineConfig = {
|
|
root: configDir,
|
|
configFile: false,
|
|
define: {
|
|
__VUE_PROD_DEVTOOLS__: true,
|
|
},
|
|
css: {
|
|
devSourcemap: true,
|
|
},
|
|
build: {
|
|
outDir: use.ctCacheDir ? path.resolve(configDir, use.ctCacheDir) : path.resolve(templateDir, '.cache')
|
|
},
|
|
preview: {
|
|
https: baseURL.protocol.startsWith('https:'),
|
|
host: baseURL.hostname,
|
|
port: use.ctPort || Number(baseURL.port) || 3100
|
|
},
|
|
// Vite preview server will otherwise always return the index.html with 200.
|
|
appType: 'custom',
|
|
};
|
|
|
|
// Apply user config on top of the base config. This could have changed root and build.outDir.
|
|
const userConfig = typeof use.ctViteConfig === 'function' ? await use.ctViteConfig() : (use.ctViteConfig || {});
|
|
const baseAndUserConfig = mergeConfig(baseConfig, userConfig);
|
|
const buildInfoFile = path.join(baseAndUserConfig.build.outDir, 'metainfo.json');
|
|
|
|
let buildExists = false;
|
|
let buildInfo: BuildInfo;
|
|
|
|
const registerSource = await fs.promises.readFile(registerSourceFile, 'utf-8');
|
|
const registerSourceHash = calculateSha1(registerSource);
|
|
|
|
try {
|
|
buildInfo = JSON.parse(await fs.promises.readFile(buildInfoFile, 'utf-8')) as BuildInfo;
|
|
assert(buildInfo.version === playwrightVersion);
|
|
assert(buildInfo.viteVersion === viteVersion);
|
|
assert(buildInfo.registerSourceHash === registerSourceHash);
|
|
buildExists = true;
|
|
} catch (e) {
|
|
buildInfo = {
|
|
version: playwrightVersion,
|
|
viteVersion,
|
|
registerSourceHash,
|
|
components: [],
|
|
tests: {},
|
|
sources: {},
|
|
};
|
|
}
|
|
log('build exists:', buildExists);
|
|
|
|
const componentRegistry: ComponentRegistry = new Map();
|
|
// 1. Re-parse changed tests and collect required components.
|
|
const hasNewTests = await checkNewTests(suite, buildInfo, componentRegistry);
|
|
log('has new tests:', hasNewTests);
|
|
|
|
// 2. Check if the set of required components has changed.
|
|
const hasNewComponents = await checkNewComponents(buildInfo, componentRegistry);
|
|
log('has new components:', hasNewComponents);
|
|
|
|
// 3. Check component sources.
|
|
const sourcesDirty = !buildExists || hasNewComponents || await checkSources(buildInfo);
|
|
log('sourcesDirty:', sourcesDirty);
|
|
|
|
// 4. Update component info.
|
|
buildInfo.components = [...componentRegistry.values()];
|
|
|
|
const frameworkOverrides: UserConfig = { plugins: [] };
|
|
|
|
// React heuristic. If we see a component in a file with .js extension,
|
|
// consider it a potential JSX-in-JS scenario and enable JSX loader for all
|
|
// .js files.
|
|
if (hasJSComponents(buildInfo.components)) {
|
|
log('jsx-in-js detected');
|
|
frameworkOverrides.esbuild = {
|
|
loader: 'jsx',
|
|
include: /.*\.jsx?$/,
|
|
exclude: [],
|
|
};
|
|
frameworkOverrides.optimizeDeps = {
|
|
esbuildOptions: {
|
|
loader: { '.js': 'jsx' },
|
|
}
|
|
};
|
|
}
|
|
|
|
// We assume that any non-empty plugin list includes `vite-react` or similar.
|
|
if (frameworkPluginFactory && !baseAndUserConfig.plugins?.length)
|
|
frameworkOverrides.plugins = [await frameworkPluginFactory()];
|
|
|
|
// But only add out own plugin when we actually build / transform.
|
|
if (sourcesDirty)
|
|
frameworkOverrides.plugins!.push(vitePlugin(registerSource, templateDir, buildInfo, componentRegistry));
|
|
|
|
frameworkOverrides.build = {
|
|
target: 'esnext',
|
|
minify: false,
|
|
rollupOptions: {
|
|
treeshake: false,
|
|
input: {
|
|
index: path.join(templateDir, 'index.html')
|
|
},
|
|
},
|
|
sourcemap: true,
|
|
};
|
|
|
|
const finalConfig = mergeConfig(baseAndUserConfig, frameworkOverrides);
|
|
|
|
if (sourcesDirty) {
|
|
log('build');
|
|
await build(finalConfig);
|
|
await fs.promises.rename(`${finalConfig.build.outDir}/${relativeTemplateDir}/index.html`, `${finalConfig.build.outDir}/index.html`);
|
|
}
|
|
|
|
if (hasNewTests || hasNewComponents || sourcesDirty) {
|
|
log('write manifest');
|
|
await fs.promises.writeFile(buildInfoFile, JSON.stringify(buildInfo, undefined, 2));
|
|
}
|
|
|
|
for (const [filename, testInfo] of Object.entries(buildInfo.tests)) {
|
|
const deps = new Set<string>();
|
|
for (const componentName of testInfo.components) {
|
|
const component = componentRegistry.get(componentName);
|
|
component?.deps.forEach(d => deps.add(d));
|
|
}
|
|
setExternalDependencies(filename, [...deps]);
|
|
}
|
|
|
|
const previewServer = await preview(finalConfig);
|
|
stoppableServer = stoppable(previewServer.httpServer, 0);
|
|
const isAddressInfo = (x: any): x is AddressInfo => x?.address;
|
|
const address = previewServer.httpServer.address();
|
|
if (isAddressInfo(address)) {
|
|
const protocol = finalConfig.preview.https ? 'https:' : 'http:';
|
|
process.env.PLAYWRIGHT_TEST_BASE_URL = `${protocol}//${finalConfig.preview.host}:${address.port}`;
|
|
}
|
|
},
|
|
|
|
end: async () => {
|
|
if (stoppableServer)
|
|
await new Promise(f => stoppableServer.stop(f));
|
|
},
|
|
};
|
|
}
|
|
|
|
type BuildInfo = {
|
|
version: string,
|
|
viteVersion: string,
|
|
registerSourceHash: string,
|
|
sources: {
|
|
[key: string]: {
|
|
timestamp: number;
|
|
}
|
|
};
|
|
components: ComponentInfo[];
|
|
tests: {
|
|
[key: string]: {
|
|
timestamp: number;
|
|
components: string[];
|
|
}
|
|
};
|
|
};
|
|
|
|
type ComponentRegistry = Map<string, ComponentInfo>;
|
|
|
|
async function checkSources(buildInfo: BuildInfo): Promise<boolean> {
|
|
for (const [source, sourceInfo] of Object.entries(buildInfo.sources)) {
|
|
try {
|
|
const timestamp = (await fs.promises.stat(source)).mtimeMs;
|
|
if (sourceInfo.timestamp !== timestamp) {
|
|
log('source has changed:', source);
|
|
return true;
|
|
}
|
|
} catch (e) {
|
|
log('check source failed:', e);
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
async function checkNewTests(suite: Suite, buildInfo: BuildInfo, componentRegistry: ComponentRegistry): Promise<boolean> {
|
|
const testFiles = new Set<string>();
|
|
for (const project of suite.suites) {
|
|
for (const file of project.suites)
|
|
testFiles.add(file.location!.file);
|
|
}
|
|
|
|
let hasNewTests = false;
|
|
for (const testFile of testFiles) {
|
|
const timestamp = (await fs.promises.stat(testFile)).mtimeMs;
|
|
if (buildInfo.tests[testFile]?.timestamp !== timestamp) {
|
|
const components = await parseTestFile(testFile);
|
|
log('changed test:', testFile);
|
|
for (const component of components)
|
|
componentRegistry.set(component.fullName, component);
|
|
buildInfo.tests[testFile] = { timestamp, components: components.map(c => c.fullName) };
|
|
hasNewTests = true;
|
|
}
|
|
}
|
|
|
|
return hasNewTests;
|
|
}
|
|
|
|
async function checkNewComponents(buildInfo: BuildInfo, componentRegistry: ComponentRegistry): Promise<boolean> {
|
|
const newComponents = [...componentRegistry.keys()];
|
|
const oldComponents = new Map(buildInfo.components.map(c => [c.fullName, c]));
|
|
|
|
let hasNewComponents = false;
|
|
for (const c of newComponents) {
|
|
if (!oldComponents.has(c)) {
|
|
hasNewComponents = true;
|
|
break;
|
|
}
|
|
}
|
|
for (const c of oldComponents.values())
|
|
componentRegistry.set(c.fullName, c);
|
|
|
|
return hasNewComponents;
|
|
}
|
|
|
|
async function parseTestFile(testFile: string): Promise<ComponentInfo[]> {
|
|
const text = await fs.promises.readFile(testFile, 'utf-8');
|
|
const ast = parse(text, { errorRecovery: true, plugins: ['typescript', 'jsx'], sourceType: 'module' });
|
|
const componentUsages = collectComponentUsages(ast);
|
|
const componentNames = componentUsages.names;
|
|
const result: ComponentInfo[] = [];
|
|
|
|
traverse(ast, {
|
|
enter: p => {
|
|
if (t.isImportDeclaration(p.node)) {
|
|
const importNode = p.node;
|
|
if (!t.isStringLiteral(importNode.source))
|
|
return;
|
|
|
|
for (const specifier of importNode.specifiers) {
|
|
const specifierName = specifier.local.name;
|
|
const componentName = componentNames.has(specifierName) ? specifierName : [...componentNames].find(c => c.startsWith(specifierName + '.'));
|
|
if (!componentName)
|
|
continue;
|
|
if (t.isImportNamespaceSpecifier(specifier))
|
|
continue;
|
|
result.push(componentInfo(specifier, importNode.source.value, testFile, componentName));
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
return result;
|
|
}
|
|
|
|
function vitePlugin(registerSource: string, templateDir: string, buildInfo: BuildInfo, componentRegistry: ComponentRegistry): Plugin {
|
|
buildInfo.sources = {};
|
|
let moduleResolver: ResolveFn;
|
|
return {
|
|
name: 'playwright:component-index',
|
|
|
|
configResolved(config: ResolvedConfig) {
|
|
moduleResolver = config.createResolver();
|
|
},
|
|
|
|
async transform(this: PluginContext, content, id) {
|
|
const queryIndex = id.indexOf('?');
|
|
const file = queryIndex !== -1 ? id.substring(0, queryIndex) : id;
|
|
if (!buildInfo.sources[file]) {
|
|
try {
|
|
const timestamp = (await fs.promises.stat(file)).mtimeMs;
|
|
buildInfo.sources[file] = { timestamp };
|
|
} catch {
|
|
// Silent if can't read the file.
|
|
}
|
|
}
|
|
|
|
// Vite React plugin will do this for .jsx files, but not .js files.
|
|
if (id.endsWith('.js') && content.includes('React.createElement') && !content.match(importReactRE) && !content.match(compiledReactRE)) {
|
|
const code = `import React from 'react';\n${content}`;
|
|
return { code, map: { mappings: '' } };
|
|
}
|
|
|
|
const indexTs = path.join(templateDir, 'index.ts');
|
|
const indexTsx = path.join(templateDir, 'index.tsx');
|
|
const indexJs = path.join(templateDir, 'index.js');
|
|
const indexJsx = path.join(templateDir, 'index.jsx');
|
|
const idResolved = path.resolve(id);
|
|
if (!idResolved.endsWith(indexTs) && !idResolved.endsWith(indexTsx) && !idResolved.endsWith(indexJs) && !idResolved.endsWith(indexJsx))
|
|
return;
|
|
|
|
const folder = path.dirname(id);
|
|
const lines = [content, ''];
|
|
lines.push(registerSource);
|
|
|
|
for (const [alias, value] of componentRegistry) {
|
|
const importPath = value.isModuleOrAlias ? value.importPath : './' + path.relative(folder, value.importPath).replace(/\\/g, '/');
|
|
if (value.importedName)
|
|
lines.push(`const ${alias} = () => import('${importPath}').then((mod) => mod.${value.importedName + (value.importedNameProperty || '')});`);
|
|
else
|
|
lines.push(`const ${alias} = () => import('${importPath}').then((mod) => mod.default${value.importedNameProperty || ''});`);
|
|
}
|
|
|
|
lines.push(`pwRegister({ ${[...componentRegistry.keys()].join(',\n ')} });`);
|
|
return {
|
|
code: lines.join('\n'),
|
|
map: { mappings: '' }
|
|
};
|
|
},
|
|
|
|
async writeBundle(this: PluginContext) {
|
|
for (const component of componentRegistry.values()) {
|
|
const id = (await moduleResolver(component.importPath));
|
|
if (!id)
|
|
continue;
|
|
const deps = new Set<string>();
|
|
collectViteModuleDependencies(this, id, deps);
|
|
component.deps = [...deps];
|
|
}
|
|
},
|
|
};
|
|
}
|
|
|
|
function collectViteModuleDependencies(context: PluginContext, id: string, deps: Set<string>) {
|
|
if (!path.isAbsolute(id))
|
|
return;
|
|
const normalizedId = path.normalize(id);
|
|
if (deps.has(normalizedId))
|
|
return;
|
|
deps.add(normalizedId);
|
|
const module = context.getModuleInfo(id);
|
|
for (const importedId of module?.importedIds || [])
|
|
collectViteModuleDependencies(context, importedId, deps);
|
|
for (const importedId of module?.dynamicallyImportedIds || [])
|
|
collectViteModuleDependencies(context, importedId, deps);
|
|
}
|
|
|
|
function hasJSComponents(components: ComponentInfo[]): boolean {
|
|
for (const component of components) {
|
|
const extname = path.extname(component.importPath);
|
|
if (extname === '.js' || !extname && fs.existsSync(component.importPath + '.js'))
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|