chore: configurable force deferred in snapshot doctor

.vscode/settings.json

@@ -38,4 +38,13 @@
   "volar.takeOverMode.enabled": "auto",
 
   "editor.tabSize": 2,
+  "coverage-gutters.coverageFileNames": [
+    "coverage-final.json",
+    "lcov.info",
+    "cov.xml",
+    "coverage.xml",
+    "cobertura.xml",
+    "jacoco.xml",
+    "coverage.cobertura.xml"
+  ],
 }

.yarnclean

@@ -44,4 +44,6 @@ wercker.yml
 .flowconfig
 .documentup.json
 .yarn-metadata.json
-.travis.yml
+.travis.yml
+
+!node_modules/istanbul-reports/lib/html/assets

packages/data-context/src/util/config-file-updater.ts

@@ -34,6 +34,7 @@ export async function insertValueInJSString (fileContents: string, obj: Record<s
         && nodePath.node.callee.type === 'Identifier') {
       const functionName = nodePath.node.callee.name
 
+      // @ts-expect-error - ast is the wrong type
       if (isDefineConfigFunction(ast, functionName)) {
         return handleExport(nodePath.get('arguments', 0))
       }

tooling/v8-snapshot/package.json

@@ -12,7 +12,9 @@
     "test": "yarn test-unit",
     "test-integration": "mocha test/integration/**/*.spec.ts --config ./test/.mocharc.js",
     "test-unit": "mocha test/unit/**/*.spec.ts --config ./test/.mocharc.js",
-    "watch": "tsc --watch"
+    "test-vspec": "vitest run",
+    "watch": "tsc --watch",
+    "watch-vspec": "vitest watch"
   },
   "dependencies": {
     "@tooling/electron-mksnapshot": "0.0.0-development",
@@ -29,11 +31,13 @@
   },
   "devDependencies": {
     "@tooling/system-tests": "0.0.0-development",
+    "@vitest/coverage-v8": "2.1.8",
     "chai-as-promised": "7.1.1",
     "cpr": "^3.0.1",
     "mocha": "7.0.1",
     "snap-shot-it": "7.9.10",
-    "stealthy-require": "^1.1.1"
+    "stealthy-require": "^1.1.1",
+    "vitest": "2.1.8"
   },
   "files": [
     "dist",

tooling/v8-snapshot/src/doctor/dependency-match.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if a dependency matches a force no rewrite entry
+ * @param dependency - The dependency to check
+ * @param forceNorewrite - The force no rewrite entry
+ * @returns true if the dependency matches the force no rewrite entry, false otherwise
+ */
+export const doesDependencyMatchForceNorewriteEntry = (dependency: string, forceNorewrite: string) => {
+  // The force no rewrite file follows a convention where we try
+  // and match all possible node_modules paths if the force no
+  // rewrite entry starts with "*/". If it does not
+  // start with "*" then it is an exact match.
+  return (forceNorewrite.startsWith('*/') && dependency.endsWith(forceNorewrite.slice(2))) || dependency === forceNorewrite
+}

tooling/v8-snapshot/src/doctor/determine-deferred.ts

@@ -1,9 +1,10 @@
 import debug from 'debug'
 import fs from 'fs'
 import path from 'path'
-import { doesDependencyMatchForceNorewriteEntry, SnapshotDoctor } from './snapshot-doctor'
+import { SnapshotDoctor } from './snapshot-doctor'
 import { canAccess, createHashForFile, matchFileHash } from '../utils'
-
+import { doesDependencyMatchForceNorewriteEntry } from './dependency-match'
+import { forceDeferred } from '../setup/force-deferred'
 const logInfo = debug('cypress:snapgen:info')
 
 interface ErrorOnInvalidForceNorewriteOpts {
@@ -49,6 +50,20 @@ function errorOnInvalidForceNorewrite (opts: ErrorOnInvalidForceNorewriteOpts) {
   }
 }
 
+export interface SnapshotMetadata {
+  deferredHash: string
+  norewrite: string[]
+  deferred: string[]
+  healthy: string[]
+}
+
+async function importCachedSnapshotMetadata (cacheDir: string): Promise<SnapshotMetadata> {
+  const jsonPath = path.join(cacheDir, 'snapshot-meta.json')
+  const contents = await fs.promises.readFile(jsonPath, 'utf8')
+
+  return JSON.parse(contents) satisfies SnapshotMetadata
+}
+
 export async function determineDeferred (
   bundlerPath: string,
   projectBaseDir: string,
@@ -63,11 +78,12 @@ export async function determineDeferred (
   },
 ) {
   const jsonPath = path.join(cacheDir, 'snapshot-meta.json')
+
   const usePreviousSnapshotMetadata = (!process.env.V8_SNAPSHOT_FROM_SCRATCH || !['1', 'true'].includes(process.env.V8_SNAPSHOT_FROM_SCRATCH)) && await canAccess(jsonPath)
-  const { deferredHash, norewrite, deferred, healthy } = usePreviousSnapshotMetadata ? require(jsonPath) : { deferredHash: '', norewrite: [], deferred: [], healthy: [] }
+  const { deferredHash, norewrite, deferred, healthy } = usePreviousSnapshotMetadata ? await importCachedSnapshotMetadata(cacheDir) : await Promise.resolve({ deferredHash: '', norewrite: [], deferred: [], healthy: [] })
+
   const hashFilePath = await findHashFile(projectBaseDir)
   const currentHash = await createHashForFile(hashFilePath)
-  const res = await matchFileHash(hashFilePath, deferredHash)
 
   let nodeModulesHealthy: string[] = []
   let projectHealthy: string[] = []
@@ -105,7 +121,10 @@ export async function determineDeferred (
     }
   })
 
