@teamscale/coverage-collector 0.1.0-beta.4 → 0.1.0-beta.6

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/coverage-collector",
-    "version": "0.1.0-beta.4",
+    "version": "0.1.0-beta.6",
     "description": "Collector for JavaScript code coverage information",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -22,13 +22,13 @@
         "dist/**/*"
     ],
     "dependencies": {
-        "@cqse/commons": "0.1.0-beta.2",
+        "@cqse/commons": "0.1.0-beta.5",
         "argparse": "^2.0.1",
         "async": "^3.2.5",
-        "axios": "^1.6.5",
+        "axios": "^1.6.7",
         "bunyan": "^1.8.15",
-        "date-and-time": "^3.1.0",
-        "dotenv": "^16.3.1",
+        "date-and-time": "^3.1.1",
+        "dotenv": "^16.4.5",
         "express": "^4.18.2",
         "form-data": "^4.0.0",
         "mkdirp": "^3.0.1",
@@ -39,22 +39,22 @@
         "ws": "^8.16.0"
     },
     "devDependencies": {
-        "@babel/core": "^7.23.7",
-        "@babel/preset-env": "^7.23.8",
+        "@babel/core": "^7.23.9",
+        "@babel/preset-env": "^7.23.9",
         "@types/argparse": "^2.0.14",
         "@types/async": "^3.2.24",
         "@types/bunyan": "^1.8.11",
         "@types/express": "^4.17.21",
-        "@types/jest": "^29.5.11",
-        "@types/node": "^20.11.0",
+        "@types/jest": "^29.5.12",
+        "@types/node": "^20.11.19",
         "@types/tmp": "^0.2.6",
         "@types/ws": "^8.5.10",
         "babel-jest": "^29.7.0",
-        "esbuild": "^0.19.11",
+        "esbuild": "^0.20.1",
         "jest": "^29.7.0",
         "mockttp": "^3.10.1",
         "rimraf": "^5.0.5",
-        "ts-jest": "^29.1.1",
+        "ts-jest": "^29.1.2",
         "ts-node": "^10.9.2",
         "typescript": "^5.3.3"
     },

package/dist/src/App.d.ts

