Merge branch 'release/1.1.6'

Author: diana.ionita

package-lock.json

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

package.json

@@ -3,7 +3,7 @@
 const ApiGatewayCachingSettings = require('./ApiGatewayCachingSettings');
 const addPathParametersCacheConfig = require('./pathParametersCache');
 const updateStageCacheSettings = require('./stageCache');
-const { outputRestApiIdTo } = require('./restApiId');
+const { restApiExists, outputRestApiIdTo } = require('./restApiId');
 
 class ApiGatewayCachingPlugin {
   constructor(serverless, options) {
@@ -22,7 +22,7 @@ class ApiGatewayCachingPlugin {
   }
 
   updateCloudFormationTemplate() {
-    this.thereIsARestApi = this.restApiExists();
+    this.thereIsARestApi = restApiExists(this.serverless);
     if (!this.thereIsARestApi) {
       this.serverless.cli.log(`[serverless-api-gateway-caching] No Rest API found. Caching settings will not be updated.`);
       return;
@@ -45,14 +45,6 @@ class ApiGatewayCachingPlugin {
     }
     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

@@ -3,8 +3,24 @@
 const get = require('lodash.get');
 const REST_API_ID_KEY = 'RestApiIdForApigCaching';
 
+const getConfiguredRestApiId = (serverless) => {
+  return get(serverless, 'service.provider.apiGateway.restApiId')
+}
+
+const restApiExists = (serverless) => {
+  const configuredRestApiId = getConfiguredRestApiId(serverless);
+  if (configuredRestApiId) {
+    return true;
+  }
+  const resource = serverless.service.provider.compiledCloudFormationTemplate.Resources['ApiGatewayRestApi'];
+  if (resource) {
+    return true;
+  }
+  return false;
+}
+
 const outputRestApiIdTo = (serverless) => {
-  const configuredRestApiId = get(serverless, 'service.provider.apiGateway.restApiId');
+  const configuredRestApiId = getConfiguredRestApiId(serverless);
   const autoGeneratedRestApiId = { Ref: 'ApiGatewayRestApi' };
 
   serverless.service.provider.compiledCloudFormationTemplate.Outputs[REST_API_ID_KEY] = {
@@ -27,6 +43,7 @@ const retrieveRestApiId = async (serverless, settings) => {
 };
 
 module.exports = {
+  restApiExists,
   outputRestApiIdTo,
   retrieveRestApiId
 };

src/restApiId.js

@@ -0,0 +1,48 @@
+const APP_ROOT = '..';
+const given = require(`${APP_ROOT}/test/steps/given`);
+const expect = require('chai').expect;
+const { restApiExists } = require(`${APP_ROOT}/src/restApiId`);
+
+describe('Finding the Rest API', () => {
+  let result;
+  describe('when the Rest API Id has already been defined in serverless configuration', () => {
+    before(() => {
+      let serverless = given.a_serverless_instance()
+        .withPredefinedRestApiId(given.a_rest_api_id());
+      result = restApiExists(serverless);
+    });
+
+    it('should return that the Rest API exists', () => {
+      expect(result).to.be.true;
+    });
+  });
+
+  describe('when the Rest API has not been defined in serverless configuration', () => {
+    describe('and there are HTTP handler functions', () => {
+      before(() => {
+        let functionWithHttpEndpoint = given.a_serverless_function('get-cat-by-paw-id')
+          .withHttpEndpoint('get', '/cat/{pawId}');
+        serverless = given.a_serverless_instance()
+          .withFunction(functionWithHttpEndpoint);
+
+        result = restApiExists(serverless);
+      });
+
+      it('should return that the Rest API does exist', () => {
+        expect(result).to.be.true;
+      });
+    });
+
+    describe('and there are no HTTP handler functions', () => {
+      before(() => {
+        serverless = given.a_serverless_instance();
+
+        result = restApiExists(serverless);
+      });
+
+      it('should return that the Rest API does not exist', () => {
+        expect(result).to.be.false;
+      });
+    });
+  });
+});

test/configuring-rest-api-id.js

@@ -58,6 +58,16 @@ class Serverless {
       functionResourceName,
       methodResourceName
     }
+    // when a function with an http endpoint is defined, serverless creates an ApiGatewayRestApi resource
+    this.service.provider.compiledCloudFormationTemplate.Resources['ApiGatewayRestApi'] = {};
+    return this;
+  }
+
+  withPredefinedRestApiId(restApiId) {
+    if (!this.service.provider.apiGateway) {
+      this.service.provider.apiGateway = {}
+    }
+    this.service.provider.apiGateway.restApiId = restApiId;
     return this;
   }
 

test/model/Serverless.js

@@ -11,8 +11,12 @@ const a_serverless_function = name => {
   return new ServerlessFunction(name);
 }
 
+const a_rest_api_id = () => {
+  return chance.guid();
+}
+
 const a_rest_api_id_for_deployment = async (serverless, settings) => {
-  let restApiId = chance.guid();
+  let restApiId = a_rest_api_id();
   serverless.setRestApiId(restApiId, settings);
 
   return restApiId;
@@ -21,5 +25,6 @@ const a_rest_api_id_for_deployment = async (serverless, settings) => {
 module.exports = {
   a_serverless_instance,
   a_serverless_function,
+  a_rest_api_id,
   a_rest_api_id_for_deployment
 }