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(mcp): redact secrets in console log artifacts (#41515)
Simon Knott2a78ee542b94
diff --git a/packages/playwright-core/src/tools/backend/context.ts b/packages/playwright-core/src/tools/backend/context.tsindex d95462452d..8d0c7399dc 100644--- a/packages/playwright-core/src/tools/backend/context.ts+++ b/packages/playwright-core/src/tools/backend/context.ts@@ -353,6 +353,15 @@ export class Context {code: `process.env['${secretName}']`,};}++ redactSecrets(text: string): string {+ for (const [secretName, secretValue] of Object.entries(this.config.secrets ?? {})) {+ if (!secretValue)+ continue;+ text = text.replaceAll(secretValue, `<secret>${secretName}</secret>`);+ }+ return text;+ }}function originOrHostGlob(originOrHost: string) {diff --git a/packages/playwright-core/src/tools/backend/logFile.ts b/packages/playwright-core/src/tools/backend/logFile.tsindex 1bbaefcb4d..66bbf6efc8 100644--- a/packages/playwright-core/src/tools/backend/logFile.ts+++ b/packages/playwright-core/src/tools/backend/logFile.ts@@ -91,7 +91,7 @@ export class LogFile {return;this._file ??= await this._context.outputFile({ prefix: this._filePrefix, ext: 'log', date: new Date(this._startTime) }, { origin: 'code' });const relativeTime = Math.round(wallTime - this._startTime);- const logLine = `[${String(relativeTime).padStart(8, ' ')}ms] ${text}\n`;+ const logLine = `[${String(relativeTime).padStart(8, ' ')}ms] ${this._context.redactSecrets(text)}\n`;await fs.promises.appendFile(this._file, logLine);const lineCount = logLine.split('\n').length - 1;diff --git a/packages/playwright-core/src/tools/backend/response.ts b/packages/playwright-core/src/tools/backend/response.tsindex db10fb696f..388fb04d80 100644--- a/packages/playwright-core/src/tools/backend/response.ts+++ b/packages/playwright-core/src/tools/backend/response.ts@@ -111,7 +111,7 @@ export class Response {private async _writeFile(resolvedFile: ResolvedFile, data: Buffer | string | null) {if (typeof data === 'string')- await fs.promises.writeFile(resolvedFile.fileName, this._redactSecrets(data), 'utf-8');+ await fs.promises.writeFile(resolvedFile.fileName, this._context.redactSecrets(data), 'utf-8');else if (data)await fs.promises.writeFile(resolvedFile.fileName, data);this._writtenFiles.add(path.resolve(resolvedFile.fileName));@@ -155,16 +155,6 @@ export class Response {this._includeSnapshotRoot = root;}- private _redactSecrets(text: string): string {- for (const [secretName, secretValue] of Object.entries(this._context.config.secrets ?? {})) {- if (!secretValue)- continue;- text = text.replaceAll(secretValue, `<secret>${secretName}</secret>`);- }- return text;- }--async serialize(): Promise<CallToolResult> {const allSections = await this._build();await this._enforceOutputBudget();@@ -211,7 +201,7 @@ export class Response {const content: (TextContent | ImageContent)[] = [{type: 'text',- text: sanitizeUnicode(this._redactSecrets(serializedText)),+ text: sanitizeUnicode(this._context.redactSecrets(serializedText)),}];diff --git a/tests/mcp/secrets.spec.ts b/tests/mcp/secrets.spec.tsindex eeae81a5be..266c7f34ea 100644--- a/tests/mcp/secrets.spec.ts+++ b/tests/mcp/secrets.spec.ts@@ -16,7 +16,7 @@import fs from 'node:fs';-import { test, expect } from './fixtures';+import { test, expect, parseResponse, consoleEntries } from './fixtures';test('browser_type', async ({ startClient, server }) => {const secretsFile = test.info().outputPath('secrets.env');@@ -65,6 +65,43 @@ await page.getByRole('textbox').press('Enter');`,});+test('secrets are redacted in console log artifact', { annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/41509' } }, async ({ startClient, server }) => {+ const secretsFile = test.info().outputPath('secrets.env');+ await fs.promises.writeFile(secretsFile, 'X-PASSWORD=password123');++ const { client } = await startClient({+ args: ['--secrets', secretsFile],+ });++ server.setContent('/', `+ <!DOCTYPE html>+ <html>+ <input type='keypress' onkeypress="console.log('Key pressed:', event.key, ', Text:', event.target.value)"></input>+ </html>+ `, 'text/html');++ await client.callTool({+ name: 'browser_navigate',+ arguments: {+ url: server.PREFIX,+ },+ });++ const response = parseResponse(await client.callTool({+ name: 'browser_type',+ arguments: {+ element: 'textbox',+ target: 'e2',+ text: 'X-PASSWORD',+ submit: true,+ },+ }));++ const consoleLog = await consoleEntries(response);+ expect(consoleLog).not.toContain('password123');+ expect(consoleLog).toContain('<secret>X-PASSWORD</secret>');+});+test('browser_fill_form', async ({ startClient, server }) => {const secretsFile = test.info().outputPath('secrets.env');await fs.promises.writeFile(secretsFile, 'X-PASSWORD=password123');