feat(transports): add custom tranporter support for flexible logging

Introduces a new custom transporter feature to Logixlysia, allowing users to send logs to various destinations

fix #51

README.md

@@ -38,6 +38,9 @@ const app = new Elysia({
 app.listen(3000)
 ```
 
+> [!NOTE]
+> You can discover more about example in the [example](example) directory.
+
 ## `📚` Documentation
 
 ### Options

example/transports/index.ts

@@ -0,0 +1,21 @@
+import { Elysia } from 'elysia'
+
+import logixlysia from '~/index'
+
+import MyCustomTransport from './myCustomTransport'
+
+const app = new Elysia()
+  .use(
+    logixlysia({
+      config: {
+        transports: [new MyCustomTransport()]
+      }
+    })
+  )
+  .get('/', () => {
+    return {
+      message: 'Basic Example'
+    }
+  })
+
+app.listen(3000)

example/transports/myCustomTransport.ts

@@ -0,0 +1,13 @@
+import { LogData, LogLevel, RequestInfo, StoreData, Transport } from '~/types'
+
+class MyCustomTransport implements Transport {
+  async log(
+    level: LogLevel,
+    message: string,
+    meta: { request: RequestInfo; data: LogData; store: StoreData }
+  ): Promise<void> {
+    console.log(`Custom log: ${level} - ${message} - ${meta.request.method}`)
+  }
+}
+
+export default MyCustomTransport

src/logger/createLogger.ts

@@ -1,3 +1,4 @@
+import { logToTransports } from '~/transports'
 import {
   LogData,
   Logger,
@@ -42,6 +43,8 @@ async function log(
       options
     )
   }
+
+  await logToTransports(level, request, data, store, options)
 }
 
 /**

src/transports/index.ts

@@ -0,0 +1,22 @@
+import { buildLogMessage } from '~/logger/buildLogMessage'
+import { LogData, LogLevel, Options, RequestInfo, StoreData } from '~/types'
+
+export async function logToTransports(
+  level: LogLevel,
+  request: RequestInfo,
+  data: LogData,
+  store: StoreData,
+  options?: Options
+): Promise<void> {
+  if (!options?.config?.transports || options.config.transports.length === 0) {
+    return
+  }
+
+  const message = buildLogMessage(level, request, data, store, options, false)
+
+  const promises = options.config.transports.map(transport =>
+    transport.log(level, message, { request, data, store })
+  )
+
+  await Promise.all(promises)
+}

src/types.ts

@@ -44,17 +44,34 @@ class HttpError extends Error {
   }
 }
 
+interface TransportFunction {
+  (
+    level: LogLevel,
+    message: string,
+    meta: {
+      request: RequestInfo
+      data: LogData
+      store: StoreData
+    }
+  ): Promise<void> | void
+}
+
+interface Transport {
+  log: TransportFunction
+}
+
 interface Options {
   config?: {
-    ip?: boolean
     customLogFormat?: string
     logFilePath?: string
     logFilter?: {
       level?: LogLevel | LogLevel[]
       method?: string | string[]
       status?: number | number[]
     } | null
+    ip?: boolean
     showBanner?: boolean
+    transports?: Transport[]
   }
 }
 
@@ -67,5 +84,7 @@ export {
   Options,
   RequestInfo,
   Server,
-  StoreData
+  StoreData,
+  Transport,
+  TransportFunction
 }

test/logger/transports.test.ts

@@ -0,0 +1,84 @@
+import { beforeEach, describe, expect, it, jest } from 'bun:test'
+
+import { logToTransports } from '~/transports'
+import {
+  LogData,
+  LogLevel,
+  Options,
+  RequestInfo,
+  StoreData,
+  Transport
+} from '~/types'
+
+describe('Custom Transports', () => {
+  let mockTransport: Transport
+  let options: Options
+
+  beforeEach(() => {
+    mockTransport = {
+      log: jest.fn().mockResolvedValue(undefined)
+    }
+    options = {
+      config: {
+        transports: [mockTransport]
+      }
+    }
+  })
+
+  it('should call the custom transport log function', async () => {
+    const level: LogLevel = 'INFO'
+    const request: RequestInfo = {
+      url: '/test',
+      method: 'GET',
+      headers: { get: () => null }
+    }
+    const data: LogData = { status: 200 }
+    const store: StoreData = { beforeTime: BigInt(0) }
+
+    await logToTransports(level, request, data, store, options)
+
+    expect(mockTransport.log).toHaveBeenCalledTimes(1)
+    expect(mockTransport.log).toHaveBeenCalledWith(level, expect.any(String), {
+      request,
+      data,
+      store
+    })
+  })
+
+  it('should not call any transports if none are configured', async () => {
+    const options: Options = { config: {} }
+    const level: LogLevel = 'INFO'
+    const request: RequestInfo = {
+      url: '/test',
+      method: 'GET',
+      headers: { get: () => null }
+    }
+    const data: LogData = { status: 200 }
+    const store: StoreData = { beforeTime: BigInt(0) }
+
+    await logToTransports(level, request, data, store, options)
+
+    expect(mockTransport.log).not.toHaveBeenCalled()
+  })
+
+  it('should call multiple transports if configured', async () => {
+    const secondMockTransport: Transport = {
+      log: jest.fn().mockResolvedValue(undefined)
+    }
+    options.config!.transports!.push(secondMockTransport)
+
+    const level: LogLevel = 'INFO'
+    const request: RequestInfo = {
+      url: '/test',
+      method: 'GET',
+      headers: { get: () => null }
+    }
+    const data: LogData = { status: 200 }
+    const store: StoreData = { beforeTime: BigInt(0) }
+
+    await logToTransports(level, request, data, store, options)
+
+    expect(mockTransport.log).toHaveBeenCalledTimes(1)
+    expect(secondMockTransport.log).toHaveBeenCalledTimes(1)
+  })
+})

test/logixlysia.test.ts

@@ -2,7 +2,7 @@ import { edenTreaty } from '@elysiajs/eden'
 import { beforeAll, beforeEach, describe, expect, it } from 'bun:test'
 import { Elysia } from 'elysia'
 
-import logixlysia from '../src'
+import logixlysia from '~/index'
 
 describe('Logixlysia', () => {
   let server: Elysia