@@ -25,6 +25,11 @@ export declare class App {
     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.
      *

package/dist/src/App.js

@@ -101,8 +101,10 @@ class App {
         // Start the server socket.
         // ATTENTION: The server is executed asynchronously
         const serverState = server.start();
-        // Optionally, start a timer that dumps the coverage after a N seconds
-        const timerState = this.maybeStartDumpTimer(config, storage, logger);
+        // Optionally, start a timer that dumps the coverage after N seconds
+        const dumpTimerState = this.maybeStartDumpTimer(config, storage, logger);
+        // Start a timer that informs if no coverage was received within the last minute
+        const statsTimerState = this.startNoMessageTimer(logger, server);
         // Say bye bye on CTRL+C and exit the process
         process.on('SIGINT', async () => {
             // ... and do a final dump before.
@@ -113,12 +115,33 @@ class App {
         return {
             async stop() {
                 logger.info('Stopping the collector.');
-                timerState.stop();
+                dumpTimerState.stop();
+                statsTimerState.stop();
                 await controlServerState.stop();
                 serverState.stop();
             }
         };
     }
+    /**
+     * Starts a timer that shows a message every min that no coverage
+     * was received until the opposite is the case.
+     */
+    static startNoMessageTimer(logger, server) {
+        const startTime = Date.now();
+        const timer = setInterval(async () => {
+            const stats = server.getStatistics();
+            if (stats.totalCoverageMessages === 0) {
+                logger.info(`No coverage received for ${((Date.now() - startTime) / 1000.0).toFixed(0)}s.`);
+            }
+            else {
+                // We can stop running the timer after we have received the first coverage.
+                clearInterval(timer);
+            }
+        }, 1000 * 60);
+        return {
+            stop: () => clearInterval(timer)
+        };
+    }
     /**
      * Start a timer for dumping the data, depending on the configuration.
      *

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

@@ -17,6 +17,14 @@ export declare class WebSocketCollectingServer {
      * The logger to use.
      */
     private readonly logger;
+    /**
+     * The number of messages that have been received.
+     */
+    private totalNumMessagesReceived;
+    /**
+     * The number of coverage messages that have been received.
+     */
+    private totalNumCoverageMessagesReceived;
     /**
      * Constructor.
      *
@@ -55,4 +63,11 @@ export declare class WebSocketCollectingServer {
      * A file name is a token; a range (start to end line) is a token.
      */
     private handleCoverageMessage;
+    /**
+     * Returns a statistic on the number of messages received.
+     */
+    getStatistics(): {
+        totalMessages: number;
+        totalCoverageMessages: number;
+    };
 }

package/dist/src/receiver/CollectingServer.js

@@ -46,6 +46,8 @@ class WebSocketCollectingServer {
         this.storage = commons_1.Contract.requireDefined(storage);
         this.logger = commons_1.Contract.requireDefined(logger);
         this.server = new WebSocket.Server({ port });
+        this.totalNumMessagesReceived = 0;
+        this.totalNumCoverageMessagesReceived = 0;
     }
     /**
      * Start the server socket, handle sessions and dispatch messages.
@@ -56,16 +58,17 @@ class WebSocketCollectingServer {
         // Handle new connections from clients
         (_b = this.server) === null || _b === void 0 ? void 0 : _b.on('connection', (webSocket, req) => {
             let session = new Session_1.Session(req.socket, this.storage, this.logger);
-            this.logger.debug(`Connection from: ${req.socket.remoteAddress}`);
+            this.logger.trace(`Connection from: ${req.socket.remoteAddress}`);
             // Handle disconnecting clients
             webSocket.on('close', code => {
                 if (session) {
                     session = null;
-                    this.logger.debug(`Closing with code ${code}`);
+                    this.logger.trace(`Closing with code ${code}`);
                 }
             });
             // Handle incoming messages
             webSocket.on('message', (message) => {
+                this.totalNumMessagesReceived += 1;
                 if (session && Buffer.isBuffer(message)) {
                     void this.handleMessage(session, message);
                 }
@@ -93,6 +96,7 @@ class WebSocketCollectingServer {
         try {
             const messageType = message.toString('utf8', 0, 1);
             if (messageType.startsWith(MESSAGE_TYPE_COVERAGE)) {
+                this.totalNumCoverageMessagesReceived += 1;
                 await this.handleCoverageMessage(session, message.subarray(1));
             }
         }
@@ -140,5 +144,14 @@ class WebSocketCollectingServer {
             }
         });
     }
+    /**
+     * Returns a statistic on the number of messages received.
+     */
+    getStatistics() {
+        return {
+            totalMessages: this.totalNumMessagesReceived,
+            totalCoverageMessages: this.totalNumCoverageMessagesReceived
+        };
+    }
 }
 exports.WebSocketCollectingServer = WebSocketCollectingServer;

package/dist/src/storage/DataStorage.js

@@ -109,7 +109,7 @@ class DataStorage {
             this.coverageByProject.set(project, projectCoverage);
         }
         coveredOriginalLines.forEach(line => projectCoverage === null || projectCoverage === void 0 ? void 0 : projectCoverage.putLine(sourceFilePath, line));
-        this.logger.debug(`Mapped Coverage: ${project} ${uniformPath} ${coveredOriginalLines}`);
+        this.logger.trace(`Mapped Coverage: ${project} ${uniformPath} ${coveredOriginalLines}`);
     }
     /**
      * Normalize the source file names provided by the Web browsers / from the
@@ -127,7 +127,7 @@ class DataStorage {
         // Currently only implemented to log the missing information.
         this.timesUnmappedCoverage++;
         if (this.timesUnmappedCoverage === 1) {
-            this.logger.debug(`Received unmapped coverage for project "${project}"`);
+            this.logger.trace(`Received unmapped coverage for project "${project}"`);
         }
     }
     /**

package/dist/src/upload/ArtifactoryUpload.d.ts

@@ -1,5 +1,5 @@
 import { ConfigParameters } from '../utils/ConfigParameters';
-import Logger from 'bunyan';
+import Logger from "bunyan";
 /**
  * Uploads a coverage file to artifactory with the provided configuration.
  */

package/dist/src/upload/ArtifactoryUpload.js

@@ -17,7 +17,7 @@ async function uploadToArtifactory(config, logger, coverageFile, lines) {
     if (lines === 0) {
         return;
     }
-    logger.info('Preparing upload to Artifactory');
+    logger.debug('Preparing upload to Artifactory');
     const form = (0, CommonUpload_1.prepareFormData)(coverageFile);
     await performArtifactoryUpload(config, form, logger);
 }

package/dist/src/upload/CommonUpload.js

@@ -27,28 +27,35 @@ exports.prepareFormData = prepareFormData;
  * Uploads a coverage file with the provided configuration.
  */
 async function performUpload(url, form, config, uploadFunction, logger) {
+    var _a, _b;
     try {
         const response = await uploadFunction(url, form, config);
-        logger.info(`Upload finished with code ${response.status}.`);
+        logger.debug(`Upload finished with code ${response.status}.`);
     }
     catch (error) {
         if (axios_1.default.isAxiosError(error)) {
+            let userMessage;
+            if (error.message) {
+                logger.error(`Upload error ${(_a = error.status) !== null && _a !== void 0 ? _a : 'UNDEFINED'}: ${error.message}`);
+            }
             if (error.response) {
-                const response = error.response;
-                if (response.status >= 400) {
-                    throw new UploadError(`Upload failed with code ${response.status}: ${response.statusText}. Response Data: ${response.data}`);
-                }
-                else {
-                    logger.info(`Upload with status code ${response.status} finished.`);
-                }
+                // The request was made and the server responded with a status code
+                // that falls out of the range of 2xx
+                logger.error('Upload error response data:', error.response.data);
+                logger.error('Upload error response status:', error.response.status);
+                logger.error('Upload error response headers:', JSON.stringify(error.response.headers));
+                userMessage = `Request failed with status ${error.response.status}: ${(_b = error.response.data) !== null && _b !== void 0 ? _b : ''}`;
             }
             else if (error.request) {
-                throw new UploadError(`Upload request did not receive a response.`);
+                // The request was made but no response was received
+                userMessage = 'No response received for the request.';
             }
-            if (error.message) {
-                logger.debug(`Something went wrong when uploading data: ${error.message}. Details of the error: ${(0, util_1.inspect)(error)}`);
-                throw new UploadError(`Something went wrong when uploading data: ${error.message}`);
+            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 uploading data: ${userMessage}`);
         }
         throw new UploadError(`Something went wrong when uploading data: ${(0, util_1.inspect)(error)}`);
     }

package/dist/src/upload/TeamscaleUpload.js

@@ -18,7 +18,7 @@ async function uploadToTeamscale(config, logger, coverageFile, lines) {
     if (lines === 0) {
         return;
     }
-    logger.info('Preparing upload to Teamscale');
+    logger.debug('Preparing upload to Teamscale');
     const form = (0, CommonUpload_1.prepareFormData)(coverageFile);
     const queryParameters = prepareQueryParameters(config);
     await performTeamscaleUpload(config, queryParameters, form, logger);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/coverage-collector",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.6",
   "description": "Collector for JavaScript code coverage information",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -15,13 +15,13 @@
     "dist/**/*"
   ],
   "dependencies": {
-    "@cqse/commons": "0.1.0-beta.2",
+    "@cqse/commons": "0.1.0-beta.5",
     "argparse": "^2.0.1",
     "async": "^3.2.5",
-    "axios": "^1.6.5",
+    "axios": "^1.6.7",
     "bunyan": "^1.8.15",
-    "date-and-time": "^3.1.0",
-    "dotenv": "^16.3.1",
+    "date-and-time": "^3.1.1",
+    "dotenv": "^16.4.5",
     "express": "^4.18.2",
     "form-data": "^4.0.0",
     "mkdirp": "^3.0.1",
@@ -32,22 +32,22 @@
     "ws": "^8.16.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.7",
-    "@babel/preset-env": "^7.23.8",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
     "@types/argparse": "^2.0.14",
     "@types/async": "^3.2.24",
     "@types/bunyan": "^1.8.11",
     "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.19",
     "@types/tmp": "^0.2.6",
     "@types/ws": "^8.5.10",
     "babel-jest": "^29.7.0",
-    "esbuild": "^0.19.11",
+    "esbuild": "^0.20.1",
     "jest": "^29.7.0",
     "mockttp": "^3.10.1",
     "rimraf": "^5.0.5",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
   },