@cypress/webpack-batteries-included-preprocessor
5.0.0 · 26 Aug 2026MIT154.9k / weekRepositoryHomepagenpmAtom feed
52 stable releases, newest first, by release line. Notes are quoted as the maintainers published them.
- 5.x · latest line
5.0.0
26 Aug 2026- Deprecated
The
cypress-plugin-retriesplugin has been deprecated in favor of test retries built into Cypress. Addresses #1313. - Breaking
Cypress no longer supports file paths with a question mark
?in them. We now use the webpack preprocessor by default and it does not support files with question marks. Addressed in #7982. - Breaking
Cypress now requires TypeScript 3.4+. Addressed in #7856.
Released 8/19/2020
Summary:
Cypress now includes support for test retries! Similar to how Cypress will retry assertions when they fail, test retries will allow you to automatically retry a failed test prior to marking it as failed. Read our new guide on Test Retries for more details.
Breaking Changes:
Please read our Migration Guide which explains the changes in more detail and how to change your code to migrate to Cypress 5.0.
- Deprecated
The
cypress-plugin-retriesplugin has been deprecated in favor of test retries built into Cypress. Addresses #1313. The
Cypress.Cookies.defaults()whitelistoption has been renamed topreserveto more closely reflect its behavior. Addressed in #7782.The
blacklistHostsconfiguration has been renamed toblockHoststo more closely reflect its behavior. Addressed in #7622.The
cy.server()whitelistoption has been renamed toignoreto more closely reflect its behavior. Addresses #6642.libgbm-devis now a requirement to run Cypress on Linux. Addressed in #7791.Values yielded by
cy.setCookie(),cy.getCookie(), andcy.getCookies()will now contain thesameSiteproperty if specified. Addresses #6892.The
experimentalGetCookiesSameSiteconfiguration flag has been removed, since this behavior is now the default. Addresses #6892.The return type of the
Cypress.BlobmethodsarrayBufferToBlob,base64StringToBlob,binaryStringToBlob, anddataURLToBlobhave changed fromPromise<Blob>toBlob. Addresses #6001.- Breaking
Cypress no longer supports file paths with a question mark
?in them. We now use the webpack preprocessor by default and it does not support files with question marks. Addressed in #7982. For TypeScript compilation of spec, support, and plugins files, the
esModuleInteropoption is no longer coerced totrue. If you need to utilizeesModuleInterop, set it in yourtsconfig.json. Addresses #7575.- Breaking
Cypress now requires TypeScript 3.4+. Addressed in #7856.
- Breaking
Installing Cypress on your system now requires Node.js 10+. Addresses #6574.
In spec files, the values for the globals
__dirnameand__filenameno longer include leading slashes. Addressed in #7982.
Features:
.click(),.dblclick(), and.rightclick()now accept optionsaltKey,ctrlKey,metaKey, andshiftKeyto hold down key combinations while clicking. Addresses #486.You can now chain
.snapshot()off ofcy.stub()andcy.spy()to disabled snapshots during those commands. For example:cy.stub().snapshot(false). Addresses #3849.
Bugfixes:
The error
Cannot set property 'err' of undefinedwill no longer incorrectly throw when rerunning tests in the Test Runner. Fixes #7874 and #8193.Cypress will no longer throw a
Cannot read property 'isAttached' of undefinederror duringcypress runon Firefox versions >= 75. Fixes #6813.The error
Maximum call stack size exceededwill no longer throw when callingscrollIntoViewon an element in the shadow dom. Fixes #7986.Cypress environment variables that accept arrays as their value will now properly evaluate as arrays. Fixes #6810.
Elements having
display: inlinewill no longer be considered hidden if it has child elements within it that are visible. Fixes #6183.When
experimentalShadowDomSupportis enabled,.parent()and.parentsUntil()commands now work correctly in shadow dom as well as passing a selector to.parents()when the subject is in the shadow dom. Fixed in #8202.Screenshots will now be correctly taken when a test fails in an
afterEachorbeforeEachhook after the hook has already passed. Fixes #3744.Cypress will no longer report screenshots overwritten in a
cy.screenshot()onAfterScreenshotoption as a unique screenshot. Fixes #8079.Taking screenshots will no longer fail when the screenshot names are too long for the filesystem to accept. Fixes #2403.
The "last used browser" will now be correctly remembered during
cypress openif a non-default-channel browser was selected. Fixes #8281.For TypeScript projects,
tsconfig.jsonwill now be loaded and used to configure TypeScript compilation of spec and support files. Fixes #7006 and #7503.reporterStatsnow correctly show the number of passed and failed tests when a test passes but theafterEachfails. Fixes #7730.The Developer Tools menu will now always display in Electron when switching focus from Specs to the Test Runner. Fixes #3559.
Documentation Changes:
We have a new guide on Test Retries.
Our Migration Guide has a new section for 5.0 migration.
Misc:
Cypress now uses the webpack preprocessor by default to preprocess spec files.
The Runs tab within the Test Runner has a new improved design when the project has not been set up or login is required. Addressed in #8141.
The type for the
Windowobject returned fromcy.window()is now correct. Addresses #7856.The type definition for Cypress's
ApplicationWindowcan now be extended. Addresses #7856.The type definition for
reporterOptionshas been added. Addresses #7877.
Dependency Updates
Upgraded Chrome browser version used during cypress run and when selecting Electron browser in cypress open from
80to83. Addressed in #7791.Upgraded bundled Node.js version from
12.8.1to12.14.1. Addressed in #7791.Upgraded
chalkfrom2.4.2to4.1.0. Addressed in #7650.Upgraded
cli-table3from0.5.1to0.6.0. Addressed in #7650.Upgraded
electronfrom8.3.1to9.2.0. Addressed in #7791 and #8235.Upgraded
execafrom1.0.0to4.0.2. Addressed in #7650.Upgraded
expressfrom4.16.4to4.17.1. Addressed in #8179.Upgraded
fs-extrafrom8.1.0to9.0.1. Addressed in #7650.Upgraded
log-symbolsfrom3.0.0to4.0.0. Addressed in #7650.Upgraded
tmpfrom0.1.0to0.2.1. Addressed in #7650.
- 4.x
4.2.0
15 Jul 2026Videos can now be recorded when running Electron in
--headedmode. Addresses #1767.cypress cache listnow prints the last time the cached binary was accessed for each version present. Addresses #6682.
Released 3/16/2020
Features:
Videos can now be recorded when running Electron in
--headedmode. Addresses #1767.cypress cache listnow prints the last time the cached binary was accessed for each version present. Addresses #6682.
Bugfixes:
We fixed a regression in 3.8.3 where HTTPS requests could experience slowdown. Fixes #6659.
We now detect some installations of Firefox that were previously undetected. Fixes #6669.
We fixed a race condition where an asynchronous error could fail to be caught when running the plugins file process. Fixes #6570.
We now more thoroughly ensure the parent of an element exists when recursively calling actionability checks in order to prevent some maximum call stack errors. Fixes #6707.
Specfiles containing
&or%characters now correctly run instead of erroring. Fixes #4210.We added support for running tests on Jira plugins even when Jira scripts were not minified. Fixes #1436.
We fixed a bug causing specs to hang after rerunning tests during
cypress openwhen there was an exception if thrown in anafterhook. Fixes #6619.cypress verifyno longer incorrectly prints messaging about this being the first time using that Cypress version. Fixes #6607.Screenshots no longer fail to be taken in Electron when Cypress
DEBUGlogs are enabled. Fixes #6662.
Misc:
A warning is now printed when setting the reserved key
CYPRESS_INTERNAL_ENVto a non-production value. Addresses #6436.When DEBUG logs are printed from
cypress:launcher, they now print a clearer log during browser detection for easier reading. Addresses #6700.The Test Runner now renders ANSI colors when there is a syntax error in the spec file. Addresses #6533.
The Test Runner now has an icon indicating whether the specs list parent folder is collapsed. Addresses #6277.
There's better type information for
.click,.dblclick, and.rightclickcommand'spositionargument. Addresses #6341.There's a more robust type signature for
.its()and.invoke(). Addresses #6431.Using
Cypress.dom.isDetachedno longer throws a type error in TypeScript projects. Addresses #4408.Using
cy.clearLocalStorage({ log:false })no longer throws a type error in TypeScript projects. Addresses #6615.We added types for
Cypress.sinon. Addresses #6720.We've added the foundational work required to support experimental features in the Test Runner. Addresses #6257.
Dependency Updates
Upgraded Chrome browser version used during
cypress runand when selecting Electron browser incypress openfrom78to80. Addressed in #6555.Upgraded
electronfrom7.1.13to8.1.1. This bumps the bundled Chromium to 80.0.3987.141 and the bundled Node to 12.13.0. Addressed in #6555.Upgraded
@ffmpeg-installer/ffmpegfrom1.0.19to1.0.20. Addressed in #6686.Upgraded
minimistfrom1.2.0to1.2.2. Addressed in #6726.Replaced deprecated
requestwithcypress-io/request. Addressed in #6679.
4.1.1
9 May 20264.1.0
13 Apr 2026There is a new
cypress infocommand to see the locally detected browsers and other information related to Cypress. Addresses #4540.You can now click a 'Try Again' button to recheck if the server at the designated
baseUrlis running within the warning message duringcypress open. Addresses #3284.The plugins file function's
configargument now includesprojectRoot(absolute path to the root of the project) andconfigFile(absolute path to the configuration file). Addresses #5941.
Released 2/28/2020
Features:
There is a new
cypress infocommand to see the locally detected browsers and other information related to Cypress. Addresses #4540.You can now click a 'Try Again' button to recheck if the server at the designated
baseUrlis running within the warning message duringcypress open. Addresses #3284.The plugins file function's
configargument now includesprojectRoot(absolute path to the root of the project) andconfigFile(absolute path to the configuration file). Addresses #5941.
Bugfixes:
Fixed a regression where Cypress could throw a "Maximum call stack size exceeded" error when transmitting a circular object over the internal WebSocket. Fixes #6582.
We fixed an issue where using Chromium-family browsers could cause Cypress to throw a "WebSocket is not open: readyState 3" error under certain conditions. Fixes #5685.
We now more thoroughly ensure the parent of an element exists when recursively calling visibility and existence checks in order to prevent some maximum call stack errors. Fixes #4373.
We fixed an issue where a maximum call stack error would throw in some circumstances when
xhr.onreadystatechangeis accessed. Fixes #5864.We fixed a regression in 3.5.0 where typing into an iframe with a body element with the contenteditable attribute would throw an error. Fixes #5930.
We now set the default window size when running Chrome headlessly to 1280x720. Fixes #6210.
We fixed an issue where
cypress installwould not complete on Node.js 8.0.0. Fixes #6512 and #6568.{% url "
cy.clearLocalStorage()" clearlocalstorage now properly accepts thelogoption to disable logging. Fixes #6342.
Misc:
The error messages displayed when rerouting to a non same-origin domain has been updated to more accurately reflect the rules around same-origin policy. Addresses #6048.
We fixed an error message that would display the wrong available browser families during validation. Addressed in #6517.
We fixed some typos in some of our error messages. Addressed in #6508.
We're collecting more environment variables when running Cypress with GitLab CI. Addresses #6231.
The typing of
cy.$$has been updated to distinguish differences between it andCypress.$. "More info here" $#Cypress-vs-cy Addresses #2027.We're continuing to make progress in converting our codebase from CoffeeScript to JavaScript. Addresses #2690 in #6552, #6523, and #6545.
Dependency Updates
Upgraded
electronfrom7.1.10to7.1.13. Addressed in #6566.
4.0.2
27 Aug 2025Fixed a bug where Firefox tests could fail to run on macOS if another instance of Firefox was open. Addresses #6380.
Updated
@cypress/browserify-preprocessorto2.1.4, fixing a regression involving non-top-levelrequire()s in tests. Addresses #6403.Fixed a bug where re-running a failed workflow in GitHub Actions would not generate a new Dashboard run. Addresses #6450.
Released 2/14/2020
Bugfixes:
Fixed a bug where Firefox tests could fail to run on macOS if another instance of Firefox was open. Addresses #6380.
Updated
@cypress/browserify-preprocessorto2.1.4, fixing a regression involving non-top-levelrequire()s in tests. Addresses #6403.Fixed a bug where re-running a failed workflow in GitHub Actions would not generate a new Dashboard run. Addresses #6450.
Fixed incorrect type definitions for
Cypress.isBrowser. Addresses #6447.Fixed a regression introduced in 4.0.0 where using
.should('contain', ...)on acy.contains()would produce unexpected results. Addresses #6384.
Misc:
4.0.1
19 Aug 2025Fixed a bug where Chromium could not be detected on macOS. Addresses #6358.
Fixed a bug where 64-bit editions of Firefox could not be detected on Windows. Addresses #6355.
Released 2/7/2020
Bugfixes:
Fixed a bug where Chromium could not be detected on macOS. Addresses #6358.
Fixed bugs where Edge and Firefox Nightly could not be detected on macOS. Addresses #6354 and #6345.
Fixed a bug where 64-bit editions of Firefox could not be detected on Windows. Addresses #6355.
Fixed a bug where video recordings of Firefox would omit all frames from before the last cross-domain navigation of the test. Addresses #6369.
Fixed a bug where Cypress could crash with the message "cannot read property 'on' of undefined" while running Firefox. Addresses #6356.
Corrected a link to the screenshot API documentation in the type definitions. Addresses #6359.
Misc:
Updated the default preferences set on Firefox to hide update notifications and otherwise improve the Firefox experience. Addresses #6346.
4.0.0
8 Aug 2025- Breaking
The
--browserflag no longer acceptscanaryas its sole argument to run Chrome Canary. You now have to specifychrome:canaryto use the Chrome Canary browser. Addresses #6243. - Breaking
Installing Cypress on your system now requires Node.js 8+. Addresses #5632.
Released 2/6/2020
Summary:
Cypress 4.0.0 includes support for Mozilla Firefox browsers (beta support) and Microsoft Edge (Chromium based) browsers which is a big step forward for Cross Browser Testing in Cypress. We've also updated many of the underlying tools behind Cypress that bring new powerful features.
Breaking Changes:
:warning: Please read our Migration Guide which explains the changes in more detail and how to change your code to migrate to Cypress 4.0.
Mocha, Chai, and Sinon.JS has been upgraded which includes a number of breaking changes and new features. Addresses #2528, #2529, #2866.
During
before:browser:launch, we no longer yield the second argument as an array of browser arguments and instead yield anoptionsobject with anargsproperty in order to support more advanced browser launch options. Addresses #6306.We updated the Cypress browser objects of all Chromium-based browsers, including Electron, to have
chromiumset as theirfamilyfield. Addresses #6243.- Breaking
The
--browserflag no longer acceptscanaryas its sole argument to run Chrome Canary. You now have to specifychrome:canaryto use the Chrome Canary browser. Addresses #6243. cy.writeFile()now yieldsnullinstead of the contents written to the file in order to more align with the behavior offs. Addresses #2466.- Breaking
Installing Cypress on your system now requires Node.js 8+. Addresses #5632.
Cypress no longer support CJSX. Addresses #3469.
Features:
Mozilla Firefox browsers now have beta support. Addresses #1096.
Microsoft Edge (Chromium based) browsers are now supported. Addresses #5433.
There is a new
Cypress.isBrowser()utility function. Addresses #2023.We updated the
Cypress.browserobject with a newchannelproperty which contains the release channel of the detected browser. Addresses #6243.Appending
.onlyto multiple tests or suites will now run all tests with the.onlyproperty. Addresses #2828.The
isFiniteassertion is now supported. Addresses #5669.The
emptyassertion is now supported when used against Map objects. Addresses #6072.The
nestedassertion chainer property is now supported. Addresses #3080 and #5004.
Bugfixes:
A test or suite appended with an
.onlywhen multiple tests or suites contained the same title now run correctly. Fixes #5345.The
.its()command now properly supports 0 as a value for indexes or object keys. Fixes #6216.
Documentation Changes:
Added Cross Browser Testing Guide with helpful CI strategies to consider when running tests across multiple browsers.
Added
Cypress.isBrowser()doc.
Misc:
We now pass through errors caused when attempting to read arguments passed through
config. Addresses #6279.We fixed a broken 'Learn more' link within the Node.js Version panel of the Test Runner Settings. Addresses #6237.
The browser icons in the Test Runner now display as images with the proper branding. Addresses #6188.
We updated the styling of browser dropdown in the Test Runner to look more like a button. Addresses #6298.
The timer in the Test Runner now always displays at a consistent length. Addresses #6168.
You can print debug information about the memory & CPU usage of Cypress, which can be accessed by enabling the
cypress:server:util:process_profilerdebug stream. Addresses #6169.We added types for plugin events. Addresses #6322.
Dependency Updates
Added
@benmalka/foxdriver. Addressed in #1359.Upgraded
@cypress/browserify-preprocessorfrom1.1.2to2.1.1. Addressed in #4308 and #4226.Upgraded
bluebirdfrom3.5.0to3.7.2. Addressed in #4226.Upgraded
cachedirfrom1.3.0to2.3.0. Addressed in #4208 and #4226.Upgraded
chaifrom3.5.0to4.2.0. Addressed in #2862 and #4226.Upgraded
chai-as-promisedfrom6.0.0to7.1.1. Addressed in #4226.Upgraded
chalkfrom2.4.0to3.0.0. Addressed in #4226.Upgraded
commanderfrom2.15.1to4.0.1. Addressed in #4208 and #4226.Upgraded
debugfrom2.15.1to4.0.1. Addressed in #4226.Upgraded
execafrom0.10.0to3.3.0. Addressed in #4226.Added
firefox-profiler. Addressed in #1359.Added
foxdriver. Addressed in #1359.Upgraded
fs-extrafrom5.0.0to8.1.0. Addressed in #4226.Upgraded
getosfrom3.1.1to3.1.4. Addressed in #4226.Upgraded
is-cifrom1.2.1to2.0.0. Addressed in #4226.Upgraded
mochafrom2.5.3to7.0.1. Addressed in #2703 and #4226.Upgraded
listrfrom0.12.0to0.14.3. Addressed in #4226.Upgraded
log-symbolsfrom2.2.0to3.0.0. Addressed in #4226.Added
marionette-client. Addressed in #1359.Upgraded
ramdafrom0.24.1to0.26.1. Addressed in #4226.Upgraded
sinonfrom3.2.0to8.1.1. Addressed in #2881 and #4226.Upgraded
strip-ansifrom3.0.1to6.0.0. Addressed in #1359.Added
systeminformation. Addressed in #1359.Upgraded
support-colorsfrom5.5.0to7.1.0. Addressed in #4208 and #4226.Upgraded
untildifyfrom3.0.3to4.0.0. Addressed in #4226.
- 3.x
3.1.2
24 Jul 2025Fixed a regression caused in
3.1.1where we attempted to set a property on an invalid cookie sent from a server. Fixes #2724.Fixed Cypress not correctly aborting long running connections (such as server sent events) on proxied requests. Fixes #2612.
Fixed bug where tests were failing due to assertions causing Cypress to accidentally iterate through cross origin iframes. If you were seeing "random" cross origin errors, this likely fixes those issues. Fixes #2784.
Released 11/18/2018
Bugfixes:
Fixed a regression caused in
3.1.1where we attempted to set a property on an invalid cookie sent from a server. Fixes #2724.Fixed Cypress not correctly aborting long running connections (such as server sent events) on proxied requests. Fixes #2612.
Fixed bug where tests were failing due to assertions causing Cypress to accidentally iterate through cross origin iframes. If you were seeing "random" cross origin errors, this likely fixes those issues. Fixes #2784.
Fixed incorrectly setting
charCodeandkeyCodewhen using .type() on a few different special characters such as{. Fixes #2105.Fixed another regression in
3.1.1where passingundefinedto asetTimeoutcaused Cypress to error. Fixes #2719.Fixed a bug in node core where Cypress would not show up in
Windowsfor users onnode >= 11. Fixes #2667.Fixed a bug with trashing assets in linux that caused recursive
.Trashfiles to show up. We now have opted to actuallyrm -rfthe files in linux because trashing is too inconsistent between linux distros. Fixes #2742.
Misc
Added type definitions for
Cypress.moment(). Fixes #2746.We now display better error messages in the CLI when runs exceed billing limits. Fixes #1689.
Dependency Updates
Removed
progress#2733.
3.1.1
1 Jul 2025Infinite
.Trash-0folder on Ubuntu 16Setting HTTPS cookies in certain situations
You can now pass a
flagoption tocy.writeFile(). The following flags are available. Fixes #1249.
Released 11/2/2018
Known regressions in this release ⚠️
Infinite
.Trash-0folder on Ubuntu 16Setting HTTPS cookies in certain situations
Features:
You can now pass a
flagoption tocy.writeFile(). The following flags are available. Fixes #1249.There is a new
CYPRESS_DOWNLOAD_MIRRORenvironment variable for installing Cypress at a mirror url. Fixes #2609.The Module API now returns the
runUrlfromcypress.run(). Fixes #2596.Specs now properly display as focused when navigating through specs via the keyboard. Fixes #2273.
Bugfixes:
Fixed a bug where Cypress would error when a secure cookie flag was set and then expired from an
httpsurl without the subsequent secure flag. Due to the way Cypress was constructing the url, this would fail to actually remove the cookie. Fixes #1264, #1321, #1799.We now truncate filenames for screenshots to not exceed 255 characters in length. Previously there were cases where the screenshot filename would exceed 255 characters and error. Fixes #2403 and #2665.
Fixed issue when using
cy.writeFile()and passing an object to a.jsonfile. The object is now correctly written to the JSON file instead of a string. Fixes #2373.We updated how we handle
trashAssetsBeforeRunsbehavior. We now trash the contents of thescreenshotsFolderandvideosFolderdirectories instead of trashing the directories themselves. This helps maintain any file access permissions for the directories. Fixes #1943 and #2600.Fixed bug where mocked Dates using
cy.clock()would not be an instance ofDate. Fixes #2570.Directories within specs whose names contain
.are now correctly read as directories instead of spec files within the Test Runner. Fixes #2423.Cypress no longer automatically takes screenshots of skipped tests. Fixes #2368.
Fixed an issue where returning/resolving
undefinedfrom acy.task()handler resulted in an incorrect runtime error. Fixes #2553.Update
modifyObstructiveCodeto account for framebusting techniques that usewindow.frameElement, so that Applications using this technique will run properly in Cypress. Fixes #2582.Fixed bug where only the first DOM element of an array of DOM elements would be blacked out after being passed as argument to
blackoutwithincy.screenshot(). Fixes #2508.We fixed an issue involving timers after running
cy.screenshot(). Fixes #2432.The Test Runner now retries node-originated errors from our internal API requests. Fixes #2341
Fixed issue with multiple
readyStateChangeswith the samereadyState. Fixes #1150.Fixed Type error being thrown for users using TypeScript 3. Fixes #2363.
Misc
We are now collecting more environment variables from runs when run in Semaphore, GitLab, Bitbucket, Team Foundation Server, Codeship, and Shippable. Fixes #2460, #2358, #2343, and #2453.
We now display better error messages in the CLI when runs exceed billing limits. Fixes #1689.
The Test Runner's search now resets when switching between projects. Fixes #2512.
Fixed internal Cypress tests. Fixes #2606.
Replaced use of
new BufferwithBuffer.from. Fixes #2626.Whitelisted
autoScrollingEnabledto be saved instate.json. Fixes #2476.Fixed internal test error
beforeSpecRun is not a function. Fixes #2401.Switched our internal tests to use CircleCI workspaces. Fixes #2398.
Update TypeScript definition for
cy.screenshot()to include screenshot specific options. Fixes #2654.Urls printed within the CLI will now display as the color blue. Fixes #2493.
We began bulk converting some of our codebase from CoffeeScript to JavaScript. Fixes #2686 and #2687.
We updated some of our internal ESLint rules to be more strict and also to help with CoffeeScript to JavaScript conversions. Fixes #2688.
Dependency Updates
Upgraded common-tags from
^1.4.0to^1.8.0#2415Upgraded @cypress/browserify-preprocessor from
1.1.0to1.1.1#2513Upgraded lolex from
^1.5.2to^3.0.0#2570
Upgraded @types/jquery from
3.2.16to3.3.6#2363
Upgraded zunder from
5.6.5to6.1.1#2541
Documentation Changes:
Added
flagoption tocy.writeFile()doc.Added
runUrlto returned run in Module API doc.Documented new
CYPRESS_DOWNLOAD_MIRRORflag and rewrote advanced install instructions to be clearer in Installing Cypress doc.
3.1.0
13 May 2025Cypress can now run tests in parallel across multiple virtual machines, or can be parallelized on a single machine. Cypress will automatically figure out, detect, and load balance all of your specs in the fastest and most efficient way possible. There is no configuration other than passing a
--parallelflag and spinning up multiple machines on your CI provider. From our experiments you can expect to see approximately 40% reduction in overall run time per machine you add. However, attempting to run in parallel on a single machine requires server grade hardware with dozens (or even hundreds) of CPU's and GB of RAM to run efficiently. A much better and simpler approach is to use a cluster of docker containers that are all isolated from each other. Any standard CI service (CircleCI, TravisCI, etc) comes with the ability to do this. We automatically tap into their environment variables to make parallelization possible without you having to configure anything.Beyond parallelization, you now have the ability to group multiple runs with each other so that they show up together (grouped) in the Dashboard. This enables you to test different applications, groups of specs, or different environments (like development, staging, production) and see all of the results together. We know how important cross browser testing is to everyone, so we built this to lead directly into aggregating the results of multiple browsers into a single run.
The Dashboard Service has been updated to show you more visual information about what happened during a run. You can see how specs were parallelized and you can calculate the effect of adding or removing machines to help reduce the overall run time.
Released 8/13/2018
Summary:
Cypress can now run tests in parallel across multiple virtual machines, or can be parallelized on a single machine. Cypress will automatically figure out, detect, and load balance all of your specs in the fastest and most efficient way possible. There is no configuration other than passing a
--parallelflag and spinning up multiple machines on your CI provider. From our experiments you can expect to see approximately 40% reduction in overall run time per machine you add. However, attempting to run in parallel on a single machine requires server grade hardware with dozens (or even hundreds) of CPU's and GB of RAM to run efficiently. A much better and simpler approach is to use a cluster of docker containers that are all isolated from each other. Any standard CI service (CircleCI, TravisCI, etc) comes with the ability to do this. We automatically tap into their environment variables to make parallelization possible without you having to configure anything.Beyond parallelization, you now have the ability to group multiple runs with each other so that they show up together (grouped) in the Dashboard. This enables you to test different applications, groups of specs, or different environments (like development, staging, production) and see all of the results together. We know how important cross browser testing is to everyone, so we built this to lead directly into aggregating the results of multiple browsers into a single run.
The Dashboard Service has been updated to show you more visual information about what happened during a run. You can see how specs were parallelized and you can calculate the effect of adding or removing machines to help reduce the overall run time.
Features:
cypress runaccepts a new--parallelflag to run specs in parallel. Fixes #1690 and #64 and #2297.cypress runaccepts a new--groupflag to group multiple spec files within a single run. Fixes #2169cypress runaccepts a new --ci-build-id flag. Fixes #2153.
Bugfixes:
We've finally tracked down the source of specs "hanging" and failing to start when running Electron. We finally tracked it down to a bug in Electron itself with setting
menuwhen using offscreen rendering. Fixes #2322 and #2294.Clicking on svg elements is now working. 3.0.2 introduced a bug that would throw an 'illegal invocation' error. Fixes #2245 and #2252 and #2258 and #2277 and #2288.
Fixed a regression in
3.0.2that caused typing{enter}not to submit a form when there were<button>elements other thantype='submit'. Fixes #2261 and #2326.Fixed a small visual bug where failed commands were not aligned to other commands. Fixes #2314.
Fixes a race condition where async electron browser commands came in after the renderer had been destroyed, causing failures. Fixes #2321.
Misc
When recording to the Dashboard Service, we now provide estimated durations per spec directly within the standard output, as long as the spec has had enough run history for this to be determined. Fixes #2276.
When using the new
--parallelor--groupfeature, we now visually indicate that to you in the standard output when recording. Fixes #2275.We have added support for more CI providers to automatically detect and show more relevant information in the Dashboard, instead of showing 'Unknown'. Fixes #2146.
We have added better checks and reliability for detecting runs in Jenkins. Fixes #1990.
The built in
cypress-browserify-preprocessorwas bumped to1.1.0. This supports more JavaScript features by default, including async/await, object rest spread, and class properties. Fixes #2254.cypress runnow creates a new browser profile per run per browser, but keeps the same browser profile for interactive mode withcypress open. This means you can run Cypress locally over multiple processes and the browser profiles will not conflict with each other. Fixes #1566.The Desktop-GUI has been updated to get the new routes provided by the Cypress API for runs. Fixes #2189.
Cypress now retries multiple times (with a backoff strategy) when communicating with our API fails while recording runs. This will provide better feedback in situations when the API is temporarily unavailable. Fixes #1590.
When Cypress retries due to an API timeout or failure it now displays a very nice message indicating to you the delay and number of retries left. Fixes #2280.
We've added parallelization to our own internal tests for the driver and the desktop-gui. We've been able to reduce the number of concurrent instances our tests use by 4, and shaved about 6 minutes off of each build. Faster with less resources. Fixes #2325.
Documentation Changes:
3.0.3
7 Jun 2024Reverted the Chrome argument that disabled
RootLayerScrollingwhich was used to prevent the application under test from "shaking" due to a bug in versions 66 and 67. This workaround inadvertently created a different and much more severe bug in Chrome 68 that would miscalculate pointer coordinates. This led to Cypress giving confusing errors about elements being covered up on action. This is still a bug in Chrome, and is fixed in Canary but has not yet been released to the stable Chrome 68 channel. Nevertheless, removing theRootLayerScrollingflag does fix it. We did several experiments to try to ensure that the "shaking" behavior does not exhibit itself in Chrome 68. We have limited the--disable-blink-features=RootLayerScrollingflag to Chrome 66 and Chrome 67. Fixes #2223 and #2215 and #2037.Fixed another bug with Chrome that caused the
chromeWebSecurity: falseoption to not be respected. This was due to Chrome progressively rolling out trials of a new option that attempts to isolate sites (and iframes) in their own child process if their origins are different. Fixes #1951 and #2001 and #715.
Released 7/30/2018
Bugfixes:
Reverted the Chrome argument that disabled
RootLayerScrollingwhich was used to prevent the application under test from "shaking" due to a bug in versions 66 and 67. This workaround inadvertently created a different and much more severe bug in Chrome 68 that would miscalculate pointer coordinates. This led to Cypress giving confusing errors about elements being covered up on action. This is still a bug in Chrome, and is fixed in Canary but has not yet been released to the stable Chrome 68 channel. Nevertheless, removing theRootLayerScrollingflag does fix it. We did several experiments to try to ensure that the "shaking" behavior does not exhibit itself in Chrome 68. We have limited the--disable-blink-features=RootLayerScrollingflag to Chrome 66 and Chrome 67. Fixes #2223 and #2215 and #2037.Fixed another bug with Chrome that caused the
chromeWebSecurity: falseoption to not be respected. This was due to Chrome progressively rolling out trials of a new option that attempts to isolate sites (and iframes) in their own child process if their origins are different. Fixes #1951 and #2001 and #715.Fixed Cypress hanging in CI due to excessive and unnecessary globbing. We finally tracked down this issue which made it appear as if Cypress was "hanging" after closing a spec file and then attempting to open the next one. Fixes #2183 and #1905 and #1912.
We are now properly serializing nested object arguments when using the Module API via
cypress.open()orcypress.run(). Passing nested objects inreporterOptionsnow works correctly. This is especially useful when usingmocha-multi-reporters. In addition to fixing the Module API, we are now also properly handling nested arguments from the Command Line. In order to pass nested objects within CLI params you must pass stringified JSON. This is useful for properties such asblacklistHosts. Fixes #1348 and #1357 and #2221.Fixed a bug causing screenshots saved via
cy.screenshot()to be in different folders when you ran usingcypress runvscypress run. Fixes #2091.Fixed bugs with Electron losing focus when running headlessly via
cypress runafter navigation. Now the browser will always act as if it is focused no matter what and in all situations when running headlessly. If you were seeing focus related problems when running headlessly, this should fix them. Fixes issue #2190.Fixed using when using
cy.click()on an element that bound to thefocusevent while the browser was currently out of focus. We have now normalized all focus and blur events to behave the same as if the browser is always in focus. This should fix the other batch ofblurandfocusissues that users have been experiencing. Fixes #549 and #2198.Fixed the vast majority of known issues with
.type(). Fixes #1241.Using
.type()on an input of typeemailornumberwill no longer fire unnecessary additionalblurandfocusevents. Fixes #2210.Fixed
.type()breaking on chains when passing the sameoptionsreferences. Fixes #365.Fixed an issue with
.clear()not behaving the same ascy.type('{selectall}{backspace}'). Fixes #420.Fixed a bug with issuing an additional
blurandclickevent when chaining.clear().type(...). Fixes #593.Fixed many issues with typing into
[contenteditable]elements. WYSIWYG, Draft.js based, and other HTML editors now work correctly. Fixes #596 and #1686 and #2096.The caret now correctly moves on
[contenteditable]elements. Fixes #1108.Fixed
.type()inserting a rogue<br>tag after the first letter in[contenteditable]elements. Fixes #1926.Fixed issue where change events with
.type()would not fire correctly for many more situations and edge cases. Fixes #651.Fixed issues with typing into JS based text-mask plugins. Basically anything that would alter the
.valuein response to certain events now works correctly. Fixes #940 and #1684.Using
.clear()on an input with amaxlengthattribute now works. Fixes #1002 and #2056.Fixed issues with
.type()not firing thechangeevent oninput[type=number]. Fixes #1171.Fixed other event related issues with
.type()that were not firing correctly. Fixes #1209.Fixed even more issues with
.type()not inserting characters oninput[type=number]. Fixes #1381.Fixed not being able to type negative numbers into
input[type=number]elements. Fixes #2173.Fixed
selectionStartandselectionEndwith.type()when using{leftarrow}or{rightarrow}. Fixes #1234.Fixed not being able to type into a
datetime-localinput. Fixes #1366.Calling
.focus()or.blur()oncy.window()no longer fires blur events on theactiveElementor causes it to becomebody. Fixes #2234.Using
cy.get('body').click()now correctly changes theactiveElementback tobodyand causes the existingactiveElementto receiveblur. Fixes #2236.
Misc:
We've loosened up the restrictions surrounding what we consider a typeable element. You can now type into inputs with invalid
typeattributes because the browser does still consider them regulartextinputs and allows you to type into them. Fixes #586.Using
{uparrow}or{downarrow}with.type()on aninput[type=number]element now increments or decrements the number configured via thestepattribute. Fixes #2110.Using
{uparrow}or{downarrow}with.type()now correctly moves the cursor ontextareaor[contenteditable]elements. Fixes #2187.You can now use
.focus()or.blur()oncy.get('body'). Fixes #2235.Bumped the version in
junitreporter dep from1.12.1to1.17.0which adds a few new features. Fixes #2238.Bumped deps that
npm auditwas yelling about. Fixes #1701.Runs showing up in the
Runstab now more closely match how they display in the Dashboard. Fixes #2060.Added more debug logs. Fixes #2108.
When recording to the Dashboard we now more accurately collect commit details when it is missing from the local
gitdata. Fixes #2129 and #2073.We now collect the pull request information if you are recording in a CI provider that connects commits to PRs. Fixes #1844.
Updated build in example kitchen sink to
1.0.2. Fixes #2139.Updated the json-schema describing
videoCompression. Allowing it to be a boolean. Fixes #2140.
Documentation Changes:
3.0.2
31 Aug 2023Screenshots taken with
cy.screenshot()on 2x DPI are now taken at the correct full size. Fixes #1857 and #2018.
Released 6/28/2018
Bugfixes:
Screenshots taken with
cy.screenshot()on 2x DPI are now taken at the correct full size. Fixes #1857 and #2018.Windows users no longer exit with
EPIPEerrors when runningcypress runin newer versions of node. Fixes #1841 and #2044.Fixed issue where applications programmatically stealing focus would lead to slow runs in Electron when running via
cypress run. #1909 and #1892.Electron no longer reports the browser as out of focus when running via
cypress run. Fixes #1939.Modified the
document.hasFocus()method to returntrueif the top window (Cypress window) is in focus. This should now correctly match how your application behaves outside of Cypress. Fixes #1940.Fixed issue where Cypress would unnecessarily scroll when attempting to locate elements with
position: sticky. Fixes #1475.Fixed a bug where changing the
integrationFolderin Windows would lead to errors with plugins. Fixes #1704.Cypress no longer crashes when a 3rd party server sends invalid
gzipcontent. Also fixed issues with incorrectly gunzipping multibyte characters which would potentially lead to serving invalid HTML or JS. Fixes #1396 and #1756.The
--silentflag should now be respected duringnpm install cypresson all OSes. Fixes #817.Corrected a typo in the CLI for a warning message. Fixes #2038.
Fixed some areas of the Desktop GUI that did not display path names correctly in Windows. Fixes #1830.
The
pluginsFilenow supports an absolute path instead of just a relative one. Fixes #1837.Fixed a regression introduced in
3.x.xwhere application code that usedsetTimeoutwith a string argument would see the errorfn.apply is not a function. Fixes #1854.Fixed issue where preprocessor errors were being swallowed. Fixes #1877.
Fixed issue where Cypress would hang indefinitely when starting a new spec when in
cypress runmode. Additionally we have optimized the code path to not read in the localstate.jsonunnecessarily. Fixes #2013 and #1912 and #1905 and #1890.Fixed a couple regressions in the Dashboard where timed out runs stayed "Pending" forever. Fixes #1891 and #1952.
Fixed another Dashboard regression where an error would throw when recording tests and sending a large list of specs. Fixes #1901.
Fixed issue where videos would not be recorded when an object was returned from
before:browser:launchwhen in the Electron browser. Fixes #1992.Fixed an issue where Cypress would inject content into the
<header>tag instead of the<head>tag. Fixes #2026.Fixed an oversight where a specific framebusting check was not being properly stripped and removed by the default config option
modifyObstructiveCode. Fixes #2030 and #2059.Fixed icons visually shifting when tests were running in the Test Runner. Fixes #1983.
Server sent events now finally work correctly in Cypress. Fixes #1440 and #1111.
Time traveling snapshots now preserve the styles of empty
<style>tags with programmatically inserted CSS rules. Fixes #1226.
Misc:
There are now several new CLI commands for interacting with the binary cache:
cypress cache path,cypress cache list, andcypress cache clear. Fixes #1856.We've added a new CLI flag:
--no-exitforcypress runto keep the browser open after the tests finish running. Fixes #1871.The CLI now respects config values and environment variables put in your
.npmrcfile. Fixes #1399 and #1853.Significantly improved the performance of taking screenshots. #1863.
The bundled version of
ffmpeghas now been bumped from3.x.xto4.x.x. This may help with some issues users were experiencing when recording videos. Fixes #1972.Added more debug logs to
ffmpegto determine whyffmpegcompression sometimes causes Cypress to crash (mostly while running in Travis CI). Fixes #1971.Several improvements to TypeScript typings. Fixes #1881 and #2007 and #1899 and #1902 and #1897 and #1907.
We improved error logging and the user experience around
cypress verify. Fixes #1984.We no longer log the
skipping installmessage if the Cypress binary is already installed locally. Fixes #1985.Now, by default, screenshots are nested within a folder with the name of the spec file that is currently running. Example - the spec named
cypress/integration/foo/bar_spec.jswill save screenshots inside of this directory:cypress/screenshots/foo/bar_spec.js/*. Fixes #1826.Passing
foo/bar/bazas the fileName arg tocy.screenshot()inside a spec,app.spec.js, will now result in the screenshot being saved to a nested folder path such as:cypress/screenshots/app.spec.js/foo/bar/baz.png. Fixes #1771 and #668.We now append
(failed)to the screenshot filename of screenshots taken automatically during test failure. Fixes #1923.If multiple screenshots are taken during a test that will result in the same filename, their file paths are now appended with a number, i.e.
test name (1).png. This prevents screenshot files with the same name from being overwritten. Fixes #1766.Screenshot
onAfterScreenshotandonBeforeScreenshotcallbacks ar enow invoked for failed tests. They include atestFailureproperty to distinguish between automatic ones and your own use ofcy.screenshot(). Fixes #2040.There's now an
after:screenshotplugin event you can use in yourpluginsFileto work with screenshots after they are taken. This enables you to rename them, move their location, resize them, send them to a service, etc. Fixes #2039.Added
Cypress.browserobject which contains information about the currently running browser. Fixes #1919 and #1961.Added
Cypress.specobject which contains information about the currently running spec. Fixes #1918.Urls displayed in the Command Log during
cy.visit()are no longer arbitrarily truncated at a set width. Fixes #1995.
Documentation Changes:
3.0.1
29 Aug 2023Seeded KitchenSink tests no longer fail. Fixes #1812.
The binary cache now correctly works and will not reinstall Cypress if an existing version is already installed. Fixes #1813.
Closing the
Electronbrowser and then openingChromeno longer causescy.screenshot()to fail. Fixes #1820.
Released 5/30/2018
Bugfixes:
Seeded KitchenSink tests no longer fail. Fixes #1812.
The binary cache now correctly works and will not reinstall Cypress if an existing version is already installed. Fixes #1813.
Closing the
Electronbrowser and then openingChromeno longer causescy.screenshot()to fail. Fixes #1820.Fixed a bug with Windows users seeing crashes with
tty.getWindowSize is not a function. Fixes #1815 and #1817.
3.0.0
14 Aug 2023- Removed
screenshotOnHeadlessFailurehas been removed as an option incypress.json. Instead you can now control this behavior directly with code by settingscreenshotOnRunFailuretofalsewithin the new Screenshot API. Fixes #1140 and #1754. There is a new cy.task() command that enables you to go outside the browser to perform tasks directly in
node. This will make it easy to setup, scaffold, seed, talk to your database, or anything else useful on a backend.cy.screenshot() has been rewritten from the ground up. It now takes a screenshot of only the application under test by default. It also can take full page screenshots or element only screenshots. This is the first step of Cypress Dashboard support for screenshot diffing.
Released 5/29/2018
Summary:
There is a new cy.task() command that enables you to go outside the browser to perform tasks directly in
node. This will make it easy to setup, scaffold, seed, talk to your database, or anything else useful on a backend.cy.screenshot() has been rewritten from the ground up. It now takes a screenshot of only the application under test by default. It also can take full page screenshots or element only screenshots. This is the first step of Cypress Dashboard support for screenshot diffing.
When running with
cypress runwe now run each spec file in isolation from others. We have rewritten our reporter to provide more details and provide a summary of the run at the bottom.The Dashboard has been upgraded to make it easier to understand the results of each spec run. This was done in anticipation of providing you the ability to parallelize and load balance your spec files automatically in CI.
We are now capturing the performance and timings data of every test when using
--recordmode and are beginning to offer the first analytics and insights into the health of your tests on our Dashboard service.Cypress now caches globally per version which prevents it from being installed multiple times across projects.
Breaking Changes:
We now run each spec file in isolation from one another. This shouldn't technically break anything, but if you have set up your tests in a way that requires the state of a previous spec file, this could potentially break your tests. This will go a long ways towards reducing problems we were seeing with long runs in CI. Fixes #431, #681, #1589, #1539, and #1692.
The environment variable
CYPRESS_BINARY_VERSIONhas been removed. You should use the equivalent environment variableCYPRESS_INSTALL_BINARYinstead.The environment variable
CYPRESS_SKIP_BINARY_INSTALLhas been removed. To skip the binary install, setCYPRESS_INSTALL_BINARY=0.- Removed
screenshotOnHeadlessFailurehas been removed as an option incypress.json. Instead you can now control this behavior directly with code by settingscreenshotOnRunFailuretofalsewithin the new Screenshot API. Fixes #1140 and #1754. trashAssetsBeforeHeadlessRunshas been renamed totrashAssetsBeforeRunsin our configuration. Fixes #1754.videoRecordinghas been renamed tovideoin our configuration to be clearer and prevent confusion about recording to our Dashboard. Fixes #562.Cypress no longer copies screenshots and videos to artifacts for CircleCI. Copying artifacts should be left up to the user to handle themselves in their
circle.ymlfile. Fixes #1592.The standard output has been redesigned to better visualize spec files running in isolation and to be more visually appealing. This may break any specialized logic written that expected the standard output to be structured in a specific way or contain specific words. Fixes #1588.
cy.screenshot() no longer takes a screenshot of the runner by default. Instead it will hide the runner, remove application scaling and then scroll to take a full page picture of your application.
beforeandafterhooks within a support file now run before/after every spec file, instead of only once before/after the entire run. #681
Features:
There is a new cy.task() command for executing any arbitrary
nodecode.You can now run multiple specs by passing a glob to the
--specargument ofcypress run. Fixes #263, #416 and #681.There is a new Screenshot API and new cy.screenshot() options that allow you set defaults for how screenshots are captured, whether to scale your app, disable timers and animations, or which elements to black out in the screenshot. You can also set defaults for whether to automatically take screenshots when there are test failures or whether to wait for the Command Log to synchronize before taking the screenshot. Fixes #1424.
cy.screenshot() can now be chained off of commands that yield a DOM element and will only take a screenshot that element.
During install of cypress, the Cypress binary is now downloaded to a global cache. This prevents multiple projects from downloading the same Cypress version. Fixes #1300.
The seeded
example_spec.jsfile has been replaced by anexamplesfolder with several spec files. This more closely reflects the recommended use of Cypress - as smaller groups of tests split among many files that will now be run in isolation. The tests were also updated from ES5 to ES6. You can see all changes in thecypress-example-kitchensinkrepo Fixes #1460.Cypress now watches all the
plugins file's entire dependency tree to make iterating on plugins easier. Fixes #1407.Videos will now be saved locally with a filename named after the associated
specfile that it represents. Fixes #980.The Test Runner now displays
skippedtests differently thanpendingtests. #244.Standard output now displays the number of
skippedtests within the summary output duringcypress run. #1559.The url to view the run in the Dashboard is now printed to output during
cypress run. #494.We now print the browser and browser version run in the output during
cypress run. #833.The build number and url to CI for tests run within Drone are now captured and displayed on the run within the Dashboard. #1709.
Bugfixes:
Cypress no longer crashes when attempting to proxy a websocket connection that fails. Fixes #556.
Asserting that an attribute equals a falsy value no longer fails when the value was falsy. Fixes #831 and #1491.
Snapshots now ignore stylesheets with
media="print". Fixes #1568.Fixed issue where the Cypress
windowwas being returned instead of AUT'swindow. Fixes #1436.The
closeevent now properly fires onfilewhen manually closing the browser. Fixes #1560.cypress.env.jsonis now being watched for changes. Fixes #1464.Fixed issue when using TypeScript that caused namespace errors to be thrown. Fixes #1627.
Fixed error message on
.type()and.clear()when typing into non-typeable elements or clearing non-clearable elements to accurately list the elements allowed. Fixes #1650.Added Chrome flag
--disable-blink-features=RootLayerScrollingto prevent the application under test from "shaking" in recent versions of Chrome. Fixes #1620.Fixed issue where some TTY characters were not properly formatted in the terminal for Windows during
cypress run. Fixes #1143 and #1550.Removed an extraneous error display from Electron during
cypress runabout a "transparent titlebar" setting. Fixes #1745.
Misc:
We are now aggressively turning on colors when running in CI. If you're using Jenkins and do not have an ANSI color plugin installed, you can turn off colors with the
NO_COLOR=1environment variable. Fixes #1747 and #1748.When running
cypress run --recordon forked PR's, we now detect that the Record Key is missing and do not fail the build. We will display a warning, but continue running the tests. Fixes #1193.Searching in the Test Runner now filters out any non-matching folders. Fixes #1706.
Duplicate, subsequent logs in the Command Log are now collapsed and can be expanded to view all logs. Fixes #1580.
We now throw a descriptive error if an alias using
.as()was defined starting with the@character. #1643.We now pass the
--disable-device-discovery-notificationsflag automatically. This should prevent Chromium browser from automatically trying to communicate with devices in your network, such as printers, while running tests. Fixes #1600.We now pass any reporter errors along and provide a stack if a custom reporter you've provided does not exist. Fixes #1192.
You can now pass a normal object to
cypress.open()orcypress.run()through the Module API, just as you would from the command line. #1442.Added type definitions for
Cypress.offandCypress.log. Fixes #1110 and #1591.Update type definitions for cy.screenshot() to reflect new changes to command's options. Fixes #1753.
The type definition for .filter() now correctly supports a function argument.
The type definition for .scrollIntoView() no longer errors when passed a
durationoption. Fixes #1606.NODE_OPTIONSenvironment variables now print within thecypress:clilogs when running inDEBUGmode. Although usingNODE_OPTIONSthemselves should not be used due to #1676. Fixes #1673.Cypress will error and exit with status 1 if no specs were found during
cypress run. Fixes #1585.We are now counting and aggregating the stats at the end of test runs separately from Mocha. Cypress considers a test to be the
itand any accompanyinghooksthat run before or after a test. Cypress will correctly associate failures in those hooks to the test itself. We believe this more accurately models and just "makes sense". Fixes #1163.The minimum viewport size has been lowered from
200pixels to20pixels. Fixes #1169 and #1444.Internal changes to our API structure and communication. Fixes #1170, #1413, #1415.
We output a much more complete test results object when using cypress as a module. Fixes #1248.
Added keywords to Cypress NPM package. Fixes #1508.
Centered the animating icon in the Test runner when 'running'. Fixes #1695.
We made some changes to internal references of
headedandheadlessto be more specific and instead referencerun modeandinteractive mode. Fixes #1140.The test name text is now selectable inside the Command Log. Fixes #1476.
Minor improvements to contributing docs and scripts. Fixes #1665.
We now collect Semaphore CI params and provide URL's to click into the builds from the Dashboard. Fixes #1785.
Config overrides coming from the CLI or environment variables are now validated the same way as if they've been set in
cypress.json. Fixes #1783.There is a better / more helpful experience around passing unknown options to the CLI. Fixes #837.
Display an empty message when there is no commit information on recorded runs. Fixes #1809.
Documentation Changes:
Update
cy.screenshot()doc to include new accepted usage and optionsUpdate
Installing Cypressdoc to include new options for Cypress binary cachingUpdated
Writing and Organizing Teststo include newly seededexamplesfolderUpdated
Launching Browsersto include our disabling of device discovery notificationsUpdated
Preprocessorsto reflect all wayscloseevent could be triggeredUpdated use of "running headlessly" to more accurate "during
cypress run"
- 2.x
2.1.1 – 2.4.113 releases without a noteShow each
2.1.0
24 Aug 2020The Selector Playground has been updated to automatically prefer
data-cy,data-testordata-testidattributes when providing the unique selector for an element. Additionally it now exposes a public API that you can use to control how it determines which selector to use. Fixes #1135.
Released 3/1/2018
Bugfixes:
Prevent a bug with
node-sasson OSX + Windows when localnodeversion does not match bundlednodewhen importing components directly in spec files. The underlying issue was because we forgot to updateBuildkiteandAppveyorwhen we upgradedElectronin2.0.0. Fixes #1387 and #1390.
Features:
The Selector Playground has been updated to automatically prefer
data-cy,data-testordata-testidattributes when providing the unique selector for an element. Additionally it now exposes a public API that you can use to control how it determines which selector to use. Fixes #1135.
Documentation Changes:
2.0.1
13 Aug 2020Using
cy.contains()with a regexp argument is now properly escaped. Fixes #1322.Fixed a runaway regexp causing large
.jsfiles to take dozens of seconds to process. This was a regression caused by2.0.0with the newmodifyObstructiveCodeoption. We've optimized the regexp and the performance is back to being almost identical to transparently passing responses through. Fixes #1330.
Released 2/16/2018
Bugfixes:
Using
cy.contains()with a regexp argument is now properly escaped. Fixes #1322.Fixed a runaway regexp causing large
.jsfiles to take dozens of seconds to process. This was a regression caused by2.0.0with the newmodifyObstructiveCodeoption. We've optimized the regexp and the performance is back to being almost identical to transparently passing responses through. Fixes #1330.
2.0.0
10 Aug 2020- Removed
Removed the flag
--disable-background-networkingfrom the Chrome launch args to fix problems in CI that would throttle XHR callbacks by up to 20-30 seconds. Fixes #1320. The built in default
Electronbrowser has been bumped from version53to59. This version represents the version ofChromiumthat Electron is using. In other words, runningcypress run(or viaElectron) will be like running your tests inChrome 59now. Although it is unlikely this would actually break any of your tests - it is technically possible they could behave differently. Fixes #895 and #891 and #823 and #860 and #1011 and #1252 and #1276.We are now detecting and automatically stripping code that obstructs Cypress from being able to test your application. Specifically, we are removing JavaScript code that tries to prevent clickjacking and framebusting. We have written very conservative rules that do their best to only strip these specific JS snippets, but it is technically possible that it may unintentionally rewrite valid JS if they match the regexp patterns. There is a new configuration option called
modifyObstructiveCodethat istrueby default. If you are experiencing problems after upgrading, you can turn this off and this will disable modifying your JS code. If you were using Cypress and upon visiting your website you would experience seemingly "random" redirects - these problems should now be eliminated. Fixes #886 and #1245 and #1064 and #992 and #692 and #352.
Released 2/15/2018
Breaking Changes:
The built in default
Electronbrowser has been bumped from version53to59. This version represents the version ofChromiumthat Electron is using. In other words, runningcypress run(or viaElectron) will be like running your tests inChrome 59now. Although it is unlikely this would actually break any of your tests - it is technically possible they could behave differently. Fixes #895 and #891 and #823 and #860 and #1011 and #1252 and #1276.We are now detecting and automatically stripping code that obstructs Cypress from being able to test your application. Specifically, we are removing JavaScript code that tries to prevent clickjacking and framebusting. We have written very conservative rules that do their best to only strip these specific JS snippets, but it is technically possible that it may unintentionally rewrite valid JS if they match the regexp patterns. There is a new configuration option called
modifyObstructiveCodethat istrueby default. If you are experiencing problems after upgrading, you can turn this off and this will disable modifying your JS code. If you were using Cypress and upon visiting your website you would experience seemingly "random" redirects - these problems should now be eliminated. Fixes #886 and #1245 and #1064 and #992 and #692 and #352.We are now clearing the browser's disk cache each time it opens (before any tests run). This means that any files that have been cached from
Cache-Controlheaders will be cleaned and removed. In the future, we will expose a newcy.clearCache()method to provide finer grained control of clearing the cache on a per test basis. But for now, this is an improvement. Fixes #1124.The
--specoption is now normalized against the current working directorycwdinstead of the project that you are running Cypress in. That means passing a path from the command line to a spec file will now work even when the project path is notcwd. Fixes #1159.
Bugfixes:
blacklistHostswould occasionally not work if you were blacklisting a host that had previously cached a file. In this case, the browser would serve it from disk and not make an actual HTTP request. This issue has been solved by clearing the cache when the browser opens. Fixes #1154.blacklistHostsis now correctly accepted via the--configCLI flag.Spies and Stubs created with
cy.stub()andcy.spy()will now retry their assertions when utilized from an alias. Fixes #1156.Basic auth is working again in Chrome 63 and Chrome 64. We "for real" fixed it this time by adding auth headers automatically at the network proxy layer and bypassed the browser altogether. We automatically apply auth headers if you provide a username/password in the URL of a
cy.visit(url). We also added a newauthoption to specify theusername/passwordusingcy.visit(url, options). All of the requests that match the origin of theurlwill have theAuthorization: Basic <...>headers added. Fixes #1288.Fixed domain parsing failures when
localorlocalhostwas not used as atld. Fixes #1292 and #1278.- Removed
Removed the flag
--disable-background-networkingfrom the Chrome launch args to fix problems in CI that would throttle XHR callbacks by up to 20-30 seconds. Fixes #1320.
Misc:
We now properly display nested objects and arrays that come from
cypress.jsonin the Settings tab in the Desktop Application.There's now a proper "empty view" when you go to setup your project to record on our Dashboard and you have not created any Organizations. Fixes #1306.
Removed the message about private projects requiring a paid account in the future. There will be a free tier including private projects. Fixes #827.
We moved the location of the browser's disk cache. That means that if you've been using Cypress for a really long time - you may have built up quite a large existing cache (in the hundreds of
mb). Before upgrading, you should open the browser and then manually clear the Cache. Or - if you have already upgraded to2.0.0delete the following folders:OSX:
~/Library/Caches/CypressLinux:
~/.cache/CypressWindows:
%APPDATA%\Cypress\cy\production\browsers
- 1.x
1.3.3
10 Aug 20201.3.2
3 Aug 2020Reading the note…
1.3.1
23 Jul 2020Reading the note…
1.3.0
23 Jul 2020Plugins now emit a
before:browser:launchevent exposing you the browser that will be launched and its launch arguments. This enables you to modify the arguments prior to launching the browser. You can also use these arguments to modify how Chrome runs and to also test Chrome extensions. Fixes #691 and #298.We have launched a "CSS Selector Playground", a new UI button in the Test Runner that enables you to highlight elements in your application and receive a unique selector. You can also find elements by their text content. These mimics
cy.get()andcy.contains()behavior. Additionally you can copy the generated Cypress command to your clipboard or output the generated selector to your console. This feature is in beta. It only works in Chrome (not in Electron). We are aware of some bugs in it, but it is good enough for use and feedback. Please check out issue #917, watch an animated gif demonstration, and leave any feedback you have there. Fixes #917.
Released 12/17/2017
Features:
Plugins now emit a
before:browser:launchevent exposing you the browser that will be launched and its launch arguments. This enables you to modify the arguments prior to launching the browser. You can also use these arguments to modify how Chrome runs and to also test Chrome extensions. Fixes #691 and #298.We have launched a "CSS Selector Playground", a new UI button in the Test Runner that enables you to highlight elements in your application and receive a unique selector. You can also find elements by their text content. These mimics
cy.get()andcy.contains()behavior. Additionally you can copy the generated Cypress command to your clipboard or output the generated selector to your console. This feature is in beta. It only works in Chrome (not in Electron). We are aware of some bugs in it, but it is good enough for use and feedback. Please check out issue #917, watch an animated gif demonstration, and leave any feedback you have there. Fixes #917.
Documentation Changes:
1.2.0
21 Jul 2020There is a new
blacklistHostsoption incypress.jsonthat allows you to block requests made to those hosts. Blocked requests will respond with a503status code. This is useful for blocking 3rd party domains like Google Analytics. We have added a new recipe demonstrating this. Fixes #442.
Released 12/14/2017
Features:
Plugins can now return a
Promiseand modify the yieldedconfigto set new configuration values and environment variables. Fixes #1042 and #909 and #576.There is a new
userAgentoption incypress.json. This enables you to change theuserAgentof the browser for the entire browsing session. Fixes #364.There is a new
blacklistHostsoption incypress.jsonthat allows you to block requests made to those hosts. Blocked requests will respond with a503status code. This is useful for blocking 3rd party domains like Google Analytics. We have added a new recipe demonstrating this. Fixes #442.Added chai assertions in TypeScript to generate autocompletion. Fixes #1073.
Bugfixes:
Updated TypeScript definitions to more accurately match the current Cypress API. Fixes #1050. Also note that if you were extending Cypress in TypeScript the
Chainerinterface changed. Please read 1048#issuecomment-351891910 to understand what you will need to update.
Misc:
Renamed
environmentVariablestoenvin the Desktop GUI. Fixes #1052.Cypress.config()now returns a complete set of configuration values. Fixes #509.Added TypeScript typings for bundled Cypress tools like
$,_, etc. Fixes #1046.Some error messages were made more passive. Fixes #1025.
Documentation Changes:
1.1.4
20 Jul 2020Reading the note…
1.1.3
20 Jul 2020JSON fixtures with unicode escape sequences are now parsed correctly. Fixes #964.
The default
browserifyplugin no longer fireswatched:file:changedtwice leading to an uncaught exception that was popping up in the console. Also fixed a minor state bug in thebrowserifypackage. Fixes #968.Cypress no longer reports
Electronas the browser that ran in the Dashboard Service when a different browser was run. Fixes #854.
Released 12/3/2017
Bugfixes:
JSON fixtures with unicode escape sequences are now parsed correctly. Fixes #964.
The default
browserifyplugin no longer fireswatched:file:changedtwice leading to an uncaught exception that was popping up in the console. Also fixed a minor state bug in thebrowserifypackage. Fixes #968.Cypress no longer reports
Electronas the browser that ran in the Dashboard Service when a different browser was run. Fixes #854.Invalid cookie values no longer crash Cypress. Fixes #962.
Misc:
We are now bundling our own
TypeScriptdefinitions with thecypressnpm module. You no longer have to install@types/cypressanymore. We'll continue to keep these updated with API changes. Fixes #856.Uncaught exceptions originating from your application code and/or test code are now distinctly and clearly indicated in the error message. We included a link to our docs to educate you on how you can optionally disable Cypress from catching these. Fixes #825.
cy.visit()now accepts{ failOnStatusCode: false }which enables you to visit pages that respond with a non2xxstatus code. This brings it into parity withcy.request(). Fixes #421 and #574.The contributing Readme's have been updated and improved for each package. Fixes #995.
Added utility methods
Cypress.platformandCypress.archfor returning the underlying OS information. Uses node'sosmodule under the hood. Fixes #824 and #675.
Documentation Changes:
1.1.2
20 Jul 2020Fixed a regression caused by
.type()adhering tomaxlengthincorrectly. Special character sequences were not respected. Now.type()works with special characters and implements a complete fix formaxlength. In addition to it working, it now fires all applicable browser events without modifying the actual input value. Fixes #955.Errors coming from plugins now display correctly in the Test Runner. Fixes #945.
Released 11/26/2017
Bugfixes:
Fixed a regression caused by
.type()adhering tomaxlengthincorrectly. Special character sequences were not respected. Now.type()works with special characters and implements a complete fix formaxlength. In addition to it working, it now fires all applicable browser events without modifying the actual input value. Fixes #955.Errors coming from plugins now display correctly in the Test Runner. Fixes #945.
Documentation Changes:
1.1.0
16 Jul 2020Reading the note…
1.0.5
16 Jul 2020Reading the note…
1.0.4
15 Jul 2020Reading the note…
1.0.3
15 Jul 2020Reading the note…
1.0.2
15 Jul 2020Reading the note…
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.