fix: koa router trailer slash (#1114)

Aareksio · web-flow · commit ac7416c229c2 · 2023-04-19T19:14:59.000+02:00
diff --git a/src/driver/koa/KoaDriver.ts b/src/driver/koa/KoaDriver.ts
@@ -129,7 +129,13 @@ export class KoaDriver extends BaseDriver {
     const afterMiddlewares = this.prepareMiddlewares(uses.filter(use => use.afterAction));
 
     // prepare route and route handler function
-    const route = ActionMetadata.appendBaseRoute(this.routePrefix, actionMetadata.fullRoute);
+    let route = ActionMetadata.appendBaseRoute(this.routePrefix, actionMetadata.fullRoute);
+
+    // @koa/router is strict about trailing slashes, allow accessing routes without them
+    if (typeof route === 'string' && route.length > 1 && route.endsWith('/')) {
+      route = route.substring(0, route.length - 1);
+    }
+
     const routeHandler = (context: any, next: () => Promise<any>) => {
       const options: Action = { request: context.request, response: context.response, context, next };
       return executeCallback(options);
diff --git a/test/functional/koa-trailing-slash.spec.ts b/test/functional/koa-trailing-slash.spec.ts
@@ -0,0 +1,47 @@
+import { Server as HttpServer } from 'http';
+import HttpStatusCodes from 'http-status-codes';
+import { Controller } from '../../src/decorator/Controller';
+import { Get } from '../../src/decorator/Get';
+import { createKoaServer, getMetadataArgsStorage } from '../../src/index';
+import { axios } from '../utilities/axios';
+import DoneCallback = jest.DoneCallback;
+
+describe(``, () => {
+  let koaServer: HttpServer;
+
+  describe('koa trailing slashes', () => {
+    beforeEach((done: DoneCallback) => {
+      getMetadataArgsStorage().reset();
+
+      @Controller('/posts')
+      class PostController {
+        @Get('/')
+        getAll(): string {
+          return '<html><body>All posts</body></html>';
+        }
+      }
+
+      koaServer = createKoaServer().listen(3001, done);
+    });
+
+    afterEach((done: DoneCallback) => {
+      koaServer.close(done);
+    });
+
+    it('get should respond to request without a traling slash', async () => {
+      expect.assertions(3);
+      const response = await axios.get('/posts');
+      expect(response.status).toEqual(HttpStatusCodes.OK);
+      expect(response.headers['content-type']).toEqual('text/html; charset=utf-8');
+      expect(response.data).toEqual('<html><body>All posts</body></html>');
+    });
+
+    it('get should respond to request with a traling slash', async () => {
+      expect.assertions(3);
+      const response = await axios.get('/posts/');
+      expect(response.status).toEqual(HttpStatusCodes.OK);
+      expect(response.headers['content-type']).toEqual('text/html; charset=utf-8');
+      expect(response.data).toEqual('<html><body>All posts</body></html>');
+    });
+  });
+});
