feat: use istanbul-lib-hook to wrap require and support vm hooks (#308)

Author: gotwarlost

bin/nyc.js

@@ -25,6 +25,10 @@ var yargs = require('yargs/yargs')(process.argv.slice(2))
         describe: 'directory to output coverage reports in',
         default: 'coverage'
       })
+      .option('temp-directory', {
+        describe: 'directory from which coverage JSON files are read',
+        default: './.nyc_output'
+      })
       .example('$0 report --reporter=lcov', 'output an HTML lcov report to ./coverage')
   })
   .command('check-coverage', 'check whether coverage is within thresholds provided', function (yargs) {
@@ -127,6 +131,11 @@ var yargs = require('yargs/yargs')(process.argv.slice(2))
     type: 'boolean',
     description: 'should nyc handle instrumentation?'
   })
+  .option('hook-run-in-context', {
+    default: true,
+    type: 'boolean',
+    description: 'should nyc wrap vm.runInThisContext?'
+  })
   .help('h')
   .alias('h', 'help')
   .version()
@@ -164,7 +173,8 @@ if (argv._[0] === 'report') {
     include: argv.include,
     exclude: argv.exclude,
     sourceMap: !!argv.sourceMap,
-    instrumenter: argv.instrumenter
+    instrumenter: argv.instrumenter,
+    hookRunInContext: argv.hookRunInContext
   }))
   nyc.reset()
 
@@ -175,6 +185,7 @@ if (argv._[0] === 'report') {
     NYC_CACHE: argv.cache ? 'enable' : 'disable',
     NYC_SOURCE_MAP: argv.sourceMap ? 'enable' : 'disable',
     NYC_INSTRUMENTER: argv.instrumenter,
+    NYC_HOOK_RUN_IN_CONTEXT: argv.hookRunInContext ? 'enable' : 'disable',
     BABEL_DISABLE_CACHE: 1
   }
   if (argv.require.length) {
@@ -218,7 +229,8 @@ function report (argv) {
 
   ;(new NYC({
     reporter: argv.reporter,
-    reportDir: argv.reportDir
+    reportDir: argv.reportDir,
+    tempDirectory: argv.tempDirectory
   })).report()
 }
 

bin/wrap.js

@@ -13,7 +13,8 @@ try {
   include: process.env.NYC_INCLUDE ? process.env.NYC_INCLUDE.split(',') : [],
   enableCache: process.env.NYC_CACHE === 'enable',
   sourceMap: process.env.NYC_SOURCE_MAP === 'enable',
-  instrumenter: process.env.NYC_INSTRUMENTER
+  instrumenter: process.env.NYC_INSTRUMENTER,
+  hookRunInContext: process.env.NYC_HOOK_RUN_IN_CONTEXT === 'enable'
 })).wrap()
 
 sw.runMain()

build-self-coverage.js

@@ -1,4 +1,4 @@
-var istanbul = require('istanbul')
+var istanbul = require('istanbul-lib-instrument')
 var fs = require('fs')
 var path = require('path')
 
@@ -8,10 +8,9 @@ var path = require('path')
   var indexPath = path.join(__dirname, name)
   var source = fs.readFileSync(indexPath, 'utf8')
 
