mirror of
https://github.com/microsoft/playwright.git
synced 2024-10-27 13:50:25 +03:00
fix(esm): make sure import from './foo.js' is supported (#13137)
Drive-by: migrate all @esm tests to esm.spec.ts.
This commit is contained in:
parent
bb90ab1471
commit
9420a53939
2
.github/workflows/tests_primary.yml
vendored
2
.github/workflows/tests_primary.yml
vendored
@ -99,7 +99,7 @@ jobs:
|
|||||||
DEBUG: pw:install
|
DEBUG: pw:install
|
||||||
- run: npm run build
|
- run: npm run build
|
||||||
- run: npx playwright install --with-deps
|
- run: npx playwright install --with-deps
|
||||||
- run: npm run ttest -- --grep=@esm
|
- run: npm run ttest -- esm.spec.ts
|
||||||
|
|
||||||
test_html_report:
|
test_html_report:
|
||||||
name: HTML Report
|
name: HTML Report
|
||||||
|
@ -99,25 +99,33 @@ export function resolveHook(filename: string, specifier: string): string | undef
|
|||||||
if (!isTypeScript)
|
if (!isTypeScript)
|
||||||
return;
|
return;
|
||||||
const tsconfig = loadAndValidateTsconfigForFile(filename);
|
const tsconfig = loadAndValidateTsconfigForFile(filename);
|
||||||
if (!tsconfig)
|
if (tsconfig) {
|
||||||
return;
|
for (const { key, values } of tsconfig.paths) {
|
||||||
for (const { key, values } of tsconfig.paths) {
|
const keyHasStar = key[key.length - 1] === '*';
|
||||||
const keyHasStar = key[key.length - 1] === '*';
|
const matches = specifier.startsWith(keyHasStar ? key.substring(0, key.length - 1) : key);
|
||||||
const matches = specifier.startsWith(keyHasStar ? key.substring(0, key.length - 1) : key);
|
if (!matches)
|
||||||
if (!matches)
|
continue;
|
||||||
continue;
|
for (const value of values) {
|
||||||
for (const value of values) {
|
const valueHasStar = value[value.length - 1] === '*';
|
||||||
const valueHasStar = value[value.length - 1] === '*';
|
let candidate = valueHasStar ? value.substring(0, value.length - 1) : value;
|
||||||
let candidate = valueHasStar ? value.substring(0, value.length - 1) : value;
|
if (valueHasStar && keyHasStar)
|
||||||
if (valueHasStar && keyHasStar)
|
candidate += specifier.substring(key.length - 1);
|
||||||
candidate += specifier.substring(key.length - 1);
|
candidate = path.resolve(tsconfig.absoluteBaseUrl, candidate.replace(/\//g, path.sep));
|
||||||
candidate = path.resolve(tsconfig.absoluteBaseUrl, candidate.replace(/\//g, path.sep));
|
for (const ext of ['', '.js', '.ts', '.mjs', '.cjs', '.jsx', '.tsx']) {
|
||||||
for (const ext of ['', '.js', '.ts', '.mjs', '.cjs', '.jsx', '.tsx']) {
|
if (fs.existsSync(candidate + ext))
|
||||||
if (fs.existsSync(candidate + ext))
|
return candidate;
|
||||||
return candidate;
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (specifier.endsWith('.js')) {
|
||||||
|
const resolved = path.resolve(path.dirname(filename), specifier);
|
||||||
|
if (resolved.endsWith('.js')) {
|
||||||
|
const tsResolved = resolved.substring(0, resolved.length - 3) + '.ts';
|
||||||
|
if (!fs.existsSync(resolved) && fs.existsSync(tsResolved))
|
||||||
|
return tsResolved;
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export function transformHook(code: string, filename: string, isModule = false): string {
|
export function transformHook(code: string, filename: string, isModule = false): string {
|
||||||
|
126
tests/playwright-test/esm.spec.ts
Normal file
126
tests/playwright-test/esm.spec.ts
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
/**
|
||||||
|
* 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 { test, expect } from './playwright-test-fixtures';
|
||||||
|
|
||||||
|
// Note: tests from this file are additionally run on Node16 bots.
|
||||||
|
|
||||||
|
test('should load nested as esm when package.json has type module', async ({ runInlineTest }) => {
|
||||||
|
const result = await runInlineTest({
|
||||||
|
'playwright.config.js': `
|
||||||
|
//@no-header
|
||||||
|
import * as fs from 'fs';
|
||||||
|
export default { projects: [{name: 'foo'}] };
|
||||||
|
`,
|
||||||
|
'package.json': JSON.stringify({ type: 'module' }),
|
||||||
|
'nested/folder/a.esm.test.js': `
|
||||||
|
const { test } = pwt;
|
||||||
|
test('check project name', ({}, testInfo) => {
|
||||||
|
expect(testInfo.project.name).toBe('foo');
|
||||||
|
});
|
||||||
|
`
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.exitCode).toBe(0);
|
||||||
|
expect(result.passed).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('should import esm from ts when package.json has type module in experimental mode', async ({ runInlineTest }) => {
|
||||||
|
// We only support experimental esm mode on Node 16+
|
||||||
|
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
||||||
|
const result = await runInlineTest({
|
||||||
|
'playwright.config.ts': `
|
||||||
|
import * as fs from 'fs';
|
||||||
|
export default { projects: [{name: 'foo'}] };
|
||||||
|
`,
|
||||||
|
'package.json': JSON.stringify({ type: 'module' }),
|
||||||
|
'a.test.ts': `
|
||||||
|
import { foo } from './b.ts';
|
||||||
|
import { bar } from './c.js';
|
||||||
|
import { qux } from './d.js';
|
||||||
|
const { test } = pwt;
|
||||||
|
test('check project name', ({}, testInfo) => {
|
||||||
|
expect(testInfo.project.name).toBe('foo');
|
||||||
|
expect(bar).toBe('bar');
|
||||||
|
expect(qux).toBe('qux');
|
||||||
|
});
|
||||||
|
`,
|
||||||
|
'b.ts': `
|
||||||
|
export const foo: string = 'foo';
|
||||||
|
`,
|
||||||
|
'c.ts': `
|
||||||
|
export const bar: string = 'bar';
|
||||||
|
`,
|
||||||
|
'd.js': `
|
||||||
|
//@no-header
|
||||||
|
export const qux = 'qux';
|
||||||
|
`,
|
||||||
|
}, {});
|
||||||
|
|
||||||
|
expect(result.exitCode).toBe(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('should propagate subprocess exit code in experimental mode', async ({ runInlineTest }) => {
|
||||||
|
// We only support experimental esm mode on Node 16+
|
||||||
|
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
||||||
|
const result = await runInlineTest({
|
||||||
|
'package.json': JSON.stringify({ type: 'module' }),
|
||||||
|
'a.test.ts': `
|
||||||
|
const { test } = pwt;
|
||||||
|
test('failing test', ({}, testInfo) => {
|
||||||
|
expect(1).toBe(2);
|
||||||
|
});
|
||||||
|
`,
|
||||||
|
}, {});
|
||||||
|
|
||||||
|
expect(result.exitCode).toBe(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test('should respect path resolver in experimental mode', async ({ runInlineTest }) => {
|
||||||
|
// We only support experimental esm mode on Node 16+
|
||||||
|
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
||||||
|
const result = await runInlineTest({
|
||||||
|
'package.json': JSON.stringify({ type: 'module' }),
|
||||||
|
'playwright.config.ts': `
|
||||||
|
export default {
|
||||||
|
projects: [{name: 'foo'}],
|
||||||
|
};
|
||||||
|
`,
|
||||||
|
'tsconfig.json': `{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2019",
|
||||||
|
"module": "commonjs",
|
||||||
|
"lib": ["esnext", "dom", "DOM.Iterable"],
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {
|
||||||
|
"util/*": ["./foo/bar/util/*"],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}`,
|
||||||
|
'a.test.ts': `
|
||||||
|
import { foo } from 'util/b.ts';
|
||||||
|
const { test } = pwt;
|
||||||
|
test('check project name', ({}, testInfo) => {
|
||||||
|
expect(testInfo.project.name).toBe(foo);
|
||||||
|
});
|
||||||
|
`,
|
||||||
|
'foo/bar/util/b.ts': `
|
||||||
|
export const foo: string = 'foo';
|
||||||
|
`,
|
||||||
|
}, {});
|
||||||
|
|
||||||
|
expect(result.exitCode).toBe(0);
|
||||||
|
});
|
@ -198,26 +198,6 @@ test('should load esm when package.json has type module', async ({ runInlineTest
|
|||||||
expect(result.passed).toBe(1);
|
expect(result.passed).toBe(1);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should load nested as esm when package.json has type module @esm', async ({ runInlineTest }) => {
|
|
||||||
const result = await runInlineTest({
|
|
||||||
'playwright.config.js': `
|
|
||||||
//@no-header
|
|
||||||
import * as fs from 'fs';
|
|
||||||
export default { projects: [{name: 'foo'}] };
|
|
||||||
`,
|
|
||||||
'package.json': JSON.stringify({ type: 'module' }),
|
|
||||||
'nested/folder/a.esm.test.js': `
|
|
||||||
const { test } = pwt;
|
|
||||||
test('check project name', ({}, testInfo) => {
|
|
||||||
expect(testInfo.project.name).toBe('foo');
|
|
||||||
});
|
|
||||||
`
|
|
||||||
});
|
|
||||||
|
|
||||||
expect(result.exitCode).toBe(0);
|
|
||||||
expect(result.passed).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should load esm config files', async ({ runInlineTest }) => {
|
test('should load esm config files', async ({ runInlineTest }) => {
|
||||||
const result = await runInlineTest({
|
const result = await runInlineTest({
|
||||||
'playwright.config.mjs': `
|
'playwright.config.mjs': `
|
||||||
@ -261,46 +241,6 @@ test('should fail to load ts from esm when package.json has type module', async
|
|||||||
expect(result.output).toContain('Cannot import a typescript file from an esmodule');
|
expect(result.output).toContain('Cannot import a typescript file from an esmodule');
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should import esm from ts when package.json has type module in experimental mode @esm', async ({ runInlineTest }) => {
|
|
||||||
// We only support experimental esm mode on Node 16+
|
|
||||||
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
|
||||||
const result = await runInlineTest({
|
|
||||||
'playwright.config.ts': `
|
|
||||||
import * as fs from 'fs';
|
|
||||||
export default { projects: [{name: 'foo'}] };
|
|
||||||
`,
|
|
||||||
'package.json': JSON.stringify({ type: 'module' }),
|
|
||||||
'a.test.ts': `
|
|
||||||
import { foo } from './b.ts';
|
|
||||||
const { test } = pwt;
|
|
||||||
test('check project name', ({}, testInfo) => {
|
|
||||||
expect(testInfo.project.name).toBe('foo');
|
|
||||||
});
|
|
||||||
`,
|
|
||||||
'b.ts': `
|
|
||||||
export const foo: string = 'foo';
|
|
||||||
`
|
|
||||||
}, {});
|
|
||||||
|
|
||||||
expect(result.exitCode).toBe(0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should propagate subprocess exit code in experimental mode @esm', async ({ runInlineTest }) => {
|
|
||||||
// We only support experimental esm mode on Node 16+
|
|
||||||
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
|
||||||
const result = await runInlineTest({
|
|
||||||
'package.json': JSON.stringify({ type: 'module' }),
|
|
||||||
'a.test.ts': `
|
|
||||||
const { test } = pwt;
|
|
||||||
test('failing test', ({}, testInfo) => {
|
|
||||||
expect(1).toBe(2);
|
|
||||||
});
|
|
||||||
`,
|
|
||||||
}, {});
|
|
||||||
|
|
||||||
expect(result.exitCode).toBe(1);
|
|
||||||
});
|
|
||||||
|
|
||||||
test('should filter stack trace for simple expect', async ({ runInlineTest }) => {
|
test('should filter stack trace for simple expect', async ({ runInlineTest }) => {
|
||||||
const result = await runInlineTest({
|
const result = await runInlineTest({
|
||||||
'expect-test.spec.ts': `
|
'expect-test.spec.ts': `
|
||||||
|
@ -163,39 +163,3 @@ test('should respect baseurl w/o paths', async ({ runInlineTest }) => {
|
|||||||
expect(result.passed).toBe(1);
|
expect(result.passed).toBe(1);
|
||||||
expect(result.output).not.toContain(`Could not`);
|
expect(result.output).not.toContain(`Could not`);
|
||||||
});
|
});
|
||||||
|
|
||||||
test('should respect path resolver in experimental mode @esm', async ({ runInlineTest }) => {
|
|
||||||
// We only support experimental esm mode on Node 16+
|
|
||||||
test.skip(parseInt(process.version.slice(1), 10) < 16);
|
|
||||||
const result = await runInlineTest({
|
|
||||||
'package.json': JSON.stringify({ type: 'module' }),
|
|
||||||
'playwright.config.ts': `
|
|
||||||
export default {
|
|
||||||
projects: [{name: 'foo'}],
|
|
||||||
};
|
|
||||||
`,
|
|
||||||
'tsconfig.json': `{
|
|
||||||
"compilerOptions": {
|
|
||||||
"target": "ES2019",
|
|
||||||
"module": "commonjs",
|
|
||||||
"lib": ["esnext", "dom", "DOM.Iterable"],
|
|
||||||
"baseUrl": ".",
|
|
||||||
"paths": {
|
|
||||||
"util/*": ["./foo/bar/util/*"],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}`,
|
|
||||||
'a.test.ts': `
|
|
||||||
import { foo } from 'util/b.ts';
|
|
||||||
const { test } = pwt;
|
|
||||||
test('check project name', ({}, testInfo) => {
|
|
||||||
expect(testInfo.project.name).toBe(foo);
|
|
||||||
});
|
|
||||||
`,
|
|
||||||
'foo/bar/util/b.ts': `
|
|
||||||
export const foo: string = 'foo';
|
|
||||||
`,
|
|
||||||
}, {});
|
|
||||||
|
|
||||||
expect(result.exitCode).toBe(0);
|
|
||||||
});
|
|
||||||
|
Loading…
Reference in New Issue
Block a user