Add MVP of mocha-like benchmark tests

Based on graphql#1163 by @mohawk2

Author: IvanGoncharov

.flowconfig

@@ -3,6 +3,7 @@
 .*/dist/.*
 .*/coverage/.*
 .*/resources/.*
+.*/benchmark/.*
 
 [include]
 

.gitignore

@@ -9,3 +9,4 @@ node_modules
 coverage
 dist
 npm
+benchmark

.npmignore

@@ -17,3 +17,4 @@ resources
 src
 dist
 npm
+benchmark

package.json

@@ -29,6 +29,7 @@
     "prettier": "prettier --write 'src/**/*.js'",
     "check": "flow check",
     "check-cover": "for file in {src/*.js,src/**/*.js}; do echo $file; flow coverage $file; done",
+    "benchmark": "node resources/benchmark.js",
     "build": "npm run build:clean && npm run build:npm && npm run build:npm-flow && npm run build:module && npm run build:module-flow && npm run build:package-json",
     "build:clean": "rm -rf ./dist",
     "build:package-json": "node ./resources/copy-package-json.js",
@@ -56,10 +57,13 @@
     "babel-plugin-transform-flow-strip-types": "6.22.0",
     "babel-plugin-transform-object-rest-spread": "6.23.0",
     "babel-preset-env": "^1.5.2",
+    "beautify-benchmark": "^0.2.4",
+    "benchmark": "^2.1.4",
     "chai": "4.1.1",
     "chai-json-equal": "0.0.1",
     "chai-spies-next": "^0.8.0",
     "chai-subset": "1.5.0",
+    "chalk": "^2.3.0",
     "coveralls": "2.13.1",
     "eslint": "4.4.1",
     "eslint-plugin-babel": "4.1.2",
@@ -69,6 +73,7 @@
     "isparta": "4.0.0",
     "mocha": "3.5.0",
     "prettier": "^1.9.2",
-    "sane": "2.0.0"
+    "sane": "2.0.0",
+    "shelljs": "^0.7.8"
   }
 }

resources/benchmark.js

@@ -0,0 +1,96 @@
+const benchmark = require('benchmark');
+const beautifyBenchmark = require('beautify-benchmark');
+const sh = require('shelljs');
+const chalk = require('chalk');
+const pathJoin = require('path').join;
+
+const args = process.argv.slice(2);
+args[0] = args[0] || 'HEAD';
+args[1] = args[1] || 'local';
+
+console.log('Benchmarking revisions: ' + args.join(', '));
+
+const localDistDir = './benchmark/local';
+sh.rm('-rf', localDistDir);
+console.log(`Building local dist: ${localDistDir}`);
+sh.mkdir('-p', localDistDir);
+exec(`babel src --optional runtime --copy-files --out-dir ${localDistDir}`);
+
+const revisions = {};
+for (const arg of args) {
+  revisions[arg] = reqireFromCWD(buildRevisionDist(arg));
+}
+
+global.suite = suite;
+const testFiles = sh.ls(`${localDistDir}/**/__tests__/**/*-benchmark.js`);
+for (const file of testFiles) {
+  reqireFromCWD(file);
+}
+
+function reqireFromCWD(path) {
+  return require(pathJoin(process.cwd(), path))
+}
+
+function suite(name, fn) {
+  console.log(chalk.green(name) + '\n');
+
+  const measures = {};
+  for (const [revision, graphql] of Object.entries(revisions)) {
+    currentRevision = revision;
+    global.measure = (name, fn) => {
+      measures[name] = measures[name] || new benchmark.Suite();
+      measures[name].add(revision, fn);
+    };
+    try {
+      fn(graphql);
+    } catch (e) {
+      console.error(e.stack);
+    }
+  }
+  global.measure = undefined;
+
+  for (const [name, suite] of Object.entries(measures)) {
+    console.log('  ⏱️ ', name);
+    suite
+      .on('cycle', function(event) {
+        beautifyBenchmark.add(event.target);
+      })
+      .on('complete', function() {
+        beautifyBenchmark.log();
+      })
+      .run();
+  }
+}
+
+function exec(command) {
+  const {code, stdout, stderr} = sh.exec(command, {silent: true});
+  if (code !== 0) {
+    console.error(stdout);
+    console.error(stderr);
+    sh.exit(code);
+  }
+  return stdout.trim();
+}
+
+function buildRevisionDist(revision) {
+  if (revision === 'local') {
+    return localDistDir;
+  }
+
+  const hash = exec(`git log -1 --format=%h "${revision}"`);
+  const buildDir = './benchmark/' + hash;
+  const distDir = buildDir + '/dist'
+
+  if (sh.test('-d', buildDir)) {
+    return distDir;
+  }
+  console.log(`Building "${revision}"(${hash}) revision: ${buildDir}`);
+  sh.mkdir('-p', buildDir);
+  exec(`git archive "${hash}" | tar -xC "${buildDir}"`);
+
+  const pwd = sh.pwd();
+  sh.cd(buildDir);
+  exec('yarn && npm run build');
+  sh.cd(pwd);
+  return buildDir + '/dist';
+}

