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

v13.14.0 Docs #5898

Merged
merged 12 commits into from
Aug 27, 2024
Merged

v13.14.0 Docs #5898

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
facea5e
misc: add docs for `CYPRESS_SKIP_VERIFY` option (#5889)
joshuajtward Aug 16, 2024
1316586
adds `experimentalJustInTimeCompile` documentation for Component Test…
AtofStryker Aug 22, 2024
2cfd4a9
feat: Implement correct behavior for all input types supporting arrow…
thevladisss Aug 26, 2024
ed4b06d
chore: add 13.14.0 changelog
AtofStryker Aug 27, 2024
9177026
Merge branch 'main' into v13.14.0
AtofStryker Aug 27, 2024
d930824
Update docs/guides/references/changelog.mdx
jennifer-shehane Aug 27, 2024
a416734
Update docs/api/actions/type.mdx
AtofStryker Aug 27, 2024
f537f80
Updating cli docs for `--browser` flag behavior (#5904)
raygdev Aug 27, 2024
08dd649
Update docs/guides/references/experiments.mdx
AtofStryker Aug 27, 2024
e3d260f
Update docs/guides/references/experiments.mdx
AtofStryker Aug 27, 2024
c6fa98d
Update docs/guides/references/experiments.mdx
AtofStryker Aug 27, 2024
c3ae17e
Update docs/guides/references/experiments.mdx
AtofStryker Aug 27, 2024
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
1 change: 1 addition & 0 deletions docs/guides/references/advanced-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ title: Advanced Installation
| `CYPRESS_CACHE_FOLDER` | [Changes the Cypress binary cache location](#Binary-cache) |
| `CYPRESS_RUN_BINARY` | [Location of Cypress binary at run-time](#Run-binary) |
| `CYPRESS_VERIFY_TIMEOUT` | Overrides the timeout duration for the `verify` command. The default value is 30000. |
| `CYPRESS_SKIP_VERIFY` | Skips the `verify` command (for stable CI environments) |
| ~~CYPRESS_SKIP_BINARY_INSTALL~~ | <Badge type="danger">removed</Badge> use `CYPRESS_INSTALL_BINARY=0` instead |
| ~~CYPRESS_BINARY_VERSION~~ | <Badge type="danger">removed</Badge> use `CYPRESS_INSTALL_BINARY` instead |

Expand Down
4 changes: 4 additions & 0 deletions docs/guides/references/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Changelog
---

## 13.14.0

_Released 8/27/2024_

AtofStryker marked this conversation as resolved.
Show resolved Hide resolved
## 13.13.3

_Released 8/14/2024_
Expand Down
86 changes: 56 additions & 30 deletions docs/guides/references/experiments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,36 +320,62 @@ you will need to add the correct matching glob pattern.
These experiments are available to be specified inside the `component`
configuration object:

| Option | Default | Description |
| ------------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. |
| Option | Default | Description |
| ------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. |
| `experimentalJustInTimeCompile` | `false` | Enables Just-In-Time (JIT) compiling for component testing, which will only compile assets related to the spec before the spec is run. Currently supported for Vite and Webpack. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just pointing out that sometimes we capitalize and use 'Component Testing' and other times we don't and use 'component testing'. Suggest we stick to one style.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got this updated on the experiments page


#### Experimental Just-In-Time Compile

By default, Cypress compiles all specs used by Component Testing before allowing any spec to run. This works fine for smaller projects most of the time.
AtofStryker marked this conversation as resolved.
Show resolved Hide resolved

However, as a Component Testing suite grows, the dev server (`vite` or `webpack-dev-server`, depending on your application) also grows with it. This can get to a point where the dev server grows so large that it consumes a large majority of CPU and memory resources, leading to:
AtofStryker marked this conversation as resolved.
Show resolved Hide resolved

- Out Of Memory (OOM) errors.
- `chunk load error`, specific to Webpack where parts of the bundle fail to load.
- long run times while running component tests in CI in `cypress run` mode.
- Unable to efficiently develop tests in `cypress open` mode because the initial and recompiling times for specs and related components are extremely long.
- Inability to leverage [Smart orchestration](/guides/cloud/smart-orchestration/overview) effectively to scale resources due to all assets being compiled into the dev server regardless of what specs are run.

The `experimentalJustInTimeCompile` option is designed to remedy this problem. Enabling this option will enable Just-In-Time (JIT) compiling for component testing, which will only compile assets and resources related to the spec before the spec is run. This is applicable in both `open` and `run` modes.

In `open` and `run` modes, the dev server will start up when the Cypress application starts with the component testing type, but will only compile the spec once it is selected or run. When a different spec is run, the different spec is then compiled, omitting the previously run spec from the dev server.

This makes developing your current spec much faster in `open` mode when it comes to initial compiling and recompiling, with a minor tradeoff being to recompile when you switch specs.

This also significantly reduces the memory requirements needed to run your tests in `run` mode, with a tradeoff being that your tests might run slightly slower since the dev server needs to recompile. If time is a factor, [Smart orchestration](/guides/cloud/smart-orchestration/overview) can now be effectively used to parallelize your component testing runs on smaller infrastructure since the dev server only compiles what is needed to run the spec.

We are using `experimentalJustInTimeCompile` internally within Cypress for our larger Component Testing suites and have noticed significant reductions in memory when running `cypress run` mode and have gained significantly faster compile times when leveraging `cypress open` to develop our tests.
AtofStryker marked this conversation as resolved.
Show resolved Hide resolved

If you are using this experiment and would like to leave feedback, please comment on our [github discussion](https://github.com/cypress-io/cypress/discussions/30024).

## History

| Version | Changes |
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [13.4.0](/guides/references/changelog#13-4-0) | Added support for configuring the Experimental Flake Detection strategy via `retries.experimentalStrategy` and `retries.experimentalOptions`. |
| [12.6.0](/guides/references/changelog#12-6-0) | Removed `require`/`import` and added `Cypress.require` for `experimentalOriginDependencies`. |
| [12.4.0](/guides/references/changelog#12-4-0) | Added `experimentalSkipDomainInjection` and `experimentalMemoryManagement`. |
| [12.0.0](/guides/references/changelog#12-0-0) | Removed `experimentalSessionAndOrigin` and made it the default behavior. Added `experimentalOriginDependencies`. |
| [11.2.0](/guides/references/changelog#11-2-0) | Added `experimentalRunAllSpecs`. |
| [10.8.0](/guides/references/changelog#10-8-0) | Added `experimentalWebKitSupport`. |
| [10.6.0](/guides/references/changelog#10-6-0) | Added support for `experimentalSingleTabRunMode`. |
| [10.4.0](/guides/references/changelog#10-4-0) | Added support for `experimentalModifyObstructiveThirdPartyCode`. |
| [9.6.0](/guides/references/changelog#9-6-0) | Added support for `experimentalSessionAndOrigin` and removed `experimentalSessionSupport`. |
| [8.2.0](/guides/references/changelog#8-2-0) | Added support for `experimentalSessionSupport`. |
| [7.1.0](/guides/references/changelog#7-1-0) | Added support for `experimentalInteractiveRunEvents`. |
| [7.0.0](/guides/references/changelog#7-0-0) | Removed `experimentalComponentTesting` and made it the default behavior. |
| [6.7.0](/guides/references/changelog#6-7-0) | Removed `experimentalRunEvents` and made it the default behavior. |
| [6.3.0](/guides/references/changelog#6-3-0) | Added support for `experimentalStudio`. |
| [6.2.0](/guides/references/changelog#6-2-0) | Added support for `experimentalRunEvents`. |
| [6.0.0](/guides/references/changelog#6-0-0) | Removed `experimentalNetworkStubbing` and made it the default behavior when using [cy.intercept()](/api/commands/intercept). |
| [6.0.0](/guides/references/changelog#6-0-0) | Deprecated `experimentalFetchPolyfill`. |
| [5.2.0](/guides/references/changelog#5-2-0) | Removed `experimentalShadowDomSupport` and made it the default behavior. |
| [5.1.0](/guides/references/changelog#5-1-0) | Added support for `experimentalNetworkStubbing`. |
| [5.0.0](/guides/references/changelog#5-0-0) | Removed `experimentalGetCookiesSameSite` and made it the default behavior. |
| [4.9.0](/guides/references/changelog#4-9-0) | Added support for `experimentalFetchPolyfill`. |
| [4.8.0](/guides/references/changelog#4-8-0) | Added support for `experimentalShadowDomSupport`. |
| [4.6.0](/guides/references/changelog#4-6-0) | Added support for `experimentalSourceRewriting`. |
| [4.5.0](/guides/references/changelog#4-5-0) | Added support for `experimentalComponentTesting`. |
| [4.3.0](/guides/references/changelog#4-3-0) | Added support for `experimentalGetCookiesSameSite`. |
| Version | Changes |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| [13.14.0](/guides/references/changelog#13-14-0) | Added support for configuring the Experimental Just-In-Time (JIT) Compiling for Component Testing via `experimentalJustInTimeCompile`. |
AtofStryker marked this conversation as resolved.
Show resolved Hide resolved
| [13.4.0](/guides/references/changelog#13-4-0) | Added support for configuring the Experimental Flake Detection strategy via `retries.experimentalStrategy` and `retries.experimentalOptions`. |
| [12.6.0](/guides/references/changelog#12-6-0) | Removed `require`/`import` and added `Cypress.require` for `experimentalOriginDependencies`. |
| [12.4.0](/guides/references/changelog#12-4-0) | Added `experimentalSkipDomainInjection` and `experimentalMemoryManagement`. |
| [12.0.0](/guides/references/changelog#12-0-0) | Removed `experimentalSessionAndOrigin` and made it the default behavior. Added `experimentalOriginDependencies`. |
| [11.2.0](/guides/references/changelog#11-2-0) | Added `experimentalRunAllSpecs`. |
| [10.8.0](/guides/references/changelog#10-8-0) | Added `experimentalWebKitSupport`. |
| [10.6.0](/guides/references/changelog#10-6-0) | Added support for `experimentalSingleTabRunMode`. |
| [10.4.0](/guides/references/changelog#10-4-0) | Added support for `experimentalModifyObstructiveThirdPartyCode`. |
| [9.6.0](/guides/references/changelog#9-6-0) | Added support for `experimentalSessionAndOrigin` and removed `experimentalSessionSupport`. |
| [8.2.0](/guides/references/changelog#8-2-0) | Added support for `experimentalSessionSupport`. |
| [7.1.0](/guides/references/changelog#7-1-0) | Added support for `experimentalInteractiveRunEvents`. |
| [7.0.0](/guides/references/changelog#7-0-0) | Removed `experimentalComponentTesting` and made it the default behavior. |
| [6.7.0](/guides/references/changelog#6-7-0) | Removed `experimentalRunEvents` and made it the default behavior. |
| [6.3.0](/guides/references/changelog#6-3-0) | Added support for `experimentalStudio`. |
| [6.2.0](/guides/references/changelog#6-2-0) | Added support for `experimentalRunEvents`. |
| [6.0.0](/guides/references/changelog#6-0-0) | Removed `experimentalNetworkStubbing` and made it the default behavior when using [cy.intercept()](/api/commands/intercept). |
| [6.0.0](/guides/references/changelog#6-0-0) | Deprecated `experimentalFetchPolyfill`. |
| [5.2.0](/guides/references/changelog#5-2-0) | Removed `experimentalShadowDomSupport` and made it the default behavior. |
| [5.1.0](/guides/references/changelog#5-1-0) | Added support for `experimentalNetworkStubbing`. |
| [5.0.0](/guides/references/changelog#5-0-0) | Removed `experimentalGetCookiesSameSite` and made it the default behavior. |
| [4.9.0](/guides/references/changelog#4-9-0) | Added support for `experimentalFetchPolyfill`. |
| [4.8.0](/guides/references/changelog#4-8-0) | Added support for `experimentalShadowDomSupport`. |
| [4.6.0](/guides/references/changelog#4-6-0) | Added support for `experimentalSourceRewriting`. |
| [4.5.0](/guides/references/changelog#4-5-0) | Added support for `experimentalComponentTesting`. |
| [4.3.0](/guides/references/changelog#4-3-0) | Added support for `experimentalGetCookiesSameSite`. |