feat: Recognize provider.apiGateway.apiKeys

Author: medikoo

lib/deploy/events/apiGateway/apiKeys.js

@@ -5,12 +5,14 @@ const BbPromise = require('bluebird');
 
 module.exports = {
   compileApiKeys() {
-    if (this.serverless.service.provider.apiKeys) {
-      if (!Array.isArray(this.serverless.service.provider.apiKeys)) {
+    const apiKeys = _.get(this.serverless.service.provider.apiGateway, 'apiKeys')
+      || this.serverless.service.provider.apiKeys;
+    if (apiKeys) {
+      if (!Array.isArray(apiKeys)) {
         throw new this.serverless.classes.Error('apiKeys property must be an array');
       }
 
-      _.forEach(this.serverless.service.provider.apiKeys, (apiKey, i) => {
+      _.forEach(apiKeys, (apiKey, i) => {
         const apiKeyNumber = i + 1;
 
         if (typeof apiKey !== 'string') {

lib/deploy/events/apiGateway/apiKeys.test.js

@@ -16,7 +16,8 @@ describe('#methods()', () => {
       region: 'us-east-1',
     };
     serverless.setProvider('aws', new AwsProvider(serverless));
-    serverless.service.provider.apiKeys = ['1234567890'];
+    if (!serverless.service.provider.apiGateway) serverless.service.provider.apiGateway = {};
+    serverless.service.provider.apiGateway.apiKeys = ['1234567890'];
     serverless.service.provider.compiledCloudFormationTemplate = {
       Resources: {},
     };
@@ -79,12 +80,12 @@ describe('#methods()', () => {
   }));
 
   it('throw error if apiKey property is not an array', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = 2;
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = 2;
     expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
   });
 
   it('throw error if an apiKey is not a string', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = [2];
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [2];
     expect(() => serverlessStepFunctions.compileApiKeys()).to.throw(Error);
   });
 });

lib/deploy/events/apiGateway/usagePlan.js

@@ -5,7 +5,9 @@ const BbPromise = require('bluebird');
 
 module.exports = {
   compileUsagePlan() {
-    if (this.serverless.service.provider.usagePlan || this.serverless.service.provider.apiKeys) {
+    if (this.serverless.service.provider.usagePlan
+      || _.get(this.serverless.service.provider.apiGateway, 'apiKeys')
+      || this.serverless.service.provider.apiKeys) {
       this.apiGatewayUsagePlanLogicalId = this.provider.naming.getUsagePlanLogicalId();
       _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
         [this.apiGatewayUsagePlanLogicalId]: {

lib/deploy/events/apiGateway/usagePlan.test.js

@@ -17,7 +17,8 @@ describe('#compileUsagePlan()', () => {
     };
     serverless.service.service = 'first-service';
     serverless.setProvider('aws', new AwsProvider(serverless));
-    serverless.service.provider.apiKeys = ['1234567890'];
+    if (!serverless.service.provider.apiGateway) serverless.service.provider.apiGateway = {};
+    serverless.service.provider.apiGateway.apiKeys = ['1234567890'];
     serverless.service.provider.compiledCloudFormationTemplate = {
       Resources: {},
     };
@@ -36,7 +37,7 @@ describe('#compileUsagePlan()', () => {
   });
 
   it('should compile default usage plan resource', () => {
-    serverless.service.provider.apiKeys = ['1234567890'];
+    serverless.service.provider.apiGateway.apiKeys = ['1234567890'];
     return serverlessStepFunctions.compileUsagePlan().then(() => {
       expect(
         serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate

lib/deploy/events/apiGateway/usagePlanKeys.js

@@ -5,12 +5,14 @@ const BbPromise = require('bluebird');
 
 module.exports = {
   compileUsagePlanKeys() {
-    if (this.serverless.service.provider.apiKeys) {
-      if (!Array.isArray(this.serverless.service.provider.apiKeys)) {
+    const apiKeys = _.get(this.serverless.service.provider.apiGateway, 'apiKeys')
+      || this.serverless.service.provider.apiKeys;
+    if (apiKeys) {
+      if (!Array.isArray(apiKeys)) {
         throw new this.serverless.classes.Error('apiKeys property must be an array');
       }
 
-      _.forEach(this.serverless.service.provider.apiKeys, (apiKey, i) => {
+      _.forEach(apiKeys, (apiKey, i) => {
         const usagePlanKeyNumber = i + 1;
 
         if (typeof apiKey !== 'string') {

lib/deploy/events/apiGateway/usagePlanKeys.test.js

@@ -19,7 +19,7 @@ describe('#compileUsagePlanKeys()', () => {
     serverless.service.service = 'first-service';
     serverless.service.provider = {
       name: 'aws',
-      apiKeys: ['1234567890'],
+      apiGateway: { apiKeys: ['1234567890'] },
     };
     serverless.service.provider.compiledCloudFormationTemplate = {
       Resources: {},
@@ -66,12 +66,12 @@ describe('#compileUsagePlanKeys()', () => {
   }));
 
   it('throw error if apiKey property is not an array', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = 2;
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = 2;
     expect(() => serverlessStepFunctions.compileUsagePlanKeys()).to.throw(Error);
   });
 
   it('throw error if an apiKey is not a string', () => {
-    serverlessStepFunctions.serverless.service.provider.apiKeys = [2];
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [2];
     expect(() => serverlessStepFunctions.compileUsagePlanKeys()).to.throw(Error);
   });
 });