✨ Allow debug logs to handle error objects like error logs

packages/cli-exec/src/commands/exec/ping.js

@@ -18,7 +18,7 @@ export class Ping extends Command {
       log.info('Percy is running');
     } catch (err) {
       log.error('Percy is not running');
-      log.debug(err.toString());
+      log.debug(err);
       this.exit(1);
     }
   }

packages/cli-exec/src/commands/exec/stop.js

@@ -23,7 +23,7 @@ export class Stop extends Command {
       log.info('Percy has stopped');
     } catch (err) {
       log.error('Percy is not running');
-      log.debug(err.toString());
+      log.debug(err);
       this.exit(1);
     }
   }

packages/config/src/load.js

@@ -67,7 +67,7 @@ export default function load({
       }
     } catch (error) {
       log.debug('Failed to load or parse config file');
-      log.debug(error.toString());
+      log.debug(error);
     }
   }
 

packages/config/test/index.test.js

@@ -282,7 +282,7 @@ describe('PercyConfig', () => {
       expect(stdio[2]).toHaveLength(0);
       expect(stdio[1]).toEqual([
         '[percy] Failed to load or parse config file\n',
-        '[percy] Error: test\n'
+        expect.stringContaining('[percy] Error: test')
       ]);
     });
 

packages/logger/index.js

@@ -66,18 +66,20 @@ logger.loglevel = function loglevel(level, flags = {}) {
   this.transports[0].level = level;
 };
 
-// Patch the error method to handle error objects. Winston accepts objects with
-// messages and meta as an argument but will fail to log real error instances.
-logger.error = function(message) {
-  // libraries may also throw errors which are not technically Error instances
-  if (typeof message === 'object') {
-    // get the stack trace for debug (no ternary to always fallback to string)
-    message = (this.loglevel() === 'debug' && message.stack) || message.toString();
-  }
+// Patch the error and debug methods to handle error objects. Winston accepts objects
+// with messages and meta as an argument but will fail to log real error instances.
+for (let method of ['error', 'debug']) {
+  logger[method] = function(message) {
+    // libraries may also throw errors which are not technically Error instances
+    if (typeof message === 'object') {
+      // get the stack trace for debug (no ternary to always fallback to string)
+      message = (this.loglevel() === 'debug' && message.stack) || message.toString();
+    }
 
-  // return super.error(message)
-  return this.constructor.prototype.error.call(this, message);
-};
+    // return super[method](message)
+    return this.constructor.prototype[method].call(this, message);
+  };
+}
 
 // Patch the query method to return a promise, query the file transport only,
 // and allow filtering logs with a filter function.

packages/logger/test/index.test.js

@@ -98,6 +98,14 @@ describe('logger', () => {
     });
   });
 
+  describe('#debug()', () => {
+    it('is patched to log error instance strings', () => {
+      let err = { toString: () => 'error' };
+      stdio.capture(() => log.debug(err));
+      expect(stdio[1]).toEqual(['[percy] error\n']);
+    });
+  });
+
   describe('#query()', () => {
     beforeEach(() => {
       stdio.capture(() => {