src/language/__tests__/parser-benchmark.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import { getIntrospectionQuery } from '../../utilities/introspectionQuery';
+/* global suite, measure */
+
+suite('Parse string to AST', graphql => {
+  const kitchenSink = readFileSync(join(__dirname, './kitchen-sink.graphql'), {
+    encoding: 'utf8',
+  });
+  measure('Kitchen Sink', () => graphql.parse(kitchenSink));
+
+  const introspectionQuery = getIntrospectionQuery();
+  measure('Introspection Query', () => graphql.parse(introspectionQuery));
+});

src/language/__tests__/printer-benchmark.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import { readFileSync } from 'fs';
+import { join } from 'path';
+import { getIntrospectionQuery } from '../../utilities/introspectionQuery';
+/* global suite, measure */
+
+suite('Print AST', graphql => {
+  const kitchenSink = readFileSync(join(__dirname, './kitchen-sink.graphql'), {
+    encoding: 'utf8',
+  });
+  const kitchenSinkAST = graphql.parse(kitchenSink);
+  measure('Kitchen Sink', () => graphql.print(kitchenSinkAST));
+
+  const introspectionQueryAST = graphql.parse(getIntrospectionQuery());
+  measure('Introspection Query', () => graphql.print(introspectionQueryAST));
+});

yarn.lock

@@ -715,6 +715,17 @@ bcrypt-pbkdf@^1.0.0:
   dependencies:
     tweetnacl "^0.14.3"
 
+beautify-benchmark@^0.2.4:
+  version "0.2.4"
+  resolved "https://registry.yarnpkg.com/beautify-benchmark/-/beautify-benchmark-0.2.4.tgz#3151def14c1a2e0d07ff2e476861c7ed0e1ae39b"
+
+benchmark@^2.1.4:
+  version "2.1.4"
+  resolved "https://registry.yarnpkg.com/benchmark/-/benchmark-2.1.4.tgz#09f3de31c916425d498cc2ee565a0ebf3c2a5629"
+  dependencies:
+    lodash "^4.17.4"
+    platform "^1.3.3"
+
 binary-extensions@^1.0.0:
   version "1.11.0"
   resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-1.11.0.tgz#46aa1751fb6a2f93ee5e689bb1087d4b14c6c205"
@@ -829,7 +840,7 @@ chalk@^1.1.1, chalk@^1.1.3:
     strip-ansi "^3.0.0"
     supports-color "^2.0.0"
 
-chalk@^2.0.0, chalk@^2.1.0:
+chalk@^2.0.0, chalk@^2.1.0, chalk@^2.3.0:
   version "2.3.0"
   resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.3.0.tgz#b5ea48efc9c1793dccc9b4767c93914d3f2d52ba"
   dependencies:
@@ -1592,6 +1603,10 @@ inquirer@^3.0.6:
     strip-ansi "^4.0.0"
     through "^2.3.6"
 
+interpret@^1.0.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.1.0.tgz#7ed1b1410c6a0e0f78cf95d3b8440c63f78b8614"
+
 invariant@^2.2.2:
   version "2.2.2"
   resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.2.tgz#9e1f56ac0acdb6bf303306f338be3b204ae60360"
@@ -2184,6 +2199,10 @@ path-is-inside@^1.0.1, path-is-inside@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/path-is-inside/-/path-is-inside-1.0.2.tgz#365417dede44430d1c11af61027facf074bdfc53"
 
+path-parse@^1.0.5:
+  version "1.0.5"
+  resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.5.tgz#3c1adf871ea9cd6c9431b6ea2bd74a0ff055c4c1"
+
 pathval@^1.0.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/pathval/-/pathval-1.1.0.tgz#b942e6d4bde653005ef6b71361def8727d0645e0"
@@ -2206,6 +2225,10 @@ pinkie@^2.0.0:
   version "2.0.4"
   resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870"
 
+platform@^1.3.3:
+  version "1.3.4"
+  resolved "https://registry.yarnpkg.com/platform/-/platform-1.3.4.tgz#6f0fb17edaaa48f21442b3a975c063130f1c3ebd"
+
 pluralize@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-4.0.0.tgz#59b708c1c0190a2f692f1c7618c446b052fd1762"
@@ -2287,6 +2310,12 @@ readdirp@^2.0.0:
     readable-stream "^2.0.2"
     set-immediate-shim "^1.0.1"
 
+rechoir@^0.6.2:
+  version "0.6.2"
+  resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384"
+  dependencies:
+    resolve "^1.1.6"
+
 regenerate@^1.2.1:
   version "1.3.3"
   resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.3.3.tgz#0c336d3980553d755c39b586ae3b20aa49c82b7f"
@@ -2416,6 +2445,12 @@ [email protected]:
   version "1.1.7"
   resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b"
 
+resolve@^1.1.6:
+  version "1.5.0"
+  resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.5.0.tgz#1f09acce796c9a762579f31b2c1cc4c3cddf9f36"
+  dependencies:
+    path-parse "^1.0.5"
+
 restore-cursor@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-2.0.0.tgz#9f7ee287f82fd326d4fd162923d62129eee0dfaf"
@@ -2491,6 +2526,14 @@ shebang-regex@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3"
 
+shelljs@^0.7.8:
+  version "0.7.8"
+  resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.7.8.tgz#decbcf874b0d1e5fb72e14b164a9683048e9acb3"
+  dependencies:
+    glob "^7.0.0"
+    interpret "^1.0.0"
+    rechoir "^0.6.2"
+
 signal-exit@^3.0.0, signal-exit@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.2.tgz#b5fdc08f1287ea1178628e415e25132b73646c6d"