Merge branch 'release/1.1.2'

Author: diana.ionita

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-api-gateway-caching",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A plugin for the serverless framework which helps with configuring caching for API Gateway endpoints.",
   "main": "src/apiGatewayCachingPlugin.js",
   "scripts": {

package.json

@@ -3,6 +3,7 @@
 const ApiGatewayCachingSettings = require('./ApiGatewayCachingSettings');
 const addPathParametersCacheConfig = require('./pathParametersCache');
 const updateStageCacheSettings = require('./stageCache');
+const { outputRestApiIdTo } = require('./restApiId');
 
 class ApiGatewayCachingPlugin {
   constructor(serverless, options) {
@@ -21,17 +22,14 @@ class ApiGatewayCachingPlugin {
   }
 
   updateCloudFormationTemplate() {
-    let restApiId = {
-      Ref: 'ApiGatewayRestApi',
-    };
-    if (this.serverless.service.provider.apiGateway && this.serverless.service.provider.apiGateway.restApiId) {
-      restApiId = this.serverless.service.provider.apiGateway.restApiId
+    this.thereIsARestApi = this.restApiExists();
+    if (!this.thereIsARestApi) {
+      this.serverless.cli.log(`[serverless-api-gateway-caching] No Rest API found. Caching settings will not be updated.`);
+      return;
     }
-    this.serverless.service.provider.compiledCloudFormationTemplate.Outputs.RestApiIdForApiGwCaching = {
-      Description: 'Rest API Id',
-      Value: restApiId,
-    };
-    
+
+    outputRestApiIdTo(this.serverless);
+
     // if caching is not defined or disabled
     if (!this.settings.cachingEnabled) {
       return;
@@ -41,8 +39,20 @@ class ApiGatewayCachingPlugin {
   }
 
   updateStage() {
+    if (!this.thereIsARestApi) {
+      this.serverless.cli.log(`[serverless-api-gateway-caching] No Rest API found. Caching settings will not be updated.`);
+      return;
+    }
     return updateStageCacheSettings(this.settings, this.serverless);
   }
+
+  restApiExists() {
+    let resource = this.serverless.service.provider.compiledCloudFormationTemplate.Resources['ApiGatewayRestApi'];
+    if (resource) {
+      return true;
+    }
+    return false;
+  }
 }
 
 module.exports = ApiGatewayCachingPlugin;

src/apiGatewayCachingPlugin.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const get = require('lodash.get');
+const REST_API_ID_KEY = 'RestApiIdForApigCaching';
+
+const outputRestApiIdTo = (serverless) => {
+  const configuredRestApiId = get(serverless, 'service.provider.apiGateway.restApiId');
+  const autoGeneratedRestApiId = { Ref: 'ApiGatewayRestApi' };
+
+  serverless.service.provider.compiledCloudFormationTemplate.Outputs[REST_API_ID_KEY] = {
+    Description: 'Rest API Id',
+    Value: configuredRestApiId || autoGeneratedRestApiId,
+  };
+};
+
+const retrieveRestApiId = async (serverless, settings) => {
+  const stackName = serverless.providers.aws.naming.getStackName(settings.stage);
+
+  const cloudFormation = await serverless.providers.aws.request('CloudFormation', 'describeStacks', { StackName: stackName },
+    settings.stage,
+    settings.region
+  );
+  const outputs = cloudFormation.Stacks[0].Outputs;
+  const restApiKey = outputs.find(({ OutputKey }) => OutputKey === REST_API_ID_KEY).OutputValue;
+
+  return restApiKey;
+};
+
+module.exports = {
+  outputRestApiIdTo,
+  retrieveRestApiId
+};

src/restApiId.js

@@ -1,17 +1,5 @@
 const isEmpty = require('lodash.isempty');
-
-const getRestApiId = async (settings, serverless) => {
-  const stackName = serverless.providers.aws.naming.getStackName(settings.stage);
-
-  let stack = await serverless.providers.aws.request('CloudFormation', 'describeStacks', { StackName: stackName },
-    settings.stage,
-    settings.region
-  );
-
-  return stack.Stacks[0].Outputs
-    .filter(output => output.OutputKey === 'RestApiIdForApiGwCaching')
-    .map(output => output.OutputValue)[0];
-}
+const { retrieveRestApiId } = require('./restApiId');
 
 String.prototype.replaceAll = function (search, replacement) {
   let target = this;
@@ -119,7 +107,7 @@ const updateStageCacheSettings = async (settings, serverless) => {
     return;
   }
 
-  let restApiId = await getRestApiId(settings, serverless);
+  let restApiId = await retrieveRestApiId(serverless, settings);
 
   let patchOps = createPatchForStage(settings);
 

src/stageCache.js

@@ -88,7 +88,7 @@ class Serverless {
               Stacks: [
                 {
                   Outputs: [{
-                    OutputKey: 'RestApiIdForApiGwCaching',
+                    OutputKey: 'RestApiIdForApigCaching',
                     OutputValue: restApiId
                   }]
                 }