fix(logger): add config property for logging configuration

Adding `config` property to the `Options` interface to enhance clearity and consistency
PunGrumpy · Apr 8, 2024 · 27d80eb · 27d80eb
1 parent bfa33cb
commit 27d80eb
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 16 deletions.
diff --git a/example/basic.ts b/example/basic.ts
@@ -6,9 +6,11 @@ const app = new Elysia({
 })
   .use(
     logger({
-      ip: true,
-      customLogFormat:
-        '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}' // default format
+      config: {
+        ip: true,
+        customLogFormat:
+          '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
+      }
     })
   )
   .get('/', () => {

diff --git a/src/logger.ts b/src/logger.ts
@@ -4,8 +4,15 @@ import methodString from './utils/method'
 import logString from './utils/log'
 import pathString from './utils/path'
 import statusString from './utils/status'
-import { HttpError, RequestInfo } from './types'
-import { LogLevel, LogData, Logger, StoreData, Options } from './types'
+import {
+  LogLevel,
+  LogData,
+  Logger,
+  StoreData,
+  Options,
+  RequestInfo,
+  HttpError
+} from './types'
 
 /**
  * Logs a message.
@@ -52,12 +59,12 @@ function buildLogMessage(
   const statusStr = statusString(data.status || 200)
   const messageStr = data.message || ''
   const ipStr =
-    options?.ip && request.headers.get('x-forwarded-for')
+    options?.config?.ip && request.headers.get('x-forwarded-for')
       ? `IP: ${request.headers.get('x-forwarded-for')}`
       : ''
 
   const logFormat =
-    options?.customLogFormat ||
+    options?.config?.customLogFormat ||
     '🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
   const logMessage = logFormat
     .replace('{now}', nowStr)
@@ -81,7 +88,7 @@ function buildLogMessage(
 export const createLogger = (options?: Options): Logger => ({
   log: (level, request, data, store) =>
     log(level, request, data, store, options),
-  customLogFormat: options?.customLogFormat
+  customLogFormat: options?.config?.customLogFormat
 })
 
 /**

diff --git a/src/types.ts b/src/types.ts
@@ -45,8 +45,10 @@ class HttpError extends Error {
 }
 
 interface Options {
-  ip?: boolean
-  customLogFormat?: string
+  config?: {
+    ip?: boolean
+    customLogFormat?: string
+  }
 }
 
 export {

diff --git a/test/logixlysia.test.ts b/test/logixlysia.test.ts
@@ -12,9 +12,11 @@ describe('Logixlysia with IP logging enabled', () => {
     server = new Elysia()
       .use(
         logger({
-          ip: true,
-          customLogFormat:
-            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          config: {
+            ip: true,
+            customLogFormat:
+              '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          }
         })
       )
       .get('/', ctx => {
@@ -69,9 +71,11 @@ describe('Logixlysia with IP logging disabled', () => {
     server = new Elysia()
       .use(
         logger({
-          ip: false,
-          customLogFormat:
-            '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          config: {
+            ip: false,
+            customLogFormat:
+              '🦊 {now} {duration} {level} {method} {pathname} {status} {message} {ip}'
+          }
         })
       )
       .get('/', () => '🦊 Logixlysia Getting')