Merge branch 'release/1.8.0'

Author: Diana Ionita

LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022 Diana Ionita
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -227,7 +227,6 @@ functions:
       - http:
           path: /graphql
           method: post
-          integration: lambda # you must use lambda integration (instead of the default proxy integration) for this to work
           caching:
             enabled: true
             cacheKeyParameters:
@@ -253,7 +252,6 @@ functions:
       - http:
           path: /graphql
           method: post
-          integration: lambda # you must use lambda integration (instead of the default proxy integration) for this to work
           caching:
             enabled: true
             cacheKeyParameters:
@@ -289,6 +287,52 @@ custom:
       handleUnauthorizedRequests: Ignore
 ```
 
+### Example of configuring an API Gateway with endpoints scattered across multiple serverless projects
+
+In the project hosting the main API Gateway deployment:
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
+
+custom:
+  apiGatewayCaching:
+    enabled: true # create an API cache
+    ttlInSeconds: 0 # but don't cache responses by default (individual endpoints can override this)
+```
+
+In a project that references that API Gateway:
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
+
+custom:
+  apiGatewayCaching:
+    enabled: true # enables caching for endpoints in this project (each endpoint must also set caching: enabled to true)
+    apiGatewayIsShared: true # makes sure the settings on the Main API Gateway are not changed
+    restApiId: ${cf:api-gateway-${self:provider.stage}.RestApiId}
+    basePath: /animals
+
+functions:
+  # caching disabled, it must be explicitly enabled
+  adoptCat:
+    handler: adoptCat.handle
+    events:
+      - http:
+          path: /cat/adoption
+          method: post
+
+  getCats:
+    handler: getCats.handle
+    events:
+      - http:
+          path: /cats
+          method: get
+          caching:
+            enabled: true # enables caching for this endpoint
+```
+
 ## Configuring caching settings for endpoints defined in CloudFormation
 You can use this feature to configure caching for endpoints which are defined in CloudFormation and not as serverless functions.
 If your `serverless.yml` contains, for example, a [HTTP Proxy](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/#setting-an-http-proxy-on-api-gateway) like this:
@@ -396,7 +440,6 @@ functions:
       - http:
           path: /cats
           method: post
-          integration: lambda # you must use lambda integration for this to work
           caching:
             enabled: true
             cacheKeyParameters:

package-lock.json

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

package.json

@@ -30,9 +30,12 @@ const addPathParametersCacheConfig = (settings, serverless) => {
         let existingValue = method.Properties.RequestParameters[`method.${cacheKeyParameter.name}`];
         method.Properties.RequestParameters[`method.${cacheKeyParameter.name}`] = (existingValue == null || existingValue == undefined) ? {} : existingValue;
 
-        if (method.Properties.Integration.Type !== 'AWS_PROXY') {
+        // in v1.8.0 "lambda" integration check was removed because setting cache key parameters seemed to work for both AWS_PROXY and AWS (lambda) integration
+        // reconsider if this becomes an issue
+
+        // if (method.Properties.Integration.Type !== 'AWS_PROXY') {
           method.Properties.Integration.RequestParameters[`integration.${cacheKeyParameter.name}`] = `method.${cacheKeyParameter.name}`;
-        }
+        // }
 
         method.Properties.Integration.CacheKeyParameters.push(`method.${cacheKeyParameter.name}`);
       } else {
@@ -44,9 +47,9 @@ const addPathParametersCacheConfig = (settings, serverless) => {
         ) {
           method.Properties.RequestParameters[cacheKeyParameter.mappedFrom] = (existingValue == null || existingValue == undefined) ? {} : existingValue;
         }
-        if (method.Properties.Integration.Type !== 'AWS_PROXY') {
+        // if (method.Properties.Integration.Type !== 'AWS_PROXY') {
           method.Properties.Integration.RequestParameters[cacheKeyParameter.name] = cacheKeyParameter.mappedFrom;
-        }
+        // }
         method.Properties.Integration.CacheKeyParameters.push(cacheKeyParameter.name)
       }
     }

src/pathParametersCache.js

@@ -41,6 +41,7 @@ describe('Configuring path parameter caching', () => {
     });
   });
 
+  // in v1.8.0 "lambda" integration check was removed because setting cache key parameters seemed to work for both AWS_PROXY and AWS (lambda) integration
   describe('when one endpoint with lambda integration has cache key parameters', () => {
     let cacheKeyParameters, method, functionWithCachingName;
     before(() => {
@@ -70,10 +71,10 @@ describe('Configuring path parameter caching', () => {
       }
     });
 
-    it('should not set any integration request parameters', () => {
+    it('should set integration request parameters', () => {
       for (let parameter of cacheKeyParameters) {
         expect(method.Properties.Integration.RequestParameters)
-          .to.not.include({
+          .to.include({
             [`integration.${parameter.name}`]: `method.${parameter.name}`
           });
       }