merge develop

Author: jennifer-shehane

.circleci/cache-version.txt

@@ -1,3 +1,3 @@
 # Bump this version to force CI to re-create the cache from scratch.
 
-4-29-2025
+5-12-2025

cli/CHANGELOG.md

@@ -22,15 +22,29 @@ _Released 07/01/2025 (PENDING)_
 
 - Migration helpers and related errors are no longer shown when upgrading from Cypress versions earlier than 10.0.0. To migrate from a pre-10.0.0 version, upgrade one major version at a time to receive the appropriate guidance. Addresses [#31345](https://github.com/cypress-io/cypress/issues/31345). Addressed in [https://github.com/cypress-io/cypress/pull/31629/](https://github.com/cypress-io/cypress/pull/31629/).
 
-## 14.3.4
+## 14.4.0
 
 _Released 5/20/2025 (PENDING)_
 
+**Features:**
+
+- `@cypress/webpack-dev-server` and `@cypress/webpack-batteries-included-preprocessor` now ship with [webpack-bundle-analyzer](https://www.npmjs.com/package/webpack-bundle-analyzer) as a diagnostic tool to determine bundle statistics, which can be enabled via `DEBUG=cypress-verbose:webpack-dev-server:bundle-analyzer` ( component tests using webpack) or `DEBUG=cypress-verbose:webpack-batteries-included-preprocessor:bundle-analyzer` (e2e tests using webpack, which is the default preprocessor), respectively. Addresses [#30461](https://github.com/cypress-io/cypress/issues/30461).
+
+**Bugfixes:**
+
+- Fixed an issue where framebusting was occurring when `top.window.location` was being set explicitly. This fix does not require the `experimentalModifyObstructiveThirdPartyCode` configuration option. Addresses [#31687](https://github.com/cypress-io/cypress/issues/31687).
+- `cy.press()` now has a return type of `Chainable<null>` instead of `void` to match the convention of other commands that yield `null`. Addressed in [#31698](https://github.com/cypress-io/cypress/pull/31698).
+- Fixed an issue with the experimental usage of WebKit where Cypress incorrectly displayed `0` as the WebKit version. Addresses [#31684](https://github.com/cypress-io/cypress/issues/31684).
+
+**Misc:**
+
+- Cursor is now available as an IDE option for opening files in Cypress, if it is installed on your system. Addressed in [#31691](https://github.com/cypress-io/cypress/pull/31691).
+- The error shown when the `--record` flag is missing has been updated to be shorter. Addressed in [#31676](https://github.com/cypress-io/cypress/pull/31676).
+
 **Dependency Updates:**
 
 - Upgraded `trash` from `5.2.0` to `7.2.0`. Addressed in [#31667](https://github.com/cypress-io/cypress/pull/31667).
 
-
 ## 14.3.3
 
 _Released 5/6/2025_

cli/types/cypress.d.ts

@@ -1755,7 +1755,7 @@ declare namespace Cypress {
      *    cy.press(Cypress.Keyboard.Keys.TAB) // dispatches a keydown and press event to the browser, followed by a keyup event.
      * @see https://on.cypress.io/press
      */
-    press(key: typeof Cypress.Keyboard.Keys[keyof typeof Cypress.Keyboard.Keys], options?: Partial<Loggable & Timeoutable>): void
+    press(key: typeof Cypress.Keyboard.Keys[keyof typeof Cypress.Keyboard.Keys], options?: Partial<Loggable & Timeoutable>): Chainable<null>
 
     /**
      * Get the immediately preceding sibling of each element in a set of the elements.

guides/v8-snapshots.md

@@ -33,6 +33,65 @@ This cache should be maintained and updated over time. Rather than having this m
 
 ## Troubleshooting
 
+### Missing Dependency
+
+#### Background on Snapshot Dependencies
+
+When we generate snapshots, we create a metadata file that contains information about all dependencies included in the snapshot. In theory, these dependencies could be removed from the binary to save space, since they're already included in the snapshot. This helps offset the size increase from the snapshot itself.
+
+However, not all dependencies can be safely removed. There are two main categories of dependencies that must be preserved:
+
+1. Dependencies (and their sub-dependencies) that are used in child processes
+2. Dependencies (and their sub-dependencies) that are dynamically loaded and cannot be determined by `esbuild`
+
+To handle this, we maintain a list of these dependencies and use `esbuild` to retrieve all their child dependencies. This list is defined in [binary-cleanup.js](https://github.com/cypress-io/cypress/blob/develop/scripts/binary/binary-cleanup.js#L40-L64). We then remove these dependencies from the list of v8 snapshot metadata dependencies, leaving only the ones that are safe to remove.
+
+#### Handling Missing Dependencies
+
+If you encounter a missing dependency error that looks something like:
+
+```
+Error: Cannot find module 'get-stream'
+Require stack:
+- /root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/node_modules/extract-zip/index.js
+    at Module._resolveFilename (node:internal/modules/cjs/loader:1232:15)
+    at s._resolveFilename (node:electron/js2c/browser_init:2:124107)
+    at PackherdModuleLoader._tryResolveFilename (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:786120)
+    at PackherdModuleLoader._resolvePaths (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:782910)
+    at PackherdModuleLoader.tryLoad (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:780953)
+    at Function.<anonymous> (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:791773)
+    at d._load (<embedded>:2752:176394)
+    at Module.require (node:internal/modules/cjs/loader:1318:19)
+    at require (node:internal/modules/helpers:179:18)
+    at Object.<anonymous> (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/node_modules/extract-zip/index.js:4:19)
+    at Module._compile (node:internal/modules/cjs/loader:1484:14)
+    at Module._extensions..js (node:internal/modules/cjs/loader:1564:10)
+    at Module.load (node:internal/modules/cjs/loader:1295:32)
+    at Module._load (node:internal/modules/cjs/loader:1111:12)
+    at c._load [as origLoad] (node:electron/js2c/node_init:2:16955)
+    at PackherdModuleLoader.tryLoad (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:781559)
+    at Function.<anonymous> (/root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/index.jsc:1:791773)
+    at d._load (<embedded>:2752:176394)
+    at node:internal/modules/esm/translators:350:17
+    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:286:7)
+    at ModuleJob.run (node:internal/modules/esm/module_job:234:25)
+    at async ModuleLoader.import (node:internal/modules/esm/loader:473:24)
+    at async startWebDriver (file:///root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/node_modules/@wdio/utils/build/index.js:503:49)
+    at async _WebDriver.newSession (file:///root/.cache/Cypress/beta-14.3.4-update-trash-d37e059a/Cypress/resources/app/packages/server/node_modules/webdriver/build/node.js:1327:27)
+    at async Object.Z (<embedded>:2752:13515)
+    at async Object.open (<embedded>:2752:30921)
+    at async v.relaunchBrowser (<embedded>:2861:42528)
+```
+
+Follow these steps:
+
+1. Look through the stack trace of the missing dependency error
+2. Try to identify where the dependency is being dynamically required/imported
+3. Validate that the dynamically required/imported dependency is missing from the binary
+4. Add the dependency to the list in [binary-cleanup.js](https://github.com/cypress-io/cypress/blob/develop/scripts/binary/binary-cleanup.js#L40-L64)
+
+This will ensure the dependency is preserved in the binary and available when needed.
+
 ### Local Development
 
 If you're running into problems locally, either with generating the snapshot or at runtime, a good first step is to clean everything and start from scratch. This command will accomplish that (note that it will delete any new unstaged files, so if you want to keep them, either stash them or stage them):

npm/puppeteer/README.md

@@ -42,9 +42,11 @@ Add the following in `tsconfig.json`:
 
 ## Compatibility
 
-`@cypress/puppeteer` requires Cypress version 13.6.0 or greater.
+Before using `@cypress/puppeteer`, ensure the following requirements are met:
 
-Only Chromium-based browsers (e.g. Chrome, Chromium, Electron) are supported.
+- Cypress 13.6.0+ is required.
+- Only Chromium-based browsers are supported, such as Chrome for Testing, Chromium, and Electron.
+- Chrome-branded browsers (e.g., standard Chrome) are not supported in version 137+ due to Chrome's removal of the `--load-extension` flag. We recommend using Chrome for Testing or Chromium instead. See Cypress Docker image examples for [Chrome for Testing](https://github.com/cypress-io/cypress-docker-images/tree/master/examples/chrome-for-testing) and [Chromium](https://github.com/cypress-io/cypress-docker-images/tree/master/examples/chromium).
 
 ## Usage
 
@@ -339,6 +341,7 @@ export default defineConfig({
 
 If you receive this error in your command log, the Puppeteer plugin was unable to communicate with the Cypress extension. This extension is necessary in order to re-activate the main Cypress tab after a Puppeteer command, when running in open mode.
 
+* If you're using a Chrome-branded browser (e.g., standard Chrome) in version 137+, you'll need to use Chrome for Testing or Chromium instead. [See download instructions](https://www.chromium.org/getting-involved/download-chromium/).
 * Ensure this extension is enabled in the instance of Chrome that Cypress launches by visiting chrome://extensions/
 * Ensure the Cypress extension is allowed by your company's security policy by its extension id, `caljajdfkjjjdehjdoimjkkakekklcck`
 

npm/webpack-batteries-included-preprocessor/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@cypress/webpack-batteries-included-preprocessor-v3.1.0](https://github.com/cypress-io/cypress/compare/@cypress/webpack-batteries-included-preprocessor-v3.0.7...@cypress/webpack-batteries-included-preprocessor-v3.1.0) (2025-05-13)
+
+
+### Features
+
+* ship webpack-bundle-analyzer with`@cypress/webpack-dev-server` and `@cypress/webpack-batteries-included-preprocessor` ([#31588](https://github.com/cypress-io/cypress/issues/31588)) ([46f2867](https://github.com/cypress-io/cypress/commit/46f2867b9dafbf991bf7154cb181eb07d9c6ad20))
+
 # [@cypress/webpack-batteries-included-preprocessor-v3.0.7](https://github.com/cypress-io/cypress/compare/@cypress/webpack-batteries-included-preprocessor-v3.0.6...@cypress/webpack-batteries-included-preprocessor-v3.0.7) (2025-03-26)
 
 

npm/webpack-batteries-included-preprocessor/README.md

@@ -46,6 +46,10 @@ module.exports = (on) => {
 
 Other than the `typescript` option, this preprocessor supports the same options as [@cypress/webpack-preprocessor](https://github.com/cypress-io/cypress/tree/develop/npm/webpack-preprocessor#readme), so see its [README](https://github.com/cypress-io/cypress/tree/develop/npm/webpack-preprocessor#readme) for more information.
 
+## Debugging
+
+If having issues with chunk load errors or bundle size problems, specifically in your end-to-end tests, please try setting `DEBUG=cypress-verbose:webpack-batteries-included-preprocessor:bundle-analyzer` before starting Cypress to get a `webpack-bundle-analyzer` report to help determine the cause of the issue. If filing an issue with Cypress, please include this report with your issue to better help us serve your issue.
+
 ## Contributing
 
 Use the [version of Node that matches Cypress](https://github.com/cypress-io/cypress/blob/develop/.node-version).

npm/webpack-batteries-included-preprocessor/index.js

@@ -2,8 +2,10 @@ const path = require('path')
 const webpack = require('webpack')
 const Debug = require('debug')
 const webpackPreprocessor = require('@cypress/webpack-preprocessor')
+const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
 
 const debug = Debug('cypress:webpack-batteries-included-preprocessor')
+const WBADebugNamespace = 'cypress-verbose:webpack-batteries-included-preprocessor:bundle-analyzer'
 
 const hasTsLoader = (rules) => {
   return rules.some((rule) => {
@@ -136,6 +138,10 @@ const getDefaultWebpackOptions = () => {
         // @see https://github.com/cypress-io/cypress/issues/27947.
         process: require.resolve('process/browser.js'),
       }),
+      // If the user is trying to debug their bundle, we'll add the BundleAnalyzerPlugin
+      // to see the size of the support file (first bundle when running `cypress open`)
+      // and spec files (subsequent bundles when running `cypress open`)
+      ...(Debug.enabled(WBADebugNamespace) ? [new BundleAnalyzerPlugin()] : []),
     ],
     resolve: {
       extensions: ['.js', '.json', '.jsx', '.mjs', '.coffee'],

npm/webpack-batteries-included-preprocessor/package.json

@@ -44,7 +44,8 @@
     "url": "^0.11.1",
     "util": "^0.12.5",
     "vm-browserify": "^1.1.2",
-    "webpack": "^5.88.2"
+    "webpack": "^5.88.2",
+    "webpack-bundle-analyzer": "4.10.2"
   },
   "devDependencies": {
     "@cypress/webpack-preprocessor": "0.0.0-development",

npm/webpack-batteries-included-preprocessor/test/unit/index.spec.js

@@ -2,6 +2,7 @@ const { expect } = require('chai')
 const decache = require('decache')
 const mock = require('mock-require')
 const sinon = require('sinon')
+const Debug = require('debug')
 
 describe('webpack-batteries-included-preprocessor', () => {
   beforeEach(() => {
@@ -29,6 +30,20 @@ describe('webpack-batteries-included-preprocessor', () => {
       expect(result.module.rules).to.have.length(4)
       expect(result.module.rules[3].use[0].loader).to.include('ts-loader')
     })
+
+    it('adds the BundleAnalyzerPlugin if the user is trying to debug their bundle', () => {
+      Debug.enable('cypress-verbose:webpack-batteries-included-preprocessor:bundle-analyzer')
+
+      // since debug needs to be hydrated before requiring the preprocessor, we need to decache
+      // and require again
+      decache('../../index')
+      preprocessor = require('../../index')
+      const result = preprocessor.getFullWebpackOptions('file/path', 'typescript/path')
+
+      expect(result.plugins).to.have.length(2)
+      expect(result.plugins[1].constructor.name).to.equal('BundleAnalyzerPlugin')
+      Debug.disable()
+    })
   })
 
   context('#getTSCompilerOptionsForUser', () => {

npm/webpack-dev-server/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@cypress/webpack-dev-server-v4.1.0](https://github.com/cypress-io/cypress/compare/@cypress/webpack-dev-server-v4.0.2...@cypress/webpack-dev-server-v4.1.0) (2025-05-13)
+
+
+### Features
+
+* ship webpack-bundle-analyzer with`@cypress/webpack-dev-server` and `@cypress/webpack-batteries-included-preprocessor` ([#31588](https://github.com/cypress-io/cypress/issues/31588)) ([46f2867](https://github.com/cypress-io/cypress/commit/46f2867b9dafbf991bf7154cb181eb07d9c6ad20))
+
 # [@cypress/webpack-dev-server-v4.0.2](https://github.com/cypress-io/cypress/compare/@cypress/webpack-dev-server-v4.0.1...@cypress/webpack-dev-server-v4.0.2) (2025-03-25)
 
 # [@cypress/webpack-dev-server-v4.0.1](https://github.com/cypress-io/cypress/compare/@cypress/webpack-dev-server-v4.0.0...@cypress/webpack-dev-server-v4.0.1) (2025-01-15)

npm/webpack-dev-server/README.md

@@ -39,6 +39,10 @@ export default defineConfig({
 })
 ```
 
+## Debugging
+
+If having issues with chunk load errors or bundle size problems, specifically in your component tests, please try setting `DEBUG=cypress-verbose:webpack-dev-server:bundle-analyzer` before starting Cypress to get a `webpack-bundle-analyzer` report to help determine the cause of the issue. If filing an issue with Cypress, please include this report with your issue to better help us serve your issue.
+
 ## Testing
 
 Unit tests can be run with `yarn test`. Integration tests can be run with `yarn cypress:run`

npm/webpack-dev-server/package.json

@@ -24,13 +24,15 @@
     "semver": "^7.7.1",
     "speed-measure-webpack-plugin": "1.4.2",
     "tslib": "^2.3.1",
+    "webpack-bundle-analyzer": "4.10.2",
     "webpack-dev-server": "^5.1.0",
     "webpack-merge": "^5.4.0"
   },
   "devDependencies": {
     "@types/node": "20.16.0",
     "@types/proxyquire": "^1.3.28",
     "@types/speed-measure-webpack-plugin": "^1.3.4",
+    "@types/webpack-bundle-analyzer": "4.7.0",
     "chai": "^4.3.6",
     "dedent": "^0.7.0",
     "mocha": "^9.2.2",

npm/webpack-dev-server/src/createWebpackDevServer.ts

@@ -3,6 +3,7 @@ import type { Configuration as WebpackDevServer5Configuration } from 'webpack-de
 import type { WebpackDevServerConfig } from './devServer'
 import type { SourceRelativeWebpackResult } from './helpers/sourceRelativeWebpackModules'
 import { makeWebpackConfig } from './makeWebpackConfig'
+import { isWebpackBundleAnalyzerEnabled } from './util'
 
 const debug = debugLib('cypress:webpack-dev-server:start')
 
@@ -69,6 +70,10 @@ function webpackDevServer5 (
     devMiddleware: {
       publicPath: devServerPublicPathRoute,
       stats: finalWebpackConfig.stats ?? 'minimal',
+      ...(isWebpackBundleAnalyzerEnabled() ? {
+        // the bundle needs to be written to disk in order to determine source map sizes
+        writeToDisk: true,
+      } : {}),
     },
     hot: false,
     // Only enable file watching & reload when executing tests in `open` mode

npm/webpack-dev-server/src/makeDefaultWebpackConfig.ts

@@ -3,6 +3,8 @@ import debugLib from 'debug'
 import type { Configuration } from 'webpack'
 import type { CreateFinalWebpackConfig } from './createWebpackDevServer'
 import { CypressCTWebpackPlugin } from './CypressCTWebpackPlugin'
+import { isWebpackBundleAnalyzerEnabled, WBADebugNamespace } from './util'
+import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer'
 
 const debug = debugLib('cypress:webpack-dev-server:makeDefaultWebpackConfig')
 
@@ -95,10 +97,15 @@ export function makeCypressWebpackConfig (
         webpack,
         indexHtmlFile,
       }),
+      ...(isWebpackBundleAnalyzerEnabled() ? [new BundleAnalyzerPlugin()] : []),
     ],
     devtool: 'inline-source-map',
   } as any
 
+  if (isWebpackBundleAnalyzerEnabled()) {
+    debugLib(WBADebugNamespace)('webpack-bundle-analyzer is enabled.')
+  }
+
   if (isRunMode) {
     // if justInTimeCompile is configured, we need to watch for file changes as the spec entries are going to be updated per test
     const ignored = justInTimeCompile ? /node_modules/ : '**/*'

npm/webpack-dev-server/src/util.ts

@@ -0,0 +1,7 @@
+import debug from 'debug'
+
+export const WBADebugNamespace = 'cypress-verbose:webpack-dev-server:bundle-analyzer'
+
+export const isWebpackBundleAnalyzerEnabled = () => {
+  return debug.enabled(WBADebugNamespace)
+}

npm/webpack-dev-server/test/devServer-unit.spec.ts

@@ -4,6 +4,7 @@ import { expect } from 'chai'
 
 import { createModuleMatrixResult } from './test-helpers/createModuleMatrixResult'
 import EventEmitter from 'events'
+import debug from 'debug'
 
 const cypressConfig = {
   projectRoot: path.join(__dirname, 'test-fixtures'),
@@ -35,4 +36,44 @@ describe('devServer', function () {
     expect(result.server).to.be.instanceOf(require('webpack-dev-server'))
     expect(result.version).to.eq(5)
   })
+
+  // Writing to disk includes the correct source map size, where the difference will be made up from stat size vs parsed size
+  // This is critical if a user is trying to debug to determine if they have large source maps or other large files in their dev-server under test
+  describe('writes to disk if DEBUG=cypress-verbose:webpack-dev-server:bundle-analyzer is set', async () => {
+    const WEBPACK_DEV_SERVER_VERSIONS: (4 | 5)[] = [4, 5]
+
+    beforeEach(() => {
+      debug.enable('cypress-verbose:webpack-dev-server:bundle-analyzer')
+    })
+
+    afterEach(() => {
+      debug.disable()
+    })
+
+    WEBPACK_DEV_SERVER_VERSIONS.forEach((version) => {
+      it(`works for webpack-dev-server v${version}`, async () => {
+        const { devServer } = proxyquire('../src/devServer', {
+          './helpers/sourceRelativeWebpackModules': {
+            sourceDefaultWebpackDependencies: () => {
+              // using webpack version to wds version as it really doesn't matter much when testing here.
+              // webpack config is tested separately in makeWebpackConfig tests
+              return createModuleMatrixResult({
+                webpack: version,
+                webpackDevServer: version,
+              })
+            } },
+        }) as typeof import('../src/devServer')
+
+        const result = await devServer.create({
+          specs: [],
+          cypressConfig,
+          webpackConfig: {},
+          devServerEvents: new EventEmitter(),
+        })
+
+        // @ts-expect-error
+        expect(result.server.options.devMiddleware.writeToDisk).to.be.true
+      })
+    })
+  })
 })