feat: support firefoxUserPrefs in launchPersistentContext (#27840)

Fixes #27773.
microsoft · Oct 27, 2023 · 88f30d1 · 88f30d1
1 parent d395a38
commit 88f30d1
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 10 deletions.
diff --git a/docs/src/api/class-browsertype.md b/docs/src/api/class-browsertype.md
@@ -337,6 +337,12 @@ use a temporary directory instead.
 ### option: BrowserType.launchPersistentContext.-inline- = %%-shared-context-params-list-v1.8-%%
 * since: v1.8
 
+### option: BrowserType.launchPersistentContext.firefoxUserPrefs = %%-js-python-browser-option-firefoxuserprefs-%%
+* since: v1.40
+
+### option: BrowserType.launchPersistentContext.firefoxUserPrefs2 = %%-csharp-java-browser-option-firefoxuserprefs-%%
+* since: v1.40
+
 ## async method: BrowserType.launchServer
 * since: v1.8
 * langs: js

diff --git a/packages/playwright-core/src/client/types.ts b/packages/playwright-core/src/client/types.ts
@@ -76,14 +76,11 @@ type LaunchOverrides = {
   ignoreDefaultArgs?: boolean | string[];
   env?: Env;
   logger?: Logger;
+  firefoxUserPrefs?: { [key: string]: string | number | boolean };
 };
 
-type FirefoxUserPrefs = {
-  firefoxUserPrefs?: { [key: string]: string | number | boolean },
-};
-type LaunchOptionsBase = Omit<channels.BrowserTypeLaunchOptions, 'ignoreAllDefaultArgs' | 'ignoreDefaultArgs' | 'env' | 'firefoxUserPrefs'> & LaunchOverrides;
-export type LaunchOptions = LaunchOptionsBase & FirefoxUserPrefs;
-export type LaunchPersistentContextOptions = Omit<LaunchOptionsBase & BrowserContextOptions, 'storageState'>;
+export type LaunchOptions = Omit<channels.BrowserTypeLaunchOptions, 'ignoreAllDefaultArgs' | 'ignoreDefaultArgs' | 'env' | 'firefoxUserPrefs'> & LaunchOverrides;
+export type LaunchPersistentContextOptions = Omit<LaunchOptions & BrowserContextOptions, 'storageState'>;
 
 export type ConnectOptions = {
   wsEndpoint: string,
@@ -117,7 +114,8 @@ export type LaunchServerOptions = {
   port?: number,
   wsPath?: string,
   logger?: Logger,
-} & FirefoxUserPrefs;
+  firefoxUserPrefs?: { [key: string]: string | number | boolean };
+};
 
 export type LaunchAndroidServerOptions = {
   deviceSerialNumber?: string,

diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
@@ -521,6 +521,7 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
   downloadsPath: tOptional(tString),
   tracesDir: tOptional(tString),
   chromiumSandbox: tOptional(tBoolean),
+  firefoxUserPrefs: tOptional(tAny),
   noDefaultViewport: tOptional(tBoolean),
   viewport: tOptional(tObject({
     width: tNumber,

diff --git a/packages/playwright-core/src/server/firefox/ffBrowser.ts b/packages/playwright-core/src/server/firefox/ffBrowser.ts
@@ -43,7 +43,7 @@ export class FFBrowser extends Browser {
     const browser = new FFBrowser(parent, connection, options);
     if ((options as any).__testHookOnConnectToBrowser)
       await (options as any).__testHookOnConnectToBrowser();
-    let firefoxUserPrefs = options.persistent ? {} : options.originalLaunchOptions.firefoxUserPrefs ?? {};
+    let firefoxUserPrefs = options.originalLaunchOptions.firefoxUserPrefs ?? {};
     if (Object.keys(kBandaidFirefoxUserPrefs).length)
       firefoxUserPrefs = { ...kBandaidFirefoxUserPrefs, ...firefoxUserPrefs };
     const promises: Promise<any>[] = [

diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
@@ -12841,6 +12841,12 @@ export interface BrowserType<Unused = {}> {
      */
     extraHTTPHeaders?: { [key: string]: string; };
 
+    /**
+     * Firefox user preferences. Learn more about the Firefox user preferences at
+     * [`about:config`](https://support.mozilla.org/en-US/kb/about-config-editor-firefox).
+     */
+    firefoxUserPrefs?: { [key: string]: string|number|boolean; };
+
     /**
      * Emulates `'forced-colors'` media feature, supported values are `'active'`, `'none'`. See
      * [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.

diff --git a/packages/protocol/src/channels.ts b/packages/protocol/src/channels.ts
@@ -929,6 +929,7 @@ export type BrowserTypeLaunchPersistentContextParams = {
   downloadsPath?: string,
   tracesDir?: string,
   chromiumSandbox?: boolean,
+  firefoxUserPrefs?: any,
   noDefaultViewport?: boolean,
   viewport?: {
     width: number,
@@ -1000,6 +1001,7 @@ export type BrowserTypeLaunchPersistentContextOptions = {
   downloadsPath?: string,
   tracesDir?: string,
   chromiumSandbox?: boolean,
+  firefoxUserPrefs?: any,
   noDefaultViewport?: boolean,
   viewport?: {
     width: number,

diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
@@ -411,6 +411,7 @@ LaunchOptions:
     downloadsPath: string?
     tracesDir: string?
     chromiumSandbox: boolean?
+    firefoxUserPrefs: json?
 
 
 ContextOptions:
@@ -868,7 +869,6 @@ BrowserType:
     launch:
       parameters:
         $mixin: LaunchOptions
-        firefoxUserPrefs: json?
         slowMo: number?
       returns:
         browser: Browser

diff --git a/packages/trace-viewer/src/ui/logTab.tsx b/packages/trace-viewer/src/ui/logTab.tsx
@@ -52,7 +52,7 @@ export const LogTab: React.FunctionComponent<{
       });
     }
     return entries;
-  }, [action]);
+  }, [action, isLive]);
   if (!entries.length)
     return <PlaceholderPanel text='No log entries' />;
 

diff --git a/tests/library/firefox/launcher.spec.ts b/tests/library/firefox/launcher.spec.ts
@@ -30,3 +30,16 @@ it('should pass firefox user preferences', async ({ browserType, mode }) => {
   expect(error.message).toContain('NS_ERROR_PROXY_CONNECTION_REFUSED');
   await browser.close();
 });
+
+it('should pass firefox user preferences in persistent', async ({ mode, launchPersistent }) => {
+  it.skip(mode.startsWith('service'));
+  const { page } = await launchPersistent({
+    firefoxUserPrefs: {
+      'network.proxy.type': 1,
+      'network.proxy.http': '127.0.0.1',
+      'network.proxy.http_port': 3333,
+    }
+  });
+  const error = await page.goto('http://example.com').catch(e => e);
+  expect(error.message).toContain('NS_ERROR_PROXY_CONNECTION_REFUSED');
+});