🐛 Fix sdk-utils test helper log capture (#920)

percy · May 9, 2022 · 064a4fb · 064a4fb
1 parent 8e7c9bc
commit 064a4fb
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 15 deletions.
diff --git a/packages/sdk-utils/src/logger.js b/packages/sdk-utils/src/logger.js
@@ -6,7 +6,7 @@ const LOG_LEVELS = { debug: 0, info: 1, warn: 2, error: 3 };
 // Create a small logger util using the specified namespace
 export function logger(namespace) {
   return Object.keys(LOG_LEVELS).reduce((ns, lvl) => (
-    Object.assign(ns, { [lvl]: log.bind(null, namespace, lvl) })
+    Object.assign(ns, { [lvl]: (...a) => logger.log(namespace, lvl, ...a) })
   ), {});
 }
 
@@ -90,8 +90,8 @@ const remote = logger.remote = async timeout => {
     if (log.history) ws.send(JSON.stringify({ messages: log.history }));
   } catch (err) {
     // there was an error connecting, will fallback to minimal logging
-    log('utils', 'debug', 'Unable to connect to remote logger');
-    log('utils', 'debug', err);
+    logger.log('utils', 'debug', 'Unable to connect to remote logger');
+    logger.log('utils', 'debug', err);
   }
 };
 

diff --git a/packages/sdk-utils/test/helpers.js b/packages/sdk-utils/test/helpers.js
@@ -41,6 +41,8 @@ const helpers = {
   },
 
   async teardown() {
+    utils.logger.log.restore?.();
+
     if (process.env.__PERCY_BROWSERIFIED__) {
       for (let m of ['warn', 'error', 'log']) console[m].restore?.();
     } else {
@@ -68,21 +70,23 @@ const helpers = {
     async mock() {
       helpers.logger.reset();
 
-      let capture = err => msg => {
-        helpers.logger[err ? 'stderr' : 'stdout']
-          .push(sanitizeLog(msg));
-      };
+      let shouldCaptureLogs = false;
+
+      stub(utils.logger, 'log', (...args) => {
+        shouldCaptureLogs = true;
+        utils.logger.log.originalValue(...args);
+        shouldCaptureLogs = false;
+      });
+
+      let stubLogs = (ctx, method, err) => stub(ctx, method, msg => {
+        if (!shouldCaptureLogs) return ctx[method].originalValue.call(ctx, msg);
+        else helpers.logger[err ? 'stderr' : 'stdout'].push(sanitizeLog(msg));
+      });
 
       if (process.env.__PERCY_BROWSERIFIED__) {
-        // use console[warn|error|log] in browsers
-        for (let m of ['warn', 'error', 'log']) {
-          stub(console, m, capture(m !== 'log'));
-        }
+        for (let m of ['warn', 'error', 'log']) stubLogs(console, m, m !== 'log');
       } else {
-        // use process[stdout|stderr].write in node
-        for (let io of ['stdout', 'stderr']) {
-          stub(process[io], 'write', capture(io === 'stderr'));
-        }
+        for (let io of ['stdout', 'stderr']) stubLogs(process[io], 'write', io === 'stderr');
       }
     },
 
@@ -93,6 +97,7 @@ const helpers = {
 
       helpers.logger.stdout.length = 0;
       helpers.logger.stderr.length = 0;
+      utils.logger.log.reset?.();
 
       if (process.env.__PERCY_BROWSERIFIED__) {
         for (let m of ['warn', 'error', 'log']) console[m].reset?.();