feat: Support string variable in the first argument of @extension (#1677

) * feat: accepts identifiers * handle null? * undefined? * where is the null * refactor: attributeValue checks * fix: addressing tsoa-cli error * trying to understand lru-cache error - remove identifier * trying to understand lru-cache error - remove get value * trying to understand lru-cache error - remove all metadata changes * return to initial * handle null? * undefined? * where is the null * refactor: attributeValue checks * fix: addressing tsoa-cli error * trying to understand lru-cache error - remove identifier * trying to understand lru-cache error - remove get value * trying to understand lru-cache error - remove all metadata changes * return to initial * refactor: remove unneeded guard
lukeautry · Sep 26, 2024 · 2c85ac9 · 2c85ac9
1 parent 364288c
commit 2c85ac9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/packages/cli/src/metadataGeneration/extension.ts b/packages/cli/src/metadataGeneration/extension.ts
@@ -12,11 +12,15 @@ export function getExtensions(decorators: ts.Identifier[], metadataGenerator: Me
 
     const [decoratorKeyArg, decoratorValueArg] = extensionDecorator.parent.arguments;
 
-    if (!ts.isStringLiteral(decoratorKeyArg)) {
+    if (!ts.isStringLiteral(decoratorKeyArg) && !ts.isIdentifier(decoratorKeyArg)) {
       throw new Error('The first argument of @Extension must be a string');
     }
 
-    const attributeKey = decoratorKeyArg.text;
+    const attributeKey = ts.isIdentifier(decoratorKeyArg) ? getInitializerValue(decoratorKeyArg, metadataGenerator.typeChecker) : decoratorKeyArg.text;
+
+    if (typeof attributeKey !== 'string') {
+      throw new Error('The first argument of @Extension must be a string');
+    }
 
     if (!decoratorValueArg) {
       throw new Error(`Extension '${attributeKey}' must contain a value`);

diff --git a/tests/fixtures/controllers/methodController.ts b/tests/fixtures/controllers/methodController.ts
@@ -27,6 +27,8 @@ const TEST_SEC = {
   secondSec: [TEST_ENUM.ADMIN, TEST_ENUM.OWNER],
 };
 
+const ATT_KEY9 = 'x-attKey9';
+
 @Route('MethodTest')
 export class MethodController extends Controller {
   @Options('Options')
@@ -165,6 +167,7 @@ export class MethodController extends Controller {
   @Extension('x-attKey6', [{ y0: 'yt0', y1: 'yt1', y2: 123, y3: true, y4: null }, { y2: 'yt2' }])
   @Extension('x-attKey7', { test: ['testVal', 123, true, null] })
   @Extension('x-attKey8', { test: { testArray: ['testVal1', true, null, ['testVal2', 'testVal3', 123, true, null]] } })
+  @Extension(ATT_KEY9, 'identifierAttValue')
   @Get('Extension')
   public async extension(): Promise<TestModel> {
     return new ModelService().getModel();

diff --git a/tests/unit/swagger/definitionsGeneration/metadata.spec.ts b/tests/unit/swagger/definitionsGeneration/metadata.spec.ts
@@ -166,10 +166,13 @@ describe('Metadata generation', () => {
 
       expect(method.responses.length).to.equal(5);
 
-      const badResponse = method.responses[1]
+      const badResponse = method.responses[1];
       expect(badResponse.name).to.equal('400');
       expect(badResponse.description).to.equal('Bad Request');
-      expect(badResponse.examples).to.deep.equal([{ status: 400, message: 'reason 1' }, { status: 400, message: 'reason 2' }]);
+      expect(badResponse.examples).to.deep.equal([
+        { status: 400, message: 'reason 1' },
+        { status: 400, message: 'reason 2' },
+      ]);
 
       const unauthResponse = method.responses[2];
       expect(unauthResponse.name).to.equal('401');
@@ -316,6 +319,7 @@ describe('Metadata generation', () => {
         { key: 'x-attKey6', value: [{ y0: 'yt0', y1: 'yt1', y2: 123, y3: true, y4: null }, { y2: 'yt2' }] },
         { key: 'x-attKey7', value: { test: ['testVal', 123, true, null] } },
         { key: 'x-attKey8', value: { test: { testArray: ['testVal1', true, null, ['testVal2', 'testVal3', 123, true, null]] } } },
+        { key: 'x-attKey9', value: 'identifierAttValue' },
       ];
 
       expect(method.extensions).to.deep.equal(expectedExtensions);