fix: make error on integration folder point to e2e

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

@@ -1,19 +1,19 @@
 exports['src/index .getBreakingKeys returns list of breaking config keys 1'] = [
-  "blacklistHosts",
   "componentFolder",
   "integrationFolder",
   "testFiles",
   "ignoreTestFiles",
+  "pluginsFile",
   "experimentalComponentTesting",
+  "blacklistHosts",
   "experimentalGetCookiesSameSite",
   "experimentalNetworkStubbing",
   "experimentalRunEvents",
   "experimentalShadowDomSupport",
   "experimentalStudio",
   "firefoxGcInterval",
   "nodeVersion",
-  "nodeVersion",
-  "pluginsFile"
+  "nodeVersion"
 ]
 
 exports['src/index .getDefaultValues returns list of public config keys 1'] = {

packages/config/src/index.ts

@@ -2,6 +2,7 @@ import _ from 'lodash'
 import Debug from 'debug'
 import { defaultSpecPattern, options, breakingOptions, breakingRootOptions, testingTypeBreakingOptions, additionalOptionsToResolveConfig } from './options'
 import type { BreakingOption, BreakingOptionErrorKey } from './options'
+import type { TestingType } from '@packages/types'
 
 // this export has to be done in 2 lines because of a bug in babel typescript
 import * as validation from './validation'
@@ -43,14 +44,15 @@ export type BreakingErrResult = {
   newName?: string
   value?: any
   configFile: string
+  testingType?: TestingType
 }
 
 type ErrorHandler = (
   key: BreakingOptionErrorKey,
   options: BreakingErrResult
 ) => void
 
-const validateNoBreakingOptions = (breakingCfgOptions: BreakingOption[], cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler) => {
+const validateNoBreakingOptions = (breakingCfgOptions: BreakingOption[], cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler, testingType?: TestingType) => {
   breakingCfgOptions.forEach(({ name, errorKey, newName, isWarning, value }) => {
     if (_.has(cfg, name)) {
       if (value && cfg[name] !== value) {
@@ -71,6 +73,7 @@ const validateNoBreakingOptions = (breakingCfgOptions: BreakingOption[], cfg: an
           newName,
           value,
           configFile: cfg.configFile,
+          testingType,
         })
       }
 
@@ -79,6 +82,7 @@ const validateNoBreakingOptions = (breakingCfgOptions: BreakingOption[], cfg: an
         newName,
         value,
         configFile: cfg.configFile,
+        testingType,
       })
     }
   })
@@ -145,12 +149,12 @@ export const validate = (cfg: any, onErr: (property: string) => void) => {
   })
 }
 
