feat(http): Allow registering global middleware (#71)

* chore: add global code owner for repository

* chore(app): extract `createRouter()` method

* feat(app): add support for global middleware registration

* test(app): use type assertion

* chore(test): fix broken test

* chore: bump version to 2.2.0

Author: imdhemy

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Global code owners
+* @imdhemy

package.json

@@ -2,7 +2,7 @@
   "name": "@koala-ts/framework",
   "main": "dist/index.js",
   "type": "module",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "A NodeJS framework for lazy developers",
   "keywords": [
     "koala",

src/Application/ApplicationFactory.test.ts

@@ -1,7 +1,7 @@
 import Koa from 'koa';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
 import { create } from '@/Application/ApplicationFactory';
-import { koalaDefaultConfig } from '@/Config';
+import { KoalaConfig, koalaDefaultConfig } from '@/Config';
 import type { HttpScope, NextMiddleware, UploadedFile } from '@/Http';
 import { Route } from '@/Routing';
 import { createTestAgent, TestAgent } from '@/Testing';
@@ -136,3 +136,18 @@ describe('Application', () => {
     expect(response.text).toBe('avatar.png');
   });
 });
+
+describe('Global Middleware', () => {
+  test('it should register configured global middleware', async () => {
+    const middlewareFn = vi.fn();
+    const config = {
+      controllers: [],
+      globalMiddleware: [middlewareFn],
+    };
+    const testAgent = createTestAgent(config as KoalaConfig);
+
+    await testAgent.get('/');
+
+    expect(middlewareFn).toHaveBeenCalled();
+  });
+});

src/Application/ApplicationFactory.ts

@@ -4,13 +4,21 @@ import { koaBody } from 'koa-body';
 import { type Application } from './types';
 import { extendResponse } from '@/Application/Response';
 import { type KoalaConfig } from '@/Config';
-import { type HttpScope } from '@/Http';
+import { type HttpMiddleware, type HttpScope } from '@/Http';
 import { getRoutes } from '@/Routing';
 
-export function create(_: KoalaConfig): Application {
+export function create(config: KoalaConfig): Application {
   const app = new Koa() as Application;
   app.scope = app.context;
 
+  app.use(extendResponse);
+  if (undefined !== config.globalMiddleware) registerGlobalMiddleware(app, config.globalMiddleware);
+  app.use(createRouter().routes());
+
+  return app;
+}
+
+function createRouter(): Router {
   const router = new Router();
 
   for (const route of getRoutes()) {
@@ -22,8 +30,11 @@ export function create(_: KoalaConfig): Application {
     }
   }
 
-  app.use(extendResponse);
-  app.use(router.routes());
+  return router;
+}
 
-  return app;
+function registerGlobalMiddleware(app: Application, middleware: HttpMiddleware[]): void {
+  for (const mw of middleware) {
+    app.use(mw);
+  }
 }

src/Config/types.ts

@@ -1,5 +1,8 @@
+import { type HttpMiddleware } from '@/Http';
+
 export type Controller = new(...args: unknown[]) => unknown;
 
 export interface KoalaConfig {
   controllers: Controller[];
+  globalMiddleware?: HttpMiddleware[];
 }