Merge pull request #895 from secretcowlevel/master

Fix coverage with sourcemaps inlined via Transform API.

Author: geek

lib/coverage.js

@@ -297,8 +297,7 @@ internals.instrument = function (filename) {
 
     // Store original source
 
-    const transformedFile = content.replace(/\/\/\#(.*)\r?\n?$/, '');
-    internals.sources[filename] = transformedFile.replace(/(\r\n|\n|\r)/gm, '\n').split('\n');
+    internals.sources[filename] = content.replace(/(\r\n|\n|\r)/gm, '\n').split('\n');
 
     // Setup global report container
     // $lab:coverage:off$
@@ -368,10 +367,6 @@ internals.instrument = function (filename) {
 
                 return commented;
             }).reduce((a, b) => a + b, 0);
-
-        if (transformedFile !== content) {
-            record.sloc++;
-        }
     }
 
     return chunks.join('');
@@ -453,7 +448,7 @@ exports.analyze = async function (options) {
     }
 
     for (let i = 0; i < files.length; ++i) {
-        const filename = files[i];
+        const filename = files[i].replace(/\\/g, '/');
         if (pattern.test(filename)) {
             if (!report.files[filename]) {
                 internals.instrument(filename);
@@ -551,7 +546,32 @@ internals.file = async function (filename, data, options) {
     };
 
     // Use sourcemap consumer rather than SourceMapSupport.mapSourcePosition itself which perform path transformations
-    const sourcemap = options.sourcemaps ? SourceMapSupport.retrieveSourceMap(ret.filename) : null;
+    let sourcemap = null;
+    if (options.sourcemaps) {
+        sourcemap = SourceMapSupport.retrieveSourceMap(ret.filename);
+        if (!sourcemap) {
+            const smre = /\/\/\#.*data:application\/json[^,]+base64,.*\r?\n?$/;
+            let sourceIndex = data.source.length - 1;
+            while (sourceIndex >= 0 && !smre.test(data.source[sourceIndex])) {
+                sourceIndex--;
+            }
+
+            if (sourceIndex >= 0) {
+                const re = /(?:\/\/[@#][ \t]+sourceMappingURL=([^\s'"]+?)[ \t]*$)|(?:\/\*[@#][ \t]+sourceMappingURL=([^\*]+?)[ \t]*(?:\*\/)[ \t]*$)/mg;
+                let lastMatch;
+                let match;
+                while (match = re.exec(data.source[sourceIndex])) {
+                    lastMatch = match;
+                }
+
+                sourcemap = {
+                    url: lastMatch[1],
+                    map: Buffer.from(lastMatch[1].slice(lastMatch[1].indexOf(',') + 1), 'base64').toString()
+                };
+            }
+        }
+    }
+
     const smc = sourcemap ? await new SourceMapConsumer(sourcemap.map) : null;
 
     // Process each line of code

lib/reporters/multiple.js

@@ -2,7 +2,7 @@
 
 // Load modules
 
-const Hoek = require('hoek');
+const { cloneDeep } = require('lodash');
 const Reporters = require('./index');
 
 
@@ -17,7 +17,7 @@ exports = module.exports = internals.Reporter = function (options) {
 
     options.reporter.forEach((reporter, index) => {
 
-        const reporterOptions = Hoek.clone(options);
+        const reporterOptions = cloneDeep(options);
         reporterOptions.reporter = reporter;
 
         if (options.output[index] === 'stdout') {

lib/runner.js

@@ -3,6 +3,7 @@
 // Load modules
 
 const Hoek = require('hoek');
+const { cloneDeep } = require('lodash');
 const Seedrandom = require('seedrandom');
 const WillCall = require('will-call');
 const Reporters = require('./reporters');
@@ -263,7 +264,7 @@ internals.executeExperiments = async function (experiments, state, skip, parentC
     for (const experiment of experiments) {
         const skipExperiment = skip || experiment.options.skip || !internals.experimentHasTests(experiment, state) || (state.options.bail && state.report.failures);
 
-        state.currentContext = parentContext ? Hoek.clone(parentContext) : {};
+        state.currentContext = parentContext ? cloneDeep(parentContext) : {};
 
         // Before
 
@@ -371,7 +372,7 @@ internals.executeTests = async function (experiment, state, skip) {
 
         const start = Date.now();
         try {
-            test.context = Hoek.clone(state.currentContext);
+            test.context = cloneDeep(state.currentContext);
             await internals.protect(test, state);
         }
         catch (ex) {

package.json

@@ -19,6 +19,7 @@
     "hoek": "6.x.x",
     "json-stable-stringify": "1.x.x",
     "json-stringify-safe": "5.x.x",
+    "lodash": "^4.17.x",
     "mkdirp": "0.5.x",
     "seedrandom": "2.4.x",
     "source-map": "0.7.x",

test/cli.js

@@ -103,7 +103,7 @@ describe('CLI', () => {
         const result = await RunCli(['test/cli_error/parse.js']);
         expect(result.code).to.equal(1);
         expect(result.errorOutput).to.contain('Error requiring file');
-        expect(result.errorOutput).to.contain('cli_error/parse_invalid.js:5');
+        expect(result.errorOutput).to.contain(Path.normalize('cli_error/parse_invalid.js') + ':5');
         expect(result.errorOutput).to.not.contain('UnhandledPromiseRejectionWarning');
     });
 

test/coverage.js

@@ -3,6 +3,7 @@
 // Load modules
 
 const Fs = require('fs');
+const Os = require('os');
 const Path = require('path');
 const Module = require('module');
 const Code = require('code');
@@ -12,7 +13,21 @@ const Lab = require('../');
 
 // Declare internals
 
-const internals = {};
+const internals = {
+    transform: [
+        {
+            ext: '.inl', transform: function (content, filename) {
+
+                if (Buffer.isBuffer(content)) {
+                    content = content.toString();
+                }
+
+                return content.concat(Os.EOL).concat('//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIndoaWxlLmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGFBRUE7QUFHQTtBQUVBLEtBQU0sV0FBWSxFQUFsQixDQUdBLFFBQVEsTUFBUixDQUFpQixTQUFVLEtBQVYsQ0FBaUIsQ0FFOUIsTUFBUSxLQUFSLENBQWdCLENBQ1osTUFBUSxLQUFSLENBQ0gsQ0FFRCxNQUFPLE1BQVAsQ0FDSCxDQVBEIiwiZmlsZSI6InNvdXJjZW1hcHMtaW5saW5lLmpzIiwic291cmNlc0NvbnRlbnQiOlsiJ3VzZSBzdHJpY3QnO1xuXG4vLyBMb2FkIG1vZHVsZXNcblxuXG4vLyBEZWNsYXJlIGludGVybmFsc1xuXG5jb25zdCBpbnRlcm5hbHMgPSB7fTtcblxuXG5leHBvcnRzLm1ldGhvZCA9IGZ1bmN0aW9uICh2YWx1ZSkge1xuXG4gICAgd2hpbGUgKCB2YWx1ZSApIHtcbiAgICAgICAgdmFsdWUgPSBmYWxzZTtcbiAgICB9XG5cbiAgICByZXR1cm4gdmFsdWU7XG59O1xuIl19').concat(Os.EOL);
+            }
+        },
+        { ext: '.js', transform: null }
+    ]
+};
 
 
 // Test shortcuts
@@ -503,3 +518,64 @@ describe('Coverage', () => {
         });
     });
 });
+
+describe('Coverage via Transform API', () => {
+
+    lab.before(() => {
+
+        internals.js = require.extensions['.js'];
+        internals.inl = require.extensions['.inl'];
+
+        Lab.coverage.instrument({ coveragePath: Path.join(__dirname, 'coverage'), coverageExclude: 'exclude', transform: internals.transform });
+    });
+
+    lab.after(() => {
+
+        require.extensions['.js'] = internals.js;
+        require.extensions['.inl'] = internals.inl;
+    });
+
+    it('identifies lines with partial coverage when having inline sourcemap', async () => {
+
+        const Test = require('./coverage/sourcemaps-transformed');
+
+        Test.method(false);
+
+        const cov = await Lab.coverage.analyze({ coveragePath: Path.join(__dirname, 'coverage/sourcemaps-transformed'), sourcemaps: true });
+
+        const source = cov.files[0].source;
+        const missedLines = [];
+        const missedChunks = [];
+        Object.keys(source).forEach((lineNumber) => {
+
+            const line = source[lineNumber];
+            if (line.miss) {
+                missedLines.push({
+                    filename: line.originalFilename,
+                    lineNumber,
+                    originalLineNumber: line.originalLine
+                });
+                if (line.chunks) {
+                    line.chunks.forEach((chunk) => {
+
+                        if (chunk.miss) {
+                            missedChunks.push({
+                                filename: chunk.originalFilename,
+                                lineNumber,
+                                originalLineNumber: chunk.originalLine,
+                                originalColumn: chunk.originalColumn
+                            });
+                        }
+                    });
+                }
+            }
+        });
+
+        expect(missedLines).to.include([
+            { filename: 'while.js', lineNumber: '3', originalLineNumber: 11 }
+        ]);
+        expect(missedChunks).to.include([
+            { filename: 'while.js', lineNumber: '3', originalLineNumber: 13, originalColumn: 12  }
+        ]);
+    });
+});

test/coverage/sourcemaps-transformed.inl

@@ -0,0 +1,3 @@
+'use strict';// Load modules
+// Declare internals
+const internals={};exports.method=function(value){while(value){value=false;}return value;};

test/runner.js

@@ -201,7 +201,7 @@ describe('Runner', () => {
         const notebook = await Lab.execute(script, {}, null);
         expect(notebook.tests).to.have.length(1);
         expect(notebook.failures).to.equal(1);
-        expect(notebook.tests[0].err.stack).to.contain('test/runner.js');
+        expect(notebook.tests[0].err.stack).to.contain(Path.normalize('test/runner.js'));
     });
 
     it('should fail test that returns a rejected promise', async () => {

test/transform.js

@@ -82,10 +82,10 @@ describe('Transform', () => {
 
         require('./transform/basic-transform'); // prime the cache
 
-        const rel = Transform.retrieveFile('test/transform/basic-transform.new');
+        const rel = Transform.retrieveFile(Path.normalize('test/transform/basic-transform.new'));
         expect(rel).to.not.contain('!NOCOMPILE!');
 
-        const abs = Transform.retrieveFile(process.cwd() + '/test/transform/basic-transform.new');
+        const abs = Transform.retrieveFile(Path.normalize(process.cwd() + '/test/transform/basic-transform.new'));
         expect(abs).to.not.contain('!NOCOMPILE!');
     });
 });
@@ -112,7 +112,7 @@ describe('Transform.install', () => {
 
         const Test = require('./transform/sourcemaps');
 
-        expect(Test.method(false)).to.equal(false);
+        expect(Test.method(true)).to.equal(false);
 
         const Test2 = require('./transform/exclude/transform-basic');