@teamscale/coverage-collector 0.1.0-beta.8 → 1.0.0-beta.2

package/dist/src/upload/TeamscaleUpload.js

@@ -3,52 +3,88 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadToTeamscale = void 0;
+exports.checkTeamscaleCredentials = checkTeamscaleCredentials;
+exports.uploadToTeamscale = uploadToTeamscale;
+exports.isTimestampArgument = isTimestampArgument;
 const QueryParameters_1 = __importDefault(require("../utils/QueryParameters"));
-const CommonUpload_1 = require("./CommonUpload");
+const RestApis_1 = require("../utils/RestApis");
 const axios_1 = __importDefault(require("axios"));
-const ProxyUpload_1 = require("./ProxyUpload");
+/**
+ * Check Teamscale credentials for validity via the `/api/auth/login/access-key` endpoint.
+ */
+async function checkTeamscaleCredentials(config, logger) {
+    if (config.teamscaleAccessToken === undefined) {
+        logger.error("No valid access token provided for accessing the Teamscale server.");
+        return false;
+    }
+    if (config.teamscaleUser === undefined) {
+        logger.error("No valid user name provided for accessing the Teamscale server.");
+        return false;
+    }
+    const checkUrl = `${(0, RestApis_1.removeTrailingUrlSlash)(config.teamscaleServerUrl)}/api/${RestApis_1.TEAMSCALE_API_VERSION}/auth/login/access-key`;
+    try {
+        await (0, RestApis_1.performRequest)(checkUrl, JSON.stringify({
+            username: config.teamscaleUser,
+            password: config.teamscaleAccessToken,
+            stayLoggedIn: false,
+        }), (0, RestApis_1.prepareTeamscaleApiRequestConfig)(config, { 'Content-Type': `application/json` }), axios_1.default.post, logger);
+        return true;
+    }
+    catch (e) {
+        logger.error('Teamscale authentication failed.', e);
+        return false;
+    }
+}
 /**
  * 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!');
+async function uploadToTeamscale(config, logger, coverageFile, lines, commit) {
+    if (!(config.teamscaleAccessToken && config.teamscaleUser && config.teamscaleServerUrl)) {
+        throw new RestApis_1.UploadError('API key and user name must be configured!');
+    }
+    if (!config.teamscaleProject && !config.teamscalePartition) {
+        throw new RestApis_1.UploadError('Teamscale project and partition must be configured!');
     }
     if (lines === 0) {
-        return;
+        return false;
     }
     logger.debug('Preparing upload to Teamscale');
-    const form = (0, CommonUpload_1.prepareFormData)(coverageFile);
-    const queryParameters = prepareQueryParameters(config);
+    const form = (0, RestApis_1.prepareReportFileUploadFormData)(coverageFile);
+    const queryParameters = prepareQueryParameters(config, commit);
     await performTeamscaleUpload(config, queryParameters, form, logger);
+    return true;
 }
-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);
+    const uploadUrl = `${(0, RestApis_1.removeTrailingUrlSlash)(config.teamscaleServerUrl)}/api/${RestApis_1.TEAMSCALE_API_VERSION}/projects/${config.teamscaleProject}/external-analysis/session/auto-create/report?${parameters.toString()}`;
+    await (0, RestApis_1.performFormDataRequest)(uploadUrl, form, (0, RestApis_1.prepareTeamscaleApiFormRequestConfig)(config, form), axios_1.default.post, logger);
 }
-function prepareQueryParameters(config) {
+function prepareQueryParameters(config, commitOrRevision) {
     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);
+    parameters.addIfDefined('message', config.teamscaleMessage);
+    parameters.addIfDefined('repository', config.teamscaleRepository);
+    if (isTimestampArgument(commitOrRevision)) {
+        parameters.addIfDefined('t', commitOrRevision);
+    }
+    else {
+        parameters.addIfDefined('revision', commitOrRevision);
+    }
+    parameters.addIfDefined('partition', config.teamscalePartition);
     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)
-    };
+/** Checks if the given string is a commit timestamp (possibly along with a branch name). */
+function isTimestampArgument(commitOrRevision) {
+    const parts = commitOrRevision.split(":");
+    if (parts.length === 2) {
+        if (parts[1].toUpperCase() === "HEAD") {
+            return true;
+        }
+        else {
+            return /^\d+$/.test(parts[1]);
+        }
+    }
+    else if (parts.length === 1) {
+        return /^\d+$/.test(commitOrRevision);
+    }
+    return false;
 }

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import 'dotenv/config';
 import { WriteStream } from 'fs';
 /**

package/dist/src/utils/PrettyFileLogger.js

@@ -11,6 +11,7 @@ require("dotenv/config");
  * standard JSON format of the bunyan logger and therefore has better readability.
  */
 class PrettyFileLogger {
+    outputStream;
     constructor(outputStream) {
         this.outputStream = outputStream;
     }

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

@@ -0,0 +1,37 @@
+import { CollectorOptions } from '@cqse/commons';
+import FormData from 'form-data';
+import Logger from 'bunyan';
+import axios, { AxiosProxyConfig, AxiosRequestConfig, AxiosResponse } from 'axios';
+/**
+ * The API version of Teamcale to perform calls against.
+ */
+export declare const TEAMSCALE_API_VERSION = "v2025.2";
+/**
+ * Error that is thrown when the upload failed
+ */
+export declare class UploadError extends Error {
+}
+/**
+ * Prepares the form data from a given report file to upload.
+ */
+export declare function prepareReportFileUploadFormData(reportFileToUpload: string): FormData;
+/**
+ * Sends the form data, for example, for uploading a file, based on the given parameters.
+ */
+export declare function performFormDataRequest(url: string, form: FormData, config: AxiosRequestConfig<FormData>, uploadFunction: <T = unknown, R = AxiosResponse<T>, D = FormData>(url: string, data?: D, config?: AxiosRequestConfig<D>) => Promise<R>, logger: Logger): Promise<void>;
+/**
+ * A generic REST API request with extensive error handling.
+ */
+export declare function performRequest<B, R>(url: string, bodyData: B | undefined, config: AxiosRequestConfig<unknown>, requestFunction: typeof axios.get | typeof axios.post | typeof axios.put, logger: Logger): Promise<R>;
+/** Some of the REST endpoints expect form data; prepare such a request here. */
+export declare function prepareTeamscaleApiFormRequestConfig(config: CollectorOptions, form: FormData): AxiosRequestConfig<FormData>;
+/** Configure the AXIOS request with all relevant parameters, such as HTTP proxy and authentication. */
+export declare function prepareTeamscaleApiRequestConfig(config: CollectorOptions, headers: Record<string, string>): AxiosRequestConfig<FormData>;
+/**
+ * Creates an `AxiosProxyConfig` object if proxy variables are provided.
+ */
+export declare function extractProxyOptions(config: CollectorOptions): AxiosProxyConfig | undefined;
+/**
+ * Removes a trailing slash from a given URL.
+ */
+export declare function removeTrailingUrlSlash(url: string | undefined): string | undefined;

package/dist/src/utils/RestApis.js

@@ -0,0 +1,141 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadError = exports.TEAMSCALE_API_VERSION = void 0;
+exports.prepareReportFileUploadFormData = prepareReportFileUploadFormData;
+exports.performFormDataRequest = performFormDataRequest;
+exports.performRequest = performRequest;
+exports.prepareTeamscaleApiFormRequestConfig = prepareTeamscaleApiFormRequestConfig;
+exports.prepareTeamscaleApiRequestConfig = prepareTeamscaleApiRequestConfig;
+exports.extractProxyOptions = extractProxyOptions;
+exports.removeTrailingUrlSlash = removeTrailingUrlSlash;
+const form_data_1 = __importDefault(require("form-data"));
+const fs_1 = __importDefault(require("fs"));
+const axios_1 = __importDefault(require("axios"));
+const util_1 = require("util");
+const url_1 = __importDefault(require("url"));
+/**
+ * The API version of Teamcale to perform calls against.
+ */
+exports.TEAMSCALE_API_VERSION = 'v2025.2';
+/**
+ * Error that is thrown when the upload failed
+ */
+class UploadError extends Error {
+}
+exports.UploadError = UploadError;
+/**
+ * Prepares the form data from a given report file to upload.
+ */
+function prepareReportFileUploadFormData(reportFileToUpload) {
+    const form = new form_data_1.default();
+    form.append('report', fs_1.default.readFileSync(reportFileToUpload), 'coverage.simple');
+    return form;
+}
+/**
+ * Sends the form data, for example, for uploading a file, based on the given parameters.
+ */
+async function performFormDataRequest(url, form, config, uploadFunction, logger) {
+    return performRequest(url, form, config, uploadFunction, logger);
+}
+/**
+ * A generic REST API request with extensive error handling.
+ */
+async function performRequest(url, bodyData, config, requestFunction, logger) {
+    try {
+        logger.debug("Requesting via URL: " + url);
+        let response;
+        if (requestFunction === axios_1.default.get) {
+            response = await axios_1.default.get(url, config);
+        }
+        else if (requestFunction === axios_1.default.put) {
+            response = await axios_1.default.put(url, bodyData, config);
+        }
+        else if (requestFunction === axios_1.default.post) {
+            response = await axios_1.default.post(url, bodyData, config);
+        }
+        else {
+            throw new Error(`Unsupported request function: ${requestFunction}`);
+        }
+        logger.debug(`Request finished with code ${response.status}.`);
+        return response.data;
+    }
+    catch (error) {
+        if (axios_1.default.isAxiosError(error)) {
+            let userMessage;
+            if (error.message) {
+                logger.error(`Request error ${error.status ?? 'UNDEFINED'}: ${error.message}\n\tRequested URL: ${url}`);
+            }
+            if (error.response) {
+                // The request was made and the server responded with a status code
+                // that falls out of the range of 2xx
+                logger.error('Request error response data:', error.response.data);
+                logger.error('Request error response status:', error.response.status);
+                logger.debug('Request error response headers:', JSON.stringify(error.response.headers));
+                userMessage = `Request failed with status ${error.response.status}: ${error.response.data ?? ''}`;
+            }
+            else if (error.request) {
+                // The request was made but no response was received
+                userMessage = 'No response received for the request. ' + (error.message ?? error.code);
+            }
+            else {
+                // Something happened in setting up the request that triggered an Error
+                userMessage = 'Request setup failed.';
+            }
+            // Provide a more specific message if possible
+            throw new UploadError(`Something went wrong when interacting with the API: ${userMessage}`);
+        }
+        throw new UploadError(`Something went wrong: ${(0, util_1.inspect)(error)}`);
+    }
+}
+/** Some of the REST endpoints expect form data; prepare such a request here. */
+function prepareTeamscaleApiFormRequestConfig(config, form) {
+    return prepareTeamscaleApiRequestConfig(config, { 'Content-Type': `multipart/form-data; boundary=${form.getBoundary()}` });
+}
+/** Configure the AXIOS request with all relevant parameters, such as HTTP proxy and authentication. */
+function prepareTeamscaleApiRequestConfig(config, headers) {
+    return {
+        auth: {
+            username: config.teamscaleUser ?? 'no username provided',
+            password: config.teamscaleAccessToken ?? 'no password provided'
+        },
+        headers: {
+            Accept: '*/*',
+            ...headers
+        },
+        timeout: 15000,
+        proxy: extractProxyOptions(config)
+    };
+}
+/**
+ * Creates an `AxiosProxyConfig` object if proxy variables are provided.
+ */
+function extractProxyOptions(config) {
+    const proxy = config.httpProxy;
+    if (!proxy) {
+        return undefined;
+    }
+    // Expected format: http://username:password@host:port/
+    // See https://nodejs.org/api/url.html#url-strings-and-url-objects for URL parsing
+    const proxyAddress = new url_1.default.URL(proxy);
+    const proxyConfig = {
+        protocol: proxyAddress.protocol.replace(':', ''),
+        host: proxyAddress.hostname,
+        port: +proxyAddress.port,
+    };
+    if (proxyAddress.username && proxyAddress.password) {
+        proxyConfig.auth = {
+            username: proxyAddress.username,
+            password: proxyAddress.password
+        };
+    }
+    return proxyConfig;
+}
+/**
+ * Removes a trailing slash from a given URL.
+ */
+function removeTrailingUrlSlash(url) {
+    return url?.replace(/\/$/, '');
+}

package/dist/src/utils/StdConsoleLogger.js

@@ -10,7 +10,17 @@ require("dotenv/config");
 class StdConsoleLogger {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     write(rec) {
-        console.log(`[${rec.time.toISOString()}] ${bunyan_1.default.nameFromLevel[rec.level].toUpperCase()}: ${rec.msg}`);
+        let logFunction;
+        if (rec.level === bunyan_1.default.ERROR) {
+            logFunction = console.error;
+        }
+        else if (rec.level === bunyan_1.default.WARN) {
+            logFunction = console.warn;
+        }
+        else {
+            logFunction = console.log;
+        }
+        logFunction.apply(this, [`[${rec.time.toISOString()}] ${bunyan_1.default.nameFromLevel[rec.level].toUpperCase()}: ${rec.msg}`]);
     }
 }
 exports.StdConsoleLogger = StdConsoleLogger;

package/package.json

@@ -1,55 +1,53 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.1.0-beta.8",
+  "version": "1.0.0-beta.2",
   "description": "Collector for JavaScript code coverage information",
   "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"
-  },
+  "homepage": "https://docs.teamscale.com/howto/setting-up-profiler-tga/javascript/",
   "files": [
     "dist/**/*"
   ],
   "dependencies": {
-    "@cqse/commons": "0.1.0-beta.7",
     "argparse": "^2.0.1",
-    "async": "^3.2.5",
-    "axios": "^1.6.8",
+    "async": "^3.2.6",
+    "axios": "^1.7.9",
     "bunyan": "^1.8.15",
-    "date-and-time": "^3.1.1",
-    "dotenv": "^16.4.5",
-    "express": "^4.19.2",
-    "form-data": "^4.0.0",
+    "date-and-time": "^3.6.0",
+    "dotenv": "^16.4.7",
+    "express": "^5.0.1",
+    "form-data": "^4.0.2",
     "mkdirp": "^3.0.1",
+    "node-cache": "^5.1.2",
     "rxjs": "^7.8.1",
     "source-map": "^0.7.4",
     "tmp": "^0.2.3",
     "typescript-optional": "^2.0.1",
-    "ws": "^8.16.0"
+    "ws": "^8.18.0",
+    "@cqse/commons": "1.0.0-beta.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/preset-env": "^7.24.4",
-    "@types/argparse": "^2.0.16",
+    "@babel/core": "^7.26.8",
+    "@babel/preset-env": "^7.26.8",
+    "@types/argparse": "^2.0.17",
     "@types/async": "^3.2.24",
     "@types/bunyan": "^1.8.11",
-    "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.12.6",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.4",
     "@types/tmp": "^0.2.6",
-    "@types/ws": "^8.5.10",
+    "@types/ws": "^8.5.14",
     "babel-jest": "^29.7.0",
-    "esbuild": "^0.20.2",
+    "esbuild": "^0.25.0",
     "jest": "^29.7.0",
-    "mockttp": "^3.10.2",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.2",
+    "mockttp": "3.15.5",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.4"
+    "typescript": "^5.7.3"
   },
   "publishConfig": {
     "access": "public"

package/dist/src/App.d.ts

@@ -1,44 +0,0 @@
-import 'dotenv/config';
-import { ConfigParameters } from './utils/ConfigParameters';
-/**
- * The main class of the Teamscale JavaScript Collector.
- * Used to start the collector with a given configuration.
- */
-export declare class App {
-    /**
-     * 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;
-    /**
-     * Run the collector with the given configuration options.
-     *
-     * @param config - The configuration options to run the collector with.
-     */
-    static runWithConfig(config: ConfigParameters): {
-        stop: () => Promise<void>;
-    };
-    /**
-     * Starts a timer that shows a message every min that no coverage
-     * was received until the opposite is the case.
-     */
-    private static startNoMessageTimer;
-    /**
-     * Start a timer for dumping the data, depending on the configuration.
-     *
-     * @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 uploadCoverage;
-    private static startControlServer;
-}