feat: various v8 snapshot improvements (#24909)

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

.circleci/cache-version.txt

@@ -1,3 +1,3 @@
 # Bump this version to force CI to re-create the cache from scratch.
 
-10-31-22
+12-01-22

.circleci/workflows.yml

@@ -28,7 +28,7 @@ mainBuildFilters: &mainBuildFilters
       only:
         - develop
         - /^release\/\d+\.\d+\.\d+$/
-        - 'feature/run-all-specs'
+        - 'ryanm/fix/v8-improvements'
 
 # usually we don't build Mac app - it takes a long time
 # but sometimes we want to really confirm we are doing the right thing
@@ -37,15 +37,15 @@ macWorkflowFilters: &darwin-workflow-filters
   when:
     or:
     - equal: [ develop, << pipeline.git.branch >> ]
-    - equal: [ 'feature/run-all-specs', << pipeline.git.branch >> ]
+    - equal: [ 'ryanm/fix/v8-improvements', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
 linuxArm64WorkflowFilters: &linux-arm64-workflow-filters
   when:
     or:
     - equal: [ develop, << pipeline.git.branch >> ]
-    - equal: [ 'feature/run-all-specs', << pipeline.git.branch >> ]
+    - equal: [ 'ryanm/fix/v8-improvements', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -63,6 +63,7 @@ windowsWorkflowFilters: &windows-workflow-filters
   when:
     or:
     - equal: [ develop, << pipeline.git.branch >> ]
+    - equal: [ 'ryanm/fix/v8-improvements', << pipeline.git.branch >> ]
     - matches:
         pattern: /^release\/\d+\.\d+\.\d+$/
         value: << pipeline.git.branch >>
@@ -128,7 +129,7 @@ commands:
       - run:
           name: Check current branch to persist artifacts
           command: |
-            if [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* ]]; then
+            if [[ "$CIRCLE_BRANCH" != "develop" && "$CIRCLE_BRANCH" != "release/"* && "$CIRCLE_BRANCH" != "ryanm/fix/v8-improvements" ]]; then
               echo "Not uploading artifacts or posting install comment for this branch."
               circleci-agent step halt
             fi
@@ -1928,7 +1929,7 @@ jobs:
       <<: *defaultsParameters
       resource_class:
         type: string
-        default: large
+        default: xlarge
     resource_class: << parameters.resource_class >>
     steps:
       - restore_cached_workspace

package.json

@@ -4,7 +4,7 @@
   "description": "Cypress is a next generation front end testing tool built for the modern web",
   "private": true,
   "scripts": {
-    "binary-build": "node ./scripts/binary.js build",
+    "binary-build": "cross-env NODE_OPTIONS=--max_old_space_size=8192 node ./scripts/binary.js build",
     "binary-deploy": "node ./scripts/binary.js deploy",
     "binary-deploy-linux": "./scripts/build-linux-binary.sh",
     "binary-ensure": "node ./scripts/binary.js ensure",
@@ -70,6 +70,7 @@
     "prepare": "husky install"
   },
   "dependencies": {
+    "bytenode": "1.3.7",
     "nvm": "0.0.4"
   },
   "devDependencies": {
@@ -140,6 +141,7 @@
     "commander": "6.2.1",
     "common-tags": "1.8.0",
     "conventional-recommended-bump": "6.1.0",
+    "cross-env": "7.0.3",
     "debug": "^4.3.2",
     "dedent": "^0.7.0",
     "del": "3.0.0",

packages/rewriter/script/worker-shim.js

@@ -3,13 +3,8 @@ if (process.env.CYPRESS_INTERNAL_ENV === 'production') {
   throw new Error(`${__filename} should only run outside of prod`)
 }
 
-if (require.name !== 'customRequire') {
-  // Purposefully make this a dynamic require so that it doesn't have the potential to get picked up by snapshotting mechanism
-  const hook = './hook'
+const { hookRequire } = require('@packages/server/hook-require')
 
-  const { hookRequire } = require(`@packages/server/${hook}-require`)
-
-  hookRequire(true)
-}
+hookRequire({ forceTypeScript: true })
 
 require('../lib/threads/worker.ts')

packages/server/hook-require.js

@@ -9,7 +9,7 @@ function runWithSnapshot (forceTypeScript) {
   const { snapshotRequire } = require('@packages/v8-snapshot-require')
   const projectBaseDir = process.env.PROJECT_BASE_DIR
 
-  const supportTS = forceTypeScript || typeof global.snapshotResult === 'undefined' || global.supportTypeScript
+  const supportTS = forceTypeScript || typeof global.getSnapshotResult === 'undefined' || global.supportTypeScript
 
   snapshotRequire(projectBaseDir, {
     diagnosticsEnabled: isDev,
@@ -30,8 +30,8 @@ function runWithSnapshot (forceTypeScript) {
   })
 }
 
-const hookRequire = (forceTypeScript) => {
-  if (['1', 'true'].includes(process.env.DISABLE_SNAPSHOT_REQUIRE) || typeof snapshotResult === 'undefined') {
+const hookRequire = ({ forceTypeScript }) => {
+  if (['1', 'true'].includes(process.env.DISABLE_SNAPSHOT_REQUIRE) || typeof getSnapshotResult === 'undefined') {
     require('@packages/ts/register')
   } else {
     runWithSnapshot(forceTypeScript)

packages/server/index.js

@@ -1,18 +1,19 @@
 const { initializeStartTime } = require('./lib/util/performance_benchmark')
 
-const run = async () => {
-  initializeStartTime()
+const startCypress = async () => {
+  try {
+    initializeStartTime()
 
-  if (require.name !== 'customRequire') {
-    // Purposefully make this a dynamic require so that it doesn't have the potential to get picked up by snapshotting mechanism
-    const hook = './hook'
+    const { hookRequire } = require('./hook-require')
 
-    const { hookRequire } = require(`${hook}-require`)
+    hookRequire({ forceTypeScript: false })
 
-    hookRequire(false)
+    await require('./start-cypress')
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error(error)
+    process.exit(1)
   }
-
-  await require('./server-entry')
 }
 
-module.exports = run()
+module.exports = startCypress()

packages/server/package.json

@@ -194,10 +194,11 @@
   },
   "files": [
     "config",
+    "hook-require.js",
     "lib",
     "patches",
-    "server-entry.js",
-    "hook-require.js"
+    "start-cypress.js",
+    "v8-snapshot-entry.js"
   ],
   "types": "index.d.ts",
   "productName": "Cypress",

packages/server/v8-snapshot-entry.js

@@ -0,0 +1 @@
+require('./start-cypress')

packages/ts/registerDir.js

@@ -8,8 +8,8 @@ const path = require('path')
 // build has been done correctly
 module.exports = function (scopeDir) {
   // Only set up ts-node if we're not using the snapshot
-  // @ts-ignore snapshotResult is a global defined in the v8 snapshot
-  if (['1', 'true'].includes(process.env.DISABLE_SNAPSHOT_REQUIRE) || typeof snapshotResult === 'undefined') {
+  // @ts-ignore getSnapshotResult is a global defined in the v8 snapshot
+  if (['1', 'true'].includes(process.env.DISABLE_SNAPSHOT_REQUIRE) || typeof getSnapshotResult === 'undefined') {
     try {
     // Prevent double-compiling if we're testing the app and already have ts-node hook installed
     // TODO(tim): e2e testing does not like this, I guess b/c it's currently using the tsconfig

packages/v8-snapshot-require/src/snapshot-require.ts

@@ -181,8 +181,8 @@ export function snapshotRequire (
   // 1. Assign snapshot which is a global if it was embedded
   const sr: Snapshot =
     opts.snapshotOverride ||
-    // @ts-ignore global snapshotResult
-    (typeof snapshotResult !== 'undefined' ? snapshotResult : undefined)
+    // @ts-ignore global getSnapshotResult
+    (typeof getSnapshotResult !== 'undefined' ? getSnapshotResult() : undefined)
 
   // If we have no snapshot we don't need to hook anything
   if (sr != null || alwaysHook) {
@@ -239,10 +239,7 @@ export function snapshotRequire (
         moduleNeedsReload,
       })
 
-    // @ts-ignore global snapshotResult
-    // 8. Ensure that the user passed the project base dir since the loader
-    //    cannot resolve modules without it
-    if (typeof snapshotResult !== 'undefined') {
+    if (typeof sr !== 'undefined') {
       const projectBaseDir = process.env.PROJECT_BASE_DIR
 
       if (projectBaseDir == null) {
@@ -290,8 +287,8 @@ export function snapshotRequire (
 
       // 11. Inject those globals
 
-      // @ts-ignore global snapshotResult
-      snapshotResult.setGlobals(
+      // @ts-ignore setGlobals is a function on global sr
+      sr.setGlobals(
         global,
         checked_process,
         checked_window,
@@ -305,8 +302,8 @@ export function snapshotRequire (
 
       // @ts-ignore private module var
       require.cache = Module._cache
-      // @ts-ignore global snapshotResult
-      snapshotResult.customRequire.cache = require.cache
+      // @ts-ignore customRequire is a property of global sr
+      sr.customRequire.cache = require.cache
 
       // 12. Add some 'magic' functions that we can use from inside the
       //    snapshot in order to integrate module loading

scripts/after-pack-hook.js

@@ -6,7 +6,8 @@ const os = require('os')
 const path = require('path')
 const { setupV8Snapshots } = require('@tooling/v8-snapshot')
 const { flipFuses, FuseVersion, FuseV1Options } = require('@electron/fuses')
-const { cleanup } = require('./binary/binary-cleanup')
+const { buildEntryPointAndCleanup } = require('./binary/binary-cleanup')
+const { getIntegrityCheckSource, getBinaryEntryPointSource } = require('./binary/binary-sources')
 
 module.exports = async function (params) {
   console.log('****************************')
@@ -55,6 +56,8 @@ module.exports = async function (params) {
   }
 
   if (!['1', 'true'].includes(process.env.DISABLE_SNAPSHOT_REQUIRE)) {
+    await fs.writeFile(path.join(outputFolder, 'index.js'), getBinaryEntryPointSource())
+
     await flipFuses(
       exePathPerPlatform[os.platform()],
       {
@@ -63,7 +66,11 @@ module.exports = async function (params) {
       },
     )
 
-    await setupV8Snapshots(params.appOutDir)
-    await cleanup(outputFolder)
+    // Build out the entry point and clean up prior to setting up v8 snapshots so that the state of the binary is correct
+    await buildEntryPointAndCleanup(outputFolder)
+    await setupV8Snapshots({
+      cypressAppPath: params.appOutDir,
+      integrityCheckSource: getIntegrityCheckSource(outputFolder),
+    })
   }
 }

scripts/binary/binary-cleanup.js

@@ -6,6 +6,7 @@ const esbuild = require('esbuild')
 const snapshotMetadata = require('@tooling/v8-snapshot/cache/prod-darwin/snapshot-meta.cache.json')
 const tempDir = require('temp-dir')
 const workingDir = path.join(tempDir, 'binary-cleanup-workdir')
+const bytenode = require('bytenode')
 
 fs.ensureDirSync(workingDir)
 
@@ -39,8 +40,6 @@ async function removeEmptyDirectories (directory) {
 const getDependencyPathsToKeep = async (buildAppDir) => {
   const unixBuildAppDir = buildAppDir.split(path.sep).join(path.posix.sep)
   const startingEntryPoints = [
-    'packages/server/index.js',
-    'packages/server/hook-require.js',
     'packages/server/lib/plugins/child/require_async_child.js',
     'packages/server/lib/plugins/child/register_ts_node.js',
     'packages/rewriter/lib/threads/worker.js',
@@ -81,7 +80,7 @@ const getDependencyPathsToKeep = async (buildAppDir) => {
       absWorkingDir: unixBuildAppDir,
       external: [
         './transpile-ts',
-        './server-entry',
+        './start-cypress',
         'fsevents',
         'pnpapi',
         '@swc/core',
@@ -111,18 +110,63 @@ const getDependencyPathsToKeep = async (buildAppDir) => {
     })
   }
 
-  return [...Object.keys(esbuildResult.metafile.inputs), ...entryPoints]
+  return [...Object.keys(esbuildResult.metafile.inputs), ...entryPoints, 'package.json']
 }
 
-const cleanup = async (buildAppDir) => {
-  // 1. Retrieve all dependencies that still need to be kept in the binary. In theory, we could use the bundles generated here as single files within the binary,
-  // but for now, we just track on the dependencies that get pulled in
-  const keptDependencies = [...await getDependencyPathsToKeep(buildAppDir), 'package.json', 'packages/server/server-entry.js']
+const createServerEntryPointBundle = async (buildAppDir) => {
+  const unixBuildAppDir = buildAppDir.split(path.sep).join(path.posix.sep)
+  const entryPoints = [path.join(unixBuildAppDir, 'packages/server/index.js')]
+  // Build the binary entry point ignoring anything that happens in start-cypress since that will be in the v8 snapshot
+  const esbuildResult = await esbuild.build({
+    entryPoints,
+    bundle: true,
+    outdir: workingDir,
+    platform: 'node',
+    metafile: true,
+    absWorkingDir: unixBuildAppDir,
+    external: [
+      './transpile-ts',
+      './start-cypress',
+    ],
+  })
+
+  console.log(`copying server entry point bundle from ${path.join(workingDir, 'index.js')} to ${path.join(buildAppDir, 'packages', 'server', 'index.js')}`)
+
+  await fs.copy(path.join(workingDir, 'index.js'), path.join(buildAppDir, 'packages', 'server', 'index.js'))
+
+  console.log(`compiling server entry point bundle to ${path.join(buildAppDir, 'packages', 'server', 'index.jsc')}`)
+
+  // Use bytenode to compile the entry point bundle. This will save time on the v8 compile step and ensure the integrity of the entry point
+  await bytenode.compileFile({
+    filename: path.join(buildAppDir, 'packages', 'server', 'index.js'),
+    output: path.join(buildAppDir, 'packages', 'server', 'index.jsc'),
+    electron: true,
+  })
+
+  // Convert these inputs to a relative file path. Note that these paths are posix paths.
+  return [...Object.keys(esbuildResult.metafile.inputs)].map((input) => `./${input}`)
+}
+
+const buildEntryPointAndCleanup = async (buildAppDir) => {
+  const [keptDependencies, serverEntryPointBundleDependencies] = await Promise.all([
+    // 1. Retrieve all dependencies that still need to be kept in the binary. In theory, we could use the bundles generated here as single files within the binary,
+    // but for now, we just track on the dependencies that get pulled in
+    getDependencyPathsToKeep(buildAppDir),
+    // 2. Create a bundle for the server entry point. This will be used to start the server in the binary. It returns the dependencies that are pulled in by this bundle that potentially can now be removed
+    createServerEntryPointBundle(buildAppDir),
+  ])
+
+  // 3. Gather the dependencies that could potentially be removed from the binary due to being in the snapshot or in the entry point bundle
+  const potentiallyRemovedDependencies = [
+    ...snapshotMetadata.healthy,
+    ...snapshotMetadata.deferred,
+    ...snapshotMetadata.norewrite,
+    ...serverEntryPointBundleDependencies,
+  ]
 
-  // 2. Gather the dependencies that could potentially be removed from the binary due to being in the snapshot
-  const potentiallyRemovedDependencies = [...snapshotMetadata.healthy, ...snapshotMetadata.deferred, ...snapshotMetadata.norewrite]
+  console.log(`potentially removing ${potentiallyRemovedDependencies.length} dependencies`)
 
-  // 3. Remove all dependencies that are in the snapshot but not in the list of kept dependencies from the binary
+  // 4. Remove all dependencies that are in the snapshot but not in the list of kept dependencies from the binary
   await Promise.all(potentiallyRemovedDependencies.map(async (dependency) => {
     const typeScriptlessDependency = dependency.replace(/\.ts$/, '.js')
 
@@ -132,10 +176,10 @@ const cleanup = async (buildAppDir) => {
     }
   }))
 
-  // 4. Consolidate dependencies that are safe to consolidate (`lodash` and `bluebird`)
+  // 5. Consolidate dependencies that are safe to consolidate (`lodash` and `bluebird`)
   await consolidateDeps({ projectBaseDir: buildAppDir })
 
-  // 5. Remove various unnecessary files from the binary to further clean things up. Likely, there is additional work that can be done here
+  // 6. Remove various unnecessary files from the binary to further clean things up. Likely, there is additional work that can be done here
   await del([
     // Remove test files
     path.join(buildAppDir, '**', 'test'),
@@ -187,10 +231,10 @@ const cleanup = async (buildAppDir) => {
     path.join(buildAppDir, '**', 'yarn.lock'),
   ], { force: true })
 
-  // 6. Remove any empty directories as a result of the rest of the cleanup
+  // 7. Remove any empty directories as a result of the rest of the cleanup
   await removeEmptyDirectories(buildAppDir)
 }
 
 module.exports = {
-  cleanup,
+  buildEntryPointAndCleanup,
 }

scripts/binary/binary-entry-point-source.js

@@ -0,0 +1,21 @@
+const Module = require('module')
+const path = require('path')
+
+process.env.CYPRESS_INTERNAL_ENV = process.env.CYPRESS_INTERNAL_ENV || 'production'
+try {
+  require('./node_modules/bytenode/lib/index.js')
+  const filename = path.join(__dirname, 'packages', 'server', 'index.jsc')
+  const dirname = path.dirname(filename)
+
+  Module._extensions['.jsc']({
+    require: module.require,
+    id: filename,
+    filename,
+    loaded: false,
+    path: dirname,
+    paths: Module._nodeModulePaths(dirname),
+  }, filename)
+} catch (error) {
+  console.error(error)
+  process.exit(1)
+}