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

package/README.md

@@ -9,7 +9,7 @@ files in the [Teamscale Simple Coverage Format](https://docs.teamscale.com/refer
 The Teamscale JavaScript Profiler consists of this Coverage Collector and the
 [JavaScript Instrumenter](https://www.npmjs.com/package/@teamscale/javascript-instrumenter).
 More details on using them (in combination) can be found 
-on the projects' [Github page](https://github.com/cqse/teamscale-javascript-profiler/).
+in the [Teamscale Documentation](https://docs.teamscale.com/howto/recording-test-coverage-for-javascript/).
 
 The JavaScript Coverage Collector starts a server process that listens for 
 code coverage information from manually or automatically exercised (tested) 
@@ -32,7 +32,7 @@ yarn build
 There are several options to run the Collector. For example, via `yarn` by running
 
 ```
-yarn serve --port 54678 --dump-to-file=./coverage.simple
+yarn collector --port 54678 --dump-to-file=./coverage.simple
 ```
 
 or via `npx` by running
@@ -49,8 +49,3 @@ for example, by setting a corresponding environment variable.
 export NODE_OPTIONS="$NODE_OPTIONS --max-old-space-size=8192"
 ```
 
-## Publishing
-
-The list of files to publish is defined by the `files` attribute in `package.json`.
-The actual files packed by npm can be listed by running `npx npm-packlist`.
-

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.0.1-beta.3",
+    "version": "0.0.1-beta.33",
     "description": "Collector for JavaScript code coverage information",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -12,22 +12,28 @@
         "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
     },
     "scripts": {
+        "prepublishOnly": "yarn clean && yarn build",
         "clean": "rimraf dist tsconfig.tsbuildinfo",
         "build": "tsc",
-        "serve": "node dist/src/main.js",
+        "collector": "node dist/src/main.js",
         "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
     },
     "files": [
         "dist/**/*"
     ],
     "dependencies": {
-        "@cqse/commons": "^0.0.1-beta.1",
+        "@cqse/commons": "^0.0.1-beta.26",
         "argparse": "^2.0.1",
-        "async": "^3.2.0",
+        "async": "^3.2.3",
+        "axios": "^0.24.0",
+        "bunyan": "^1.8.15",
+        "dotenv": "^14.1.0",
+        "form-data": "^4.0.0",
+        "mkdirp": "^1.0.4",
         "rxjs": "^7.1.0",
         "source-map": "^0.7.3",
+        "tmp": "^0.2.1",
         "typescript-optional": "^2.0.1",
-        "winston": "^3.3.3",
         "ws": "^7.4.5"
     },
     "devDependencies": {
@@ -35,10 +41,12 @@
         "@babel/preset-env": "^7.14.1",
         "@types/argparse": "^2.0.5",
         "@types/async": "^3.2.6",
+        "@types/bunyan": "^1.8.8",
         "@types/jest": "^27.0.1",
+        "@types/mkdirp": "^1.0.2",
         "@types/node": "^15.0.1",
         "@types/source-map": "^0.5.7",
-        "@types/winston": "^2.4.4",
+        "@types/tmp": "^0.2.3",
         "@types/ws": "^7.4.2",
         "babel-jest": "^27.2.0",
         "esbuild": "^0.13.4",

package/dist/src/main.d.ts

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
+import 'dotenv/config';
 /**
  * The main class of the Teamscale JavaScript Collector.
- * Used to start-up the collector for with a given configuration.
+ * Used to start the collector for with a given configuration.
  */
 export declare class Main {
     /**
@@ -23,9 +24,11 @@ export declare class Main {
     /**
      * 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 config - The config that determines whether to do the timed dump or not.
      * @param storage - The storage with the information to dump.
      * @param logger - The logger to use.
      */
     private static maybeStartDumpTimer;
+    private static dumpCoverage;
+    private static uploadToTeamscale;
 }

package/dist/src/main.js

@@ -1,5 +1,28 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 };
 };
@@ -7,35 +30,82 @@ 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 bunyan_1 = __importDefault(require("bunyan"));
 const DataStorage_1 = require("./storage/DataStorage");
 const CollectingServer_1 = require("./receiver/CollectingServer");
+require("dotenv/config");
+const fs = __importStar(require("fs"));
+const axios_1 = __importDefault(require("axios"));
+const form_data_1 = __importDefault(require("form-data"));
+const QueryParameters_1 = __importDefault(require("./utils/QueryParameters"));
+const util_1 = require("util");
+const tmp_1 = __importDefault(require("tmp"));
+const mkdirp_1 = __importDefault(require("mkdirp"));
+const path_1 = __importDefault(require("path"));
 /**
  * The main class of the Teamscale JavaScript Collector.
- * Used to start-up the collector for with a given configuration.
+ * Used to start the collector for with a given configuration.
  */
 class Main {
     /**
      * Construct the object for parsing the command line arguments.
      */
     static buildParser() {
+        var _a;
         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: 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('-f', '--dump-to-file', { help: 'Target file to write coverage to.' });
         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
+        parser.add_argument('-t', '--dump-after-mins', {
+            help: 'Dump the coverage information to the target file every N minutes.',
+            default: 360
         });
         parser.add_argument('-d', '--debug', {
             help: 'Print received coverage information to the terminal?',
             default: false
         });
+        // 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.',
+            default: process.env.TEAMSCALE_SERVER_URL
+        });
+        parser.add_argument('--teamscale-access-token', {
+            help: 'The API key to use for uploading to Teamscale.',
+            default: process.env.TEAMSCALE_ACCESS_TOKEN
+        });
+        parser.add_argument('--teamscale-project', {
+            help: 'The project ID to upload coverage to.',
+            default: process.env.TEAMSCALE_PROJECT
+        });
+        parser.add_argument('--teamscale-user', {
+            help: 'The user for uploading coverage to Teamscale.',
+            default: process.env.TEAMSCALE_USER
+        });
+        parser.add_argument('--teamscale-partition', {
+            help: 'The partition to upload coverage to.',
+            default: process.env.TEAMSCALE_PARTITION
+        });
+        parser.add_argument('--teamscale-revision', {
+            help: 'The revision (commit hash, version id) to upload coverage for.',
+            default: process.env.TEAMSCALE_REVISION
+        });
+        parser.add_argument('--teamscale-commit', {
+            help: 'The branch and timestamp to upload coverage for, separated by colon.',
+            default: process.env.TEAMSCALE_COMMIT
+        });
+        parser.add_argument('--teamscale-repository', {
+            help: 'The repository to upload coverage for. Optional: Only needed when uploading via revision to a project that has more than one connector.',
+            default: process.env.TEAMSCALE_REPOSITORY
+        });
+        parser.add_argument('--teamscale-message', {
+            help: 'The commit message shown within Teamscale for the coverage upload. Default is "JavaScript coverage upload".',
+            default: (_a = process.env.TEAMSCALE_MESSAGE) !== null && _a !== void 0 ? _a : 'JavaScript coverage upload'
+        });
         return parser;
     }
     /**
@@ -49,16 +119,25 @@ class Main {
      * Construct the logger.
      */
     static buildLogger(config) {
-        return winston_1.default.createLogger({
-            level: config.log_level,
-            format: winston_1.default.format.json(),
-            defaultMeta: {},
-            transports: [
-                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 })
-            ]
-        });
+        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",
+            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
+                }
+            ] });
     }
     /**
      * Entry point of the Teamscale JavaScript Profiler.
@@ -70,6 +149,11 @@ class Main {
         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}".`);
+        // Check the command line arguments
+        if (!config.dump_to_file && !config.teamscale_server_url) {
+            logger.error('The Collector must be configured to either dump to a file or upload to Teamscale.');
+            process.exit(1);
+        }
         // Prepare the storage and the server
         const storage = new DataStorage_1.DataStorage(logger);
         const server = new CollectingServer_1.WebSocketCollectingServer(config.port, storage, logger);
@@ -79,7 +163,9 @@ class Main {
         // 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', () => {
+        process.on('SIGINT', async () => {
+            // ... and do a final dump before.
+            await this.dumpCoverage(config, storage, logger).then();
             logger.info('Bye bye.');
             process.exit();
         });
@@ -87,32 +173,100 @@ class Main {
     /**
      * 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 config - The config that determines whether to do the timed dump or not.
      * @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) {
+        if (config.dump_after_mins > 0) {
+            logger.info(`Will dump coverage information every ${config.dump_after_mins} minute(s).`);
             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);
+                this.dumpCoverage(config, storage, logger).then();
+            }, config.dump_after_mins * 1000 * 60);
             process.on('SIGINT', () => {
                 // Stop the timed file dump
                 if (timer) {
                     clearInterval(timer);
                 }
-                // ... and do a final dump
-                const written = storage.dumpToSimpleCoverageFile(config.dump_to_file);
-                logger.info(`\nCaught interrupt signal. Written ${written} lines of the latest coverage.`);
             });
         }
     }
+    static async dumpCoverage(config, storage, logger) {
+        var _a;
+        try {
+            const deleteCoverageFileAfterUpload = !config.dump_to_file;
+            const coverageFile = (_a = config.dump_to_file) !== null && _a !== void 0 ? _a : tmp_1.default.tmpNameSync();
+            try {
+                // 1. Write coverage to a file
+                const lines = storage.dumpToSimpleCoverageFile(coverageFile);
+                logger.info(`Dumped ${lines} lines of coverage to ${coverageFile}.`);
+                // 2. Upload to Teamscale if configured
+                if (config.teamscale_server_url) {
+                    await this.uploadToTeamscale(config, logger, coverageFile, lines);
+                }
+            }
+            finally {
+                if (deleteCoverageFileAfterUpload) {
+                    fs.unlinkSync(coverageFile);
+                }
+            }
+        }
+        catch (e) {
+            logger.error('Coverage dump failed.', e);
+        }
+    }
+    static async uploadToTeamscale(config, logger, coverageFile, lines) {
+        if (!(config.teamscale_access_token && config.teamscale_user && config.teamscale_server_url)) {
+            logger.error('Cannot upload to Teamscale: API key and user name must be configured!');
+            return;
+        }
+        if (lines === 0) {
+            return;
+        }
+        logger.info('Preparing upload to Teamscale');
+        const form = new form_data_1.default();
+        form.append('report', fs.createReadStream(coverageFile), 'coverage.simple');
+        const parameters = new QueryParameters_1.default();
+        parameters.addIfDefined('format', 'SIMPLE');
+        parameters.addIfDefined('message', config.teamscale_message);
+        parameters.addIfDefined('repository', config.teamscale_repository);
+        parameters.addIfDefined('t', config.teamscale_commit);
+        parameters.addIfDefined('revision', config.teamscale_revision);
+        parameters.addIfDefined('partition', config.teamscale_partition);
+        await axios_1.default
+            .post(`${config.teamscale_server_url.replace(/\/$/, '')}/api/projects/${config.teamscale_project}/external-analysis/session/auto-create/report?${parameters.toString()}`, form, {
+            auth: {
+                username: config.teamscale_user,
+                password: config.teamscale_access_token
+            },
+            headers: {
+                Accept: '*/*',
+                'Content-Type': `multipart/form-data; boundary=${form.getBoundary()}`
+            }
+        })
+            .catch(function (error) {
+            if (error.response) {
+                const response = error.response;
+                if (response.status >= 400) {
+                    logger.error(`Upload failed with code ${response.status}: ${response.statusText}`);
+                    logger.error(`Request failed with following response: ${response.data}`);
+                }
+                else {
+                    logger.info(`Upload with status code ${response.status} finished.`);
+                }
+            }
+            else if (error.request) {
+                logger.error(`Upload request did not receive a response.`);
+            }
+            if (error.message) {
+                logger.error(`Something went wrong when uploading data: ${error.message}`);
+                logger.debug(`Details of the error: ${(0, util_1.inspect)(error)}`);
+            }
+            else {
+                logger.error(`Something went wrong when uploading data: ${(0, util_1.inspect)(error)}`);
+            }
+        });
+    }
 }
 exports.Main = Main;
 Main.run();

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

