@teamscale/javascript-instrumenter 0.1.0-beta.8 → 1.0.0-beta.2

package/dist/package.json

@@ -1,16 +1,13 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "0.1.0-beta.8",
+    "version": "1.0.0-beta.2",
     "description": "JavaScript coverage instrumenter with coverage forwarding to a collector process",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
     "types": "dist/src/main.d.ts",
     "author": "CQSE GmbH",
     "license": "Apache-2.0",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
-    },
+    "homepage": "https://docs.teamscale.com/howto/setting-up-profiler-tga/javascript/",
     "scripts": {
         "prepublishOnly": "pnpm clean && pnpm build",
         "clean": "rimraf dist tsconfig.tsbuildinfo",
@@ -23,50 +20,51 @@
         "dist/**/*"
     ],
     "devDependencies": {
-        "@babel/core": "^7.24.4",
-        "@babel/plugin-transform-modules-commonjs": "^7.24.1",
-        "@babel/preset-env": "^7.24.4",
-        "@types/argparse": "^2.0.16",
+        "@babel/core": "^7.26.8",
+        "@babel/plugin-transform-modules-commonjs": "^7.26.3",
+        "@babel/preset-env": "^7.26.8",
+        "@types/argparse": "^2.0.17",
         "@types/async": "^3.2.24",
         "@types/babel__generator": "^7.6.8",
-        "@types/babel__traverse": "^7.20.5",
+        "@types/babel__traverse": "^7.20.6",
         "@types/bunyan": "^1.8.11",
         "@types/convert-source-map": "^2.0.3",
         "@types/glob": "^8.1.0",
-        "@types/istanbul-lib-instrument": "^1.7.7",
-        "@types/jest": "^29.5.12",
-        "@types/node": "^20.12.6",
-        "@types/ws": "^8.5.10",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^22.13.4",
+        "@types/ws": "^8.5.14",
+        "@types/uuid": "^10.0.0",
         "babel-jest": "^29.7.0",
-        "esbuild": "^0.20.2",
+        "esbuild": "^0.25.0",
         "esbuild-plugin-inline-worker": "^0.1.1",
         "jest": "^29.7.0",
-        "rimraf": "^5.0.5",
-        "ts-jest": "^29.1.2",
+        "rimraf": "^6.0.1",
+        "ts-jest": "^29.2.5",
         "ts-node": "^10.9.2",
-        "tslib": "^2.6.2",
-        "typescript": "^5.4.4"
+        "tslib": "^2.8.1",
+        "typescript": "^5.7.3"
     },
     "dependencies": {
-        "@cqse/commons": "0.1.0-beta.7",
+        "@cqse/commons": "workspace:../cqse-commons",
         "@teamscale/lib-instrument": "workspace:../lib-instrument",
-        "@babel/generator": "^7.24.4",
-        "@babel/parser": "^7.24.4",
-        "@babel/traverse": "^7.24.1",
-        "@babel/types": "^7.24.0",
-        "@types/micromatch": "^4.0.6",
+        "@babel/generator": "^7.26.8",
+        "@babel/parser": "^7.26.8",
+        "@babel/traverse": "^7.26.8",
+        "@babel/types": "^7.26.8",
+        "@types/micromatch": "^4.0.9",
         "argparse": "^2.0.1",
-        "async": "^3.2.5",
+        "async": "^3.2.6",
         "bunyan": "^1.8.15",
         "convert-source-map": "^2.0.0",
-        "foreground-child": "^3.1.1",
-        "glob": "^10.3.12",
-        "micromatch": "4.0.5",
+        "foreground-child": "^3.3.0",
+        "glob": "^11.0.1",
+        "micromatch": "4.0.8",
         "mkdirp": "^3.0.1",
         "source-map": "0.7.4",
         "typescript-optional": "^2.0.1",
         "unload": "^2.4.1",
-        "web-worker": "^1.3.0"
+        "uuid": "^11.1.0",
+        "web-worker": "^1.5.0"
     },
     "publishConfig": {
         "access": "public"

package/dist/src/App.d.ts

@@ -1,6 +1,6 @@
 import { TaskResult } from './instrumenter/Task';
-import { ConfigurationParameters } from './instrumenter/TaskBuilder';
 import Logger from 'bunyan';
+import { InstrumenterOptions } from './instrumenter/InstrumenterConfig';
 /**
  * Entry points of the instrumenter, including command line argument parsing.
  */
@@ -10,22 +10,23 @@ export declare class App {
      * Parses the command line options and the instrumentation accordingly.
      */
     static run(): Promise<TaskResult>;
+    /**
+     * Runs the application with for the given command line arguments. Visible for testing.
+     */
+    static runForArgv(argv: string[]): Promise<TaskResult>;
     /**
      * Parses the command-line arguments.
      *
-     * @param args Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
+     * @param args - Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
      *   If not given, uses the NodeJS process's arguments and exits on errors.
+     * @param beforeArgumentCheckCallback - To be executed before the arguments are checked for validity.
      */
-    static parseCommandLine(args?: string[]): ConfigurationParameters;
+    static parseCommandLine(args?: string[], beforeArgumentCheckCallback?: (options: InstrumenterOptions) => void): InstrumenterOptions;
     /**
      * Sometimes we get inputs from shell environments where the strings are
      * still quoted. We remove those here.
      */
-    static postprocessConfig(config: ConfigurationParameters): void;
-    /**
-     * Build the command line argument parser.
-     */
-    private static buildParser;
+    static postprocessConfig(config: InstrumenterOptions): void;
     /**
      * Construct the logger.
      */
@@ -40,7 +41,7 @@ export declare class App {
      * @param config - The dictionary with all configuration arguments.
      * @param logger - The logger to use.
      */
-    static runForConfigArguments(config: ConfigurationParameters, logger?: Logger): Promise<TaskResult>;
+    static runForConfigArguments(config: InstrumenterOptions, logger?: Logger): Promise<TaskResult>;
     private static createInstrumentationTask;
     private static createInstrumenter;
 }

package/dist/src/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtE,OAAO,EAAE,uBAAuB,EAAe,MAAM,4BAA4B,CAAC;AAKlF,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAY9C;;;;;OAKG;WACW,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,uBAAuB;IAKxE;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAwCtE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA0D1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA+B1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAI/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAS1G,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAajC"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAYtE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAA4C,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAGlH;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAI9C;;OAEG;WACiB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BnE;;;;;;OAMG;WACW,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,2BAA2B,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,mBAAmB;IAM1I;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAwClE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA+B1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAI/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAoCtG,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAajC"}

package/dist/src/App.js

@@ -15,19 +15,28 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.App = void 0;
-const argparse_1 = require("argparse");
 const Instrumenter_1 = require("./instrumenter/Instrumenter");
 const commons_1 = require("@cqse/commons");
 const TaskBuilder_1 = require("./instrumenter/TaskBuilder");
@@ -36,6 +45,8 @@ const package_json_1 = require("../package.json");
 const fs_1 = require("fs");
 const mkdirp_1 = require("mkdirp");
 const bunyan_1 = __importDefault(require("bunyan"));
+const InstrumenterConfig_1 = require("./instrumenter/InstrumenterConfig");
+const process = __importStar(require("node:process"));
 /**
  * Entry points of the instrumenter, including command line argument parsing.
  */
@@ -45,7 +56,25 @@ class App {
      * Parses the command line options and the instrumentation accordingly.
      */
     static async run() {
-        const config = this.parseCommandLine();
+        return this.runForArgv(process.argv);
+    }
+    /**
+     * Runs the application with for the given command line arguments. Visible for testing.
+     */
+    static async runForArgv(argv) {
+        const config = this.parseCommandLine(argv.slice(2), options => {
+            if (options.collectorOptionsList) {
+                const collectorParameters = (0, commons_1.buildReconfigurableCollectorParameters)();
+                (0, commons_1.printHelp)(collectorParameters, undefined, true);
+                console.log("");
+                console.log("ATTENTION:\n" +
+                    "When specifying credentials of Teamscale or other services via --collector-config-file or --collector-option,\n" +
+                    "the credentials will be included in the instrumented source code and are thus visible\n" +
+                    "to anyone that can access your deployed application.\n" +
+                    "We recommend you instead give these credentials to the collector directly when launching it.\n");
+                process.exit(0);
+            }
+        });
         // Build the logger
         const logger = this.buildLogger(config);
         logger.trace('Retrieved arguments', process.argv);
@@ -56,12 +85,14 @@ class App {
     /**
      * Parses the command-line arguments.
      *
-     * @param args Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
+     * @param args - Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
      *   If not given, uses the NodeJS process's arguments and exits on errors.
+     * @param beforeArgumentCheckCallback - To be executed before the arguments are checked for validity.
      */
-    static parseCommandLine(args) {
-        const parser = this.buildParser();
-        return parser.parse_args(args);
+    static parseCommandLine(args, beforeArgumentCheckCallback) {
+        const configParameters = (0, InstrumenterConfig_1.buildInstrumenterConfigurationParameters)();
+        const appInfos = { about: package_json_1.description, version: package_json_1.version, name: package_json_1.name };
+        return (0, commons_1.processCommandLine)(configParameters, appInfos, args, beforeArgumentCheckCallback);
     }
     /**
      * Sometimes we get inputs from shell environments where the strings are
@@ -107,70 +138,14 @@ class App {
             }
         }
     }
-    /**
-     * Build the command line argument parser.
-     */
-    static buildParser() {
-        const parser = new argparse_1.ArgumentParser({
-            description: 'Instrumenter of the Teamscale JavaScript Profiler',
-        });
-        parser.add_argument('-v', '--version', { action: 'version', version: package_json_1.version });
-        parser.add_argument('-i', '--in-place', {
-            action: 'store_true',
-            help: 'If set, the original files to instrument are replaced by their instrumented counterparts.'
-        });
-        parser.add_argument('-d', '--debug', { action: 'store_true' });
-        parser.add_argument('-o', '--to', {
-            help: 'Path (directory or file name) to write the instrumented version to.'
-        });
-        parser.add_argument('-s', '--source-map', {
-            help: 'External location of source-map files to consider.'
-        });
-        parser.add_argument('-c', '--collector', {
-            help: 'The collector (`host:port` or `wss://host:port/` or `ws://host:port/`) to send coverage information to.',
-            default: 'ws://localhost:54678'
-        });
-        parser.add_argument('--relative-collector', {
-            help: 'Pattern used to determine the collector URL from the application hostname.'
-                + ' Useful for Kubernetes deployments where the collector URL is not known at instrumentation time.'
-                + ' Example: `replace-in-host:app collector,scheme:wss`.'
-                + ' This causes the first occurrence of `app` in the application hostname to be replaced with `collector`'
-                + ' and the URL scheme changed to wss.'
-                + ' Available operations:'
-                + ' `replace-in-host:SEARCH REPLACE` replaces the literal term SEARCH once in the hostname with REPLACE.'
-                + ' `port:NUMBER` changes the port to NUMBER.'
-                + ' `port:keep` keeps the port of the application (instead of using the chosen scheme\'s default port).'
-                + ' `scheme:SCHEME` changes the URL scheme to one of ws, wss, http or https.'
-                + ' `path:PATH` uses the URL path PATH (instead of no path).'
-        });
-        parser.add_argument('-x', '--exclude-origin', {
-            nargs: '*',
-            help: 'Glob pattern(s) of files in the source origin to not produce coverage for. Multiple patterns can be separated by space.'
-        });
-        parser.add_argument('-k', '--include-origin', {
-            nargs: '*',
-            help: 'Glob pattern(s) of files in the source origin to produce coverage for. Multiple patterns can be separated by space.'
-        });
-        parser.add_argument('-e', '--exclude-bundle', {
-            nargs: '*',
-            help: 'Glob pattern(s) of input (bundle) files to keep unchanged (to not instrument).'
-        });
-        parser.add_argument('-p', '--dump-origins-to', {
-            help: 'Path specifying where to dump source origins file names, based on the source maps, as a JSON file.'
-        });
-        parser.add_argument('-m', '--dump-origin-matches-to', {
-            help: 'Path specifying where to dump a JSON with the names of the files that have matched the origin include/exclude patterns.'
-        });
-        parser.add_argument('inputs', { nargs: '+', help: 'The input file(s) to instrument.' });
-        return parser;
-    }
     /**
      * Construct the logger.
      */
     static buildLogger(config) {
+        var _a;
         const logfilePath = 'logs/instrumenter.log';
         mkdirp_1.mkdirp.sync(path.dirname(logfilePath));
-        const logLevel = config.debug ? 'debug' : 'error';
+        const logLevel = (_a = config.logLevel) !== null && _a !== void 0 ? _a : 'info';
         return bunyan_1.default.createLogger({
             name: 'Instrumenter',
             streams: [
@@ -205,14 +180,39 @@ class App {
      */
     static runForConfigArguments(config, logger) {
         this.postprocessConfig(config);
+        if (config.collectorConfigFile) {
+            if (!(0, fs_1.existsSync)(config.collectorConfigFile)) {
+                throw new commons_1.InvalidConfigurationException(`The specified collector configuration file '${config.collectorConfigFile}' does not exist.`);
+            }
+            config.collectorConfigFileContent = (0, fs_1.readFileSync)(config.collectorConfigFile, 'utf8');
+        }
+        if (Array.isArray(config.collectorOption)) {
+            if (!config.collectorConfigFileContent) {
+                config.collectorConfigFileContent = "";
+            }
+            config.collectorConfigFileContent += `\n${config.collectorOption.join("\n")}`;
+        }
+        if (config.collectorConfigFileContent) {
+            try {
+                // We parse the collector config file once, to see if it is valid.
+                const collectorParameters = (0, commons_1.buildReconfigurableCollectorParameters)();
+                const { options } = (0, commons_1.parseConfigFile)(config.collectorConfigFileContent, collectorParameters);
+                if (!(0, commons_1.checkArguments)(collectorParameters, options)) {
+                    throw new commons_1.InvalidConfigurationException(`Not all required configuration options are specified correctly.`);
+                }
+            }
+            catch (e) {
+                throw new commons_1.InvalidConfigurationException(`The specified collector configuration is invalid: ${e.message}`);
+            }
+        }
         const task = this.createInstrumentationTask(config);
         commons_1.Contract.require(task.elements.length > 0, 'The instrumentation task must not be empty.');
-        return this.createInstrumenter(logger !== null && logger !== void 0 ? logger : this.buildDummyLogger(), task.collector).instrument(task);
+        return this.createInstrumenter(logger !== null && logger !== void 0 ? logger : this.buildDummyLogger(), task.collector, task.targetBucket).instrument(task);
     }
     static createInstrumentationTask(config) {
         return new TaskBuilder_1.TaskBuilder().addFromConfig(config).build();
     }
-    static createInstrumenter(logger, collector) {
+    static createInstrumenter(logger, collector, targetBucket) {
         // We have to deal with two different `__dirname` versions,
         // which depends on whether we run from within the IDE or from
         // the command line:
@@ -220,10 +220,10 @@ class App {
         const pathVariant1 = path.join(__dirname, '../vaccine.js');
         const pathVariant2 = path.join(__dirname, '../dist/vaccine.js');
         if ((0, fs_1.existsSync)(pathVariant1)) {
-            return new Instrumenter_1.IstanbulInstrumenter(pathVariant1, logger, collector);
+            return new Instrumenter_1.IstanbulInstrumenter(pathVariant1, logger, collector, targetBucket);
         }
         else {
-            return new Instrumenter_1.IstanbulInstrumenter(pathVariant2, logger, collector);
+            return new Instrumenter_1.IstanbulInstrumenter(pathVariant2, logger, collector, targetBucket);
         }
     }
 }

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

@@ -31,4 +31,8 @@ export declare function expandToFileSet(toExpand: string): string[];
  * @param mapFilePath
  */
 export declare function sourceMapFromMapFile(mapFilePath: string): RawSourceMap | undefined;
+/**
+ * Ensure that the given name works as a file or folder name.
+ */
+export declare function replaceNonFilesystemCharacters(name: string): string;
 //# sourceMappingURL=FileSystem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/FileSystem.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU1D;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAgBpF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGlF"}
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/FileSystem.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU1D;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAgBpF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGlF;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKnE"}

package/dist/src/instrumenter/FileSystem.js

@@ -15,18 +15,35 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.sourceMapFromMapFile = exports.expandToFileSet = exports.isDirectoryEmpty = exports.findSubFolders = exports.ensureExistingDirectory = exports.isExistingDirectory = exports.isExistingFile = void 0;
+exports.isExistingFile = isExistingFile;
+exports.isExistingDirectory = isExistingDirectory;
+exports.ensureExistingDirectory = ensureExistingDirectory;
+exports.findSubFolders = findSubFolders;
+exports.isDirectoryEmpty = isDirectoryEmpty;
+exports.expandToFileSet = expandToFileSet;
+exports.sourceMapFromMapFile = sourceMapFromMapFile;
+exports.replaceNonFilesystemCharacters = replaceNonFilesystemCharacters;
 const commons_1 = require("@cqse/commons");
 const fs = __importStar(require("fs"));
 const mkdirp = __importStar(require("mkdirp"));
@@ -38,14 +55,12 @@ const glob_1 = require("glob");
 function isExistingFile(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isFile();
 }
-exports.isExistingFile = isExistingFile;
 /**
  * Does the given `path` point to an existing directory?
  */
 function isExistingDirectory(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isDirectory();
 }
-exports.isExistingDirectory = isExistingDirectory;
 /**
  * Ensure that the given directory `path` exists.
  */
@@ -57,7 +72,6 @@ function ensureExistingDirectory(path) {
         throw new commons_1.InvalidConfigurationException(`The specified path '${path}' does not point to an existing directory!`);
     }
 }
-exports.ensureExistingDirectory = ensureExistingDirectory;
 /**
  * Given a root folder find a folder with a given name.
  */
@@ -76,14 +90,12 @@ function findSubFolders(startFromFolder, folderName) {
     }
     return matches;
 }
-exports.findSubFolders = findSubFolders;
 /**
  * Is the given directory empty?
  */
 function isDirectoryEmpty(path) {
     return !isExistingDirectory(path) || fs.readdirSync(path).length > 0;
 }
-exports.isDirectoryEmpty = isDirectoryEmpty;
 /**
  * Expand a given Glob pattern to a list of files.
  *
@@ -102,7 +114,6 @@ function expandToFileSet(toExpand) {
     }
     return glob_1.glob.sync(globPattern, { nodir: true });
 }
-exports.expandToFileSet = expandToFileSet;
 /**
  * Read a source map from a source map file.
  *
@@ -112,4 +123,12 @@ function sourceMapFromMapFile(mapFilePath) {
     const content = fs.readFileSync(mapFilePath, 'utf8');
     return JSON.parse(content);
 }
-exports.sourceMapFromMapFile = sourceMapFromMapFile;
+/**
+ * Ensure that the given name works as a file or folder name.
+ */
+function replaceNonFilesystemCharacters(name) {
+    // Replace undesired characters by underscore chars.
+    const result = name.replace(/[^a-zA-Z0-9_\-.\\/]/g, '_');
+    // Remove repeated underscores (_) from `result.
+    return result.replace(/_+/g, '_');
+}

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

@@ -2,7 +2,7 @@ import { FileExcludePattern, InstrumentationTask, OriginSourcePattern, SourceMap
 import { RawSourceMap, SourceMapConsumer } from 'source-map';
 import { Optional } from 'typescript-optional';
 import Logger from 'bunyan';
-import { CollectorSpecifier } from '@src/vaccine/types';
+import { CollectorSpecifier, CoverageBucketSpecifier } from '@src/vaccine/types';
 export declare const IS_INSTRUMENTED_TOKEN = "$IS_JS_PROFILER_INSTRUMENTED=true";
 /**
  * An instrumenter that can conduct a {@code InstrumentationTask}.
@@ -29,7 +29,7 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
      * The logger instance to log to.
      */
     private logger;
-    constructor(vaccineFilePath: string, logger: Logger, collector: CollectorSpecifier);
+    constructor(vaccineFilePath: string, logger: Logger, collector: CollectorSpecifier, targetBucket: CoverageBucketSpecifier);
     /**
      * {@inheritDoc #IInstrumenter.instrument}
      */
@@ -49,7 +49,9 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
     /**
      * Loads the vaccine from the vaccine file and adjusts some template parameters.
      *
+     * @param filePath - The path to the vaccine file.
      * @param collector - The collector to send coverage information to.
+     * @param targetBucket - The bucket within the collector to put the coverage into.
      */
     private loadVaccine;
     /**

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,EAEN,kBAAkB,EAElB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAElB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,eAAO,MAAM,qBAAqB,sCAAsC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AA0BD;;GAEG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB;IAUlF;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BhE;;;;;;;;OAQG;IACG,aAAa,CAClB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,kBAAkB,EAClC,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAsER,gBAAgB;IA8C9B,OAAO,CAAC,eAAe;IA0BvB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAMnB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAS3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAgBpC,+EAA+E;IAC/E,OAAO,CAAC,SAAS;IAUjB,+EAA+E;IAC/E,OAAO,CAAC,UAAU;CAYlB;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAClC,kBAAkB,EAAE,MAAM,EAC1B,0BAA0B,EAAE,MAAM,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAUxC;AAsBD;;;;;;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,CAwC7G"}
+{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,kBAAkB,EAElB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAElB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAEjF,eAAO,MAAM,qBAAqB,sCAAsC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AA0BD;;GAEG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,YAAY,EAAE,uBAAuB;IAUzH;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BhE;;;;;;;;OAQG;IACG,aAAa,CAClB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,kBAAkB,EAClC,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAsER,gBAAgB;IA8C9B,OAAO,CAAC,eAAe;IA0BvB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAQnB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAS3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAgBpC,+EAA+E;IAC/E,OAAO,CAAC,SAAS;IAUjB,+EAA+E;IAC/E,OAAO,CAAC,UAAU;CAYlB;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAClC,kBAAkB,EAAE,MAAM,EAC1B,0BAA0B,EAAE,MAAM,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAUxC;AAsBD;;;;;;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,CAwC7G"}

package/dist/src/instrumenter/Instrumenter.js

@@ -15,18 +15,31 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.sourceMapFromCodeComment = exports.loadInputSourceMap = exports.loadSourceMap = exports.IstanbulInstrumenter = exports.IS_INSTRUMENTED_TOKEN = void 0;
+exports.IstanbulInstrumenter = exports.IS_INSTRUMENTED_TOKEN = void 0;
+exports.loadSourceMap = loadSourceMap;
+exports.loadInputSourceMap = loadInputSourceMap;
+exports.sourceMapFromCodeComment = sourceMapFromCodeComment;
 const Task_1 = require("./Task");
 const commons_1 = require("@cqse/commons");
 const source_map_1 = require("source-map");
@@ -66,9 +79,9 @@ function readBundle(bundleContent, taskElement) {
  * An instrumenter based on the IstanbulJs instrumentation and coverage framework.
  */
 class IstanbulInstrumenter {
-    constructor(vaccineFilePath, logger, collector) {
+    constructor(vaccineFilePath, logger, collector, targetBucket) {
         commons_1.Contract.require(fs.existsSync(vaccineFilePath), `The vaccine file to inject "${vaccineFilePath}" must exist!\nCWD:${process.cwd()}`);
-        this.vaccineSource = this.loadVaccine(commons_1.Contract.requireNonEmpty(vaccineFilePath), collector);
+        this.vaccineSource = this.loadVaccine(commons_1.Contract.requireNonEmpty(vaccineFilePath), collector, targetBucket);
         this.logger = logger;
     }
     /**
@@ -199,12 +212,16 @@ class IstanbulInstrumenter {
     /**
      * Loads the vaccine from the vaccine file and adjusts some template parameters.
      *
+     * @param filePath - The path to the vaccine file.
      * @param collector - The collector to send coverage information to.
+     * @param targetBucket - The bucket within the collector to put the coverage into.
      */
-    loadVaccine(filePath, collector) {
+    loadVaccine(filePath, collector, targetBucket) {
         // We first replace parameters in the file with the
         // actual values, for example, the collector to send the coverage information to.
-        return fs.readFileSync(filePath, 'utf8').replace(/\$COLLECTOR_SPECIFIER/g, JSON.stringify(collector));
+        return fs.readFileSync(filePath, 'utf8')
+            .replace(/\$COLLECTOR_SPECIFIER/g, JSON.stringify(collector))
+            .replace(/\$BUCKET_SPECIFIER/g, Buffer.from(JSON.stringify(targetBucket)).toString('base64'));
     }
     /**
      * @returns whether the given file is supported for instrumentation.
@@ -272,7 +289,6 @@ async function loadSourceMap(instrumentedSource, instrumentedSourceFileName) {
     }
     return undefined;
 }
-exports.loadSourceMap = loadSourceMap;
 function loadInputSourceMaps(taskFile, bundleFile, externalSourceMapFile) {
     if ((0, WebToolkit_1.isGwtBundle)(bundleFile)) {
         return (0, WebToolkit_1.loadInputSourceMapsGwt)(taskFile, bundleFile);
@@ -303,7 +319,6 @@ function loadInputSourceMap(inputSource, taskFile, externalSourceMapFile) {
         return sourceMapFromCodeComment(inputSource, taskFile);
     }
 }
-exports.loadInputSourceMap = loadInputSourceMap;
 /**
  * Extract a sourcemap for a given code comment.
  *
@@ -351,7 +366,6 @@ function sourceMapFromCodeComment(sourcecode, sourceFilePath) {
         return undefined;
     }
 }
-exports.sourceMapFromCodeComment = sourceMapFromCodeComment;
 function writeToFile(filePath, fileContent) {
     mkdirp.sync(path.dirname(filePath));
     fs.writeFileSync(filePath, fileContent);