Enhanced logging information (#23)

* implemented interface for centralized logging behaviour * Added success and error logging for all commands * Added logging for download progress
AlexanderSkrock · Oct 2, 2023 · 377590d · 377590d
1 parent 1ce10ef
commit 377590d
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 10 deletions.
diff --git a/bin/index.js b/bin/index.js
@@ -2,8 +2,8 @@
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
 
-const { getAllVersions, download, install, launch } = require('../lib');
-const { getConfig } = require('../lib');
+const { getAllVersions, download, getConfig, install, launch } = require('../lib');
+const { error, info } = require('../lib/logging');
 
 // eslint-disable-next-line
 yargs(hideBin(process.argv))
@@ -12,7 +12,9 @@ yargs(hideBin(process.argv))
         'versions',
         'List available versions of the Camunda Modeler',
         () => {},
-        () => getAllVersions().then((versions) => process.stdout.write(`Versions:\n${versions.join('\n')}\n`)),
+        () => getAllVersions()
+            .then((versions) => info(versions.join('\n')))
+            .catch(err => error(err)),
     )
     .command(
         'download',
@@ -26,7 +28,8 @@ yargs(hideBin(process.argv))
             version: args.version,
             noCache: !args.cache,
             cachePath: args['cache-path'],
-        }).then((res) => process.stdout.write(`Download was finished successfully: ${res}`)),
+        }).then((res) => info(`Download was finished successfully: ${res}`))
+            .catch(err => error(err)),
     )
     .command(
         'install',
@@ -46,14 +49,16 @@ yargs(hideBin(process.argv))
             installationPath: args.path,
             overwriteExistingInstallation: args.overwrite,
             linkedPlugins: [args['link-plugin']],
-        }).then((res) => process.stdout.write(`Installation was finished successfully: ${res}\n`)),
+        }).then((res) => info(`Installation was finished successfully: ${res}`))
+            .catch(err => error(err)),
     )
     .command(
         'launch',
         'Launch Camunda Modeler',
         (yargs) => yargs.option('path', { default: getConfig().getInstallationPath() }),
         args => launch({
             installationPath: args.path,
-        }).catch(err => `An error occurred: ${err}`),
+        }).then(() => info('Camunda Modeler launched successfully'))
+            .catch(err => error(err)),
     )
     .argv;
diff --git a/lib/download.js b/lib/download.js
@@ -2,6 +2,7 @@ const { basename } = require('node:path');
 
 const { getReleaseByVersion, getLatestRelease } = require('./api');
 const Cache = require('./cache');
+const { ProgressTransformStream } = require('./logging');
 
 function getDownloadLink (platform, version) {
     const release = version === null || version === undefined
@@ -20,9 +21,10 @@ function getDownloadLink (platform, version) {
 function downloadToCache (cache, cacheKey, link) {
     return fetch(link).then(response => {
         if (!response.ok) {
-            return new Error('Response status was ' + response.status);
+            throw new Error('Response status was ' + response.status);
         }
-        return cache.put(cacheKey, response.body);
+        const length = response.headers.get('Content-Length');
+        return cache.put(cacheKey, response.body.pipeThrough(new ProgressTransformStream(length)));
     });
 }
 
@@ -34,8 +36,9 @@ function downloadCamundaModeler (config) {
         return Promise.all([
             cache.isCached(fileName),
             config.shouldSkipCache() ? Promise.reject(new Error('cache may not be used')) : Promise.resolve(),
-        ]).catch(() => downloadToCache(cache, fileName, link))
-            .then(() => cache.get(fileName));
+        ]).catch(() => {
+            return downloadToCache(cache, fileName, link);
+        }).then(() => cache.get(fileName));
     });
 }
 

diff --git a/lib/logging/ProgressTransformStream.js b/lib/logging/ProgressTransformStream.js
@@ -0,0 +1,33 @@
+const { info } = require('./logger');
+
+const PERCENTAGE_STEP_SIZE = 5;
+
+class ProgressTransformOptions {
+    constructor (streamLength) {
+        this.lastLogged = 0;
+        this.progress = 0;
+        this.length = streamLength;
+    }
+
+    transform (chunk, controller) {
+        this.progress += chunk.length;
+        controller.enqueue(chunk);
+        this.logProgress();
+    }
+
+    logProgress () {
+        const percentage = Math.trunc(this.progress * 100 / this.length);
+        if (percentage >= this.lastLogged + PERCENTAGE_STEP_SIZE) {
+            info(`Progress: ${percentage}%`);
+            this.lastLogged = percentage;
+        }
+    }
+}
+
+class ProgressTransformStream extends TransformStream {
+    constructor (streamLength) {
+        super(new ProgressTransformOptions(streamLength));
+    }
+}
+
+module.exports = ProgressTransformStream;
diff --git a/lib/logging/index.js b/lib/logging/index.js
@@ -0,0 +1,16 @@
+const logger = require('./logger');
+const ProgressTransformStream = require('./ProgressTransformStream');
+
+function info (msg) {
+    logger.info(msg);
+}
+
+function error (error) {
+    logger.error(error);
+}
+
+module.exports = {
+    info,
+    error,
+    ProgressTransformStream,
+};
diff --git a/lib/logging/logger.js b/lib/logging/logger.js
@@ -0,0 +1,6 @@
+const LOGGER = {
+    info: msg => console.info(msg),
+    error: err => console.error(err),
+};
+
+module.exports = LOGGER;