fix: allow migration of pluginsFile using env properties (#20770)

* fix: allow migration of code-coverage plugin

* fix: use 9.X options to default migration

* fix: remove internal values from options

* test: add unit tests to the new model

* test: e2e test all error prone defaultValues

* fix: avoid removing values in pluginsFile

* test: fix tests

* test: fix test

* fix unit test

Author: Barthélémy Ledoux

packages/data-context/src/actions/MigrationActions.ts

@@ -3,6 +3,7 @@ import path from 'path'
 import { fork } from 'child_process'
 import type { ForkOptions } from 'child_process'
 import assert from 'assert'
+import _ from 'lodash'
 import type { DataContext } from '..'
 import {
   cleanUpIntegrationFolder,
@@ -23,10 +24,45 @@ import {
   getComponentFolder,
   getIntegrationTestFilesGlobs,
   getSpecPattern,
+  legacyOptions,
 } from '../sources/migration'
 import { makeCoreData } from '../data'
 import { LegacyPluginsIpc } from '../data/LegacyPluginsIpc'
 
+export function getConfigWithDefaults (legacyConfig: any) {
+  const newConfig = _.cloneDeep(legacyConfig)
+
+  legacyOptions.forEach(({ defaultValue, name }) => {
+    if (defaultValue !== undefined && legacyConfig[name] === undefined) {
+      newConfig[name] = typeof defaultValue === 'function' ? defaultValue() : defaultValue
+    }
+  })
+
+  return newConfig
+}
+
+export function getDiff (oldConfig: any, newConfig: any) {
+  // get all the values updated
+  const result: any = _.reduce(oldConfig, (acc: any, value, key) => {
+    // ignore values that have been removed
+    if (newConfig[key] && !_.isEqual(value, newConfig[key])) {
+      acc[key] = newConfig[key]
+    }
+
+    return acc
+  }, {})
+
+  // get all the values added
+  return _.reduce(newConfig, (acc: any, value, key) => {
+    // their key is in the new config but not in the old config
+    if (!oldConfig.hasOwnProperty(key)) {
+      acc[key] = value
+    }
+
+    return acc
+  }, result)
+}
+
 export async function processConfigViaLegacyPlugins (projectRoot: string, legacyConfig: LegacyCypressConfigJson): Promise<LegacyCypressConfigJson> {
   const pluginFile = legacyConfig.pluginsFile ?? await tryGetDefaultLegacyPluginsFile(projectRoot)
 
@@ -49,12 +85,23 @@ export async function processConfigViaLegacyPlugins (projectRoot: string, legacy
     const CHILD_PROCESS_FILE_PATH = require.resolve('@packages/server/lib/plugins/child/require_async_child')
     const ipc = new LegacyPluginsIpc(fork(CHILD_PROCESS_FILE_PATH, configProcessArgs, childOptions))
 
+    const legacyConfigWithDefaults = getConfigWithDefaults(legacyConfig)
+
     ipc.on('ready', () => {
-      ipc.send('loadLegacyPlugins', legacyConfig)
+      ipc.send('loadLegacyPlugins', legacyConfigWithDefaults)
     })
 
     ipc.on('loadLegacyPlugins:reply', (modifiedLegacyConfig) => {
-      resolve(modifiedLegacyConfig)
+      const diff = getDiff(legacyConfigWithDefaults, modifiedLegacyConfig)
+
+      // if env is updated by plugins, avoid adding it to the config file
+      if (diff.env) {
+        delete diff.env
+      }
+
+      const legacyConfigWithChanges = _.merge(legacyConfig, diff)
+
+      resolve(legacyConfigWithChanges)
       ipc.childProcess.kill()
     })
 

packages/data-context/src/sources/MigrationDataSource.ts

@@ -31,6 +31,8 @@ export type LegacyCypressConfigJson = Partial<{
   integrationFolder: string
   testFiles: string | string[]
   ignoreTestFiles: string | string[]
+  env: { [key: string]: any }
+  [index: string]: any
 }>
 
 export interface MigrationFile {

packages/data-context/src/sources/migration/index.ts

@@ -4,6 +4,7 @@
 export * from './autoRename'
 export * from './codegen'
 export * from './format'
+export * from './legacyOptions'
 export * from './parserUtils'
 export * from './regexps'
 export * from './shouldShowSteps'