resources: replace execSync with spawnSync (#3704)

graphql · Aug 21, 2022 · 52bcc32 · 52bcc32
1 parent 9a494d9
commit 52bcc32
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 30 deletions.
diff --git a/integrationTests/integration-test.ts b/integrationTests/integration-test.ts
@@ -5,12 +5,14 @@ import * as path from 'node:path';
 
 import { describe, it } from 'mocha';
 
-function exec(command: string, options = {}) {
-  const output = childProcess.execSync(command, {
+function npm(args: ReadonlyArray<string>, options = {}): string {
+  const result = childProcess.spawnSync('npm', [...args], {
+    maxBuffer: 10 * 1024 * 1024, // 10MB
+    stdio: ['inherit', 'pipe', 'inherit'],
     encoding: 'utf-8',
     ...options,
   });
-  return output?.trimEnd();
+  return result.stdout.toString().trimEnd();
 }
 
 describe('Integration Tests', () => {
@@ -19,7 +21,7 @@ describe('Integration Tests', () => {
   fs.mkdirSync(tmpDir);
 
   const distDir = path.resolve('./npmDist');
-  const archiveName = exec(`npm --quiet pack ${distDir}`, { cwd: tmpDir });
+  const archiveName = npm(['--quiet', 'pack', distDir], { cwd: tmpDir });
   fs.renameSync(
     path.join(tmpDir, archiveName),
     path.join(tmpDir, 'graphql.tgz'),
@@ -38,8 +40,8 @@ describe('Integration Tests', () => {
 
       const cwd = path.join(tmpDir, projectName);
       // TODO: figure out a way to run it with --ignore-scripts
-      exec('npm --quiet install', { cwd, stdio: 'inherit' });
-      exec('npm --quiet test', { cwd, stdio: 'inherit' });
+      npm(['--quiet', 'install'], { cwd });
+      npm(['--quiet', 'test'], { cwd });
     }).timeout(120000);
   }
 

diff --git a/resources/benchmark.ts b/resources/benchmark.ts
@@ -5,7 +5,7 @@ import * as os from 'node:os';
 import * as path from 'node:path';
 import * as url from 'node:url';
 
-import { exec, localRepoPath } from './utils';
+import { git, localRepoPath, npm } from './utils';
 
 const NS_PER_SEC = 1e9;
 const LOCAL = 'local';
@@ -63,7 +63,7 @@ function prepareBenchmarkProjects(
       path.join(projectPath, 'package.json'),
       JSON.stringify(packageJSON, null, 2),
     );
-    exec('npm --quiet install --ignore-scripts ', { cwd: projectPath });
+    npm(['--quiet', 'install', '--ignore-scripts'], { cwd: projectPath });
 
     return { revision, projectPath };
   });
@@ -77,7 +77,7 @@ function prepareBenchmarkProjects(
     }
 
     // Returns the complete git hash for a given git revision reference.
-    const hash = exec(`git rev-parse "${revision}"`);
+    const hash = git(['rev-parse', revision]);
 
     const archivePath = path.join(tmpDir, `graphql-${hash}.tgz`);
     if (fs.existsSync(archivePath)) {
@@ -87,19 +87,19 @@ function prepareBenchmarkProjects(
     const repoDir = path.join(tmpDir, hash);
     fs.rmSync(repoDir, { recursive: true, force: true });
     fs.mkdirSync(repoDir);
-    exec(`git clone --quiet "${localRepoPath()}" "${repoDir}"`);
-    exec(`git checkout --quiet --detach "${hash}"`, { cwd: repoDir });
-    exec('npm --quiet ci --ignore-scripts', { cwd: repoDir });
+    git(['clone', '--quiet', localRepoPath(), repoDir]);
+    git(['checkout', '--quiet', '--detach', hash], { cwd: repoDir });
+    npm(['--quiet', 'ci', '--ignore-scripts'], { cwd: repoDir });
     fs.renameSync(buildNPMArchive(repoDir), archivePath);
     fs.rmSync(repoDir, { recursive: true });
     return archivePath;
   }
 
   function buildNPMArchive(repoDir: string) {
-    exec('npm --quiet run build:npm', { cwd: repoDir });
+    npm(['--quiet', 'run', 'build:npm'], { cwd: repoDir });
 
     const distDir = path.join(repoDir, 'npmDist');
-    const archiveName = exec(`npm --quiet pack ${distDir}`, {
+    const archiveName = npm(['--quiet', 'pack', distDir], {
       cwd: repoDir,
     });
     return path.join(repoDir, archiveName);

diff --git a/resources/diff-npm-package.ts b/resources/diff-npm-package.ts
@@ -1,9 +1,10 @@
 import * as assert from 'node:assert';
+import * as childProcess from 'node:child_process';
 import * as fs from 'node:fs';
 import * as os from 'node:os';
 import * as path from 'node:path';
 
-import { exec, localRepoPath, writeGeneratedFile } from './utils';
+import { git, localRepoPath, npm, writeGeneratedFile } from './utils';
 
 const LOCAL = 'local';
 const tmpDir = path.join(os.tmpdir(), 'graphql-js-npm-diff');
@@ -27,7 +28,7 @@ console.log(`📦 Building NPM package for ${toRevision}...`);
 const toPackage = prepareNPMPackage(toRevision);
 
 console.log('➖➕ Generating diff...');
-const diff = exec(`npm diff --diff=${fromPackage} --diff=${toPackage}`);
+const diff = npm(['diff', '--diff', fromPackage, '--diff', toPackage]);
 
 if (diff === '') {
   console.log('No changes found!');
@@ -78,19 +79,19 @@ function generateReport(diffString: string): string {
 
 function prepareNPMPackage(revision: string): string {
   if (revision === LOCAL) {
-    exec('npm --quiet run build:npm', { cwd: localRepoPath() });
+    npm(['--quiet', 'run', 'build:npm'], { cwd: localRepoPath() });
     return localRepoPath('npmDist');
   }
 
   // Returns the complete git hash for a given git revision reference.
-  const hash = exec(`git rev-parse "${revision}"`);
+  const hash = git(['rev-parse', revision]);
   assert(hash != null);
 
   const repoDir = path.join(tmpDir, hash);
   fs.rmSync(repoDir, { recursive: true, force: true });
   fs.mkdirSync(repoDir);
-  exec(`git archive "${hash}" | tar -xC "${repoDir}"`);
-  exec('npm --quiet ci --ignore-scripts', { cwd: repoDir });
-  exec('npm --quiet run build:npm', { cwd: repoDir });
+  childProcess.execSync(`git archive "${hash}" | tar -xC "${repoDir}"`);
+  npm(['--quiet', 'ci', '--ignore-scripts'], { cwd: repoDir });
+  npm(['--quiet', 'run', 'build:npm'], { cwd: repoDir });
   return path.join(repoDir, 'npmDist');
 }
diff --git a/resources/gen-changelog.ts b/resources/gen-changelog.ts
@@ -1,4 +1,4 @@
-import { exec, readPackageJSON } from './utils';
+import { git, readPackageJSON } from './utils';
 
 const packageJSON = readPackageJSON();
 const labelsConfig: { [label: string]: { section: string; fold?: boolean } } = {
@@ -64,15 +64,15 @@ function getChangeLog(): Promise<string> {
   const { version } = packageJSON;
 
   let tag: string | null = null;
-  let commitsList = exec(`git rev-list --reverse v${version}..`);
+  let commitsList = git(['rev-list', '--reverse', `v${version}..`]);
   if (commitsList === '') {
-    const parentPackageJSON = exec('git cat-file blob HEAD~1:package.json');
+    const parentPackageJSON = git(['cat-file', 'blob', 'HEAD~1:package.json']);
     const parentVersion = JSON.parse(parentPackageJSON).version;
-    commitsList = exec(`git rev-list --reverse v${parentVersion}..HEAD~1`);
+    commitsList = git(['rev-list', '--reverse', `v${parentVersion}..HEAD~1`]);
     tag = `v${version}`;
   }
 
-  const date = exec('git log -1 --format=%cd --date=short');
+  const date = git(['log', '-1', '--format=%cd', '--date=short']);
   return getCommitsInfo(commitsList.split('\n'))
     .then((commitsInfo) => getPRsInfo(commitsInfoToPRs(commitsInfo)))
     .then((prsInfo) => genChangeLog(tag, date, prsInfo));

diff --git a/resources/utils.ts b/resources/utils.ts
@@ -9,15 +9,36 @@ export function localRepoPath(...paths: ReadonlyArray<string>): string {
   return path.join(__dirname, '..', ...paths);
 }
 
-type ExecOptions = Parameters<typeof childProcess.execSync>[1];
-export function exec(command: string, options?: ExecOptions): string {
-  const output = childProcess.execSync(command, {
+export function npm(
+  args: ReadonlyArray<string>,
+  options?: SpawnOptions,
+): string {
+  return spawn('npm', args, options);
+}
+
+export function git(
+  args: ReadonlyArray<string>,
+  options?: SpawnOptions,
+): string {
+  return spawn('git', args, options);
+}
+
+interface SpawnOptions {
+  cwd?: string;
+}
+
+function spawn(
+  command: string,
+  args: ReadonlyArray<string>,
+  options?: SpawnOptions,
+): string {
+  const result = childProcess.spawnSync(command, args, {
     maxBuffer: 10 * 1024 * 1024, // 10MB
     stdio: ['inherit', 'pipe', 'inherit'],
     encoding: 'utf-8',
     ...options,
   });
-  return output.toString().trimEnd();
+  return result.stdout.toString().trimEnd();
 }
 
 export function readdirRecursive(