Merge pull request #342 from byu-oit/fix/pretty

fix: error with pretty-print and jest
byu-oit · Dec 11, 2023 · 4f612b1 · 4f612b1
2 parents d2f92f8 + d283b16
commit 4f612b1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@byu-oit/logger",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Default configuration for pino logger",
   "contributors": [
     {

diff --git a/src/logger.ts b/src/logger.ts
@@ -15,8 +15,10 @@ export function ByuLogger (options?: LoggerOptions): Logger {
       paths: ['req.headers.authorization', 'req.headers.assertion', 'req.headers["x-jwt-assertion"]', 'req.headers["x-jwt-assertion-original"]'],
       censor: '***'
     },
-    // if in local environment try to pretty print logs
-    ...!isProduction() && isInstalled('pino-pretty') && {
+    // if in local environment and not running tests try to pretty print logs
+    // jest and pretty-print don't get along (causes open handles and sometimes doesn't close),
+    // so we'll default to not include pretty-print if running tests
+    ...!isProduction() && process.env.NODE_ENV !== 'test' && isInstalled('pino-pretty') && {
       transport: {
         target: 'pino-pretty',
         options: { translateTime: 'UTC:yyyy-mm-dd\'T\'HH:MM:ss.l\'Z\'' }