@teamscale/coverage-collector 0.0.1-beta.5 → 0.0.1-beta.50

package/dist/src/upload/TeamscaleUpload.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadToTeamscale = void 0;
+const QueryParameters_1 = __importDefault(require("../utils/QueryParameters"));
+const CommonUpload_1 = require("./CommonUpload");
+const axios_1 = __importDefault(require("axios"));
+const ProxyUpload_1 = require("./ProxyUpload");
+/**
+ * Uploads a coverage file to Teamscale with the provided configuration.
+ */
+async function uploadToTeamscale(config, logger, coverageFile, lines) {
+    if (!(config.teamscale_access_token && config.teamscale_user && config.teamscale_server_url)) {
+        throw new CommonUpload_1.UploadError('API key and user name must be configured!');
+    }
+    if (lines === 0) {
+        return;
+    }
+    logger.info('Preparing upload to Teamscale');
+    const form = (0, CommonUpload_1.prepareFormData)(coverageFile);
+    const queryParameters = prepareQueryParameters(config);
+    await performTeamscaleUpload(config, queryParameters, form, logger);
+}
+exports.uploadToTeamscale = uploadToTeamscale;
+async function performTeamscaleUpload(config, parameters, form, logger) {
+    var _a;
+    await (0, CommonUpload_1.performUpload)(`${(_a = config.teamscale_server_url) === null || _a === void 0 ? void 0 : _a.replace(/\/$/, '')}/api/projects/${config.teamscale_project}/external-analysis/session/auto-create/report?${parameters.toString()}`, form, prepareTeamscaleConfig(config, form), axios_1.default.post, logger);
+}
+function prepareQueryParameters(config) {
+    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);
+    return parameters;
+}
+function prepareTeamscaleConfig(config, form) {
+    var _a, _b;
+    return {
+        auth: {
+            username: (_a = config.teamscale_user) !== null && _a !== void 0 ? _a : 'no username provided',
+            password: (_b = config.teamscale_access_token) !== null && _b !== void 0 ? _b : 'no password provided'
+        },
+        headers: {
+            Accept: '*/*',
+            'Content-Type': `multipart/form-data; boundary=${form.getBoundary()}`
+        },
+        proxy: (0, ProxyUpload_1.extractProxyOptions)(config)
+    };
+}

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

@@ -0,0 +1,36 @@
+import { ArgumentParser } from 'argparse';
+/**
+ * The command line parameters the profiler can be configured with.
+ *
+ * ATTENTION: We use snake_case here because ArgParse creates
+ * the parameters that way---as in Python from which ArgParse stems.
+ */
+export declare type ConfigParameters = {
+    dump_to_folder: string;
+    log_to_file: string;
+    keep_coverage_files: boolean;
+    log_level: string;
+    dump_after_mins: number;
+    port: number;
+    json_log: boolean;
+    teamscale_server_url?: string;
+    teamscale_access_token?: string;
+    teamscale_project?: string;
+    teamscale_user?: string;
+    teamscale_partition?: string;
+    teamscale_revision?: string;
+    teamscale_commit?: string;
+    teamscale_repository?: string;
+    teamscale_message?: string;
+    artifactory_server_url?: string;
+    artifactory_user?: string;
+    artifactory_password?: string;
+    artifactory_access_token?: string;
+    artifactory_path_suffix?: string;
+    enable_control_port?: number;
+    http_proxy?: string;
+};
+/**
+ * Construct the object for parsing the command line arguments.
+ */
+export declare function buildParameterParser(): ArgumentParser;

package/dist/src/utils/ConfigParameters.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildParameterParser = void 0;
+const argparse_1 = require("argparse");
+const package_json_1 = require("../../package.json");
+/**
+ * Construct the object for parsing the command line arguments.
+ */
+function buildParameterParser() {
+    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-folder', {
+        help: 'Target folder for coverage files.',
+        default: 'coverage'
+    });
+    parser.add_argument('-k', '--keep-coverage-files', {
+        help: 'Whether to keep the coverage files on disk after a successful upload to Teamsacle',
+        action: 'store_true',
+        default: false
+    });
+    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('-c', '--enable-control-port', {
+        help: 'Enables the remote control API on the specified port (<=0 means "disabled").',
+        default: 0
+    });
+    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
+    });
+    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.',
+        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'
+    });
+    parser.add_argument('--artifactory-server-url', {
+        help: 'Upload the coverage to the given Artifactory server URL. The URL may include a subpath on the artifactory server, e.g. https://artifactory.acme.com/my-repo/my/subpath',
+        default: process.env.ARTIFACTORY_SERVER_URL
+    });
+    parser.add_argument('--artifactory-user', {
+        help: 'The user for uploading coverage to Artifactory. Only needed when not using the --artifactory-access-token option',
+        default: process.env.ARTIFACTORY_USER
+    });
+    parser.add_argument('--artifactory-password', {
+        help: 'The password for uploading coverage to Artifactory. Only needed when not using the --artifactory-access-token option',
+        default: process.env.ARTIFACTORY_PASSWORD
+    });
+    parser.add_argument('--artifactory-access-token', {
+        help: 'The access_token for uploading coverage to Artifactory.',
+        default: process.env.ARTIFACTORY_ACCESS_TOKEN
+    });
+    parser.add_argument('--artifactory-path-suffix', {
+        help: '(optional): The path within the storage location between the default path and the uploaded artifact.',
+        default: process.env.ARTIFACTORY_PATH_SUFFIX
+    });
+    parser.add_argument('--http-proxy', {
+        help: '(optional): The HTTP/HTTPS proxy address that should be used in the format: http://host:port/ or http://username:password@host:port/.',
+        default: process.env.HTTP_PROXY
+    });
+    return parser;
+}
+exports.buildParameterParser = buildParameterParser;

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/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/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.5",
+  "version": "0.0.1-beta.50",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -12,22 +12,30 @@
     "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
   },
   "scripts": {
+    "prepublishOnly": "yarn clean && yarn build",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "build": "tsc",
     "collector": "node dist/src/main.js",
-    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
+    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --coverage --silent=true"
   },
   "files": [
     "dist/**/*"
   ],
   "dependencies": {
-    "@cqse/commons": "^0.0.1-beta.1",
+    "@cqse/commons": "^0.0.1-beta.45",
     "argparse": "^2.0.1",
-    "async": "^3.2.0",
+    "async": "^3.2.4",
+    "axios": "^0.24.0",
+    "bunyan": "^1.8.15",
+    "date-and-time": "^2.3.1",
+    "dotenv": "^14.1.0",
+    "express": "^4.18.1",
+    "form-data": "^4.0.0",
+    "mkdirp": "^1.0.4",
     "rxjs": "^7.1.0",
-    "source-map": "^0.7.3",
+    "source-map": "^0.7.4",
+    "tmp": "^0.2.1",
     "typescript-optional": "^2.0.1",
-    "winston": "^3.3.3",
     "ws": "^7.4.5"
   },
   "devDependencies": {
@@ -35,14 +43,18 @@
     "@babel/preset-env": "^7.14.1",
     "@types/argparse": "^2.0.5",
     "@types/async": "^3.2.6",
+    "@types/bunyan": "^1.8.8",
+    "@types/express": "^4.17.13",
     "@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",
     "jest": "^27.2.0",
+    "mockttp": "^3.4.0",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.2.1",