fetch-har 8.1.3 → 8.1.5

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,63 @@
+## <small>8.1.5 (2023-01-23)</small>
+
+* fix: support urls with hashes that also have query params (#363) ([7a51342](https://github.com/readmeio/fetch-har/commit/7a51342)), closes [#363](https://github.com/readmeio/fetch-har/issues/363)
+* chore(deps-dev): bumping deps (#362) ([3279246](https://github.com/readmeio/fetch-har/commit/3279246)), closes [#362](https://github.com/readmeio/fetch-har/issues/362)
+
+
+
+## <small>8.1.4 (2023-01-03)</small>
+
+* chore(deps-dev): bump @readme/eslint-config from 10.1.0 to 10.1.1 (#331) ([75de615](https://github.com/readmeio/fetch-har/commit/75de615)), closes [#331](https://github.com/readmeio/fetch-har/issues/331)
+* chore(deps-dev): bump @readme/eslint-config from 10.1.1 to 10.2.0 (#345) ([b791ce3](https://github.com/readmeio/fetch-har/commit/b791ce3)), closes [#345](https://github.com/readmeio/fetch-har/issues/345)
+* chore(deps-dev): bump @readme/eslint-config from 9.0.0 to 10.1.0 (#312) ([27b53b8](https://github.com/readmeio/fetch-har/commit/27b53b8)), closes [#312](https://github.com/readmeio/fetch-har/issues/312)
+* chore(deps-dev): bump @types/chai from 4.3.1 to 4.3.3 (#313) ([cfc65d0](https://github.com/readmeio/fetch-har/commit/cfc65d0)), closes [#313](https://github.com/readmeio/fetch-har/issues/313)
+* chore(deps-dev): bump @types/express from 4.17.13 to 4.17.14 (#323) ([1fec46d](https://github.com/readmeio/fetch-har/commit/1fec46d)), closes [#323](https://github.com/readmeio/fetch-har/issues/323)
+* chore(deps-dev): bump @types/mocha from 10.0.0 to 10.0.1 (#344) ([75d4db7](https://github.com/readmeio/fetch-har/commit/75d4db7)), closes [#344](https://github.com/readmeio/fetch-har/issues/344)
+* chore(deps-dev): bump @types/mocha from 9.1.1 to 10.0.0 (#326) ([36c4b00](https://github.com/readmeio/fetch-har/commit/36c4b00)), closes [#326](https://github.com/readmeio/fetch-har/issues/326)
+* chore(deps-dev): bump @types/node from 18.11.8 to 18.11.10 (#349) ([6479fbf](https://github.com/readmeio/fetch-har/commit/6479fbf)), closes [#349](https://github.com/readmeio/fetch-har/issues/349)
+* chore(deps-dev): bump @types/node from 18.6.1 to 18.6.3 (#309) ([4cce975](https://github.com/readmeio/fetch-har/commit/4cce975)), closes [#309](https://github.com/readmeio/fetch-har/issues/309)
+* chore(deps-dev): bump @types/node from 18.6.3 to 18.7.14 (#315) ([69679ac](https://github.com/readmeio/fetch-har/commit/69679ac)), closes [#315](https://github.com/readmeio/fetch-har/issues/315)
+* chore(deps-dev): bump @types/node from 18.7.14 to 18.7.23 (#324) ([8c0c037](https://github.com/readmeio/fetch-har/commit/8c0c037)), closes [#324](https://github.com/readmeio/fetch-har/issues/324)
+* chore(deps-dev): bump @types/node from 18.7.23 to 18.8.0 (#330) ([0174e1d](https://github.com/readmeio/fetch-har/commit/0174e1d)), closes [#330](https://github.com/readmeio/fetch-har/issues/330)
+* chore(deps-dev): bump @types/node from 18.8.0 to 18.11.8 (#335) ([5a602b3](https://github.com/readmeio/fetch-har/commit/5a602b3)), closes [#335](https://github.com/readmeio/fetch-har/issues/335)
+* chore(deps-dev): bump chai from 4.3.6 to 4.3.7 (#348) ([b427f19](https://github.com/readmeio/fetch-har/commit/b427f19)), closes [#348](https://github.com/readmeio/fetch-har/issues/348)
+* chore(deps-dev): bump eslint from 8.20.0 to 8.23.0 (#318) ([5d6293b](https://github.com/readmeio/fetch-har/commit/5d6293b)), closes [#318](https://github.com/readmeio/fetch-har/issues/318)
+* chore(deps-dev): bump eslint from 8.23.0 to 8.24.0 (#325) ([033eeec](https://github.com/readmeio/fetch-har/commit/033eeec)), closes [#325](https://github.com/readmeio/fetch-har/issues/325)
+* chore(deps-dev): bump eslint from 8.24.0 to 8.26.0 (#339) ([8806ab8](https://github.com/readmeio/fetch-har/commit/8806ab8)), closes [#339](https://github.com/readmeio/fetch-har/issues/339)
+* chore(deps-dev): bump eslint from 8.26.0 to 8.28.0 (#350) ([3440e1c](https://github.com/readmeio/fetch-har/commit/3440e1c)), closes [#350](https://github.com/readmeio/fetch-har/issues/350)
+* chore(deps-dev): bump express from 4.18.1 to 4.18.2 (#338) ([acdc8ac](https://github.com/readmeio/fetch-har/commit/acdc8ac)), closes [#338](https://github.com/readmeio/fetch-har/issues/338)
+* chore(deps-dev): bump mocha from 10.0.0 to 10.1.0 (#336) ([9e91790](https://github.com/readmeio/fetch-har/commit/9e91790)), closes [#336](https://github.com/readmeio/fetch-har/issues/336)
+* chore(deps-dev): bump prettier from 2.7.1 to 2.8.0 (#347) ([22ce3c9](https://github.com/readmeio/fetch-har/commit/22ce3c9)), closes [#347](https://github.com/readmeio/fetch-har/issues/347)
+* chore(deps-dev): bump typescript from 4.7.4 to 4.8.2 (#316) ([a5819c1](https://github.com/readmeio/fetch-har/commit/a5819c1)), closes [#316](https://github.com/readmeio/fetch-har/issues/316)
+* chore(deps-dev): bump typescript from 4.8.2 to 4.8.4 (#327) ([2e1fdf1](https://github.com/readmeio/fetch-har/commit/2e1fdf1)), closes [#327](https://github.com/readmeio/fetch-har/issues/327)
+* chore(deps-dev): bump typescript from 4.8.4 to 4.9.3 (#346) ([afa6122](https://github.com/readmeio/fetch-har/commit/afa6122)), closes [#346](https://github.com/readmeio/fetch-har/issues/346)
+* chore(deps-dev): bump undici from 5.10.0 to 5.11.0 (#332) ([a020b27](https://github.com/readmeio/fetch-har/commit/a020b27)), closes [#332](https://github.com/readmeio/fetch-har/issues/332)
+* chore(deps-dev): bump undici from 5.11.0 to 5.12.0 (#337) ([e4e3daf](https://github.com/readmeio/fetch-har/commit/e4e3daf)), closes [#337](https://github.com/readmeio/fetch-har/issues/337)
+* chore(deps-dev): bump undici from 5.12.0 to 5.13.0 (#351) ([2f1da07](https://github.com/readmeio/fetch-har/commit/2f1da07)), closes [#351](https://github.com/readmeio/fetch-har/issues/351)
+* chore(deps-dev): bump undici from 5.8.0 to 5.8.2 (#310) ([09a5241](https://github.com/readmeio/fetch-har/commit/09a5241)), closes [#310](https://github.com/readmeio/fetch-har/issues/310)
+* chore(deps-dev): bump undici from 5.8.2 to 5.10.0 (#314) ([ad16183](https://github.com/readmeio/fetch-har/commit/ad16183)), closes [#314](https://github.com/readmeio/fetch-har/issues/314)
+* chore(deps): bump @types/har-format from 1.2.8 to 1.2.9 (#322) ([4746a42](https://github.com/readmeio/fetch-har/commit/4746a42)), closes [#322](https://github.com/readmeio/fetch-har/issues/322)
+* chore(deps): bump @types/har-format from 1.2.9 to 1.2.10 (#352) ([df4506a](https://github.com/readmeio/fetch-har/commit/df4506a)), closes [#352](https://github.com/readmeio/fetch-har/issues/352)
+* chore(deps): bump actions/cache from 3.0.10 to 3.0.11 (#334) ([b4b9a7c](https://github.com/readmeio/fetch-har/commit/b4b9a7c)), closes [#334](https://github.com/readmeio/fetch-har/issues/334)
+* chore(deps): bump actions/cache from 3.0.5 to 3.0.8 (#311) ([011f9d4](https://github.com/readmeio/fetch-har/commit/011f9d4)), closes [#311](https://github.com/readmeio/fetch-har/issues/311)
+* chore(deps): bump actions/cache from 3.0.8 to 3.0.9 (#320) ([441c2a6](https://github.com/readmeio/fetch-har/commit/441c2a6)), closes [#320](https://github.com/readmeio/fetch-har/issues/320)
+* chore(deps): bump actions/cache from 3.0.9 to 3.0.10 (#329) ([0d9bc07](https://github.com/readmeio/fetch-har/commit/0d9bc07)), closes [#329](https://github.com/readmeio/fetch-har/issues/329)
+* chore(deps): bump decode-uri-component from 0.2.0 to 0.2.2 (#353) ([b987538](https://github.com/readmeio/fetch-har/commit/b987538)), closes [#353](https://github.com/readmeio/fetch-har/issues/353)
+* chore(deps): bump engine.io and socket.io (#343) ([5e0451a](https://github.com/readmeio/fetch-har/commit/5e0451a)), closes [#343](https://github.com/readmeio/fetch-har/issues/343)
+* chore(deps): bump formdata-node from 4.3.3 to 4.4.1 (#319) ([31ab620](https://github.com/readmeio/fetch-har/commit/31ab620)), closes [#319](https://github.com/readmeio/fetch-har/issues/319)
+* chore(deps): bump loader-utils from 1.4.0 to 1.4.1 (#340) ([e90b650](https://github.com/readmeio/fetch-har/commit/e90b650)), closes [#340](https://github.com/readmeio/fetch-har/issues/340)
+* chore(deps): bump loader-utils from 1.4.1 to 1.4.2 (#342) ([ca2e6d2](https://github.com/readmeio/fetch-har/commit/ca2e6d2)), closes [#342](https://github.com/readmeio/fetch-har/issues/342)
+* chore(deps): bump socket.io-parser from 4.0.4 to 4.0.5 (#341) ([97cbd5b](https://github.com/readmeio/fetch-har/commit/97cbd5b)), closes [#341](https://github.com/readmeio/fetch-har/issues/341)
+* chore(deps): bumping deps ([6636acd](https://github.com/readmeio/fetch-har/commit/6636acd))
+* ci: formdata-node is esm only now so we cant use it ([b9b0b47](https://github.com/readmeio/fetch-har/commit/b9b0b47))
+* ci: running unit tests on node 19 (#333) ([6f936da](https://github.com/readmeio/fetch-har/commit/6f936da)), closes [#333](https://github.com/readmeio/fetch-har/issues/333)
+* ci: simplifying ci dep caching ([78a5f34](https://github.com/readmeio/fetch-har/commit/78a5f34))
+* ci: stop testing on node 19 until it hits LTS ([864a10b](https://github.com/readmeio/fetch-har/commit/864a10b))
+* ci: temp-dir is esm-only now ([15e96a0](https://github.com/readmeio/fetch-har/commit/15e96a0))
+* ci: timing out browser tests at 5mins ([c53c161](https://github.com/readmeio/fetch-har/commit/c53c161))
+
+
+
 ## <small>8.1.3 (2022-07-29)</small>
 
 * chore: clenaing up some lengthy test comments ([7f797af](https://github.com/readmeio/fetch-har/commit/7f797af))

package/dist/index.d.ts

@@ -1,9 +1,22 @@
 /// <reference types="node" />
 import type { Har } from 'har-format';
-export declare type FetchHAROptions = {
+interface RequestInitWithDuplex extends RequestInit {
+    /**
+     * `RequestInit#duplex` does not yet exist in the TS `lib.dom.d.ts` definition yet the native
+     * fetch implementation in Node 18+, `undici`, requires it for certain POST payloads.
+     *
+     * @see {@link https://github.com/microsoft/TypeScript-DOM-lib-generator/issues/1483}
+     * @see {@link https://github.com/nodejs/node/issues/46221}
+     * @see {@link https://fetch.spec.whatwg.org/#request-class}
+     * @see {@link https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts}
+     */
+    duplex?: 'half';
+}
+export interface FetchHAROptions {
     userAgent?: string;
     files?: Record<string, Blob | Buffer>;
     multipartEncoder?: any;
-    init?: RequestInit;
-};
+    init?: RequestInitWithDuplex;
+}
 export default function fetchHAR(har: Har, opts?: FetchHAROptions): Promise<Response>;
+export {};

package/dist/index.js

@@ -11,8 +11,8 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 exports.__esModule = true;
-var readable_stream_1 = require("readable-stream");
 var data_urls_1 = require("@readme/data-urls");
+var readable_stream_1 = require("readable-stream");
 if (!globalThis.Blob) {
     try {
         // eslint-disable-next-line @typescript-eslint/no-var-requires, import/no-extraneous-dependencies
@@ -101,6 +101,7 @@ function fetchHAR(har, opts) {
     var request = har.log.entries[0].request;
     var url = request.url;
     var querystring = '';
+    var shouldSetDuplex = false;
     var options = __assign(__assign({}, (opts.init ? opts.init : {})), { method: request.method });
     if (!options.headers) {
         options.headers = new Headers();
@@ -260,6 +261,7 @@ function fetchHAR(har, opts) {
                         });
                         // @ts-expect-error "Property 'from' does not exist on type 'typeof Readable'." but it does!
                         options.body = readable_stream_1.Readable.from(encoder_1);
+                        shouldSetDuplex = true;
                     }
                     else {
                         options.body = form_1;
@@ -300,6 +302,7 @@ function fetchHAR(har, opts) {
                                 else {
                                     // @ts-expect-error "Property 'from' does not exist on type 'typeof Readable'." but it does!
                                     options.body = readable_stream_1.Readable.from(fileContents.stream());
+                                    shouldSetDuplex = true;
                                     // Supplying a polyfilled `File` stream into `Request.body` doesn't automatically
                                     // add `Content-Length`.
                                     if (!headers.has('content-length')) {
@@ -315,11 +318,27 @@ function fetchHAR(har, opts) {
                 options.body = request.postData.text;
             }
         }
+        /**
+         * The fetch spec, which Node 18+ strictly abides by, now requires that `duplex` be sent with
+         * requests that have payloads.
+         *
+         * As `RequestInit#duplex` isn't supported by any browsers, or even mentioned on MDN, we aren't
+         * sending it in browser environments. This work is purely to support Node 18+ and `undici`
+         * environments.
+         *
+         * @see {@link https://github.com/nodejs/node/issues/46221}
+         * @see {@link https://github.com/whatwg/fetch/pull/1457}
+         * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request}
+         */
+        if (shouldSetDuplex && !isBrowser()) {
+            options.duplex = 'half';
+        }
     }
     // We automaticaly assume that the HAR that we have already has query parameters encoded within
     // it so we do **not** use the `URLSearchParams` API here for composing the query string.
+    var requestURL = url;
     if ('queryString' in request && request.queryString.length) {
-        var urlObj = new URL(url);
+        var urlObj = new URL(requestURL);
         var queryParams_1 = Array.from(urlObj.searchParams).map(function (_a) {
             var k = _a[0], v = _a[1];
             return "".concat(k, "=").concat(v);
@@ -328,11 +347,21 @@ function fetchHAR(har, opts) {
             queryParams_1.push("".concat(q.name, "=").concat(q.value));
         });
         querystring = queryParams_1.join('&');
+        // Because anchor hashes before query strings will prevent query strings from being delivered
+        // we need to pop them off and re-add them after.
+        if (urlObj.hash) {
+            var urlWithoutHashes = requestURL.replace(urlObj.hash, '');
+            requestURL = "".concat(urlWithoutHashes.split('?')[0]).concat(querystring ? "?".concat(querystring) : '');
+            requestURL += urlObj.hash;
+        }
+        else {
+            requestURL = "".concat(requestURL.split('?')[0]).concat(querystring ? "?".concat(querystring) : '');
+        }
     }
     if (opts.userAgent) {
         headers.append('User-Agent', opts.userAgent);
     }
     options.headers = headers;
-    return fetch("".concat(url.split('?')[0]).concat(querystring ? "?".concat(querystring) : ''), options);
+    return fetch(requestURL, options);
 }
 exports["default"] = fetchHAR;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fetch-har",
-  "version": "8.1.3",
+  "version": "8.1.5",
   "description": "Make a fetch request from a HAR definition",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -40,16 +40,16 @@
   "devDependencies": {
     "@jsdevtools/host-environment": "^2.1.2",
     "@jsdevtools/karma-config": "^3.1.7",
-    "@readme/eslint-config": "^9.0.0",
+    "@readme/eslint-config": "^10.4.5",
     "@types/chai": "^4.3.1",
-    "@types/express": "^4.17.13",
-    "@types/mocha": "^9.1.1",
+    "@types/express": "^4.17.15",
+    "@types/mocha": "^10.0.0",
     "@types/multer": "^1.4.7",
-    "@types/node": "^18.0.0",
-    "@types/readable-stream": "^2.3.13",
+    "@types/node": "^18.11.18",
+    "@types/readable-stream": "^2.3.15",
     "chai": "^4.3.4",
     "datauri": "^4.1.0",
-    "eslint": "^8.14.0",
+    "eslint": "^8.32.0",
     "express": "^4.18.1",
     "fetch-mock": "^9.11.0",
     "form-data": "^4.0.0",
@@ -57,17 +57,17 @@
     "formdata-node": "^4.3.2",
     "har-examples": "^3.1.1",
     "isomorphic-fetch": "^3.0.0",
-    "mocha": "^10.0.0",
+    "mocha": "^10.2.0",
     "multer": "^1.4.5-lts.1",
-    "nock": "^13.2.4",
+    "nock": "^13.3.0",
     "node-fetch": "^2.6.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.6.2",
+    "prettier": "^2.8.3",
     "temp-dir": "^2.0.0",
     "ts-loader": "^8.4.0",
     "ts-node": "^10.7.0",
-    "typescript": "^4.6.3",
-    "undici": "^5.0.0",
+    "typescript": "^4.9.4",
+    "undici": "^5.16.0",
     "webpack": "^4.46.0"
   },
   "browserslist": [

package/src/index.ts

@@ -1,7 +1,8 @@
-import type { Har } from 'har-format';
 import type { DataURL as npmDataURL } from '@readme/data-urls';
-import { Readable } from 'readable-stream';
+import type { Har } from 'har-format';
+
 import { parse as parseDataUrl } from '@readme/data-urls';
+import { Readable } from 'readable-stream';
 
 if (!globalThis.Blob) {
   try {
@@ -36,12 +37,25 @@ if (!globalThis.FormData) {
   }
 }
 
-export type FetchHAROptions = {
+interface RequestInitWithDuplex extends RequestInit {
+  /**
+   * `RequestInit#duplex` does not yet exist in the TS `lib.dom.d.ts` definition yet the native
+   * fetch implementation in Node 18+, `undici`, requires it for certain POST payloads.
+   *
+   * @see {@link https://github.com/microsoft/TypeScript-DOM-lib-generator/issues/1483}
+   * @see {@link https://github.com/nodejs/node/issues/46221}
+   * @see {@link https://fetch.spec.whatwg.org/#request-class}
+   * @see {@link https://github.com/microsoft/TypeScript/blob/main/lib/lib.dom.d.ts}
+   */
+  duplex?: 'half';
+}
+
+export interface FetchHAROptions {
   userAgent?: string;
   files?: Record<string, Blob | Buffer>;
   multipartEncoder?: any; // form-data-encoder
-  init?: RequestInit;
-};
+  init?: RequestInitWithDuplex;
+}
 
 type DataURL = npmDataURL & {
   // `parse-data-url` doesn't explicitly support `name` in data URLs but if it's there it'll be
@@ -116,8 +130,9 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
   const { request } = har.log.entries[0];
   const { url } = request;
   let querystring = '';
+  let shouldSetDuplex = false;
 
-  const options: RequestInit = {
+  const options: RequestInitWithDuplex = {
     // If we have custom options for the `Request` API we need to add them in here now before we
     // fill it in with everything we need from the HAR.
     ...(opts.init ? opts.init : {}),
@@ -308,6 +323,7 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
 
             // @ts-expect-error "Property 'from' does not exist on type 'typeof Readable'." but it does!
             options.body = Readable.from(encoder);
+            shouldSetDuplex = true;
           } else {
             options.body = form;
           }
@@ -346,6 +362,7 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
                 } else {
                   // @ts-expect-error "Property 'from' does not exist on type 'typeof Readable'." but it does!
                   options.body = Readable.from((fileContents as File).stream());
+                  shouldSetDuplex = true;
 
                   // Supplying a polyfilled `File` stream into `Request.body` doesn't automatically
                   // add `Content-Length`.
@@ -363,12 +380,29 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
         options.body = request.postData.text;
       }
     }
+
+    /**
+     * The fetch spec, which Node 18+ strictly abides by, now requires that `duplex` be sent with
+     * requests that have payloads.
+     *
+     * As `RequestInit#duplex` isn't supported by any browsers, or even mentioned on MDN, we aren't
+     * sending it in browser environments. This work is purely to support Node 18+ and `undici`
+     * environments.
+     *
+     * @see {@link https://github.com/nodejs/node/issues/46221}
+     * @see {@link https://github.com/whatwg/fetch/pull/1457}
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request}
+     */
+    if (shouldSetDuplex && !isBrowser()) {
+      options.duplex = 'half';
+    }
   }
 
   // We automaticaly assume that the HAR that we have already has query parameters encoded within
   // it so we do **not** use the `URLSearchParams` API here for composing the query string.
+  let requestURL = url;
   if ('queryString' in request && request.queryString.length) {
-    const urlObj = new URL(url);
+    const urlObj = new URL(requestURL);
 
     const queryParams = Array.from(urlObj.searchParams).map(([k, v]) => `${k}=${v}`);
     request.queryString.forEach(q => {
@@ -376,6 +410,16 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
     });
 
     querystring = queryParams.join('&');
+
+    // Because anchor hashes before query strings will prevent query strings from being delivered
+    // we need to pop them off and re-add them after.
+    if (urlObj.hash) {
+      const urlWithoutHashes = requestURL.replace(urlObj.hash, '');
+      requestURL = `${urlWithoutHashes.split('?')[0]}${querystring ? `?${querystring}` : ''}`;
+      requestURL += urlObj.hash;
+    } else {
+      requestURL = `${requestURL.split('?')[0]}${querystring ? `?${querystring}` : ''}`;
+    }
   }
 
   if (opts.userAgent) {
@@ -384,5 +428,5 @@ export default function fetchHAR(har: Har, opts: FetchHAROptions = {}) {
 
   options.headers = headers;
 
-  return fetch(`${url.split('?')[0]}${querystring ? `?${querystring}` : ''}`, options);
+  return fetch(requestURL, options);
 }