Skip to content

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

fix(tracing): do not store secrets in trace context options (#43220)

Dmitry Gozman433c5eeb60eb
diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.ts
index ed938f231e..3b29eb35bb 100644
--- a/packages/playwright-core/src/server/trace/recorder/tracing.ts
+++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts
@@ -133,7 +133,8 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
assert(tracesDir, 'tracesDir must be specified for BrowserContext');
this._contextCreatedEvent.browserName = context._browser.options.name;
this._contextCreatedEvent.channel = context._browser.options.channel;
- this._contextCreatedEvent.options = context._options;
+ const { baseURL, viewport, deviceScaleFactor, isMobile, userAgent } = context._options;
+ this._contextCreatedEvent.options = { baseURL, viewport, deviceScaleFactor, isMobile, userAgent };
}
}
diff --git a/tests/library/tracing.spec.ts b/tests/library/tracing.spec.ts
index ad29ab0de5..6e5b88e7bb 100644
--- a/tests/library/tracing.spec.ts
+++ b/tests/library/tracing.spec.ts
@@ -95,6 +95,38 @@ test('should use the correct title for event driven callbacks', async ({ context
]);
});
+browserTest('should not store secrets in context options', async ({ browser, server }, testInfo) => {
+ const context = await browser.newContext({
+ baseURL: server.PREFIX,
+ viewport: { width: 500, height: 600 },
+ deviceScaleFactor: 2,
+ isMobile: false,
+ userAgent: 'custom-ua',
+ httpCredentials: { username: 'user', password: 'secret-password' },
+ extraHTTPHeaders: { 'x-secret': 'secret-header' },
+ storageState: { cookies: [{ name: 'session', value: 'secret-cookie', domain: 'localhost', path: '/', expires: -1, httpOnly: false, secure: false, sameSite: 'Lax' }], origins: [] },
+ });
+ await context.tracing.start();
+ const page = await context.newPage();
+ await page.goto(server.EMPTY_PAGE);
+ await context.tracing.stop({ path: testInfo.outputPath('trace.zip') });
+ await context.close();
+
+ const { events } = await parseTraceRaw(testInfo.outputPath('trace.zip'));
+ expect(events[0].type).toBe('context-options');
+ expect(events[0].options).toEqual({
+ baseURL: server.PREFIX,
+ viewport: { width: 500, height: 600 },
+ deviceScaleFactor: 2,
+ isMobile: false,
+ userAgent: 'custom-ua',
+ });
+ const traceText = fs.readFileSync(testInfo.outputPath('trace.zip')).toString('latin1');
+ expect(traceText).not.toContain('secret-password');
+ expect(traceText).not.toContain('secret-header');
+ expect(traceText).not.toContain('secret-cookie');
+});
+
test('should not collect snapshots by default', async ({ context, page, server }, testInfo) => {
await context.tracing.start();
await page.goto(server.EMPTY_PAGE);