@teamscale/javascript-instrumenter 0.0.1-beta.40 → 0.0.1-beta.41

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "0.0.1-beta.40",
+    "version": "0.0.1-beta.41",
     "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -17,7 +17,7 @@
         "build": "tsc --project tsconfig.json && yarn buildVaccine",
         "buildVaccine": "node esbuild.mjs",
         "instrumenter": "node dist/src/main.js",
-        "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
+        "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules --max-old-space-size=8192' jest --forceExit --coverage --silent=true --detectOpenHandles"
     },
     "files": [
         "dist/**/*"
@@ -59,7 +59,7 @@
         "convert-source-map": "^1.7.0",
         "foreground-child": "^2.0.0",
         "glob": "^7.1.7",
-        "istanbul-lib-instrument": "^4.0.0",
+        "istanbul-lib-instrument": "^5.2.0",
         "micromatch": "4.0.4",
         "mkdirp": "^1.0.4",
         "nyc": "^15.1.0",

package/dist/src/instrumenter/Instrumenter.d.ts

@@ -1,4 +1,6 @@
-import { CollectorSpecifier, InstrumentationTask, OriginSourcePattern, TaskElement, TaskResult } from './Task';
+import { CollectorSpecifier, InstrumentationTask, OriginSourcePattern, SourceMapReference, TaskElement, TaskResult } from './Task';
+import { RawSourceMap, SourceMapConsumer } from 'source-map';
+import { Optional } from 'typescript-optional';
 import Logger from 'bunyan';
 export declare const IS_INSTRUMENTED_TOKEN = "/** $IS_JS_PROFILER_INSTRUMENTED=true **/";
 /**
@@ -41,22 +43,12 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
      */
     instrumentOne(collector: CollectorSpecifier, taskElement: TaskElement, sourcePattern: OriginSourcePattern, dumpOriginsFile: string | undefined): Promise<TaskResult>;
     private removeUnwantedInstrumentation;
-    private loadSourceMap;
     /**
      * Loads the vaccine from the vaccine file and adjusts some template parameters.
      *
      * @param collector - The collector to send coverage information to.
      */
     private loadVaccine;
-    /**
-     * Should the given file be excluded from the instrumentation,
-     * based on the source files that have been transpiled into it?
-     *
-     * @param pattern - The pattern to match the origin source files.
-     * @param sourceFile - The bundle file name.
-     * @param originSourceFiles - The list of files that were transpiled into the bundle.
-     */
-    private shouldExcludeFromInstrumentation;
     /**
      * @returns whether the given file is supported for instrumentation.
      */
@@ -66,17 +58,37 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
      * given task element.
      */
     private configurationAlternativesFor;
-    /**
-     * Given a source code file, load the corresponding sourcemap.
-     *
-     * @param inputSource - The source code that might contain sourcemap comments.
-     * @param taskFile - The name of the file the `inputSource` is from.
-     * @param externalSourceMapFile - An external source map file to consider.
-     */
-    private loadInputSourceMap;
     /** Appends all origins from the source map to a given file. Creates the file if it does not exist yet. */
     private dumpOrigins;
     /** Clears the dump origins file if it exists, such that it is now ready to be appended for every instrumented file. */
     private clearDumpOriginsFileIfNeeded;
 }
+/**
+ * Extract the sourcemap from the given source code.
+ *
+ * @param instrumentedSource - The source code.
+ * @param instrumentedSourceFileName - The file name to assume for the file name.
+ */
+export declare function loadSourceMap(instrumentedSource: string, instrumentedSourceFileName: string): Promise<SourceMapConsumer | undefined>;
+/**
+ * Given a source code file, load the corresponding sourcemap.
+ *
+ * @param inputSource - The source code that might contain sourcemap comments.
+ * @param taskFile - The name of the file the `inputSource` is from.
+ * @param externalSourceMapFile - An external source map file to consider.
+ */
+export declare function loadInputSourceMap(inputSource: string, taskFile: string, externalSourceMapFile: Optional<SourceMapReference>): RawSourceMap | undefined;
+/**
+ * Extract a sourcemap for a given code comment.
+ *
+ * @param sourcecode - The source code that is scanned for source map comments.
+ * @param sourceFilePath - The file name the code was loaded from.
+ */
+export declare function sourceMapFromCodeComment(sourcecode: string, sourceFilePath: string): RawSourceMap | undefined;
+/**
+ * Read a source map from a source map file.
+ *
+ * @param mapFilePath
+ */
+export declare function sourceMapFromMapFile(mapFilePath: string): RawSourceMap | undefined;
 //# sourceMappingURL=Instrumenter.d.ts.map

