feat(test): 添加Koa框架支持并更新相关测试

Author: yourtion

package.json

@@ -52,11 +52,15 @@
     "@types/express": "^4.17.21",
     "@types/jest": "^27.5.2",
     "@types/koa": "^2.15.0",
+    "@types/koa-bodyparser": "^4.3.12",
+    "@types/koa-router": "^7.4.8",
     "@types/supertest": "^2.0.16",
     "coveralls": "^3.1.1",
     "express": "^4.18.2",
     "jest": "^27.5.1",
     "koa": "^3.0.0",
+    "koa-bodyparser": "^4.4.1",
+    "koa-router": "^13.0.1",
     "prettier": "^2.8.8",
     "supertest": "^6.3.4",
     "ts-jest": "^27.1.5",

src/lib/index.ts

@@ -493,32 +493,6 @@ export default class ERest<T = DEFAULT_HANDLER> {
       );
     }
   }
-
-  public bindRouterToKoa(router: any, checker: (erest: ERest<T>, schema: API<T>) => T) {
-    if (this.forceGroup) {
-      throw this.error.internalError("使用了 forceGroup，请使用 bindKoaRouterToApp");
-    }
-    for (const [key, schema] of this.apiInfo.$apis.entries()) {
-      debug("bind router to koa: %s", key);
-      schema.init(this as unknown as ERest<T>);
-
-      const handlers = [
-        ...(this.apiInfo.beforeHooks as any), // Spread Set into array
-        ...(schema.options.beforeHooks as any), // Spread Set into array
-        checker(this as unknown as ERest<T>, schema as API<T>),
-        ...(schema.options.middlewares as any), // Spread Set into array
-        schema.options.handler,
-      ].filter(h => typeof h === 'function'); // Ensure only functions are passed
-
-      const routeMethod = schema.options.method.toLowerCase();
-      if (typeof router[routeMethod] === 'function') {
-        router[routeMethod](schema.options.path, ...handlers);
-      } else {
-        console.error(`ERest: Invalid method ${routeMethod} for Koa router.`);
-      }
-    }
-  }
-
   public bindKoaRouterToApp(app: any, KoaRouter: any, checker: (erest: ERest<T>, schema: API<T>) => T) {
     if (!this.forceGroup) {
       throw this.error.internalError("没有开启 forceGroup，请使用 bindRouterToKoa");

src/test/test-group.ts

@@ -1,5 +1,8 @@
 import express from "express";
-import { Application, Router, Context } from "@leizm/web";
+import { Application, Router, Context as LeiContext } from "@leizm/web";
+import Koa ,{Context as KoaContext} from 'koa';
+import KoaRouter from 'koa-router'; // or import Router from 'koa-router';
+// import bodyParser from 'koa-bodyparser'; // Add this
 
 import { hook } from "./helper";
 import lib from "./lib";
@@ -8,10 +11,14 @@ function reqFn(req: express.Request, res: express.Response) {
   res.json("Hello, API Framework Index");
 }
 
-function reqFnLeiWeb(ctx: Context) {
+function reqFnLeiWeb(ctx: LeiContext) {
   ctx.response.json("Hello, API Framework Index");
 }
 
+function reqFnKoa(ctx: KoaContext) {
+  ctx.response.body = "Hello, API Framework Index";
+}
+
 const globalBefore = hook("globalBefore");
 const globalAfter = hook("globalAfter");
 const beforHook = hook("beforHook");
@@ -127,6 +134,22 @@ describe("Group - 使用@leizm/web框架", () => {
   });
 });
 
+describe("Group - 使用koa框架", () => {
+  const apiService = lib({ forceGroup: true, info: { basePath: "" } });
+  const api = apiService.group("Index");
+  const app = new Koa();
+  api.get("/").title("Get").register(reqFnKoa);
+  apiService.bindKoaRouterToApp(app, KoaRouter, apiService.checkerKoa);
+
+  test("Get请求成功", async () => {
+    apiService.initTest(app.callback());
+
+    const { text: ret } = await apiService.test.get("/index/").raw();
+    expect(ret).toBe("Hello, API Framework Index");
+  });
+});
+
+
 describe("Group - 高级分组配置", () => {
   const apiService = lib({
     forceGroup: true,

src/test/test-koa.ts

@@ -2,11 +2,11 @@ import Koa from 'koa';
 import KoaRouter from 'koa-router'; // or import Router from 'koa-router';
 import request from 'supertest';
 import bodyParser from 'koa-bodyparser'; // Add this
-import ERest, { KoaHandler, API } from '../lib'; // Adjust path as needed
+import ERest from '../lib'; // Adjust path as needed
 
 // Helper to set up ERest instance for forceGroup: false
 const setupERestNoGroup = () => {
-  return new ERest<KoaHandler>({
+  return new ERest({
     info: { title: 'Koa Test No Group' },
     // Ensure default error handlers are set up if your tests rely on specific status codes for errors
     missingParameterError: (msg: string) => ({ status: 400, message: `Missing Parameter: ${msg}` } as any), // Example
@@ -16,7 +16,7 @@ const setupERestNoGroup = () => {
 
 // Helper to set up ERest instance for forceGroup: true
 const setupERestWithGroup = () => {
-  return new ERest<KoaHandler>({
+  return new ERest({
     info: { title: 'Koa Test With Group' },
     forceGroup: true,
     groups: {
@@ -35,22 +35,22 @@ describe('ERest Koa Integration', () => {
     app.use(bodyParser()); // Use bodyParser for all non-group tests
     const erest = setupERestNoGroup();
     const router = new KoaRouter();
-
+    const api = erest.group("Index");;
     // Test 1.1
-    erest.api.get('/test-koa').register(async (ctx: Koa.Context) => { ctx.body = { success: true, data: 'koa works' }; });
+    api.get('/test-koa').register(async (ctx: Koa.Context) => { ctx.body = { success: true, data: 'koa works' }; });
 
     // Test 1.2
-    erest.api.get('/query-test')
+    api.get('/query-test')
       .query({ name: { type: 'string', required: true }})
       .register(async (ctx: Koa.Context) => { ctx.body = { name: (ctx.request as any).$params.query.name }; });
 
     // Test 1.3
-    erest.api.post('/body-test')
+    api.post('/body-test')
       .body({ id: { type: 'int', required: true }})
       .register(async (ctx: Koa.Context) => { ctx.body = { id: (ctx.request as any).$params.body.id }; });
 
     // After all API definitions for this block
-    erest.bindRouterToKoa(router, (e,s) => erest.checkerKoa(e,s as API<KoaHandler>));
+    erest.bindRouterToKoa(router, (e,s) => erest.checkerKoa(e,s));
     app.use(router.routes()).use(router.allowedMethods());
 
     // Now run the actual test executions that were commented out above
@@ -79,7 +79,7 @@ describe('ERest Koa Integration', () => {
     erestGroup.group('user').get('/info').register(async (ctx: Koa.Context) => { ctx.body = { group: 'user info' }; });
 
     // After all API definitions for this block
-    erestGroup.bindKoaRouterToApp(appGroup, KoaRouter, (e,s) => erestGroup.checkerKoa(e,s as API<KoaHandler>));
+    erestGroup.bindKoaRouterToApp(appGroup, KoaRouter, (e,s) => erestGroup.checkerKoa(e,s));
 
     // Now run the actual test executions
     it('should handle basic GET request in a group with explicit prefix (execution)', async () => {