Skip to content

Commit 26353db

Browse files
AtofStrykerAtofStryker
authored
chore: add firefox webdriver bidi docs (#6103)
* chore: add firefox webdriver bidi docs * address code review comments * update firefox warning message and correct majorVersion type
1 parent cad4643 commit 26353db

File tree

3 files changed

+39
-23
lines changed

3 files changed

+39
-23
lines changed

‎docs/api/cypress-api/browser.mdx

+12-12
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ Cypress.browser // returns browser object
1919

2020
The object has the following properties:
2121

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

3535
## Examples
3636

‎docs/api/cypress-api/isbrowser.mdx

+11-11
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ Filter one or multiple browsers by the browser properties. You can inspect the
3838
current browser's properties by using the
3939
[Cypress.browser](/api/cypress-api/browser). Supported properties are:
4040

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

5353
## Examples
5454

‎docs/app/references/launching-browsers.mdx

+16
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,22 @@ of our [docker images](/app/continuous-integration/overview#Cypress-Docker-Image
190190
By default, we will launch Firefox headlessly during `cypress run`. To run
191191
Firefox headed, you can pass the `--headed` argument to `cypress run`.
192192

193+
##### Webdriver BiDi and CDP Deprecation
194+
195+
:::info
196+
197+
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/).
198+
In Firefox 135 and above, Cypress defaults to automating the Firefox browser with WebDriver BiDi.
199+
Cypress will no longer support CDP within Firefox in the future and is planned for removal in Cypress 15.
200+
201+
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:
202+
203+
```bash
204+
FORCE_FIREFOX_CDP=1 npx cypress run --browser firefox
205+
```
206+
207+
:::
208+
193209
### WebKit (Experimental)
194210

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

0 commit comments

Comments
 (0)