@teamscale/coverage-collector 0.0.1-alpha.18 → 0.0.1-beta.3

package/README.md

@@ -19,9 +19,10 @@ information back to the original source code.
 ## Building
 
 The Collector 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
 ```

package/dist/package.json

@@ -1,23 +1,27 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.0.1-alpha.18",
+    "version": "0.0.1-beta.3",
     "description": "Collector for JavaScript code coverage information",
-    "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": "npx rimraf dist tsconfig.tsbuildinfo",
+        "clean": "rimraf dist tsconfig.tsbuildinfo",
         "build": "tsc",
-        "serve": "node dist/main.js",
-        "test": "yarn build && jest --forceExit --coverage --silent=true"
+        "serve": "node dist/src/main.js",
+        "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
     },
     "files": [
         "dist/**/*"
     ],
     "dependencies": {
-        "@cqse/commons": "workspace:*",
+        "@cqse/commons": "^0.0.1-beta.1",
         "argparse": "^2.0.1",
         "async": "^3.2.0",
         "rxjs": "^7.1.0",
@@ -37,7 +41,9 @@
         "@types/winston": "^2.4.4",
         "@types/ws": "^7.4.2",
         "babel-jest": "^27.2.0",
+        "esbuild": "^0.13.4",
         "jest": "^27.2.0",
+        "rimraf": "^3.0.2",
         "ts-jest": "^27.0.5",
         "ts-node": "^10.2.1",
         "typescript": "^4.4.3"

package/dist/src/main.js

@@ -1,25 +1,33 @@
 #!/usr/bin/env node
-import { version } from '../package.json';
-import { ArgumentParser } from 'argparse';
-import winston from 'winston';
-import { DataStorage } from './storage/DataStorage';
-import { WebSocketCollectingServer } from './receiver/CollectingServer';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Main = void 0;
+const package_json_1 = require("../package.json");
+const argparse_1 = require("argparse");
+const winston_1 = __importDefault(require("winston"));
+const DataStorage_1 = require("./storage/DataStorage");
+const CollectingServer_1 = require("./receiver/CollectingServer");
 /**
  * The main class of the Teamscale JavaScript Collector.
  * Used to start-up the collector for with a given configuration.
  */
-export class Main {
+class Main {
     /**
      * Construct the object for parsing the command line arguments.
      */
     static buildParser() {
-        const parser = new ArgumentParser({
+        const parser = new argparse_1.ArgumentParser({
             description: 'Collector of the Teamscale JavaScript Profiler. Collects coverage information from a' +
                 '(headless) Web browser that executes code instrumented with our instrumenter.'
         });
-        parser.add_argument('-v', '--version', { action: 'version', version });
+        parser.add_argument('-v', '--version', { action: 'version', version: package_json_1.version });
         parser.add_argument('-p', '--port', { help: 'The port to receive coverage information on.', default: 54678 });
         parser.add_argument('-f', '--dump-to-file', { help: 'Target file', default: './coverage.simple' });
+        parser.add_argument('-l', '--log-to-file', { help: 'Log file', default: 'logs/collector-combined.log' });
+        parser.add_argument('-e', '--log-level', { help: 'Log level', default: 'info' });
         parser.add_argument('-s', '--dump-after-secs', {
             help: 'Dump the coverage information to the target file every N seconds.',
             default: 120
@@ -40,15 +48,15 @@ export class Main {
     /**
      * Construct the logger.
      */
-    static buildLogger() {
-        return winston.createLogger({
-            level: 'info',
-            format: winston.format.json(),
+    static buildLogger(config) {
+        return winston_1.default.createLogger({
+            level: config.log_level,
+            format: winston_1.default.format.json(),
             defaultMeta: {},
             transports: [
-                new winston.transports.File({ filename: 'logs/collector-error.log', level: 'error' }),
-                new winston.transports.File({ filename: 'logs/collector-combined.log' }),
-                new winston.transports.Console({ format: winston.format.simple(), level: 'info' })
+                new winston_1.default.transports.File({ filename: 'logs/collector-error.log', level: 'error' }),
+                new winston_1.default.transports.File({ filename: config.log_to_file.trim() }),
+                new winston_1.default.transports.Console({ format: winston_1.default.format.simple(), level: config.log_level })
             ]
         });
     }
@@ -56,13 +64,15 @@ export class Main {
      * Entry point of the Teamscale JavaScript Profiler.
      */
     static run() {
-        const logger = this.buildLogger();
-        logger.info(`Starting collector in working directory "${process.cwd()}".`);
         // Parse the command line arguments
         const config = this.parseArguments();
+        // Build the logger
+        const logger = this.buildLogger(config);
+        logger.info(`Starting collector in working directory "${process.cwd()}".`);
+        logger.info(`Logging "${config.log_level}" to "${config.log_to_file}".`);
         // Prepare the storage and the server
-        const storage = new DataStorage(logger);
-        const server = new WebSocketCollectingServer(config.port, storage, logger);
+        const storage = new DataStorage_1.DataStorage(logger);
+        const server = new CollectingServer_1.WebSocketCollectingServer(config.port, storage, logger);
         // Start the server socket.
         // ATTENTION: The server is executed asynchronously
         server.start();
@@ -98,10 +108,11 @@ export class Main {
                     clearInterval(timer);
                 }
                 // ... and do a final dump
-                logger.info('\nCaught interrupt signal. Writing latest coverage.');
-                storage.dumpToSimpleCoverageFile(config.dump_to_file);
+                const written = storage.dumpToSimpleCoverageFile(config.dump_to_file);
+                logger.info(`\nCaught interrupt signal. Written ${written} lines of the latest coverage.`);
             });
         }
     }
 }
+exports.Main = Main;
 Main.run();

package/dist/src/receiver/CollectingServer.js

@@ -1,17 +1,39 @@
-import * as WebSocket from 'ws';
-import { Contract } from '@cqse/commons';
-import { Session } from './Session';
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketCollectingServer = exports.ProtocolMessageTypes = void 0;
+const WebSocket = __importStar(require("ws"));
+const commons_1 = require("@cqse/commons");
+const Session_1 = require("./Session");
 /**
  * Various constants that are used to exchange data between
  * the instrumented application and the coverage collector.
  */
-export var ProtocolMessageTypes;
+var ProtocolMessageTypes;
 (function (ProtocolMessageTypes) {
     /** A message that provides a source map */
     ProtocolMessageTypes["TYPE_SOURCEMAP"] = "s";
     /** A message that provides coverage information */
     ProtocolMessageTypes["TYPE_COVERAGE"] = "c";
-})(ProtocolMessageTypes || (ProtocolMessageTypes = {}));
+})(ProtocolMessageTypes = exports.ProtocolMessageTypes || (exports.ProtocolMessageTypes = {}));
 /**
  * Separates the instrumentation subject from the coverage information.
  */
@@ -20,7 +42,7 @@ const INSTRUMENTATION_SUBJECT_SEPARATOR = ':';
  * A WebSocket based implementation of a coverage receiver.
  * Receives coverage from instrumented JavaScript code.
  */
-export class WebSocketCollectingServer {
+class WebSocketCollectingServer {
     /**
      * Constructor.
      *
@@ -29,9 +51,9 @@ export class WebSocketCollectingServer {
      * @param logger - The logger to use.
      */
     constructor(port, storage, logger) {
-        Contract.require(port > 0 && port < 65536, 'Port must be valid (range).');
-        this.storage = Contract.requireDefined(storage);
-        this.logger = Contract.requireDefined(logger);
+        commons_1.Contract.require(port > 0 && port < 65536, 'Port must be valid (range).');
+        this.storage = commons_1.Contract.requireDefined(storage);
+        this.logger = commons_1.Contract.requireDefined(logger);
         this.server = new WebSocket.Server({ port: port });
     }
     /**
@@ -41,7 +63,7 @@ export class WebSocketCollectingServer {
         this.logger.info(`Starting server on port ${this.server.options.port}.`);
         // Handle new connections from clients
         this.server.on('connection', (webSocket, req) => {
-            let session = new Session(req.socket, this.storage, this.logger);
+            let session = new Session_1.Session(req.socket, this.storage, this.logger);
             this.logger.debug(`Connection from: ${req.socket.remoteAddress}`);
             // Handle disconnecting clients
             webSocket.on('close', code => {
@@ -94,6 +116,7 @@ export class WebSocketCollectingServer {
         const fileIdSeparatorPosition = body.indexOf(INSTRUMENTATION_SUBJECT_SEPARATOR);
         if (fileIdSeparatorPosition > -1) {
             const fileId = body.substring(0, fileIdSeparatorPosition).trim();
+            this.logger.debug(`Received source map information for ${fileId}`);
             const sourcemap = body.substring(fileIdSeparatorPosition + 1);
             session.putSourcemap(fileId, sourcemap);
         }
@@ -118,3 +141,4 @@ export class WebSocketCollectingServer {
         }
     }
 }
+exports.WebSocketCollectingServer = WebSocketCollectingServer;

package/dist/src/receiver/Session.js

@@ -1,11 +1,33 @@
-import * as sourceMap from 'source-map';
-import { Contract } from '@cqse/commons';
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = void 0;
+const sourceMap = __importStar(require("source-map"));
+const commons_1 = require("@cqse/commons");
 /**
  * The session maintains the relevant information for a client.
  * One session is created for each client.
  * The mapping based on sourcemaps is conducted here.
  */
-export class Session {
+class Session {
     /**
      * Constructor
      *
@@ -14,9 +36,9 @@ export class Session {
      * @param logger - The logger to use.
      */
     constructor(socket, storage, logger) {
-        this.socket = Contract.requireDefined(socket);
-        this.storage = Contract.requireDefined(storage);
-        this.logger = Contract.requireDefined(logger);
+        this.socket = commons_1.Contract.requireDefined(socket);
+        this.storage = commons_1.Contract.requireDefined(storage);
+        this.logger = commons_1.Contract.requireDefined(logger);
         this.sourceMaps = new Map();
         this.projectId = ''; // We currently only support coverage for one project.
     }
@@ -84,3 +106,4 @@ export class Session {
         }
     }
 }
+exports.Session = Session;

package/dist/src/storage/DataStorage.d.ts

@@ -94,6 +94,10 @@ export declare class DataStorage implements IDataStorage {
      * Logger to use.
      */
     private readonly logger;
+    /**
+     * Times unmapped coverage received.
+     */
+    private timesUnmappedCoverage;
     /**
      * Constructs the data storage.
      *

package/dist/src/storage/DataStorage.js

@@ -1,16 +1,38 @@
-import { Contract, removePrefix } from '@cqse/commons';
-import * as fs from 'fs';
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataStorage = exports.ProjectCoverage = void 0;
+const commons_1 = require("@cqse/commons");
+const fs = __importStar(require("fs"));
 /**
  * The coverage information received for one particular project.
  */
-export class ProjectCoverage {
+class ProjectCoverage {
     /**
      * Constructor.
      *
      * @param projectId - The identifier of the project to collect the coverage for.
      */
     constructor(projectId) {
-        this.projectId = Contract.requireDefined(projectId);
+        this.projectId = commons_1.Contract.requireDefined(projectId);
         this.coveredLinesByFile = new Map();
     }
     /**
@@ -44,10 +66,11 @@ export class ProjectCoverage {
         });
     }
 }
+exports.ProjectCoverage = ProjectCoverage;
 /**
  * The data storage which retrieves coverage information.
  */
-export class DataStorage {
+class DataStorage {
     /**
      * Constructs the data storage.
      *
@@ -55,7 +78,8 @@ export class DataStorage {
      */
     constructor(logger) {
         this.coverageByProject = new Map();
-        this.logger = Contract.requireDefined(logger);
+        this.logger = commons_1.Contract.requireDefined(logger);
+        this.timesUnmappedCoverage = 0;
     }
     /**
      * Put coverage into the storage.
@@ -81,14 +105,17 @@ export class DataStorage {
      * @param sourceFile - The file name to normalize, produced by the instrumenter.
      */
     normalizeSourceFileName(sourceFile) {
-        return removePrefix('webpack:///', sourceFile.replace('\\', '/'));
+        return (0, commons_1.removePrefix)('webpack:///', sourceFile.replace('\\', '/'));
     }
     /**
      * {@inheritDoc IWriteableStorage.signalUnmappedCoverage}
      */
     signalUnmappedCoverage(project) {
         // Currently only implemented to log the missing information.
-        this.logger.debug(`Received unmapped coverage for ${project}`);
+        this.timesUnmappedCoverage++;
+        if (this.timesUnmappedCoverage === 1) {
+            this.logger.debug(`Received unmapped coverage for project "${project}"`);
+        }
     }
     /**
      * {@inheritDoc IReadableStorage.getCoverageBySourceFile}
@@ -103,7 +130,7 @@ export class DataStorage {
     dumpToSimpleCoverageFile(filePath) {
         const toSimpleCoverage = () => {
             const result = [];
-            Contract.require(this.getProjects().length < 2, 'Only one project supported to be handled in parallel.');
+            commons_1.Contract.require(this.getProjects().length < 2, 'Only one project supported to be handled in parallel.');
             for (const project of this.getProjects()) {
                 const projectCoverage = this.getCoverageBySourceFile(project);
                 if (!projectCoverage) {
@@ -119,7 +146,7 @@ export class DataStorage {
             return [result.length, result.join('\n')];
         };
         const [lines, content] = toSimpleCoverage();
-        fs.writeFileSync(filePath, content, 'utf8');
+        fs.writeFileSync(filePath.trim(), content, { flag: 'w', encoding: 'utf8' });
         return lines;
     }
     /**
@@ -129,3 +156,4 @@ export class DataStorage {
         return Array.from(this.coverageByProject.keys());
     }
 }
+exports.DataStorage = DataStorage;

package/package.json

@@ -1,23 +1,27 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.0.1-alpha.18",
+  "version": "0.0.1-beta.3",
   "description": "Collector for JavaScript code coverage information",
-  "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": "npx rimraf dist tsconfig.tsbuildinfo",
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
     "build": "tsc",
-    "serve": "node dist/main.js",
-    "test": "yarn build && jest --forceExit --coverage --silent=true"
+    "serve": "node dist/src/main.js",
+    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
   },
   "files": [
     "dist/**/*"
   ],
   "dependencies": {
-    "@cqse/commons": "workspace:*",
+    "@cqse/commons": "^0.0.1-beta.1",
     "argparse": "^2.0.1",
     "async": "^3.2.0",
     "rxjs": "^7.1.0",
@@ -37,7 +41,9 @@
     "@types/winston": "^2.4.4",
     "@types/ws": "^7.4.2",
     "babel-jest": "^27.2.0",
+    "esbuild": "^0.13.4",
     "jest": "^27.2.0",
+    "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",
     "typescript": "^4.4.3"

package/dist/main.d.ts

@@ -1,31 +0,0 @@
-#!/usr/bin/env node
-/**
- * The main class of the Teamscale JavaScript Collector.
- * Used to start-up the collector for with a given configuration.
- */
-export declare class Main {
-    /**
-     * Construct the object for parsing the command line arguments.
-     */
-    private static buildParser;
-    /**
-     * Parse the given command line arguments into a corresponding options object.
-     */
-    private static parseArguments;
-    /**
-     * Construct the logger.
-     */
-    private static buildLogger;
-    /**
-     * Entry point of the Teamscale JavaScript Profiler.
-     */
-    static run(): void;
-    /**
-     * Start a timer for dumping the data, depending on the configuration.
-     *
-     * @param config - The config that determines whether or not to do the timed dump.
-     * @param storage - The storage with the information to dump.
-     * @param logger - The logger to use.
-     */
-    private static maybeStartDumpTimer;
-}

package/dist/main.js

@@ -1,112 +0,0 @@
-#!/usr/bin/env node
-import { ArgumentParser } from 'argparse';
-import { WebSocketCollectingServer } from './receiver/CollectingServer';
-import { DataStorage } from './storage/DataStorage';
-import { setInterval } from 'timers';
-import * as winston from 'winston';
-const { version } = require('../package.json');
-/**
- * The main class of the Teamscale JavaScript Collector.
- * Used to start-up the collector for with a given configuration.
- */
-export class Main {
-    /**
-     * Construct the object for parsing the command line arguments.
-     */
-    static buildParser() {
-        const parser = new ArgumentParser({
-            description: 'Collector of the Teamscale JavaScript Profiler. Collects coverage information from a' +
-                '(headless) Web browser that executes code instrumented with our instrumenter.'
-        });
-        parser.add_argument('-v', '--version', { action: 'version', version });
-        parser.add_argument('-p', '--port', { help: 'The port to receive coverage information on.', default: 54678 });
-        parser.add_argument('-f', '--dump-to-file', { help: 'Target file', default: './coverage.simple' });
-        parser.add_argument('-s', '--dump-after-secs', {
-            help: 'Dump the coverage information to the target file every N seconds.',
-            default: 120
-        });
-        parser.add_argument('-d', '--debug', {
-            help: 'Print received coverage information to the terminal?',
-            default: false
-        });
-        return parser;
-    }
-    /**
-     * Parse the given command line arguments into a corresponding options object.
-     */
-    static parseArguments() {
-        const parser = this.buildParser();
-        return parser.parse_args();
-    }
-    /**
-     * Construct the logger.
-     */
-    static buildLogger() {
-        return winston.createLogger({
-            level: 'info',
-            format: winston.format.json(),
-            defaultMeta: {},
-            transports: [
-                //
-                // - Write all logs with level `error` and below to `error.log`
-                // - Write all logs with level `info` and below to `combined.log`
-                //
-                new winston.transports.File({ filename: 'logs/collector-error.log', level: 'error' }),
-                new winston.transports.File({ filename: 'logs/collector-combined.log' }),
-                new winston.transports.Console({ format: winston.format.simple(), level: 'info' })
-            ]
-        });
-    }
-    /**
-     * Entry point of the Teamscale JavaScript Profiler.
-     */
-    static run() {
-        const logger = this.buildLogger();
-        logger.info(`Starting collector in working directory "${process.cwd()}".`);
-        // Parse the command line arguments
-        const config = this.parseArguments();
-        // Prepare the storage and the server
-        const storage = new DataStorage(logger);
-        const server = new WebSocketCollectingServer(config.port, storage, logger);
-        // Start the server socket.
-        // ATTENTION: The server is executed asynchronously
-        server.start();
-        // Optionally, start a timer that dumps the coverage after a N seconds
-        this.maybeStartDumpTimer(config, storage, logger);
-        // Say bye bye on CTRL+C and exit the process
-        process.on('SIGINT', () => {
-            logger.info('Bye bye.');
-            process.exit();
-        });
-    }
-    /**
-     * Start a timer for dumping the data, depending on the configuration.
-     *
-     * @param config - The config that determines whether or not to do the timed dump.
-     * @param storage - The storage with the information to dump.
-     * @param logger - The logger to use.
-     */
-    static maybeStartDumpTimer(config, storage, logger) {
-        if (config.dump_after_secs > 0) {
-            const timer = setInterval(() => {
-                try {
-                    const lines = storage.dumpToSimpleCoverageFile(config.dump_to_file);
-                    logger.info(`Conducted periodic coverage dump with ${lines} lines to ${config.dump_to_file}.`);
-                }
-                catch (e) {
-                    logger.error('Timed coverage dump failed.', e);
-                }
-            }, config.dump_after_secs * 1000);
-            process.on('SIGINT', () => {
-                // Stop the timed file dump
-                if (timer) {
-                    clearInterval(timer);
-                }
-                // ... and do a final dump
-                logger.info('\nCaught interrupt signal. Writing latest coverage.');
-                storage.dumpToSimpleCoverageFile(config.dump_to_file);
-            });
-        }
-    }
-}
-Main.run();

package/dist/receiver/CollectingServer.d.ts

@@ -1,63 +0,0 @@
-import { IDataStorage } from '../storage/DataStorage';
-import { Logger } from 'winston';
-/**
- * Various constants that are used to exchange data between
- * the instrumented application and the coverage collector.
- */
-export declare enum ProtocolMessageTypes {
-    /** A message that provides a source map */
-    TYPE_SOURCEMAP = "s",
-    /** A message that provides coverage information */
-    TYPE_COVERAGE = "c"
-}
-/**
- * A WebSocket based implementation of a coverage receiver.
- * Receives coverage from instrumented JavaScript code.
- */
-export declare class WebSocketCollectingServer {
-    /**
-     * The WebSocket server component.
-     */
-    private readonly server;
-    /**
-     * The storage to put the received coverage information to for aggregation and further processing.
-     */
-    private readonly storage;
-    /**
-     * The logger to use.
-     */
-    private readonly logger;
-    /**
-     * Constructor.
-     *
-     * @param port - The port the WebSocket server should listen on.
-     * @param storage - The storage to put the received coverage information to.
-     * @param logger - The logger to use.
-     */
-    constructor(port: number, storage: IDataStorage, logger: Logger);
-    /**
-     * Start the server socket, handle sessions and dispatch messages.
-     */
-    start(): void;
-    /**
-     * Handle a message from a client.
-     *
-     * @param session - The session that has been started for the client.
-     * @param message - The message to handle.
-     */
-    private handleMessage;
-    /**
-     * Handle a source map message.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     */
-    private handleSourcemapMessage;
-    /**
-     * Handle a message with coverage information.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     */
-    private handleCoverageMessage;
-}

package/dist/receiver/CollectingServer.js

@@ -1,120 +0,0 @@
-import * as WebSocket from 'ws';
-import { Contract } from '@cqse/commons';
-import { Session } from './Session';
-/**
- * Various constants that are used to exchange data between
- * the instrumented application and the coverage collector.
- */
-export var ProtocolMessageTypes;
-(function (ProtocolMessageTypes) {
-    /** A message that provides a source map */
-    ProtocolMessageTypes["TYPE_SOURCEMAP"] = "s";
-    /** A message that provides coverage information */
-    ProtocolMessageTypes["TYPE_COVERAGE"] = "c";
-})(ProtocolMessageTypes || (ProtocolMessageTypes = {}));
-/**
- * Separates the instrumentation subject from the coverage information.
- */
-const INSTRUMENTATION_SUBJECT_SEPARATOR = ':';
-/**
- * A WebSocket based implementation of a coverage receiver.
- * Receives coverage from instrumented JavaScript code.
- */
-export class WebSocketCollectingServer {
-    /**
-     * Constructor.
-     *
-     * @param port - The port the WebSocket server should listen on.
-     * @param storage - The storage to put the received coverage information to.
-     * @param logger - The logger to use.
-     */
-    constructor(port, storage, logger) {
-        Contract.require(port > 0 && port < 65536, 'Port must be valid (range).');
-        this.storage = Contract.requireDefined(storage);
-        this.logger = Contract.requireDefined(logger);
-        this.server = new WebSocket.Server({ port: port });
-    }
-    /**
-     * Start the server socket, handle sessions and dispatch messages.
-     */
-    start() {
-        this.logger.info(`Starting server on port ${this.server.options.port}.`);
-        // Handle new connections from clients
-        this.server.on('connection', (webSocket, req) => {
-            let session = new Session(req.socket, this.storage, this.logger);
-            this.logger.debug(`Connection from: ${req.socket.remoteAddress}`);
-            // Handle disconnecting clients
-            webSocket.on('close', code => {
-                if (session) {
-                    // Free the memory that is associated with the session (important!)
-                    session.destroy();
-                    session = null;
-                    this.logger.debug(`Closing with code ${code}`);
-                }
-            });
-            // Handle incoming messages
-            webSocket.on('message', (message) => {
-                if (session && typeof message === 'string') {
-                    this.handleMessage(session, message);
-                }
-            });
-            // Handle errors
-            webSocket.on('error', (e) => {
-                this.logger.error('Error on server socket triggered.', e);
-            });
-        });
-    }
-    /**
-     * Handle a message from a client.
-     *
-     * @param session - The session that has been started for the client.
-     * @param message - The message to handle.
-     */
-    handleMessage(session, message) {
-        try {
-            if (message.startsWith(ProtocolMessageTypes.TYPE_SOURCEMAP)) {
-                this.handleSourcemapMessage(session, message.substring(1));
-            }
-            else if (message.startsWith(ProtocolMessageTypes.TYPE_COVERAGE)) {
-                this.handleCoverageMessage(session, message.substring(1));
-            }
-        }
-        catch (e) {
-            this.logger.error(`Error while processing message starting with ${message.substring(0, Math.min(50, message.length))}`);
-            this.logger.error(e.message);
-        }
-    }
-    /**
-     * Handle a source map message.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     */
-    handleSourcemapMessage(session, body) {
-        const fileIdSeparatorPosition = body.indexOf(INSTRUMENTATION_SUBJECT_SEPARATOR);
-        if (fileIdSeparatorPosition > -1) {
-            const fileId = body.substring(0, fileIdSeparatorPosition).trim();
-            const sourcemap = body.substring(fileIdSeparatorPosition + 1);
-            session.putSourcemap(fileId, sourcemap);
-        }
-    }
-    /**
-     * Handle a message with coverage information.
-     *
-     * @param session - The session to handle the message for.
-     * @param body - The body of the message (to be parsed).
-     */
-    handleCoverageMessage(session, body) {
-        var _a;
-        const bodyPattern = /(?<fileId>\S+) (?<positions>((\d+:\d+)\s+)*(\d+:\d+))/;
-        const matches = bodyPattern.exec(body);
-        if (matches === null || matches === void 0 ? void 0 : matches.groups) {
-            const fileId = matches.groups['fileId'];
-            const positions = ((_a = matches.groups['positions']) !== null && _a !== void 0 ? _a : '').split(/\s+/);
-            for (const position of positions) {
-                const [line, column] = position.split(':');
-                session.putCoverage(fileId, Number.parseInt(line), Number.parseInt(column));
-            }
-        }
-    }
-}

package/dist/receiver/Session.d.ts

@@ -1,70 +0,0 @@
-/// <reference types="node" />
-import { Socket } from 'net';
-import { IDataStorage } from '../storage/DataStorage';
-import { Logger } from 'winston';
-/**
- * The session maintains the relevant information for a client.
- * One session is created for each client.
- * The mapping based on sourcemaps is conducted here.
- */
-export declare class Session {
-    /**
-     * The client socket.
-     */
-    private readonly socket;
-    /**
-     * The storage to forward coverage information to for aggregation.
-     */
-    private readonly storage;
-    /**
-     * One browser window can load multiple source files, with different
-     * source maps. However, there might be only one socket to this
-     * server per browser window.
-     */
-    private readonly sourceMaps;
-    /**
-     * The logger to use.
-     */
-    private readonly logger;
-    /**
-     * The project the coverage information is for.
-     */
-    private readonly projectId;
-    /**
-     * Constructor
-     *
-     * @param socket - The client socket.
-     * @param storage - The storage to store and aggregate coverage information in.
-     * @param logger - The logger to use.
-     */
-    constructor(socket: Socket, storage: IDataStorage, logger: Logger);
-    /**
-     * Put coverage information to the storage for aggregation.
-     * This method also conducts the mapping based on the source map.
-     *
-     * @param fileId - The identifier of the instrumented bundle (file).
-     * @param line - The line number within the bundle.
-     * @param column - The column within the bundle.
-     */
-    putCoverage(fileId: string, line: number, column: number): void;
-    /**
-     * Map to the original file position.
-     *
-     * @param fileId - The identifier of the instrumented bundle.
-     * @param line - The line within the bundle.
-     * @param column - The column within the bundle.
-     */
-    private mapToOriginal;
-    /**
-     * Receives the source map and stores it to the session.
-     *
-     * @param fileId - The identifier of the file bundle.
-     * @param sourceMapText - The actual source map.
-     */
-    putSourcemap(fileId: string, sourceMapText: string): void;
-    /**
-     * Destroy the session and free the memory it allocates.
-     * In particular the sourcemaps are freed (important to not run out of memory!).
-     */
-    destroy(): void;
-}

package/dist/receiver/Session.js

@@ -1,86 +0,0 @@
-import * as sourceMap from 'source-map';
-import { Contract } from '@cqse/commons';
-/**
- * The session maintains the relevant information for a client.
- * One session is created for each client.
- * The mapping based on sourcemaps is conducted here.
- */
-export class Session {
-    /**
-     * Constructor
-     *
-     * @param socket - The client socket.
-     * @param storage - The storage to store and aggregate coverage information in.
-     * @param logger - The logger to use.
-     */
-    constructor(socket, storage, logger) {
-        this.socket = Contract.requireDefined(socket);
-        this.storage = Contract.requireDefined(storage);
-        this.logger = Contract.requireDefined(logger);
-        this.sourceMaps = new Map();
-        this.projectId = ''; // We currently only support coverage for one project.
-    }
-    /**
-     * Put coverage information to the storage for aggregation.
-     * This method also conducts the mapping based on the source map.
-     *
-     * @param fileId - The identifier of the instrumented bundle (file).
-     * @param line - The line number within the bundle.
-     * @param column - The column within the bundle.
-     */
-    putCoverage(fileId, line, column) {
-        const originalPosition = this.mapToOriginal(fileId, line, column);
-        if (originalPosition.line && originalPosition.source) {
-            this.storage.putCoverage(this.projectId, originalPosition.source, [originalPosition.line]);
-        }
-        else {
-            this.storage.signalUnmappedCoverage(this.projectId);
-        }
-    }
-    /**
-     * Map to the original file position.
-     *
-     * @param fileId - The identifier of the instrumented bundle.
-     * @param line - The line within the bundle.
-     * @param column - The column within the bundle.
-     */
-    mapToOriginal(fileId, line, column) {
-        const sourceMap = this.sourceMaps.get(fileId);
-        if (sourceMap) {
-            const position = { line, column };
-            return sourceMap.originalPositionFor(position);
-        }
-        else {
-            return { line, column, source: null, name: null };
-        }
-    }
-    /**
-     * Receives the source map and stores it to the session.
-     *
-     * @param fileId - The identifier of the file bundle.
-     * @param sourceMapText - The actual source map.
-     */
-    putSourcemap(fileId, sourceMapText) {
-        const rawSourceMap = JSON.parse(sourceMapText);
-        new sourceMap.SourceMapConsumer(rawSourceMap)
-            .then(consumer => {
-            this.sourceMaps.set(fileId, consumer);
-        })
-            .catch(e => {
-            this.logger.error(`Consuming source map failed! ${e}`);
-        });
-    }
-    /**
-     * Destroy the session and free the memory it allocates.
-     * In particular the sourcemaps are freed (important to not run out of memory!).
-     */
-    destroy() {
-        for (const key of Array.from(this.sourceMaps.keys())) {
-            const value = this.sourceMaps.get(key);
-            if (value) {
-                value.destroy();
-                this.sourceMaps.delete(key);
-            }
-        }
-    }
-}

package/dist/storage/CoveragePersiterBase.d.ts

@@ -1,6 +0,0 @@
-import { IDataStorage } from "./DataStorage";
-export declare abstract class CoveragePersisterBase {
-    protected readonly _storage: IDataStorage;
-    constructor(storage: IDataStorage);
-    abstract finalizePerstistence(): void;
-}

package/dist/storage/CoveragePersiterBase.js

@@ -1,10 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.CoveragePersisterBase = void 0;
-const common_qualities_1 = require('@cqse/commons');
-class CoveragePersisterBase {
-	constructor(storage) {
-		this._storage = common_qualities_1.Contract.requireDefined(storage);
-	}
-}
-exports.CoveragePersisterBase = CoveragePersisterBase;

package/dist/storage/DataStorage.d.ts

@@ -1,134 +0,0 @@
-import { Logger } from 'winston';
-/**
- * Lines covered for the specified file.
- */
-export declare type FileCoverage = {
-    /** Name of the file in the origin */
-    sourceFile: string;
-    /** Lines covered */
-    coveredLines: Set<number>;
-};
-/**
- * Storage interface for reading information.
- */
-export interface IReadableStorage {
-    /**
-     * The list of projects the collector received coverage information for.
-     */
-    getProjects(): string[];
-    /**
-     * Retrieve the projects' coverage by source file.
-     */
-    getCoverageBySourceFile(project: string): IterableIterator<FileCoverage> | undefined;
-    /**
-     * Write the coverage to the specified file.
-     *
-     * @param filePath - Full path of the file to write the coverage to.
-     */
-    dumpToSimpleCoverageFile(filePath: string): void;
-}
-/**
- * Storage interface for writing information.
- */
-export interface IWriteableStorage {
-    /**
-     * Add coverage information to the storage.
-     *
-     * @param project - The project to add the information to.
-     * @param sourceFilePath - The file for that lines are covered.
-     * @param coveredOriginalLines - The covered lines.
-     */
-    putCoverage(project: string, sourceFilePath: string, coveredOriginalLines: number[]): void;
-    /**
-     * Signals that we have received coverage information
-     * for that no mapping based on sourcemaps was possible.
-     *
-     * @param project - The project to add the information to.
-     */
-    signalUnmappedCoverage(project: string): void;
-}
-/**
- * Union of write and read interface.
- */
-export interface IDataStorage extends IReadableStorage, IWriteableStorage {
-}
-/**
- * The coverage information received for one particular project.
- */
-export declare class ProjectCoverage {
-    /**
-     * The identifier of the project.
-     */
-    private readonly projectId;
-    /**
-     * The coverage.
-     */
-    private readonly coveredLinesByFile;
-    /**
-     * Constructor.
-     *
-     * @param projectId - The identifier of the project to collect the coverage for.
-     */
-    constructor(projectId: string);
-    /**
-     * Put coverage for a single line to the storage.
-     *
-     * @param sourceFile - The file in that the line is covered.
-     * @param line - The line number.
-     */
-    putLine(sourceFile: string, line: number): void;
-    /**
-     * Returns an iterator over the projects' coverage.
-     */
-    getCoverage(): IterableIterator<FileCoverage>;
-}
-/**
- * The data storage which retrieves coverage information.
- */
-export declare class DataStorage implements IDataStorage {
-    /**
-     * Coverage information by project.
-     */
-    private readonly coverageByProject;
-    /**
-     * Logger to use.
-     */
-    private readonly logger;
-    /**
-     * Constructs the data storage.
-     *
-     * @param logger - The logger to use.
-     */
-    constructor(logger: Logger);
-    /**
-     * Put coverage into the storage.
-     *
-     * @param project - The project to add it to.
-     * @param sourceFilePath - The covered file.
-     * @param coveredOriginalLines - The lines covered in the file.
-     */
-    putCoverage(project: string, sourceFilePath: string, coveredOriginalLines: number[]): void;
-    /**
-     * Normalize the source file names provided by the Web browsers / from the
-     * instrumentation such that they can be matched to the original source code by Teamscale.
-     *
-     * @param sourceFile - The file name to normalize, produced by the instrumenter.
-     */
-    private normalizeSourceFileName;
-    /**
-     * {@inheritDoc IWriteableStorage.signalUnmappedCoverage}
-     */
-    signalUnmappedCoverage(project: string): void;
-    /**
-     * {@inheritDoc IReadableStorage.getCoverageBySourceFile}
-     */
-    getCoverageBySourceFile(project: string): IterableIterator<FileCoverage> | undefined;
-    /**
-     * {@inheritDoc IReadableStorage.writeToSimpleCoverageFile}
-     */
-    dumpToSimpleCoverageFile(filePath: string): number;
-    /**
-     * {@inheritDoc IReadableStorage.getProjects}
-     */
-    getProjects(): string[];
-}

package/dist/storage/DataStorage.js

@@ -1,130 +0,0 @@
-import { Contract, removePrefix } from '@cqse/commons';
-import * as fs from 'fs';
-/**
- * The coverage information received for one particular project.
- */
-export class ProjectCoverage {
-    /**
-     * Constructor.
-     *
-     * @param projectId - The identifier of the project to collect the coverage for.
-     */
-    constructor(projectId) {
-        this.projectId = Contract.requireDefined(projectId);
-        this.coveredLinesByFile = new Map();
-    }
-    /**
-     * Put coverage for a single line to the storage.
-     *
-     * @param sourceFile - The file in that the line is covered.
-     * @param line - The line number.
-     */
-    putLine(sourceFile, line) {
-        let targetSet = this.coveredLinesByFile.get(sourceFile);
-        if (!targetSet) {
-            targetSet = new Set();
-            this.coveredLinesByFile.set(sourceFile, targetSet);
-        }
-        targetSet.add(line);
-    }
-    /**
-     * Returns an iterator over the projects' coverage.
-     */
-    getCoverage() {
-        function* iterate(iterable, transform) {
-            for (const e of iterable) {
-                yield transform(e);
-            }
-        }
-        return iterate(this.coveredLinesByFile.entries(), ([file, lines]) => {
-            return {
-                sourceFile: file,
-                coveredLines: lines
-            };
-        });
-    }
-}
-/**
- * The data storage which retrieves coverage information.
- */
-export class DataStorage {
-    /**
-     * Constructs the data storage.
-     *
-     * @param logger - The logger to use.
-     */
-    constructor(logger) {
-        this.coverageByProject = new Map();
-        this.logger = Contract.requireDefined(logger);
-    }
-    /**
-     * Put coverage into the storage.
-     *
-     * @param project - The project to add it to.
-     * @param sourceFilePath - The covered file.
-     * @param coveredOriginalLines - The lines covered in the file.
-     */
-    putCoverage(project, sourceFilePath, coveredOriginalLines) {
-        const uniformPath = this.normalizeSourceFileName(sourceFilePath);
-        let projectCoverage = this.coverageByProject.get(project);
-        if (!projectCoverage) {
-            projectCoverage = new ProjectCoverage(project);
-            this.coverageByProject.set(project, projectCoverage);
-        }
-        coveredOriginalLines.forEach(line => projectCoverage === null || projectCoverage === void 0 ? void 0 : projectCoverage.putLine(sourceFilePath, line));
-        this.logger.debug(`Mapped Coverage: ${project} ${uniformPath} ${coveredOriginalLines}`);
-    }
-    /**
-     * Normalize the source file names provided by the Web browsers / from the
-     * instrumentation such that they can be matched to the original source code by Teamscale.
-     *
-     * @param sourceFile - The file name to normalize, produced by the instrumenter.
-     */
-    normalizeSourceFileName(sourceFile) {
-        return removePrefix('webpack:///', sourceFile.replace('\\', '/'));
-    }
-    /**
-     * {@inheritDoc IWriteableStorage.signalUnmappedCoverage}
-     */
-    signalUnmappedCoverage(project) {
-        // Currently not used.
-    }
-    /**
-     * {@inheritDoc IReadableStorage.getCoverageBySourceFile}
-     */
-    getCoverageBySourceFile(project) {
-        const projectCoverage = this.coverageByProject.get(project);
-        return projectCoverage === null || projectCoverage === void 0 ? void 0 : projectCoverage.getCoverage();
-    }
-    /**
-     * {@inheritDoc IReadableStorage.writeToSimpleCoverageFile}
-     */
-    dumpToSimpleCoverageFile(filePath) {
-        const toSimpleCoverage = () => {
-            const result = [];
-            Contract.require(this.getProjects().length < 2, 'Only one project supported to be handled in parallel.');
-            for (const project of this.getProjects()) {
-                const projectCoverage = this.getCoverageBySourceFile(project);
-                if (!projectCoverage) {
-                    return [0, ''];
-                }
-                for (const entry of projectCoverage) {
-                    result.push(this.normalizeSourceFileName(entry.sourceFile));
-                    for (const lineNo of entry.coveredLines) {
-                        result.push(String(lineNo));
-                    }
-                }
-            }
-            return [result.length, result.join('\n')];
-        };
-        const [lines, content] = toSimpleCoverage();
-        fs.writeFileSync(filePath, content, 'utf8');
-        return lines;
-    }
-    /**
-     * {@inheritDoc IReadableStorage.getProjects}
-     */
-    getProjects() {
-        return Array.from(this.coverageByProject.keys());
-    }
-}