chore: refactor server/lib/config.ts to pkg/config

package.json

@@ -119,6 +119,7 @@
  "@types/send": "^0.17.1",
  "@types/sinon-chai": "3.2.3",
  "@types/through2": "^2.0.36",
+ "@types/underscore.string": "0.0.38",
  "@typescript-eslint/eslint-plugin": "4.18.0",
  "@typescript-eslint/parser": "4.18.0",
  "@urql/introspection": "^0.3.0",

packages/config/package.json

@@ -27,9 +27,11 @@
  "debug": "^4.3.2",
  "fs-extra": "^9.1.0",
  "lodash": "^4.17.21",
- "recast": "0.20.4"
+ "recast": "0.20.4",
+ "return-deep-diff": "0.4.0"
  },
  "devDependencies": {
+ "@packages/errors": "0.0.0-development",
  "@packages/root": "0.0.0-development",
  "@packages/ts": "0.0.0-development",
  "@packages/types": "0.0.0-development",

packages/config/src/index.ts

@@ -2,4 +2,8 @@
 // babel transforms, etc. into client-side usage of the config code
 export * from './browser'
 
+export * from './project'
+
 export { addProjectIdToCypressConfig, addToCypressConfig, addTestingTypeToCypressConfig, AddTestingTypeToCypressConfigOptions, defineConfigAvailable } from './ast-utils/addToCypressConfig'
+
+export * from './utils'

packages/config/src/project/index.ts

@@ -0,0 +1,133 @@
+import _ from 'lodash'
+import Debug from 'debug'
+import deepDiff from 'return-deep-diff'
+
+import errors, { ConfigValidationFailureInfo, CypressError } from '@packages/errors'
+import type {
+ ResolvedFromConfig, TestingType, FullConfig,
+} from '@packages/types'
+
+import {
+ validate,
+ validateNoBreakingConfig,
+} from '../browser'
+import {
+ setPluginResolvedOn,
+ mergeDefaults,
+} from './utils'
+
+const debug = Debug('cypress:config:project')
+
+// TODO: any -> SetupFullConfigOptions in data-context/src/data/ProjectConfigManager.ts
+export function setupFullConfigWithDefaults (obj: any = {}, getFilesByGlob: any): Promise<FullConfig> {
+ debug('setting config object %o', obj)
+ let { projectRoot, projectName, config, envFile, options, cliConfig } = obj
+
+ // just force config to be an object so we dont have to do as much
+ // work in our tests
+ if (config == null) {
+ config = {}
+ }
+
+ debug('config is %o', config)
+
+ // flatten the object's properties into the master config object
+ config.envFile = envFile
+ config.projectRoot = projectRoot
+ config.projectName = projectName
+
+ // @ts-ignore
+ return mergeDefaults(config, options, cliConfig, getFilesByGlob)
+}
+
+// TODO: update types from data-context/src/data/ProjectLifecycleManager.ts
+// updateWithPluginValues(config: FullConfig, modifiedConfig: Partial<Cypress.ConfigOptions>, testingType: TestingType): FullConfig
+export function updateWithPluginValues (cfg: FullConfig, modifiedConfig: any, testingType: TestingType): FullConfig {
+ if (!modifiedConfig) {
+ modifiedConfig = {}
+ }
+
+ debug('updateWithPluginValues %o', { cfg, modifiedConfig })
+
+ // make sure every option returned from the plugins file
+ // passes our validation functions
+ validate(modifiedConfig, (validationResult: ConfigValidationFailureInfo | string) => {
+ let configFile = cfg.configFile!
+
+ if (_.isString(validationResult)) {
+ return errors.throwErr('CONFIG_VALIDATION_MSG_ERROR', 'configFile', configFile, validationResult)
+ }
+
+ return errors.throwErr('CONFIG_VALIDATION_ERROR', 'configFile', configFile, validationResult)
+ })
+
+ debug('validate that there is no breaking config options added by setupNodeEvents')
+
+ function makeSetupError (cyError: CypressError) {
+ cyError.name = `Error running ${testingType}.setupNodeEvents()`
+
+ return cyError
+ }
+
+ validateNoBreakingConfig(modifiedConfig, errors.warning, (err, options) => {
+ throw makeSetupError(errors.get(err, options))
+ }, testingType)
+
+ validateNoBreakingConfig(modifiedConfig[testingType], errors.warning, (err, options) => {
+ throw makeSetupError(errors.get(err, {
+ ...options,
+ name: `${testingType}.${options.name}`,
+ }))
+ }, testingType)
+
+ const originalResolvedBrowsers = _.cloneDeep(cfg?.resolved?.browsers) ?? {
+ value: cfg.browsers,
+ from: 'default',
+ } as ResolvedFromConfig
+
+ const diffs = deepDiff(cfg, modifiedConfig, true)
+
+ debug('config diffs %o', diffs)
+
+ const userBrowserList = diffs && diffs.browsers && _.cloneDeep(diffs.browsers)
+
+ if (userBrowserList) {
+ debug('user browser list %o', userBrowserList)
+ }
+
+ // for each override go through
+ // and change the resolved values of cfg
+ // to point to the plugin
+ if (diffs) {
+ debug('resolved config before diffs %o', cfg.resolved)
+ setPluginResolvedOn(cfg.resolved, diffs)
+ debug('resolved config object %o', cfg.resolved)
+ }
+
+ // merge cfg into overrides
+ const merged = _.defaultsDeep(diffs, cfg)
+
+ debug('merged config object %o', merged)
+
+ // the above _.defaultsDeep combines arrays,
+ // if diffs.browsers = [1] and cfg.browsers = [1, 2]
+ // then the merged result merged.browsers = [1, 2]
+ // which is NOT what we want
+ if (Array.isArray(userBrowserList) && userBrowserList.length) {
+ merged.browsers = userBrowserList
+ merged.resolved.browsers.value = userBrowserList
+ }
+
+ if (modifiedConfig.browsers === null) {
+ // null breaks everything when merging lists
+ debug('replacing null browsers with original list %o', originalResolvedBrowsers)
+ merged.browsers = cfg.browsers
+ if (originalResolvedBrowsers) {
+ merged.resolved.browsers = originalResolvedBrowsers
+ }
+ }
+
+ debug('merged plugins config %o', merged)
+
+ return merged
+}

packages/config/src/project/types.ts

@@ -0,0 +1 @@
+export type Config = Record<string, any>