package/dist/src/instrumenter/Instrumenter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EAGnB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAUhB,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,eAAO,MAAM,qBAAqB,8CAA8C,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IAEzC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IASnD;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAqBhE;;;;;;;OAOG;IACG,aAAa,CAClB,SAAS,EAAE,kBAAkB,EAC7B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAoGR,6BAA6B;YAmC7B,aAAa;IAe3B;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAMnB;;;;;;;OAOG;IACH,OAAO,CAAC,gCAAgC;IAQxC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAK3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAcpC;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAgB1B,0GAA0G;IAC1G,OAAO,CAAC,WAAW;IASnB,uHAAuH;IACvH,OAAO,CAAC,4BAA4B;CASpC"}
+{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAClB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAY,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAOvE,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,eAAO,MAAM,qBAAqB,8CAA8C,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AAED;;GAEG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IAEzC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IASnD;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAqBhE;;;;;;;OAOG;IACG,aAAa,CAClB,SAAS,EAAE,kBAAkB,EAC7B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAuGR,6BAA6B;IA8C3C;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAK3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAcpC,0GAA0G;IAC1G,OAAO,CAAC,WAAW;IASnB,uHAAuH;IACvH,OAAO,CAAC,4BAA4B;CASpC;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAClC,kBAAkB,EAAE,MAAM,EAC1B,0BAA0B,EAAE,MAAM,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAUxC;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,qBAAqB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,GACjD,YAAY,GAAG,SAAS,CAU1B;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAsC7G;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGlF"}

package/dist/src/instrumenter/Instrumenter.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IstanbulInstrumenter = exports.IS_INSTRUMENTED_TOKEN = void 0;
+exports.sourceMapFromMapFile = exports.sourceMapFromCodeComment = exports.loadInputSourceMap = exports.loadSourceMap = exports.IstanbulInstrumenter = exports.IS_INSTRUMENTED_TOKEN = void 0;
 const Task_1 = require("./Task");
 const commons_1 = require("@cqse/commons");
 const source_map_1 = require("source-map");
@@ -99,7 +99,7 @@ class IstanbulInstrumenter {
             let inputSourceMap;
             try {
                 const instrumenter = istanbul.createInstrumenter(configurationAlternative);
-                inputSourceMap = this.loadInputSourceMap(inputFileSource, taskElement.fromFile, taskElement.externalSourceMapFile);
+                inputSourceMap = loadInputSourceMap(inputFileSource, taskElement.fromFile, taskElement.externalSourceMapFile);
                 // Based on the source maps of the file to instrument, we can now
                 // decide if we should NOT write an instrumented version of it
                 // and use the original code instead and write it to the target path.
@@ -108,26 +108,23 @@ class IstanbulInstrumenter {
                 if (dumpOriginsFile) {
                     this.dumpOrigins(dumpOriginsFile, originSourceFiles);
                 }
-                if (this.shouldExcludeFromInstrumentation(sourcePattern, taskElement.fromFile, originSourceFiles)) {
-                    writeToFile(taskElement.toFile, inputFileSource);
-                    return new Task_1.TaskResult(0, 1, 0, 0, 0, 0, 0);
-                }
                 // The main instrumentation (adding coverage statements) is performed now:
-                instrumentedSource = instrumenter
-                    .instrumentSync(inputFileSource, taskElement.fromFile, inputSourceMap)
-                    .replace(/actualCoverage\s*=\s*coverage\[path\]/g, 'actualCoverage=makeCoverageInterceptor(coverage[path])')
-                    .replace(/new Function\("return this"\)\(\)/g, "typeof window === 'object' ? window : this");
+                instrumentedSource = instrumenter.instrumentSync(inputFileSource, taskElement.fromFile, inputSourceMap);
                 this.logger.debug('Instrumentation source maps to:', (_b = instrumenter.lastSourceMap()) === null || _b === void 0 ? void 0 : _b.sources);
                 // In case of a bundle, the initial instrumentation step might have added
                 // too much and undesired instrumentations. Remove them now.
-                instrumentedSource = await this.removeUnwantedInstrumentation(taskElement, instrumentedSource, configurationAlternative, sourcePattern);
+                const instrumentedSourcemap = instrumenter.lastSourceMap();
+                let instrumentedAndCleanedSource = await this.removeUnwantedInstrumentation(taskElement, instrumentedSource, configurationAlternative, sourcePattern, instrumentedSourcemap);
+                instrumentedAndCleanedSource = instrumentedAndCleanedSource
+                    .replace(/actualCoverage\s*=\s*coverage\[path\]/g, 'actualCoverage=makeCoverageInterceptor(coverage[path])')
+                    .replace(/new Function\("return this"\)\(\)/g, "typeof window === 'object' ? window : this");
                 // The process also can result in a new source map that we will append in the result.
                 //
                 // `lastSourceMap` === Sourcemap for the last file that was instrumented.
                 finalSourceMap = convertSourceMap.fromObject(instrumenter.lastSourceMap()).toComment();
                 // We now can glue together the final version of the instrumented file.
                 const vaccineSource = this.loadVaccine(collector);
-                writeToFile(taskElement.toFile, `${exports.IS_INSTRUMENTED_TOKEN} ${vaccineSource} ${instrumentedSource} \n${finalSourceMap}`);
+                writeToFile(taskElement.toFile, `${exports.IS_INSTRUMENTED_TOKEN} ${vaccineSource} ${instrumentedAndCleanedSource} \n${finalSourceMap}`);
                 return new Task_1.TaskResult(1, 0, 0, 0, 0, 0, 0);
             }
             catch (e) {
@@ -144,13 +141,13 @@ class IstanbulInstrumenter {
         }
         return new Task_1.TaskResult(0, 0, 0, 0, 0, 1, 0);
     }
-    async removeUnwantedInstrumentation(taskElement, instrumentedSource, configurationAlternative, sourcePattern) {
-        // Read the source map from the instrumented file
-        const instrumentedSourceMapConsumer = await this.loadSourceMap(instrumentedSource, taskElement.fromFile);
+    async removeUnwantedInstrumentation(taskElement, instrumentedSource, configurationAlternative, sourcePattern, instrumentedSourcemap) {
+        const instrumentedSourceMapConsumer = await new source_map_1.SourceMapConsumer(instrumentedSourcemap);
         // Without a source map, excludes/includes do not work.
         if (!instrumentedSourceMapConsumer) {
             return instrumentedSource;
         }
+        const removedInstrumentationFor = new Set();
         // Remove the unwanted instrumentation
         const cleaned = (0, Cleaner_1.cleanSourceCode)(instrumentedSource, configurationAlternative.esModules, location => {
             const originalPosition = instrumentedSourceMapConsumer.originalPositionFor({
@@ -158,21 +155,22 @@ class IstanbulInstrumenter {
                 column: location.start.column
             });
             if (!originalPosition.source) {
-                return true;
+                return false;
+            }
+            const isToCover = sourcePattern.isAnyIncluded([originalPosition.source]);
+            if (!isToCover) {
+                removedInstrumentationFor.add(originalPosition.source);
             }
-            return sourcePattern.isAnyIncluded([originalPosition.source]);
+            return isToCover;
         });
+        if (removedInstrumentationFor.size) {
+            this.logger.info(`Removed from ${taskElement.toFile} instrumentation for:`);
+            removedInstrumentationFor.forEach(entry => this.logger.info(entry));
+        }
         // Explicitly free the source map to avoid memory leaks
         instrumentedSourceMapConsumer.destroy();
         return cleaned;
     }
-    async loadSourceMap(instrumentedSource, instrumentedSourceFileName) {
-        const instrumentedSourceMap = this.loadInputSourceMap(instrumentedSource, instrumentedSourceFileName, typescript_optional_1.Optional.empty());
-        if (instrumentedSourceMap) {
-            return await new source_map_1.SourceMapConsumer(instrumentedSourceMap);
-        }
-        return undefined;
-    }
     /**
      * Loads the vaccine from the vaccine file and adjusts some template parameters.
      *
@@ -183,17 +181,6 @@ class IstanbulInstrumenter {
         // actual values, for example, the collector to send the coverage information to.
         return fs.readFileSync(this.vaccineFilePath, 'utf8').replace(/\$REPORT_TO_URL/g, collector.url);
     }
-    /**
-     * Should the given file be excluded from the instrumentation,
-     * based on the source files that have been transpiled into it?
-     *
-     * @param pattern - The pattern to match the origin source files.
-     * @param sourceFile - The bundle file name.
-     * @param originSourceFiles - The list of files that were transpiled into the bundle.
-     */
-    shouldExcludeFromInstrumentation(pattern, sourceFile, originSourceFiles) {
-        return !pattern.isAnyIncluded(originSourceFiles);
-    }
     /**
      * @returns whether the given file is supported for instrumentation.
      */
@@ -209,32 +196,13 @@ class IstanbulInstrumenter {
         this.logger.debug(`Determining configuration alternatives for ${taskElement.fromFile}`);
         const baseConfig = {
             coverageVariable: '__coverage__',
-            produceSourceMap: true
+            produceSourceMap: 'both'
         };
         return [
             { ...baseConfig, ...{ esModules: true } },
             { ...baseConfig, ...{ esModules: false } }
         ];
     }
-    /**
-     * Given a source code file, load the corresponding sourcemap.
-     *
-     * @param inputSource - The source code that might contain sourcemap comments.
-     * @param taskFile - The name of the file the `inputSource` is from.
-     * @param externalSourceMapFile - An external source map file to consider.
-     */
-    loadInputSourceMap(inputSourceCode, taskFile, externalSourceMapFile) {
-        if (externalSourceMapFile.isPresent()) {
-            const sourceMapOrigin = externalSourceMapFile.get();
-            if (!(sourceMapOrigin instanceof Task_1.SourceMapFileReference)) {
-                throw new commons_1.IllegalArgumentException('Type of source map not yet supported!');
-            }
-            return sourceMapFromMapFile(sourceMapOrigin.sourceMapFilePath);
-        }
-        else {
-            return sourceMapFromCodeComment(inputSourceCode, taskFile);
-        }
-    }
     /** Appends all origins from the source map to a given file. Creates the file if it does not exist yet. */
     dumpOrigins(dumpOriginsFile, originSourceFiles) {
         const jsonContent = JSON.stringify(originSourceFiles, null, 2);
@@ -257,6 +225,40 @@ class IstanbulInstrumenter {
     }
 }
 exports.IstanbulInstrumenter = IstanbulInstrumenter;
+/**
+ * Extract the sourcemap from the given source code.
+ *
+ * @param instrumentedSource - The source code.
+ * @param instrumentedSourceFileName - The file name to assume for the file name.
+ */
+async function loadSourceMap(instrumentedSource, instrumentedSourceFileName) {
+    const instrumentedSourceMap = loadInputSourceMap(instrumentedSource, instrumentedSourceFileName, typescript_optional_1.Optional.empty());
+    if (instrumentedSourceMap) {
+        return await new source_map_1.SourceMapConsumer(instrumentedSourceMap);
+    }
+    return undefined;
+}
+exports.loadSourceMap = loadSourceMap;
+/**
+ * Given a source code file, load the corresponding sourcemap.
+ *
+ * @param inputSource - The source code that might contain sourcemap comments.
+ * @param taskFile - The name of the file the `inputSource` is from.
+ * @param externalSourceMapFile - An external source map file to consider.
+ */
+function loadInputSourceMap(inputSource, taskFile, externalSourceMapFile) {
+    if (externalSourceMapFile.isPresent()) {
+        const sourceMapOrigin = externalSourceMapFile.get();
+        if (!(sourceMapOrigin instanceof Task_1.SourceMapFileReference)) {
+            throw new commons_1.IllegalArgumentException('Type of source map not yet supported!');
+        }
+        return sourceMapFromMapFile(sourceMapOrigin.sourceMapFilePath);
+    }
+    else {
+        return sourceMapFromCodeComment(inputSource, taskFile);
+    }
+}
+exports.loadInputSourceMap = loadInputSourceMap;
 /**
  * Extract a sourcemap for a given code comment.
  *
@@ -290,11 +292,11 @@ function sourceMapFromCodeComment(sourcecode, sourceFilePath) {
                 // One JS file can refer to several source map files in its comments.
                 failedLoading++;
             }
-            if (result) {
-                return result;
-            }
         }
     } while (matched);
+    if (result) {
+        return result;
+    }
     if (failedLoading > 0) {
         throw new commons_1.IllegalArgumentException('None of the referenced source map files loaded!');
     }
@@ -302,6 +304,7 @@ function sourceMapFromCodeComment(sourcecode, sourceFilePath) {
         return undefined;
     }
 }
+exports.sourceMapFromCodeComment = sourceMapFromCodeComment;
 /**
  * Read a source map from a source map file.
  *
@@ -311,6 +314,7 @@ function sourceMapFromMapFile(mapFilePath) {
     const content = fs.readFileSync(mapFilePath, 'utf8');
     return JSON.parse(content);
 }
+exports.sourceMapFromMapFile = sourceMapFromMapFile;
 function writeToFile(filePath, fileContent) {
     mkdirp.sync(path.dirname(filePath));
     fs.writeFileSync(filePath, fileContent);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/javascript-instrumenter",
-  "version": "0.0.1-beta.40",
+  "version": "0.0.1-beta.41",
   "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -17,7 +17,7 @@
     "build": "tsc --project tsconfig.json && yarn buildVaccine",
     "buildVaccine": "node esbuild.mjs",
     "instrumenter": "node dist/src/main.js",
-    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
+    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules --max-old-space-size=8192' jest --forceExit --coverage --silent=true --detectOpenHandles"
   },
   "files": [
     "dist/**/*"
@@ -59,7 +59,7 @@
     "convert-source-map": "^1.7.0",
     "foreground-child": "^2.0.0",
     "glob": "^7.1.7",
-    "istanbul-lib-instrument": "^4.0.0",
+    "istanbul-lib-instrument": "^5.2.0",
     "micromatch": "4.0.4",
     "mkdirp": "^1.0.4",
     "nyc": "^15.1.0",