fix(AWS API Gateway): Meaningfully reject missing `restApiRootResourc…

…eId` (PR #10371)
serverless · Dec 15, 2021 · 2c0a962 · 2c0a962
1 parent dd033e8
commit 2c0a962
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/lib/plugins/aws/package/compile/events/apiGateway/lib/validate.js b/lib/plugins/aws/package/compile/events/apiGateway/lib/validate.js
@@ -41,6 +41,14 @@ module.exports = {
   validate() {
     const events = [];
     const corsPreflight = {};
+    const apiGateway = this.serverless.service.provider.apiGateway;
+
+    if (apiGateway && apiGateway.restApiId && !apiGateway.restApiRootResourceId) {
+      throw new ServerlessError(
+        'Missing required "provider.apiGateway.restApiRootResourceId" property (needed if "provider.apiGateway.restApiId" is provided)',
+        'API_GATEWAY_MISSING_REST_API_ROOT_RESOURCE_ID'
+      );
+    }
 
     Object.entries(this.serverless.service.functions).forEach(([functionName, functionObject]) => {
       (functionObject.events || []).forEach((event) => {

diff --git a/test/unit/lib/plugins/aws/package/compile/events/apiGateway/lib/validate.test.js b/test/unit/lib/plugins/aws/package/compile/events/apiGateway/lib/validate.test.js
@@ -8,6 +8,9 @@ const Serverless = require('../../../../../../../../../../lib/Serverless');
 const AwsProvider = require('../../../../../../../../../../lib/plugins/aws/provider');
 const ServerlessError = require('../../../../../../../../../../lib/serverless-error');
 
+const chai = require('chai');
+chai.use(require('chai-as-promised'));
+
 describe('#validate()', () => {
   let serverless;
   let awsCompileApigEvents;
@@ -1471,4 +1474,36 @@ describe('test/unit/lib/plugins/aws/package/compile/events/apiGateway/lib/valida
         .IntegrationResponses[0].ResponseParameters
     ).to.deep.eq(expected);
   });
+
+  it('should throw an error when restApiRootResourceId is not provided with restApiId', async () => {
+    await expect(
+      runServerless({
+        fixture: 'function',
+        command: 'package',
+        configExt: {
+          provider: {
+            apiGateway: {
+              restApiId: 'ivrcdpj7y2',
+            },
+          },
+          functions: {
+            first: {
+              handler: 'index.handler',
+              events: [
+                {
+                  http: {
+                    method: 'GET',
+                    path: 'foo/bar',
+                  },
+                },
+              ],
+            },
+          },
+        },
+      })
+    ).to.be.eventually.rejected.and.have.property(
+      'code',
+      'API_GATEWAY_MISSING_REST_API_ROOT_RESOURCE_ID'
+    );
+  });
 });