@faasjs/http 7.1.0 → 8.0.0-beta.1

package/README.md

@@ -1,5 +1,16 @@
 # @faasjs/http
 
+FaasJS's http plugin.
+
+[![License: MIT](https://img.shields.io/npm/l/@faasjs/http.svg)](https://github.com/faasjs/faasjs/blob/main/packages/http/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@faasjs/http.svg)](https://www.npmjs.com/package/@faasjs/http)
+
+## Install
+
+```sh
+npm install @faasjs/http
+```
+
 ## Functions
 
 - [useHttp](functions/useHttp.md)

package/dist/index.cjs

@@ -207,7 +207,7 @@ function deepClone(obj) {
   if (Array.isArray(obj)) return JSON.parse(JSON.stringify(obj));
   const clone = {};
   for (const key in obj) {
-    if (!obj.hasOwnProperty(key)) continue;
+    if (!Object.hasOwn(obj, key)) continue;
     if (typeof obj[key] === "function") {
       clone[key] = obj[key];
       continue;
@@ -216,6 +216,30 @@ function deepClone(obj) {
   }
   return clone;
 }
+function createCompressedStream(body, encoding) {
+  const compressStream = encoding === "br" ? zlib.createBrotliCompress() : encoding === "gzip" ? zlib.createGzip() : zlib.createDeflate();
+  return new ReadableStream({
+    async start(controller) {
+      try {
+        const compressed = await new Promise((resolve, reject) => {
+          const chunks = [];
+          compressStream.on("data", (chunk) => chunks.push(chunk));
+          compressStream.on("end", () => resolve(Buffer.concat(chunks)));
+          compressStream.on("error", reject);
+          compressStream.write(Buffer.from(body));
+          compressStream.end();
+        });
+        const chunkSize = 16 * 1024;
+        for (let i = 0; i < compressed.length; i += chunkSize) {
+          controller.enqueue(compressed.subarray(i, i + chunkSize));
+        }
+        controller.close();
+      } catch (error) {
+        controller.error(error);
+      }
+    }
+  });
+}
 var Http = class {
   type = "http";
   name = Name;
@@ -315,12 +339,14 @@ var Http = class {
         }
       } else if (Object.prototype.toString.call(data.response) === "[object Object]" && data.response.statusCode && data.response.headers)
         this.response = data.response;
+      else if (data.response instanceof ReadableStream)
+        this.response.body = data.response;
       else this.response.body = JSON.stringify({ data: data.response });
     if (!this.response.statusCode)
       this.response.statusCode = this.response.body ? 200 : 201;
     this.response.headers = Object.assign(
       {
-        "content-type": "application/json; charset=utf-8",
+        "content-type": this.response.body instanceof ReadableStream ? "text/plain; charset=utf-8" : "application/json; charset=utf-8",
         "cache-control": "no-cache, no-store",
         "x-faasjs-request-id": data.context.request_id
       },
@@ -330,26 +356,22 @@ var Http = class {
     data.response = Object.assign({}, data.response, this.response);
     const originBody = data.response.body;
     data.response.originBody = originBody;
-    if (originBody && !data.response.isBase64Encoded && typeof originBody !== "string")
+    if (data.response.body instanceof ReadableStream) {
+      data.response.isBase64Encoded = true;
+      return;
+    }
+    if (originBody && typeof originBody !== "string")
       data.response.body = JSON.stringify(originBody);
-    if (!data.response.body || data.response.isBase64Encoded || typeof data.response.body !== "string" || data.response.body.length < 1024)
+    if (!data.response.body || typeof data.response.body !== "string" || data.response.body.length < 1024)
       return;
     const acceptEncoding = this.headers["accept-encoding"] || this.headers["Accept-Encoding"];
     if (!acceptEncoding || !/(br|gzip|deflate)/.test(acceptEncoding)) return;
     try {
-      if (acceptEncoding.includes("br")) {
-        data.response.headers["Content-Encoding"] = "br";
-        data.response.body = zlib.brotliCompressSync(originBody).toString("base64");
-      } else if (acceptEncoding.includes("gzip")) {
-        data.response.headers["Content-Encoding"] = "gzip";
-        data.response.body = zlib.gzipSync(originBody).toString("base64");
-      } else if (acceptEncoding.includes("deflate")) {
-        data.response.headers["Content-Encoding"] = "deflate";
-        data.response.body = zlib.deflateSync(originBody).toString("base64");
-      } else throw Error("No matched compression.");
-      data.response.isBase64Encoded = true;
+      const encoding = acceptEncoding.includes("br") ? "br" : acceptEncoding.includes("gzip") ? "gzip" : "deflate";
+      data.response.headers["Content-Encoding"] = encoding;
+      data.response.body = createCompressedStream(originBody, encoding);
     } catch (error) {
-      console.error(error);
+      data.logger.error("Compression failed: %s", error.message);
       data.response.body = originBody;
       delete data.response.headers["Content-Encoding"];
     }

package/dist/index.d.ts

@@ -103,7 +103,7 @@ type Response = {
     headers?: {
         [key: string]: string;
     };
-    body?: string;
+    body?: string | ReadableStream;
     message?: string;
 };
 declare class HttpError extends Error {

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { brotliCompressSync, gzipSync, deflateSync } from 'zlib';
+import { createBrotliCompress, createGzip, createDeflate } from 'zlib';
 import { deepMerge } from '@faasjs/deep_merge';
 import { usePlugin, useFunc } from '@faasjs/func';
 import { randomBytes, pbkdf2Sync, createCipheriv, createHmac, createDecipheriv } from 'crypto';
@@ -205,7 +205,7 @@ function deepClone(obj) {
   if (Array.isArray(obj)) return JSON.parse(JSON.stringify(obj));
   const clone = {};
   for (const key in obj) {
-    if (!obj.hasOwnProperty(key)) continue;
+    if (!Object.hasOwn(obj, key)) continue;
     if (typeof obj[key] === "function") {
       clone[key] = obj[key];
       continue;
@@ -214,6 +214,30 @@ function deepClone(obj) {
   }
   return clone;
 }
+function createCompressedStream(body, encoding) {
+  const compressStream = encoding === "br" ? createBrotliCompress() : encoding === "gzip" ? createGzip() : createDeflate();
+  return new ReadableStream({
+    async start(controller) {
+      try {
+        const compressed = await new Promise((resolve, reject) => {
+          const chunks = [];
+          compressStream.on("data", (chunk) => chunks.push(chunk));
+          compressStream.on("end", () => resolve(Buffer.concat(chunks)));
+          compressStream.on("error", reject);
+          compressStream.write(Buffer.from(body));
+          compressStream.end();
+        });
+        const chunkSize = 16 * 1024;
+        for (let i = 0; i < compressed.length; i += chunkSize) {
+          controller.enqueue(compressed.subarray(i, i + chunkSize));
+        }
+        controller.close();
+      } catch (error) {
+        controller.error(error);
+      }
+    }
+  });
+}
 var Http = class {
   type = "http";
   name = Name;
@@ -313,12 +337,14 @@ var Http = class {
         }
       } else if (Object.prototype.toString.call(data.response) === "[object Object]" && data.response.statusCode && data.response.headers)
         this.response = data.response;
+      else if (data.response instanceof ReadableStream)
+        this.response.body = data.response;
       else this.response.body = JSON.stringify({ data: data.response });
     if (!this.response.statusCode)
       this.response.statusCode = this.response.body ? 200 : 201;
     this.response.headers = Object.assign(
       {
-        "content-type": "application/json; charset=utf-8",
+        "content-type": this.response.body instanceof ReadableStream ? "text/plain; charset=utf-8" : "application/json; charset=utf-8",
         "cache-control": "no-cache, no-store",
         "x-faasjs-request-id": data.context.request_id
       },
@@ -328,26 +354,22 @@ var Http = class {
     data.response = Object.assign({}, data.response, this.response);
     const originBody = data.response.body;
     data.response.originBody = originBody;
-    if (originBody && !data.response.isBase64Encoded && typeof originBody !== "string")
+    if (data.response.body instanceof ReadableStream) {
+      data.response.isBase64Encoded = true;
+      return;
+    }
+    if (originBody && typeof originBody !== "string")
       data.response.body = JSON.stringify(originBody);
-    if (!data.response.body || data.response.isBase64Encoded || typeof data.response.body !== "string" || data.response.body.length < 1024)
+    if (!data.response.body || typeof data.response.body !== "string" || data.response.body.length < 1024)
       return;
     const acceptEncoding = this.headers["accept-encoding"] || this.headers["Accept-Encoding"];
     if (!acceptEncoding || !/(br|gzip|deflate)/.test(acceptEncoding)) return;
     try {
-      if (acceptEncoding.includes("br")) {
-        data.response.headers["Content-Encoding"] = "br";
-        data.response.body = brotliCompressSync(originBody).toString("base64");
-      } else if (acceptEncoding.includes("gzip")) {
-        data.response.headers["Content-Encoding"] = "gzip";
-        data.response.body = gzipSync(originBody).toString("base64");
-      } else if (acceptEncoding.includes("deflate")) {
-        data.response.headers["Content-Encoding"] = "deflate";
-        data.response.body = deflateSync(originBody).toString("base64");
-      } else throw Error("No matched compression.");
-      data.response.isBase64Encoded = true;
+      const encoding = acceptEncoding.includes("br") ? "br" : acceptEncoding.includes("gzip") ? "gzip" : "deflate";
+      data.response.headers["Content-Encoding"] = encoding;
+      data.response.body = createCompressedStream(originBody, encoding);
     } catch (error) {
-      console.error(error);
+      data.logger.error("Compression failed: %s", error.message);
       data.response.body = originBody;
       delete data.response.headers["Content-Encoding"];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/http",
-  "version": "7.1.0",
+  "version": "v8.0.0-beta.1",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.cjs",
@@ -30,12 +30,12 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/func": ">=7.1.0",
-    "@faasjs/logger": ">=7.1.0"
+    "@faasjs/func": ">=v8.0.0-beta.1",
+    "@faasjs/logger": ">=v8.0.0-beta.1"
   },
   "devDependencies": {
-    "@faasjs/func": ">=7.1.0",
-    "@faasjs/logger": ">=7.1.0"
+    "@faasjs/func": ">=v8.0.0-beta.1",
+    "@faasjs/logger": ">=v8.0.0-beta.1"
   },
   "engines": {
     "node": ">=24.0.0",