@middy/s3-object-response 2.5.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+# Middy s3-object-response middleware
+
+<div align="center">
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
+</div>
+
+<div align="center">
+  <p><strong>S3 object response middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+</div>
+
+<div align="center">
+<p>
+  <a href="http://badge.fury.io/js/%40middy%2Fs3-object-response">
+    <img src="https://badge.fury.io/js/%40middy%2Fs3-object-response.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+  </a>
+</p>
+</div>
+
+** This middleware is a Proof of Concept and requires real world testing before use, not recommended for production **
+
+Fetches S3 object as a stream and writes back to s3 object response.
+
+## Install
+
+To install this middleware you can use NPM:
+
+```bash
+npm install --save @middy/s3-object-response
+```
+
+
+## Options
+- `bodyType` (string) (required): How to pass in the s3 object through the handler. Can be `stream` or `promise`.
+- `AwsClient` (object) (default `AWS.S3`): AWS.STS class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
+- `awsClientOptions` (object) (optional): Options to pass to AWS.STS class constructor.
+- `awsClientCapture` (function) (optional): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
+- `httpsCapture` (function) (optional): Enable XRay by passing `captureHTTPsGlobal` from `aws-xray-sdk` in.
+- `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
+
+NOTES:
+- The response from the handler must match the allowed parameters for [`S3.writeGetObjectResponse`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#writeGetObjectResponse-property), excluding `RequestRoute` and `RequestToken`.
+- Lambda is required to have IAM permission for `s3-object-lambda:WriteGetObjectResponse`
+
+## Sample usage
+### Stream
+```javascript
+import zlib from 'zlib'
+import middy from '@middy/core'
+import s3ObjectResponse from '@middy/s3-object-response'
+
+const handler = middy((event, context) => {
+  const readStream = context.s3Object
+  const transformStream = zlib.createBrotliCompress()
+  return {
+    Body: readStream.pipe(transformStream)
+  }
+})
+
+handler
+  .use(s3ObjectResponse({
+    bodyType: 'stream'
+  }))
+```
+
+### Promise
+```javascript
+import zlib from 'zlib'
+import middy from '@middy/core'
+import s3ObjectResponse from '@middy/s3-object-response'
+
+const handler = middy(async (event, context) => {
+  let body = await context.s3Object
+  // change body
+  return {
+    Body: JSON.stringify(body)
+  }
+})
+
+handler
+  .use(s3ObjectResponse({
+    bodyType: 'promise'
+  }))
+```
+
+
+## Middy documentation and examples
+
+For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
+
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+
+<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
+  <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">
+</a>

package/index.d.ts

@@ -0,0 +1,16 @@
+import { S3 } from 'aws-sdk'
+import { captureAWSClient } from 'aws-xray-sdk'
+import middy from '@middy/core'
+
+interface Options<S = S3> {
+  AwsClient?: new() => S
+  awsClientOptions?: Partial<S3.Types.ClientConfiguration>
+  awsClientAssumeRole?: string
+  awsClientCapture?: typeof captureAWSClient
+  disablePrefetch?: boolean
+  bodyType?: string
+}
+
+declare function s3ObjectResponse (options?: Options): middy.MiddlewareObj
+
+export default s3ObjectResponse

package/index.js

@@ -0,0 +1,116 @@
+"use strict";
+
+let https = require('https');
+
+const {
+  URL
+} = require('url');
+
+const {
+  canPrefetch,
+  createPrefetchClient,
+  createClient
+} = require('@middy/util');
+
+const S3 = require('aws-sdk/clients/s3'); // v2
+// const { S3 } = require('@aws-sdk/client-s3') // v3
+
+
+const defaults = {
+  AwsClient: S3,
+  // Allow for XRay
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  httpsCapture: undefined,
+  disablePrefetch: false,
+  bodyType: undefined
+};
+
+const s3ObjectResponseMiddleware = (opts = {}) => {
+  const options = { ...defaults,
+    ...opts
+  };
+
+  if (!['stream', 'promise'].includes(options.bodyType)) {
+    throw new Error('bodyType is invalid.');
+  }
+
+  if (options.httpsCapture) {
+    https = options.httpsCapture(https);
+  }
+
+  let client;
+
+  if (canPrefetch(options)) {
+    client = createPrefetchClient(options);
+  }
+
+  const s3ObjectResponseMiddlewareBefore = async request => {
+    const {
+      inputS3Url,
+      outputRoute,
+      outputToken
+    } = request.event.getObjectContext;
+    request.internal.s3ObjectResponse = {
+      RequestRoute: outputRoute,
+      RequestToken: outputToken
+    };
+    const parsedInputS3Url = new URL(inputS3Url);
+    const fetchOptions = {
+      method: 'GET',
+      host: parsedInputS3Url.hostname,
+      path: parsedInputS3Url.pathname
+    };
+    request.context.s3Object = fetchType(options.bodyType, fetchOptions);
+  };
+
+  const s3ObjectResponseMiddlewareAfter = async request => {
+    var _request$response$Bod;
+
+    if (!client) {
+      client = await createClient(options, request);
+    }
+
+    request.response.Body = (_request$response$Bod = request.response.Body) !== null && _request$response$Bod !== void 0 ? _request$response$Bod : request.response.body;
+    delete request.response.body;
+    return client.writeGetObjectResponse({ ...request.response,
+      ...request.internal.s3ObjectResponse
+    }).promise().then(() => ({
+      statusCode: 200
+    })); // TODO test if needed
+  };
+
+  return {
+    before: s3ObjectResponseMiddlewareBefore,
+    after: s3ObjectResponseMiddlewareAfter
+  };
+};
+
+const fetchType = (type, fetchOptions) => {
+  if (type === 'stream') {
+    return fetchStream(fetchOptions);
+  } else if (type === 'promise') {
+    return fetchPromise(fetchOptions);
+  }
+
+  return null;
+};
+
+const fetchStream = fetchOptions => {
+  return https.request(fetchOptions);
+};
+
+const fetchPromise = fetchOptions => {
+  return new Promise((resolve, reject) => {
+    let data = '';
+    const stream = fetchStream(fetchOptions);
+    stream.on('data', chunk => {
+      data += chunk;
+    });
+    stream.on('end', () => resolve(data));
+    stream.on('error', error => reject(error));
+  });
+};
+
+module.exports = s3ObjectResponseMiddleware;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@middy/s3-object-response",
+  "version": "2.5.2",
+  "description": "S3 object response handling middleware for the middy framework",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "ava"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "S3",
+    "GetObjectResponse",
+    "WriteObjectREsponse"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:middyjs/middy",
+    "directory": "packages/sts"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://github.com/middyjs/middy#readme",
+  "dependencies": {
+    "@middy/util": "^2.5.2"
+  },
+  "devDependencies": {
+    "@middy/core": "^2.5.2",
+    "aws-sdk": "^2.939.0",
+    "aws-xray-sdk": "^3.3.3"
+  },
+  "gitHead": "a2bb757a7a13638ae64277f8eecfcf11c1af17d4"
+}