@faasjs/request 0.0.4-beta.9 → 0.0.5-beta.1

package/README.md

@@ -12,6 +12,10 @@ FaasJS's request module.
 
 ## Modules
 
+### Classes
+
+- [ResponseError](classes/ResponseError.md)
+
 ### Type Aliases
 
 - [Request](#request)
@@ -34,7 +38,7 @@ FaasJS's request module.
 
 | Name | Type |
 | :------ | :------ |
-| `body?` | { `[key: string]`: `any`;  } |
+| `body?` | \{ `[key: string]`: `any`;  } |
 | `headers?` | `http.OutgoingHttpHeaders` |
 | `host?` | `string` |
 | `method?` | `string` |
@@ -53,7 +57,7 @@ ___
 | :------ | :------ | :------ |
 | `agent?` | `boolean` | - |
 | `auth?` | `string` | The authentication credentials to use for the request. Format: `username:password` |
-| `body?` | { `[key: string]`: `any`;  } \| `string` | - |
+| `body?` | \{ `[key: string]`: `any`;  } \| `string` | - |
 | `downloadFile?` | `string` | Path of downloading a file from the server. ```ts await request('https://example.com', { downloadFile: 'filepath' }) ``` |
 | `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. ```ts import { createWriteStream } from 'fs' const stream = createWriteStream('filepath') await request('https://example.com', { downloadStream: stream }) ``` |
 | `file?` | `string` | Path of uploading a file to the server. ```ts await request('https://example.com', { file: 'filepath' }) ``` |
@@ -63,14 +67,14 @@ ___
 | `parse?` | (`body`: `string`) => `any` | Body parser. Defaults to `JSON.parse`. |
 | `passphrase?` | `string` | - |
 | `pfx?` | `Buffer` | - |
-| `query?` | { `[key: string]`: `any`;  } | - |
+| `query?` | \{ `[key: string]`: `any`;  } | - |
 | `timeout?` | `number` | - |
 
 ___
 
 ### Response
 
-Ƭ **Response**<`T`\>: `Object`
+Ƭ **Response**\<`T`\>: `Object`
 
 #### Type parameters
 
@@ -108,7 +112,7 @@ ___
 
 ### request
 
-▸ **request**<`T`\>(`url`, `options?`): `Promise`<[`Response`](#response)<`T`\>\>
+▸ **request**\<`T`\>(`url`, `options?`): `Promise`\<[`Response`](#response)\<`T`\>\>
 
 Request
 
@@ -127,7 +131,7 @@ Request
 
 #### Returns
 
-`Promise`<[`Response`](#response)<`T`\>\>
+`Promise`\<[`Response`](#response)\<`T`\>\>
 
 **`Url`**
 

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import * as http from 'http';
+import * as http from 'node:http';
 import { Logger } from '@faasjs/logger';
 
 type Request = {
@@ -81,8 +81,21 @@ type Mock = (url: string, options: RequestOptions) => Promise<Response>;
  */
 declare function setMock(handler: Mock | null): void;
 declare function querystringify(obj: any): string;
+/**
+ * ResponseError class
+ */
+declare class ResponseError extends Error {
+    response: Response;
+    request: Request;
+    statusCode: number;
+    statusMessage: string;
+    headers: http.OutgoingHttpHeaders;
+    body: any;
+    constructor(message: string, response: Response<any>);
+}
 /**
  * Request
+ *
  * @param {string} url Url
  * @param {object=} [options={}] Options
  * @param {string} [options.method=GET] Method
@@ -100,8 +113,9 @@ declare function querystringify(obj: any): string;
  * @param {parse=} options.parse body parser, default is JSON.parse
  *
  * @returns {promise}
+ *
  * @url https://faasjs.com/doc/request.html
  */
 declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
 
-export { Request, RequestOptions, Response, querystringify, request, setMock };
+export { type Request, type RequestOptions, type Response, ResponseError, querystringify, request, setMock };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as http from 'http';
+import * as http from 'node:http';
 import { Logger } from '@faasjs/logger';
 
 type Request = {
@@ -81,8 +81,21 @@ type Mock = (url: string, options: RequestOptions) => Promise<Response>;
  */
 declare function setMock(handler: Mock | null): void;
 declare function querystringify(obj: any): string;
+/**
+ * ResponseError class
+ */
+declare class ResponseError extends Error {
+    response: Response;
+    request: Request;
+    statusCode: number;
+    statusMessage: string;
+    headers: http.OutgoingHttpHeaders;
+    body: any;
+    constructor(message: string, response: Response<any>);
+}
 /**
  * Request
+ *
  * @param {string} url Url
  * @param {object=} [options={}] Options
  * @param {string} [options.method=GET] Method
@@ -100,8 +113,9 @@ declare function querystringify(obj: any): string;
  * @param {parse=} options.parse body parser, default is JSON.parse
  *
  * @returns {promise}
+ *
  * @url https://faasjs.com/doc/request.html
  */
 declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
 
-export { Request, RequestOptions, Response, querystringify, request, setMock };
+export { type Request, type RequestOptions, type Response, ResponseError, querystringify, request, setMock };

package/dist/index.js

@@ -6,6 +6,8 @@ var url = require('url');
 var fs = require('fs');
 var path = require('path');
 var logger = require('@faasjs/logger');
+var zlib = require('zlib');
+var crypto = require('crypto');
 
 function _interopNamespace(e) {
   if (e && e.__esModule) return e;
@@ -52,6 +54,17 @@ function querystringify(obj) {
   }
   return pairs.length ? pairs.join("&") : "";
 }
+var ResponseError = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+    this.request = response.request;
+    this.statusCode = response.statusCode;
+    this.statusMessage = response.statusMessage;
+    this.headers = response.headers;
+    this.body = response.body;
+  }
+};
 async function request(url$1, {
   headers,
   method,
@@ -108,6 +121,9 @@ async function request(url$1, {
     passphrase,
     agent
   };
+  if (!options.headers["Accept-Encoding"] && !downloadFile && !downloadStream) {
+    options.headers["Accept-Encoding"] = "br,gzip";
+  }
   for (const key in headers)
     if (typeof headers[key] !== "undefined" && headers[key] !== null)
       options.headers[key] = headers[key];
@@ -118,57 +134,101 @@ async function request(url$1, {
       body = JSON.stringify(body);
   if (body && !options.headers["Content-Length"])
     options.headers["Content-Length"] = Buffer.byteLength(body);
-  return await new Promise(function(resolve, reject) {
+  const requestId = crypto.randomUUID();
+  return await new Promise((resolve, reject) => {
     logger$1.debug("request %j", {
       ...options,
       body
     });
-    const req = protocol.request(options, function(res) {
+    const req = protocol.request(options, (res) => {
       if (downloadStream) {
-        res.pipe(downloadStream);
-        downloadStream.on("finish", () => resolve(void 0));
-      } else if (downloadFile) {
-        const stream = fs.createWriteStream(downloadFile);
-        res.pipe(stream);
-        stream.on("finish", () => resolve(void 0));
-      } else {
-        const raw = [];
-        res.on("data", (chunk) => {
-          raw.push(chunk);
+        res.pipe(downloadStream, { end: true });
+        downloadStream.on("finish", () => {
+          res.destroy();
+          downloadStream.end();
+          resolve(void 0);
         });
+        return;
+      }
+      if (downloadFile) {
+        logger$1.debug("downloadFile");
+        const stream2 = fs.createWriteStream(downloadFile, { autoClose: true });
+        res.pipe(stream2, { end: true });
         res.on("end", () => {
-          const data = Buffer.concat(raw).toString();
-          logger$1.timeEnd(
-            url$1,
-            "response %s %s %s",
-            res.statusCode,
-            res.headers["content-type"],
-            data
+          logger$1.debug("end");
+          res.destroy();
+        });
+        stream2.on("finish", () => {
+          stream2.end();
+          stream2.close();
+          logger$1.debug("finish");
+        });
+        stream2.on("close", () => {
+          logger$1.debug(
+            "finish",
+            res.closed,
+            res.destroyed,
+            stream2.destroyed,
+            stream2.closed,
+            req.closed,
+            req.destroyed
           );
-          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
-          response.request = options;
-          response.request.body = body;
-          response.statusCode = res.statusCode;
-          response.statusMessage = res.statusMessage;
-          response.headers = res.headers;
-          response.body = data;
-          if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
-            try {
-              response.body = (parse || JSON.parse)(response.body);
-              logger$1.debug("response.parse JSON");
-            } catch (error) {
-              console.warn("response plain body", response.body);
-              console.error(error);
-            }
-          if (response.statusCode >= 200 && response.statusCode < 400)
-            resolve(response);
-          else {
-            logger$1.debug("response.error %j", response);
-            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
-            reject(response);
-          }
+          resolve(void 0);
         });
+        return;
+      }
+      let stream = res;
+      switch (res.headers["content-encoding"]) {
+        case "br":
+          stream = res.pipe(zlib.createBrotliDecompress());
+          break;
+        case "gzip":
+          stream = res.pipe(zlib.createGunzip());
+          break;
       }
+      const raw = [];
+      stream.on("data", (chunk) => raw.push(chunk));
+      stream.on("end", () => {
+        const data = Buffer.concat(raw).toString();
+        logger$1.timeEnd(
+          requestId,
+          "response %s %s %s %j",
+          res.statusCode,
+          res.headers["content-type"],
+          res.headers["content-encoding"],
+          data
+        );
+        const response = /* @__PURE__ */ Object.create(null);
+        response.request = options;
+        response.request.body = body;
+        response.statusCode = res.statusCode;
+        response.statusMessage = res.statusMessage;
+        response.headers = res.headers;
+        response.body = data;
+        if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
+          try {
+            response.body = (parse || JSON.parse)(response.body);
+            logger$1.debug("response.parse JSON");
+          } catch (error) {
+            console.warn("response plain body", response.body);
+            console.error(error);
+          }
+        if (response.statusCode >= 200 && response.statusCode < 400)
+          resolve(response);
+        else {
+          logger$1.debug("response.error %j", response);
+          reject(
+            new ResponseError(
+              `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
+              response
+            )
+          );
+        }
+      });
+      stream.on("error", (e) => {
+        logger$1.timeEnd(requestId, "response.error %j", e);
+        reject(e);
+      });
     });
     if (body)
       req.write(body);
