logixlysia 2.2.2 → 2.3.0

package/.gitguardian.yml

@@ -0,0 +1,16 @@
+# Required, otherwise ggshield considers the file to use the deprecated v1 format
+version: 2
+
+# Set to true if the desired exit code for the CLI is always 0, otherwise the
+# exit code will be 1 if incidents are found.
+exit-zero: false
+
+verbose: false
+
+instance: https://dashboard.gitguardian.com
+
+# Maximum commits to scan in a hook.
+max-commits-for-hook: 50
+
+# Accept self-signed certificates for the API.
+allow-self-signed: false

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.3.0](https://github.com/PunGrumpy/logixlysia/compare/v2.2.3...v2.3.0) (2024-04-06)
+
+
+### Features
+
+* **logger:** handle HTTP errors and log with appropriate status code ([276b3c4](https://github.com/PunGrumpy/logixlysia/commit/276b3c41334bcf1cefd032ae11f71fb8cda2bc9a)), closes [#24](https://github.com/PunGrumpy/logixlysia/issues/24)
+
+## [2.2.3](https://github.com/PunGrumpy/logixlysia/compare/v2.2.2...v2.2.3) (2024-04-06)
+
+
+### Bug Fixes
+
+* **error-log:** add global to `onError` ([e217baa](https://github.com/PunGrumpy/logixlysia/commit/e217baad9f72fa3e866f959f371768ed2ed22e33))
+* **ts2488:** that method return an iterator ([35da93f](https://github.com/PunGrumpy/logixlysia/commit/35da93f75e34ff212ddd31ff951425551f31c764))
+
 ## [2.2.2](https://github.com/PunGrumpy/logixlysia/compare/v2.2.1...v2.2.2) (2024-04-06)
 
 

package/package.json

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

package/src/index.ts

@@ -1,5 +1,5 @@
 import Elysia from 'elysia'
-import { createLogger } from './logger'
+import { createLogger, handleHttpError } from './logger'
 import startString from './utils/start'
 import { Server } from 'bun'
 import { Options } from './options'
@@ -50,8 +50,9 @@ export const logger = (options?: Options): Elysia => {
         store as { beforeTime: bigint }
       )
     })
-    .onError(({ request, error, store }) => {
-      log.log('ERROR', request, error, store as { beforeTime: bigint })
+    .onError({ as: 'global' }, ({ request, error, store }) => {
+      // log.log('ERROR', request, error, store as { beforeTime: bigint })
+      handleHttpError(request, error, store as { beforeTime: bigint })
     })
 
   return elysia

package/src/logger.ts

@@ -7,6 +7,7 @@ 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'
 
 /**
  * Asynchronously logs a message constructed from various log components.
@@ -88,3 +89,25 @@ function writeToLogAsync(message: string): Promise<void> {
 export const createLogger = (): Logger => ({
   log: (level, request, data, store) => log(level, request, data, store)
 })
+
+/**
+ * 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
+): void => {
+  const statusCode = error instanceof HttpError ? error.status : 500
+  const logMessage = buildLogMessage(
+    'ERROR',
+    request,
+    { status: statusCode },
+    store
+  )
+  console.error(logMessage)
+}

package/src/types/HttpError.ts

@@ -0,0 +1,11 @@
+/**
+ * Custom Error class for HTTP errors.
+ */
+export class HttpError extends Error {
+  status: number
+
+  constructor(status: number, message: string) {
+    super(message)
+    this.status = status
+  }
+}

package/test/utils/start.test.ts

@@ -28,7 +28,9 @@ describe('Start String', () => {
     const expectedMessage = `🦊 Elysia is running at http://localhost:3000`
 
     // Extract the arguments passed to console.log during the function call
-    const [[logMessage]] = mockConsoleLog.mock.calls
+    const logMessage = mockConsoleLog.mock.calls
+      .map((args: any[]) => args.join(' '))
+      .join(' ')
 
     expect(logMessage).toMatch(expectedMessage)
   })