@percy/logger 1.30.0 → 1.30.2-alpha.0

package/dist/index.js

@@ -1,4 +1,5 @@
 import Logger from './logger.js';
+import TimeIt from './timing.js';
 export function logger(name) {
   return new Logger().group(name);
 }
@@ -23,6 +24,12 @@ Object.defineProperties(logger, {
   },
   loglevel: {
     value: (...args) => logger.instance.loglevel(...args)
+  },
+  timeit: {
+    get: () => new TimeIt(logger.instance.group('timer'))
+  },
+  measure: {
+    value: (...args) => logger.timeit.measure(...args)
   }
 });
 export default logger;

package/dist/timing.js

@@ -0,0 +1,64 @@
+export default class TimeIt {
+  // returns a singleton instance
+  constructor(log) {
+    let {
+      instance = this
+    } = this.constructor;
+    instance.log = log;
+    this.constructor.instance = instance;
+    return instance;
+  }
+
+  // this function has some code repeatition as it needs to handle both sync and async
+  // callbacks. It handles both cases when function is marked async but there is no await
+  // as well as functions which have async await and sync functions - including sync
+  // functions which returns a promise instead.
+  // So we need to check if callback is returning promise or not and handle accordingly
+  // it always returns exact same value/promise as callback function and measures time
+  // correctly.
+  measure(name, identifier, meta, callback) {
+    const startTime = Date.now();
+    let errorMsg;
+    let errorStack;
+    const logtime = () => {
+      const duration = Date.now() - startTime;
+      this.log.debug(`${name} - ${identifier} - ${duration / 1000}s`, {
+        durationMs: duration,
+        errorMsg,
+        errorStack,
+        ...meta
+      });
+    };
+    let wasPromise = false;
+    try {
+      let ret = callback();
+      // if it returned a promise then we need to return a promise
+      if (ret.then !== undefined && ret.then != null) {
+        wasPromise = true;
+        return ret.catch(e => {
+          return {
+            error: e,
+            errorReturnedFromMeasure: true
+          };
+        }).then(result => {
+          if (result !== null && result !== void 0 && result.errorReturnedFromMeasure) {
+            errorMsg = result.error.message;
+            errorStack = result.error.stack;
+          }
+          logtime();
+          if (result !== null && result !== void 0 && result.errorReturnedFromMeasure) {
+            throw result.error;
+          }
+          return result;
+        });
+      }
+      return ret;
+    } catch (e) {
+      errorMsg = e.message;
+      errorStack = e.stack;
+      throw e;
+    } finally {
+      if (!wasPromise) logtime();
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/logger",
-  "version": "1.30.0",
+  "version": "1.30.2-alpha.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "alpha"
   },
   "engines": {
     "node": ">=14"
@@ -32,5 +32,5 @@
     "test": "node ../../scripts/test",
     "test:coverage": "yarn test --coverage"
   },
-  "gitHead": "0f9c627b5100eaf4d7262c6671764ffb38d23d33"
+  "gitHead": "5cf337161a28fe90a670b009f2d2149663734047"
 }