Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(ui-mode): include project outputDirs in allowedFileRoots (#41065)

Simon Knottcadf83c4c593
diff --git a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts
index d8060209f9..2c36fde99f 100644
--- a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts
+++ b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts
@@ -45,7 +45,6 @@ export type TraceViewerServerOptions = {
port?: number;
isServer?: boolean;
transport?: Transport;
- allowedFileRoots?: string[];
};
export type TraceViewerRedirectOptions = {
@@ -88,10 +87,9 @@ function validateTraceUrlOrPath(traceFileOrUrl: string | undefined): string | un
}
}
-export async function startTraceViewerServer(options?: TraceViewerServerOptions): Promise<HttpServer> {
+export async function startTraceViewerServer(options: TraceViewerServerOptions & { allowedFileRoots: () => string[] }): Promise<HttpServer> {
const server = new HttpServer(libPath('vite', 'traceViewer'));
- const allowedRoots = (options?.allowedFileRoots ?? [process.cwd()]).map(r => path.resolve(r));
- const isAllowed = (filePath: string) => allowedRoots.some(root => isPathInside(root, filePath));
+ const isAllowed = (filePath: string) => options.allowedFileRoots().some(root => isPathInside(path.resolve(root), filePath));
const serveTraceDataRoute = (request: http.IncomingMessage, response: http.ServerResponse, relativePath: string): boolean => {
if (!relativePath.startsWith('/file'))
@@ -154,11 +152,11 @@ export async function startTraceViewerServer(options?: TraceViewerServerOptions)
});
}
- const transport = options?.transport || (options?.isServer ? new StdinServer() : undefined);
+ const transport = options.transport || (options.isServer ? new StdinServer() : undefined);
if (transport)
server.createWebSocket(() => transport);
- const { host, port } = options || {};
+ const { host, port } = options;
await server.start({ preferredPort: port, host });
return server;
}
@@ -197,7 +195,8 @@ export async function installRootRedirect(server: HttpServer, traceUrl: string |
export async function runTraceViewerApp(traceUrl: string | undefined, browserName: string, options: TraceViewerServerOptions & { headless?: boolean }) {
traceUrl = validateTraceUrlOrPath(traceUrl);
- const server = await startTraceViewerServer({ ...options, allowedFileRoots: traceFileRoots(traceUrl, options.allowedFileRoots) });
+ const allowedFileRoots = traceFileRoots(traceUrl);
+ const server = await startTraceViewerServer({ ...options, allowedFileRoots: () => allowedFileRoots });
await installRootRedirect(server, traceUrl, options);
const page = await openTraceViewerApp(server.urlPrefix('precise'), browserName, options);
page.on('close', () => gracefullyProcessExitDoNotHang(0));
@@ -206,14 +205,13 @@ export async function runTraceViewerApp(traceUrl: string | undefined, browserNam
export async function runTraceInBrowser(traceUrl: string | undefined, options: TraceViewerServerOptions) {
traceUrl = validateTraceUrlOrPath(traceUrl);
- const server = await startTraceViewerServer({ ...options, allowedFileRoots: traceFileRoots(traceUrl, options.allowedFileRoots) });
+ const allowedFileRoots = traceFileRoots(traceUrl);
+ const server = await startTraceViewerServer({ ...options, allowedFileRoots: () => allowedFileRoots });
await installRootRedirect(server, traceUrl, options);
await openTraceInBrowser(server.urlPrefix('human-readable'));
}
-function traceFileRoots(traceUrl: string | undefined, configured: string[] | undefined): string[] {
- if (configured)
- return configured;
+function traceFileRoots(traceUrl: string | undefined): string[] {
if (traceUrl?.startsWith('file://')) {
try {
return [path.dirname(url.fileURLToPath(traceUrl))];
diff --git a/packages/playwright/src/runner/testRunner.ts b/packages/playwright/src/runner/testRunner.ts
index 3f1f250dee..254b1d243c 100644
--- a/packages/playwright/src/runner/testRunner.ts
+++ b/packages/playwright/src/runner/testRunner.ts
@@ -104,6 +104,7 @@ export class TestRunner extends EventEmitter<TestRunnerEventMap> {
private _watchTestDirs = false;
private _populateDependenciesOnList = false;
private _startingEnv: NodeJS.ProcessEnv = {};
+ private _lastLoadedConfig: FullConfigInternal | undefined;
constructor(configLocation: ConfigLocation, configCLIOverrides: ipc.ConfigCLIOverrides) {
super();
@@ -398,12 +399,17 @@ export class TestRunner extends EventEmitter<TestRunnerEventMap> {
} else {
config.plugins.splice(0, config.plugins.length, ...this._plugins);
}
+ this._lastLoadedConfig = config;
return { config };
} catch (e) {
return { config: null, error: serializeError(e) };
}
}
+ lastLoadedConfig(): FullConfigInternal | undefined {
+ return this._lastLoadedConfig;
+ }
+
private async _loadConfigOrReportError(reporter: InternalReporter, overrides?: ipc.ConfigCLIOverrides): Promise<FullConfigInternal | null> {
const { config, error } = await this._loadConfig(overrides);
if (config)
diff --git a/packages/playwright/src/runner/testServer.ts b/packages/playwright/src/runner/testServer.ts
index e5cb70a98e..5a31cd6f98 100644
--- a/packages/playwright/src/runner/testServer.ts
+++ b/packages/playwright/src/runner/testServer.ts
@@ -61,7 +61,24 @@ class TestServer {
async start(options: { host?: string, port?: number }): Promise<HttpServer> {
this._dispatcher = new TestServerDispatcher(this._configLocation, this._configCLIOverrides);
- return await coreServer.startTraceViewerServer({ ...options, transport: this._dispatcher.transport });
+ return await coreServer.startTraceViewerServer({
+ host: options.host,
+ port: options.port,
+ allowedFileRoots: () => this._allowedFileRoots(),
+ transport: this._dispatcher.transport,
+ });
+ }
+
+ private _allowedFileRoots(): string[] {
+ const roots = new Set<string>([process.cwd(), this._configLocation.configDir]);
+ const config = this._dispatcher?._testRunner.lastLoadedConfig();
+ if (config) {
+ for (const project of config.projects) {
+ roots.add(project.project.outputDir);
+ roots.add(project.project.testDir);
+ }
+ }
+ return [...roots];
}
async stop() {
@@ -97,7 +114,7 @@ export class TestServerDispatcher implements TestServerInterface {
readonly transport: Transport;
private _serializer: string | undefined;
private _closeOnDisconnect = false;
- private _testRunner: TestRunner;
+ _testRunner: TestRunner;
private _globalSetupReport: ReportEntry[] | undefined;
readonly _dispatchEvent: TestServerInterfaceEventEmitters['dispatchEvent'];
diff --git a/tests/playwright-test/ui-mode-trace.spec.ts b/tests/playwright-test/ui-mode-trace.spec.ts
index e890f35e83..eb0643bcee 100644
--- a/tests/playwright-test/ui-mode-trace.spec.ts
+++ b/tests/playwright-test/ui-mode-trace.spec.ts
@@ -14,6 +14,10 @@
* limitations under the License.
*/
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+
import { createImage } from './playwright-test-fixtures';
import { test, expect, retries } from './ui-mode-fixtures';
@@ -841,3 +845,36 @@ test('should update state on subsequent run', async ({ runUITest, writeFiles })
- treeitem /Expect \"toBe\"/
`);
});
+
+test('should load trace when outputDir is outside cwd', {
+ annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/40950' },
+}, async ({ runUITest }) => {
+ const outputDir = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'pw-outputdir-'));
+ try {
+ const { page } = await runUITest({
+ 'playwright.config.ts': `
+ import { defineConfig } from '@playwright/test';
+ export default defineConfig({
+ outputDir: ${JSON.stringify(outputDir)},
+ });
+ `,
+ 'a.test.ts': `
+ import { test, expect } from '@playwright/test';
+ test('trace test', async ({ page }) => {
+ await page.setContent('<button>Submit</button>');
+ });
+ `,
+ });
+
+ await page.getByText('trace test').dblclick();
+
+ const listItem = page.getByTestId('actions-tree').getByRole('treeitem');
+ await expect(listItem, 'action list').toHaveText([
+ /Before Hooks/,
+ /Set content/,
+ /After Hooks/,
+ ]);
+ } finally {
+ await fs.promises.rm(outputDir, { recursive: true, force: true });
+ }
+});