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(tsconfig): do not throw when "extends"/"references" cannot be resolved (#42005)
Dmitry Gozman28ae3de4aa5a
diff --git a/packages/playwright/src/transform/tsconfig-loader.ts b/packages/playwright/src/transform/tsconfig-loader.tsindex 690034cf6b..9ae8544bee 100644--- a/packages/playwright/src/transform/tsconfig-loader.ts+++ b/packages/playwright/src/transform/tsconfig-loader.ts@@ -61,16 +61,18 @@ export function loadTsConfig(configPath: string): LoadedTsConfig[] {}}-function resolveConfigFile(baseConfigFile: string, referencedConfigFile: string, kind: 'extends' | 'references') {- const originalReferencedConfigFile = referencedConfigFile;+function resolveConfigFile(baseConfigFile: string, referencedConfigFile: string) {if (!referencedConfigFile.endsWith('.json'))referencedConfigFile += '.json';const currentDir = path.dirname(baseConfigFile);let resolvedConfigFile = path.resolve(currentDir, referencedConfigFile);if (referencedConfigFile.includes('/') && referencedConfigFile.includes('.') && !fs.existsSync(resolvedConfigFile))resolvedConfigFile = path.join(currentDir, 'node_modules', referencedConfigFile);- if (!fs.existsSync(resolvedConfigFile))- throw new Error(`Failed to resolve "${kind}" path "${originalReferencedConfigFile}" referenced from ${baseConfigFile}`);+ // Note: this function may return a non-existing file, and the caller silently ignores it.+ // We deliberately do not throw in this case, because we do not want to repeat the whole+ // resolution process that tsc has, e.g. node_modules walk-up and package.json "exports".+ // See https://github.com/microsoft/playwright/issues/41989.+ // TODO: implement tsc-compatible resolution and start throwing on invalid "extends"/"references".return resolvedConfigFile;}@@ -97,7 +99,7 @@ function innerLoadTsConfig(const extendsArray = Array.isArray(parsedConfig.extends) ? parsedConfig.extends : (parsedConfig.extends ? [parsedConfig.extends] : []);for (const extendedConfig of extendsArray) {- const extendedConfigPath = resolveConfigFile(configFilePath, extendedConfig, 'extends');+ const extendedConfigPath = resolveConfigFile(configFilePath, extendedConfig);const base = innerLoadTsConfig(extendedConfigPath, references, visited);// Retain result instance, so that caching works.Object.assign(result, base, { tsConfigPath: configFilePath });@@ -122,7 +124,7 @@ function innerLoadTsConfig(}for (const ref of parsedConfig.references || [])- references.push(innerLoadTsConfig(resolveConfigFile(configFilePath, ref.path, 'references'), references, visited));+ references.push(innerLoadTsConfig(resolveConfigFile(configFilePath, ref.path), references, visited));if (path.basename(configFilePath) === 'jsconfig.json' && result.allowJs === undefined)result.allowJs = true;diff --git a/tests/playwright-test/resolver.spec.ts b/tests/playwright-test/resolver.spec.tsindex c9909e0f87..6215abb16b 100644--- a/tests/playwright-test/resolver.spec.ts+++ b/tests/playwright-test/resolver.spec.ts@@ -14,6 +14,9 @@* limitations under the License.*/+import fs from 'fs';+import path from 'path';+import { test, expect } from './playwright-test-fixtures';test('should print tsconfig parsing error', async ({ runInlineTest }) => {@@ -622,32 +625,91 @@ test('should resolve extends from an explicit node_modules subpath', async ({ ruexpect(result.exitCode).toBe(0);});-test('should fail loudly when extends path cannot be resolved', async ({ runInlineTest }) => {- test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41543' });+test('should ignore extends bare specifier resolvable only via node_modules walk-up', async ({ runInlineTest }, testInfo) => {+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41989' });++ const baseDir = testInfo.outputPath();+ const symlinkType = process.platform === 'win32' ? 'junction' : 'dir';+ // npm symlinks "file:" dependencies into node_modules. The realpath escapes node_modules,+ // so the dependency goes through per-file tsconfig discovery.+ await fs.promises.mkdir(path.join(baseDir, 'node_modules'), { recursive: true });+ await fs.promises.symlink(path.join(baseDir, 'dep-src'), path.join(baseDir, 'node_modules', 'dep'), symlinkType);const result = await runInlineTest({- 'tsconfig.json': `{- "extends": "./tsconfig.bas.json",- }`,+ 'package.json': JSON.stringify({ name: 'repro', private: true, dependencies: { 'dep': 'file:./dep-src', 'foo': '1.0.0' } }),+ // "foo" is hoisted to the root node_modules and is absent from dep's own node_modules.+ // tsc resolves the "extends" below by walking up node_modules from dep-src.+ 'node_modules/foo/package.json': JSON.stringify({ name: 'foo', version: '1.0.0', main: 'index.js' }),+ 'node_modules/foo/index.js': `module.exports = 'foo';`,+ 'node_modules/foo/tsconfig.json': `{ "compilerOptions": {} }`,+ 'dep-src/package.json': JSON.stringify({ name: 'dep', version: '1.0.0', main: 'index.js' }),+ 'dep-src/tsconfig.json': `{ "extends": "foo/tsconfig.json" }`,+ 'dep-src/index.js': `+ require('foo');+ module.exports = 'dep';+ `,+ 'a.test.ts': `+ import { test, expect } from '@playwright/test';+ const dep = require('dep');+ test('test', () => {+ expect(dep).toBe('dep');+ });+ `,+ });++ expect(result.passed).toBe(1);+ expect(result.exitCode).toBe(0);+});++test('should ignore extends subpath resolvable only via package.json exports', async ({ runInlineTest }) => {+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41989' });++ const result = await runInlineTest({+ 'package.json': JSON.stringify({ name: 'test-project' }),+ // The "./next" subpath only exists in the exports map, there is no "next.json" file.+ 'node_modules/@repo/tsconfig/package.json': JSON.stringify({ name: '@repo/tsconfig', version: '1.0.0', exports: { './next': './tsconfig.next.json' } }),+ 'node_modules/@repo/tsconfig/tsconfig.next.json': `{ "compilerOptions": {} }`,+ 'tsconfig.json': `{ "extends": "@repo/tsconfig/next" }`,'a.test.ts': `import { test, expect } from '@playwright/test';test('test', () => {});`,});- expect(result.exitCode).toBe(1);- expect(result.output).toContain('Failed to resolve "extends" path "./tsconfig.bas.json"');+ expect(result.passed).toBe(1);+ expect(result.exitCode).toBe(0);});-test('should fail loudly when references path cannot be resolved', async ({ runInlineTest }) => {- test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41543' });+test('should ignore extends bare package name resolvable only via package.json exports', async ({ runInlineTest }) => {+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41989' });const result = await runInlineTest({+ 'package.json': JSON.stringify({ name: 'test-project' }),+ 'node_modules/typescript-config-silverwind/package.json': JSON.stringify({ name: 'typescript-config-silverwind', version: '1.0.0', exports: './tsconfig.json' }),+ 'node_modules/typescript-config-silverwind/tsconfig.json': `{ "compilerOptions": {} }`,+ 'tsconfig.json': `{ "extends": "typescript-config-silverwind" }`,+ 'a.test.ts': `+ import { test, expect } from '@playwright/test';+ test('test', () => {});+ `,+ });++ expect(result.passed).toBe(1);+ expect(result.exitCode).toBe(0);+});++test('should ignore tsconfig references pointing to a directory', async ({ runInlineTest }) => {+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41998' });++ const result = await runInlineTest({+ // tsc resolves a directory-form reference to "./sub/tsconfig.json",+ // as written by "tsc --build" and "nx sync".'tsconfig.json': `{- "files": [],- "references": [- { "path": "./tsconfig.doesnotexist.json" }- ]+ "compilerOptions": { "composite": true },+ "references": [{ "path": "./sub" }],+ }`,+ 'sub/tsconfig.json': `{+ "compilerOptions": { "composite": true },}`,'a.test.ts': `import { test, expect } from '@playwright/test';@@ -655,8 +717,8 @@ test('should fail loudly when references path cannot be resolved', async ({ runI`,});- expect(result.exitCode).toBe(1);- expect(result.output).toContain('Failed to resolve "references" path "./tsconfig.doesnotexist.json"');+ expect(result.passed).toBe(1);+ expect(result.exitCode).toBe(0);});test('should respect tsconfig project references', async ({ runInlineTest }) => {@@ -671,9 +733,6 @@ test('should respect tsconfig project references', async ({ runInlineTest }) =>{ "path": "./tsconfig.test.json" }]}`,- 'tsconfig.app.json': `{- "compilerOptions": {},- }`,'tsconfig.test.json': `{"compilerOptions": {"baseUrl": ".",