Skip to main content
Cypress App

Experimental Features

If you'd like to try out what we're working on in Cypress, you can enable specific experimental features for your project using the Cypress configuration options described below.

caution

⚠️ The experimental features might change or ultimately be removed without making it into the core product. Our primary goal for experiments is to collect real-world feedback during their development. For more information, see the documentation for all Cypress Release Stages.

Configuration​

You can pass the Cypress configuration options below to enable or disable experiments. See our Configuration Guide on how to pass configuration to Cypress.

OptionDefaultDescription
experimentalCspAllowListfalseIndicates the Content-Security-Policy directives to permit during a test run. See Content-Security-Policy for more information.
experimentalInteractiveRunEventsfalseAllows listening to the before:run, after:run, before:spec, and after:spec events in the setupNodeEvents function during interactive mode.
experimentalModifyObstructiveThirdPartyCodefalseWhether Cypress searches for and replaces obstructive code in third party .js or .html files. NOTE: Setting this flag removes Subresource Integrity (SRI) from third-party resources. To also remove SRI from first-party resources, use removeSRIAttributes.
experimentalRunAllSpecsfalseEnables the "Run All Specs" UI feature, allowing the execution of multiple specs sequentially.
experimentalWebKitSupportfalseEnable experimental support for running tests in WebKit. When set, Cypress detects installs of playwright-webkit and makes them available. See Launching Browsers for more information.
retries.experimentalStrategyN/AApplies a strategy for test retries according to your "flake tolerance"; options are detect-flake-but-always-fail or detect-flake-and-pass-on-threshold. See Experimental Retries for more details.
retries.experimentalOptionsN/ASets retries strategy-specific options like maxRetries, passesRequired, and stopIfAnyPassed. See Experimental Retries for more details.

Experimental CSP Allow List​

Cypress by default strips all CSP headers (Content-Security-Policy and Content-Security-Policy-Report-Only) from the response before sending it to the browser. The experimentalCspAllowList option provides more granular control over which CSP directives Cypress strips from the CSP response headers, so your application runs under test with CSP enabled. Valid values for this option are false (the default), true, or an array of CSP directive names.

ValueExample
false (default)experimentalCspAllowList=false
trueexperimentalCspAllowList=true
<CspDirectives>[]experimentalCspAllowList=["default-src","script-src"]

Strip All CSP Headers​

The value experimentalCspAllowList=false (default) removes all CSP headers from the response before Cypress sends it to the browser. Use this option if you do not depend on CSP for any tests in your application.

Strip Minimum CSP Directives​

If you need to test your application with CSP enabled, setting the experimentalCspAllowList option makes Cypress send all CSP headers to the browser except those that could prevent Cypress from functioning normally.

Cypress always strips the following CSP directives:

Stripped DirectiveAllowableReason
frame-ancestorsNoPrevents Cypress from loading a test application into an iframe.
navigate-toNoAffects Cypress' ability to navigate to different URLs.
require-trusted-types-forNoMight prevent Cypress from rewriting the DOM.
sandboxNoCan restrict access to script and iframe functionality.
trusted-typesNoCould cause the browser to mark Cypress injections as untrusted.

When experimentalCspAllowList=true, Cypress also strips the following directives in addition to the ones listed above, but you can configure Cypress to send them to the browser:

Stripped DirectiveAllowableReason
child-srcYesCould prevent iframes from loading in combination with other Cypress options.
default-srcYesConditionally prevents Cypress from loading scripts and running.
frame-srcYesCould prevent iframes from loading in combination with other Cypress options.
form-actionYesCan prevent Cypress from monitoring form events.
script-srcYesConditionally prevents Cypress from loading scripts and running.
script-src-elemYesConditionally prevents Cypress from loading scripts and running.

Allow Specific CSP Directives​

Set the experimentalCspAllowList option to an array of directive names marked as "Allowable" from the list above. Cypress then sends the specified CSP directives to the browser.

The following configuration sends the default-src, script-src, and script-src-elem directives to the browser:

const { defineConfig } = require('cypress')

module.exports = defineConfig({
experimentalCspAllowList: ['default-src', 'script-src', 'script-src-elem'],
})
caution