-  var instrumentor = new istanbul.Instrumenter({
+  var instrumentor = istanbul.createInstrumenter({
     coverageVariable: '___NYC_SELF_COVERAGE___',
-    esModules: true,
-    noAutoWrap: true
+    esModules: true
   })
 
   var instrumentedSource = instrumentor.instrumentSync(source, indexPath)

index.js

@@ -2,12 +2,12 @@
 var fs = require('fs')
 var glob = require('glob')
 var libCoverage = require('istanbul-lib-coverage')
+var libHook = require('istanbul-lib-hook')
 var libReport = require('istanbul-lib-report')
 var libSourceMaps = require('istanbul-lib-source-maps')
 var reports = require('istanbul-reports')
 var mkdirp = require('mkdirp')
 var Module = require('module')
-var appendTransform = require('append-transform')
 var cachingTransform = require('caching-transform')
 var path = require('path')
 var rimraf = require('rimraf')
@@ -67,6 +67,7 @@ function NYC (opts) {
 
   this.sourceMapCache = libSourceMaps.createSourceMapStore()
 
+  this.hookRunInContext = config.hookRunInContext
   this.hashCache = {}
   this.loadedMaps = null
   this.fakeRequire = null
@@ -289,13 +290,23 @@ NYC.prototype._handleJs = function (code, filename) {
   return this._maybeInstrumentSource(code, filename, relFile) || code
 }
 
-NYC.prototype._wrapRequire = function () {
+NYC.prototype._addHook = function (type) {
   var handleJs = this._handleJs.bind(this)
+  var dummyMatcher = function () { return true } // we do all processing in transformer
+  libHook['hook' + type](dummyMatcher, handleJs, { extensions: this.extensions })
+}
 
+NYC.prototype._wrapRequire = function () {
   this.extensions.forEach(function (ext) {
     require.extensions[ext] = js
-    appendTransform(handleJs, ext)
   })
+  this._addHook('Require')
+}
+
+NYC.prototype._addOtherHooks = function () {
+  if (this.hookRunInContext) {
+    this._addHook('RunInThisContext')
+  }
 }
 
 NYC.prototype.cleanup = function () {
@@ -329,6 +340,7 @@ NYC.prototype._wrapExit = function () {
 
 NYC.prototype.wrap = function (bin) {
   this._wrapRequire()
+  this._addOtherHooks()
   this._wrapExit()
   this._loadAdditionalModules()
   return this

package.json

@@ -11,7 +11,7 @@
     "build": "node ./build-tests",
     "instrument": "node ./build-self-coverage.js",
     "run-tests": "tap -t120 --no-cov -b ./test/build/*.js ./test/src/nyc-bin.js",
-    "report": "istanbul report --include=./.self_coverage/*.json lcov text",
+    "report": "node ./bin/nyc  --temp-directory ./.self_coverage/ -r text -r lcov report",
     "cover": "npm run clean && npm run build && npm run instrument && npm run run-tests && npm run report",
     "dev": "npm run clean && npm run build && npm run run-tests",
     "version": "standard-version"
@@ -72,7 +72,6 @@
   "author": "Ben Coe <[email protected]>",
   "license": "ISC",
   "dependencies": {
-    "append-transform": "^0.4.0",
     "arrify": "^1.0.1",
     "caching-transform": "^1.0.0",
     "convert-source-map": "^1.1.2",
@@ -82,6 +81,7 @@
     "foreground-child": "^1.5.3",
     "glob": "^7.0.3",
     "istanbul-lib-coverage": "^1.0.0-alpha.4",
+    "istanbul-lib-hook": "^1.0.0-alpha.4",
     "istanbul-lib-instrument": "^1.1.0-alpha.1",
     "istanbul-lib-report": "^1.0.0-alpha.3",
     "istanbul-lib-source-maps": "^1.0.0-alpha.10",
@@ -105,9 +105,9 @@
     "exists-sync": "0.0.3",
     "forking-tap": "^0.1.1",
     "is-windows": "^0.2.0",
-    "istanbul": "^0.4.4",
     "lodash": "^4.12.0",
     "newline-regex": "^0.2.1",
+    "requirejs": "^2.2.0",
     "sanitize-filename": "^1.5.3",
     "sinon": "^1.15.3",
     "source-map-support": "^0.4.1",
@@ -134,6 +134,7 @@
     "glob",
     "istanbul-lib-coverage",
     "istanbul-lib-instrument",
+    "istanbul-lib-hook",
     "istanbul-lib-report",
     "istanbul-lib-source-maps",
     "istanbul-reports",

test/fixtures/hooks/index.js

@@ -0,0 +1,16 @@
+// RequireJS uses `vm.runInThisContext`
+// make sure we add hooks for it as well
+
+var rjs = require('requirejs'),
+    assert = require('assert');
+
+rjs.config({
+    baseUrl : __dirname,
+    nodeRequire : require
+});
+
+rjs(['./lib/lorem'], function(lorem){
+    var result = lorem(1, 2, 3);
+    assert.equal(9, result);
+});
+

test/fixtures/hooks/lib/ipsum.js

@@ -0,0 +1,11 @@
+define(function(){
+
+    function sum(a, b) {
+        return a + b;
+    }
+
+    return {
+        sum : sum
+    };
+
+});

test/fixtures/hooks/lib/lorem.js

@@ -0,0 +1,7 @@
+define(['./ipsum'], function (ipsum) {
+
+    return function exec(a, b, c){
+        return ipsum.sum(a, b) * c;
+    };
+
+});

test/fixtures/hooks/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "hooktest",
+  "version": "1.1.1",
+  "description": "AMD/ requirejs test project",
+  "main": "index.js",
+  "dependencies": {
+    "requirejs": "^2.2.0"
+  },
+  "private": true
+}

test/src/nyc-bin.js

@@ -5,6 +5,7 @@ var fs = require('fs')
 var spawn = require('child_process').spawn
 var isWindows = require('is-windows')()
 var fixturesCLI = path.resolve(__dirname, '../fixtures/cli')
+var fixturesHooks = path.resolve(__dirname, '../fixtures/hooks')
 var fakebin = path.resolve(fixturesCLI, 'fakebin')
 var bin = path.resolve(__dirname, '../../bin/nyc')
 var rimraf = require('rimraf')
@@ -388,4 +389,25 @@ describe('the nyc cli', function () {
       })
     })
   })
+
+  describe('hooks', function () {
+    it('provides coverage for requireJS and AMD modules', function (done) {
+      var args = [bin, process.execPath, './index.js']
+
+      var proc = spawn(process.execPath, args, {
+        cwd: fixturesHooks,
+        env: process.env
+      })
+      var stdout = ''
+      proc.stdout.on('data', function (chunk) {
+        stdout += chunk
+      })
+      proc.on('close', function (code) {
+        code.should.equal(0)
+        stdout.should.match(/ipsum\.js/)
+        stdout.should.match(/lorem\.js/)
+        done()
+      })
+    })
+  })
 })