@wdio/firefox-profile-service

WDIO Firefox Profile Service

You want to run your Firefox browser with a specific extension or need to set a couple preferences? Selenium allows you to use a profile for the Firefox browser by passing this profile as base64 string to the moz:firefoxOptions.profile property in your desired capabilities. This requires building that profile and converting it into base64. This service for the wdio testrunner takes the work of compiling the profile out of your hand and lets you define your desired options comfortably from the wdio.conf.js file.

To find all possible options open about:config in your Firefox browser or go to mozillaZine website to find the whole documentation about each setting. In Addition to that, you can define compiled (as *.xpi) Firefox extensions that should get installed before the test starts.

Installation

The easiest way is to keep @wdio/firefox-profile-service as a devDependency in your package.json, via:

npm install @wdio/firefox-profile-service --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

Setup your profile by adding the firefox-profile service to your service list. Then define your settings in the firefoxProfile property like this:

// wdio.conf.js
export const config = {
    // ...
    services: [
        ['firefox-profile', {
            extensions: [
                '/path/to/extensionA.xpi', // path to .xpi file
                '/path/to/extensionB' // or path to unpacked Firefox extension
            ],
            'xpinstall.signatures.required': false,
            'browser.startup.homepage': 'https://webdriver.io',
            legacy: true // only use for firefox <= 55
        }]
    ],
    // ...
};

If you have built a custom Firefox extension that you want to install in the browser make sure to set 'xpinstall.signatures.required': false` as a profile flag since Firefox extensions are required to be signed by Mozilla.

To use custom unsigned extensions you will also need to use Firefox Developer Edition since the regular Firefox 48 and newer do not allow this.

Options

Contains all settings as key-value pair. You can find all available settings on the about:config page.

extensions

Add one or multiple extensions to the browser session. All entries can be either an absolute path to the .xpi file or the path to an unpacked Firefox extension directory.

Type: String[]
Default: []

profileDirectory

Create Firefox profile based on an existing one by setting an absolute path to that profile.

Type: String
Default: null

proxy

Set network proxy settings. The parameter proxy is a hash whose structure depends on the value of the mandatory proxyType key, which takes one of the following string values:

• direct - direct connection (no proxy)
• system - use operating system proxy settings
• pac - use an automatic proxy configuration set based on the value of autoconfigUrl key
• manual - manual proxy settings defined separately for different protocols using values from the following keys: ftpProxy, httpProxy, sslProxy, socksProxy

Type: Object
Default: null
Example:

• Automatic Proxy:

  // wdio.conf.js
  export const config = {
      // ...
      services: [
          ['firefox-profile', {
              proxy: {
                  proxyType: 'pac',
                  autoconfigUrl: 'http://myserver/proxy.pac'
              }
          }]
      ],
      // ...
  };
  

• Manual HTTP Proxy:

  // wdio.conf.js
  export const config = {
      // ...
      services: [
          ['firefox-profile', {
              proxy: {
                  proxyType: 'manual',
                  httpProxy: '127.0.0.1:8080'
              }
          }]
      ],
      // ...
  };
  

• Manual HTTP and HTTPS Proxy:

  // wdio.conf.js
  export const config = {
      // ...
      services: [
          ['firefox-profile', {
              proxy: {
                  proxyType: 'manual',
                  httpProxy: '127.0.0.1:8080',
                  sslProxy: '127.0.0.1:8080'
              }
          }]
      ],
      // ...
  };
  

legacy

Please set this flag to true if you use Firefox v55 or lower.

Type: Boolean
Default: false

---

For more information on WebdriverIO see the homepage.

Changelog

v9.2.2 (2024-10-28)

:bug: Bug Fix

• wdio-browser-runner, wdio-cli, wdio-config, wdio-local-runner, wdio-spec-reporter, webdriver, webdriverio
  • #13781 fix(webdriverio): improve switchFrame behavior (@christian-bromann)
• webdriver
  • #13805 fix(webdriver): allow WebdriverIO to handle alerts (@christian-bromann)
• wdio-browser-runner, webdriver
  • #13782 fix(@wdio/browser-runner): publish Mocha assets as part of package (@christian-bromann)
• webdriverio
  • #13798 fix(webdriverio): Misfound elements when using WebDriver BiDi (@nextlevelbeard)
  • #13800 reorder shadowroot removal (@ccharnkij)
  • #13772 fix(webdriverio): ensure BiDi browsingContext is updated after switchToWindow (@harsha509)
  • #13760 Prevent switchWindow from switching on invalid window requested (@gavvvr)
• wdio-browserstack-service
  • #13773 🐛 Bug Fix: TypeError: fetch failed (@kamal-kaur04)
• wdio-types, webdriverio
  • #13777 fix(webdriverio): wait for request information to come in (@christian-bromann)
• wdio-cli
  • #13768 Fix moduleLoaderFlag (@jenskuhrjorgensen)

:nail_care: Polish

• wdio-appium-service
  • #13804 chore(@wdio/appium-service): log to stdout if no log path is set (@christian-bromann)
• wdio-protocols
  • #13806 feat(wdio-protocols): extend BiDi type definitions (@harsha509)
• webdriverio
  • #13793 feat: enhance newWindow function to support 'tab' or 'window' types (@harsha509)

:memo: Documentation

• webdriverio
  • #13802 fix(webdriverio): typo in keys description (@cuvar)
  • #13794 docs(browser.mock): remove outdated parameter comment (@Delta456)
• Other
  • #13795 rename attachSession to attachToSession (@navin772)
  • #13797 docs(BACKERS.md): fix LambdaTest logo link (@Delta456)
  • #13758 docs: Updated examples guide to mention PNPM for setup instead of NPM (@gavvvr)
  • #13761 docs: correct links to flowcharts (@gavvvr)

:house: Internal

• #13792 add missing test:e2e script to package.json (@harsha509)

Committers: 11

• Chanatan Charnkijtawarush (@ccharnkij)
• Christian Bromann (@christian-bromann)
• Jens Kuhr Jørgensen (@jenskuhrjorgensen)
• Kamalpreet Kaur (@kamal-kaur04)
• Kirill Gavrilov (@gavvvr)
• Luca Müller (@cuvar)
• Navin Chandra (@navin772)
• Ricardo Barbosa (@nextlevelbeard)
• Sri Harsha (@harsha509)
• Swastik Baranwal (@Delta456)
• Wim Selles (@wswebcreation)