-export const validateNoBreakingConfigRoot = (cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler) => {
-  return validateNoBreakingOptions(breakingRootOptions, cfg, onWarning, onErr)
+export const validateNoBreakingConfigRoot = (cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler, testingType: TestingType) => {
+  return validateNoBreakingOptions(breakingRootOptions, cfg, onWarning, onErr, testingType)
 }
 
-export const validateNoBreakingConfig = (cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler) => {
-  return validateNoBreakingOptions(breakingOptions, cfg, onWarning, onErr)
+export const validateNoBreakingConfig = (cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler, testingType: TestingType) => {
+  return validateNoBreakingOptions(breakingOptions, cfg, onWarning, onErr, testingType)
 }
 
 export const validateNoBreakingConfigLaunchpad = (cfg: any, onWarning: ErrorHandler, onErr: ErrorHandler) => {
@@ -160,7 +164,7 @@ export const validateNoBreakingConfigLaunchpad = (cfg: any, onWarning: ErrorHand
 export const validateNoBreakingTestingTypeConfig = (cfg: any, testingType: keyof typeof testingTypeBreakingOptions, onWarning: ErrorHandler, onErr: ErrorHandler) => {
   const options = testingTypeBreakingOptions[testingType]
 
-  return validateNoBreakingOptions(options, cfg, onWarning, onErr)
+  return validateNoBreakingOptions(options, cfg, onWarning, onErr, testingType)
 }
 
 export const validateNoReadOnlyConfig = (config: any, onErr: (property: string) => void) => {

packages/config/src/options.ts

@@ -543,10 +543,6 @@ export const additionalOptionsToResolveConfig = [
  */
 export const breakingOptions: Array<BreakingOption> = [
   {
-    name: 'blacklistHosts',
-    errorKey: 'RENAMED_CONFIG_OPTION',
-    newName: 'blockHosts',
-  }, {
     name: 'componentFolder',
     errorKey: 'COMPONENT_FOLDER_REMOVED',
     isWarning: false,
@@ -564,10 +560,19 @@ export const breakingOptions: Array<BreakingOption> = [
     errorKey: 'TEST_FILES_RENAMED',
     newName: 'excludeSpecPattern',
     isWarning: false,
+  }, {
+    name: 'pluginsFile',
+    errorKey: 'PLUGINS_FILE_CONFIG_OPTION_REMOVED',
+    isWarning: false,
   }, {
     name: 'experimentalComponentTesting',
     errorKey: 'EXPERIMENTAL_COMPONENT_TESTING_REMOVED',
     isWarning: false,
+  }, {
+    name: 'blacklistHosts',
+    errorKey: 'RENAMED_CONFIG_OPTION',
+    newName: 'blockHosts',
+    isWarning: false,
   }, {
     name: 'experimentalGetCookiesSameSite',
     errorKey: 'EXPERIMENTAL_SAMESITE_REMOVED',
@@ -603,9 +608,6 @@ export const breakingOptions: Array<BreakingOption> = [
     value: 'bundled',
     errorKey: 'NODE_VERSION_DEPRECATION_BUNDLED',
     isWarning: true,
-  }, {
-    name: 'pluginsFile',
-    errorKey: 'PLUGINS_FILE_CONFIG_OPTION_REMOVED',
   },
 ]
 

packages/config/test/unit/index.spec.ts

@@ -134,12 +134,13 @@ describe('src/index', () => {
       configUtil.validateNoBreakingConfig({
         'experimentalNetworkStubbing': 'should break',
         configFile: 'config.js',
-      }, warningFn, errorFn)
+      }, warningFn, errorFn, 'e2e')
 
       expect(warningFn).to.have.been.calledOnceWith('EXPERIMENTAL_NETWORK_STUBBING_REMOVED', {
         name: 'experimentalNetworkStubbing',
         newName: undefined,
         value: undefined,
+        testingType: 'e2e',
         configFile: 'config.js',
       })
 
@@ -153,13 +154,14 @@ describe('src/index', () => {
       configUtil.validateNoBreakingConfig({
         'blacklistHosts': 'should break',
         configFile: 'config.js',
-      }, warningFn, errorFn)
+      }, warningFn, errorFn, 'e2e')
 
       expect(warningFn).to.have.been.callCount(0)
       expect(errorFn).to.have.been.calledOnceWith('RENAMED_CONFIG_OPTION', {
         name: 'blacklistHosts',
         newName: 'blockHosts',
         value: undefined,
+        testingType: 'e2e',
         configFile: 'config.js',
       })
     })
@@ -179,6 +181,7 @@ describe('src/index', () => {
         name: 'experimentalStudio',
         newName: undefined,
         value: undefined,
+        testingType: undefined,
         configFile: 'config.js',
       })
 

packages/data-context/src/data/ProjectConfigManager.ts

@@ -222,7 +222,7 @@ export class ProjectConfigManager {
     const cypressEnv = await this.loadCypressEnvFile()
     const fullConfig = await this.buildBaseFullConfig(loadConfigReply.initialConfig, cypressEnv, this.options.ctx.modeOptions)
 
-    const finalConfig = this._cachedFullConfig = this.options.ctx._apis.configApi.updateWithPluginValues(fullConfig, result.setupConfig ?? {})
+    const finalConfig = this._cachedFullConfig = this.options.ctx._apis.configApi.updateWithPluginValues(fullConfig, result.setupConfig ?? {}, this._testingType ?? 'e2e')
 
     await this.options.onFinalConfigLoaded(finalConfig)
 
@@ -332,7 +332,7 @@ export class ProjectConfigManager {
     return w
   }
 
-  private validateConfigRoot (config: Cypress.ConfigOptions) {
+  private validateConfigRoot (config: Cypress.ConfigOptions, testingType: TestingType) {
     return validateNoBreakingConfigRoot(
       config,
       (type, obj) => {
@@ -341,6 +341,7 @@ export class ProjectConfigManager {
       (type, obj) => {
         throw getError(type, obj)
       },
+      testingType,
     )
   }
 
@@ -359,7 +360,7 @@ export class ProjectConfigManager {
 
   private async buildBaseFullConfig (configFileContents: Cypress.ConfigOptions, envFile: Cypress.ConfigOptions, options: Partial<AllModeOptions>, withBrowsers = true) {
     assert(this._testingType, 'Cannot build base full config without a testing type')
-    this.validateConfigRoot(configFileContents)
+    this.validateConfigRoot(configFileContents, this._testingType)
 
     const testingTypeOverrides = configFileContents[this._testingType] ?? {}
     const optionsOverrides = options.config?.[this._testingType] ?? {}

packages/data-context/src/data/ProjectLifecycleManager.ts

@@ -46,7 +46,7 @@ export interface InjectedConfigApi {
   cypressVersion: string
   validateConfig<T extends Cypress.ConfigOptions>(config: Partial<T>, onErr: (errMsg: ConfigValidationFailureInfo | string) => never): T
   allowedConfig(config: Cypress.ConfigOptions): Cypress.ConfigOptions
-  updateWithPluginValues(config: FullConfig, modifiedConfig: Partial<Cypress.ConfigOptions>): FullConfig
+  updateWithPluginValues(config: FullConfig, modifiedConfig: Partial<Cypress.ConfigOptions>, testingType: TestingType): FullConfig
   setupFullConfigWithDefaults(config: SetupFullConfigOptions): Promise<FullConfig>
 }
 

packages/errors/src/errors.ts

@@ -1409,20 +1409,32 @@ export const AllCypressErrors = {
     const stackTrace = err ? fmt.stackTrace(err) : null
 
     const newName = errShape.newName || '<unknown>'
-    const code = errPartial`
-    {
-      e2e: {
-        specPattern: '...',
-      },
-      component: {
-        specPattern: '...',
-      },
-    }`
 
-    return errTemplate`\
-     The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
-
-      It is now renamed to ${fmt.highlight(newName)} and configured separately as a testing type property: ${fmt.highlightSecondary(`e2e.${newName}`)} and ${fmt.highlightSecondary(`component.${newName}`)}
+    const testingTypedHelpMessage = errShape.testingType
+      ? errPartial`${fmt.highlightSecondary(`${errShape.testingType}.${newName}`)}`
+      : errPartial`${fmt.highlightSecondary(`e2e.${newName}`)} or ${fmt.highlightSecondary(`component.${newName}`)}`
+
+    const code = errShape.testingType
+      ? errPartial`
+        {
+          ${fmt.off(errShape.testingType)}: {
+            specPattern: '...',
+          },
+        }`
+      : errPartial`
+        {
+          e2e: {
+            specPattern: '...',
+          },
+          component: {
+            specPattern: '...',
+          },
+        }`
+
+    return errTemplate`\
+      The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
+
+      It is now renamed to ${fmt.highlight(newName)} and configured separately as a testing type property: ${testingTypedHelpMessage}
       ${fmt.code(code)}
 
       https://on.cypress.io/migration-guide
@@ -1442,7 +1454,7 @@ export const AllCypressErrors = {
     }`
 
     return errTemplate`\
-     The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
+      The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
 
       It is now renamed to ${fmt.highlight('specPattern')} and configured separately as a component testing property: ${fmt.highlightSecondary('component.specPattern')}
       ${fmt.code(code)}
@@ -1464,9 +1476,9 @@ export const AllCypressErrors = {
     }`
 
     return errTemplate`\
-     The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
+      The ${fmt.highlight(errShape.name)} configuration option is now invalid when set on the config object in ${fmt.cypressVersion(`10.0.0`)}.
 
-      It is now renamed to ${fmt.highlight('specPattern')} and configured separately as a component testing property: ${fmt.highlightSecondary('component.specPattern')}
+      It is now renamed to ${fmt.highlight('specPattern')} and configured separately as a end to end testing property: ${fmt.highlightSecondary('e2e.specPattern')}
       ${fmt.code(code)}
 
       https://on.cypress.io/migration-guide