refactor: remove legacy error handling code and implement new structured error handling

- Deleted old error handler implementations from Express and H3 drivers.
- Introduced a new error handling module in the common package to standardize error responses.
- Updated Express and H3 drivers to use the new error handling logic.
- Added logging for unhandled errors and structured error payloads.
- Updated tests to cover new error handling behavior and ensure compatibility.

Author: 3m1n3nc3

create-arkstack/cleaner.ts

@@ -5,7 +5,6 @@ import { join } from 'node:path'
 
 const filesToPatch = [
     'src/core/app.ts',
-    'src/core/utils/request-handlers.ts',
 ]
 
 for (const file of filesToPatch) {

create-arkstack/src/actions.ts

@@ -241,7 +241,6 @@ export default class {
       'src/core/app.ts',
       'src/core/router.ts',
       'src/core/bootstrap.ts',
-      'src/core/utils/request-handlers.ts',
     ]
 
     for (const file of filesToPatch) {

create-arkstack/tests/lean-profile.test.ts

@@ -20,7 +20,7 @@ describe('makeLeanProfile', () => {
 
         await mkdir(join(location, 'src/app/http/controllers'), { recursive: true })
         await mkdir(join(location, 'src/app/http/resources'), { recursive: true })
-        await mkdir(join(location, 'src/core/utils'), { recursive: true })
+        await mkdir(join(location, 'src/core'), { recursive: true })
         await mkdir(join(location, 'src/routes'), { recursive: true })
         await mkdir(join(location, 'prisma/migrations'), { recursive: true })
 
@@ -46,29 +46,6 @@ describe('makeLeanProfile', () => {
             ].join('\n'),
         )
 
-        await writeFile(
-            join(location, 'src/core/utils/request-handlers.ts'),
-            [
-                'import { ModelNotFoundException } from \'arkormx\'',
-                '',
-                'export const ErrorHandler = (cause: unknown) => {',
-                '  const error: Record<string, any> = {}',
-                '',
-                '  if (cause instanceof ModelNotFoundException) {',
-                '    error.code = 404',
-                '    error.message = `${cause.getModelName()} not found!`',
-                '  }',
-                '',
-                '  if (!(err instanceof ValidationException) &&\n    !(err instanceof ModelNotFoundException)) {',
-                '    error.stack = (cause as Error).stack',
-                '  }',
-                '',
-                '  return error',
-                '}',
-                '',
-            ].join('\n'),
-        )
-
         await writeFile(
             join(location, 'src/core/router.ts'),
             [
@@ -144,10 +121,6 @@ describe('makeLeanProfile', () => {
         const appContent = await readFile(join(location, 'src/core/app.ts'), 'utf-8')
         expect(appContent).not.toContain('import { ModelNotFoundException } from \'arkormx\'')
 
-        const handlersContent = await readFile(join(location, 'src/core/utils/request-handlers.ts'), 'utf-8')
-        expect(handlersContent).not.toContain('ModelNotFoundException')
-        expect(handlersContent).not.toContain('not found!')
-
         const routerContent = await readFile(join(location, 'src/core/router.ts'), 'utf-8')
         expect(routerContent).not.toContain('await ClearRouter.group(\'/api\'')
     })

express/src/core/app.ts

@@ -1,7 +1,6 @@
 import { bindGracefulShutdown } from '@arkstack/common'
 import { Router } from 'src/core/router'
 import path from 'path'
-import ErrorHandler from './utils/request-handlers'
 import { ExpressDriver } from '@arkstack/driver-express'
 import { ArkstackKitDriver, ArkstackRouterAwareCore, ArkstackRouterContract, ArkstackRouteListOptions } from '@arkstack/contract'
 import { type Express, type Handler } from 'express'
@@ -23,7 +22,6 @@ export default class Application implements ArkstackRouterAwareCore<Express, unk
       bindRouter: async (runtime) => {
         runtime.use(await Router.bind())
       },
-      errorHandler: ErrorHandler,
     })
 
     this.app = app ?? this.driver.createApp()

express/src/core/utils/request-handlers.ts

@@ -4,7 +4,6 @@ import { ArkstackKitDriver, ArkstackRouterAwareCore, ArkstackRouterContract, Ark
 import { H3Driver, type H3Middleware } from '@arkstack/driver-h3'
 import { H3 } from 'h3'
 import { Router } from 'src/core/router'
-import ErrorHandler from './utils/request-handlers'
 
 export default class Application implements ArkstackRouterAwareCore<H3, unknown> {
   private app: H3
@@ -19,10 +18,6 @@ export default class Application implements ArkstackRouterAwareCore<H3, unknown>
    */
   constructor(app?: H3) {
     this.driver = new H3Driver({
-      createApp: () =>
-        new H3({
-          onError: ErrorHandler,
-        }),
       bindRouter: async (runtime) => {
         await Router.bind(runtime)
       },

express/tests/app.test.ts

@@ -1,6 +1,4 @@
 import Application from 'src/core/app'
-import ErrorHandler from './utils/request-handlers'
-import { H3 } from 'h3'
 import { Validator } from 'kanun'
 import { ValidatorDBDriver } from './utils/drivers/ValidatorDBDriver'
 import { fileValidatorPlugin } from '@kanun-hq/plugin-file'
@@ -10,8 +8,5 @@ globalThis.str = str
 Validator.useDatabase(new ValidatorDBDriver())
 Validator.use(fileValidatorPlugin)
 
-export const h3App = new H3({
-  onError: ErrorHandler,
-})
-
-export const app = new Application(h3App) 
+export const app = new Application()
+export const h3App = app.getAppInstance()

h3/src/core/app.ts

@@ -1,4 +1,3 @@
-import ErrorHandler from './request-handlers'
 import { HTTPError } from 'h3'
 import { HttpContext } from 'clear-router/types/h3'
 
@@ -19,13 +18,9 @@ export class RequestError extends HTTPError {
     value: T | null | undefined,
     message: string,
     code: number = 404,
-    ctx?: HttpContext,
+    _ctx?: HttpContext,
   ): asserts value is T {
     if (!value) {
-      if (ctx) {
-        return ErrorHandler(new RequestError(message, code), ctx) as never
-      }
-
       throw new RequestError(message, code)
     }
   }
@@ -42,13 +37,9 @@ export class RequestError extends HTTPError {
     boolean: T,
     message: string,
     code?: number,
-    ctx?: HttpContext,
+    _ctx?: HttpContext,
   ): asserts boolean is T {
     if (boolean) {
-      if (ctx) {
-        return ErrorHandler(new RequestError(message, code), ctx) as never
-      }
-
       throw new RequestError(message, code)
     }
   }