Skip to content
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

Remove invalid firefoxGcInterval configuration #5119

Merged
merged 1 commit into from
Mar 14, 2023
Merged

Remove invalid firefoxGcInterval configuration #5119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
122 changes: 1 addition & 121 deletions docs/guides/references/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,126 +607,6 @@ The `**/node_modules/**` pattern is automatically added to `excludeSpecPattern`
and does not need to be specified (and can't be overridden). See [`e2e`](#e2e)
or [`component`](#component) testing-specific options.

### firefoxGcInterval

:::caution

The following section only applies if you are using a version of Firefox older
than Firefox 80. `firefoxGcInterval` has no effect if you are using Firefox 80
or newer, since the garbage collection bug was fixed in Firefox 80. It is
recommended to upgrade your version of Firefox to avoid this workaround.

:::

Firefox versions 79 and earlier have a
[bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1608501) where it does not
run its internal garbage collection (GC) fast enough, which can lead to
consuming all available system memory and crashing.

Cypress prevents Firefox from crashing by forcing Firefox to run its GC cleanup
routines between tests.

Running GC is an expensive and **blocking** routine. It adds significant time to
the overall run, and causes Firefox to "freeze" for the duration of GC cleanup.
This causes the browser not to respond to any user input.

Cypress runs GC cleanup during
[cypress run](/guides/guides/command-line#cypress-run) only because we don't
expect users to interact with the browser - since this is typically run in CI.
We've disabled running GC during
[cypress open](/guides/guides/command-line#cypress-open) because users typically
interact with the browser.

Because GC adds additional time to the overall run, we've added the amount of
time this routine has taken to the bottom of the Cypress Command Log.

<DocsImage
src="/img/guides/configuration/firefox-gc-interval-in-command-log.jpg"
alt="GC duration shown"
/>

#### Configuration

You can control how often GC cleanup runs via the `firefoxGcInterval`
configuration value.

`firefoxGcInterval` controls whether Cypress forces Firefox to run GC cleanup
and how frequently.

By default, we force GC cleanup between every test during
[cypress run](/guides/guides/command-line#cypress-run), but do not run any GC
cleanup during [cypress open](/guides/guides/command-line#cypress-open) using
the configuration below:

:::cypress-config-example

```ts
{
firefoxGcInterval: {
runMode: 1,
openMode: null,
},
}
```

:::

You can override how often Cypress runs GC cleanup by setting the
`firefoxGcInterval` config value to:

- `null`, to disable it for both
[cypress run](/guides/guides/command-line#cypress-run) and
[cypress open](/guides/guides/command-line#cypress-open)
- a `number`, which sets the interval for both
[cypress run](/guides/guides/command-line#cypress-run) and
[cypress open](/guides/guides/command-line#cypress-open)
- an `object` to set different intervals for each mode

**Examples**

Turn off GC cleanup all modes

:::cypress-config-example

```ts
{
firefoxGcInterval: null,
}
```

:::

Run GC cleanup before every other test during
[cypress run](/guides/guides/command-line#cypress-run) and
[cypress open](/guides/guides/command-line#cypress-open)

:::cypress-config-example

```ts
{
firefoxGcInterval: 2,
}
```

:::

Run GC cleanup before every 3rd test during
[cypress run](/guides/guides/command-line#cypress-run) and disable running GC
cleanup during [cypress open](/guides/guides/command-line#cypress-open).

:::cypress-config-example

```ts
{
firefoxGcInterval: {
runMode: 3,
openMode: null,
},
}
```

:::

### isInteractive

You can open Cypress in the interactive mode via the `cypress open` command, and
Expand Down Expand Up @@ -864,7 +744,7 @@ DEBUG=cypress:cli,cypress:server:specs
| [10.4.0](/guides/references/changelog#10-4-0) | Added `e2e.testIsolation` option. |
| [10.0.0](/guides/references/changelog#10-0-0) | Reworked page to support new `cypress.config.js` and deprecated `cypress.json` files. |
| [8.7.0](/guides/references/changelog#8-7-0) | Added `slowTestThreshold` option. |
| [8.0.0](/guides/references/changelog#8-0-0) | Added `clientCertificates` option. |
| [8.0.0](/guides/references/changelog#8-0-0) | Added `clientCertificates` option and removed `firefoxGcInterval` configuration. |
| [7.0.0](/guides/references/changelog#7-0-0) | Added `e2e` and `component` options. |
| [7.0.0](/guides/references/changelog#7-0-0) | Added `redirectionLimit` option. |
| [6.1.0](/guides/references/changelog#6-1-0) | Added `scrollBehavior` option. |
Expand Down