@readme/httpsnippet 3.1.1 → 4.0.0

package/src/index.ts

@@ -0,0 +1,361 @@
+import type { Param, PostDataCommon, Request as NpmHarRequest } from 'har-format';
+import type { UrlWithParsedQuery } from 'url';
+import type { ReducedHelperObject } from './helpers/reducer';
+import type { ClientId, TargetId } from './targets/targets';
+import { map as eventStreamMap } from 'event-stream';
+import FormData from 'form-data';
+import { stringify as queryStringify } from 'qs';
+// eslint-disable-next-line node/no-deprecated-api
+import { format as urlFormat, parse as urlParse } from 'url';
+
+import { formDataIterator, isBlob } from './helpers/form-data';
+import { validateHarRequest } from './helpers/har-validator';
+import { getHeaderName } from './helpers/headers';
+import { reducer } from './helpers/reducer';
+import { targets } from './targets/targets';
+
+export { availableTargets, extname } from './helpers/utils';
+export { addTarget, addTargetClient } from './targets/targets';
+
+const DEBUG_MODE = false;
+
+const debug = {
+  // eslint-disable-next-line @typescript-eslint/no-empty-function -- intentional noop
+  info: DEBUG_MODE ? console.info : () => {},
+};
+
+/** is this wrong?  yes.  according to the spec (http://www.softwareishard.com/blog/har-12-spec/#postData) it's technically wrong since `params` and `text` are (by the spec) mutually exclusive.  However, in practice, this is not what is often the case.
+ *
+ * In general, this library takes a _descriptive_ rather than _perscriptive_ approach (see https://amyrey.web.unc.edu/classes/ling-101-online/tutorials/understanding-prescriptive-vs-descriptive-grammar/).
+ *
+ * Then, in addition to that, it really adds to complexity with TypeScript (TypeScript takes this constraint very very seriously) in a way that's not actually super useful.  So, we treat this object as though it could have both or either of `params` and/or `text`.
+ */
+type PostDataBase = PostDataCommon & {
+  text?: string;
+  params?: Param[];
+};
+
+export type HarRequest = Omit<NpmHarRequest, 'postData'> & { postData: PostDataBase };
+
+export interface RequestExtras {
+  postData: PostDataBase & {
+    jsonObj?: ReducedHelperObject;
+    paramsObj?: ReducedHelperObject;
+    boundary?: string;
+  };
+  fullUrl: string;
+  queryObj: ReducedHelperObject;
+  headersObj: ReducedHelperObject;
+  uriObj: UrlWithParsedQuery;
+  cookiesObj: ReducedHelperObject;
+  allHeaders: ReducedHelperObject;
+}
+
+export type Request = HarRequest & RequestExtras;
+
+interface Entry {
+  request: Partial<HarRequest>;
+}
+
+interface HarEntry {
+  log: {
+    version: string;
+    creator: {
+      name: string;
+      version: string;
+    };
+    entries: Entry[];
+  };
+}
+
+export interface HTTPSnippetOptions {
+  harIsAlreadyEncoded?: boolean;
+}
+
+const isHarEntry = (value: any): value is HarEntry =>
+  typeof value === 'object' &&
+  'log' in value &&
+  typeof value.log === 'object' &&
+  'entries' in value.log &&
+  Array.isArray(value.log.entries);
+
+export class HTTPSnippet {
+  requests: Request[] = [];
+
+  constructor(input: HarEntry | HarRequest, opts: HTTPSnippetOptions = {}) {
+    let entries: Entry[] = [];
+
+    const options = {
+      harIsAlreadyEncoded: false,
+      ...opts,
+    };
+
+    // prep the main container
+    this.requests = [];
+
+    // is it har?
+    if (isHarEntry(input)) {
+      entries = input.log.entries;
+    } else {
+      entries = [
+        {
+          request: input,
+        },
+      ];
+    }
+
+    entries.forEach(({ request }) => {
+      // add optional properties to make validation successful
+      const req = {
+        bodySize: 0,
+        headersSize: 0,
+        headers: [],
+        cookies: [],
+        httpVersion: 'HTTP/1.1',
+        queryString: [],
+        postData: {
+          mimeType: request.postData?.mimeType || 'application/octet-stream',
+        },
+        ...request,
+      };
+
+      if (validateHarRequest(req)) {
+        this.requests.push(this.prepare(req, options));
+      }
+    });
+  }
+
+  prepare = (harRequest: HarRequest, options: HTTPSnippetOptions) => {
+    const request: Request = {
+      ...harRequest,
+      fullUrl: '',
+      uriObj: {} as UrlWithParsedQuery,
+      queryObj: {},
+      headersObj: {},
+      cookiesObj: {},
+      allHeaders: {},
+    };
+
+    // construct query objects
+    if (request.queryString && request.queryString.length) {
+      debug.info('queryString found, constructing queryString pair map');
+
+      request.queryObj = request.queryString.reduce(reducer, {});
+    }
+
+    // construct headers objects
+    if (request.headers && request.headers.length) {
+      const http2VersionRegex = /^HTTP\/2/;
+      request.headersObj = request.headers.reduce((accumulator, { name, value }) => {
+        const headerName = http2VersionRegex.exec(request.httpVersion) ? name.toLocaleLowerCase() : name;
+        return {
+          ...accumulator,
+          [headerName]: value,
+        };
+      }, {});
+    }
+
+    // construct headers objects
+    if (request.cookies && request.cookies.length) {
+      request.cookiesObj = request.cookies.reduceRight(
+        (accumulator, { name, value }) => ({
+          ...accumulator,
+          [name]: value,
+        }),
+        {}
+      );
+    }
+
+    // construct Cookie header
+    const cookies = request.cookies?.map(({ name, value }) => {
+      if (options.harIsAlreadyEncoded) {
+        return `${name}=${value}`;
+      }
+
+      return `${encodeURIComponent(name)}=${encodeURIComponent(value)}`;
+    });
+
+    if (cookies?.length) {
+      request.allHeaders.cookie = cookies.join('; ');
+    }
+
+    switch (request.postData.mimeType) {
+      case 'multipart/mixed':
+      case 'multipart/related':
+      case 'multipart/form-data':
+      case 'multipart/alternative':
+        // reset values
+        request.postData.text = '';
+        request.postData.mimeType = 'multipart/form-data';
+
+        if (request.postData?.params) {
+          const form = new FormData();
+
+          // The `form-data` module returns one of two things: a native FormData object, or its own polyfill
+          // Since the polyfill does not support the full API of the native FormData object, when this library is running in a browser environment it'll fail on two things:
+          //
+          //  1. The API for `form.append()` has three arguments and the third should only be present when the second is a
+          //    Blob or USVString.
+          //  1. `FormData.pipe()` isn't a function.
+          //
+          // Since the native FormData object is iterable, we easily detect what version of `form-data` we're working with here to allow `multipart/form-data` requests to be compiled under both browser and Node environments.
+          //
+          // This hack is pretty awful but it's the only way we can use this library in the browser as if we code this against just the native FormData object, we can't polyfill that back into Node because Blob and File objects, which something like `formdata-polyfill` requires, don't exist there.
+          // @ts-expect-error TODO
+          const isNativeFormData = typeof form[Symbol.iterator] === 'function';
+
+          // TODO: THIS ABSOLUTELY MUST BE REMOVED.
+          // IT BREAKS SOME USE-CASES FOR MULTIPART FORMS THAT DEPEND ON BEING ABLE TO SET THE BOUNDARY.
+          // easter egg
+          const boundary = '---011000010111000001101001'; // this is binary for "api". yep.
+          if (!isNativeFormData) {
+            // @ts-expect-error THIS IS WRONG.  VERY WRONG.
+            form._boundary = boundary;
+          }
+
+          request.postData?.params.forEach(param => {
+            const name = param.name;
+            const value = param.value || '';
+            const filename = param.fileName || null;
+
+            if (isNativeFormData) {
+              if (isBlob(value)) {
+                // @ts-expect-error TODO
+                form.append(name, value, filename);
+              } else {
+                form.append(name, value);
+              }
+            } else {
+              form.append(name, value, {
+                // @ts-expect-error TODO
+                filename,
+                // @ts-expect-error TODO
+                contentType: param.contentType || null,
+              });
+            }
+          });
+
+          if (isNativeFormData) {
+            // eslint-disable-next-line no-restricted-syntax
+            for (const data of formDataIterator(form, boundary)) {
+              request.postData.text += data;
+            }
+          } else {
+            form.pipe(
+              // @ts-expect-error TODO
+              eventStreamMap(data => {
+                request.postData.text += data;
+              })
+            );
+          }
+
+          request.postData.boundary = boundary;
+
+          // Since headers are case-sensitive we need to see if there's an existing `Content-Type` header that we can override.
+          const contentTypeHeader = getHeaderName(request.headersObj, 'content-type') || 'content-type';
+
+          request.headersObj[contentTypeHeader] = `multipart/form-data; boundary=${boundary}`;
+        }
+        break;
+
+      case 'application/x-www-form-urlencoded':
+        if (!request.postData.params) {
+          request.postData.text = '';
+        } else {
+          // @ts-expect-error the `har-format` types make this challenging
+          request.postData.paramsObj = request.postData.params.reduce(reducer, {});
+
+          // always overwrite
+          request.postData.text = queryStringify(request.postData.paramsObj);
+        }
+        break;
+
+      case 'text/json':
+      case 'text/x-json':
+      case 'application/json':
+      case 'application/x-json':
+        request.postData.mimeType = 'application/json';
+
+        if (request.postData.text) {
+          try {
+            request.postData.jsonObj = JSON.parse(request.postData.text);
+          } catch (e) {
+            debug.info(e);
+
+            // force back to `text/plain` if headers have proper content-type value, then this should also work
+            request.postData.mimeType = 'text/plain';
+          }
+        }
+        break;
+    }
+
+    // create allHeaders object
+    const allHeaders = {
+      ...request.allHeaders,
+      ...request.headersObj,
+    };
+
+    const urlWithParsedQuery = urlParse(request.url, true, true); //?
+
+    // query string key/value pairs in with literal querystrings containd within the url
+    request.queryObj = {
+      ...request.queryObj,
+      ...(urlWithParsedQuery.query as ReducedHelperObject),
+    }; //?
+
+    // reset uriObj values for a clean url
+    let search;
+    if (options.harIsAlreadyEncoded) {
+      search = queryStringify(request.queryObj, {
+        encode: false,
+        indices: false,
+      });
+    } else {
+      search = queryStringify(request.queryObj, {
+        indices: false,
+      });
+    }
+
+    const uriObj = {
+      ...urlWithParsedQuery,
+      query: request.queryObj,
+      search,
+      path: search ? `${urlWithParsedQuery.pathname}?${search}` : urlWithParsedQuery.pathname,
+    };
+
+    // keep the base url clean of queryString
+    const url = urlFormat({
+      ...urlWithParsedQuery,
+      query: null,
+      search: null,
+    }); //?
+
+    const fullUrl = urlFormat({
+      ...urlWithParsedQuery,
+      ...uriObj,
+    }); //?
+
+    return {
+      ...request,
+      allHeaders,
+      fullUrl,
+      url,
+      uriObj,
+    };
+  };
+
+  convert = (targetId: TargetId, clientId?: ClientId, options?: any) => {
+    if (!options && clientId) {
+      options = clientId;
+    }
+
+    const target = targets[targetId];
+    if (!target) {
+      return false;
+    }
+
+    const { convert } = target.clientsById[clientId || target.info.default];
+    const results = this.requests.map(request => convert(request, options));
+    return results.length === 1 ? results[0] : results;
+  };
+}

