@teamscale/javascript-instrumenter 0.0.1-alpha.20 → 0.0.1-beta.5

package/README.md

@@ -17,19 +17,42 @@ information is produced and (2) forwarded to the Collector.
 ## Building
 
 The Instrumenter is written in TypeScript/JavaScript. For building and running it,
-NodeJs (>= v14) and Yarn (>= v3) are needed as prerequisites.
+NodeJs (>= v14) and Yarn are needed as prerequisites.
 
 ``` 
+yarn clean
 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
 
 ```
-yarn run
+yarn instrumenter
 ```
 
 or via `npx` by running
@@ -51,24 +74,17 @@ the file must contain source-map information, or the source-map file
 must be placed along with the source file in the same directory.
 
 ```
-yarn run --inplace ./the/path/to/the/file.js
+yarn instrument --inplace ./the/path/to/the/file.js
 ```
 
 ```
-yarn run --inplace ./the/path/to/the/file.js --source-map ./the/path/to/the/source.map
+yarn instrument --inplace ./the/path/to/the/file.js --source-map ./the/path/to/the/source.map
 ```
 
 ```
-yarn run ./the/path/to/the/file.js --to ./the/file/path/to/write/to.js
+yarn instrument ./the/path/to/the/file.js --to ./the/file/path/to/write/to.js
 ```
 
-### Instrumenting all JavaScript Files in a Folder
-
-We think that dealing with sets of files, in particular including or excluding
-files that match particular file masks should be done by other tools.
-In a UNIX environment, you should consider using `find` with corresponding
-filters and an `-exec` argument to run the instrumenter.
-
 ### Integration with Testing Frameworks
 
 This is planned work: Provide a Babel plugin that provides a code transformation

package/dist/package.json

@@ -1,27 +1,29 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "0.0.1-alpha.10",
+    "version": "0.0.1-beta.5",
     "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
-    "main": "dist/main.js",
-    "bin": "dist/main.js",
-    "types": "dist/main.d.ts",
+    "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"
+    },
     "scripts": {
         "clean": "rimraf dist tsconfig.tsbuildinfo",
-        "build": "tsc --project tsconfig.json && rollup --config",
-        "run": "node src/main.js",
-        "test": "yarn build && jest --forceExit --coverage --silent=true"
+        "build": "tsc --project tsconfig.json && node esbuild.mjs",
+        "instrumenter": "node dist/src/main.js",
+        "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
     },
     "files": [
         "dist/**/*"
     ],
     "devDependencies": {
         "@babel/core": "^7.14.0",
+        "@babel/plugin-transform-modules-commonjs": "^7.15.4",
         "@babel/preset-env": "^7.14.1",
-        "@rollup/plugin-commonjs": "^20.0.0",
-        "@rollup/plugin-node-resolve": "^13.0.0",
-        "@rollup/plugin-typescript": "^8.2.5",
         "@types/async": "^3.2.6",
         "@types/convert-source-map": "^1.5.1",
         "@types/glob": "^7.1.3",
@@ -32,18 +34,17 @@
         "@types/source-map": "^0.5.7",
         "@types/ws": "^7.4.4",
         "babel-jest": "^27.2.0",
+        "esbuild": "^0.13.3",
+        "esbuild-plugin-inline-worker": "^0.1.1",
         "jest": "^27.2.0",
         "rimraf": "^3.0.2",
-        "rollup": "^2.56.2",
-        "rollup-plugin-auto-named-exports": "^1.0.0-beta.3",
-        "rollup-plugin-web-worker-loader": "^1.6.1",
         "ts-jest": "^27.0.5",
         "ts-node": "^10.2.1",
         "tslib": "^2.2.0",
         "typescript": "^4.4.3"
     },
     "dependencies": {
-        "@cqse/commons": "workspace:packages/cqse-commons",
+        "@cqse/commons": "^0.0.1-beta.1",
         "@types/micromatch": "^4.0.2",
         "argparse": "^2.0.1",
         "async": "^3.2.0",
@@ -57,7 +58,8 @@
         "source-map": "0.6.1",
         "typescript-optional": "^2.0.1",
         "unload": "^2.2.0",
-        "web-worker": "^1.0.0"
+        "web-worker": "^1.0.0",
+        "winston": "^3.3.3"
     },
     "publishConfig": {
         "access": "public"

package/dist/src/App.d.ts

@@ -32,3 +32,4 @@ export declare class App {
     private static createInstrumentationTask;
     private static createInstrumenter;
 }
+//# sourceMappingURL=App.d.ts.map

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

@@ -0,0 +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;AAGlF,OAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAG1C;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAa9C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAgC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAa1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAO1G,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAajC"}

package/dist/src/App.js

@@ -1,48 +1,66 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
 };
-import { ArgumentParser } from 'argparse';
-import { IstanbulInstrumenter } from './instrumenter/Instrumenter';
-import { Contract } from '@cqse/commons';
-import { TaskBuilder } from './instrumenter/TaskBuilder';
-import * as path from 'path';
-import { version } from '../package.json';
-import winston from 'winston';
+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");
+const path = __importStar(require("path"));
+const package_json_1 = require("../package.json");
+const winston_1 = __importDefault(require("winston"));
+const fs_1 = require("fs");
 /**
  * Entry points of the instrumenter, including command line argument parsing.
  */
-export class App {
+class App {
     /**
      * Main function of the instrumenter.
      * Parses the command line options and the instrumentation accordingly.
      */
-    static run() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Parsing of command line arguments:
-            // Build the configuration object from the command line arguments.
-            const parser = this.buildParser();
-            const config = parser.parse_args();
-            // Build the logger
-            const logger = this.buildLogger(config);
-            // Run the instrumenter with the given configuration.
-            return this.runForConfigArguments(config, logger);
-        });
+    static async run() {
+        // Parsing of command line arguments:
+        // Build the configuration object from the command line arguments.
+        const parser = this.buildParser();
+        const config = parser.parse_args();
+        // Build the logger
+        const logger = this.buildLogger(config);
+        // Run the instrumenter with the given configuration.
+        return this.runForConfigArguments(config, logger);
     }
     /**
      * Build the command line argument parser.
      */
     static buildParser() {
-        const parser = new ArgumentParser({
+        const parser = new argparse_1.ArgumentParser({
             description: 'Instrumenter of the Teamscale JavaScript Profiler'
         });
-        parser.add_argument('-v', '--version', { action: 'version', version });
-        parser.add_argument('-i', '--in-place', { action: 'store_true' });
+        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: 'Name of the file to write the instrumented version to.'
@@ -67,14 +85,14 @@ export class App {
      * Construct the logger.
      */
     static buildLogger(config) {
-        return winston.createLogger({
+        return winston_1.default.createLogger({
             level: config.debug ? 'debug' : 'info',
-            format: winston.format.json(),
+            format: winston_1.default.format.json(),
             defaultMeta: {},
             transports: [
-                new winston.transports.File({ filename: 'logs/instrumenter-error.log', level: 'error' }),
-                new winston.transports.File({ filename: 'logs/instrumenter-combined.log' }),
-                new winston.transports.Console({ format: winston.format.simple(), level: 'info' })
+                new winston_1.default.transports.File({ filename: 'logs/instrumenter-error.log', level: 'error' }),
+                new winston_1.default.transports.File({ filename: 'logs/instrumenter-combined.log' }),
+                new winston_1.default.transports.Console({ format: winston_1.default.format.simple(), level: 'info' })
             ]
         });
     }
@@ -82,11 +100,11 @@ export class App {
      * A logger for testing.
      */
     static buildDummyLogger() {
-        return winston.createLogger({
+        return winston_1.default.createLogger({
             level: 'info',
-            format: winston.format.json(),
+            format: winston_1.default.format.json(),
             defaultMeta: {},
-            transports: [new winston.transports.Console({ format: winston.format.simple(), level: 'info' })]
+            transports: [new winston_1.default.transports.Console({ format: winston_1.default.format.simple(), level: 'info' })]
         });
     }
     /**
@@ -97,13 +115,25 @@ export class App {
      */
     static runForConfigArguments(config, logger) {
         const task = this.createInstrumentationTask(config);
-        Contract.require(task.elements.length > 0, 'The instrumentation task must not be empty.');
+        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()).instrument(task);
     }
     static createInstrumentationTask(config) {
-        return new TaskBuilder().addFromConfig(config).build();
+        return new TaskBuilder_1.TaskBuilder().addFromConfig(config).build();
     }
     static createInstrumenter(logger) {
-        return new IstanbulInstrumenter(path.join(__dirname, '../dist/vaccine.js'), logger);
+        // We have to deal with two different `__dirname` versions,
+        // which depends on whether we run from within the IDE or from
+        // the command line:
+        //     dist/src/    OR    src/
+        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);
+        }
+        else {
+            return new Instrumenter_1.IstanbulInstrumenter(pathVariant2, logger);
+        }
     }
 }
+exports.App = App;

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

@@ -20,3 +20,4 @@ export declare function isDirectoryEmpty(path: string): boolean;
  * @param toExpand - The Glob pattern.
  */
 export declare function expandToFileSet(toExpand: string): string[];
+//# sourceMappingURL=FileSystem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/FileSystem.ts"],"names":[],"mappings":"AAMA;;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,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1D"}

package/dist/src/instrumenter/FileSystem.js

@@ -1,43 +1,72 @@
-import { InvalidConfigurationException } from '@cqse/commons';
-import * as fs from 'fs';
-import mkdirp from 'mkdirp';
-import path from 'path';
-import { glob } from 'glob';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expandToFileSet = exports.isDirectoryEmpty = exports.ensureExistingDirectory = exports.isExistingDirectory = exports.isExistingFile = void 0;
+const commons_1 = require("@cqse/commons");
+const fs = __importStar(require("fs"));
+const mkdirp_1 = __importDefault(require("mkdirp"));
+const path_1 = __importDefault(require("path"));
+const glob_1 = require("glob");
 /**
  * Does the given `path` point to an existing file?
  */
-export function isExistingFile(path) {
+function isExistingFile(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isFile();
 }
+exports.isExistingFile = isExistingFile;
 /**
  * Does the given `path` point to an existing directory?
  */
-export function isExistingDirectory(path) {
+function isExistingDirectory(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isDirectory();
 }
+exports.isExistingDirectory = isExistingDirectory;
 /**
  * Ensure that the given directory `path` exists.
  */
-export function ensureExistingDirectory(path) {
+function ensureExistingDirectory(path) {
     if (!fs.existsSync(path)) {
-        mkdirp.sync(path);
+        mkdirp_1.default.sync(path);
     }
     if (!fs.lstatSync(path).isDirectory()) {
-        throw new InvalidConfigurationException(`The specified path '${path}' does not point to an existing directory!`);
+        throw new commons_1.InvalidConfigurationException(`The specified path '${path}' does not point to an existing directory!`);
     }
 }
+exports.ensureExistingDirectory = ensureExistingDirectory;
 /**
  * Is the given directory empty?
  */
-export function isDirectoryEmpty(path) {
+function isDirectoryEmpty(path) {
     return !isExistingDirectory(path) || fs.readdirSync(path).length > 0;
 }
+exports.isDirectoryEmpty = isDirectoryEmpty;
 /**
  * Expand a given Glob pattern to a list of files.
  *
  * @param toExpand - The Glob pattern.
  */
-export function expandToFileSet(toExpand) {
+function expandToFileSet(toExpand) {
     let globPattern = toExpand;
     if (fs.existsSync(toExpand)) {
         const stat = fs.lstatSync(toExpand, {});
@@ -45,12 +74,9 @@ export function expandToFileSet(toExpand) {
             return [toExpand];
         }
         if (stat.isDirectory()) {
-            globPattern = `${toExpand}${path.sep}**`;
+            globPattern = `${toExpand}${path_1.default.sep}**`;
         }
     }
-    const result = glob.sync(globPattern, { nodir: true });
-    if (result.length === 0) {
-        throw new InvalidConfigurationException(`No files to instrument found. \n\tWorking directory: '${process.cwd()}'\n\tPattern: '${globPattern}'`);
-    }
-    return result;
+    return glob_1.glob.sync(globPattern, { nodir: true });
 }
+exports.expandToFileSet = expandToFileSet;

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

@@ -39,13 +39,19 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
      * @param sourcePattern - A pattern to restrict the instrumentation to only a fraction of the task element.
      */
     instrumentOne(collector: CollectorSpecifier, taskElement: TaskElement, sourcePattern: OriginSourcePattern): TaskResult;
+    /**
+     * 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.
+     * @param sourceFile - The bundle file name.
+     * @param originSourceFiles - The list of files that were transpiled into the bundle.
      */
     private shouldExcludeFromInstrumentation;
     /**
@@ -65,3 +71,4 @@ export declare class IstanbulInstrumenter implements IInstrumenter {
      */
     private loadInputSourceMap;
 }
+//# sourceMappingURL=Instrumenter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EAEnB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAOhB,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,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;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAW1D;;;;;;OAMG;IACH,aAAa,CACZ,SAAS,EAAE,kBAAkB,EAC7B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,mBAAmB,GAChC,UAAU;IAuFb;;;;OAIG;IACH,OAAO,CAAC,WAAW;IASnB;;;;;;;OAOG;IACH,OAAO,CAAC,gCAAgC;IAQxC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAK3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAcpC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;CAW1B"}