@middy/http-content-encoding 5.0.0-alpha.0 → 5.0.0-alpha.2

package/README.md

@@ -19,8 +19,9 @@
   <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://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.js

@@ -8,11 +8,16 @@ const contentEncodingStreams = {
 };
 const defaults = {
     br: undefined,
+    // zstd: undefined,
     gzip: undefined,
     deflate: undefined,
     overridePreferredEncoding: []
 };
-const httpContentEncodingMiddleware = (opts)=>{
+/*
+ * `zstd` disabled due to lack of support in browsers
+ * https://github.com/Fyrd/caniuse/issues/4065
+ * https://github.com/andrew-aladev/brotli-vs-zstd
+ */ const httpContentEncodingMiddleware = (opts)=>{
     const options = {
         ...defaults,
         ...opts
@@ -20,7 +25,8 @@ const httpContentEncodingMiddleware = (opts)=>{
     const supportedContentEncodings = Object.keys(contentEncodingStreams);
     const httpContentEncodingMiddlewareAfter = async (request)=>{
         normalizeHttpResponse(request);
-        const { event: { preferredEncoding , preferredEncodings  } , response  } = request;
+        const { context: { preferredEncoding, preferredEncodings }, response } = request;
+        // Encoding not supported OR already encoded
         if (response.isBase64Encoded || !preferredEncoding || !supportedContentEncodings.includes(preferredEncoding) || !response.body) {
             return;
         }
@@ -32,12 +38,20 @@ const httpContentEncodingMiddleware = (opts)=>{
             contentEncoding = encoding;
             break;
         }
+        // Support streamifyResponse
+        if (response.body?._readableState) {
+            request.response.headers['Content-Encoding'] = contentEncoding;
+            request.response.body.pipe(contentEncodingStream);
+            return;
+        }
         const stream = Readable.from(response.body).pipe(contentEncodingStream);
         const chunks = [];
         for await (const chunk of stream){
             chunks.push(chunk);
         }
+        // TODO update to btoa if faster
         const body = Buffer.concat(chunks).toString('base64');
+        // Only apply encoding if it's smaller
         if (body.length < response.body.length) {
             response.headers['Content-Encoding'] = contentEncoding;
             response.body = body;
@@ -47,7 +61,7 @@ const httpContentEncodingMiddleware = (opts)=>{
     };
     const httpContentEncodingMiddlewareOnError = async (request)=>{
         if (typeof request.response === 'undefined') return;
-        return httpContentEncodingMiddlewareAfter(request);
+        httpContentEncodingMiddlewareAfter(request);
     };
     return {
         after: httpContentEncodingMiddlewareAfter,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-content-encoding",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.2",
   "description": "Http content encoding middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -69,10 +63,10 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0"
+    "@middy/util": "5.0.0-alpha.2"
   },
   "devDependencies": {
-    "@middy/core": "5.0.0-alpha.0"
+    "@middy/core": "5.0.0-alpha.2"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _nodeStream = require("node:stream");
-const _nodeZlib = require("node:zlib");
-const _util = require("@middy/util");
-const contentEncodingStreams = {
-    br: _nodeZlib.createBrotliCompress,
-    gzip: _nodeZlib.createGzip,
-    deflate: _nodeZlib.createDeflate
-};
-const defaults = {
-    br: undefined,
-    gzip: undefined,
-    deflate: undefined,
-    overridePreferredEncoding: []
-};
-const httpContentEncodingMiddleware = (opts)=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const supportedContentEncodings = Object.keys(contentEncodingStreams);
-    const httpContentEncodingMiddlewareAfter = async (request)=>{
-        (0, _util.normalizeHttpResponse)(request);
-        const { event: { preferredEncoding , preferredEncodings  } , response  } = request;
-        if (response.isBase64Encoded || !preferredEncoding || !supportedContentEncodings.includes(preferredEncoding) || !response.body) {
-            return;
-        }
-        let contentEncodingStream = contentEncodingStreams[preferredEncoding](options[preferredEncoding]);
-        let contentEncoding = preferredEncoding;
-        for (const encoding of options.overridePreferredEncoding){
-            if (!preferredEncodings.includes(encoding)) continue;
-            contentEncodingStream = contentEncodingStreams[encoding](options[encoding]);
-            contentEncoding = encoding;
-            break;
-        }
-        const stream = _nodeStream.Readable.from(response.body).pipe(contentEncodingStream);
-        const chunks = [];
-        for await (const chunk of stream){
-            chunks.push(chunk);
-        }
-        const body = Buffer.concat(chunks).toString('base64');
-        if (body.length < response.body.length) {
-            response.headers['Content-Encoding'] = contentEncoding;
-            response.body = body;
-            response.isBase64Encoded = true;
-        }
-        request.response = response;
-    };
-    const httpContentEncodingMiddlewareOnError = async (request)=>{
-        if (typeof request.response === 'undefined') return;
-        return httpContentEncodingMiddlewareAfter(request);
-    };
-    return {
-        after: httpContentEncodingMiddlewareAfter,
-        onError: httpContentEncodingMiddlewareOnError
-    };
-};
-const _default = httpContentEncodingMiddleware;
-