feat: dropping support for non-native FormData implementations

.eslintrc

@@ -20,7 +20,9 @@
 
     "unicorn/prefer-node-protocol": "error",
 
-    "vitest/require-hook": "off"
+    "vitest/require-hook": ["error", {
+      "allowedFunctionCalls": ["runCustomFixtures"]
+    }]
   },
   "overrides": [
     {

.vscode/settings.json

@@ -1,4 +1,10 @@
 {
-  "files.insertFinalNewline": false, // controlled by the .editorconfig at root since we can't map vscode settings directly to files (see: https://github.com/microsoft/vscode/issues/35350)
-  "editor.defaultFormatter": "esbenp.prettier-vscode"
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+
+  // controlled by the .editorconfig at root since we can't map vscode settings directly to files
+  // https://github.com/microsoft/vscode/issues/35350
+  "files.insertFinalNewline": false
 }

README.md

@@ -39,7 +39,7 @@ Type: `object`
 
 Available options:
 
-* `harIsAlreadyEncoded` (`boolean`): In the event of you supplying a `source` HAR that already contains escaped data (query and cookie parameters)strings, this allows you to disable automatic encoding of those parameters to prevent them from being double-escaped.
+- `harIsAlreadyEncoded` (`boolean`): In the event of you supplying a `source` HAR that already contains escaped data (query and cookie parameters)strings, this allows you to disable automatic encoding of those parameters to prevent them from being double-escaped.
 
 ### convert(target [, options])
 
@@ -63,6 +63,8 @@ const snippet = new HTTPSnippet({
   url: 'httsp://httpbin.org/anything',
 });
 
+await snippet.init();
+
 // generate Node.js: Native output
 console.log(snippet.convert('node'));
 
@@ -102,6 +104,8 @@ const snippet = new HTTPSnippet({
   url: 'https://httpbin.org/anything',
 });
 
+await snippet.init();
+
 // generate Shell: cURL output
 console.log(
   snippet.convert('shell', 'curl', {
@@ -155,32 +159,31 @@ For detailed information on each target, please review the [wiki](https://github
 
 There are some major differences between this library and the [httpsnippet](https://github.com/Kong/httpsnippet) upstream:
 
-* Includes a full integration test suite for a handful of clients and targets.
-* Does not ship with a CLI component.
-* Does not do any HAR schema validation. It's just assumed that the HAR you're supplying to the library is already valid.
-* The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
-  * We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
-* Does not support the `insecureSkipVerify` option on `go:native`, `node:native`, `ruby:native`, and `shell:curl` as we don't want snippets generated for our users to bypass SSL certificate verification.
-* Node
-  * `fetch`
-    * Body payloads are treated as an object literal and wrapped within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads. This also applies to the JS `fetch` target as well.
-  * `request`
-    * Does not provide query string parameters in a `params` argument due to complexities with query encoding.
-* PHP
-  * `guzzle`
-    * Snippets have `require_once('vendor/autoload.php');` prefixed at the top.
-* Python
-  * `python3`
-    * Does not ship this client due to its incompatibility with being able to support file uploads.
-  * `requests`
-    * Does not provide query string parameters in a `params` argument due to complexities with query encoding.
+- Includes a full integration test suite for a handful of clients and targets.
+- Does not ship with a CLI component.
+- Does not do any HAR schema validation. It's just assumed that the HAR you're supplying to the library is already valid.
+- The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
+  - We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
+- Does not support the `insecureSkipVerify` option on `go:native`, `node:native`, `ruby:native`, and `shell:curl` as we don't want snippets generated for our users to bypass SSL certificate verification.
+- Node
+  - `fetch`
+    - Body payloads are treated as an object literal and wrapped within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads. This also applies to the JS `fetch` target as well.
+  - `request`
+    - Does not provide query string parameters in a `params` argument due to complexities with query encoding.
+- PHP
+  - `guzzle`
+    - Snippets have `require_once('vendor/autoload.php');` prefixed at the top.
+- Python
+  - `python3`
+    - Does not ship this client due to its incompatibility with being able to support file uploads.
+  - `requests`
+    - Does not provide query string parameters in a `params` argument due to complexities with query encoding.
 
 ## License
 
 [MIT](LICENSE) © [Kong](https://konghq.com)
 
 [license-url]: https://github.com/Kong/httpsnippet/blob/master/LICENSE
-
 [npm-url]: https://www.npmjs.com/package/@readme/httpsnippet
 [npm-license]: https://img.shields.io/npm/l/@readme/httpsnippet.svg?style=flat-square
 [npm-version]: https://img.shields.io/npm/v/@readme/httpsnippet.svg?style=flat-square

package.json

@@ -75,7 +75,7 @@
     "prebuild": "npm run clean",
     "prepack": "npm run build",
     "pretest": "npm run lint",
-    "prettier": "prettier --list-different --write \"./**/**.{js,ts}\"",
+    "prettier": "prettier --list-different --write \"./**/**.{md,cjs,js,ts}\"",
     "test": "vitest --coverage"
   },
   "devDependencies": {
@@ -95,8 +95,7 @@
     "vitest": "^0.34.4"
   },
   "dependencies": {
-    "form-data": "^4.0.0",
-    "map-stream": "^0.0.7",
+    "formdata-to-string": "^1.0.1",
     "qs": "^6.11.2",
     "stringify-object": "^3.3.0"
   },

src/fixtures/runCustomFixtures.ts

@@ -24,24 +24,25 @@ export interface CustomFixture {
 
 export const runCustomFixtures = ({ targetId, clientId, tests }: CustomFixture) => {
   describe(`custom fixtures for ${targetId}:${clientId}`, () => {
-    tests.forEach(({ it: title, expected: fixtureFile, options, input: request }) => {
+    it.each(tests.map(t => [t.it, t]))('%s', async (_, { expected: fixtureFile, options, input: request }) => {
       const opts: HTTPSnippetOptions = {};
       if (options.harIsAlreadyEncoded) {
         opts.harIsAlreadyEncoded = options.harIsAlreadyEncoded;
       }
 
-      const result = new HTTPSnippet(request, opts).convert(targetId, clientId, options);
+      const snippet = new HTTPSnippet(request, opts);
+      await snippet.init();
+
+      const result = snippet.convert(targetId, clientId, options);
       const filePath = path.join(__dirname, '..', 'targets', targetId, clientId, 'fixtures', fixtureFile);
       if (process.env.OVERWRITE_EVERYTHING) {
         writeFileSync(filePath, String(result));
       }
 
-      it(title, async () => {
-        const buffer = await readFile(filePath);
-        const fixture = String(buffer);
+      const buffer = await readFile(filePath);
+      const fixture = String(buffer);
 
-        expect(result).toStrictEqual(fixture);
-      });
+      expect(result).toStrictEqual(fixture);
     });
   });
 };