fix(plugin): revamp types resolution, fix empty summary in ctrl bug

kamilmysliwiec · kamilmysliwiec · commit c1295b692d2d · 2023-06-26T10:40:51.000+02:00
diff --git a/lib/plugin/utils/plugin-utils.ts b/lib/plugin/utils/plugin-utils.ts
@@ -161,7 +161,7 @@ export function replaceImportPath(
   } catch (_error) {
     const from = options?.readonly
       ? options.pathToSource
-      : posix.dirname(fileName);
+      : posix.dirname(convertPath(fileName));
 
     let relativePath = posix.relative(from, importPath);
     relativePath = relativePath[0] !== '.' ? './' + relativePath : relativePath;
@@ -190,10 +190,17 @@ export function replaceImportPath(
 
     typeReference = typeReference.replace(importPath, relativePath);
 
+    if (options.readonly) {
+      const { typeName, typeImportStatement } =
+        convertToAsyncImport(typeReference);
+      return {
+        typeReference: typeImportStatement,
+        typeName,
+        importPath: relativePath
+      };
+    }
     return {
-      typeReference: options.readonly
-        ? convertToAsyncImport(typeReference)
-        : typeReference.replace('import', 'require'),
+      typeReference: typeReference.replace('import', 'require'),
       importPath: relativePath
     };
   }
@@ -205,14 +212,15 @@ function convertToAsyncImport(typeReference: string) {
 
   if (match?.length >= 2) {
     const importPos = typeReference.indexOf(match[0]);
-    typeReference = typeReference.replace(
-      match[1],
-      `then((f) => f.${match[1]})`
-    );
-    return insertAt(typeReference, importPos, 'await ');
+    typeReference = typeReference.replace(`.${match[1]}`, '');
+
+    return {
+      typeImportStatement: insertAt(typeReference, importPos, 'await '),
+      typeName: match[1]
+    };
   }
 
-  return typeReference;
+  return { typeImportStatement: typeReference };
 }
 
 export function insertAt(string: string, index: number, substring: string) {
@@ -326,7 +334,7 @@ function isOptionalBoolean(text: string) {
  * Converts Windows specific file paths to posix
  * @param windowsPath
  */
-function convertPath(windowsPath: string) {
+export function convertPath(windowsPath: string) {
   return windowsPath
     .replace(/^\\\\\?\\/, '')
     .replace(/\\/g, '/')
diff --git a/lib/plugin/visitors/controller-class.visitor.ts b/lib/plugin/visitors/controller-class.visitor.ts
@@ -12,6 +12,7 @@ import {
   getTsDocTagsOfNode
 } from '../utils/ast-utils';
 import {
+  convertPath,
   getDecoratorOrUndefinedByNames,
   getTypeReferenceAsString,
   hasPropertyKey,
@@ -204,12 +205,19 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
       decorators,
       factory
     );
-    const apiOperationExpr: ts.ObjectLiteralExpression | undefined =
-      apiOperationDecorator &&
-      head(getDecoratorArguments(apiOperationDecorator));
-    const apiOperationExprProperties =
-      apiOperationExpr &&
-      (apiOperationExpr.properties as ts.NodeArray<ts.PropertyAssignment>);
+    let apiOperationExistingProps:
+      | ts.NodeArray<ts.PropertyAssignment>
+      | undefined = undefined;
+
+    if (apiOperationDecorator && !options.readonly) {
+      const apiOperationExpr = head(
+        getDecoratorArguments(apiOperationDecorator)
+      );
+      if (apiOperationExpr) {
+        apiOperationExistingProps =
+          apiOperationExpr.properties as ts.NodeArray<ts.PropertyAssignment>;
+      }
+    }
 
     const extractedComments = getMainCommentOfNode(node, sourceFile);
     if (!extractedComments) {
@@ -222,12 +230,12 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
         keyToGenerate,
         factory.createStringLiteral(extractedComments)
       ),
-      ...(apiOperationExprProperties ?? factory.createNodeArray())
+      ...(apiOperationExistingProps ?? factory.createNodeArray())
     ];
 
     const hasDeprecatedKey = hasPropertyKey(
       'deprecated',
-      factory.createNodeArray(apiOperationExprProperties)
+      factory.createNodeArray(apiOperationExistingProps)
     );
     if (!hasDeprecatedKey && tags.deprecated) {
       const deprecatedPropertyAssignment = factory.createPropertyAssignment(
@@ -345,16 +353,15 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
     if (!type) {
       return undefined;
     }
-    const { typeName, isArray } = getTypeReferenceAsString(type, typeChecker);
-    if (!typeName) {
+    const typeReferenceDescriptor = getTypeReferenceAsString(type, typeChecker);
+    if (!typeReferenceDescriptor.typeName) {
       return undefined;
     }
-    if (typeName.includes('node_modules')) {
+    if (typeReferenceDescriptor.typeName.includes('node_modules')) {
       return undefined;
     }
     const identifier = this.typeReferenceStringToIdentifier(
-      typeName,
-      isArray,
+      typeReferenceDescriptor,
       hostFilename,
       options,
       factory
@@ -399,20 +406,23 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
   }
 
   private normalizeImportPath(pathToSource: string, path: string) {
-    let relativePath = posix.relative(pathToSource, path);
+    let relativePath = posix.relative(pathToSource, convertPath(path));
     relativePath = relativePath[0] !== '.' ? './' + relativePath : relativePath;
     return relativePath;
   }
 
   private typeReferenceStringToIdentifier(
-    _typeReference: string,
-    isArray: boolean,
+    typeReferenceDescriptor: {
+      typeName: string;
+      isArray?: boolean;
+      arrayDepth?: number;
+    },
     hostFilename: string,
     options: PluginOptions,
     factory: ts.NodeFactory
   ) {
-    const { typeReference, importPath } = replaceImportPath(
-      _typeReference,
+    const { typeReference, importPath, typeName } = replaceImportPath(
+      typeReferenceDescriptor.typeName,
       hostFilename,
       options
     );
@@ -423,14 +433,25 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
         this._typeImports[importPath] = typeReference;
       }
 
-      identifier = factory.createIdentifier(
-        isArray ? `[t["${importPath}"]]` : `t["${importPath}"]`
-      );
+      let ref = `t["${importPath}"].${typeName}`;
+      if (typeReferenceDescriptor.isArray) {
+        ref = this.wrapTypeInArray(ref, typeReferenceDescriptor.arrayDepth);
+      }
+      identifier = factory.createIdentifier(ref);
     } else {
-      identifier = factory.createIdentifier(
-        isArray ? `[${typeReference}]` : typeReference
-      );
+      let ref = typeReference;
+      if (typeReferenceDescriptor.isArray) {
+        ref = this.wrapTypeInArray(ref, typeReferenceDescriptor.arrayDepth);
+      }
+      identifier = factory.createIdentifier(ref);
     }
     return identifier;
   }
+
+  private wrapTypeInArray(typeRef: string, arrayDepth: number) {
+    for (let i = 0; i < arrayDepth; i++) {
+      typeRef = `[${typeRef}]`;
+    }
+    return typeRef;
+  }
 }
diff --git a/lib/plugin/visitors/model-class.visitor.ts b/lib/plugin/visitors/model-class.visitor.ts
@@ -16,6 +16,7 @@ import {
   isEnum
 } from '../utils/ast-utils';
 import {
+  convertPath,
   extractTypeArgumentIfArray,
   getDecoratorOrUndefinedByNames,
   getTypeReferenceAsString,
@@ -725,7 +726,7 @@ export class ModelClassVisitor extends AbstractFileVisitor {
   }
 
   private normalizeImportPath(pathToSource: string, path: string) {
-    let relativePath = posix.relative(pathToSource, path);
+    let relativePath = posix.relative(pathToSource, convertPath(path));
     relativePath = relativePath[0] !== '.' ? './' + relativePath : relativePath;
     return relativePath;
   }
@@ -740,7 +741,7 @@ export class ModelClassVisitor extends AbstractFileVisitor {
     options: PluginOptions,
     factory: ts.NodeFactory
   ) {
-    const { typeReference, importPath } = replaceImportPath(
+    const { typeReference, importPath, typeName } = replaceImportPath(
       typeReferenceDescriptor.typeName,
       hostFilename,
       options
@@ -752,7 +753,7 @@ export class ModelClassVisitor extends AbstractFileVisitor {
         this._typeImports[importPath] = typeReference;
       }
 
-      let ref = `t["${importPath}"]`;
+      let ref = `t["${importPath}"].${typeName}`;
       if (typeReferenceDescriptor.isArray) {
         ref = this.wrapTypeInArray(ref, typeReferenceDescriptor.arrayDepth);
       }
diff --git a/test/plugin/fixtures/project/app.controller.ts b/test/plugin/fixtures/project/app.controller.ts
@@ -1,4 +1,5 @@
 import { Controller, Get } from '@nestjs/common';
+import { ApiOperation } from '../../../../lib/decorators';
 
 @Controller()
 export class AppController {
@@ -21,6 +22,10 @@ export class AppController {
     return 'Hello world!';
   }
 
+  /**
+   * Returns information about the application
+   */
+  @ApiOperation({ summary: 'Returns Hello World' })
   @Get('fastify::colon::another/:prop')
   withColonFastify(): string {
     return 'Hello world!';
diff --git a/test/plugin/fixtures/project/cats/dto/create-cat.dto.ts b/test/plugin/fixtures/project/cats/dto/create-cat.dto.ts
@@ -3,6 +3,11 @@ import { ExtraModel } from './extra-model.dto';
 import { LettersEnum } from './pagination-query.dto';
 import { TagDto } from './tag.dto';
 
+export enum CategoryState {
+  OK = 'OK',
+  DEPRECATED = 'DEPRECATED'
+}
+
 @ApiExtraModels(ExtraModel)
 export class CreateCatDto {
   @ApiProperty()
@@ -48,6 +53,12 @@ export class CreateCatDto {
   })
   readonly enum: LettersEnum;
 
+  /**
+   * Available language in the application
+   * @example FR
+   */
+  state?: CategoryState;
+
   @ApiProperty({
     enum: LettersEnum,
     enumName: 'LettersEnum',
diff --git a/test/plugin/fixtures/serialized-meta.fixture.ts b/test/plugin/fixtures/serialized-meta.fixture.ts
@@ -3,10 +3,9 @@ export default async () => {
   const t = {
     ['./cats/dto/pagination-query.dto']: await import(
       './cats/dto/pagination-query.dto'
-    ).then((f) => f.LettersEnum),
-    ['./cats/dto/tag.dto']: await import('./cats/dto/tag.dto').then(
-      (f) => f.TagDto
-    )
+    ),
+    ['./cats/dto/create-cat.dto']: await import('./cats/dto/create-cat.dto'),
+    ['./cats/dto/tag.dto']: await import('./cats/dto/tag.dto')
   };
   return {
     '@nestjs/swagger': {
@@ -20,16 +19,16 @@ export default async () => {
               limit: { required: true, type: () => Number },
               enum: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto']
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum
               },
               enumArr: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto'],
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum,
                 isArray: true
               },
               letters: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto'],
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum,
                 isArray: true
               },
               beforeDate: { required: true, type: () => Date },
@@ -59,11 +58,11 @@ export default async () => {
               options: { required: false, type: () => [Object] },
               enum: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto']
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum
               },
               enumArr: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto']
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum
               }
             }
           }
@@ -94,21 +93,30 @@ export default async () => {
               options: { required: false, type: () => [Object] },
               enum: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto']
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum
+              },
+              state: {
+                required: false,
+                description: 'Available language in the application',
+                example: 'FR',
+                enum: t['./cats/dto/create-cat.dto'].CategoryState
               },
               enumArr: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto']
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum
               },
               enumArr2: {
                 required: true,
-                enum: t['./cats/dto/pagination-query.dto'],
+                enum: t['./cats/dto/pagination-query.dto'].LettersEnum,
                 isArray: true
               },
-              tag: { required: true, type: () => t['./cats/dto/tag.dto'] },
+              tag: {
+                required: true,
+                type: () => t['./cats/dto/tag.dto'].TagDto
+              },
               multipleTags: {
                 required: true,
-                type: () => [t['./cats/dto/tag.dto']]
+                type: () => [t['./cats/dto/tag.dto'].TagDto]
               },
               nested: {
                 required: true,
@@ -133,19 +141,22 @@ export default async () => {
               },
               withAliases: { type: String },
               withColonExpress: { type: String },
-              withColonFastify: { type: String }
+              withColonFastify: {
+                description: 'Returns information about the application',
+                type: String
+              }
             }
           }
         ],
         [
           import('./cats/cats.controller'),
           {
             CatsController: {
-              create: { type: t['./cats/classes/cat.class'] },
-              findOne: { type: t['./cats/classes/cat.class'] },
+              create: { type: t['./cats/classes/cat.class'].Cat },
+              findOne: { type: t['./cats/classes/cat.class'].Cat },
               findAll: {},
-              createBulk: { type: t['./cats/classes/cat.class'] },
-              createAsFormData: { type: t['./cats/classes/cat.class'] },
+              createBulk: { type: t['./cats/classes/cat.class'].Cat },
+              createAsFormData: { type: t['./cats/classes/cat.class'].Cat },
               getWithEnumParam: {},
               getWithRandomQuery: {}
             }
