Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace Istanbul for instrumentation? #217

Closed
wants to merge 1 commit into from
+104 −119
Closed

Replace Istanbul for instrumentation? #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions bin/nyc.js
View file
Original file line number Diff line number Diff line change
@@ -136,7 +136,9 @@ if (argv._[0] === 'report') {
return done()
})
} else {
if (!argv.silent) report(argv)
if (!argv.silent) {
return report(argv).then(done)
}
return done()
}
})
@@ -148,7 +150,7 @@ if (argv._[0] === 'report') {
function report (argv) {
process.env.NYC_CWD = process.cwd()

;(new NYC({
return (new NYC({
reporter: argv.reporter,
reportDir: argv.reportDir
})).report()
213 changes: 97 additions & 116 deletions index.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* global __coverage__ */
var fs = require('fs')
var glob = require('glob')
var micromatch = require('micromatch')
@@ -8,16 +7,16 @@ var appendTransform = require('append-transform')
var cachingTransform = require('caching-transform')
var path = require('path')
var rimraf = require('rimraf')
var onExit = require('signal-exit')
var resolveFrom = require('resolve-from')
var arrify = require('arrify')
var SourceMapCache = require('./lib/source-map-cache')
var convertSourceMap = require('convert-source-map')
var md5hex = require('md5-hex')
var findCacheDir = require('find-cache-dir')
var js = require('default-require-extensions/js')
var pkgUp = require('pkg-up')
var yargs = require('yargs/yargs')
var sourceMapSupport = require('source-map-support')
var md5Hex = require('md5-hex')

/* istanbul ignore next */
if (/index\.covered\.js$/.test(__filename)) {
@@ -47,7 +46,10 @@ function NYC (opts) {

this.cacheDirectory = findCacheDir({name: 'nyc', cwd: this.cwd})

this.enableCache = Boolean(this.cacheDirectory && (config.enableCache === true || process.env.NYC_CACHE === 'enable'))
// Disable caching until cache-transform has been updated to store multiple
// results (instrumented code, source maps, generated reporting code) for a
// single 'transform'.
this.enableCache = false

// require extensions can be provided as config in package.json.
this.require = arrify(config.require)
@@ -61,8 +63,6 @@ function NYC (opts) {
return transforms
}.bind(this), {})

this.sourceMapCache = new SourceMapCache()

this.hashCache = {}
this.loadedMaps = null
}
@@ -88,6 +88,8 @@ NYC.prototype._createTransform = function (ext) {
return cachingTransform({
salt: JSON.stringify({
istanbul: require('istanbul/package.json').version,
// A dedicated salt for caches like these!
copenhagen: require('copenhagen').cacheSalt,
nyc: require('./package.json').version
}),
hash: function (code, metadata, salt) {
@@ -122,20 +124,33 @@ NYC.prototype.instrumenter = function () {
}

NYC.prototype._createInstrumenter = function () {
var configFile = path.resolve(this.cwd, './.istanbul.yml')

if (!fs.existsSync(configFile)) configFile = undefined

var istanbul = this.istanbul()

var instrumenterConfig = istanbul.config.loadFile(configFile).instrumentation.config

return new istanbul.Instrumenter({
coverageVariable: '__coverage__',
embedSource: instrumenterConfig['embed-source'],
noCompact: !instrumenterConfig.compact,
preserveComments: instrumenterConfig['preserve-comments']
var tempDir = this.tempDirectory()

// Quick hack which corrects error stack traces for instrumented code. May
// collide with AVA or Babel which also install source-map-support, but at
// least it proves that we can now add instrumentation without messing up
// stack traces.
//
// We'll likely have to submit a patch to source-map-support so it uses
// default-require-extensions. This would allow us to provide the transformed
// code. Currently source-map-support goes straight to disk and reads the
// non-transformed source file.
sourceMapSupport.install({
retrieveSourceMap: function (source) {
try {
return {
url: source,
map: fs.readFileSync(path.join(tempDir, md5Hex(source) + '.js.map'), 'utf8')
}
} catch (_) {
return null
}
}
})

// Only load the instrumentation code when needed. This is good because there
// are transitive dependencies on Babel.
return require('copenhagen/instrument')
}

NYC.prototype._prepGlobPatterns = function (patterns) {
@@ -192,9 +207,8 @@ NYC.prototype.shouldInstrumentFile = function (filename, relFile) {
}

NYC.prototype.addAllFiles = function () {
var _this = this

this._loadAdditionalModules()
// Note that we no longer load additional modules. We don't need custom
// precompilers in order to instrument ES2015 files.

var pattern = null
if (this.extensions.length === 1) {
@@ -203,17 +217,13 @@ NYC.prototype.addAllFiles = function () {
pattern = '**/*{' + this.extensions.join() + '}'
}

var _this = this
glob.sync(pattern, {cwd: this.cwd, nodir: true, ignore: this.exclude}).forEach(function (filename) {
var obj = _this.addFile(path.join(_this.cwd, filename))
if (obj.instrument) {
module._compile(
_this.instrumenter().getPreamble(obj.content, obj.relFile),
filename
)
}
// Somewhat indirectly adding the files causes the reporting file to be
// written to .nyc_output. Then when reports are loaded we'll automatically
// include coverage for all files matched here.
_this.addFile(path.join(_this.cwd, filename))
})

this.writeCoverageFile()
}

NYC.prototype._maybeInstrumentSource = function (code, filename, relFile) {
@@ -235,23 +245,37 @@ NYC.prototype._maybeInstrumentSource = function (code, filename, relFile) {
}

NYC.prototype._transformFactory = function (cacheDir) {
var _this = this
var instrumenter = this.instrumenter()

// Ensure the instrumented code uses *our* singleton collector.
var collectorModuleId = require.resolve('copenhagen/collector')
var tempDir = this.tempDirectory()

return function (code, metadata, hash) {
var filename = metadata.filename

var sourceMap = convertSourceMap.fromSource(code) || convertSourceMap.fromMapFileSource(code, path.dirname(filename))
if (sourceMap) {
if (hash) {
var mapPath = path.join(cacheDir, hash + '.map')
fs.writeFileSync(mapPath, sourceMap.toJSON())
} else {
_this.sourceMapCache.addMap(filename, sourceMap.toJSON())
}
}
var result = instrumenter.instrument({
filename: filename,
code: code,
// Note that Copenhagen does not yet support mapping coverage based on the
// input source map. Anyway, this is how it would be provided.
inputSourceMap: sourceMap && sourceMap.toObject(),
collectorModuleId: collectorModuleId
})

// The reporting file is required when loading reports. It provides the
// initial coverage data. The hash is based on the filename and the parsed
// tokens in the code.
var reportingFile = path.join(tempDir, result.hash + '.js')
fs.writeFileSync(reportingFile, result.reportingCode)

return instrumenter.instrumentSync(code, filename)
// Write the resulting source map file for use with source-map-support.
var mapFile = path.join(tempDir, md5Hex(filename) + '.js.map')
fs.writeFileSync(mapFile, JSON.stringify(result.map))

// Ideally we'd add a source map comment here, pointing towards the mapFile.
return result.code
}
}

@@ -288,45 +312,21 @@ NYC.prototype.reset = function () {
this.createTempDirectory()
}

NYC.prototype._wrapExit = function () {
var _this = this

// we always want to write coverage
// regardless of how the process exits.
onExit(function () {
_this.writeCoverageFile()
}, {alwaysLast: true})
NYC.prototype._startUsageStream = function () {
// Usage data is streamed to disk. This means there's no need for Istanbul's
// __coverage__ global. Hopefully we won't need to handle exits either, though
// it's possible the process could exit before all data has flushed.
var outputStream = fs.createWriteStream(path.join(this.tempDirectory(), process.pid + '.csv'))
require('copenhagen/collector').getStream().pipe(outputStream)
}

NYC.prototype.wrap = function (bin) {
this._wrapRequire()
this._wrapExit()
this._loadAdditionalModules()
this._startUsageStream()
return this
}

NYC.prototype.writeCoverageFile = function () {
var coverage = global.__coverage__
if (typeof __coverage__ === 'object') coverage = __coverage__
if (!coverage) return

if (this.enableCache) {
Object.keys(coverage).forEach(function (absFile) {
if (this.hashCache[absFile] && coverage[absFile]) {
coverage[absFile].contentHash = this.hashCache[absFile]
}
}, this)
} else {
this.sourceMapCache.applySourceMaps(coverage)
}

fs.writeFileSync(
path.resolve(this.tempDirectory(), './', process.pid + '.json'),
JSON.stringify(coverage),
'utf-8'
)
}

NYC.prototype.istanbul = function () {
return this._istanbul || (this._istanbul = require('istanbul'))
}
@@ -335,59 +335,40 @@ NYC.prototype.report = function (cb, _collector, _reporter) {
cb = cb || function () {}

var istanbul = this.istanbul()
var collector = _collector || new istanbul.Collector()
var reporter = _reporter || new istanbul.Reporter(null, this._reportDir)

this._loadReports().forEach(function (report) {
collector.add(report)
})

this.reporter.forEach(function (_reporter) {
reporter.add(_reporter)
})

reporter.write(collector, true, cb)
}

NYC.prototype._loadReports = function () {
var _this = this
var files = fs.readdirSync(this.tempDirectory())

var cacheDir = _this.cacheDirectory
var coverage = require('copenhagen/coverage')
var tempDir = this.tempDirectory()

// Load initial file coverage (without usage data).
var report = {}
var coverageLookup = {}
glob.sync('*.js', { cwd: tempDir }).forEach(function (f) {
var reportingModule = require(path.join(tempDir, f))
var fileCoverage = reportingModule.getInitialCoverage()
report[fileCoverage.path] = fileCoverage
coverageLookup[reportingModule.hash] = fileCoverage
})

var loadedMaps = this.loadedMaps || (this.loadedMaps = {})
// Asynchronously load usage data (probably breaks if there's lots of files)
var streams = glob.sync('*.csv', { cwd: tempDir }).map(function (f) {
return fs.createReadStream(path.join(tempDir, f))
})

return files.map(function (f) {
var report
try {
report = JSON.parse(fs.readFileSync(
path.resolve(_this.tempDirectory(), './', f),
'utf-8'
))
} catch (e) { // handle corrupt JSON output.
return {}
return coverage.collectUsageData(streams).then(function (data) {
for (var hash in data) {
// Update the initial coverage with the usage data
coverage.addCounts(coverageLookup[hash], data[hash])
}

Object.keys(report).forEach(function (absFile) {
var fileReport = report[absFile]
if (fileReport && fileReport.contentHash) {
var hash = fileReport.contentHash
if (!(hash in loadedMaps)) {
try {
var mapPath = path.join(cacheDir, hash + '.map')
loadedMaps[hash] = JSON.parse(fs.readFileSync(mapPath, 'utf8'))
} catch (e) {
// set to false to avoid repeatedly trying to load the map
loadedMaps[hash] = false
}
}
if (loadedMaps[hash]) {
_this.sourceMapCache.addMap(absFile, loadedMaps[hash])
}
}
})
_this.sourceMapCache.applySourceMaps(report)
return report
var collector = _collector || new istanbul.Collector()
collector.add(report)
reporter.write(collector, true, cb)
}).catch(function (err) {
process.nextTick(function () { throw err })
})
}

4 changes: 3 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -69,20 +69,22 @@
"arrify": "^1.0.1",
"caching-transform": "^1.0.0",
"convert-source-map": "^1.1.2",
"copenhagen": "^0.1.0",
"default-require-extensions": "^1.0.0",
"find-cache-dir": "^0.1.1",
"find-up": "^1.1.2",
"foreground-child": "^1.3.5",
"glob": "^7.0.3",
"istanbul": "^0.4.1",
"md5-hex": "^1.2.0",
"md5-hex": "^1.2.1",
"micromatch": "^2.3.7",
"mkdirp": "^0.5.0",
"pkg-up": "^1.0.0",
"resolve-from": "^2.0.0",
"rimraf": "^2.5.0",
"signal-exit": "^2.1.1",
"source-map": "^0.5.3",
"source-map-support": "^0.4.0",
"spawn-wrap": "^1.1.1",
"strip-bom": "^2.0.0",
"yargs": "^4.3.1"