@@ -1,5 +1,5 @@
 import { IDataStorage } from '../storage/DataStorage';
-import { Logger } from 'winston';
+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

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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 'winston';
+import Logger from "bunyan";
 /**
  * The session maintains the relevant information for a client.
  * One session is created for each client.

package/dist/src/receiver/Session.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

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

package/dist/src/storage/DataStorage.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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

@@ -0,0 +1,9 @@
+/**
+ * Helper class for building HTTP query parameter strings.
+ */
+export default class QueryParameters extends URLSearchParams {
+    /**
+     * Adds a parameter if the value is defined.
+     */
+    addIfDefined(key: string, value: string | undefined): void;
+}

package/dist/src/utils/QueryParameters.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Helper class for building HTTP query parameter strings.
+ */
+class QueryParameters extends URLSearchParams {
+    /**
+     * Adds a parameter if the value is defined.
+     */
+    addIfDefined(key, value) {
+        if (value) {
+            this.append(key, value);
+        }
+        else {
+            this.delete(key);
+        }
+    }
+}
+exports.default = QueryParameters;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.33",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -12,22 +12,28 @@
     "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
   },
   "scripts": {
+    "prepublishOnly": "yarn clean && yarn build",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "build": "tsc",
-    "serve": "node dist/src/main.js",
+    "collector": "node dist/src/main.js",
     "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
   },
   "files": [
     "dist/**/*"
   ],
   "dependencies": {
-    "@cqse/commons": "^0.0.1-beta.1",
+    "@cqse/commons": "^0.0.1-beta.26",
     "argparse": "^2.0.1",
-    "async": "^3.2.0",
+    "async": "^3.2.3",
+    "axios": "^0.24.0",
+    "bunyan": "^1.8.15",
+    "dotenv": "^14.1.0",
+    "form-data": "^4.0.0",
+    "mkdirp": "^1.0.4",
     "rxjs": "^7.1.0",
     "source-map": "^0.7.3",
+    "tmp": "^0.2.1",
     "typescript-optional": "^2.0.1",
-    "winston": "^3.3.3",
     "ws": "^7.4.5"
   },
   "devDependencies": {
@@ -35,10 +41,12 @@
     "@babel/preset-env": "^7.14.1",
     "@types/argparse": "^2.0.5",
     "@types/async": "^3.2.6",
+    "@types/bunyan": "^1.8.8",
     "@types/jest": "^27.0.1",
+    "@types/mkdirp": "^1.0.2",
     "@types/node": "^15.0.1",
     "@types/source-map": "^0.5.7",
-    "@types/winston": "^2.4.4",
+    "@types/tmp": "^0.2.3",
     "@types/ws": "^7.4.2",
     "babel-jest": "^27.2.0",
     "esbuild": "^0.13.4",