package/src/integration.test.ts

@@ -0,0 +1,270 @@
+/* eslint-disable jest/no-conditional-expect */
+import type { Request } from '.';
+import type { TargetId } from './targets/targets';
+import type { Response } from 'har-format';
+
+import shell from 'child_process';
+import { format } from 'util';
+import { readdirSync } from 'fs';
+import path from 'path';
+
+import { availableTargets, extname } from './helpers/utils';
+
+const expectedBasePath = ['src', 'fixtures', 'requests'];
+
+const ENVIRONMENT_CONFIG = {
+  docker: {
+    // Every client + target that we test in an HTTPBin-powered Docker environment.
+    node: ['axios', 'fetch', 'native', 'request'],
+    php: ['curl', 'guzzle'],
+    python: ['requests'],
+    shell: ['curl'],
+  },
+  local: {
+    // When running tests locally, or within a Jest CI environment, we shold limit the targets that
+    // we're testing so as to not require a mess of dependency requirements that would be better
+    // served within a container.
+    node: ['native'],
+    php: ['curl'],
+    python: ['requests'],
+    shell: ['curl'],
+  },
+};
+
+const inputFileNames = readdirSync(path.join(...expectedBasePath), 'utf-8');
+
+const fixtures: [string, Request][] = inputFileNames.map(inputFileName => [
+  inputFileName.replace(path.extname(inputFileName), ''),
+  // eslint-disable-next-line import/no-dynamic-require, global-require
+  require(path.resolve(...expectedBasePath, inputFileName)),
+]);
+
+/** ignore a set of fixtures from being run in tests */
+const fixtureIgnoreFilter: string[] = [
+  // Some targets don't support native file handling without supplying a raw boundary header and
+  // because the HAR for `multipart-file` doesn't include the files contents, just its filename
+  // running one of these generated snippets doesn't send anything for the file because the
+  // FormData API rewrites the incoming full path of `src/fixtures/files/hello.txt` to just
+  // `hello.txt`. Instead of monkeypatching these targets to have the full file path at time ofb
+  // this execution suite we're just ignoring this test case as file uploading is well covered by
+  // the other cases we have.
+  'multipart-file',
+];
+
+const environmentFilter = (): string[] => {
+  if (process.env.HTTPBIN) {
+    return Object.keys(ENVIRONMENT_CONFIG.docker);
+  } else if (process.env.NODE_ENV === 'test') {
+    return Object.keys(ENVIRONMENT_CONFIG.local);
+  }
+
+  throw new Error('Unsupported environment supplied to `environmentFilter`.');
+};
+
+const clientFilter = (target: TargetId): string[] => {
+  if (process.env.HTTPBIN) {
+    // @ts-expect-error fix this type
+    return ENVIRONMENT_CONFIG.docker[target];
+  } else if (process.env.NODE_ENV === 'test') {
+    // @ts-expect-error fix this type
+    return ENVIRONMENT_CONFIG.local[target];
+  }
+
+  throw new Error('Unsupported environment supplied to `clientFilter`.');
+};
+
+const testFilter =
+  <T>(property: keyof T, list: T[keyof T][], ignore = false) =>
+  (item: T) => {
+    if (!list.length) {
+      return true;
+    } else if (ignore) {
+      return list.length > 0 ? !list.includes(item[property]) : true;
+    }
+
+    return list.length > 0 ? list.includes(item[property]) : true;
+  };
+
+/**
+ * @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_eval!
+ */
+function looseJSONParse(obj: any) {
+  // eslint-disable-next-line no-new-func
+  return new Function(`"use strict";return ${obj}`)();
+}
+
+availableTargets()
+  .filter(target => target.cli)
+  .filter(testFilter('key', environmentFilter()))
+  .forEach(({ key: targetId, cli: targetCLI, title, extname: fixtureExtension, clients }) => {
+    describe(`${title} integration tests`, () => {
+      clients.filter(testFilter('key', clientFilter(targetId))).forEach(({ key: clientId }) => {
+        // If we're in an HTTPBin-powered Docker environment we only want to run tests for the
+        // client that our Docker has been configured for.
+        if (process.env.HTTPBIN && process.env.INTEGRATION_CLIENT !== targetId) {
+          return;
+        }
+
+        // eslint-disable-next-line jest/valid-title
+        describe(clientId, () => {
+          fixtures.filter(testFilter(0, fixtureIgnoreFilter, true)).forEach(([fixture, request]) => {
+            it(`should return the expected response for \`${fixture}\``, () => {
+              const basePath = path.join(
+                'src',
+                'targets',
+                targetId,
+                clientId,
+                'fixtures',
+                `${fixture}${extname(targetId)}`
+              );
+
+              // Clone the fixture we're testing against to another object because for multipart cases
+              // we're deleting the header, and if we don't clone the fixture to another object, that
+              // deleted header will cause other tests to fail because it's missing where other tests
+              // are expecting it.
+              const har = JSON.parse(JSON.stringify(request));
+              const url = har.log.entries[0].request.url;
+              const harResponse = har.log.entries[0].response as Response;
+
+              const command = format(targetCLI, basePath);
+              let stdout;
+              try {
+                stdout = shell.execSync(command);
+              } catch (err) {
+                // If this target throws errors when it can't access a method on the server that
+                // doesn't exist let's make sure that it only did that on the `custom-method` test,
+                // otherwise something went wrong!
+                if (err.message.includes('405 METHOD NOT ALLOWED')) {
+                  expect(fixture).toBe('custom-method');
+                  return;
+                }
+
+                throw err;
+              }
+
+              stdout = stdout.toString().trim();
+
+              // If the endpoint we're testing against returns HTML we should do a string comparison
+              // instead of parsing a non-existent JSON response.
+              if (harResponse.headers.find(header => header.name === 'Content-Type' && header.value === 'text/html')) {
+                // const stdoutTrimmed = stdout.toString().trim();
+
+                try {
+                  expect(stdout).toStrictEqual(harResponse.content.text);
+                } catch (err) {
+                  // Some targets always assume that their response is JSON and for this case
+                  // (`custom-method`) will print out an empty string instead.
+                  expect(stdout).toBe('');
+                }
+
+                return;
+              }
+
+              const expected = JSON.parse(String(harResponse.content.text));
+              let response;
+              try {
+                response = JSON.parse(stdout);
+              } catch (err) {
+                // Some JS targets print out their response with `console.log(json)` which creates
+                // a JSON object that we can't access with `JSON.parse()`.
+                // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_eval!
+                if (fixtureExtension !== '.js') {
+                  throw err;
+                }
+
+                response = looseJSONParse(stdout);
+              }
+
+              // If we're testing against the `/cookies` or `/headers` endpoints it returns a
+              // different schema than everything else.
+              if (url === 'https://httpbin.org/cookies') {
+                expect(response.cookies).toStrictEqual(expected.cookies);
+                return;
+              } else if (url === 'https://httpbin.org/headers') {
+                expect(response.headers).toStrictEqual(
+                  expect.objectContaining({
+                    ...expected.headers,
+                  })
+                );
+
+                return;
+              }
+
+              expect(response.args).toStrictEqual(expected.args);
+
+              // Some targets send files that have a new line at the end of them without that new
+              // line so we need to make our assertion universal across all targets.
+              let files = {};
+              if (Object.keys(response.files).length) {
+                files = Object.entries(response.files)
+                  .map(([k, v]) => ({ [k]: String(v).trim() }))
+                  .reduce((prev, next) => Object.assign(prev, next));
+              }
+
+              expect(files).toStrictEqual(expected.files);
+
+              expect(response.form).toStrictEqual(expected.form);
+              expect(response.method).toStrictEqual(expected.method);
+              expect(response.url).toStrictEqual(expected.url);
+
+              // Because some JS targets may be returning their payloads with `console.log()` that
+              // method has a default depth, at which point it turns objects into `[Object]`. When
+              // we then run that through `looseJSONParse` it gets transformed again into
+              // `[ [Function: Object] ]`. Since we don't have access to the original object context
+              // from the target snippet, we rewrite our response a bit so that it can partially
+              // match what we're looking for.
+              //
+              // Of course the side effect to this is is that now these test cases may be subject
+              // to flakiness but without updating the root snippets to not use `console.log()`,
+              // which we don't want to do, this is the way it's got to be.
+              if (fixture === 'application-json' && fixtureExtension === '.js') {
+                const respJSON = response.json;
+                respJSON.arr_mix[2] = { arr_mix_nested: {} };
+
+                expect(respJSON).toStrictEqual(expected.json);
+              } else {
+                expect(response.json).toStrictEqual(expected.json);
+              }
+
+              // If we're dealing with a JSON payload, some snippets add indents and new lines to
+              // the data that is sent to
+              // HTTPBin (that it then returns back us in the same format) -- to make this `data`
+              // check target agnostic we need to parse and re-stringify our expectations so that
+              // this test can universally match them all.
+              if (expected.headers?.['Content-Type']?.includes('application/json')) {
+                expect(JSON.stringify(JSON.parse(response.data))).toStrictEqual(
+                  JSON.stringify(JSON.parse(expected.data))
+                );
+              } else {
+                expect(response.data).toStrictEqual(expected.data);
+              }
+
+              // `multipart/form-data` needs some special tests to assert that boundaries were sent
+              // and received properly.
+              if (expected.headers?.['Content-Type']?.includes('multipart/form-data')) {
+                if (expected.headers['Content-Type'] === response.headers['Content-Type']) {
+                  // If the headers match identically, great! If not we need to make sure that
+                  // there's a boundary set up.
+                } else {
+                  // It doesn't matter that the /right/ boundary is set up because some targets may
+                  // add their own, we just need to make sure that **a** boundary is present.
+                  const contentTypes: string[] = response.headers['Content-Type']
+                    .split(';')
+                    .map((p: string) => p.trim());
+
+                  expect(contentTypes).toHaveLength(2);
+                  expect(contentTypes.map(type => type.includes('boundary=')).filter(Boolean)).toHaveLength(1);
+                }
+              } else {
+                expect(response.headers).toStrictEqual(
+                  expect.objectContaining({
+                    ...expected.headers,
+                  })
+                );
+              }
+            });
+          });
+        });
+      });
+    });
+  });

