Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: resolve config location earlier (#30275)

Browse source 
Reference https://github.com/microsoft/playwright/issues/29768
This commit is contained in:
Yury Semikhatsky 2024-04-05 19:32:56 -07:00 committed by GitHub
parent 9e89f292bf
commit 3e03c800df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 39 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
packages/playwright/src/common/configLoader.ts
View file

@ -286,7 +286,16 @@ function validateProject(file: string, project: Project, title: string) {
} }
} }
export function resolveConfigFile(configFileOrDirectory: string): string | undefined { export function resolveConfigLocation(configFile: string | undefined): ConfigLocation {
const configFileOrDirectory = configFile ? path.resolve(process.cwd(), configFile) : process.cwd();
const resolvedConfigFile = resolveConfigFile(configFileOrDirectory);
return {
resolvedConfigFile,
configDir: resolvedConfigFile ? path.dirname(resolvedConfigFile) : configFileOrDirectory,
};
}
function resolveConfigFile(configFileOrDirectory: string): string | undefined {
const resolveConfig = (configFile: string) => { const resolveConfig = (configFile: string) => {
if (fs.existsSync(configFile)) if (fs.existsSync(configFile))
return configFile; return configFile;
@ -309,22 +318,15 @@ export function resolveConfigFile(configFileOrDirectory: string): string | undef
return configFile; return configFile;
// If there is no config, assume this as a root testing directory. // If there is no config, assume this as a root testing directory.
return undefined; return undefined;
} else {
// When passed a file, it must be a config file.
const configFile = resolveConfig(configFileOrDirectory);
return configFile!;
} }
// When passed a file, it must be a config file.
return configFileOrDirectory!;
} }
export async function loadConfigFromFileRestartIfNeeded(configFile: string | undefined, overrides?: ConfigCLIOverrides, ignoreDeps?: boolean): Promise<FullConfigInternal | null> { export async function loadConfigFromFileRestartIfNeeded(configFile: string | undefined, overrides?: ConfigCLIOverrides, ignoreDeps?: boolean): Promise<FullConfigInternal | null> {
const configFileOrDirectory = configFile ? path.resolve(process.cwd(), configFile) : process.cwd(); const location = resolveConfigLocation(configFile);
const resolvedConfigFile = resolveConfigFile(configFileOrDirectory); if (restartWithExperimentalTsEsm(location.resolvedConfigFile))
if (restartWithExperimentalTsEsm(resolvedConfigFile))
return null; return null;
const location: ConfigLocation = {
configDir: resolvedConfigFile ? path.dirname(resolvedConfigFile) : configFileOrDirectory,
resolvedConfigFile,
};
return await loadConfig(location, overrides, ignoreDeps); return await loadConfig(location, overrides, ignoreDeps);
} }

50
packages/playwright/src/runner/testServer.ts
View file