@@ -190,15 +250,21 @@ async function request(url$1, {
       req.setHeader("Content-Length", multipartBody.length);
       req.write(multipartBody);
     }
-    req.on("error", function(e) {
-      logger$1.timeEnd(url$1, "response.error %j", e);
+    req.on("error", (e) => {
+      logger$1.timeEnd(requestId, "response.error %j", e);
       reject(e);
     });
-    logger$1.time(url$1);
+    req.on("timeout", () => {
+      logger$1.timeEnd(requestId, "response.timeout");
+      req.destroy();
+      reject(Error(`Timeout ${url$1}`));
+    });
+    logger$1.time(requestId);
     req.end();
   });
 }
 
+exports.ResponseError = ResponseError;
 exports.querystringify = querystringify;
 exports.request = request;
 exports.setMock = setMock;

package/dist/index.mjs

@@ -1,9 +1,11 @@
-import * as http from 'http';
-import * as https from 'https';
-import { URL } from 'url';
-import { createWriteStream, readFileSync } from 'fs';
-import { basename } from 'path';
+import * as http from 'node:http';
+import * as https from 'node:https';
+import { URL } from 'node:url';
+import { createWriteStream, readFileSync } from 'node:fs';
+import { basename } from 'node:path';
 import { Logger } from '@faasjs/logger';
