Add JSON reporter. Major refactoring of project file structure.

Author: HP Dietz

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.9.0
+* [#32: Add JSON reporter.](https://github.com/haensl/js-performance/issues/32)
+* Major refactoring of project file structure
+
 ### 1.8.0
 * [#10: Add profile for guards.](https://github.com/haensl/js-performance/issues/10)
 * Add command line option to specify result precision.

README.md

@@ -19,6 +19,19 @@ To run specific profiles simply supply their names separated by spaces when star
 
 ## CLI
 
+```bash
+Usage: node js-performance.js
+
+  -h, --help         Display this helptext.
+  -i, --iterations=  Specify the number of iterations per profiled function. Default: 1000.
+  -j, --json         Output results in JSON format.
+  -l, --list         List available profiles.
+  -m, --magnitude=   Specify the magnitude of testdata. Default: 1000.
+  -p, --precision=   Specify the precision in terms of decimal places of results. Default: 4 decimals.
+  -q, --quiet        Print results only.
+  -v, --verbose      Print verbose information.
+```
+
 ### Getting help
 
 ```bash
@@ -67,6 +80,13 @@ To print results only:
 ./js-performance --quiet
 ```
 
+### Report in JSON format
+
+```bash
+./js-performance -j
+./js-performance --json
+```
+
 ## [Changelog](CHANGELOG.md)
 
 ## [License](LICENSE)

js-performance.js

@@ -8,14 +8,16 @@ const GetOpt = require('node-getopt');
 const chalk = require('chalk');
 const appRoot = __dirname;
 global.requireModule = (module) => require(join(appRoot, module));
-const DEFAULTS = requireModule('src/support/defaults');
-const VERBOSITY = requireModule('src/support/verbosity');
-const ProfileRunner = requireModule('src/profile-runner');
-const Reporter = requireModule('src/reporter/reporter');
+const DEFAULTS = requireModule('lib/support/defaults');
+const VERBOSITY = requireModule('lib/support/verbosity');
+const ProfileRunner = requireModule('lib/profile-runner');
+const ConsoleReporter = requireModule('lib/reporter/console');
+const JSONReporter = requireModule('lib/reporter/json');
 
 const opts = new GetOpt([
     ['h', 'help', 'Display this helptext.'],
     ['i', 'iterations=', `Specify the number of iterations per profiled function. Default: ${DEFAULTS.iterations}.`],
+    ['j', 'json', `Output results in JSON format.`],
     ['l', 'list', 'List available profiles.'],
     ['m', 'magnitude=', `Specify the magnitude of testdata. Default: ${DEFAULTS.testdataMagnitude}.`],
     ['p', 'precision=', `Specify the precision in terms of decimal places of results. Default: ${DEFAULTS.precision} decimals.`],
@@ -25,7 +27,7 @@ const opts = new GetOpt([
   .parseSystem();
 
 if ('list' in opts.options) {
-  requireModule('src/profiles')
+  requireModule('lib/profiles')
     .forEach((profile) => {
       console.info(`${chalk.bold.underline(profile.name)}\n${profile.description(VERBOSITY.VERBOSE)}\n`);
     });
@@ -59,18 +61,9 @@ if ('precision' in opts.options
   precision = parseInt(opts.options.precision, 10);
 }
 
-let profiles = [];
+let profiles = requireModule('lib/profiles');
 if (opts.argv.length > 0) {
-  opts.argv.forEach((profileName) => {
-    const discoveredProfiles = glob.sync(`src/profiles/**/@(${profileName}.profile|${profileName}.profile.js|${profileName}.js)`);
-    if (discoveredProfiles.length === 1) {
-      profiles.push(requireModule(discoveredProfiles.pop()));
-    } else if (verbosity >= VERBOSITY.NORMAL) {
-      console.info(`Skipping unknown profile "${profileName}".`);
-    }
-  });
-} else {
-  profiles = profiles.concat(requireModule('src/profiles'));
+  profiles = profiles.filter((profile) => opts.argv.includes(profile.name));
 }
 
 const profileRunner = new ProfileRunner({
@@ -79,5 +72,8 @@ const profileRunner = new ProfileRunner({
   magnitude
 });
 
-new Reporter(profileRunner, verbosity, precision);
+const reporter = 'json' in opts.options
+  ? new JSONReporter(verbosity, precision)
+  : new ConsoleReporter(verbosity, precision);
+reporter.reportOn(profileRunner);
 profileRunner.run();

src/profile-runner.js renamed to lib/profile-runner/index.js

@@ -1,9 +1,9 @@
 'use strict';
 
 const EventEmitter = require('events');
-const clock = requireModule('src/support/clock/clock');
-const events = requireModule('src/support/events');
-const testdata = requireModule('src/support/testdata/testdata');
+const clock = requireModule('lib/support/clock');
+const events = requireModule('lib/support/events');
+const testdata = requireModule('lib/support/testdata');
 
 class ProfileRunner extends EventEmitter {
 

src/profile-runner.spec.js renamed to lib/profile-runner/profile-runner.spec.js

@@ -6,8 +6,8 @@ const sinonChai = require('sinon-chai');
 
 chai.use(sinonChai);
 const expect = chai.expect;
-const ProfileRunner = require('./profile-runner');
-const events = require('./support/events');
+const ProfileRunner = requireModule('lib/profile-runner');
+const events = requireModule('lib/support/events');
 
 describe('Profile Runner', () => {
   let profileRunner;

src/profiles/guards/guards.profile.spec.js renamed to lib/profiles/guards/guards.profile.spec.js

@@ -1,5 +1,5 @@
 const expect = require('chai').expect;
-const guards = requireModule('src/profiles/guards/guards.profile');
+const guards = requireModule('lib/profiles/guards');
 
 describe('Guards', () => {
   let data;

src/profiles/guards/guards.profile.js renamed to lib/profiles/guards/index.js

@@ -1,4 +1,4 @@
-const VERBOSITY = requireModule('src/support/verbosity');
+const VERBOSITY = requireModule('lib/support/verbosity');
 
 const guardTypeofNotUndefined = {
   description: () => 'typeof !== undefined',
@@ -41,6 +41,7 @@ const guardHasOwnProperty = {
 };
 
 module.exports = {
+  name: 'guards',
   description: (verbosity) => {
     switch (verbosity) {
       case VERBOSITY.QUIET:

src/profiles/index.js renamed to lib/profiles/index.js

@@ -1,8 +1,8 @@
 'use strict';
 
 const glob = require('glob');
-module.exports = glob.sync('**/*.profile.js')
+module.exports = glob.sync('lib/profiles/*/index.js')
   .reduce((allProfiles, profile) => {
-    allProfiles.push(requireModule(profile)); // eslint-disable-line
+    allProfiles.push(requireModule(profile));
     return allProfiles;
   }, []);

src/profiles/loops/loops.profile.js renamed to lib/profiles/loops/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const VERBOSITY = requireModule('src/support/verbosity');
+const VERBOSITY = requireModule('lib/support/verbosity');
 
 const loopForEach = {
   description: () => '[].forEach() => []',

src/profiles/loops/loops.profile.spec.js renamed to lib/profiles/loops/loops.profile.spec.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const expect = require('chai').expect;
-const loops = requireModule('src/profiles/loops/loops.profile');
+const loops = requireModule('lib/profiles/loops');
 
 describe('Loops', () => {
   let result;

src/profiles/recursion/recursion.profile.js renamed to lib/profiles/recursion/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const VERBOSITY = requireModule('src/support/verbosity');
+const VERBOSITY = requireModule('lib/support/verbosity');
 
 const recursiveSum = {
   description: () => 'recursive sum',

src/profiles/recursion/recursion.profile.spec.js renamed to lib/profiles/recursion/recursion.profile.spec.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const expect = require('chai').expect;
-const recursions = requireModule('src/profiles/recursion/recursion.profile');
+const recursions = requireModule('lib/profiles/recursion');
 
 describe('Recursion', () => {
   let result;

src/reporter/reporter.js renamed to lib/reporter/console/index.js

@@ -1,19 +1,13 @@
 'use strict';
 
 const chalk = require('chalk');
-const VERBOSITY = requireModule('src/support/verbosity');
-const events = requireModule('src/support/events');
-
-class Reporter {
-  /**
-  * @param {ProfileRunner} profileRunner The test runner
-  * @param {number} verbosity The verbosity level
-  * @param {number} precision The number of decimal places to print for results
-  */
-  constructor(profileRunner, verbosity, precision) {
-    this.verbosity = verbosity;
-    this.precision = precision;
+const VERBOSITY = requireModule('lib/support/verbosity');
+const events = requireModule('lib/support/events');
+const Reporter = requireModule('lib/reporter/reporter');
 
+class ConsoleReporter extends Reporter{
+  reportOn(profileRunner) {
+    super.reportOn(profileRunner);
     profileRunner.on(events.START, (profiles) => {
       if (this.verbosity === VERBOSITY.VERBOSE) {
         console.info(`Executing ${profiles.length} profile${profiles.length === 1 ? '' : 's'}.\n`);
@@ -22,7 +16,7 @@ class Reporter {
 
     profileRunner.on(events.END, (profiles) => {
       if (this.verbosity >= VERBOSITY.VERBOSE) {
-        console.log(`Finished ${profiles.length} profiles.`);
+        console.info(`Finished ${profiles.length} profiles.`);
       }
     });
 
@@ -35,9 +29,7 @@ class Reporter {
     profileRunner.on(events.PROFILE_END, (profile, result) => {
       if (this.verbosity >= VERBOSITY.NORMAL) {
         console.log('  ==============');
-        const best = result.testResults
-          .sort((a, b) => a.averageTime - b.averageTime)
-          .filter((a, i, arr) => a.averageTime === arr[0].averageTime);
+        const best = this.bestResults(result);
         if (best.length === 1) {
           console.info(chalk.green(`  Winner: "${best[0].func.description()}" (${this.formatTime(best[0].averageTime)})\n`));
         } else {
@@ -57,19 +49,7 @@ class Reporter {
         console.info(`    ${this.formatTime(result.averageTime)}\n`);
       }
     });
-
-    profileRunner.on(events.ERROR, (err) => {
-      console.error(err.stack);
-    });
-  }
-
-  formatTime(t) {
-    if (t * 1000 < 10) {
-      return `${(t * 1000).toFixed(this.precision)}μs`;
-    }
-
-    return `${t.toFixed(this.precision)}ms`;
   }
 }
 
-module.exports = Reporter;
+module.exports = ConsoleReporter;

lib/reporter/json/index.js

@@ -0,0 +1,52 @@
+const VERBOSITY = requireModule('lib/support/verbosity');
+const events = requireModule('lib/support/events');
+const Reporter = requireModule('lib/reporter/reporter');
+
+class JSONReporter extends Reporter {
+  constructor(verbosity, precision) {
+    super(verbosity, precision);
+    this.report = [];
+    this.profiles = {};
+  }
+
+  reportOn(profileRunner) {
+    super.reportOn(profileRunner);
+
+    profileRunner.on(events.END, (profiles) => {
+      console.info(JSON.stringify(this.report, null, 2));
+    });
+
+    profileRunner.on(events.PROFILE_START, (profile) => {
+      this.profiles[profile.name] = [];
+    });
+
+    profileRunner.on(events.PROFILE_END, (profile, result) => {
+      const best = this.bestResults(result);
+      const p = {
+        name: profile.name,
+        description: profile.description(this.verbosity)
+      };
+
+      if (this.verbosity >= VERBOSITY.NORMAL) {
+        p.tests = this.profiles[profile.name];
+        p.fastest = best.map((b) => ({
+          description: `${b.func.description()}`,
+          average: this.formatTime(b.averageTime, true)
+        }));
+      }
+
+      this.report.push(p);
+    });
+
+    profileRunner.on(events.TEST_END, (profile, func, result) => {
+      if (this.verbosity >= VERBOSITY.NORMAL) {
+        this.profiles[profile.name].push({
+          description: func.description(),
+          average: this.formatTime(result.averageTime, true)
+        });
+      }
+    });
+  }
+}
+
+module.exports = JSONReporter;

lib/reporter/reporter/index.js

@@ -0,0 +1,45 @@
+const events = requireModule('lib/support/events');
+
+class Reporter {
+  /**
+   * @param {number} verbosity The verbosity level
+   * @param {number} precision The number of decimal places to print for results
+   */
+  constructor(verbosity, precision) {
+    this.verbosity = verbosity;
+    this.precision = precision;
+  }
+
+  /**
+  * @param {ProfileRunner} profileRunner The test runner
+  */
+  reportOn(profileRunner) {
+    profileRunner.on(events.ERROR, (err) => {
+      console.error(err.stack);
+    });
+  }
+
+  /**
+   * @param {object} results of profile run
+   * @returns {Array} best results
+   */
+  bestResults(results) {
+    return results.testResults
+      .sort((a, b) => a.averageTime - b.averageTime)
+      .filter((a, i, arr) => a.averageTime === arr[0].averageTime);
+  }
+
+  formatTime(t, preserveUnits = false) {
+    if (preserveUnits) {
+      return t.toFixed(this.precision);
+    }
+
+    if (t * 1000 < 10) {
+      return `${(t * 1000).toFixed(this.precision)}μs`;
+    }
+
+    return `${t.toFixed(this.precision)}ms`;
+  }
+}
+
+module.exports = Reporter;

src/support/clock/clock.spec.js renamed to lib/support/clock/clock.spec.js

@@ -3,7 +3,7 @@
 const chai = require('chai');
 const expect = chai.expect;
 const sinon = require('sinon');
-const clock = require('./clock');
+const clock = requireModule('lib/support/clock');
 
 chai.use(require('sinon-chai'));
 

src/support/clock/clock.js renamed to lib/support/clock/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const testdata = requireModule('src/support/testdata/testdata')();
+const testdata = requireModule('lib/support/testdata')();
 
 const delta = (start) => {
   if (!Array.isArray(start)) {

src/support/defaults.js renamed to lib/support/defaults/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const VERBOSITY = requireModule('src/support/verbosity');
+const VERBOSITY = requireModule('lib/support/verbosity');
 
 module.exports = {
   iterations: 1000,

src/support/events.js renamed to lib/support/events/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const DEFAULTS = requireModule('src/support/defaults');
+const DEFAULTS = requireModule('lib/support/defaults');
 
 const testArray = (len) => {
   let i = len;