chore: add guided error for removal of videoUploadOnPasses config opt…

…ion (#27158) * chore: add guided error for removal of videoUploadOnPasses config option * chore: properly order breaking keys and update snapshot
cypress-io · Jun 30, 2023 · d3200df · d3200df · cypress-bot · Jun 30, 2023
1 parent b0c63ff
commit d3200df
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 1 deletion.
diff --git a/packages/config/__snapshots__/index.spec.ts.js b/packages/config/__snapshots__/index.spec.ts.js
@@ -13,6 +13,7 @@ exports['config/src/index .getBreakingKeys returns list of breaking config keys
   'integrationFolder',
   'pluginsFile',
   'testFiles',
+  'videoUploadOnPasses',
 ]
 
 exports['config/src/index .getDefaultValues returns list of public config keys 1'] = {

diff --git a/packages/config/src/options.ts b/packages/config/src/options.ts
@@ -26,6 +26,7 @@ const BREAKING_OPTION_ERROR_KEY: Readonly<AllCypressErrorNames[]> = [
   '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
@@ -633,11 +634,16 @@ export const breakingOptions: Readonly<BreakingOption[]> = [
     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',
+    isWarning: true,
   },
 ] as const
 

diff --git a/packages/errors/src/errors.ts b/packages/errors/src/errors.ts
@@ -1381,6 +1381,15 @@ export const AllCypressErrors = {
         https://on.cypress.io/migration-guide`
   },
 
+  VIDEO_UPLOAD_ON_PASSES_REMOVED: (_errShape: BreakingErrResult) => {
+    return errTemplate`\
+        The ${fmt.highlight(`videoUploadOnPasses`)} configuration option was removed in ${fmt.cypressVersion(`13.0.0`)}.
+
+        You can safely remove this option from your config.
+
+        https://on.cypress.io/migration-guide`
+  },
+
   CONFIG_FILE_INVALID_ROOT_CONFIG: (errShape: BreakingErrResult) => {
     const code = errPartial`
       {

diff --git a/packages/errors/test/unit/visualSnapshotErrors_spec.ts b/packages/errors/test/unit/visualSnapshotErrors_spec.ts
@@ -1144,6 +1144,11 @@ describe('visual error templates', () => {
         default: [{ name: 'pluginsFile', configFile: '/path/to/cypress.config.js.ts' }],
       }
     },
+    VIDEO_UPLOAD_ON_PASSES_REMOVED: () => {
+      return {
+        default: [{ name: 'videoUploadOnPasses', configFile: '/path/to/cypress.config.js.ts' }],
+      }
+    },
     CONFIG_FILE_INVALID_ROOT_CONFIG: () => {
       return {
         default: [{ name: 'specPattern', configFile: '/path/to/cypress.config.js.ts' }],

diff --git a/packages/graphql/schemas/schema.graphql b/packages/graphql/schemas/schema.graphql
@@ -1237,6 +1237,7 @@ enum ErrorTypeEnum {
   VIDEO_CAPTURE_FAILED
   VIDEO_COMPRESSION_FAILED
   VIDEO_RECORDING_FAILED
+  VIDEO_UPLOAD_ON_PASSES_REMOVED
 }
 
 """Base error"""