@teamscale/coverage-collector 0.0.1-beta.41 → 0.0.1-beta.42

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.0.1-beta.41",
+    "version": "0.0.1-beta.42",
     "description": "Collector for JavaScript code coverage information",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -27,6 +27,7 @@
         "async": "^3.2.4",
         "axios": "^0.24.0",
         "bunyan": "^1.8.15",
+        "date-and-time": "^2.3.1",
         "dotenv": "^14.1.0",
         "form-data": "^4.0.0",
         "mkdirp": "^1.0.4",

package/dist/src/main.d.ts

@@ -5,6 +5,7 @@ import 'dotenv/config';
  * Used to start the collector for with a given configuration.
  */
 export declare class Main {
+    private static readonly DEFAULT_COVERAGE_LOCATION;
     /**
      * Construct the object for parsing the command line arguments.
      */
@@ -31,4 +32,7 @@ export declare class Main {
     private static maybeStartDumpTimer;
     private static dumpCoverage;
     private static uploadToTeamscale;
+    private static performTeamscaleUpload;
+    private static prepareQueryParameters;
+    private static prepareFormData;
 }

package/dist/src/main.js

@@ -39,11 +39,15 @@ 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"));
 const StdConsoleLogger_1 = require("./utils/StdConsoleLogger");
 const PrettyFileLogger_1 = require("./utils/PrettyFileLogger");
+/**
+ * Error that is thrown when the upload to Teamscale failed
+ */
+class TeamscaleUploadError extends Error {
+}
 /**
  * The main class of the Teamscale JavaScript Collector.
  * Used to start the collector for with a given configuration.
@@ -60,7 +64,15 @@ class Main {
         });
         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 to write coverage to.' });
+        parser.add_argument('-f', '--dump-to-folder', {
+            help: 'Target folder for coverage files.',
+            default: this.DEFAULT_COVERAGE_LOCATION
+        });
+        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('-t', '--dump-after-mins', {
@@ -153,11 +165,6 @@ 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);
@@ -196,52 +203,48 @@ class Main {
         }
     }
     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) {
+            // 1. Write coverage to a file
+            const [coverageFile, lines] = storage.dumpToSimpleCoverageFile(config.dump_to_folder, new Date());
+            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);
+                // Delete coverage if upload was successful and keeping coverage files on disk was not configure by the user
+                if (!config.keep_coverage_files) {
                     fs.unlinkSync(coverageFile);
                 }
             }
         }
         catch (e) {
-            logger.error('Coverage dump failed.', e);
+            if (e instanceof TeamscaleUploadError) {
+                logger.error(`Teamscale upload failed. The coverage files on disk (inside the folder "${config.dump_to_folder}") were not deleted. 
+					You can still upload them manually.`, e);
+            }
+            else {
+                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;
+            throw new TeamscaleUploadError('API key and user name must be configured!');
         }
         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);
+        const form = this.prepareFormData(coverageFile);
+        const queryParameters = this.prepareQueryParameters(config);
+        await this.performTeamscaleUpload(config, queryParameters, form, logger);
+    }
+    static async performTeamscaleUpload(config, parameters, form, logger) {
+        var _a, _b, _c;
         await axios_1.default
-            .post(`${config.teamscale_server_url.replace(/\/$/, '')}/api/projects/${config.teamscale_project}/external-analysis/session/auto-create/report?${parameters.toString()}`, form, {
+            .post(`${(_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, {
             auth: {
-                username: config.teamscale_user,
-                password: config.teamscale_access_token
+                username: (_b = config.teamscale_user) !== null && _b !== void 0 ? _b : 'no username provided',
+                password: (_c = config.teamscale_access_token) !== null && _c !== void 0 ? _c : 'no password provided'
             },
             headers: {
                 Accept: '*/*',
@@ -252,25 +255,40 @@ class Main {
             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}`);
+                    throw new TeamscaleUploadError(`Upload failed with code ${response.status}: ${response.statusText}. Response Data: ${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.`);
+                throw new TeamscaleUploadError(`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)}`);
+                logger.debug(`Something went wrong when uploading data: ${error.message}. Details of the error: ${(0, util_1.inspect)(error)}`);
+                throw new TeamscaleUploadError(`Something went wrong when uploading data: ${error.message}`);
             }
             else {
-                logger.error(`Something went wrong when uploading data: ${(0, util_1.inspect)(error)}`);
+                throw new TeamscaleUploadError(`Something went wrong when uploading data: ${(0, util_1.inspect)(error)}`);
             }
         });
     }
+    static 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;
+    }
+    static prepareFormData(coverageFile) {
+        const form = new form_data_1.default();
+        form.append('report', fs.createReadStream(coverageFile), 'coverage.simple');
+        return form;
+    }
 }
 exports.Main = Main;
+Main.DEFAULT_COVERAGE_LOCATION = 'coverage';
 Main.run();

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

@@ -21,11 +21,14 @@ export interface IReadableStorage {
      */
     getCoverageBySourceFile(project: string): IterableIterator<FileCoverage> | undefined;
     /**
-     * Write the coverage to the specified file.
+     * Write the coverage to the specified file. A timestamp will be appended to the provided file path.
      *
-     * @param filePath - Full path of the file to write the coverage to.
+     * @param coverageFolder - Full path of the file to write the coverage to.
+     * @param date - Date to use for the appended timestamp
+     *
+     * @return The number of lines written
      */
-    dumpToSimpleCoverageFile(filePath: string): void;
+    dumpToSimpleCoverageFile(coverageFolder: string, date: Date): [string, number];
 }
 /**
  * Storage interface for writing information.
@@ -89,7 +92,7 @@ export declare class DataStorage implements IDataStorage {
     /**
      * Coverage information by project.
      */
-    private readonly coverageByProject;
+    private coverageByProject;
     /**
      * Logger to use.
      */
@@ -98,6 +101,10 @@ export declare class DataStorage implements IDataStorage {
      * Times unmapped coverage received.
      */
     private timesUnmappedCoverage;
+    /**
+     * Date format for the timestamp appended to the coverage files
+     */
+    readonly DATE_FORMAT = "YYYY-MM-DD-HH-mm-ss.SSS";
     /**
      * Constructs the data storage.
      *
@@ -118,7 +125,7 @@ export declare class DataStorage implements IDataStorage {
      *
      * @param sourceFile - The file name to normalize, produced by the instrumenter.
      */
-    private normalizeSourceFileName;
+    private static normalizeSourceFileName;
     /**
      * {@inheritDoc IWriteableStorage.signalUnmappedCoverage}
      */
@@ -128,9 +135,25 @@ export declare class DataStorage implements IDataStorage {
      */
     getCoverageBySourceFile(project: string): IterableIterator<FileCoverage> | undefined;
     /**
-     * {@inheritDoc IReadableStorage.writeToSimpleCoverageFile}
+     * @inheritDoc
+     */
+    dumpToSimpleCoverageFile(coverageFolder: string, date: Date): [string, number];
+    /**
+     * Set the collected coverage to 0 for all projects
+     * @private
+     */
+    private resetCoverage;
+    /**
+     * Appends the timestamp given with date to the coverageFolder (before the file ending if there is one)
+     * @param coverageFolder Path to the coverage file
+     * @param date Represents the timestamp to be appended with the format {@link DataStorage.DATE_FORMAT}
+     * @private
+     */
+    private initCoverageFile;
+    /**
+     * Generate simple coverage format for the collected coverage
      */
-    dumpToSimpleCoverageFile(filePath: string): number;
+    private toSimpleCoverage;
     /**
      * {@inheritDoc IReadableStorage.getProjects}
      */

package/dist/src/storage/DataStorage.js

@@ -22,10 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataStorage = exports.ProjectCoverage = void 0;
 const commons_1 = require("@cqse/commons");
 const fs = __importStar(require("fs"));
+const path_1 = __importDefault(require("path"));
+const dat = __importStar(require("date-and-time"));
 /**
  * The coverage information received for one particular project.
  */
@@ -81,6 +86,10 @@ class DataStorage {
      * @param logger - The logger to use.
      */
     constructor(logger) {
+        /**
+         * Date format for the timestamp appended to the coverage files
+         */
+        this.DATE_FORMAT = 'YYYY-MM-DD-HH-mm-ss.SSS';
         this.coverageByProject = new Map();
         this.logger = commons_1.Contract.requireDefined(logger);
         this.timesUnmappedCoverage = 0;
@@ -93,7 +102,7 @@ class DataStorage {
      * @param coveredOriginalLines - The lines covered in the file.
      */
     putCoverage(project, sourceFilePath, coveredOriginalLines) {
-        const uniformPath = this.normalizeSourceFileName(sourceFilePath);
+        const uniformPath = DataStorage.normalizeSourceFileName(sourceFilePath);
         let projectCoverage = this.coverageByProject.get(project);
         if (!projectCoverage) {
             projectCoverage = new ProjectCoverage(project);
@@ -108,7 +117,7 @@ class DataStorage {
      *
      * @param sourceFile - The file name to normalize, produced by the instrumenter.
      */
-    normalizeSourceFileName(sourceFile) {
+    static normalizeSourceFileName(sourceFile) {
         return (0, commons_1.removePrefix)('webpack:///', sourceFile.replace('\\', '/'));
     }
     /**
@@ -129,29 +138,55 @@ class DataStorage {
         return projectCoverage === null || projectCoverage === void 0 ? void 0 : projectCoverage.getCoverage();
     }
     /**
-     * {@inheritDoc IReadableStorage.writeToSimpleCoverageFile}
+     * @inheritDoc
      */
-    dumpToSimpleCoverageFile(filePath) {
-        const toSimpleCoverage = () => {
-            const result = [];
-            commons_1.Contract.require(this.getProjects().length < 2, 'Only one project supported to be handled in parallel.');
-            for (const project of this.getProjects()) {
-                const projectCoverage = this.getCoverageBySourceFile(project);
-                if (!projectCoverage) {
-                    return [0, ''];
-                }
-                for (const entry of projectCoverage) {
-                    result.push(this.normalizeSourceFileName(entry.sourceFile));
-                    for (const lineNo of entry.coveredLines) {
-                        result.push(String(lineNo));
-                    }
+    dumpToSimpleCoverageFile(coverageFolder, date) {
+        const [lines, content] = this.toSimpleCoverage();
+        const coverageFolderTrimmed = coverageFolder.trim();
+        const finalFilePath = this.initCoverageFile(coverageFolderTrimmed, date);
+        fs.writeFileSync(finalFilePath, content, { flag: 'w', encoding: 'utf8' });
+        this.resetCoverage();
+        return [finalFilePath, lines];
+    }
+    /**
+     * Set the collected coverage to 0 for all projects
+     * @private
+     */
+    resetCoverage() {
+        this.coverageByProject = new Map();
+    }
+    /**
+     * Appends the timestamp given with date to the coverageFolder (before the file ending if there is one)
+     * @param coverageFolder Path to the coverage file
+     * @param date Represents the timestamp to be appended with the format {@link DataStorage.DATE_FORMAT}
+     * @private
+     */
+    initCoverageFile(coverageFolder, date) {
+        if (!fs.existsSync(coverageFolder)) {
+            fs.mkdirSync(coverageFolder);
+        }
+        const formattedDate = dat.format(date, this.DATE_FORMAT);
+        return path_1.default.join(coverageFolder, `coverage-${formattedDate}.simple`);
+    }
+    /**
+     * Generate simple coverage format for the collected coverage
+     */
+    toSimpleCoverage() {
+        const result = [];
+        commons_1.Contract.require(this.getProjects().length < 2, 'Only one project supported to be handled in parallel.');
+        for (const project of this.getProjects()) {
+            const projectCoverage = this.getCoverageBySourceFile(project);
+            if (!projectCoverage) {
+                return [0, ''];
+            }
+            for (const entry of projectCoverage) {
+                result.push(DataStorage.normalizeSourceFileName(entry.sourceFile));
+                for (const lineNo of entry.coveredLines) {
+                    result.push(String(lineNo));
                 }
             }
-            return [result.length, result.join('\n')];
-        };
-        const [lines, content] = toSimpleCoverage();
-        fs.writeFileSync(filePath.trim(), content, { flag: 'w', encoding: 'utf8' });
-        return lines;
+        }
+        return [result.length, result.join('\n')];
     }
     /**
      * {@inheritDoc IReadableStorage.getProjects}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.0.1-beta.41",
+  "version": "0.0.1-beta.42",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -27,6 +27,7 @@
     "async": "^3.2.4",
     "axios": "^0.24.0",
     "bunyan": "^1.8.15",
+    "date-and-time": "^2.3.1",
     "dotenv": "^14.1.0",
     "form-data": "^4.0.0",
     "mkdirp": "^1.0.4",