@teamscale/coverage-collector 0.0.1-beta.35 → 0.0.1-beta.39

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.0.1-beta.35",
+    "version": "0.0.1-beta.39",
     "description": "Collector for JavaScript code coverage information",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -24,7 +24,7 @@
     "dependencies": {
         "@cqse/commons": "^0.0.1-beta.26",
         "argparse": "^2.0.1",
-        "async": "^3.2.3",
+        "async": "^3.2.4",
         "axios": "^0.24.0",
         "bunyan": "^1.8.15",
         "dotenv": "^14.1.0",

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,24 +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/Session.d.ts

@@ -43,8 +43,10 @@ export declare class Session {
      * 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.
+     * @param startLine - The line number within the bundle the range starts.
+     * @param startColumn - The column in the given `startLine` on that the range starts (inclusive).
+     * @param endLine - The line number within the bundle the range ends.
+     * @param endColumn - The column in the given `startLine` on that the range ends (inclusive).
      */
     putCoverage(fileId: string, startLine: number, startColumn: number, endLine: number, endColumn: number): void;
     /**

package/dist/src/receiver/Session.js

@@ -51,8 +51,10 @@ class Session {
      * 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.
+     * @param startLine - The line number within the bundle the range starts.
+     * @param startColumn - The column in the given `startLine` on that the range starts (inclusive).
+     * @param endLine - The line number within the bundle the range ends.
+     * @param endColumn - The column in the given `startLine` on that the range ends (inclusive).
      */
     putCoverage(fileId, startLine, startColumn, endLine, endColumn) {
         var _a, _b;

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.35",
+  "version": "0.0.1-beta.39",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -24,7 +24,7 @@
   "dependencies": {
     "@cqse/commons": "^0.0.1-beta.26",
     "argparse": "^2.0.1",
-    "async": "^3.2.3",
+    "async": "^3.2.4",
     "axios": "^0.24.0",
     "bunyan": "^1.8.15",
     "dotenv": "^14.1.0",