From 1698fc96af2d58dce414cd22b7d9898f30efde3e Mon Sep 17 00:00:00 2001
From: Joyee Cheung <joyeec9h3@gmail.com>
Date: Wed, 7 Nov 2018 04:28:50 +0800
Subject: [PATCH] benchmark: support more options in startup benchmark

1. Add options to benchmark the startup performance of a node
  "instance" after running a script. By default there are two options:
  `test/fixtures/semicolon` which is basically an empty file,
  and `benchmark/fixtures/require-cachable` which require all
  the cachable modules before exiting. This allows us to measure
  the overhead of bootstrap in more scenarios.
2. Add options to benchmark the overhead of spinning
  node through a process and through a worker.

PR-URL: https://github.com/nodejs/node/pull/24220
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
---
 benchmark/fixtures/require-cachable.js | 13 ++++
 benchmark/misc/startup.js              | 88 +++++++++++++++++++-------
 test/parallel/test-benchmark-misc.js   |  2 +
 3 files changed, 79 insertions(+), 24 deletions(-)
 create mode 100644 benchmark/fixtures/require-cachable.js

diff --git a/benchmark/fixtures/require-cachable.js b/benchmark/fixtures/require-cachable.js
new file mode 100644
index 00000000000000..f651728dc78f35
--- /dev/null
+++ b/benchmark/fixtures/require-cachable.js
@@ -0,0 +1,13 @@
+'use strict';
+
+const list = require('internal/bootstrap/cache');
+const {
+  isMainThread
+} = require('worker_threads');
+
+for (const key of list.cachableBuiltins) {
+  if (!isMainThread && key === 'trace_events') {
+    continue;
+  }
+  require(key);
+}
diff --git a/benchmark/misc/startup.js b/benchmark/misc/startup.js
index 703146f081b3c6..1350cd291e2b18 100644
--- a/benchmark/misc/startup.js
+++ b/benchmark/misc/startup.js
@@ -1,36 +1,76 @@
 'use strict';
 const common = require('../common.js');
-const spawn = require('child_process').spawn;
+const { spawn } = require('child_process');
 const path = require('path');
-const emptyJsFile = path.resolve(__dirname, '../../test/fixtures/semicolon.js');
 
-const bench = common.createBenchmark(startNode, {
-  dur: [1]
+let Worker;  // Lazy loaded in main
+
+const bench = common.createBenchmark(main, {
+  dur: [1],
+  script: ['benchmark/fixtures/require-cachable', 'test/fixtures/semicolon'],
+  mode: ['process', 'worker']
+}, {
+  flags: ['--expose-internals', '--experimental-worker']  // for workers
 });
 
-function startNode({ dur }) {
-  var go = true;
-  var starts = 0;
+function spawnProcess(script) {
+  const cmd = process.execPath || process.argv[0];
+  const argv = ['--expose-internals', script];
+  return spawn(cmd, argv);
+}
+
+function spawnWorker(script) {
+  return new Worker(script, { stderr: true, stdout: true });
+}
+
+function start(state, script, bench, getNode) {
+  const node = getNode(script);
+  let stdout = '';
+  let stderr = '';
+
+  node.stdout.on('data', (data) => {
+    stdout += data;
+  });
+
+  node.stderr.on('data', (data) => {
+    stderr += data;
+  });
+
+  node.on('exit', (code) => {
+    if (code !== 0) {
+      console.error('------ stdout ------');
+      console.error(stdout);
+      console.error('------ stderr ------');
+      console.error(stderr);
+      throw new Error(`Error during node startup, exit code ${code}`);
+    }
+    state.throughput++;
+
+    if (state.go) {
+      start(state, script, bench, getNode);
+    } else {
+      bench.end(state.throughput);
+    }
+  });
+}
+
+function main({ dur, script, mode }) {
+  const state = {
+    go: true,
+    throughput: 0
+  };
 
   setTimeout(function() {
-    go = false;
+    state.go = false;
   }, dur * 1000);
 
-  bench.start();
-  start();
-
-  function start() {
-    const node = spawn(process.execPath || process.argv[0], [emptyJsFile]);
-    node.on('exit', function(exitCode) {
-      if (exitCode !== 0) {
-        throw new Error('Error during node startup');
-      }
-      starts++;
-
-      if (go)
-        start();
-      else
-        bench.end(starts);
-    });
+  script = path.resolve(__dirname, '../../', `${script}.js`);
+  if (mode === 'worker') {
+    Worker = require('worker_threads').Worker;
+    bench.start();
+    start(state, script, bench, spawnWorker);
+  } else {
+    bench.start();
+    start(state, script, bench, spawnProcess);
   }
 }
diff --git a/test/parallel/test-benchmark-misc.js b/test/parallel/test-benchmark-misc.js
index fc7e340a80d0bb..b88415280833bc 100644
--- a/test/parallel/test-benchmark-misc.js
+++ b/test/parallel/test-benchmark-misc.js
@@ -11,4 +11,6 @@ runBenchmark('misc', [
   'n=1',
   'type=',
   'val=magyarország.icom.museum',
+  'script=test/fixtures/semicolon',
+  'mode=worker'
 ], { NODEJS_BENCHMARK_ZERO_ALLOWED: 1 });