logixlysia 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [3.1.0](https://github.com/PunGrumpy/logixlysia/compare/v3.0.2...v3.1.0) (2024-04-09)
+
+
+### Features
+
+* **logger:** add log filtering functional ([af7d9ec](https://github.com/PunGrumpy/logixlysia/commit/af7d9ec5b2bb5ff5942d1a586be23a9d23a2c1cf)), closes [#38](https://github.com/PunGrumpy/logixlysia/issues/38)
+
+
+### Bug Fixes
+
+* CI/CD GitHub Actions ([3c40092](https://github.com/PunGrumpy/logixlysia/commit/3c40092bd0ac7bf8bd601a299453cf5080224234))
+
+## [3.0.2](https://github.com/PunGrumpy/logixlysia/compare/v3.0.1...v3.0.2) (2024-04-08)
+
+
+### Bug Fixes
+
+* **logger:** add `config` property for logging configuration ([27d80eb](https://github.com/PunGrumpy/logixlysia/commit/27d80eb6b0c3a4a40a96738b235d9bc6b117c804))
+
 ## [3.0.1](https://github.com/PunGrumpy/logixlysia/compare/v3.0.0...v3.0.1) (2024-04-08)
 
 

package/README.md

@@ -37,6 +37,7 @@ app.listen(3000)
 | ------------------ | --------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------- |
 | `ip`               | `boolean` | Display the incoming IP address based on the `X-Forwarded-For` header | `false`                                                                   |
 | `customLogMessage` | `string`  | Custom log message to display                                         | `🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}` |
+| `logFilter`        | `object`  | Filter the logs based on the level, method, and status                | `null`                                                                    |
 
 ## `📄` License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logixlysia",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",

package/src/logger.ts

@@ -4,8 +4,64 @@ 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'
+
+/**
+ * Filters log messages.
+ *
+ * @param {LogLevel} logLevel The log level.
+ * @param {number} status The status code.
+ * @param {string} method The method.
+ * @param {Options} options The options.
+ * @returns {boolean} `true` if the log message should be logged, otherwise `false`.
+ */
+function filterLog(
+  logLevel: LogLevel,
+  status: number,
+  method: string,
+  options?: Options
+): boolean {
+  const filter = options?.config?.logFilter
+
+  if (!filter) return true
+
+  // Level
+  if (filter.level) {
+    if (Array.isArray(filter.level)) {
+      if (!filter.level.includes(logLevel)) return false
+    }
+  } else {
+    if (filter.level !== logLevel) return false
+  }
+
+  // Status
+  if (filter.status) {
+    if (Array.isArray(filter.status)) {
+      if (!filter.status.includes(status)) return false
+    }
+  } else {
+    if (filter.status !== status) return false
+  }
+
+  // Method
+  if (filter.method) {
+    if (Array.isArray(filter.method)) {
+      if (!filter.method.includes(method)) return false
+    }
+  } else {
+    if (filter.method !== method) return false
+  }
+
+  return true
+}
 
 /**
  * Logs a message.
@@ -23,6 +79,10 @@ function log(
   store: StoreData,
   options?: Options
 ): void {
+  if (!filterLog(level, data.status || 200, request.method, options)) {
+    return
+  }
+
   const logMessage = buildLogMessage(level, request, data, store, options)
   console.log(logMessage)
 }
@@ -52,12 +112,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 +141,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
 })
 
 /**

package/src/types.ts

@@ -45,8 +45,15 @@ class HttpError extends Error {
 }
 
 interface Options {
-  ip?: boolean
-  customLogFormat?: string
+  config?: {
+    ip?: boolean
+    customLogFormat?: string
+    logFilter?: {
+      level?: LogLevel | LogLevel[]
+      method?: string | string[]
+      status?: number | number[]
+    } | null
+  }
 }
 
 export {

package/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')
@@ -120,3 +124,106 @@ describe('Logixlysia with IP logging disabled', () => {
     expect(error).toBeInstanceOf(Error)
   })
 })
+
+describe('Logixlysia with log filtering enabled', () => {
+  let server: Elysia
+  let app: any
+  let logs: string[] = []
+
+  beforeAll(() => {
+    server = new Elysia()
+      .use(
+        logger({
+          config: {
+            logFilter: {
+              level: 'INFO',
+              status: [200, 404],
+              method: 'GET'
+            }
+          }
+        })
+      )
+      .get('/', () => '🦊 Logixlysia Getting')
+      .post('logixlysia', () => '🦊 Logixlysia Posting')
+      .listen(3000)
+
+    app = edenTreaty<typeof server>('http://127.0.0.1:3000')
+  })
+
+  beforeEach(() => {
+    logs = []
+  })
+
+  it("Logs 'GET' requests with status 200 or 404 when log filtering criteria are met", async () => {
+    const requestCount = 5
+
+    for (let i = 0; i < requestCount; i++) {
+      logs.push((await app.get('/')).data)
+    }
+
+    expect(logs.length).toBe(requestCount)
+    logs.forEach(log => {
+      expect(log).toMatch('🦊 Logixlysia Getting')
+    })
+  })
+
+  it("Doesn't log 'POST' requests when log filtering criteria are not met", async () => {
+    const requestCount = 5
+
+    for (let i = 0; i < requestCount; i++) {
+      await app.post('/logixlysia', {})
+    }
+
+    expect(logs.length).toBe(0)
+  })
+
+  const otherMethods = ['PUT', 'DELETE', 'PATCH', 'HEAD'] // OPTIONS is failed (IDK why)
+  otherMethods.forEach(async method => {
+    it(`Logs '${method}' requests with status 200 or 404 when log filtering criteria are met`, async () => {
+      const requestCount = 5
+
+      for (let i = 0; i < requestCount; i++) {
+        logs.push((await app[method.toLowerCase()]('/')).data)
+      }
+
+      expect(logs.length).toBe(requestCount)
+    })
+  })
+})
+
+describe('Logixlysia with log filtering disabled', () => {
+  let server: Elysia
+  let app: any
+  let logs: string[] = []
+
+  beforeAll(() => {
+    server = new Elysia()
+      .use(
+        logger({
+          config: {
+            logFilter: null
+          }
+        })
+      )
+      .get('/', () => '🦊 Logixlysia Getting')
+      .post('logixlysia', () => '🦊 Logixlysia Posting')
+      .listen(3000)
+
+    app = edenTreaty<typeof server>('http://127.0.0.1:3000')
+  })
+
+  beforeEach(() => {
+    logs = []
+  })
+
+  it('Logs all requests when log filtering is disabled', async () => {
+    const requestCount = 5
+
+    for (let i = 0; i < requestCount; i++) {
+      logs.push((await app.get('/')).data)
+      logs.push((await app.post('/logixlysia', {})).data)
+    }
+
+    expect(logs.length).toBe(requestCount * 2)
+  })
+})