Skip to content

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

fix(chromium): propagate `setUserAgent()` to service workers via `Network` domain (#41071)

pikachuc30ccc68f833
diff --git a/packages/playwright-core/src/server/chromium/crBrowser.ts b/packages/playwright-core/src/server/chromium/crBrowser.ts
index ec96fb9496..27a3409fb5 100644
--- a/packages/playwright-core/src/server/chromium/crBrowser.ts
+++ b/packages/playwright-core/src/server/chromium/crBrowser.ts
@@ -30,7 +30,7 @@ import { CRPage } from './crPage';
import { saveProtocolStream } from './crProtocolHelper';
import { CRServiceWorker } from './crServiceWorker';
-import type { InitScript, Worker } from '../page';
+import type { InitScript } from '../page';
import type { ConnectionTransport } from '../transport';
import type * as types from '../types';
import type { CDPSession, CRSession } from './crConnection';
@@ -496,9 +496,10 @@ export class CRBrowserContext extends BrowserContext<CREventsMap> {
async setUserAgent(userAgent: string | undefined): Promise<void> {
this._options.userAgent = userAgent;
- for (const page of this.pages())
- await (page.delegate as CRPage).updateUserAgent();
- // TODO: service workers don't have Emulation domain?
+ await Promise.all([
+ ...this.pages().map(page => (page.delegate as CRPage).updateUserAgent()),
+ ...this.serviceWorkers().map(sw => sw.updateUserAgent()),
+ ]);
}
async doUpdateOffline(): Promise<void> {
@@ -593,7 +594,7 @@ export class CRBrowserContext extends BrowserContext<CREventsMap> {
});
}
- serviceWorkers(): Worker[] {
+ serviceWorkers(): CRServiceWorker[] {
return Array.from(this._browser._serviceWorkers.values()).filter(serviceWorker => serviceWorker.browserContext === this);
}
diff --git a/packages/playwright-core/src/server/chromium/crPage.ts b/packages/playwright-core/src/server/chromium/crPage.ts
index 19556b0536..cbb1d4eb13 100644
--- a/packages/playwright-core/src/server/chromium/crPage.ts
+++ b/packages/playwright-core/src/server/chromium/crPage.ts
@@ -1165,7 +1165,7 @@ async function emulateTimezone(session: CRSession, timezoneId: string) {
}
// Chromium reference: https://source.chromium.org/chromium/chromium/src/+/main:components/embedder_support/user_agent_utils.cc;l=434;drc=70a6711e08e9f9e0d8e4c48e9ba5cab62eb010c2
-function calculateUserAgentMetadata(options: types.BrowserContextOptions) {
+export function calculateUserAgentMetadata(options: types.BrowserContextOptions) {
const ua = options.userAgent;
if (!ua)
return undefined;
diff --git a/packages/playwright-core/src/server/chromium/crServiceWorker.ts b/packages/playwright-core/src/server/chromium/crServiceWorker.ts
index da83759bca..abd6f58ad7 100644
--- a/packages/playwright-core/src/server/chromium/crServiceWorker.ts
+++ b/packages/playwright-core/src/server/chromium/crServiceWorker.ts
@@ -20,6 +20,7 @@ import { BrowserContext } from '../browserContext';
import * as network from '../network';
import { ConsoleMessage } from '../console';
import { stackTraceToLocation } from './crProtocolHelper';
+import { calculateUserAgentMetadata } from './crPage';
import type { CRBrowserContext } from './crBrowser';
import type { CRSession } from './crConnection';
@@ -53,6 +54,7 @@ export class CRServiceWorker extends Worker {
this.updateExtraHTTPHeaders();
this.updateHttpCredentials();
this.updateOffline();
+ this.updateUserAgent();
this._networkManager.addSession(session, undefined, true /* isMain */).catch(() => {});
}
@@ -96,6 +98,15 @@ export class CRServiceWorker extends Worker {
await this._networkManager?.setExtraHTTPHeaders(this.browserContext._options.extraHTTPHeaders || []).catch(() => {});
}
+ async updateUserAgent(): Promise<void> {
+ const options = this.browserContext._options;
+ await this._session.send('Emulation.setUserAgentOverride', {
+ userAgent: options.userAgent || '',
+ acceptLanguage: options.locale,
+ userAgentMetadata: calculateUserAgentMetadata(options),
+ }).catch(() => {});
+ }
+
async updateRequestInterception(): Promise<void> {
if (!this._isNetworkInspectionEnabled())
return;
diff --git a/tests/library/chromium/extensions.spec.ts b/tests/library/chromium/extensions.spec.ts
index c27fd1cdfe..3194d5554c 100644
--- a/tests/library/chromium/extensions.spec.ts
+++ b/tests/library/chromium/extensions.spec.ts
@@ -164,4 +164,21 @@ it.describe('MV3', () => {
expect(message.text()).toContain('Test console log from a third-party execution context');
await context.close();
});
+
+ it('should use custom userAgent in service worker fetch requests', async ({ launchPersistentContext, asset, server }) => {
+ server.setRoute('/ua-echo', (req, res) => {
+ res.writeHead(200, { 'Content-Type': 'text/plain' });
+ res.end(req.headers['user-agent']);
+ });
+ const extensionPath = asset('extension-mv3-simple');
+ const context = await launchPersistentContext(extensionPath, { userAgent: 'MyTestAgent/1.0' });
+ const serviceWorkers = context.serviceWorkers();
+ const sw = serviceWorkers.length ? serviceWorkers[0] : await context.waitForEvent('serviceworker');
+ const userAgent = await sw.evaluate(async url => {
+ const response = await fetch(url);
+ return response.text();
+ }, server.PREFIX + '/ua-echo');
+ expect(userAgent).toBe('MyTestAgent/1.0');
+ await context.close();
+ });
});