Skip to content

Commit

Permalink
fix: source-maps were not being cached in the parent process when --a…
Browse files Browse the repository at this point in the history
…ll was being used (#556)



fixes: #537
  • Loading branch information
bcoe authored Apr 20, 2017
1 parent 2ff8f3b commit ff73b18
Show file tree
Hide file tree
Showing 15 changed files with 178 additions and 120 deletions.
1 change: 0 additions & 1 deletion bin/nyc.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ if (argv._[0] === 'report') {
if (config.all) nyc.addAllFiles()

var env = {
NYC_CACHE: argv.cache ? 'enable' : 'disable',
NYC_CONFIG: JSON.stringify(config),
NYC_CWD: process.cwd(),
NYC_ROOT_ID: nyc.rootId,
Expand Down
3 changes: 2 additions & 1 deletion bin/wrap.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ process.env.NYC_PARENT_PID = process.pid

var config = {}
if (process.env.NYC_CONFIG) config = JSON.parse(process.env.NYC_CONFIG)
config.enableCache = process.env.NYC_CACHE === 'enable'
config.isChildProcess = true

config._processInfo = {
ppid: parentPid,
root: process.env.NYC_ROOT_ID
Expand Down
2 changes: 1 addition & 1 deletion build-tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ mkdirp.sync(path.join(__dirname, 'test/build'))

var testDir = path.join(__dirname, 'test/src')
var buildDir = path.join(__dirname, 'test/build')
var originalTestsFilename = path.join(testDir, 'nyc-test.js')
var originalTestsFilename = path.join(testDir, 'nyc-tap.js')
var originalTestSource = fs.readFileSync(originalTestsFilename, 'utf8')
var individualTests = forkingTap(originalTestSource, {
filename: originalTestsFilename,
Expand Down
137 changes: 46 additions & 91 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
/* global __coverage__ */
var arrify = require('arrify')
var debugLog = require('debug-log')('nyc')
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 cachingTransform = require('caching-transform')
var path = require('path')
var rimraf = require('rimraf')
var onExit = require('signal-exit')
var resolveFrom = require('resolve-from')
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 testExclude = require('test-exclude')

const arrify = require('arrify')
const cachingTransform = require('caching-transform')
const debugLog = require('debug-log')('nyc')
const findCacheDir = require('find-cache-dir')
const fs = require('fs')
const glob = require('glob')
const Hash = require('./lib/hash')
const js = require('default-require-extensions/js')
const libCoverage = require('istanbul-lib-coverage')
const libHook = require('istanbul-lib-hook')
const libReport = require('istanbul-lib-report')
const md5hex = require('md5-hex')
const mkdirp = require('mkdirp')
const Module = require('module')
const onExit = require('signal-exit')
const path = require('path')
const reports = require('istanbul-reports')
const resolveFrom = require('resolve-from')
const rimraf = require('rimraf')
const SourceMaps = require('./lib/source-maps')
const testExclude = require('test-exclude')

var ProcessInfo
try {
Expand All @@ -29,10 +30,6 @@ try {
ProcessInfo = require('./lib/process.js')
}

// bust cache whenever nyc is upgraded, this prevents
// crashers caused by instrumentation updates.
var CACHE_VERSION = require('./package.json').version

/* istanbul ignore next */
if (/index\.covered\.js$/.test(__filename)) {
require('./lib/self-coverage-helper')
Expand All @@ -50,19 +47,22 @@ function NYC (config) {
this._showProcessTree = config.showProcessTree || false
this._eagerInstantiation = config.eager || false
this.cwd = config.cwd || process.cwd()

this.reporter = arrify(config.reporter || 'text')

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

this.enableCache = Boolean(this.cacheDirectory && (config.enableCache === true || process.env.NYC_CACHE === 'enable'))
this.cache = Boolean(this.cacheDirectory && config.cache)

this.exclude = testExclude({
cwd: this.cwd,
include: config.include,
exclude: config.exclude
})

this.sourceMaps = new SourceMaps({
cache: this.cache,
cacheDirectory: this.cacheDirectory
})

// require extensions can be provided as config in package.json.
this.require = arrify(config.require)

Expand All @@ -78,32 +78,24 @@ function NYC (config) {
return transforms
}.bind(this), {})

this.sourceMapCache = libSourceMaps.createSourceMapStore()

this.hookRunInContext = config.hookRunInContext
this.hashCache = {}
this.loadedMaps = null
this.fakeRequire = null

this.processInfo = new ProcessInfo(config && config._processInfo)
this.rootId = this.processInfo.root || this.generateUniqueID()
}

NYC.prototype._createTransform = function (ext) {
var _this = this

var opts = {
salt: JSON.stringify({
istanbul: require('istanbul-lib-coverage/package.json').version,
nyc: require('./package.json').version
}),
salt: Hash.salt,
hash: function (code, metadata, salt) {
var hash = md5hex([code, metadata.filename, salt]) + '_' + CACHE_VERSION
_this.hashCache[metadata.filename] = hash
var hash = Hash(code, metadata.filename)
return hash
},
cacheDir: this.cacheDirectory,
disableCache: !this.enableCache,
// when running --all we should not load source-file from
// cache, we want to instead return the fake source.
disableCache: this._disableCachingTransform(),
ext: ext
}
if (this._eagerInstantiation) {
Expand All @@ -114,6 +106,10 @@ NYC.prototype._createTransform = function (ext) {
return cachingTransform(opts)
}

NYC.prototype._disableCachingTransform = function () {
return !(this.cache && this.config.isChildProcess)
}

NYC.prototype._loadAdditionalModules = function () {
var _this = this
this.require.forEach(function (r) {
Expand Down Expand Up @@ -271,7 +267,7 @@ NYC.prototype._transformFactory = function (cacheDir) {
var filename = metadata.filename
var sourceMap = null

if (_this._sourceMap) sourceMap = _this._handleSourceMap(cacheDir, code, hash, filename)
if (_this._sourceMap) sourceMap = _this.sourceMaps.extractAndRegister(code, filename)

try {
instrumented = instrumenter.instrumentSync(code, filename, sourceMap)
Expand All @@ -289,19 +285,6 @@ NYC.prototype._transformFactory = function (cacheDir) {
}
}

NYC.prototype._handleSourceMap = function (cacheDir, code, hash, 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.registerMap(filename, sourceMap.sourcemap)
}
}
return sourceMap
}

NYC.prototype._handleJs = function (code, filename) {
var relFile = path.relative(this.cwd, filename)
// ensure the path has correct casing (see istanbuljs/nyc#269 and nodejs/node#6624)
Expand Down Expand Up @@ -333,13 +316,14 @@ NYC.prototype.cleanup = function () {
}

NYC.prototype.clearCache = function () {
if (this.enableCache) {
if (this.cache) {
rimraf.sync(this.cacheDirectory)
}
}

NYC.prototype.createTempDirectory = function () {
mkdirp.sync(this.tempDirectory())
mkdirp.sync(this.cacheDirectory)

if (this._showProcessTree) {
mkdirp.sync(this.processInfoDirectory())
Expand Down Expand Up @@ -379,14 +363,14 @@ NYC.prototype.writeCoverageFile = function () {
var coverage = coverageFinder()
if (!coverage) return

if (this.enableCache) {
if (this.cache) {
Object.keys(coverage).forEach(function (absFile) {
if (this.hashCache[absFile] && coverage[absFile]) {
coverage[absFile].contentHash = this.hashCache[absFile]
if (this.sourceMaps.hashCache[absFile] && coverage[absFile]) {
coverage[absFile].contentHash = this.sourceMaps.hashCache[absFile]
}
}, this)
} else {
coverage = this.sourceMapTransform(coverage)
coverage = this.sourceMaps.remapCoverage(coverage)
}

var id = this.generateUniqueID()
Expand All @@ -411,13 +395,6 @@ NYC.prototype.writeCoverageFile = function () {
)
}

NYC.prototype.sourceMapTransform = function (obj) {
var transformed = this.sourceMapCache.transformCoverage(
libCoverage.createCoverageMap(obj)
)
return transformed.map.data
}

function coverageFinder () {
var coverage = global.__coverage__
if (typeof __coverage__ === 'object') coverage = __coverage__
Expand All @@ -431,7 +408,7 @@ NYC.prototype._getCoverageMapFromAllCoverageFiles = function () {
this.loadReports().forEach(function (report) {
map.merge(report)
})

map.data = this.sourceMaps.remapCoverage(map.data)
return map
}

Expand Down Expand Up @@ -497,10 +474,6 @@ NYC.prototype.loadReports = function (filenames) {
var _this = this
var files = filenames || fs.readdirSync(this.tempDirectory())

var cacheDir = _this.cacheDirectory

var loadedMaps = this.loadedMaps || (this.loadedMaps = {})

return files.map(function (f) {
var report
try {
Expand All @@ -512,25 +485,7 @@ NYC.prototype.loadReports = function (filenames) {
return {}
}

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.registerMap(absFile, loadedMaps[hash])
}
}
})
report = _this.sourceMapTransform(report)
_this.sourceMaps.reloadCachedSourceMaps(report)
return report
})
}
Expand Down
12 changes: 6 additions & 6 deletions lib/config-util.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
var arrify = require('arrify')
var fs = require('fs')
var path = require('path')
var findUp = require('find-up')
var testExclude = require('test-exclude')
var Yargs = require('yargs/yargs')
const arrify = require('arrify')
const fs = require('fs')
const path = require('path')
const findUp = require('find-up')
const testExclude = require('test-exclude')
const Yargs = require('yargs/yargs')

var Config = {}

Expand Down
14 changes: 14 additions & 0 deletions lib/hash.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const CACHE_VERSION = require('../package.json').version
const md5hex = require('md5-hex')
const salt = JSON.stringify({
istanbul: require('istanbul-lib-coverage/package.json').version,
nyc: CACHE_VERSION
})

function Hash (code, filename) {
return md5hex([code, filename, salt]) + '_' + CACHE_VERSION
}

Hash.salt = salt

module.exports = Hash
4 changes: 2 additions & 2 deletions lib/process-args.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
var parser = require('yargs-parser')
var commands = [
const parser = require('yargs-parser')
const commands = [
'report',
'check-coverage',
'instrument'
Expand Down
5 changes: 2 additions & 3 deletions lib/process.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
'use strict'
var archy = require('archy')
var libCoverage = require('istanbul-lib-coverage')
const archy = require('archy')
const libCoverage = require('istanbul-lib-coverage')

function ProcessInfo (defaults) {
defaults = defaults || {}
Expand Down
8 changes: 4 additions & 4 deletions lib/self-coverage-helper.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/* global ___NYC_SELF_COVERAGE___ */

var path = require('path')
var fs = require('fs')
var mkdirp = require('mkdirp')
var onExit = require('signal-exit')
const path = require('path')
const fs = require('fs')
const mkdirp = require('mkdirp')
const onExit = require('signal-exit')

onExit(function () {
var coverage = global.___NYC_SELF_COVERAGE___
Expand Down
Loading

0 comments on commit ff73b18

Please sign in to comment.