@teamscale/coverage-collector 0.0.1-beta.33 → 0.0.1-beta.36

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.0.1-beta.33",
+    "version": "0.0.1-beta.36",
     "description": "Collector for JavaScript code coverage information",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",

package/dist/src/main.js

@@ -42,6 +42,8 @@ const util_1 = require("util");
 const tmp_1 = __importDefault(require("tmp"));
 const mkdirp_1 = __importDefault(require("mkdirp"));
 const path_1 = __importDefault(require("path"));
+const StdConsoleLogger_1 = require("./utils/StdConsoleLogger");
+const PrettyFileLogger_1 = require("./utils/PrettyFileLogger");
 /**
  * The main class of the Teamscale JavaScript Collector.
  * Used to start the collector for with a given configuration.
@@ -69,6 +71,10 @@ class Main {
             help: 'Print received coverage information to the terminal?',
             default: false
         });
+        parser.add_argument('-j', '--json-log', {
+            help: 'Additional JSON-like log file format.',
+            action: 'store_true'
+        });
         // Parameters for the upload to Teamscale
         parser.add_argument('-u', '--teamscale-server-url', {
             help: 'Upload the coverage to the given Teamscale server URL, for example, https://teamscale.dev.example.com:8080/production.',
@@ -122,22 +128,20 @@ class Main {
         const logfilePath = config.log_to_file.trim();
         mkdirp_1.default.sync(path_1.default.dirname(logfilePath));
         const logLevel = config.log_level;
-        return bunyan_1.default.createLogger({ name: "Instrumenter",
+        const logger = bunyan_1.default.createLogger({
+            name: 'Collector',
             streams: [
-                {
-                    level: logLevel,
-                    stream: {
-                        write: (rec) => {
-                            console.log('[%s] %s: %s', rec.time.toISOString(), bunyan_1.default.nameFromLevel[rec.level], rec.msg);
-                        }
-                    },
-                    type: 'raw'
-                },
-                {
-                    level: logLevel,
-                    path: logfilePath
-                }
-            ] });
+                // console output
+                { level: logLevel, stream: new StdConsoleLogger_1.StdConsoleLogger(), type: 'raw' },
+                // default log file
+                { level: logLevel, stream: new PrettyFileLogger_1.PrettyFileLogger(fs.createWriteStream(logfilePath)), type: 'raw' }
+            ]
+        });
+        // If the given flag is set, we also log with a JSON-like format
+        if (config.json_log) {
+            logger.addStream({ level: logLevel, path: `${logfilePath}.json` });
+        }
+        return logger;
     }
     /**
      * Entry point of the Teamscale JavaScript Profiler.

package/dist/src/receiver/CollectingServer.d.ts

@@ -1,5 +1,5 @@
 import { IDataStorage } from '../storage/DataStorage';
-import Logger from "bunyan";
+import Logger from 'bunyan';
 /**
  * Various constants that are used to exchange data between
  * the instrumented application and the coverage collector.

package/dist/src/receiver/CollectingServer.js

@@ -133,14 +133,19 @@ class WebSocketCollectingServer {
      */
     handleCoverageMessage(session, body) {
         var _a;
-        const bodyPattern = /(?<fileId>\S+) (?<positions>((\d+:\d+)\s+)*(\d+:\d+))/;
+        const bodyPattern = /(?<fileId>\S+) (?<positions>((\d+:\d+(:\d+:\d+)?\s+)*(\d+:\d+(:\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));
+                const positionParts = position.split(':');
+                if (positionParts.length === 2) {
+                    session.putCoverage(fileId, Number.parseInt(positionParts[0]), Number.parseInt(positionParts[1]), Number.parseInt(positionParts[1]), Number.parseInt(positionParts[2]));
+                }
+                else if (positionParts.length === 4) {
+                    session.putCoverage(fileId, Number.parseInt(positionParts[0]), Number.parseInt(positionParts[1]), Number.parseInt(positionParts[2]), Number.parseInt(positionParts[3]));
+                }
             }
         }
     }

package/dist/src/receiver/Session.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Socket } from 'net';
 import { IDataStorage } from '../storage/DataStorage';
-import Logger from "bunyan";
+import Logger from 'bunyan';
 /**
  * The session maintains the relevant information for a client.
  * One session is created for each client.
@@ -46,7 +46,7 @@ export declare class Session {
      * @param line - The line number within the bundle.
      * @param column - The column within the bundle.
      */
