Do not save confi in file cache

estrada9166 · estrada9166 · commit 0702fbbf9746 · 2021-10-29T12:01:03.000-05:00
diff --git a/packages/data-context/src/DataContext.ts b/packages/data-context/src/DataContext.ts
@@ -5,7 +5,6 @@ import type { NexusGenAbstractTypeMembers } from '@packages/graphql/src/gen/nxs.
 import type { AuthApiShape } from './actions/AuthActions'
 import debugLib from 'debug'
 import fsExtra from 'fs-extra'
-import { CoreDataShape, makeCoreData } from './data/coreDataShape'
 import { DataActions } from './DataActions'
 import {
   AppDataSource,
@@ -27,21 +26,15 @@ export interface DataContextConfig extends DataContextShellConfig {
   os: PlatformName
   launchArgs: LaunchArgs
   launchOptions: OpenProjectLaunchOptions
-  /**
-   * Default is to
-   */
-  coreData?: CoreDataShape
   /**
    * Injected from the server
    */
   appApi: AppApiShape
   authApi: AuthApiShape
-  projectApi: ProjectApiShape
+  projectApi: (ctx: DataContext) => ProjectApiShape
 }
 
 export class DataContext extends DataContextShell {
-  private _coreData: CoreDataShape
-
   @cached
   get fs () {
     return fsExtra
@@ -54,7 +47,6 @@ export class DataContext extends DataContextShell {
 
   constructor (private config: DataContextConfig) {
     super(config)
-    this._coreData = config.coreData ?? makeCoreData()
   }
 
   async initializeData () {
@@ -98,10 +90,6 @@ export class DataContext extends DataContextShell {
     return this.config.launchOptions
   }
 
-  get coreData () {
-    return this._coreData
-  }
-
   get user () {
     return this.coreData.user
   }
@@ -188,7 +176,7 @@ export class DataContext extends DataContextShell {
     return {
       appApi: this.config.appApi,
       authApi: this.config.authApi,
-      projectApi: this.config.projectApi,
+      projectApi: this.config.projectApi(this),
       busApi: this.config.rootBus,
     }
   }
diff --git a/packages/data-context/src/DataContextShell.ts b/packages/data-context/src/DataContextShell.ts
@@ -3,9 +3,14 @@ import type { Server } from 'http'
 import type { AddressInfo } from 'net'
 import { DataEmitterActions } from './actions/DataEmitterActions'
 import { cached } from './util/cached'
+import { CoreDataShape, makeCoreData } from './data/coreDataShape'
 
 export interface DataContextShellConfig {
   rootBus: EventEmitter
+    /**
+   * Default is to
+   */
+     coreData?: CoreDataShape
 }
 
 // Used in places where we have to create a "shell" data context,
@@ -14,8 +19,11 @@ export class DataContextShell {
   private _gqlServer?: Server
   private _appServerPort: number | undefined
   private _gqlServerPort: number | undefined
+  private _coreData: CoreDataShape
 
-  constructor (private shellConfig: DataContextShellConfig = { rootBus: new EventEmitter }) {}
+  constructor (private shellConfig: DataContextShellConfig = { rootBus: new EventEmitter }) {
+    this._coreData = shellConfig.coreData ?? makeCoreData()
+  }
 
   setAppServerPort (port: number | undefined) {
     this._appServerPort = port
@@ -45,6 +53,10 @@ export class DataContextShell {
     }
   }
 
+  get coreData () {
+    return this._coreData
+  }
+
   destroy () {
     this._gqlServer?.close()
   }
diff --git a/packages/data-context/src/actions/ProjectActions.ts b/packages/data-context/src/actions/ProjectActions.ts
@@ -25,7 +25,6 @@ export interface ProjectApiShape {
   clearProjectPreferences(projectTitle: string): Promise<unknown>
   clearAllProjectPreferences(): Promise<unknown>
   closeActiveProject(): Promise<unknown>
-  getProjectConfig (projectRoot: string): Promise<FullConfig | null>
   error(type: string, ...args: any): Error
 }
 
diff --git a/packages/data-context/src/data/coreDataShape.ts b/packages/data-context/src/data/coreDataShape.ts
@@ -63,20 +63,29 @@ export interface BaseErrorDataShape {
   stack?: string
 }
 
+export interface ActiveProjectConfig {
+  settings: Cypress.ConfigOptions
+  envFile: Cypress.ObjectLike
+}
+
 export interface CoreDataShape {
   baseError: BaseErrorDataShape | null
   dev: DevStateShape
   app: AppDataShape
   wizard: WizardDataShape
   user: AuthenticatedUserShape | null
   electron: ElectronShape
+  activeProjectConfig: {
+    [key: string]: ActiveProjectConfig | null
+  }
 }
 
 /**
  * All state for the app should live here for now
  */
 export function makeCoreData (): CoreDataShape {
   return {
+    activeProjectConfig: {},
     baseError: null,
     dev: {
       refreshState: null,
diff --git a/packages/data-context/src/sources/ProjectDataSource.ts b/packages/data-context/src/sources/ProjectDataSource.ts
@@ -88,13 +88,6 @@ export class ProjectDataSource {
     // Check first the config files, to be sure there are no 2 config files
     const configFile = await this.getDefaultConfigFilePath(projectRoot)
 
-    // Check if we have already cached the config
-    const config = await this.api.getProjectConfig(projectRoot)
-
-    if (config) {
-      return config
-    }
-
     return this.configLoader({
       configFile,
     }).load(projectRoot)
diff --git a/packages/server/lib/cache.js b/packages/server/lib/cache.js
@@ -145,19 +145,6 @@ module.exports = {
     return fileUtil.set({ USER: {} })
   },
 
-  // We may need to set this value every time the config file is read, or updated
-  // having it on the cache, will help us preventing to read the file on a cp
-  // to get the projectId
-  setProjectConfig (projectRoot, config) {
-    return fileUtil.set({ PROJECTS_CONFIG: { [projectRoot]: config } })
-  },
-
-  getProjectConfig (projectRoot) {
-    return fileUtil.get('PROJECTS_CONFIG').then((projects) => {
-      return projects && projects[projectRoot] ? projects[projectRoot] : null
-    })
-  },
-
   removeLatestProjects () {
     return fileUtil.set({ PROJECTS: [] })
   },
diff --git a/packages/server/lib/config.ts b/packages/server/lib/config.ts
@@ -14,7 +14,6 @@ import * as settings from './util/settings'
 import Debug from 'debug'
 import pathHelpers from './util/path_helpers'
 import findSystemNode from './util/find_system_node'
-import { setProjectConfig } from './cache'
 
 export interface ConfigSettingsConfig {
   testingType: TestingType
@@ -25,6 +24,7 @@ const debug = Debug('cypress:server:config')
 
 import { options, breakingOptions } from './config_options'
 import { getProcessEnvVars } from './util/config'
+import type { DataContextShell } from '@packages/data-context/src/DataContextShell'
 
 export const CYPRESS_ENV_PREFIX = 'CYPRESS_'
 
@@ -204,12 +204,29 @@ export type FullConfig =
     resolved: ResolvedConfigurationOptions
   }
 
-export function get (projectRoot, options: {configFile?: string | false } = { configFile: undefined }): Promise<FullConfig> {
-  return Promise.all([
-    settings.read(projectRoot, options).then(validateFile(options.configFile ?? 'cypress.config.{ts|js}')),
-    settings.readEnv(projectRoot).then(validateFile('cypress.env.json')),
-  ])
+export function get (projectRoot, options: {configFile?: string | false } = { configFile: undefined }, ctx?: DataContextShell): Promise<FullConfig> {
+  return Promise.resolve(ctx?.coreData.activeProjectConfig[projectRoot])
+  .then((config) => {
+    if (config) {
+      return Promise.resolve([config.settings, config.envFile])
+    }
+
+    return Promise.all([
+      settings.read(projectRoot, options).then(validateFile(options.configFile ?? 'cypress.config.{ts|js}')),
+      settings.readEnv(projectRoot).then(validateFile('cypress.env.json')),
+    ])
+  })
   .spread((settings, envFile) => {
+    if (ctx) {
+      ctx.coreData.activeProjectConfig = {
+        ...ctx.coreData.activeProjectConfig,
+        [projectRoot]: {
+          settings,
+          envFile,
+        },
+      }
+    }
+
     return set({
       projectName: getNameFromRoot(projectRoot),
       projectRoot,
@@ -218,17 +235,16 @@ export function get (projectRoot, options: {configFile?: string | false } = { co
       options,
     })
   })
-  .then((fullConfig) => {
-    return setProjectConfig(projectRoot, fullConfig).then(() => {
-      return fullConfig
-    })
-  })
   .catch((e) => {
     // Cleanup the cache if there's an error to prevent showing stale data
-    return setProjectConfig(projectRoot, null)
-    .then(() => {
-      throw e
-    })
+    if (ctx?.coreData.activeProjectConfig) {
+      ctx.coreData.activeProjectConfig = {
+        ...ctx.coreData.activeProjectConfig,
+        [projectRoot]: null,
+      }
+    }
+
+    throw e
   })
 }
 
diff --git a/packages/server/lib/makeDataContext.ts b/packages/server/lib/makeDataContext.ts
@@ -38,52 +38,51 @@ export function makeDataContext (options: MakeDataContextOptions) {
         return user.logOut()
       },
     },
-    projectApi: {
-      getConfig (projectRoot: string, options?: SettingsOptions) {
-        return config.get(projectRoot, options)
-      },
-      launchProject (browser: FoundBrowser, spec: Cypress.Spec, options?: LaunchOpts) {
-        return openProject.launch({ ...browser }, spec, options)
-      },
-      initializeProject (args: LaunchArgs, options: OpenProjectLaunchOptions, browsers: FoundBrowser[]) {
-        return openProject.create(args.projectRoot, args, options, browsers)
-      },
-      insertProjectToCache (projectRoot: string) {
-        cache.insertProject(projectRoot)
-      },
-      getProjectRootsFromCache () {
-        return cache.getProjectRoots()
-      },
-      findSpecs (payload: FindSpecs) {
-        return specsUtil.findSpecs(payload)
-      },
-      getProjectConfig (projectRoot: string) {
-        return cache.getProjectConfig(projectRoot)
-      },
-      clearLatestProjectsCache () {
-        return cache.removeLatestProjects()
-      },
-      getProjectPreferencesFromCache () {
-        return cache.getProjectPreferences()
-      },
-      clearProjectPreferences (projectTitle: string) {
-        return cache.removeProjectPreferences(projectTitle)
-      },
-      clearAllProjectPreferences () {
-        return cache.removeAllProjectPreferences()
-      },
-      insertProjectPreferencesToCache (projectTitle: string, preferences: Preferences) {
-        cache.insertProjectPreferences(projectTitle, preferences)
-      },
-      removeProjectFromCache (path: string) {
-        return cache.removeProject(path)
-      },
-      closeActiveProject () {
-        return openProject.closeActiveProject()
-      },
-      error (type: string, ...args: any) {
-        throw errors.throw(type, ...args)
-      },
+    projectApi (ctx: DataContext) {
+      return {
+        getConfig (projectRoot: string, options?: SettingsOptions) {
+          return config.get(projectRoot, options, ctx)
+        },
+        launchProject (browser: FoundBrowser, spec: Cypress.Spec, options?: LaunchOpts) {
+          return openProject.launch({ ...browser }, spec, options)
+        },
+        initializeProject (args: LaunchArgs, options: OpenProjectLaunchOptions, browsers: FoundBrowser[]) {
+          return openProject.create(args.projectRoot, args, options, browsers)
+        },
+        insertProjectToCache (projectRoot: string) {
+          cache.insertProject(projectRoot)
+        },
+        getProjectRootsFromCache () {
+          return cache.getProjectRoots()
+        },
+        findSpecs (payload: FindSpecs) {
+          return specsUtil.findSpecs(payload)
+        },
+        clearLatestProjectsCache () {
+          return cache.removeLatestProjects()
+        },
+        getProjectPreferencesFromCache () {
+          return cache.getProjectPreferences()
+        },
+        clearProjectPreferences (projectTitle: string) {
+          return cache.removeProjectPreferences(projectTitle)
+        },
+        clearAllProjectPreferences () {
+          return cache.removeAllProjectPreferences()
+        },
+        insertProjectPreferencesToCache (projectTitle: string, preferences: Preferences) {
+          cache.insertProjectPreferences(projectTitle, preferences)
+        },
+        removeProjectFromCache (path: string) {
+          return cache.removeProject(path)
+        },
+        closeActiveProject () {
+          return openProject.closeActiveProject()
+        },
+        error (type: string, ...args: any) {
+          throw errors.throw(type, ...args)
+        },
+      }
     },
   })
 }
diff --git a/packages/server/lib/project-base.ts b/packages/server/lib/project-base.ts
@@ -34,7 +34,6 @@ import { SpecsStore } from './specs-store'
 import { checkSupportFile, getDefaultConfigFilePath } from './project_utils'
 import type { FoundBrowser, OpenProjectLaunchOptions } from '@packages/types'
 import { DataContextShell } from '@packages/data-context/src/DataContextShell'
-import { getProjectConfig } from './cache'
 
 // Cannot just use RuntimeConfigOptions as is because some types are not complete.
 // Instead, this is an interface of values that have been manually validated to exist
@@ -706,7 +705,7 @@ export class ProjectBase<TServer extends Server> extends EE {
       this.options.configFile = await getDefaultConfigFilePath(this.projectRoot)
     }
 
-    let theCfg: Cfg = await config.get(this.projectRoot, this.options)
+    let theCfg: Cfg = await config.get(this.projectRoot, this.options, this.ctx)
 
     if (!theCfg.browsers || theCfg.browsers.length === 0) {
       // @ts-ignore - we don't know if the browser is headed or headless at this point.
@@ -861,10 +860,10 @@ export class ProjectBase<TServer extends Server> extends EE {
   async getProjectId () {
     await this.verifyExistence()
 
-    const config = await getProjectConfig(this.projectRoot)
+    const config = this.ctx.coreData.activeProjectConfig[this.projectRoot]
 
-    if (config?.projectId) {
-      return config.projectId
+    if (config?.settings.projectId) {
+      return config.settings.projectId
     }
 
     const readSettings = await settings.read(this.projectRoot, this.options)
diff --git a/packages/server/lib/util/settings.ts b/packages/server/lib/util/settings.ts
@@ -6,7 +6,6 @@ import { fs } from '../util/fs'
 import { requireAsync } from './require_async'
 import Debug from 'debug'
 import type { SettingsOptions } from '@packages/types'
-import { getProjectConfig } from '../cache'
 
 const debug = Debug('cypress:server:settings')
 
@@ -131,13 +130,7 @@ export function configFile (options: SettingsOptions = {}) {
 }
 
 export function id (projectRoot, options = {}) {
-  return getProjectConfig(projectRoot).then((config) => {
-    if (config) {
-      return Promise.resolve(config)
-    }
-
-    return read(projectRoot, options)
-  })
+  return read(projectRoot, options)
   .then((config) => config.projectId)
   .catch(() => {
     return null

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,6 @@ export interface ProjectApiShape {`
`25`	`25`	`clearProjectPreferences(projectTitle: string): Promise<unknown>`
`26`	`26`	`clearAllProjectPreferences(): Promise<unknown>`
`27`	`27`	`closeActiveProject(): Promise<unknown>`
`28`		`- getProjectConfig (projectRoot: string): Promise<FullConfig \| null>`
`29`	`28`	`error(type: string, ...args: any): Error`
`30`	`29`	`}`
`31`	`30`