refactor(*): update logger functionally to support configurable IP lo…

…gging

1. modified the logger functions in logger.ts to accept an options parameter, allowing for the
configuration of IP logging , 2. move all files in types folder to types.ts

src/index.ts

@@ -2,7 +2,7 @@ import Elysia from 'elysia'
 import { createLogger, handleHttpError } from './logger'
 import startString from './utils/start'
 import { Server } from 'bun'
-import { Options } from './options'
+import { Options } from './types'
 
 /**
  * Creates a logger.
@@ -20,7 +20,7 @@ import { Options } from './options'
  * @returns {Elysia} The logger.
  */
 export const logger = (options?: Options): Elysia => {
-  const log = createLogger()
+  const log = createLogger(options)
 
   const elysia = new Elysia({
     name: 'Logixlysia'

src/logger.ts

@@ -4,51 +4,26 @@ import methodString from './utils/method'
 import logString from './utils/log'
 import pathString from './utils/path'
 import statusString from './utils/status'
-import { RequestInfo } from './types/RequestInfo'
-import { LogData, LogLevel, Logger } from './types/Logger'
-import { StoreData } from './types/StoreData'
-import { HttpError } from './types/HttpError'
+import { HttpError, RequestInfo } from './types'
+import { LogLevel, LogData, Logger, StoreData, Options } from './types'
 
-/**
- * Asynchronously logs a message constructed from various log components.
- *
- * @async
- * @param {LogLevel} level - The log level.
- * @param {RequestInfo} request - The request information.
- * @param {LogData} data - The log data.
- * @param {StoreData} store - The store data.
- *
- * @returns {Promise<void>}
- */
 async function log(
   level: LogLevel,
   request: RequestInfo,
   data: LogData,
-  store: StoreData
+  store: StoreData,
+  options?: Options
 ): Promise<void> {
-  const logMessage = buildLogMessage(level, request, data, store)
-  try {
-    await writeToLogAsync(logMessage)
-  } catch (error) {
-    console.error('Error logging message:', error)
-  }
+  const logMessage = buildLogMessage(level, request, data, store, options)
+  console.log(logMessage)
 }
 
-/**
- * Builds the log message string from given parameters.
- *
- * @param {LogLevel} level - The log level.
- * @param {RequestInfo} request - The request information.
- * @param {LogData} data - The log data.
- * @param {StoreData} store - The store data.
- *
- * @returns {string} - The constructed log message.
- */
 function buildLogMessage(
   level: LogLevel,
   request: RequestInfo,
   data: LogData,
-  store: StoreData
+  store: StoreData,
+  options?: Options
 ): string {
   const nowStr = chalk.bgYellow(chalk.black(new Date().toLocaleString()))
   const levelStr = logString(level)
@@ -58,56 +33,36 @@ function buildLogMessage(
   const statusStr = statusString(data.status || 200)
   const messageStr = data.message || ''
 
-  return `🦊 ${nowStr} ${levelStr} ${durationStr} ${methodStr} ${pathnameStr} ${statusStr} ${messageStr}`
-}
+  let logMessage = `🦊 ${nowStr} ${levelStr} ${durationStr} ${methodStr} ${pathnameStr} ${statusStr} ${messageStr}`
 
-/**
- * Writes a log message to the console asynchronously.
- *
- * @async
- * @param {string} message - The message to log.
- *
- * @returns {Promise<void>}
- * @throws {Error} - If the timeout is reached.
- */
-function writeToLogAsync(message: string): Promise<void> {
-  return new Promise((resolve, reject) => {
-    console.log(message)
-    resolve()
+  if (options?.ip) {
+    const forwardedFor = request.headers.get('x-forwarded-for')
+    if (forwardedFor) {
+      logMessage += ` IP: ${forwardedFor}`
+    }
+  }
 
-    setTimeout(() => {
-      reject(new Error('Timed out while writing to log.'))
-    })
-  })
+  return logMessage
 }
 
-/**
- * Creates a logger instance with an asynchronous log method.
- *
- * @returns {Logger} - The logger instance.
- */
-export const createLogger = (): Logger => ({
-  log: (level, request, data, store) => log(level, request, data, store)
+export const createLogger = (options?: Options): Logger => ({
+  log: (level, request, data, store) =>
+    log(level, request, data, store, options)
 })
 
-/**
- * Handle HTTP errors and log them with the appropriate status code.
- *
- * @param {RequestInfo} request - The request information.
- * @param {Error} error - The error object.
- * @param {StoreData} store - The store data.
- */
 export const handleHttpError = (
   request: RequestInfo,
   error: Error,
-  store: StoreData
+  store: StoreData,
+  options?: Options
 ): void => {
   const statusCode = error instanceof HttpError ? error.status : 500
   const logMessage = buildLogMessage(
     'ERROR',
     request,
     { status: statusCode },
-    store
+    store,
+    options
   )
   console.error(logMessage)
 }

src/types.ts

@@ -0,0 +1,60 @@
+interface RequestInfo {
+  headers: { get: (key: string) => any }
+  method: string
+  url: string
+}
+
+interface Server {
+  hostname?: string
+  port?: number
+  protocol?: string
+}
+
+interface ColorMap {
+  [key: string]: (str: string) => string
+}
+
+type LogLevel = 'INFO' | 'WARNING' | 'ERROR' | string
+
+interface LogData {
+  status?: number
+  message?: string
+}
+
+interface Logger {
+  log(
+    level: LogLevel,
+    request: RequestInfo,
+    data: LogData,
+    store: StoreData
+  ): void
+}
+
+interface StoreData {
+  beforeTime: bigint
+}
+
+class HttpError extends Error {
+  status: number
+
+  constructor(status: number, message: string) {
+    super(message)
+    this.status = status
+  }
+}
+
+interface Options {
+  ip?: boolean
+}
+
+export {
+  RequestInfo,
+  Server,
+  ColorMap,
+  LogLevel,
+  LogData,
+  Logger,
+  StoreData,
+  HttpError,
+  Options
+}

src/utils/colorMapping.ts

@@ -1,5 +1,5 @@
 import chalk from 'chalk'
-import { ColorMap } from '~/types/ColorMap'
+import { ColorMap } from '~/types'
 
 /**
  * The color map for the log levels.

src/utils/path.ts

@@ -1,4 +1,4 @@
-import { RequestInfo } from '~/types/RequestInfo'
+import { RequestInfo } from '~/types'
 
 /**
  * Returns the path string.

src/utils/start.ts

@@ -1,4 +1,4 @@
-import { Server } from '~/types/Server'
+import { Server } from '~/types'
 
 /**
  * Creates a box text.

test/types/ColorMap.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test'
-import { ColorMap } from '~/types/ColorMap'
+import { ColorMap } from '~/types'
 
 describe('Color Mapping Interface', () => {
   it('Defines an object with string keys mapping to functions', () => {

test/types/HttpError.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test'
-import { HttpError } from '~/types/HttpError'
+import { HttpError } from '~/types'
 
 describe('HttpError', () => {
   it('Should create an instance with correct status and message', () => {

test/types/Logger.test.ts

@@ -1,7 +1,5 @@
 import { beforeEach, describe, expect, it, jest } from 'bun:test'
-import { LogData } from '~/types/Logger'
-import { RequestInfo } from '~/types/RequestInfo'
-import { StoreData } from '~/types/StoreData'
+import { RequestInfo, LogData, StoreData } from '~/types'
 
 interface Logger {
   info(request: RequestInfo, data: LogData, store: StoreData): void

test/types/RequestInfo.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test'
-import { RequestInfo } from '~/types/RequestInfo'
+import { RequestInfo } from '~/types'
 
 describe('Request Infomation interface', () => {
   it('Defines the RequestInfo interface correctly', () => {

test/types/Server.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test'
-import { Server } from '~/types/Server'
+import { Server } from '~/types'
 
 describe('Server interface', () => {
   it('Defines the Server interface correctly', () => {

test/types/StoreData.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test'
-import { StoreData } from '~/types/StoreData'
+import { StoreData } from '~/types'
 
 describe('Store Data interface', () => {
   it('Defines the StoreData interface correctly', () => {