colorize error stack trace and add unit test

hiro5id · May 26, 2023 · 65b3ba9 · 65b3ba9
1 parent 8f75bc9
commit 65b3ba9
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/src/colors/colorize.ts b/src/colors/colorize.ts
@@ -3,6 +3,8 @@ import { jsonStringifySafe } from '../json-stringify-safe/stringify-safe';
 export interface IDefaultColorMap {
   black: string;
   red: string;
+  darkRed: string;
+  lightRed: string;
   green: string;
   darkGreen: string;
   lightGreen: string;
@@ -24,6 +26,8 @@ export interface IDefaultColorMap {
 export const defaultColorMap: IDefaultColorMap = {
   black: '\x1b[30m',
   red: '\x1b[31m',
+  darkRed: '\x1b[38;2;179;5;15m',
+  lightRed: '\x1b[38;2;255;137;149m',
   green: '\x1b[32m',
   darkGreen: '\x1b[38;2;36;119;36m',
   lightGreen: '\x1b[38;2;0;255;127m',
@@ -66,6 +70,8 @@ export interface IColorConfiguration {
   packageName: ColorValue;
   timestampKey: ColorValue;
   timestamp: ColorValue;
+  errCallStackKey: ColorValue;
+  errCallStack: ColorValue;
 }
 
 export type ColorItemName = keyof IColorConfiguration;
@@ -92,6 +98,8 @@ export const defaultColors: IColorConfiguration = {
   packageName: 'yellow',
   timestampKey: 'pink',
   timestamp: 'lightPink',
+  errCallStackKey: 'darkRed',
+  errCallStack: 'lightRed',
 };
 
 // TODO: this is super beta, consider using Sindre's supports-colors
@@ -156,6 +164,9 @@ export function colorJson(jsonInput: any, colorsInput: Partial<IColorConfigurati
             if (/\"@timestamp\"/i.test(match)) {
               colorCode = 'timestampKey';
             }
+            if (/\"errCallStack\"/i.test(match)) {
+              colorCode = 'errCallStackKey';
+            }
           } else {
             colorCode = 'string';
             // If the key is "level" then handle value with special color
@@ -192,6 +203,9 @@ export function colorJson(jsonInput: any, colorsInput: Partial<IColorConfigurati
             if (/\"@timestamp\"/i.test(previousMatchedValue)) {
               colorCode = 'timestamp';
             }
+            if (/\"errCallStack\"/i.test(previousMatchedValue)) {
+              colorCode = 'errCallStack';
+            }
           }
         } else if (/true|false/.test(match)) {
           colorCode = 'boolean';

diff --git a/test/logger.test.ts b/test/logger.test.ts
@@ -1099,6 +1099,23 @@ describe('logger', () => {
     expect(outputText[0].startsWith("\u001b[30m{\u001b[0m\u001b[38;2;26;175;192m\"level\":\u001b[30m\u001b[0m\u001b[38;2;31;230;255m\"info\"\u001b[30m,\u001b[0m\u001b[38;2;36;119;36m\"message\":\u001b[30m\u001b[0m\u001b[38;2;0;255;127m\"this is a test - more messages\"\u001b[30m,\u001b[0m\u001b[38;2;159;147;45m\"@filename\":\u001b[30m\u001b[0m\u001b[33m\"")).eql(true);
   });  
 
+  it('color console.log logs with error object', async () => {
+    sandbox.stub(process.env, 'CONSOLE_LOG_COLORIZE').value('TRUE');
+    const { originalWrite, outputText } = overrideStdOut();
+    LoggerAdaptToConsole();
+
+    const err = new Error("HEY MAN THIS IS AN ERROR!");
+    await console.log('this is a test', { a: 'stuff-a', b: 'stuff-b' }, 'more messages', err,{ c: 1234 });
+
+    restoreStdOut(originalWrite);
+    LoggerRestoreConsole();
+
+    console.log(outputText[0]);
+
+    // const testObj = JSON.parse(outputText[0]);
+    expect(outputText[0].startsWith("\u001b[30m{\u001b[0m\u001b[38;2;26;175;192m\"level\":\u001b[30m\u001b[0m\u001b[31m\"error\"\u001b[30m,\u001b[0m\u001b[38;2;36;119;36m\"message\":\u001b[30m\u001b[0m\u001b[31m\"this is a test - more messages  - HEY MAN THIS IS AN ERROR!\"\u001b[30m,\u001b[0m\u001b[38;2;135;38;162m\"@errorObjectName\":\u001b[30m\u001b[0m\u001b[37m\"Error\"\u001b[30m,\u001b[0m\u001b[38;2;159;147;45m\"@filename\":\u001b[30m\u001b[0m\u001b[33m\"")).eql(true);
+  });    
+
   // Todo: test multiple nested ErrorWithContext objects to ensure proper stacktrace and error messages
 });