Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
fix(test): let registered loaders load files with unknown extensions (#43305)
Pavel Feldman8895397cde69
diff --git a/packages/playwright/src/transform/esmLoader.ts b/packages/playwright/src/transform/esmLoader.tsindex 97893201f4..7e85e4c5e4 100644--- a/packages/playwright/src/transform/esmLoader.ts+++ b/packages/playwright/src/transform/esmLoader.ts@@ -19,7 +19,7 @@ import url from 'url';import { addToCompilationCache, currentFileDepsCollector, serializeCompilationCache, startCollectingFileDeps, stopCollectingFileDeps } from './compilationCache';import { PortTransport } from './portTransport';-import { isStyleFile, resolveHook, setSingleTSConfig, setTransformConfig, shouldTransform, transformHook } from './transform';+import { hasTransformedExtension, isStyleFile, resolveHook, setSingleTSConfig, setTransformConfig, shouldTransform, transformHook } from './transform';import { fileIsModule } from '../util';// Before each import of the ESM module, a preflight request with the .esm.preflight extension is issued.@@ -83,6 +83,10 @@ async function load(moduleUrl: string, context: { format?: string }, defaultLoadconst originalModuleUrl = isPreflight ? moduleUrl.slice(0, -esmPreflightExtension.length) : moduleUrl;const originalFilename = isPreflight ? url.fileURLToPath(originalModuleUrl) : filename;+ // Bail for files that registered loaders should handle.+ if (!hasTransformedExtension(originalFilename))+ return defaultLoad(moduleUrl, context, defaultLoad);+const code = fs.readFileSync(originalFilename, 'utf-8');const transformed = transformHook(code, originalFilename, originalModuleUrl);diff --git a/packages/playwright/src/transform/esmLoaderSync.ts b/packages/playwright/src/transform/esmLoaderSync.tsindex 9de1fc7744..568327bebc 100644--- a/packages/playwright/src/transform/esmLoaderSync.ts+++ b/packages/playwright/src/transform/esmLoaderSync.ts@@ -18,7 +18,7 @@ import fs from 'fs';import url from 'url';import { currentFileDepsCollector } from './compilationCache';-import { isStyleFile, resolveHook, shouldTransform, transformHook } from './transform';+import { hasTransformedExtension, isStyleFile, resolveHook, shouldTransform, transformHook } from './transform';import { fileIsModule } from '../util';export function resolve(specifier: string, context: { parentURL?: string, conditions?: string[] | Set<string> }, nextResolve: Function) {@@ -70,8 +70,8 @@ export function load(moduleUrl: string, context: { format?: string, conditions?:if (isStyleFile(filename))return { format: 'commonjs', source: '', shortCircuit: true };- // Bail for node_modules.- if (!shouldTransform(filename))+ // Bail for node_modules and for files that registered loaders should handle.+ if (!shouldTransform(filename) || !hasTransformedExtension(filename))return nextLoad(moduleUrl, context);// A file reached via `require` is loaded as CommonJS. Files reached via `import` keep real ESM semantics.diff --git a/packages/playwright/src/transform/transform.ts b/packages/playwright/src/transform/transform.tsindex ae1d8a3c72..447178aae8 100644--- a/packages/playwright/src/transform/transform.ts+++ b/packages/playwright/src/transform/transform.ts@@ -229,6 +229,14 @@ export function shouldTransform(filename: string): boolean {return !cc.belongsToNodeModules(filename);}+const kTransformedExtensions = ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.mts', '.cjs', '.cts'];++// Files with other extensions are left to Node.js and the loaders registered by the user.+export function hasTransformedExtension(filename: string): boolean {+ const extension = path.extname(filename);+ return !extension || kTransformedExtensions.includes(extension);+}+export function transformHook(originalCode: string, filename: string, moduleUrl?: string): { code: string, serializedCache?: any } {const hasPreprocessor =process.env.PW_TEST_SOURCE_TRANSFORM &&@@ -352,7 +360,7 @@ function installCJSHooks() {addHook((code, filename) => {return transformHook(code, filename).code;- }, shouldTransform, ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.mts', '.cjs', '.cts']);+ }, shouldTransform, kTransformedExtensions);const extensions = (Module as any)._extensions;for (const ext of kStyleExtensions)diff --git a/tests/playwright-test/loader.spec.ts b/tests/playwright-test/loader.spec.tsindex 8b36bbcaf3..c3b3dd944a 100644--- a/tests/playwright-test/loader.spec.ts+++ b/tests/playwright-test/loader.spec.ts@@ -1244,19 +1244,37 @@ test('should load css imports as empty modules', async ({ runInlineTest }) => {expect(result.passed).toBe(1);});-test('should load css imports as empty modules in esm', async ({ runInlineTest }) => {+test('should load css imports as empty modules in esm', {+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/43295' },+}, async ({ runInlineTest }) => {const result = await runInlineTest({'package.json': `{ "type": "module" }`,'index.css': `body { color: red; }`,+ // Extensions Playwright does not transform are left to the loaders registered in the config.+ 'playwright.config.ts': `+ import { register } from 'node:module';+ register('./txt-loader.mjs', import.meta.url);+ export default {};+ `,+ 'txt-loader.mjs': `+ export async function load(url, context, nextLoad) {+ if (!url.endsWith('.txt'))+ return nextLoad(url, context);+ return { format: 'module', source: 'export default "hello"', shortCircuit: true };+ }+ `,+ 'hello.txt': `hello`,'a.test.ts': `import './index.css';import styles from './index.css';+ import text from './hello.txt';import { test, expect } from '@playwright/test';test('pass', async () => {expect(styles).toEqual({});+ expect(text).toBe('hello');});`,});