fix: Handle custom stage name when creating a Usage Plan

serverless · Feb 9, 2024 · c70d1d7 · c70d1d7
1 parent 7b1e012
commit c70d1d7
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/lib/plugins/aws/package/compile/events/api-gateway/lib/usage-plan.js b/lib/plugins/aws/package/compile/events/api-gateway/lib/usage-plan.js
@@ -10,13 +10,15 @@ function createUsagePlanResource(that, name) {
       ApiStages: [
         {
           ApiId: that.provider.getApiGatewayRestApiId(),
-          Stage: that.provider.getStage(),
+          Stage: that.provider.getApiGatewayStage(),
         },
       ],
       Description: `Usage plan "${name}" for ${
         that.serverless.service.service
-      } ${that.provider.getStage()} stage`,
-      UsagePlanName: `${that.serverless.service.service}-${name}-${that.provider.getStage()}`,
+      } ${that.provider.getApiGatewayStage()} stage`,
+      UsagePlanName: `${
+        that.serverless.service.service
+      }-${name}-${that.provider.getApiGatewayStage()}`,
     },
   };
   const template = _.cloneDeep(resourceTemplate);
@@ -26,10 +28,10 @@ function createUsagePlanResource(that, name) {
     // create old legacy resources
     template.Properties.UsagePlanName = `${
       that.serverless.service.service
-    }-${that.provider.getStage()}`;
+    }-${that.provider.getApiGatewayStage()}`;
     template.Properties.Description = `Usage plan for ${
       that.serverless.service.service
-    } ${that.provider.getStage()} stage`;
+    } ${that.provider.getApiGatewayStage()} stage`;
     // assign quota
     if (_.get(usagePlan, 'quota')) {
       _.merge(template, {

diff --git a/test/unit/lib/plugins/aws/package/compile/events/api-gateway/lib/usage-plan.test.js b/test/unit/lib/plugins/aws/package/compile/events/api-gateway/lib/usage-plan.test.js
@@ -288,6 +288,26 @@ describe('#compileUsagePlan()', () => {
       ].Properties.ApiStages[0].ApiId
     ).to.equal('xxxxx');
   });
+
+  it('should compile custom usage plan resource with custom stage name provided', () => {
+    awsCompileApigEvents.serverless.service.provider.apiGateway = {
+      stage: 'custom-stage',
+      usagePlan: {
+        throttle: {
+          burstLimit: 200,
+          rateLimit: 100,
+        },
+      },
+    };
+
+    awsCompileApigEvents.compileUsagePlan();
+
+    expect(
+      awsCompileApigEvents.serverless.service.provider.compiledCloudFormationTemplate.Resources[
+        awsCompileApigEvents.provider.naming.getUsagePlanLogicalId()
+      ].Properties.ApiStages[0].Stage
+    ).to.equal('custom-stage');
+  });
 });
 
 describe('UsagePlan', () => {