-    putCoverage(fileId: string, line: number, column: number): void;
+    putCoverage(fileId: string, startLine: number, startColumn: number, endLine: number, endColumn: number): void;
     /**
      * Map to the original file position.
      *

package/dist/src/receiver/Session.js

@@ -54,13 +54,50 @@ class Session {
      * @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);
+    putCoverage(fileId, startLine, startColumn, endLine, endColumn) {
+        var _a, _b;
+        // Iterate over the lines to scan
+        let line = startLine;
+        while (line <= endLine) {
+            // Determine the column range to consider for this line
+            let scanFromColumn;
+            if (line === startLine) {
+                scanFromColumn = startColumn;
+            }
+            else {
+                scanFromColumn = 0;
+            }
+            let scanToColumn;
+            if (line === endLine) {
+                scanToColumn = endColumn;
+            }
+            else {
+                // Since we do not know the length of the different lines, we assume
+                // all to end in the lager of `endColumn` and `startColumn`.
+                // A better estimate (or the correct value) is supposed to be implemented
+                // in context of TS-30077.
+                scanToColumn = Math.max(endColumn, startColumn);
+            }
+            let column = scanFromColumn;
+            let lastCoveredLine = -1;
+            while (column <= scanToColumn) {
+                const originalPosition = this.mapToOriginal(fileId, line, column);
+                if (originalPosition.line && originalPosition.source) {
+                    if (lastCoveredLine !== originalPosition.line) {
+                        this.storage.putCoverage(this.projectId, originalPosition.source, [originalPosition.line]);
+                        lastCoveredLine = originalPosition.line;
+                    }
+                }
+                else {
+                    this.storage.signalUnmappedCoverage(this.projectId);
+                }
+                // Step to the next column to map back to the original.
+                // `originalPosition.name` is the token on the position, that is, if it is present
+                // we increment the column by its length.
+                column = column + Math.max(1, (_b = (_a = originalPosition.name) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 1);
+            }
+            // And the next line
+            line++;
         }
     }
     /**

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

@@ -1,4 +1,4 @@
-import Logger from "bunyan";
+import Logger from 'bunyan';
 /**
  * Lines covered for the specified file.
  */

package/dist/src/utils/PrettyFileLogger.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import 'dotenv/config';
+import { WriteStream } from 'fs';
+/**
+ * Class for log4j-like logger. Stream output shows less information than the
+ * standard JSON format of the bunyan logger and therefore has better readability.
+ */
+export declare class PrettyFileLogger {
+    outputStream: WriteStream;
+    constructor(outputStream: WriteStream);
+    write(rec: Record<any, any>): void;
+    end(): void;
+}

package/dist/src/utils/PrettyFileLogger.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrettyFileLogger = void 0;
+const bunyan_1 = __importDefault(require("bunyan"));
+require("dotenv/config");
+/**
+ * Class for log4j-like logger. Stream output shows less information than the
+ * standard JSON format of the bunyan logger and therefore has better readability.
+ */
+class PrettyFileLogger {
+    constructor(outputStream) {
+        this.outputStream = outputStream;
+    }
+    write(rec) {
+        this.outputStream.write(`[${rec.time.toISOString()}] ${bunyan_1.default.nameFromLevel[rec.level].toUpperCase()}: ${rec.msg}\n`);
+    }
+    end() {
+        this.outputStream.close();
+    }
+}
+exports.PrettyFileLogger = PrettyFileLogger;

package/dist/src/utils/StdConsoleLogger.d.ts

@@ -0,0 +1,5 @@
+import 'dotenv/config';
+/** Class for console logger. Doesn't print all information to ensure better readability. */
+export declare class StdConsoleLogger {
+    write(rec: Record<any, any>): void;
+}

package/dist/src/utils/StdConsoleLogger.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StdConsoleLogger = void 0;
+const bunyan_1 = __importDefault(require("bunyan"));
+require("dotenv/config");
+/** Class for console logger. Doesn't print all information to ensure better readability. */
+class StdConsoleLogger {
+    write(rec) {
+        console.log(`[${rec.time.toISOString()}] ${bunyan_1.default.nameFromLevel[rec.level].toUpperCase()}: ${rec.msg}`);
+    }
+}
+exports.StdConsoleLogger = StdConsoleLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.0.1-beta.33",
+  "version": "0.0.1-beta.36",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",