Add MVP of mocha-like benchmark tests

Based on #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,19 +57,24 @@
     "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",
     "eslint-plugin-flowtype": "2.35.0",
     "eslint-plugin-prettier": "^2.3.1",
     "flow-bin": "0.61.0",
     "isparta": "4.0.0",
+    "microtime": "^2.1.7",
     "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,112 @@
+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) {
+  const distPath = buildRevisionDist(arg);
+  const distRequire = (path) => reqireFromCWD(pathJoin(distPath, path));
+  revisions[arg] = distRequire;
+}
+
+const suites = {};
+global.suite = suite;
+const testFiles = sh.ls(`${localDistDir}/**/__tests__/**/*-benchmark.js`);
+for (const file of testFiles) {
+  reqireFromCWD(file);
+}
+
+dummyRun();
+for (const [name, measures] of Object.entries(suites)) {
+  console.log(chalk.green(name) + '\n');
+  benchmark.invoke(measures, 'run');
+}
+
+function reqireFromCWD(path) {
+  return require(pathJoin(process.cwd(), path))
+}
+
+function dummyRun() {
+  benchmark.Suite()
+    .add('dummy', () => { Math.pow(2, 256); })
+    .run();
+}
+
+function newMeasurement(name) {
+  return new benchmark.Suite(name, {
+    onStart(event) {
+      console.log('  ⏱️ ', event.currentTarget.name);
+    },
+    onCycle(event) {
+      beautifyBenchmark.add(event.target);
+    },
+    onComplete() {
+      beautifyBenchmark.log();
+    },
+  });
+}
+
+function suite(name, fn) {
+  const measures = {};
+  for (const [revision, distRequire] of Object.entries(revisions)) {
+    currentRevision = revision;
+    global.measure = (name, fn) => {
+      measures[name] = measures[name] || newMeasurement(name);
+      measures[name].add(revision, fn);
+    };
+    try {
+      fn(distRequire);
+    } catch (e) {
+      console.error(e.stack);
+    }
+  }
+  global.measure = undefined;
+  suites[name] = Object.values(measures);
+}
+
+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__/lexer-benchmark.js

@@ -0,0 +1,38 @@
+/**
+ * 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('Run lexer on a string', distRequire => {
+  const { Source } = distRequire('language/source');
+  const { createLexer } = distRequire('language/lexer');
+
+  function runLexer(source) {
+    try {
+      const lexer = createLexer(source);
+      let token;
+      do {
+        token = lexer.advance();
+      } while (token.kind !== '<EOF>');
+    } catch (e) {
+      console.error(e.stack);
+    }
+  }
+
+  const kitchenSinkPath = join(__dirname, './kitchen-sink.graphql');
+  const kitchenSink = new Source(
+    readFileSync(kitchenSinkPath, { encoding: 'utf8' }),
+  );
+
+  measure('Kitchen Sink', () => runLexer(kitchenSink));
+
+  const introspectionQuery = new Source(getIntrospectionQuery());
+  measure('Introspection Query', () => runLexer(introspectionQuery));
+});

src/language/__tests__/parser-benchmark.js

@@ -0,0 +1,24 @@
+/**
+ * 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', distRequire => {
+  const { parse } = distRequire('language/parser');
+
+  const kitchenSink = readFileSync(join(__dirname, './kitchen-sink.graphql'), {
+    encoding: 'utf8',
+  });
+
+  measure('Kitchen Sink', () => parse(kitchenSink));
+
+  const introspectionQuery = getIntrospectionQuery();
+  measure('Introspection Query', () => parse(introspectionQuery));
+});

src/language/__tests__/printer-benchmark.js

@@ -0,0 +1,25 @@
+/**
+ * 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', distRequire => {
+  const { print } = distRequire('language/printer');
+  const { parse } = distRequire('language/parser');
+
+  const kitchenSink = readFileSync(join(__dirname, './kitchen-sink.graphql'), {
+    encoding: 'utf8',
+  });
+  const kitchenSinkAST = parse(kitchenSink);
+  measure('Kitchen Sink', () => print(kitchenSinkAST));
+
+  const introspectionQueryAST = parse(getIntrospectionQuery());
+  measure('Introspection Query', () => print(introspectionQueryAST));
+});