Merge branch 'test/middleware/add-cases-for-root-path-invoke' of github.com:jeremydaly/lambda-api into test/middleware/add-cases-for-root-path-invoke

Author: naorpeled

.github/workflows/merge-to-main.yml renamed to .github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: 'Merge to main'
+name: 'Build'
 
 on:
   push:
@@ -28,6 +28,8 @@ jobs:
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Install NPM
+        run: npm install -g npm@9
       - run: npm ci
       - run: npm run test-ci
         env:

.github/workflows/pull-request.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [14, 16, 18]
+        node: [14, 16, 18, 20]
     name: Node ${{ matrix.node }}
     steps:
       - name: 'Checkout latest code'
@@ -19,6 +19,9 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
+          cache: 'npm'
+      - name: Install NPM
+        run: npm install -g npm@9
       - name: Install dependencies
         run: npm ci
       - name: Run tests
@@ -36,6 +39,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: '16'
+          cache: 'npm'
       - name: Install dependencies
         run: npm ci
       - name: Run ESLint

README.md

@@ -1,6 +1,6 @@
 [![Lambda API](https://www.jeremydaly.com/wp-content/uploads/2018/03/lambda-api-logo.svg)](https://serverless-api.com/)
 
-[![Build Status](https://github.com/jeremydaly/lambda-api/actions/workflows/build.yml/badge.svg)](https://github.com/jeremydaly/lambda-api/actions/workflows/build.yml)
+[![Build Status](https://github.com/jeremydaly/lambda-api/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/jeremydaly/lambda-api/actions/workflows/build.yml)
 [![npm](https://img.shields.io/npm/v/lambda-api.svg)](https://www.npmjs.com/package/lambda-api)
 [![npm](https://img.shields.io/npm/l/lambda-api.svg)](https://www.npmjs.com/package/lambda-api)
 [![Coverage Status](https://coveralls.io/repos/github/jeremydaly/lambda-api/badge.svg?branch=main)](https://coveralls.io/github/jeremydaly/lambda-api?branch=main)
@@ -9,6 +9,11 @@
 
 Lambda API is a lightweight web framework for AWS Lambda using AWS API Gateway Lambda Proxy Integration or ALB Lambda Target Support. This closely mirrors (and is based on) other web frameworks like Express.js and Fastify, but is significantly stripped down to maximize performance with Lambda's stateless, single run executions.
 
+## Using AWS SDK v2?
+
+lambda-api@v1 is using AWS SDK v3.
+If you are using AWS SDK v2, please use lambda-api@v0.12.0.
+
 ## Simple Example
 
 ```javascript
@@ -147,6 +152,7 @@ Require the `lambda-api` module into your Lambda handler script and instantiate
 | serializer           | `Function`            | Optional object serializer function. This function receives the `body` of a response and must return a string. Defaults to `JSON.stringify`                                                               |
 | version              | `String`              | Version number accessible via the `REQUEST` object                                                                                                                                                        |
 | errorHeaderWhitelist | `Array`               | Array of headers to maintain on errors                                                                                                                                                                    |
+| s3Config             | `Object`              | Optional object to provide as config to S3 sdk. [S3ClientConfig](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)                                 |
 
 ```javascript
 // Require the framework and instantiate it with optional version and base parameters
@@ -481,21 +487,22 @@ res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
 The `header` method allows for you to set additional headers to return to the client. By default, just the `content-type` header is sent with `application/json` as the value. Headers can be added or overwritten by calling the `header()` method with two string arguments. The first is the name of the header and then second is the value. You can utilize multi-value headers by specifying an array with multiple values as the `value`, or you can use an optional third boolean parameter and append multiple headers.
 
 ```javascript
-api.get('/users', (req,res) => {
-  res.header('content-type','text/html').send('<div>This is HTML</div>')
-})
+api.get('/users', (req, res) => {
+  res.header('content-type', 'text/html').send('<div>This is HTML</div>');
+});
 
 // Set multiple header values
-api.get('/users', (req,res) => {
-  res.header('someHeader',['foo','bar').send({})
-})
+api.get('/users', (req, res) => {
+  res.header('someHeader', ['foo', 'bar']).send({});
+});
 
 // Set multiple header by adding to existing header
-api.get('/users', (req,res) => {
-  res.header('someHeader','foo')
-    .header('someHeader','bar',true) // append another value
-      .send({})
-})
+api.get('/users', (req, res) => {
+  res
+    .header('someHeader', 'foo')
+    .header('someHeader', 'bar', true) // append another value
+    .send({});
+});
 ```
 
 **NOTE:** Header keys are converted and stored as lowercase in compliance with [rfc7540 8.1.2. HTTP Header Fields](https://tools.ietf.org/html/rfc7540) for HTTP/2. Header convenience methods (`getHeader`, `hasHeader`, and `removeHeader`) automatically ignore case.

__tests__/cookies.unit.js

@@ -299,6 +299,39 @@ describe('Cookie Tests:', function() {
       })
     }) // end it
 
+    /**
+     * There is no definitive standard on what the cookie value can contain.
+     * The most restrictive definition I could find comes from Safari which only supports
+     * the ASCII character set, excluding semi-colon, comma, backslash, and white space.
+     * 
+     * The % character is also ambiguous, as it is used as part of the URL encoded scheme. For the purpose of this test, we will leave this character out.
+     * 
+     * @see {@link https://stackoverflow.com/a/1969339 | This StackOverflow answer which provides more context regarding the cookie value}
+     */
+    it('Parse cookie with the entire supported set of ASCII characters', async function() {
+      let asciiCharacterSet = ' !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~';
+
+      asciiCharacterSet = 
+        asciiCharacterSet.replace(' ', '')
+          .replace(';', '')
+          .replace(',', '')
+          .replace('/', '')
+          .replace('%', '');
+
+      let _event = Object.assign({},event,{
+        path: '/cookieParse',
+        multiValueHeaders: {
+          cookie: [`test=${asciiCharacterSet}`]
+        }
+      })
+      let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))
+      expect(JSON.parse(result.body)).toEqual({
+        cookies: {
+          test: asciiCharacterSet,
+        },
+      })
+    }) // end it
+
     it('Parse & decode two cookies', async function() {
       let _event = Object.assign({},event,{
         path: '/cookieParse',
@@ -330,6 +363,31 @@ describe('Cookie Tests:', function() {
       })
     }) // end it
 
+    it('Parse & decode multiple cookies with the entire supported set of ASCII characters', async function() {
+      let asciiCharacterSet = ' !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~';
+
+      asciiCharacterSet = 
+        asciiCharacterSet.replace(' ', '')
+          .replace(';', '')
+          .replace(',', '')
+          .replace('/', '')
+          .replace('%', '');
+
+      let _event = Object.assign({},event,{
+        path: '/cookieParse',
+        multiValueHeaders: {
+          cookie: [`test=${asciiCharacterSet}; test2=${asciiCharacterSet}`]
+        }
+      })
+      let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))
+      expect(JSON.parse(result.body)).toEqual({
+        cookies: {
+          test: asciiCharacterSet,
+          test2: asciiCharacterSet,
+        },
+      })
+    }) // end it
+
   }) // end parse tests
 
   describe("Clear", function() {

__tests__/download.unit.js

@@ -7,7 +7,6 @@ const fs = require('fs') // Require Node.js file system
 // Require Sinon.js library
 const sinon = require('sinon')
 
-const AWS = require('aws-sdk') // AWS SDK (automatically available in Lambda)
 const S3 = require('../lib/s3-service') // Init S3 Service
 
 // Init API instance

__tests__/getLink.unit.js

@@ -5,9 +5,6 @@ const delay = ms => new Promise(res => setTimeout(res, ms))
 // Require Sinon.js library
 const sinon = require('sinon')
 
-const AWS = require('aws-sdk') // AWS SDK (automatically available in Lambda)
-// AWS.config.credentials = new AWS.SharedIniFileCredentials({profile: 'madlucas'})
-
 const S3 = require('../lib/s3-service') // Init S3 Service
 
 // Init API instance

__tests__/headers.unit.js

@@ -90,6 +90,13 @@ api.get('/hasHeader', function(req,res) {
   })
 })
 
+api.get('/setHeader', function(req,res) {
+  res.status(200).header('TestHeader','test').setHeader('NewHeader','test')
+  res.json({
+    headers: res.getHeaders()
+  })
+});
+
 api.get('/removeHeader', function(req,res) {
   res.status(200).header('TestHeader','test').header('NewHeader','test').removeHeader('testHeader')
   res.json({
@@ -243,6 +250,20 @@ describe('Header Tests:', function() {
       })
     }) // end it
 
+    it('Set Header', async function() {
+      let _event = Object.assign({},event,{ path: '/setHeader'})
+      let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))
+      expect(result).toEqual({
+        multiValueHeaders: {
+          'content-type': ['application/json'],
+          'testheader': ['test'],
+          'newheader': ['test']
+        }, statusCode: 200,
+        body: "{\"headers\":{\"content-type\":[\"application/json\"],\"testheader\":[\"test\"],\"newheader\":[\"test\"]}}",
+        isBase64Encoded: false
+      })
+    }) // end it
+
     it('Remove Header', async function() {
       let _event = Object.assign({},event,{ path: '/removeHeader'})
       let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))

__tests__/responses.unit.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const sinon = require('sinon') // Require Sinon.js library
-const AWS = require('aws-sdk') // AWS SDK (automatically available in Lambda)
 const S3 = require('../lib/s3-service') // Init S3 Service
 const { gzipSync, brotliCompressSync, deflateSync } = require('zlib')
 

__tests__/sendFile.unit.js

@@ -7,13 +7,10 @@ const fs = require('fs') // Require Node.js file system
 // Require Sinon.js library
 const sinon = require('sinon')
 
-const AWS = require('aws-sdk') // AWS SDK (automatically available in Lambda)
-// AWS.config.credentials = new AWS.SharedIniFileCredentials({profile: 'madlucas'})
-
 const S3 = require('../lib/s3-service'); // Init S3 Service
 
 // Init API instance
-const api = require('../index')({ version: 'v1.0', mimeTypes: { test: 'text/test' } })
+const api = require('../index')({ version: 'v1.0', mimeTypes: { test: 'text/test' }})
 
 let event = {
   httpMethod: 'get',
@@ -187,10 +184,12 @@ api.use(function(err,req,res,next) {
 let stub
 
 describe('SendFile Tests:', function() {
+  let setConfigSpy;
 
   beforeEach(function() {
      // Stub getObjectAsync
     stub = sinon.stub(S3,'getObject')
+    setConfigSpy = sinon.spy(S3, 'setConfig');
   })
 
   it('Bad path', async function() {
@@ -348,6 +347,7 @@ describe('SendFile Tests:', function() {
   it('S3 file', async function() {
     let _event = Object.assign({},event,{ path: '/sendfile/s3' })
     let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))
+    sinon.assert.notCalled(setConfigSpy);
     expect(result).toEqual({
       multiValueHeaders: {
         'content-type': ['text/plain'],
@@ -359,6 +359,14 @@ describe('SendFile Tests:', function() {
     })
   }) // end it
 
+  it('S3 file w/ custom config',async function() {
+    const s3Config = {
+      endpoint: "http://test"
+    }
+    const apiWithConfig = require('../index')({ version: 'v1.0', mimeTypes: { test: 'text/test' }, s3Config})
+    sinon.assert.calledWith(setConfigSpy, s3Config);
+  }) // end it
+
   it('S3 file w/ nested path', async function() {
     let _event = Object.assign({},event,{ path: '/sendfile/s3path' })
     let result = await new Promise(r => api.run(_event,{},(e,res) => { r(res) }))
@@ -396,8 +404,10 @@ describe('SendFile Tests:', function() {
     })
   }) // end it
 
+
   afterEach(function() {
     stub.restore()
+    setConfigSpy.restore();
   })
 
 }) // end sendFile tests

__tests__/utils.unit.js

@@ -1,6 +1,7 @@
 "use strict";
 
 const utils = require("../lib/utils");
+const { Readable } = require('stream');
 
 /******************************************************************************/
 /***  BEGIN TESTS                                                           ***/
@@ -489,5 +490,15 @@ describe("Utility Function Tests:", function () {
 
 	}); // end deepMerge tests
 
-
+  describe("streamToBuffer:", function () {
+    it("Should transform a given stream to a buffer", function () {
+      let stream = new Readable();
+      stream.push("test");
+      stream.push(null);
+      return utils.streamToBuffer(stream).then((buffer) => {
+        expect(Buffer.isBuffer(buffer)).toBe(true);
+        expect(buffer.toString()).toBe("test");
+      });
+    })
+  })
 }); // end UTILITY tests