package/src/targets/c/libcurl/client.ts

@@ -0,0 +1,50 @@
+import type { Client } from '../../targets';
+import { CodeBuilder } from '../../../helpers/code-builder';
+
+export const libcurl: Client = {
+  info: {
+    key: 'libcurl',
+    title: 'Libcurl',
+    link: 'http://curl.haxx.se/libcurl',
+    description: 'Simple REST and HTTP API Client for C',
+  },
+  convert: ({ method, fullUrl, headersObj, allHeaders, postData }) => {
+    const { push, blank, join } = new CodeBuilder();
+
+    push('CURL *hnd = curl_easy_init();');
+    blank();
+    push(`curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "${method.toUpperCase()}");`);
+    push(`curl_easy_setopt(hnd, CURLOPT_URL, "${fullUrl}");`);
+
+    // Add headers, including the cookies
+    const headers = Object.keys(headersObj);
+
+    // construct headers
+    if (headers.length) {
+      blank();
+      push('struct curl_slist *headers = NULL;');
+
+      headers.forEach(header => {
+        push(`headers = curl_slist_append(headers, "${header}: ${headersObj[header]}");`);
+      });
+
+      push('curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);');
+    }
+
+    // construct cookies
+    if (allHeaders.cookie) {
+      blank();
+      push(`curl_easy_setopt(hnd, CURLOPT_COOKIE, "${allHeaders.cookie}");`);
+    }
+
+    if (postData.text) {
+      blank();
+      push(`curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, ${JSON.stringify(postData.text)});`);
+    }
+
+    blank();
+    push('CURLcode ret = curl_easy_perform(hnd);');
+
+    return join();
+  },
+};

package/src/targets/c/libcurl/fixtures/application-form-encoded.c

@@ -0,0 +1,12 @@
+CURL *hnd = curl_easy_init();
+
+curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
+curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
+
+struct curl_slist *headers = NULL;
+headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
+curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
+
+curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "foo=bar&hello=world");
+
+CURLcode ret = curl_easy_perform(hnd);