Defining experimentalCspAllowList may cause Cypress to be unable to run tests against your application. If you experience issues, reduce the directives specified in your allow list to identify which directive is causing issues.

There is a known issue when using certain directives containing hash algorithm values and the modifyObstructiveCode option. Using this option in combination with the experimentalCspAllowList option can cause a mismatch between the original hashed directive value, and the modified HTML or JS value.

Experimental Flake Detection Features​

Experimental Test Retries​

Test retries is a Cypress Flake Detection feature that re-attempts any test that initially fails. The failure may not be a "true" failure, i.e. flaky. The only way to determine this is to retry the test.

Normally, test retries stop on the first passing attempt. And the final test result of any flaky test is always "passing", regardless of how many prior attempts failed. The following experimental settings for retries give you more control over the retries process.

There are two strategies for retries:

  • detect-flake-and-pass-on-threshold
  • detect-flake-but-always-fail

The detect-flake-and-pass-on-threshold strategy is most like the current implementation of retries, where failing tests have a "chance" to still pass, but still detect flake. But this new experimental strategy also adds a threshold of passing attempts that the test must reach for a passing final result. And if you want to ensure flaky tests are treated with the same urgency as failing tests, then use the detect-flake-but-always-fail strategy, which assures that Cypress still marks every flaky test as failing.

experimentalStrategy: 'detect-flake-and-pass-on-threshold'​