@ -21,7 +21,7 @@ import { ManualPromise, gracefullyProcessExitDoNotHang, isUnderTest } from 'play
import type { Transport, HttpServer } from 'playwright-core/lib/utils'; import type { Transport, HttpServer } from 'playwright-core/lib/utils';
import type * as reporterTypes from '../../types/testReporter'; import type * as reporterTypes from '../../types/testReporter';
import { collectAffectedTestFiles, dependenciesForTestFile } from '../transform/compilationCache'; import { collectAffectedTestFiles, dependenciesForTestFile } from '../transform/compilationCache';
import type { FullConfigInternal } from '../common/config'; import type { ConfigLocation, FullConfigInternal } from '../common/config';
import { InternalReporter } from '../reporters/internalReporter'; import { InternalReporter } from '../reporters/internalReporter';
import { createReporterForTestServer, createReporters } from './reporters'; import { createReporterForTestServer, createReporters } from './reporters';
import { TestRun, createTaskRunnerForList, createTaskRunnerForTestServer, createTaskRunnerForWatchSetup, createTaskRunnerForListFiles } from './tasks'; import { TestRun, createTaskRunnerForList, createTaskRunnerForTestServer, createTaskRunnerForWatchSetup, createTaskRunnerForListFiles } from './tasks';
@ -33,7 +33,7 @@ import { Watcher } from '../fsWatcher';
import type { ReportEntry, TestServerInterface, TestServerInterfaceEventEmitters } from '../isomorphic/testServerInterface'; import type { ReportEntry, TestServerInterface, TestServerInterfaceEventEmitters } from '../isomorphic/testServerInterface';
import { Runner } from './runner'; import { Runner } from './runner';
import type { ConfigCLIOverrides } from '../common/ipc'; import type { ConfigCLIOverrides } from '../common/ipc';
import { loadConfig, resolveConfigFile, restartWithExperimentalTsEsm } from '../common/configLoader'; import { loadConfig, resolveConfigLocation, restartWithExperimentalTsEsm } from '../common/configLoader';
import { webServerPluginsForConfig } from '../plugins/webServerPlugin'; import { webServerPluginsForConfig } from '../plugins/webServerPlugin';
import type { TraceViewerRedirectOptions, TraceViewerServerOptions } from 'playwright-core/lib/server/trace/viewer/traceViewer'; import type { TraceViewerRedirectOptions, TraceViewerServerOptions } from 'playwright-core/lib/server/trace/viewer/traceViewer';
import type { TestRunnerPluginRegistration } from '../plugins'; import type { TestRunnerPluginRegistration } from '../plugins';
@ -44,15 +44,15 @@ const originalStdoutWrite = process.stdout.write;
const originalStderrWrite = process.stderr.write; const originalStderrWrite = process.stderr.write;
class TestServer { class TestServer {
private _configFile: string | undefined; private _configLocation: ConfigLocation;
private _dispatcher: TestServerDispatcher | undefined; private _dispatcher: TestServerDispatcher | undefined;
constructor(configFile: string | undefined) { constructor(configLocation: ConfigLocation) {
this._configFile = configFile; this._configLocation = configLocation;
} }
async start(options: { host?: string, port?: number }): Promise<HttpServer> { async start(options: { host?: string, port?: number }): Promise<HttpServer> {
this._dispatcher = new TestServerDispatcher(this._configFile); this._dispatcher = new TestServerDispatcher(this._configLocation);
return await startTraceViewerServer({ ...options, transport: this._dispatcher.transport }); return await startTraceViewerServer({ ...options, transport: this._dispatcher.transport });
} }
@ -63,7 +63,7 @@ class TestServer {
} }
class TestServerDispatcher implements TestServerInterface { class TestServerDispatcher implements TestServerInterface {
private _configFile: string | undefined; private _configLocation: ConfigLocation;
private _globalWatcher: Watcher; private _globalWatcher: Watcher;
private _testWatcher: Watcher; private _testWatcher: Watcher;
private _testRun: { run: Promise<reporterTypes.FullResult['status']>, stop: ManualPromise<void> } | undefined; private _testRun: { run: Promise<reporterTypes.FullResult['status']>, stop: ManualPromise<void> } | undefined;
@ -77,8 +77,8 @@ class TestServerDispatcher implements TestServerInterface {
private _closeOnDisconnect = false; private _closeOnDisconnect = false;
private _devServerHandle: (() => Promise<void>) | undefined; private _devServerHandle: (() => Promise<void>) | undefined;
constructor(configFile: string | undefined) { constructor(configLocation: ConfigLocation) {
this._configFile = configFile; this._configLocation = configLocation;
this.transport = { this.transport = {
dispatch: (method, params) => (this as any)[method](params), dispatch: (method, params) => (this as any)[method](params),
onclose: () => { onclose: () => {
@ -145,7 +145,7 @@ class TestServerDispatcher implements TestServerInterface {
await this.runGlobalTeardown(); await this.runGlobalTeardown();
const { reporter, report } = await this._collectingReporter(); const { reporter, report } = await this._collectingReporter();
const { config, error } = await this._loadConfig(this._configFile); const { config, error } = await this._loadConfig();
if (!config) { if (!config) {
reporter.onError(error!); reporter.onError(error!);
return { status: 'failed', report }; return { status: 'failed', report };
@ -178,7 +178,7 @@ class TestServerDispatcher implements TestServerInterface {
if (this._devServerHandle) if (this._devServerHandle)
return { status: 'failed', report: [] }; return { status: 'failed', report: [] };
const { reporter, report } = await this._collectingReporter(); const { reporter, report } = await this._collectingReporter();
const { config, error } = await this._loadConfig(this._configFile); const { config, error } = await this._loadConfig();
if (!config) { if (!config) {
reporter.onError(error!); reporter.onError(error!);
return { status: 'failed', report }; return { status: 'failed', report };
@ -212,14 +212,14 @@ class TestServerDispatcher implements TestServerInterface {
} }
async clearCache(params: Parameters<TestServerInterface['clearCache']>[0]): ReturnType<TestServerInterface['clearCache']> { async clearCache(params: Parameters<TestServerInterface['clearCache']>[0]): ReturnType<TestServerInterface['clearCache']> {
const { config } = await this._loadConfig(this._configFile); const { config } = await this._loadConfig();
if (config) if (config)
await clearCacheAndLogToConsole(config); await clearCacheAndLogToConsole(config);
} }
async listFiles(params: Parameters<TestServerInterface['listFiles']>[0]): ReturnType<TestServerInterface['listFiles']> { async listFiles(params: Parameters<TestServerInterface['listFiles']>[0]): ReturnType<TestServerInterface['listFiles']> {
const { reporter, report } = await this._collectingReporter(); const { reporter, report } = await this._collectingReporter();
const { config, error } = await this._loadConfig(this._configFile); const { config, error } = await this._loadConfig();
if (!config) { if (!config) {
reporter.onError(error!); reporter.onError(error!);
return { status: 'failed', report }; return { status: 'failed', report };
@ -250,7 +250,7 @@ class TestServerDispatcher implements TestServerInterface {
retries: 0, retries: 0,
}; };
const { reporter, report } = await this._collectingReporter(); const { reporter, report } = await this._collectingReporter();
const { config, error } = await this._loadConfig(this._configFile, overrides); const { config, error } = await this._loadConfig(overrides);
if (!config) { if (!config) {
reporter.onError(error!); reporter.onError(error!);
return { report: [], status: 'failed' }; return { report: [], status: 'failed' };
@ -315,7 +315,7 @@ class TestServerDispatcher implements TestServerInterface {
else else
process.env.PW_LIVE_TRACE_STACKS = undefined; process.env.PW_LIVE_TRACE_STACKS = undefined;
const { config, error } = await this._loadConfig(this._configFile, overrides); const { config, error } = await this._loadConfig(overrides);
if (!config) { if (!config) {
const wireReporter = await this._wireReporter(e => this._dispatchEvent('report', e)); const wireReporter = await this._wireReporter(e => this._dispatchEvent('report', e));
wireReporter.onError(error!); wireReporter.onError(error!);
@ -359,7 +359,7 @@ class TestServerDispatcher implements TestServerInterface {
} }
async findRelatedTestFiles(params: Parameters<TestServerInterface['findRelatedTestFiles']>[0]): ReturnType<TestServerInterface['findRelatedTestFiles']> { async findRelatedTestFiles(params: Parameters<TestServerInterface['findRelatedTestFiles']>[0]): ReturnType<TestServerInterface['findRelatedTestFiles']> {
const { config, error } = await this._loadConfig(this._configFile); const { config, error } = await this._loadConfig();
if (error) if (error)
return { testFiles: [], errors: [error] }; return { testFiles: [], errors: [error] };
const runner = new Runner(config!); const runner = new Runner(config!);
@ -393,11 +393,9 @@ class TestServerDispatcher implements TestServerInterface {
gracefullyProcessExitDoNotHang(0); gracefullyProcessExitDoNotHang(0);
} }
private async _loadConfig(configFile: string | undefined, overrides?: ConfigCLIOverrides): Promise<{ config: FullConfigInternal | null, error?: reporterTypes.TestError }> { private async _loadConfig(overrides?: ConfigCLIOverrides): Promise<{ config: FullConfigInternal | null, error?: reporterTypes.TestError }> {
const configFileOrDirectory = configFile ? path.resolve(process.cwd(), configFile) : process.cwd();
const resolvedConfigFile = resolveConfigFile(configFileOrDirectory);
try { try {
const config = await loadConfig({ resolvedConfigFile, configDir: resolvedConfigFile === configFileOrDirectory ? path.dirname(resolvedConfigFile) : configFileOrDirectory }, overrides); const config = await loadConfig(this._configLocation, overrides);
// Preserve plugin instances between setup and build. // Preserve plugin instances between setup and build.
if (!this._plugins) if (!this._plugins)
this._plugins = config.plugins || []; this._plugins = config.plugins || [];
@ -411,7 +409,8 @@ class TestServerDispatcher implements TestServerInterface {
} }
export async function runUIMode(configFile: string | undefined, options: TraceViewerServerOptions & TraceViewerRedirectOptions): Promise<reporterTypes.FullResult['status'] | 'restarted'> { export async function runUIMode(configFile: string | undefined, options: TraceViewerServerOptions & TraceViewerRedirectOptions): Promise<reporterTypes.FullResult['status'] | 'restarted'> {
return await innerRunTestServer(configFile, options, async (server: HttpServer, cancelPromise: ManualPromise<void>) => { const configLocation = resolveConfigLocation(configFile);
return await innerRunTestServer(configLocation, options, async (server: HttpServer, cancelPromise: ManualPromise<void>) => {
await installRootRedirect(server, [], { ...options, webApp: 'uiMode.html' }); await installRootRedirect(server, [], { ...options, webApp: 'uiMode.html' });
if (options.host !== undefined || options.port !== undefined) { if (options.host !== undefined || options.port !== undefined) {
await openTraceInBrowser(server.urlPrefix()); await openTraceInBrowser(server.urlPrefix());
@ -428,23 +427,24 @@ export async function runUIMode(configFile: string | undefined, options: TraceVi
} }
export async function runTestServer(configFile: string | undefined, options: { host?: string, port?: number }): Promise<reporterTypes.FullResult['status'] | 'restarted'> { export async function runTestServer(configFile: string | undefined, options: { host?: string, port?: number }): Promise<reporterTypes.FullResult['status'] | 'restarted'> {
return await innerRunTestServer(configFile, options, async server => { const configLocation = resolveConfigLocation(configFile);
return await innerRunTestServer(configLocation, options, async server => {
// eslint-disable-next-line no-console // eslint-disable-next-line no-console
console.log('Listening on ' + server.urlPrefix().replace('http:', 'ws:') + '/' + server.wsGuid()); console.log('Listening on ' + server.urlPrefix().replace('http:', 'ws:') + '/' + server.wsGuid());
}); });
} }
async function innerRunTestServer(configFile: string | undefined, options: { host?: string, port?: number }, openUI: (server: HttpServer, cancelPromise: ManualPromise<void>) => Promise<void>): Promise<reporterTypes.FullResult['status'] | 'restarted'> { async function innerRunTestServer(configLocation: ConfigLocation, options: { host?: string, port?: number }, openUI: (server: HttpServer, cancelPromise: ManualPromise<void>, configLocation: ConfigLocation) => Promise<void>): Promise<reporterTypes.FullResult['status'] | 'restarted'> {
if (restartWithExperimentalTsEsm(undefined, true)) if (restartWithExperimentalTsEsm(undefined, true))
return 'restarted'; return 'restarted';
const testServer = new TestServer(configFile); const testServer = new TestServer(configLocation);
const cancelPromise = new ManualPromise<void>(); const cancelPromise = new ManualPromise<void>();
const sigintWatcher = new SigIntWatcher(); const sigintWatcher = new SigIntWatcher();
process.stdin.on('close', () => gracefullyProcessExitDoNotHang(0)); process.stdin.on('close', () => gracefullyProcessExitDoNotHang(0));
void sigintWatcher.promise().then(() => cancelPromise.resolve()); void sigintWatcher.promise().then(() => cancelPromise.resolve());
try { try {
const server = await testServer.start(options); const server = await testServer.start(options);
await openUI(server, cancelPromise); await openUI(server, cancelPromise, configLocation);
await cancelPromise; await cancelPromise;
} finally { } finally {
await testServer.stop(); await testServer.stop();