Update benchmark testing script

Author: leeyi45

package.json

@@ -57,7 +57,7 @@
     "autocomplete": "node ./scripts/docs.mjs autocomplete",
     "build_sicp_package": "yarn build && node ./scripts/build_sicp_package.mjs",
     "publish_sicp_package": "./scripts/publish_sicp_package.sh",
-    "benchmark": "jest --runInBand --testPathPattern='.*benchmark.*' --testPathIgnorePatterns='/dist/'",
+    "benchmark": "node ./scripts/run_jest.mjs --runInBand --testPathPattern='.*benchmark.*' --testPathIgnorePatterns='/dist/'",
     "prepare": "husky install"
   },
   "devDependencies": {

scripts/docs.mjs

@@ -4,7 +4,7 @@ import { execFile, fork, spawn } from 'child_process'
 import pathlib from 'path'
 import fs from 'fs/promises'
 import process from 'process'
-import { Command } from 'commander'
+import { Command } from '@commander-js/extra-typings'
 import autocomplete from './autocomplete.mjs'
 
 const configs = {
@@ -164,7 +164,11 @@ const jsdoc = 'node_modules/jsdoc/jsdoc.js'
 const template_location = 'docs/jsdoc/templates/template'
 const specs_dir = 'docs/specs'
 
-async function run() {
+/**
+ * Build the documentations using JSDOC
+ * @param {boolean | undefined} silent 
+ */
+async function run(silent) {
   await fs.mkdir(out_dir, { recursive: true })
 
   const promises = Object.entries(configs).map(([name, config]) => {
@@ -183,11 +187,14 @@ async function run() {
       ...config.libs.map(each => pathlib.join(libraries, each))
     ])
 
-    proc.on('spawn', () => console.log(`Building ${name}`))
+    if (!silent) {
+      proc.on('spawn', () => console.log(`Building ${name}`))
+    }
+
     return new Promise(resolve => {
       proc.on('exit', c => {
         if (c === 0) {
-          console.log(`Finished ${name}`)
+          if (!silent) console.log(`Finished ${name}`)
         } else {
           console.error(`Error occurred with ${name}: jsdoc exited with code ${c}`)
         }
@@ -209,8 +216,12 @@ async function run() {
   if (nonzeroRetcode !== undefined) process.exit(nonzeroRetcode)
 }
 
-async function prepare({ silent }) {
-  await run()
+/**
+ * Runs JSDOC, then `make`
+ * @param {boolean | undefined} silent 
+ */
+async function prepare(silent) {
+  await run(silent)
 
   // Copy images in images directory to out_dir
   await fs.readdir('docs/images').then(images =>
@@ -219,7 +230,7 @@ async function prepare({ silent }) {
         const srcPath = pathlib.join('docs/images', img)
         const dstPath = pathlib.join(out_dir, img)
         await fs.copyFile(srcPath, dstPath)
-        console.debug(`Copied ${srcPath} to ${dstPath}`)
+        if (!silent) console.log(`Copied ${srcPath} to ${dstPath}`)
       })
     )
   )
@@ -238,7 +249,7 @@ async function prepare({ silent }) {
   })
 
   if (makeretcode !== 0) process.exit(makeretcode)
-  console.log('Finished running make')
+  if (!silent) console.log('Finished running make')
 
   // Copy pdf files that make produced to out_dir
   await fs.readdir(specs_dir).then(files =>
@@ -249,7 +260,7 @@ async function prepare({ silent }) {
           const srcPath = pathlib.join(specs_dir, file)
           const dstPath = pathlib.join(out_dir, file)
           await fs.copyFile(srcPath, dstPath)
-          console.debug(`Copied ${srcPath} to ${dstPath}`)
+          if (!silent) console.debug(`Copied ${srcPath} to ${dstPath}`)
         })
     )
   )
@@ -285,13 +296,16 @@ async function checkGitRoot() {
 
 await new Command()
   .hook('preAction', checkGitRoot)
-  .addCommand(new Command('run').description('Run JSDOC and build documentation').action(run), {
-    isDefault: true
-  })
+  .addCommand(
+    new Command('run')
+      .description('Run JSDOC and build documentation')
+      .option('--silent', 'Run without outputting to stdout')
+      .action(args => run(args.silent)), { isDefault: true }
+  )
   .addCommand(
     new Command('prepare')
       .option('--silent', 'Run make without outputting to stdout')
-      .action(prepare)
+      .action(args => prepare(args.silent))
   )
   .addCommand(new Command('clean').description('Clear the output directory').action(clean))
   .addCommand(
@@ -302,6 +316,7 @@ await new Command()
   .addCommand(
     new Command('docs')
       .description("Execute the 'run' command and then the 'autocomplete' command")
-      .action(() => run().then(autocomplete))
+      .option('--silent', 'Run without outputting to stdout')
+      .action(args => run(args.silent).then(autocomplete))
   )
   .parseAsync()

scripts/run_jest.mjs

@@ -13,7 +13,7 @@ await new Command()
     const newPatterns = patterns.map(pattern => pattern.split(pathlib.sep).join(pathlib.posix.sep))
 
     const proc = fork('node_modules/jest/bin/jest.js', [
-      ...Object.entries(args),
+      ...Object.entries(args).flat(),
       ...newPatterns
     ])
 

src/__tests__/stringify-benchmark.ts

@@ -2,38 +2,36 @@ import * as list from '../stdlib/list'
 import { Chapter } from '../types'
 import { stripIndent } from '../utils/formatters'
 import { stringify } from '../utils/stringify'
-import { testSuccess } from '../utils/testing'
+import { expectFinishedResult } from '../utils/testing'
 
 test('stringify is fast', () => {
-  return expect(
-    testSuccess(
-      stripIndent`
-        function make_k_list(k, d) {
-            const degree = k;
-            const depth = d;
-            let repeat = 0;
-            function helper(k, d, to_repeat) {
-                if (d === 0 && k === 0) {
-                    return null;
-                } else if (k === 0) {
-                    return helper(degree, d - 1, repeat);
-                } else {
-                    repeat = pair(to_repeat, helper(k - 1, d, to_repeat));
-                    return pair(to_repeat, helper(k - 1, d, to_repeat));
-                }
-            }
-            return helper(k, d, 0);
-        }
+  return expectFinishedResult(
+    stripIndent`
+      function make_k_list(k, d) {
+          const degree = k;
+          const depth = d;
+          let repeat = 0;
+          function helper(k, d, to_repeat) {
+              if (d === 0 && k === 0) {
+                  return null;
+              } else if (k === 0) {
+                  return helper(degree, d - 1, repeat);
+              } else {
+                  repeat = pair(to_repeat, helper(k - 1, d, to_repeat));
+                  return pair(to_repeat, helper(k - 1, d, to_repeat));
+              }
+          }
+          return helper(k, d, 0);
+      }
 
-        const bigstructure = make_k_list(2,2);
-        const start = get_time();
-        stringify(bigstructure);
-        const end = get_time();
-        end - start;
-        `,
-      { chapter: Chapter.SOURCE_3 }
-    ).then(testResult => testResult.result)
-  ).resolves.toBeLessThan(2000)
+      const bigstructure = make_k_list(2,2);
+      const start = get_time();
+      stringify(bigstructure);
+      const end = get_time();
+      end - start;
+      `,
+    Chapter.SOURCE_3
+  ).toBeLessThan(2000)
   // This benchmark takes 100ms on my machine,
   // but less than 2 seconds should be good enough on the test servers.
 })
@@ -47,9 +45,8 @@ test('display_list with stringify is linear runtime', () => {
     return stringify(list.rawDisplayList((x: any) => x, v, s === placeholder ? undefined : s))
   }
 
-  return expect(
-    testSuccess(
-      stripIndent`
+  return expectFinishedResult(
+    stripIndent`
       const build_inf = (i, f) => {
         const t = list(f(i));
         let p = t;
@@ -138,14 +135,13 @@ test('display_list with stringify is linear runtime', () => {
       const slope = head(line);
       slope;
     `,
-      {
-        chapter: Chapter.SOURCE_3,
-        testBuiltins: {
-          no_display_list: noDisplayList
-        }
+    {
+      chapter: Chapter.SOURCE_3,
+      testBuiltins: {
+        no_display_list: noDisplayList
       }
-    ).then(testResult => testResult.result)
-  ).resolves.toBeLessThan(1.2)
+    }
+  ).toBeLessThan(1.2)
   // estimated power is less than 1.2
   // means it's probably near 1
   // => probably linear?

src/utils/testing/index.ts

@@ -93,7 +93,8 @@ export function expectFinishedResult(code: string, options: TestOptions = {}) {
   return expect(
     testInContext(code, options).then(({ result, context }) => {
       if (result.status === 'error') {
-        console.log(context.errors)
+        const errStr = parseError(context.errors)
+        console.log(errStr)
       }
       assertIsFinished(result)
       return result.value