Setting experimentalStrategy: 'detect-flake-and-pass-on-threshold' within retries makes the test result pass only after a set number of passing attempts. You must set two experimentalOptions with this strategy:

  • maxRetries sets the maximum number of retries that can occur after the first attempt failed.
  • passesRequired sets the required number of passing attempts for the final test result to be passing. Cannot be greater than maxRetries.
    • passesRequired also determines how the retries may stop before maxRetries is reached; either if the number of passing attempts so far has met the passesRequired condition or if the number of failing attempts exceeds the difference between maxRetries and passesRequired (when it's impossible to achieve the passing result).
const { defineConfig } = require('cypress')

module.exports = defineConfig({
retries: {
experimentalStrategy: 'detect-flake-and-pass-on-threshold',
experimentalOptions: {
maxRetries: 2,
passesRequired: 2,
},

// you must also explicitly set openMode and runMode to
// either true or false when using experimental retries
openMode: true,
runMode: true,
},
})

Examples of the above configuration's results:

Scenario 1:

  • Attempt 1: Fail
  • Attempt 2: Pass
  • Attempt 3: Fail

The retries stop on attempt 3, since maxRetries: 2 is now met and the test's final result is failing and flaky. Only one attempt passed, but two are needed to pass.

Scenario 2:

  • Attempt 1: Fail
  • Attempt 2: Pass
  • Attempt 3: Pass

Retries stop at attempt 3 again, and the test is passing and flaky, since there are now two passing attempts.

Scenario 3:

  • Attempt 1: Fail
  • Attempt 2: Fail

Retries stop on attempt 2, and the test is failing , because the test can no longer achieve the requisite two passing attempts for a passing result once the 1st retry failed. The test is also not flaky, since there were no passing attempts.

experimentalStrategy: 'detect-flake-but-always-fail'​

Setting experimentalStrategy: 'detect-flake-but-always-fail' within retries ensures any test with any failed attempt always ends with a failing final result. You must set two experimentalOptions in this strategy:

  • maxRetries sets the maximum number of retries that can occur after the first attempt failed.
  • stopIfAnyPassed stops the retries before maxRetries is reached when there is any passing attempt.
    • stopIfAnyPassed causes retries to exit as soon as Cypress detects any flake (a test that is retrying after a failure only needs to pass once to exhibit flaky behavior). However it may help to see more retry attempts, such as when the failure mode is also non-deterministic and more retries reveal more of these different errors, in which case stopIfAnyPassed: false may be desirable.
const { defineConfig } = require('cypress')

module.exports = defineConfig({
retries: {
experimentalStrategy: 'detect-flake-but-always-fail',
experimentalOptions: {
maxRetries: 2,
stopIfAnyPassed: true,
},

// you must also explicitly set openMode and runMode to
// either true or false when using experimental retries
openMode: true,
runMode: true,
},
})

Examples of the above configuration's results:

Scenario 1:

  • Attempt 1: Fail
  • Attempt 2: Fail
  • Attempt 3: Fail

The retries stop on attempt 3, since maxRetries: 2 is now met and the test is failing , but also not flaky.

Scenario 2:

  • Attempt 1: Fail
  • Attempt 2: Pass

Retries stop on the first retry, due to the passing attempt. The test is failing and flaky. If stopIfAnyPassed was false, then the retries would have proceeded once more.

caution

Note: You can configure experimental retries only at the global level and not per individual test, whereas you can configure non-experimental retries per test. If you configure retries on a per-test basis while using experimental retries globally, that particular test's retries configuration overrides the experimental retries and ignores it.

Also, while using experimental retries, you cannot set numeric values for openMode or runMode at the global level. You can instead set true or false for each.

Testing Type-Specific Experiments​

You can provide configuration options for either E2E or Component Testing by creating e2e and component objects inside your Cypress configuration.

End-to-End Testing​

You can specify these experiments inside the e2e configuration object:

OptionDefaultDescription
experimentalOriginDependenciesfalseEnables support for Cypress.require within cy.origin.

Component Testing​

You can specify these experiments inside the component configuration object:

OptionDefaultDescription
experimentalSingleTabRunModefalseRun all specs in a single tab, instead of creating a new tab per spec. Running in a single tab can improve run mode performance, but can impact spec isolation and reliability on large test suites.

History​

VersionChanges
16.0.0Removed experimentalSourceRewriting. The default regex-based source rewriting is now the only implementation.
16.0.0Removed experimentalFastVisibility. The modern visibility algorithm is now the default.
16.0.0Removed experimentalMemoryManagement. Memory management graduated to manageBrowserMemory, enabled by default.
15.9.0Added component testing support for experimentalRunAllSpecs.
15.8.0Added support for experimentalFastVisibility experiment.
15.4.0Removed experimentalStudio. Cypress Studio is available as default behavior.
14.0.0Removed experimentalFetchPolyfill, experimentalJustInTimeCompile, and experimentalSkipDomainInjection and made it default behavior.
13.14.0Added support for configuring the Experimental Just-In-Time (JIT) Compiling for component testing via experimentalJustInTimeCompile.
13.4.0Added support for configuring the Experimental Flake Detection strategy via retries.experimentalStrategy and retries.experimentalOptions.
12.6.0Removed require/import and added Cypress.require for experimentalOriginDependencies.
12.4.0Added experimentalSkipDomainInjection and experimentalMemoryManagement.
12.0.0Removed experimentalSessionAndOrigin and made it the default behavior. Added experimentalOriginDependencies.
11.2.0Added experimentalRunAllSpecs.
10.8.0Added experimentalWebKitSupport.
10.6.0Added support for experimentalSingleTabRunMode.
10.4.0Added support for experimentalModifyObstructiveThirdPartyCode.
9.6.0Added support for experimentalSessionAndOrigin and removed experimentalSessionSupport.
8.2.0Added support for experimentalSessionSupport.
7.1.0Added support for experimentalInteractiveRunEvents.
7.0.0Removed experimentalComponentTesting and made it the default behavior.
6.7.0Removed experimentalRunEvents and made it the default behavior.
6.3.0Added support for experimentalStudio.
6.2.0Added support for experimentalRunEvents.
6.0.0Removed experimentalNetworkStubbing and made it the default behavior when using cy.intercept().
6.0.0Deprecated experimentalFetchPolyfill.
5.2.0Removed experimentalShadowDomSupport and made it the default behavior.
5.1.0Added support for experimentalNetworkStubbing.
5.0.0Removed experimentalGetCookiesSameSite and made it the default behavior.
4.9.0Added support for experimentalFetchPolyfill.
4.8.0Added support for experimentalShadowDomSupport.
4.6.0Added support for experimentalSourceRewriting.
4.5.0Added support for experimentalComponentTesting.
4.3.0Added support for experimentalGetCookiesSameSite.