Merge pull request #1634 from glebbash/fix/colon-escape

fix(): unescape colons in paths

e2e/api-spec.json

@@ -67,6 +67,50 @@
         }
       }
     },
+    "/api/v1/express:colon:another/{prop}": {
+      "get": {
+        "operationId": "AppController_withColonExpress",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/api/v2/express:colon:another/{prop}": {
+      "get": {
+        "operationId": "AppController_withColonExpress",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/api/v1/fastify:{colon}:{another}/{prop}": {
+      "get": {
+        "operationId": "AppController_withColonFastify",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        }
+      }
+    },
+    "/api/v2/fastify:{colon}:{another}/{prop}": {
+      "get": {
+        "operationId": "AppController_withColonFastify",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": ""
+          }
+        }
+      }
+    },
     "/api/cats": {
       "post": {
         "operationId": "CatsController_create",

e2e/fastify.e2e-spec.ts

@@ -52,6 +52,11 @@ describe('Fastify Swagger', () => {
     }
   });
 
+  it('should fix colons in url', async () => {
+    const document = SwaggerModule.createDocument(app, builder.build());
+    expect(document.paths['/fastify:colon:another/{prop}']).toBeDefined();
+  });
+
   it('should pass uiConfig options to fastify-swagger', async () => {
     const document1 = SwaggerModule.createDocument(app, builder.build());
     const uiConfig = {

e2e/src/app.controller.ts

@@ -13,4 +13,14 @@ export class AppController {
   withAliases(): string {
     return 'Hello world!';
   }
+
+  @Get('express[:]colon[:]another/:prop')
+  withColonExpress(): string {
+    return 'Hello world!';
+  }
+
+  @Get('fastify::colon::another/:prop')
+  withColonFastify(): string {
+    return 'Hello world!';
+  }
 }

e2e/validate-schema.e2e-spec.ts

@@ -71,6 +71,11 @@ describe('Validate OpenAPI schema', () => {
     }
   });
 
+  it('should fix colons in url', async () => {
+    const document = SwaggerModule.createDocument(app, options);
+    expect(document.paths['/api/v1/express:colon:another/{prop}']).toBeDefined();
+  });
+
   it('should merge custom components passed via config', async () => {
     const components = {
       schemas: {

lib/interfaces/module-route.interface.ts

@@ -0,0 +1,4 @@
+import { OpenAPIObject } from '.';
+
+export type ModuleRoute = Omit<OpenAPIObject, 'openapi' | 'info'> &
+  Record<'root', any>;

lib/swagger-scanner.ts

@@ -5,6 +5,7 @@ import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
 import { InstanceToken, Module } from '@nestjs/core/injector/module';
 import { flatten, isEmpty } from 'lodash';
 import { OpenAPIObject, SwaggerDocumentOptions } from './interfaces';
+import { ModuleRoute } from './interfaces/module-route.interface';
 import {
   ReferenceObject,
   SchemaObject
@@ -18,7 +19,7 @@ import { getGlobalPrefix } from './utils/get-global-prefix';
 import { stripLastSlash } from './utils/strip-last-slash.util';
 
 export class SwaggerScanner {
-  private readonly transfomer = new SwaggerTransformer();
+  private readonly transformer = new SwaggerTransformer();
   private readonly schemaObjectFactory = new SchemaObjectFactory(
     new ModelPropertiesAccessor(),
     new SwaggerTypesMapper()
@@ -50,7 +51,7 @@ export class SwaggerScanner {
 
     const denormalizedPaths = modules.map(
       ({ routes, metatype, relatedModules }) => {
-        let result = [];
+        let result: ModuleRoute[] = [];
 
         if (deepScanRoutes) {
           // only load submodules routes if asked
@@ -76,7 +77,7 @@ export class SwaggerScanner {
             });
         }
         const modulePath = this.getModulePathMetadata(container, metatype);
-        return result.concat(
+        result = result.concat(
           this.scanModuleRoutes(
             routes,
             modulePath,
@@ -85,14 +86,15 @@ export class SwaggerScanner {
             operationIdFactory
           )
         );
+        return this.transformer.unescapeColonsInPath(app, result);
       }
     );
 
     const schemas = this.explorer.getSchemas();
     this.addExtraModels(schemas, extraModels);
 
     return {
-      ...this.transfomer.normalizePaths(flatten(denormalizedPaths)),
+      ...this.transformer.normalizePaths(flatten(denormalizedPaths)),
       components: {
         schemas: schemas as Record<string, SchemaObject | ReferenceObject>
       }
@@ -105,7 +107,7 @@ export class SwaggerScanner {
     globalPrefix: string | undefined,
     applicationConfig: ApplicationConfig,
     operationIdFactory?: (controllerKey: string, methodKey: string) => string
-  ): Array<Omit<OpenAPIObject, 'openapi' | 'info'> & Record<'root', any>> {
+  ): ModuleRoute[] {
     const denormalizedArray = [...routes.values()].map((ctrl) =>
       this.explorer.exploreController(
         ctrl,

lib/swagger-transformer.ts

@@ -1,5 +1,7 @@
+import { INestApplication } from '@nestjs/common';
 import { filter, groupBy, keyBy, mapValues, omit } from 'lodash';
 import { OpenAPIObject } from './interfaces';
+import { ModuleRoute } from './interfaces/module-route.interface';
 
 export class SwaggerTransformer {
   public normalizePaths(
@@ -26,4 +28,23 @@ export class SwaggerTransformer {
       paths
     };
   }
+
+  public unescapeColonsInPath(
+    app: INestApplication,
+    moduleRoutes: ModuleRoute[]
+  ): ModuleRoute[] {
+    const httpAdapter = app.getHttpAdapter();
+    const usingFastify = httpAdapter && httpAdapter.getType() === 'fastify';
+    const unescapeColon = usingFastify
+      ? (path: string) => path.replace(/:\{([^}]+)\}/g, ':$1')
+      : (path: string) => path.replace(/\[:\]/g, ':');
+
+    return moduleRoutes.map((moduleRoute) => ({
+      ...moduleRoute,
+      root: {
+        ...moduleRoute.root,
+        path: unescapeColon(moduleRoute.root.path)
+      }
+    }));
+  }
 }