resources: add utility function to create tmp dir (#3723)

Author: IvanGoncharov

package.json

@@ -44,7 +44,7 @@
     "prettier": "prettier --cache --cache-strategy metadata --write --list-different .",
     "prettier:check": "prettier --cache --cache-strategy metadata --check .",
     "check:spelling": "cspell --cache --no-progress '**/*'",
-    "check:integrations": "npm run build:npm && npm run build:deno && mocha --full-trace resources/integration-test.ts",
+    "check:integrations": "mocha --full-trace resources/integration-test.ts",
     "serve": "docusaurus serve --dir websiteDist/ --config website/docusaurus.config.cjs",
     "start": "npm run build:website && npm run serve",
     "build:website": "ts-node resources/build-docusaurus.ts",

resources/benchmark.ts

@@ -1,11 +1,10 @@
 import assert from 'node:assert';
 import cp from 'node:child_process';
 import fs from 'node:fs';
-import os from 'node:os';
 import path from 'node:path';
 import url from 'node:url';
 
-import { git, localRepoPath, npm } from './utils.js';
+import { git, localRepoPath, makeTmpDir, npm } from './utils.js';
 
 const NS_PER_SEC = 1e9;
 const LOCAL = 'local';
@@ -35,18 +34,13 @@ interface BenchmarkProject {
 function prepareBenchmarkProjects(
   revisionList: ReadonlyArray<string>,
 ): Array<BenchmarkProject> {
-  const tmpDir = path.join(os.tmpdir(), 'graphql-js-benchmark');
-  fs.rmSync(tmpDir, { recursive: true, force: true });
-  fs.mkdirSync(tmpDir);
-
-  const setupDir = path.join(tmpDir, 'setup');
-  fs.mkdirSync(setupDir);
+  const { tmpDirPath } = makeTmpDir('graphql-js-benchmark');
 
   return revisionList.map((revision) => {
     console.log(`🍳  Preparing ${revision}...`);
-    const projectPath = path.join(setupDir, revision);
+    const projectPath = tmpDirPath('setup', revision);
     fs.rmSync(projectPath, { recursive: true, force: true });
-    fs.mkdirSync(projectPath);
+    fs.mkdirSync(projectPath, { recursive: true });
 
     fs.cpSync(localRepoPath('benchmark'), path.join(projectPath, 'benchmark'), {
       recursive: true,
@@ -71,20 +65,20 @@ function prepareBenchmarkProjects(
   function prepareNPMPackage(revision: string) {
     if (revision === LOCAL) {
       const repoDir = localRepoPath();
-      const archivePath = path.join(tmpDir, 'graphql-local.tgz');
+      const archivePath = tmpDirPath('graphql-local.tgz');
       fs.renameSync(buildNPMArchive(repoDir), archivePath);
       return archivePath;
     }
 
     // Returns the complete git hash for a given git revision reference.
     const hash = git(['rev-parse', revision]);
 
-    const archivePath = path.join(tmpDir, `graphql-${hash}.tgz`);
+    const archivePath = tmpDirPath(`graphql-${hash}.tgz`);
     if (fs.existsSync(archivePath)) {
       return archivePath;
     }
 
-    const repoDir = path.join(tmpDir, hash);
+    const repoDir = tmpDirPath(hash);
     fs.rmSync(repoDir, { recursive: true, force: true });
     fs.mkdirSync(repoDir);
     git(['clone', '--quiet', localRepoPath(), repoDir]);

resources/build-docusaurus.ts

@@ -3,14 +3,10 @@
 // Should be just: `docusaurus build --out-dir ./websiteDist ./website`
 
 import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
 
-import { localRepoPath, npm, readPackageJSON } from './utils.js';
+import { localRepoPath, makeTmpDir, npm, readPackageJSON } from './utils.js';
 
-const tmpDir = path.join(os.tmpdir(), 'graphql-run-docusaurus');
-fs.rmSync(tmpDir, { recursive: true, force: true });
-fs.mkdirSync(tmpDir);
+const { tmpDirPath } = makeTmpDir('graphql-js-run-docusaurus');
 
 const packageJSON = readPackageJSON();
 delete packageJSON.type;
@@ -21,7 +17,7 @@ copyToTmpDir('tsconfig.json');
 copyToTmpDir('src');
 copyToTmpDir('website');
 
-npm(['install', 'ci'], { cwd: tmpDir });
+npm(['install', 'ci'], { cwd: tmpDirPath() });
 
 const env = {
   ...process.env,
@@ -33,14 +29,13 @@ const docusaurusArgs = [
   localRepoPath('websiteDist'),
   tmpDirPath('website'),
 ];
-npm(['exec', 'docusaurus', '--', ...docusaurusArgs], { env, cwd: tmpDir });
+npm(['exec', 'docusaurus', '--', ...docusaurusArgs], {
+  env,
+  cwd: tmpDirPath(),
+});
 
 function copyToTmpDir(relativePath: string) {
   fs.cpSync(localRepoPath(relativePath), tmpDirPath(relativePath), {
     recursive: true,
   });
 }
-
-function tmpDirPath(...paths: ReadonlyArray<string>): string {
-  return path.join(tmpDir, ...paths);
-}

resources/diff-npm-package.ts

@@ -1,15 +1,18 @@
 import assert from 'node:assert';
 import childProcess from 'node:child_process';
 import fs from 'node:fs';
-import os from 'node:os';
 import path from 'node:path';
 
-import { git, localRepoPath, npm, writeGeneratedFile } from './utils.js';
+import {
+  git,
+  localRepoPath,
+  makeTmpDir,
+  npm,
+  writeGeneratedFile,
+} from './utils.js';
 
 const LOCAL = 'local';
-const tmpDir = path.join(os.tmpdir(), 'graphql-js-npm-diff');
-fs.rmSync(tmpDir, { recursive: true, force: true });
-fs.mkdirSync(tmpDir);
+const { tmpDirPath } = makeTmpDir('graphql-js-npm-diff');
 
 const args = process.argv.slice(2);
 let [fromRevision, toRevision] = args;
@@ -87,7 +90,7 @@ function prepareNPMPackage(revision: string): string {
   const hash = git(['rev-parse', revision]);
   assert(hash != null);
 
-  const repoDir = path.join(tmpDir, hash);
+  const repoDir = tmpDirPath(hash);
   fs.rmSync(repoDir, { recursive: true, force: true });
   fs.mkdirSync(repoDir);
   childProcess.execSync(`git archive "${hash}" | tar -xC "${repoDir}"`);

resources/integration-test.ts

@@ -1,38 +1,30 @@
 import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
 
 import { describe, it } from 'mocha';
 
-import { localRepoPath, npm } from './utils.js';
+import { localRepoPath, makeTmpDir, npm, readPackageJSON } from './utils.js';
 
 describe('Integration Tests', () => {
-  const tmpDir = path.join(os.tmpdir(), 'graphql-js-integrationTmp');
-  fs.rmSync(tmpDir, { recursive: true, force: true });
-  fs.mkdirSync(tmpDir);
+  const { tmpDirPath } = makeTmpDir('graphql-js-integrationTmp');
+  fs.cpSync(localRepoPath('integrationTests'), tmpDirPath(), {
+    recursive: true,
+  });
 
+  npm(['run', 'build:npm']);
   const distDir = localRepoPath('npmDist');
-  const archiveName = npm(['--quiet', 'pack', distDir], { cwd: tmpDir });
-  fs.renameSync(
-    path.join(tmpDir, archiveName),
-    path.join(tmpDir, 'graphql.tgz'),
-  );
+  const archiveName = npm(['--quiet', 'pack', distDir], { cwd: tmpDirPath() });
+  fs.renameSync(tmpDirPath(archiveName), tmpDirPath('graphql.tgz'));
 
-  function testOnNodeProject(projectName: string) {
-    const projectPath = localRepoPath('integrationTests', projectName);
+  npm(['run', 'build:deno']);
 
-    const packageJSONPath = path.join(projectPath, 'package.json');
-    const packageJSON = JSON.parse(fs.readFileSync(packageJSONPath, 'utf-8'));
+  function testOnNodeProject(projectName: string) {
+    const projectPath = tmpDirPath(projectName);
+    const packageJSON = readPackageJSON(projectPath);
 
     it(packageJSON.description, () => {
-      fs.cpSync(projectPath, path.join(tmpDir, projectName), {
-        recursive: true,
-      });
-
-      const cwd = path.join(tmpDir, projectName);
       // TODO: figure out a way to run it with --ignore-scripts
-      npm(['--quiet', 'install'], { cwd });
-      npm(['--quiet', 'test'], { cwd });
+      npm(['--quiet', 'install'], { cwd: projectPath });
+      npm(['--quiet', 'test'], { cwd: projectPath });
     }).timeout(120000);
   }
 

resources/utils.ts

@@ -1,6 +1,7 @@
 import assert from 'node:assert';
 import childProcess from 'node:child_process';
 import fs from 'node:fs';
+import os from 'node:os';
 import path from 'node:path';
 
 import prettier from 'prettier';
@@ -10,6 +11,20 @@ export function localRepoPath(...paths: ReadonlyArray<string>): string {
   return path.join(repoDir, ...paths);
 }
 
+interface MakeTmpDirReturn {
+  tmpDirPath: (...paths: ReadonlyArray<string>) => string;
+}
+
+export function makeTmpDir(name: string): MakeTmpDirReturn {
+  const tmpDir = path.join(os.tmpdir(), name);
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+  fs.mkdirSync(tmpDir);
+
+  return {
+    tmpDirPath: (...paths) => path.join(tmpDir, ...paths),
+  };
+}
+
 export function npm(
   args: ReadonlyArray<string>,
   options?: SpawnOptions,
@@ -133,6 +148,7 @@ export function writeGeneratedFile(filepath: string, body: string): void {
 }
 
 interface PackageJSON {
+  description: string;
   version: string;
   private?: boolean;
   repository?: { url?: string };
@@ -145,6 +161,9 @@ interface PackageJSON {
   publishConfig?: { tag?: string };
 }
 
-export function readPackageJSON(): PackageJSON {
-  return JSON.parse(fs.readFileSync(localRepoPath('package.json'), 'utf-8'));
+export function readPackageJSON(
+  dirPath: string = localRepoPath(),
+): PackageJSON {
+  const filepath = path.join(dirPath, 'package.json');
+  return JSON.parse(fs.readFileSync(filepath, 'utf-8'));
 }