@teamscale/javascript-instrumenter 0.0.1-beta.10 → 0.0.1-beta.21

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+We use [Semantic Versioning](https://semver.org/).
+
+# New Release
+
+# 0.0.1-beta.21
+
+- [fix] Include/exclude pattern and the paths to match were not normalized
+
+# 0.0.1-beta.20
+
+- [feature] Automatic release now for NPM packages and Docker images 

package/README.md

@@ -9,7 +9,7 @@ in the Teamscale Simple Coverage Format and sent to a Teamscale instance.
 The Teamscale JavaScript Profiler consists of the [Coverage Collector](https://www.npmjs.com/package/@teamscale/coverage-collector) 
 and this JavaScript Instrumenter.
 More details on using them (in combination) can be found
-on the projects' [Github page](https://github.com/cqse/teamscale-javascript-profiler/).
+in the [Teamscale Documentation](https://docs.teamscale.com/howto/recording-test-coverage-for-javascript/).
 
 The Instrumenter instruments a given (set of) JavaScript file(s) such that (1) coverage 
 information is produced and (2) forwarded to the Collector.
@@ -25,28 +25,6 @@ yarn install
 yarn build
 ```
 
-### Preparation: Source Maps
-
-Please make sure to enable the generation of source map files to ensure
-that the profiled code can be mapped back to the original.
-
-For example, when the tool Vite is used to bundle the code,
-the generation of source map information can be enabled by setting:
-
-```
-   build: {
-      sourcemap: true
-   }
-```
-
-or
-
-```
-   build: {
-      sourcemap: `inline`
-   }
-```
-
 ## Workflow Integration
 
 There are several options to run the Instrumenter. For example, via `yarn` by running
@@ -85,12 +63,8 @@ yarn instrumenter --inplace ./the/path/to/the/file.js --source-map ./the/path/to
 yarn instrumenter ./the/path/to/the/file.js --to ./the/file/path/to/write/to.js
 ```
 
-### Integration with Testing Frameworks
-
-This is planned work: Provide a Babel plugin that provides a code transformation
-such that coverage information is collected and this information is forwarded.
-
 ## Limitations
 
 This tool inherits most of the limitations of IstanbulJs, including 
 a considerable performance impact.
+

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "0.0.1-beta.10",
+    "version": "0.0.1-beta.21",
     "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",

package/dist/src/instrumenter/Instrumenter.js

@@ -63,11 +63,11 @@ class IstanbulInstrumenter {
             if (!taskElement.isInPlace()) {
                 fs.writeFileSync(taskElement.toFile, inputFileSource);
             }
-            return new Task_1.TaskResult(0, 0, 1, 0, 0, 0);
+            return new Task_1.TaskResult(0, 0, 0, 1, 0, 0, 0);
         }
         // Not all file types are supported by the instrumenter
         if (!this.isFileTypeSupported(taskElement.fromFile)) {
-            return new Task_1.TaskResult(0, 0, 0, 1, 0, 0);
+            return new Task_1.TaskResult(0, 0, 0, 0, 1, 0, 0);
         }
         // Report progress
         this.logger.info(`Instrumenting "${path.basename(taskElement.fromFile)}"`);
@@ -87,7 +87,7 @@ class IstanbulInstrumenter {
                 //
                 if (this.shouldExcludeFromInstrumentation(sourcePattern, taskElement.fromFile, (_a = inputSourceMap === null || inputSourceMap === void 0 ? void 0 : inputSourceMap.sources) !== null && _a !== void 0 ? _a : [])) {
                     fs.writeFileSync(taskElement.toFile, inputFileSource);
-                    return new Task_1.TaskResult(1, 0, 0, 0, 0, 0);
+                    return new Task_1.TaskResult(0, 1, 0, 0, 0, 0, 0);
                 }
                 // The main instrumentation (adding coverage statements) is performed now:
                 instrumentedSource = instrumenter
@@ -117,7 +117,7 @@ class IstanbulInstrumenter {
         //
         const vaccineSource = this.loadVaccine(collector);
         fs.writeFileSync(taskElement.toFile, `${exports.IS_INSTRUMENTED_TOKEN} ${vaccineSource} ${instrumentedSource} \n${finalSourceMap}`);
-        return new Task_1.TaskResult(1, 0, 0, 0, 0, 0);
+        return new Task_1.TaskResult(1, 0, 0, 0, 0, 0, 0);
     }
     /**
      * Loads the vaccine from the vaccine file and adjusts some template parameters.

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

@@ -51,12 +51,19 @@ export declare class OriginSourcePattern {
     /**
      * Does the given pattern require to include the given set of files?
      *
+     * For example, a JavaScript bundle is compiled from several (origin) source files.
+     * If one of the files in the bundle is needed, then the full bundle is needed, that is,
+     * this function is required to return `true`.
+     *
      * @param originFiles - The file set to decide for include or exclude.
      *
-     * @returns `true` if (1) all of the given files are supposed to be excluded,
-     *   or (2) if one of the files is supposed to be included.
+     * @returns `false` if (1) all given files are supposed to be excluded,
+     *   or (2) `true` if at least one of the files is supposed to be included.
      */
     isAnyIncluded(originFiles: string[]): boolean;
+    private static normalizeGlobPattern;
+    private static normalizePath;
+    private static removeTrailingCurrentWorkingDir;
 }
 /**
  * The actual instrumentation task.
@@ -87,6 +94,8 @@ export declare class InstrumentationTask {
 export declare class TaskResult {
     /** Number of task elements that were performed (instrumented) */
     readonly translated: number;
+    /** Number of task elements that were excluded because of corresponding include/exclude patterns. */
+    readonly excluded: number;
     /** Number of instrumentations that were taken from a cache */
     readonly translatedFromCache: number;
     /** Number of skips due to a present instrumentation */
@@ -97,7 +106,7 @@ export declare class TaskResult {
     readonly failed: number;
     /** Number of warnings that were produced during the instrumentation process */
     readonly warnings: number;
-    constructor(translated: number, translatedFromCache: number, alreadyInstrumented: number, unsupported: number, failed: number, warnings: number);
+    constructor(translated: number, excluded: number, translatedFromCache: number, alreadyInstrumented: number, unsupported: number, failed: number, warnings: number);
     /**
      * Returns the sum of the present task results and the given one.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAI/C;;GAEG;AACH,8BAAsB,kBAAkB;CAAG;AAE3C;;;GAGG;AACH,qBAAa,WAAW;IACvB,sBAAsB;IACtB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,2BAA2B;IAC3B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,gEAAgE;IAChE,SAAgB,qBAAqB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;gBAExD,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,kBAAkB;IAMpF;;OAEG;IACI,SAAS,IAAI,OAAO;CAK3B;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC9B,2CAA2C;IAC3C,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gDAAgD;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,SAAS,EAAE,MAAM;CAK7B;AAED;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAC/B,mGAAmG;IACnG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;gBAEjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS;IAKpE;;;;;;;OAOG;IACI,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO;CAepD;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC/B;;OAEG;IACH,SAAgB,SAAS,EAAE,kBAAkB,CAAC;IAE9C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAE1C;;;OAGG;IACH,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;gBAE7C,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,mBAAmB,EAAE,mBAAmB;IAM5G;;OAEG;IACH,IAAI,QAAQ,IAAI,WAAW,EAAE,CAI5B;CACD;AAED;;GAEG;AACH,qBAAa,UAAU;IACtB,iEAAiE;IACjE,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,8DAA8D;IAC9D,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAE5C,uDAAuD;IACvD,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAE5C,sDAAsD;IACtD,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,6DAA6D;IAC7D,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,+EAA+E;IAC/E,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAGhC,UAAU,EAAE,MAAM,EAClB,mBAAmB,EAAE,MAAM,EAC3B,mBAAmB,EAAE,MAAM,EAC3B,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;IAgBjB;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAWnD;;OAEG;WACW,OAAO,IAAI,UAAU;IAInC;;;;OAIG;WACW,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,UAAU;IAKzC;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;CAI9C;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC7D,2CAA2C;IAC3C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;gBAE9B,iBAAiB,EAAE,MAAM;CAIrC"}
+{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAK/C;;GAEG;AACH,8BAAsB,kBAAkB;CAAG;AAE3C;;;GAGG;AACH,qBAAa,WAAW;IACvB,sBAAsB;IACtB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,2BAA2B;IAC3B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,gEAAgE;IAChE,SAAgB,qBAAqB,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;gBAExD,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,kBAAkB;IAMpF;;OAEG;IACI,SAAS,IAAI,OAAO;CAK3B;AAED;;;GAGG;AACH,qBAAa,kBAAkB;IAC9B,2CAA2C;IAC3C,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gDAAgD;IAChD,SAAgB,IAAI,EAAE,MAAM,CAAC;gBAEjB,SAAS,EAAE,MAAM;CAK7B;AAED;;;;;;GAMG;AACH,qBAAa,mBAAmB;IAC/B,mGAAmG;IACnG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;gBAEjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS;IAKpE;;;;;;;;;;;OAWG;IACI,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO;IAiBpD,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAQnC,OAAO,CAAC,MAAM,CAAC,aAAa;IAI5B,OAAO,CAAC,MAAM,CAAC,+BAA+B;CAO9C;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC/B;;OAEG;IACH,SAAgB,SAAS,EAAE,kBAAkB,CAAC;IAE9C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAE1C;;;OAGG;IACH,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;gBAE7C,SAAS,EAAE,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,mBAAmB,EAAE,mBAAmB;IAM5G;;OAEG;IACH,IAAI,QAAQ,IAAI,WAAW,EAAE,CAI5B;CACD;AAED;;GAEG;AACH,qBAAa,UAAU;IACtB,iEAAiE;IACjE,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,oGAAoG;IACpG,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,8DAA8D;IAC9D,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAE5C,uDAAuD;IACvD,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAE5C,sDAAsD;IACtD,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,6DAA6D;IAC7D,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,+EAA+E;IAC/E,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAGhC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,mBAAmB,EAAE,MAAM,EAC3B,mBAAmB,EAAE,MAAM,EAC3B,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM;IAkBjB;;;;OAIG;IACI,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAYnD;;OAEG;WACW,OAAO,IAAI,UAAU;IAInC;;;;OAIG;WACW,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,UAAU;IAKzC;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;CAI9C;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,kBAAkB;IAC7D,2CAA2C;IAC3C,SAAgB,iBAAiB,EAAE,MAAM,CAAC;gBAE9B,iBAAiB,EAAE,MAAM;CAIrC"}

package/dist/src/instrumenter/Task.js

@@ -18,11 +18,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceMapFileReference = exports.TaskResult = exports.InstrumentationTask = exports.OriginSourcePattern = exports.CollectorSpecifier = exports.TaskElement = exports.SourceMapReference = void 0;
 const typescript_optional_1 = require("typescript-optional");
 const commons_1 = require("@cqse/commons");
 const matching = __importStar(require("micromatch"));
+const path_1 = __importDefault(require("path"));
 /**
  * An abstract source map type.
  */
@@ -70,31 +74,52 @@ exports.CollectorSpecifier = CollectorSpecifier;
  */
 class OriginSourcePattern {
     constructor(include, exclude) {
-        this.include = include;
-        this.exclude = exclude;
+        this.include = OriginSourcePattern.normalizeGlobPattern(include);
+        this.exclude = OriginSourcePattern.normalizeGlobPattern(exclude);
     }
     /**
      * Does the given pattern require to include the given set of files?
      *
+     * For example, a JavaScript bundle is compiled from several (origin) source files.
+     * If one of the files in the bundle is needed, then the full bundle is needed, that is,
+     * this function is required to return `true`.
+     *
      * @param originFiles - The file set to decide for include or exclude.
      *
-     * @returns `true` if (1) all of the given files are supposed to be excluded,
-     *   or (2) if one of the files is supposed to be included.
+     * @returns `false` if (1) all given files are supposed to be excluded,
+     *   or (2) `true` if at least one of the files is supposed to be included.
      */
     isAnyIncluded(originFiles) {
         var _a;
+        const normalizedOriginFiles = originFiles.map(OriginSourcePattern.normalizePath);
         if (this.exclude) {
-            const matchedToExclude = matching.match(originFiles, this.exclude);
+            const matchedToExclude = matching.match(normalizedOriginFiles, this.exclude);
             if (originFiles.length === matchedToExclude.length) {
                 return false;
             }
         }
         if (this.include) {
-            const matchedToInclude = matching.match(originFiles, (_a = this.include) !== null && _a !== void 0 ? _a : '**');
+            const matchedToInclude = matching.match(normalizedOriginFiles, (_a = this.include) !== null && _a !== void 0 ? _a : '**');
             return matchedToInclude.length > 0;
         }
         return true;
     }
+    static normalizeGlobPattern(pattern) {
+        if (!pattern) {
+            return pattern;
+        }
+        return OriginSourcePattern.removeTrailingCurrentWorkingDir(pattern);
+    }
+    static normalizePath(toNormalize) {
+        return OriginSourcePattern.removeTrailingCurrentWorkingDir(toNormalize);
+    }
+    static removeTrailingCurrentWorkingDir(removeFrom) {
+        const prefixToRemove = '.' + path_1.default.sep;
+        if (removeFrom.startsWith(prefixToRemove)) {
+            return removeFrom.substring(2);
+        }
+        return removeFrom;
+    }
 }
 exports.OriginSourcePattern = OriginSourcePattern;
 /**
@@ -120,14 +145,16 @@ exports.InstrumentationTask = InstrumentationTask;
  * A summary of executing the instrumentation task.
  */
 class TaskResult {
-    constructor(translated, translatedFromCache, alreadyInstrumented, unsupported, failed, warnings) {
+    constructor(translated, excluded, translatedFromCache, alreadyInstrumented, unsupported, failed, warnings) {
         commons_1.Contract.require(translated > -1);
+        commons_1.Contract.require(excluded > -1);
         commons_1.Contract.require(translatedFromCache > -1);
         commons_1.Contract.require(alreadyInstrumented > -1);
         commons_1.Contract.require(unsupported > -1);
         commons_1.Contract.require(failed > -1);
         commons_1.Contract.require(warnings > -1);
         this.translated = translated;
+        this.excluded = excluded;
         this.translatedFromCache = translatedFromCache;
         this.alreadyInstrumented = alreadyInstrumented;
         this.unsupported = unsupported;
@@ -140,13 +167,13 @@ class TaskResult {
      * @param incBy - The task result to add (as delta).
      */
     withIncrement(incBy) {
-        return new TaskResult(this.translated + incBy.translated, this.translatedFromCache + incBy.translatedFromCache, this.alreadyInstrumented + incBy.alreadyInstrumented, this.unsupported + incBy.unsupported, this.failed + incBy.failed, this.warnings + incBy.warnings);
+        return new TaskResult(this.translated + incBy.translated, this.excluded + incBy.excluded, this.translatedFromCache + incBy.translatedFromCache, this.alreadyInstrumented + incBy.alreadyInstrumented, this.unsupported + incBy.unsupported, this.failed + incBy.failed, this.warnings + incBy.warnings);
     }
     /**
      * @returns the neutral task element (adding it with {@code withIncrement} does not change the result).
      */
     static neutral() {
-        return new TaskResult(0, 0, 0, 0, 0, 0);
+        return new TaskResult(0, 0, 0, 0, 0, 0, 0);
     }
     /**
      * @returns a task result signaling one error.
@@ -155,7 +182,7 @@ class TaskResult {
      */
     static error(e) {
         console.error(e);
-        return new TaskResult(0, 0, 0, 0, 1, 0);
+        return new TaskResult(0, 0, 0, 0, 0, 1, 0);
     }
     /**
      * @returns a task result signaling one warning.
@@ -164,7 +191,7 @@ class TaskResult {
      */
     static warning(msg) {
         console.warn(msg);
-        return new TaskResult(0, 0, 0, 0, 0, 1);
+        return new TaskResult(0, 0, 0, 0, 0, 0, 1);
     }
 }
 exports.TaskResult = TaskResult;

package/dist/src/main.js

@@ -7,6 +7,7 @@ App_1.App.run()
     .then(result => {
     console.log('Instrumentation finished.');
     console.log(`\tInstrumented: ${result.translated}`);
+    console.log(`\tExcluded: ${result.excluded}`);
     console.log(`\tInstrumented from cache: ${result.translatedFromCache}`);
     console.log(`\tAlready instrumented: ${result.alreadyInstrumented}`);
     console.log(`\tUnsupported: ${result.unsupported}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/javascript-instrumenter",
-  "version": "0.0.1-beta.10",
+  "version": "0.0.1-beta.21",
   "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",