logixlysia 3.0.2 → 3.2.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [3.2.0](https://github.com/PunGrumpy/logixlysia/compare/v3.1.0...v3.2.0) (2024-05-07)
+
+
+### Features
+
+* update logger function name for clarity ([9badffc](https://github.com/PunGrumpy/logixlysia/commit/9badffc286fc13feda9eeffd28881990ae437c9f))
+
+## [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)
 
 

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.2",
+  "version": "3.2.0",
   "description": "🦊 Logixlysia is a logger for Elysia",
   "type": "module",
   "module": "src/index.ts",

package/src/index.ts

@@ -1,8 +1,9 @@
 import Elysia from 'elysia'
-import { createLogger, handleHttpError } from './logger'
-import startString from './utils/start'
+import startServer from './utils/start'
 import { Server } from 'bun'
 import { HttpError, Options } from './types'
+import { createLogger } from './logger'
+import { handleHttpError } from './logger/handle'
 
 /**
  * Creates a logger.
@@ -19,14 +20,14 @@ import { HttpError, Options } from './types'
  *
  * @returns {Elysia} The logger.
  */
-export const logger = (options?: Options): Elysia => {
+export default function logixlysia(options?: Options): Elysia {
   const log = createLogger(options)
 
   const elysia = new Elysia({
     name: 'Logixlysia'
   })
     .onStart(ctx => {
-      startString(ctx.server as Server)
+      startServer(ctx.server as Server)
     })
     .onRequest(ctx => {
       ctx.store = { beforeTime: process.hrtime.bigint() }

package/src/logger/filter.ts

@@ -0,0 +1,52 @@
+import { LogLevel, Options } 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
+}
+
+export { filterLog }

package/src/logger/handle.ts

@@ -0,0 +1,29 @@
+import { HttpError, Options, RequestInfo, StoreData } from '~/types'
+import { buildLogMessage } from '.'
+
+/**
+ * Handles an HTTP error.
+ *
+ * @param {RequestInfo} request The request.
+ * @param {HttpError} error The HTTP error.
+ * @param {StoreData} store The store data.
+ * @param {Options} options The options.
+ */
+function handleHttpError(
+  request: RequestInfo,
+  error: HttpError,
+  store: StoreData,
+  options?: Options
+): void {
+  const statusCode = error.status || 500
+  const logMessage = buildLogMessage(
+    'ERROR',
+    request,
+    { status: statusCode },
+    store,
+    options
+  )
+  console.error(logMessage)
+}
+
+export { handleHttpError }

package/src/{logger.ts → logger/index.ts}

@@ -1,18 +1,18 @@
-import chalk from 'chalk'
-import durationString from './utils/duration'
-import methodString from './utils/method'
-import logString from './utils/log'
-import pathString from './utils/path'
-import statusString from './utils/status'
 import {
-  LogLevel,
   LogData,
   Logger,
-  StoreData,
+  LogLevel,
   Options,
   RequestInfo,
-  HttpError
-} from './types'
+  StoreData
+} from '~/types'
+import { filterLog } from './filter'
+import chalk from 'chalk'
+import logString from '~/utils/log'
+import durationString from '~/utils/duration'
+import methodString from '~/utils/method'
+import pathString from '~/utils/path'
+import statusString from '~/utils/status'
 
 /**
  * Logs a message.
@@ -30,6 +30,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)
 }
@@ -85,33 +89,12 @@ function buildLogMessage(
  * @param {Options} options The options.
  * @returns {Logger} The logger.
  */
-export const createLogger = (options?: Options): Logger => ({
-  log: (level, request, data, store) =>
-    log(level, request, data, store, options),
-  customLogFormat: options?.config?.customLogFormat
-})
-
-/**
- * Handles an HTTP error.
- *
- * @param {RequestInfo} request The request.
- * @param {HttpError} error The HTTP error.
- * @param {StoreData} store The store data.
- * @param {Options} options The options.
- */
-export const handleHttpError = (
-  request: RequestInfo,
-  error: HttpError,
-  store: StoreData,
-  options?: Options
-): void => {
-  const statusCode = error.status || 500
-  const logMessage = buildLogMessage(
-    'ERROR',
-    request,
-    { status: statusCode },
-    store,
-    options
-  )
-  console.error(logMessage)
+function createLogger(options?: Options): Logger {
+  return {
+    log: (level, request, data, store) =>
+      log(level, request, data, store, options),
+    customLogFormat: options?.config?.customLogFormat
+  }
 }
+
+export { log, buildLogMessage, createLogger }

package/src/types.ts

@@ -48,6 +48,11 @@ interface Options {
   config?: {
     ip?: boolean
     customLogFormat?: string
+    logFilter?: {
+      level?: LogLevel | LogLevel[]
+      method?: string | string[]
+      status?: number | number[]
+    } | null
   }
 }
 

package/src/utils/start.ts

@@ -21,7 +21,7 @@ function createBoxText(text: string, width: number): string {
  *
  * @returns {void} The server string.
  */
-function startString(config: Server): void {
+function startServer(config: Server): void {
   const { hostname, port, protocol } = config
   const ELYSIA_VERSION = import.meta.require('elysia/package.json').version
   const title = `Elysia v${ELYSIA_VERSION}`
@@ -41,4 +41,4 @@ function startString(config: Server): void {
     `)
 }
 
-export default startString
+export default startServer

package/test/logixlysia.test.ts

@@ -1,7 +1,7 @@
 import { Elysia } from 'elysia'
 import { edenTreaty } from '@elysiajs/eden'
 import { describe, it, expect, beforeAll, beforeEach } from 'bun:test'
-import { logger } from '../src'
+import logixlysia from '../src'
 
 describe('Logixlysia with IP logging enabled', () => {
   let server: Elysia
@@ -11,7 +11,7 @@ describe('Logixlysia with IP logging enabled', () => {
   beforeAll(() => {
     server = new Elysia()
       .use(
-        logger({
+        logixlysia({
           config: {
             ip: true,
             customLogFormat:
@@ -70,7 +70,7 @@ describe('Logixlysia with IP logging disabled', () => {
   beforeAll(() => {
     server = new Elysia()
       .use(
-        logger({
+        logixlysia({
           config: {
             ip: false,
             customLogFormat:
@@ -124,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(
+        logixlysia({
+          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(
+        logixlysia({
+          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)
+  })
+})

package/test/utils/start.test.ts

@@ -1,6 +1,6 @@
 import { afterEach, beforeEach, describe, expect, it, jest } from 'bun:test'
 import { Server } from '~/types'
-import startString from '~/utils/start'
+import startServer from '~/utils/start'
 
 describe('Start String', () => {
   let originalConsoleLog: any
@@ -23,7 +23,7 @@ describe('Start String', () => {
       protocol: 'http'
     }
 
-    startString(config)
+    startServer(config)
 
     const expectedMessage = `🦊 Elysia is running at http://localhost:3000`