misc: Remove migration UI, warnings, and errors for changes pre-Cypress 10 (v15) (#31629)

* begin removing migration code

* remove migration query

* add back actions

* remove more migration references

* more migration removals

* remove call to migration

* remove gqp-Migration file

* updates to remove migration

* update type

* remove a lot more migration code - especially errors

* Remove other errors/warnins for versions before 10.x

* update error snapshots

* fix some tests

* index on remove-migration: 49fa75a Merge branch 'remove-migration' of https://github.com/cypress-io/cypress into remove-migration

* index on remove-migration: 49fa75a Merge branch 'remove-migration' of https://github.com/cypress-io/cypress into remove-migration

* index on remove-migration: 49fa75a Merge branch 'remove-migration' of https://github.com/cypress-io/cypress into remove-migration

* remove more system tests and references

* fix call to refreshMetaState which was lost at initialization

* rearrange some system tests to not be dependent on migration

* update welcome version test

* fix wording of messaging

* skip irrelevant test

* fix failing assertion

* remove tests around cypress-plugin-retries

* Remove test from config_spec

* Remove screenshot from snapshot

* fix tests + remove more migration projects

* remove + update system tests

* remove + update system tests

* remove some invalid dev-server: start errors

* remove references and tests around pluginsFile which was removed

* remove some more invalid config examples

* Add changelog entry

* fix changelog link

* fix unit test

* index on remove-migration: 490ddb1 Merge branch 'release/15.0.0' into remove-migration

* index on remove-migration: 490ddb1 Merge branch 'release/15.0.0' into remove-migration

* index on remove-migration: 490ddb1 Merge branch 'release/15.0.0' into remove-migration

* run all binary/windows tests on this branch

* Update packages/scaffold-config/test/unit/detect.spec.ts

Co-authored-by: Bill Glesias <[email protected]>

* Update packages/scaffold-config/test/unit/detect.spec.ts

Co-authored-by: Bill Glesias <[email protected]>

---------

Co-authored-by: cypress-bot[bot] <+cypress-bot[bot]@users.noreply.github.com>
Co-authored-by: Bill Glesias <[email protected]>

Author: 3 people

.circleci/workflows.yml

@@ -38,7 +38,7 @@ mainBuildFilters: &mainBuildFilters
         - /^release\/\d+\.\d+\.\d+$/
         # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
         - 'update-v8-snapshot-cache-on-develop'
-        - 'breaking/remove_webpack_4'
+        - 'remove-migration'
 
 # usually we don't build Mac app - it takes a long time
 # but sometimes we want to really confirm we are doing the right thing
@@ -49,7 +49,7 @@ macWorkflowFilters: &darwin-workflow-filters
       - equal: [ develop, << pipeline.git.branch >> ]
       # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
       - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-      - equal: [ 'breaking/remove_webpack_4', << pipeline.git.branch >> ]
+      - equal: [ 'remove-migration', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -60,7 +60,7 @@ linuxArm64WorkflowFilters: &linux-arm64-workflow-filters
       - equal: [ develop, << pipeline.git.branch >> ]
       # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
       - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-      - equal: [ 'breaking/remove_webpack_4', << pipeline.git.branch >> ]
+      - equal: [ 'remove-migration', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -83,7 +83,7 @@ windowsWorkflowFilters: &windows-workflow-filters
       - equal: [ develop, << pipeline.git.branch >> ]
       # use the following branch as well to ensure that v8 snapshot cache updates are fully tested
       - equal: [ 'update-v8-snapshot-cache-on-develop', << pipeline.git.branch >> ]
-      - equal: [ 'breaking/remove_webpack_4', << pipeline.git.branch >> ]
+      - equal: [ 'remove-migration', << pipeline.git.branch >> ]
       - matches:
           pattern: /^release\/\d+\.\d+\.\d+$/
           value: << pipeline.git.branch >>
@@ -157,7 +157,7 @@ commands:
           name: Set environment variable to determine whether or not to persist artifacts
           command: |
             echo "Setting SHOULD_PERSIST_ARTIFACTS variable"
-            echo 'if ! [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "breaking/remove_webpack_4" ]]; then
+            echo 'if ! [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "remove-migration" ]]; then
                 export SHOULD_PERSIST_ARTIFACTS=true
             fi' >> "$BASH_ENV"
   # You must run `setup_should_persist_artifacts` command and be using bash before running this command
@@ -1160,23 +1160,6 @@ commands:
               CYPRESS_INSTALL_BINARY=~/cypress/cypress.zip npm install --legacy-peer-deps ~/cypress/cypress.tgz
             fi
           working_directory: /tmp/<<parameters.repo>>
-      - run:
-          name: Scaffold new config file
-          working_directory: /tmp/<<parameters.repo>>
-          environment:
-            CYPRESS_INTERNAL_FORCE_SCAFFOLD: "1"
-          command: |
-            if [[ -f cypress.json ]]; then
-              rm -rf cypress.json
-              echo 'module.exports = { e2e: {} }' > cypress.config.js
-            fi
-      - run:
-          name: Rename support file
-          working_directory: /tmp/<<parameters.repo>>
-          command: |
-            if [[ -f cypress/support/index.js ]]; then
-              mv cypress/support/index.js cypress/support/e2e.js
-            fi
       - run:
           name: Print Cypress version
           working_directory: /tmp/<<parameters.repo>>

cli/CHANGELOG.md

@@ -18,6 +18,10 @@ _Released 07/01/2025 (PENDING)_
 
 - [`tsx`](https://tsx.is/) is now used in all cases to run the Cypress config, replacing [ts-node](https://github.com/TypeStrong/ts-node) for TypeScript and Node for commonjs/ESM. This should allow for more interoperability for users who are using any variant of ES Modules. Addresses [#8090](https://github.com/cypress-io/cypress/issues/8090), [#15724](https://github.com/cypress-io/cypress/issues/15724), [#21805](https://github.com/cypress-io/cypress/issues/21805), [#22273](https://github.com/cypress-io/cypress/issues/22273), [#22747](https://github.com/cypress-io/cypress/issues/22747), [#23141](https://github.com/cypress-io/cypress/issues/23141), [#25958](https://github.com/cypress-io/cypress/issues/25958), [#25959](https://github.com/cypress-io/cypress/issues/25959), [#26606](https://github.com/cypress-io/cypress/issues/26606), [#27359](https://github.com/cypress-io/cypress/issues/27359), [#27450](https://github.com/cypress-io/cypress/issues/27450), [#28442](https://github.com/cypress-io/cypress/issues/28442), [#30318](https://github.com/cypress-io/cypress/issues/30318), [#30718](https://github.com/cypress-io/cypress/issues/30718), [#30907](https://github.com/cypress-io/cypress/issues/30907), [#30915](https://github.com/cypress-io/cypress/issues/30915), [#30925](https://github.com/cypress-io/cypress/issues/30925), [#30954](https://github.com/cypress-io/cypress/issues/30954) and [#31185](https://github.com/cypress-io/cypress/issues/31185).
 
+**Misc:**
+
+- 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.3
 
 _Released 5/6/2025_

cli/types/tests/plugins-config.ts

@@ -1,4 +1,4 @@
-// checking types passed to cypress/plugins/index.js file
+// checking types passed through setupNodeEvents
 
 // does nothing
 const pluginConfig: Cypress.PluginConfig = (on, config) => {}

guides/error-handling.md

@@ -4,7 +4,7 @@ Clear, consistent, errors are one of the important parts of the Cypress experien
 
 ### @packages/errors
 
-All error related logic for the server should be added to `@packages/errors`. This logic has been separated out from the `@packages/server` to enable strict type checking & use in other packages we have added in the `10.0-release` branch.
+All error related logic for the server should be added to `@packages/errors`.
 
 ### Errors Development Workflow
 
@@ -78,15 +78,15 @@ In this case, `arg1` will be highlighted in yellow when printed to the terminal.
 
 
 ```ts
-PLUGINS_FILE_ERROR: (arg1: string, arg2: Error) => {
+FAKE_ERROR: (arg1: string, arg2: Error) => {
   return errTemplate`\
-      The plugins file is missing or invalid.
+      The fake file is missing or invalid.
 
-      Your \`pluginsFile\` is set to ${arg1}, but either the file is missing, it contains a syntax error, or threw an error when required. The \`pluginsFile\` must be a \`.js\`, \`.ts\`, or \`.coffee\` file.
+      Your \`fakeFile\` is set to ${arg1}, but either the file is missing, it contains a syntax error, or threw an error when required. The \`fakeFile\` must be a \`.js\`, \`.ts\`, or \`.coffee\` file.
 
-      Or you might have renamed the extension of your \`pluginsFile\`. If that's the case, restart the test runner.
+      Or you might have renamed the extension of your \`fakeFile\`. If that's the case, restart the test runner.
 
-      Please fix this, or set \`pluginsFile\` to \`false\` if a plugins file is not necessary for your project.
+      Please fix this, or set \`fakeFile\` to \`false\` if a plugins file is not necessary for your project.
 
       ${details(arg2)}
     `

npm/grep/README.md

@@ -143,14 +143,16 @@ $ npx cypress run --env grepTags=@smoke,grepFilterSpecs=true
 $ npx cypress run --env grepUntagged=true
 ```
 
-You can use any way to modify the environment values `grep` and `grepTags`, except the run-time `Cypress.env('grep')` (because it is too late at run-time). You can set the `grep` value in the `cypress.json` file to run only tests with the substring `viewport` in their names
+You can use any way to modify the environment values `grep` and `grepTags`, except the run-time `Cypress.env('grep')` (because it is too late at run-time). You can set the `grep` value in the `cypress.config.js` file to run only tests with the substring `viewport` in their names
 
-```json
-{
-  "env": {
-    "grep": "viewport"
-  }
-}
+```js
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  env: {
+    grep: "viewport"
+  },
+})
 ```
 
 You can also set the `env.grep` object in the plugin file, but remember to return the changed config object:

packages/config/__snapshots__/index.spec.ts.js

@@ -1,20 +1,7 @@
 exports['config/src/index .getBreakingKeys returns list of breaking config keys 1'] = [
-  'blacklistHosts',
-  'componentFolder',
-  'experimentalComponentTesting',
-  'experimentalGetCookiesSameSite',
   'experimentalJustInTimeCompile',
-  'experimentalNetworkStubbing',
-  'experimentalRunEvents',
-  'experimentalSessionSupport',
   'experimentalSessionAndOrigin',
-  'experimentalShadowDomSupport',
   'experimentalSkipDomainInjection',
-  'firefoxGcInterval',
-  'ignoreTestFiles',
-  'integrationFolder',
-  'pluginsFile',
-  'testFiles',
   'videoUploadOnPasses',
 ]
 

packages/config/src/options.ts

@@ -9,26 +9,15 @@ import type { TestingType } from '@packages/types'
 import * as validate from './validation'
 
 const BREAKING_OPTION_ERROR_KEY: Readonly<AllCypressErrorNames[]> = [
-  'COMPONENT_FOLDER_REMOVED',
-  'INTEGRATION_FOLDER_REMOVED',
   'CONFIG_FILE_INVALID_ROOT_CONFIG',
   'CONFIG_FILE_INVALID_ROOT_CONFIG_E2E',
   'CONFIG_FILE_INVALID_ROOT_CONFIG_COMPONENT',
   'CONFIG_FILE_INVALID_TESTING_TYPE_CONFIG_COMPONENT',
   'CONFIG_FILE_INVALID_TESTING_TYPE_CONFIG_E2E',
-  'EXPERIMENTAL_COMPONENT_TESTING_REMOVED',
-  'EXPERIMENTAL_SAMESITE_REMOVED',
-  'EXPERIMENTAL_NETWORK_STUBBING_REMOVED',
-  'EXPERIMENTAL_RUN_EVENTS_REMOVED',
-  'EXPERIMENTAL_SESSION_SUPPORT_REMOVED',
   'EXPERIMENTAL_SESSION_AND_ORIGIN_REMOVED',
   'EXPERIMENTAL_SINGLE_TAB_RUN_MODE',
-  'EXPERIMENTAL_SHADOW_DOM_REMOVED',
-  'FIREFOX_GC_INTERVAL_REMOVED',
-  'PLUGINS_FILE_CONFIG_OPTION_REMOVED',
   'VIDEO_UPLOAD_ON_PASSES_REMOVED',
   'RENAMED_CONFIG_OPTION',
-  'TEST_FILES_RENAMED',
 ] as const
 
 type ValidationOptions = {
@@ -617,74 +606,17 @@ export const options: Array<DriverConfigOption | RuntimeConfigOption> = [
  */
 export const breakingOptions: Readonly<BreakingOption[]> = [
   {
-    name: 'blacklistHosts',
-    errorKey: 'RENAMED_CONFIG_OPTION',
-    newName: 'blockHosts',
-    isWarning: false,
-  }, {
-    name: 'componentFolder',
-    errorKey: 'COMPONENT_FOLDER_REMOVED',
-    isWarning: false,
-  }, {
-    name: 'experimentalComponentTesting',
-    errorKey: 'EXPERIMENTAL_COMPONENT_TESTING_REMOVED',
-    isWarning: false,
-  }, {
-    name: 'experimentalGetCookiesSameSite',
-    errorKey: 'EXPERIMENTAL_SAMESITE_REMOVED',
-    isWarning: true,
-  }, {
     name: 'experimentalJustInTimeCompile',
     errorKey: 'EXPERIMENTAL_JIT_COMPILE_REMOVED',
     isWarning: true,
-  },
-  {
-    name: 'experimentalNetworkStubbing',
-    errorKey: 'EXPERIMENTAL_NETWORK_STUBBING_REMOVED',
-    isWarning: true,
-  }, {
-    name: 'experimentalRunEvents',
-    errorKey: 'EXPERIMENTAL_RUN_EVENTS_REMOVED',
-    isWarning: true,
-  }, {
-    name: 'experimentalSessionSupport',
-    errorKey: 'EXPERIMENTAL_SESSION_SUPPORT_REMOVED',
-    isWarning: true,
   }, {
     name: 'experimentalSessionAndOrigin',
     errorKey: 'EXPERIMENTAL_SESSION_AND_ORIGIN_REMOVED',
     isWarning: true,
-  }, {
-    name: 'experimentalShadowDomSupport',
-    errorKey: 'EXPERIMENTAL_SHADOW_DOM_REMOVED',
-    isWarning: true,
   }, {
     name: 'experimentalSkipDomainInjection',
     errorKey: 'EXPERIMENTAL_SKIP_DOMAIN_INJECTION_REMOVED',
     isWarning: false,
-  }, {
-    name: 'firefoxGcInterval',
-    errorKey: 'FIREFOX_GC_INTERVAL_REMOVED',
-    isWarning: true,
-  }, {
-    name: 'ignoreTestFiles',
-    errorKey: 'TEST_FILES_RENAMED',
-    newName: 'excludeSpecPattern',
-    isWarning: false,
-  }, {
-    name: 'integrationFolder',
-    errorKey: 'INTEGRATION_FOLDER_REMOVED',
-    isWarning: false,
-  }, {
-    name: 'pluginsFile',
-    errorKey: 'PLUGINS_FILE_CONFIG_OPTION_REMOVED',
-    isWarning: false,
-  },
-  {
-    name: 'testFiles',
-    errorKey: 'TEST_FILES_RENAMED',
-    newName: 'specPattern',
-    isWarning: false,
   }, {
     name: 'videoUploadOnPasses',
     errorKey: 'VIDEO_UPLOAD_ON_PASSES_REMOVED',

packages/config/test/index.spec.ts

@@ -14,14 +14,14 @@ describe('config/src/index', () => {
     it('returns filter config only containing allowed keys', () => {
       const keys = configUtil.allowed({
         'baseUrl': 'https://url.com',
-        'blacklistHosts': 'breaking option',
+        'videoUploadOnPasses': true,
         'devServerPublicPathRoute': 'internal key',
         'random': 'not a config option',
       })
 
       expect(keys).to.deep.eq({
         'baseUrl': 'https://url.com',
-        'blacklistHosts': 'breaking option',
+        'videoUploadOnPasses': true,
       })
     })
   })
@@ -30,7 +30,7 @@ describe('config/src/index', () => {
     it('returns list of breaking config keys', () => {
       const breakingKeys = configUtil.getBreakingKeys()
 
-      expect(breakingKeys).to.include('blacklistHosts')
+      expect(breakingKeys).to.include('videoUploadOnPasses')
       snapshot(breakingKeys)
     })
   })
@@ -154,12 +154,12 @@ describe('config/src/index', () => {
       const errorFn = sinon.spy()
 
       configUtil.validateNoBreakingConfig({
-        'experimentalNetworkStubbing': 'should break',
+        'experimentalSessionAndOrigin': 'should break',
         configFile: 'config.js',
       }, warningFn, errorFn, 'e2e')
 
-      expect(warningFn).to.have.been.calledOnceWith('EXPERIMENTAL_NETWORK_STUBBING_REMOVED', {
-        name: 'experimentalNetworkStubbing',
+      expect(warningFn).to.have.been.calledOnceWith('EXPERIMENTAL_SESSION_AND_ORIGIN_REMOVED', {
+        name: 'experimentalSessionAndOrigin',
         newName: undefined,
         value: undefined,
         testingType: 'e2e',
@@ -174,14 +174,14 @@ describe('config/src/index', () => {
       const errorFn = sinon.spy()
 
       configUtil.validateNoBreakingConfig({
-        'blacklistHosts': 'should break',
+        experimentalSkipDomainInjection: true,
         configFile: 'config.js',
       }, warningFn, errorFn, 'e2e')
 
       expect(warningFn).to.have.been.callCount(0)
-      expect(errorFn).to.have.been.calledOnceWith('RENAMED_CONFIG_OPTION', {
-        name: 'blacklistHosts',
-        newName: 'blockHosts',
+      expect(errorFn).to.have.been.calledOnceWith('EXPERIMENTAL_SKIP_DOMAIN_INJECTION_REMOVED', {
+        name: 'experimentalSkipDomainInjection',
+        newName: undefined,
         value: undefined,
         testingType: 'e2e',
         configFile: 'config.js',