+import { createGunzip, createBrotliDecompress } from 'node:zlib';
+import { randomUUID } from 'node:crypto';
 
 // src/index.ts
 var mock = null;
@@ -29,6 +31,17 @@ function querystringify(obj) {
   }
   return pairs.length ? pairs.join("&") : "";
 }
+var ResponseError = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+    this.request = response.request;
+    this.statusCode = response.statusCode;
+    this.statusMessage = response.statusMessage;
+    this.headers = response.headers;
+    this.body = response.body;
+  }
+};
 async function request(url, {
   headers,
   method,
@@ -85,6 +98,9 @@ async function request(url, {
     passphrase,
     agent
   };
+  if (!options.headers["Accept-Encoding"] && !downloadFile && !downloadStream) {
+    options.headers["Accept-Encoding"] = "br,gzip";
+  }
   for (const key in headers)
     if (typeof headers[key] !== "undefined" && headers[key] !== null)
       options.headers[key] = headers[key];
@@ -95,57 +111,101 @@ async function request(url, {
       body = JSON.stringify(body);
   if (body && !options.headers["Content-Length"])
     options.headers["Content-Length"] = Buffer.byteLength(body);
-  return await new Promise(function(resolve, reject) {
+  const requestId = randomUUID();
+  return await new Promise((resolve, reject) => {
     logger.debug("request %j", {
       ...options,
       body
     });
-    const req = protocol.request(options, function(res) {
+    const req = protocol.request(options, (res) => {
       if (downloadStream) {
-        res.pipe(downloadStream);
-        downloadStream.on("finish", () => resolve(void 0));
-      } else if (downloadFile) {
-        const stream = createWriteStream(downloadFile);
-        res.pipe(stream);
-        stream.on("finish", () => resolve(void 0));
-      } else {
-        const raw = [];
-        res.on("data", (chunk) => {
-          raw.push(chunk);
+        res.pipe(downloadStream, { end: true });
+        downloadStream.on("finish", () => {
+          res.destroy();
+          downloadStream.end();
+          resolve(void 0);
         });
+        return;
+      }
+      if (downloadFile) {
+        logger.debug("downloadFile");
+        const stream2 = createWriteStream(downloadFile, { autoClose: true });
+        res.pipe(stream2, { end: true });
         res.on("end", () => {
-          const data = Buffer.concat(raw).toString();
-          logger.timeEnd(
-            url,
-            "response %s %s %s",
-            res.statusCode,
-            res.headers["content-type"],
-            data
+          logger.debug("end");
+          res.destroy();
+        });
+        stream2.on("finish", () => {
+          stream2.end();
+          stream2.close();
+          logger.debug("finish");
+        });
+        stream2.on("close", () => {
+          logger.debug(
+            "finish",
+            res.closed,
+            res.destroyed,
+            stream2.destroyed,
+            stream2.closed,
+            req.closed,
+            req.destroyed
           );
-          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
-          response.request = options;
-          response.request.body = body;
-          response.statusCode = res.statusCode;
-          response.statusMessage = res.statusMessage;
-          response.headers = res.headers;
-          response.body = data;
-          if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
-            try {
-              response.body = (parse || JSON.parse)(response.body);
-              logger.debug("response.parse JSON");
-            } catch (error) {
-              console.warn("response plain body", response.body);
-              console.error(error);
-            }
-          if (response.statusCode >= 200 && response.statusCode < 400)
-            resolve(response);
-          else {
-            logger.debug("response.error %j", response);
-            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
-            reject(response);
-          }
+          resolve(void 0);
         });
+        return;
+      }
+      let stream = res;
+      switch (res.headers["content-encoding"]) {
+        case "br":
+          stream = res.pipe(createBrotliDecompress());
+          break;
+        case "gzip":
+          stream = res.pipe(createGunzip());
+          break;
       }
+      const raw = [];
+      stream.on("data", (chunk) => raw.push(chunk));
+      stream.on("end", () => {
+        const data = Buffer.concat(raw).toString();
+        logger.timeEnd(
+          requestId,
+          "response %s %s %s %j",
+          res.statusCode,
+          res.headers["content-type"],
+          res.headers["content-encoding"],
+          data
+        );
+        const response = /* @__PURE__ */ Object.create(null);
+        response.request = options;
+        response.request.body = body;
+        response.statusCode = res.statusCode;
+        response.statusMessage = res.statusMessage;
+        response.headers = res.headers;
+        response.body = data;
+        if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
+          try {
+            response.body = (parse || JSON.parse)(response.body);
+            logger.debug("response.parse JSON");
+          } catch (error) {
+            console.warn("response plain body", response.body);
+            console.error(error);
+          }
+        if (response.statusCode >= 200 && response.statusCode < 400)
+          resolve(response);
+        else {
+          logger.debug("response.error %j", response);
+          reject(
+            new ResponseError(
+              `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
+              response
+            )
+          );
+        }
+      });
+      stream.on("error", (e) => {
+        logger.timeEnd(requestId, "response.error %j", e);
+        reject(e);
+      });
     });
     if (body)
       req.write(body);
@@ -167,13 +227,18 @@ async function request(url, {
       req.setHeader("Content-Length", multipartBody.length);
       req.write(multipartBody);
     }
-    req.on("error", function(e) {
-      logger.timeEnd(url, "response.error %j", e);
+    req.on("error", (e) => {
+      logger.timeEnd(requestId, "response.error %j", e);
       reject(e);
     });
-    logger.time(url);
+    req.on("timeout", () => {
+      logger.timeEnd(requestId, "response.timeout");
+      req.destroy();
+      reject(Error(`Timeout ${url}`));
+    });
+    logger.time(requestId);
     req.end();
   });
 }
 
-export { querystringify, request, setMock };
+export { ResponseError, querystringify, request, setMock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.4-beta.9",
+  "version": "0.0.5-beta.1",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,10 +21,10 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/logger": "0.0.4-beta.9"
+    "@faasjs/logger": "0.0.5-beta.1"
   },
   "devDependencies": {
-    "@faasjs/logger": "0.0.4-beta.9"
+    "@faasjs/logger": "0.0.5-beta.1"
   },
   "engines": {
     "npm": ">=9.0.0",