cache benchmark revision archives

Author: yaacovCR

resources/benchmark/projects.ts

@@ -1,3 +1,4 @@
+import assert from 'node:assert';
 import fs from 'node:fs';
 import path from 'node:path';
 
@@ -6,53 +7,60 @@ import { git, localRepoPath, makeTmpDir, npm } from '../utils.js';
 import { LOCAL } from './config.js';
 import type { BenchmarkProject } from './types.js';
 
-// Build a benchmark-friendly environment for each revision.
+// Build a benchmark-friendly install for each revision.
 export function prepareBenchmarkProjects(
   revisionList: ReadonlyArray<string>,
 ): Array<BenchmarkProject> {
   const { tmpDirPath } = makeTmpDir('graphql-js-benchmark');
+  const { tmpDirPath: benchmarkCachePath } = makeTmpDir(
+    'graphql-js-benchmark-cache',
+    false,
+  );
 
   return revisionList.map((revision) => {
-    console.log(`\u{1F373}  Preparing ${revision}...`);
-    const projectPath = tmpDirPath('setup', revision);
-    fs.rmSync(projectPath, { recursive: true, force: true });
-    fs.mkdirSync(projectPath, { recursive: true });
-
-    fs.cpSync(localRepoPath('benchmark'), path.join(projectPath, 'benchmark'), {
-      recursive: true,
-    });
-
-    fs.writeFileSync(
-      path.join(projectPath, 'package.json'),
-      JSON.stringify(
+    // Resolve refs like "main" to full SHAs so equivalent revisions reuse setup.
+    const hash = revision === LOCAL ? LOCAL : git().revParse(revision);
+    const projectPath = tmpDirPath('setup', hash);
+    if (!fs.existsSync(projectPath)) {
+      console.log('\u{1F373}  Preparing ' + revision + '...');
+      fs.mkdirSync(projectPath, { recursive: true });
+      fs.cpSync(
+        localRepoPath('benchmark'),
+        path.join(projectPath, 'benchmark'),
         {
-          private: true,
-          type: 'module',
-          dependencies: {
-            graphql: prepareNPMPackage(revision),
-          },
+          recursive: true,
         },
-        null,
-        2,
-      ),
-    );
-    npm({ cwd: projectPath, quiet: true }).install('--ignore-scripts');
+      );
+
+      fs.writeFileSync(
+        path.join(projectPath, 'package.json'),
+        JSON.stringify(
+          {
+            private: true,
+            type: 'module',
+            dependencies: {
+              graphql: prepareNPMPackage(hash),
+            },
+          },
+          null,
+          2,
+        ),
+      );
+      npm({ cwd: projectPath, quiet: true }).install('--ignore-scripts');
+    }
 
     return { revision, projectPath };
   });
 
-  function prepareNPMPackage(revision: string): string {
-    if (revision === LOCAL) {
+  function prepareNPMPackage(hash: string): string {
+    if (hash === LOCAL) {
       const repoDir = localRepoPath();
       const archivePath = tmpDirPath('graphql-local.tgz');
-      fs.renameSync(buildNPMArchive(repoDir), archivePath);
+      copyBuiltArchive(repoDir, archivePath);
       return archivePath;
     }
 
-    // Returns the complete git hash for a given git revision reference.
-    const hash = git().revParse(revision);
-
-    const archivePath = tmpDirPath(`graphql-${hash}.tgz`);
+    const archivePath = benchmarkCachePath(`graphql-${hash}.tgz`);
     if (fs.existsSync(archivePath)) {
       return archivePath;
     }
@@ -63,16 +71,35 @@ export function prepareBenchmarkProjects(
     git({ quiet: true }).clone(localRepoPath(), repoDir);
     git({ cwd: repoDir, quiet: true }).checkout('--detach', hash);
     npm({ cwd: repoDir, quiet: true }).ci('--ignore-scripts');
-    fs.renameSync(buildNPMArchive(repoDir), archivePath);
+    copyBuiltArchive(repoDir, archivePath);
     fs.rmSync(repoDir, { recursive: true });
     return archivePath;
   }
 
+  function copyBuiltArchive(repoDir: string, archivePath: string): void {
+    const sourcePath = buildNPMArchive(repoDir);
+    fs.copyFileSync(sourcePath, archivePath);
+    fs.rmSync(sourcePath, { force: true });
+  }
+
   function buildNPMArchive(repoDir: string): string {
     npm({ cwd: repoDir, quiet: true }).run('build:npm');
 
     const distDir = path.join(repoDir, 'npmDist');
-    const archiveName = npm({ cwd: repoDir, quiet: true }).pack(distDir);
-    return path.join(repoDir, archiveName);
+    const archivePath = path.join(repoDir, getNPMArchiveName(repoDir));
+    fs.rmSync(archivePath, { force: true });
+    npm({ cwd: repoDir, quiet: true }).pack(distDir);
+    assert(fs.existsSync(archivePath), 'npm pack did not create an archive.');
+    return archivePath;
   }
 }
+
+function getNPMArchiveName(repoDir: string): string {
+  const packageJSON = JSON.parse(
+    fs.readFileSync(path.join(repoDir, 'package.json'), 'utf8'),
+  ) as { name?: string; version?: string };
+  const packageName = packageJSON.name?.replace(/^@/, '').replaceAll('/', '-');
+  assert(packageName != null, 'package.json is missing a package name.');
+  assert(packageJSON.version != null, 'package.json is missing a version.');
+  return `${packageName}-${packageJSON.version}.tgz`;
+}

resources/utils.ts

@@ -18,10 +18,15 @@ interface MakeTmpDirReturn {
   tmpDirPath: (...paths: ReadonlyArray<string>) => string;
 }
 
-export function makeTmpDir(name: string): MakeTmpDirReturn {
+export function makeTmpDir(
+  name: string,
+  clear: boolean = true,
+): MakeTmpDirReturn {
   const tmpDir = path.join(os.tmpdir(), name);
-  fs.rmSync(tmpDir, { recursive: true, force: true });
-  fs.mkdirSync(tmpDir);
+  if (clear) {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  }
+  fs.mkdirSync(tmpDir, { recursive: true });
 
   return {
     tmpDirPath: (...paths) => path.join(tmpDir, ...paths),