-  if (res.match && opts.nodeModulesOnly) {
+  const res = await matchFileHash(hashFilePath, deferredHash)
+  const fileHashMatchesDeferredHash = res.match
+
+  if (fileHashMatchesDeferredHash && opts.nodeModulesOnly) {
     const combined: Set<string> = new Set([
       ...currentNorewrite,
       ...opts.forceNorewrite,
@@ -127,9 +146,9 @@ export async function determineDeferred (
     entryFilePath: snapshotEntryFile,
     baseDirPath: projectBaseDir,
     nodeModulesOnly: opts.nodeModulesOnly,
-    previousDeferred: currentDeferred,
-    previousHealthy: currentHealthy,
-    previousNorewrite: currentNorewrite,
+    previousDeferred: new Set([...currentDeferred, ...forceDeferred()]),
+    previousHealthy: new Set(currentHealthy),
+    previousNorewrite: new Set(currentNorewrite),
     forceNorewrite: opts.forceNorewrite,
     nodeEnv: opts.nodeEnv,
     cypressInternalEnv: opts.cypressInternalEnv,

tooling/v8-snapshot/src/doctor/snapshot-doctor.ts

@@ -19,6 +19,7 @@ import {
   WarningConsequence,
   WarningsProcessor,
 } from './warnings-processor'
+import { doesDependencyMatchForceNorewriteEntry } from './dependency-match'
 
 const logInfo = debug('cypress:snapgen:info')
 const logDebug = debug('cypress:snapgen:debug')
@@ -48,20 +49,6 @@ export type SnapshotDoctorOpts = Omit<
   forceNorewrite: Set<string>
 }
 
-/**
- * Checks if a dependency matches a force no rewrite entry
- * @param dependency - The dependency to check
- * @param forceNorewrite - The force no rewrite entry
- * @returns true if the dependency matches the force no rewrite entry, false otherwise
- */
-export const doesDependencyMatchForceNorewriteEntry = (dependency: string, forceNorewrite: string) => {
-  // The force no rewrite file follows a convention where we try
-  // and match all possible node_modules paths if the force no
-  // rewrite entry starts with "*/". If it does not
-  // start with "*" then it is an exact match.
-  return (forceNorewrite.startsWith('*/') && dependency.endsWith(forceNorewrite.slice(2))) || dependency === forceNorewrite
-}
-
 /**
  * Tracks which modules have been deferred, need to be deferred and so on
  * during the doctor process

tooling/v8-snapshot/src/generator/snapshot-generator.ts

@@ -263,10 +263,12 @@ export class SnapshotGenerator {
     if (this.useExistingSnapshotScript) {
       let contents = await fs.promises.readFile(this.snapshotScriptPath, 'utf8')
 
+      console.log('??', contents, this.updateSnapshotScriptContents)
       if (this.updateSnapshotScriptContents) {
         contents = this.updateSnapshotScriptContents(contents)
       }
 
+      console.log('??', contents)
       this.snapshotScript = Buffer.from(contents)
       await fs.promises.writeFile(this.snapshotScriptPath, this.snapshotScript)
 
@@ -339,7 +341,8 @@ export class SnapshotGenerator {
     //    errors we verify that the generated script is snapshot-able.
     logInfo('Verifying snapshot script')
     try {
-      this._verifyScript()
+      assert(this.snapshotScript != null, 'need snapshotScript to be set')
+      this._snapshotVerifier.verify(this.snapshotScript, this.snapshotScriptPath)
     } catch (err) {
       logInfo(`Script failed verification, writing to ${this.snapshotScriptPath}`)
 
@@ -604,9 +607,4 @@ export class SnapshotGenerator {
 
     throw new Error('make snapshot failed')
   }
-
-  private _verifyScript () {
-    assert(this.snapshotScript != null, 'need snapshotScript to be set')
-    this._snapshotVerifier.verify(this.snapshotScript, this.snapshotScriptPath)
-  }
 }

tooling/v8-snapshot/src/setup/force-deferred.ts

@@ -0,0 +1,3 @@
+export function forceDeferred (): string[] {
+  return []
+}

tooling/v8-snapshot/test/fixtures/force-deferred.json

@@ -0,0 +1,6 @@
+{
+  "empty": [],
+  "withValues": [
+    "node_modules/some-package/src/index.js"
+  ]
+}