fix: defer aynsc_hooks warning (fixes #50)

gajus · Jul 27, 2021 · 51be614 · 51be614
1 parent 331289d
commit 51be614
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 4 deletions.
diff --git a/src/factories/createLogger.ts b/src/factories/createLogger.ts
@@ -17,6 +17,8 @@ import type {
   TranslateMessageFunction,
 } from '../types';
 
+let loggedWarning = false;
+
 const globalThis = createGlobalThis();
 
 const getAsyncLocalContext = () => {
@@ -167,6 +169,21 @@ const createLogger = (
     const asyncLocalStorage = globalThis.ROARR.asyncLocalStorage;
 
     if (!asyncLocalStorage) {
+      if (loggedWarning === false) {
+        loggedWarning = true;
+
+        onMessage({
+          context: {
+            logLevel: logLevels.warn,
+            package: 'roarr',
+          },
+          message: 'async_hooks are unavailable; Roarr.child will not function as expected',
+          sequence: getSequence(),
+          time: Date.now(),
+          version: ROARR_LOG_FORMAT_VERSION,
+        });
+      }
+
       return routine();
     }
 

diff --git a/src/factories/createRoarrInitialGlobalState.ts b/src/factories/createRoarrInitialGlobalState.ts
@@ -41,10 +41,8 @@ export default (currentState: any): RoarrGlobalState => {
         ...createNodeWriter(),
         asyncLocalStorage,
       };
-    } catch {
-      // eslint-disable-next-line no-console
-      console.warn('async_hooks are unavailable; Roarr.child will not function as expected');
-    }
+    // eslint-disable-next-line no-empty
+    } catch {}
   }
 
   return newState;

diff --git a/test/roarr/asyncLocalScope.ts b/test/roarr/asyncLocalScope.ts
@@ -35,6 +35,41 @@ const createLoggerWithHistory = () => {
   return log;
 };
 
+serial('warns if async_hooks are unavailable', async (t) => {
+  const firstLog = createLoggerWithHistory();
+
+  const log = firstLog.child({
+    // Ensure that we are not adding context to the internal warning.
+    foo: 'bar',
+  });
+
+  globalThis.ROARR.asyncLocalStorage = null;
+
+  await log.adopt(
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    () => {},
+  );
+
+  // Ensure that we log only once.
+  await log.adopt(
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    () => {},
+  );
+
+  t.deepEqual(firstLog.messages, [
+    {
+      context: {
+        logLevel: 40,
+        package: 'roarr',
+      },
+      message: 'async_hooks are unavailable; Roarr.child will not function as expected',
+      sequence: '0',
+      time,
+      version,
+    },
+  ]);
+});
+
 serial('inherits context from async local scope', async (t) => {
   const log = createLoggerWithHistory();