Skip to content

chore: add firefox webdriver bidi docs #6103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 25, 2025
Merged

chore: add firefox webdriver bidi docs #6103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6065b1b
chore: add firefox webdriver bidi docs
AtofStryker Feb 14, 2025
429f36f
address code review comments
AtofStryker Feb 14, 2025
8b6c661
update firefox warning message and correct majorVersion type
AtofStryker Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/api/cypress-api/browser.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ Cypress.browser // returns browser object

The object has the following properties:

| Property | Type | Description |
| -------------- | --------- | --------------------------------------------------------------------- |
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
| `displayName` | `string` | Human-readable display name for the browser. |
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
| `isChosen` | `boolean` | Whether the browser is selected in the browser selector of Cypress. |
| `majorVersion` | `number` | The major version number of the browser. |
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
| `version` | `string` | Full version. |
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
| `isHeaded` | `boolean` | Whether the browser displays headed. |
| Property | Type | Description |
| -------------- | -------------------- | --------------------------------------------------------------------- |
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
| `displayName` | `string` | Human-readable display name for the browser. |
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
| `isChosen` | `boolean` | Whether the browser is selected in the browser selector of Cypress. |
| `majorVersion` | `number` \| `string` | The major version number of the browser. |
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
| `version` | `string` | Full version. |
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
| `isHeaded` | `boolean` | Whether the browser displays headed. |

## Examples

Expand Down
22 changes: 11 additions & 11 deletions docs/api/cypress-api/isbrowser.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,17 @@ Filter one or multiple browsers by the browser properties. You can inspect the
current browser's properties by using the
[Cypress.browser](/api/cypress-api/browser). Supported properties are:

| Property | Type | Description |
| -------------- | --------- | --------------------------------------------------------------------- |
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
| `displayName` | `string` | Human-readable display name for the browser. |
| `version` | `string` | Full version. |
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
| `majorVersion` | `number` | The major version number of the browser. |
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
| `isHeaded` | `boolean` | Whether the browser displays headed. |
| Property | Type | Description |
| -------------- | -------------------- | --------------------------------------------------------------------- |
| `name` | `string` | Machine-friendly name, like `chrome`, `electron`, or `firefox`. |
| `family` | `string` | Rendering engine being used. `chromium` or `firefox`. |
| `channel` | `string` | Release channel of the browser, such as `stable`, `dev`, or `canary`. |
| `displayName` | `string` | Human-readable display name for the browser. |
| `version` | `string` | Full version. |
| `path` | `string` | Path to the browser on disk. Blank for Electron. |
| `majorVersion` | `number` \| `string` | The major version number of the browser. |
| `isHeadless` | `boolean` | Whether the browser is running headlessly. |
| `isHeaded` | `boolean` | Whether the browser displays headed. |

## Examples

Expand Down
16 changes: 16 additions & 0 deletions docs/app/references/launching-browsers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,22 @@ of our [docker images](/app/continuous-integration/overview#Cypress-Docker-Image
By default, we will launch Firefox headlessly during `cypress run`. To run
Firefox headed, you can pass the `--headed` argument to `cypress run`.

##### Webdriver BiDi and CDP Deprecation

:::info

Since Firefox 129, Chrome DevTools Protocol (CDP) has been [deprecated in Firefox](https://fxdx.dev/deprecating-cdp-support-in-firefox-embracing-the-future-with-webdriver-bidi/).
In Firefox 135 and above, Cypress defaults to automating the Firefox browser with WebDriver BiDi.
Cypress will no longer support CDP within Firefox in the future and is planned for removal in Cypress 15.

If CDP still needs to be used, you can force enablement via the `FORCE_FIREFOX_CDP=1` environment variable, regardless of Firefox version. For example:

```bash
FORCE_FIREFOX_CDP=1 npx cypress run --browser firefox
```

:::

### WebKit (Experimental)

Cypress has [experimental](/app/references/experiments) support for WebKit,
Expand Down