Merge pull request #17 from koul1sh/zz-formdata

feat: added support for multipart formdata

Author: vasan-agrostar

docs/zzapi-bundle-description.md

@@ -72,6 +72,9 @@ requests:
 * `headers`: a set of headers, this will be in in addition to the common set, or overridden if the name is the same
 * `params`: a set of parameter values, or overridden if the name is the same
 * `body`: the raw request body. (Use the value `file://<filename>` to read from a file), or an object, which will be converted to a JSON string after variable replacements.
+* `formValues`: An object representing form fields to send in the request body. If no content-type is given and:
+  1. if none of the fields contain a file (specified as `file://<filename>`), the request will be sent as `application/x-www-form-urlencoded`.
+  2. if at least one field contains a file, the request will be sent as `multipart/form-data`.
 * `response*`: a set of sample responses, useful for documentation (doesn't affect the request)
   * `headers`: the headers expected in the response
   * `body`: the raw response body, or a JSON object. Use `<filename` to read from a file.

package.json

@@ -39,6 +39,8 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
+    "form-data-encoder": "^4.0.2",
+    "formdata-node": "^6.0.3",
     "got": "11.8.6",
     "jsonpath": "^1.1.1",
     "yaml": "^2.3.4"

schemas/zzapi-bundle.schema.json

@@ -257,6 +257,16 @@
               "description": "The request body",
               "type": ["string", "object", "array"] 
             },
+            "formValues":{
+              "description": "Put form values here.",
+              "anyOf":[
+                {
+                  "type": "array",
+                  "items": { "$ref": "#/$defs/headerArray" }
+                },
+                { "$ref": "#/$defs/headerObject" }
+              ]
+            },
             "options": { "$ref": "#/$defs/options" },
             "tests": { "$ref": "#/$defs/tests" },
             "capture": {

src/checkTypes.ts

@@ -5,7 +5,7 @@ function checkKey(
   item: string,
   key: string,
   expectedTypes: string[],
-  optional: boolean,
+  optional: boolean
 ): string | undefined {
   if (!optional && !obj.hasOwnProperty(key)) {
     return `${key} key must be present in each ${item} item`;
@@ -217,6 +217,18 @@ export function validateRawRequest(obj: any): string | undefined {
     }
   }
 
+  if (obj.hasOwnProperty("formValues") && obj.hasOwnProperty("body")) {
+    return `both body and formValues can't be present in the same request.`;
+  }
+
+  if (obj.hasOwnProperty("method") && obj["method"] == "GET" && obj.hasOwnProperty("formValues")) {
+    return `formValues can't be used with method GET`;
+  }
+
+  if (obj.hasOwnProperty("method") && obj["method"] == "GET" && obj.hasOwnProperty("body")) {
+    return `body can't be used with method GET`;
+  }
+
   return undefined;
 }
 

src/constructCurl.ts

@@ -1,16 +1,73 @@
-import { getStringValueIfDefined } from "./utils/typeUtils";
-
+import { getStringValueIfDefined, hasFile, isFilePath } from "./utils/typeUtils";
 import { RequestSpec } from "./models";
 import { getParamsForUrl, getURL } from "./executeRequest";
+import path from "path";
 
 function replaceSingleQuotes<T>(value: T): T {
   if (typeof value !== "string") return value;
   return value.replace(/'/g, "%27") as T & string;
 }
 
+function formatCurlFormField(key: string, value: string): string {
+  if (isFilePath(value)) {
+    return ` --form ${key}=@"${path.resolve(value.slice(7))}"`;
+  }
+  return ` --form '${key}="${encodeURIComponent(value)}"'`;
+}
+
+function getFormDataUrlEncoded(request: RequestSpec): string {
+  const formValues = request.httpRequest.formValues;
+  if (!formValues) return "";
+  let result = "";
+
+  formValues.forEach((formValue: any) => {
+    result += ` --data "${formValue.name}=${encodeURIComponent(formValue.value)}"`;
+  });
+
+  return result;
+}
+
+function getFormDataCurlRequest(request: RequestSpec): string {
+  const formValues = request.httpRequest.formValues;
+  if (!formValues) return "";
+  let result = "";
+  for (const { name, value } of formValues) {
+    result += formatCurlFormField(name, value);
+  }
+  return result;
+}
+
 export function getCurlRequest(request: RequestSpec): string {
   let curl: string = "curl";
 
+  if (
+    request.httpRequest.headers["content-type"] == "multipart/form-data" ||
+    hasFile(request.httpRequest.formValues)
+  ) {
+    curl += getFormDataCurlRequest(request);
+    curl += ` '${replaceSingleQuotes(
+      getURL(
+        request.httpRequest.baseUrl,
+        request.httpRequest.url,
+        getParamsForUrl(request.httpRequest.params, request.options.rawParams)
+      )
+    )}'`;
+    return curl;
+  } else if (
+    request.httpRequest.headers["content-type"] == "application/x-www-form-urlencoded" ||
+    request.httpRequest.formValues
+  ) {
+    curl += getFormDataUrlEncoded(request);
+    curl += ` '${replaceSingleQuotes(
+      getURL(
+        request.httpRequest.baseUrl,
+        request.httpRequest.url,
+        getParamsForUrl(request.httpRequest.params, request.options.rawParams)
+      )
+    )}'`;
+    return curl;
+  }
+
   // method
   curl += ` -X ${request.httpRequest.method.toUpperCase()}`;
 
@@ -22,8 +79,9 @@ export function getCurlRequest(request: RequestSpec): string {
   }
 
   // body
-  if (request.httpRequest.body !== undefined)
+  if (request.httpRequest.body !== undefined) {
     curl += ` -d '${replaceSingleQuotes(getStringValueIfDefined(request.httpRequest.body))}'`;
+  }
 
   // options.follow
   if (request.options.follow) curl += " -L";
@@ -39,8 +97,8 @@ export function getCurlRequest(request: RequestSpec): string {
     getURL(
       request.httpRequest.baseUrl,
       request.httpRequest.url,
-      getParamsForUrl(request.httpRequest.params, request.options.rawParams),
-    ),
+      getParamsForUrl(request.httpRequest.params, request.options.rawParams)
+    )
   )}'`;
 
   return curl;

src/executeRequest.ts

@@ -1,19 +1,25 @@
 import got, { Method, OptionsOfTextResponseBody } from "got";
 
-import { getStringValueIfDefined } from "./utils/typeUtils";
+import { getStringValueIfDefined, hasFile, isFilePath } from "./utils/typeUtils";
 
 import { GotRequest, Param, RequestSpec } from "./models";
+import { fileFromPathSync } from "formdata-node/file-from-path";
+
+import { FormDataEncoder } from "form-data-encoder";
+import { FormData } from "formdata-node";
+import { Readable } from "stream";
+import * as path from "path";
 
 export function constructGotRequest(allData: RequestSpec): GotRequest {
   const completeUrl: string = getURL(
     allData.httpRequest.baseUrl,
     allData.httpRequest.url,
-    getParamsForUrl(allData.httpRequest.params, allData.options.rawParams),
+    getParamsForUrl(allData.httpRequest.params, allData.options.rawParams)
   );
 
   const options: OptionsOfTextResponseBody = {
     method: allData.httpRequest.method.toLowerCase() as Method,
-    body: getStringValueIfDefined(allData.httpRequest.body),
+    body: getBody(allData),
     headers: allData.httpRequest.headers,
     followRedirect: allData.options.follow,
     https: { rejectUnauthorized: allData.options.verifySSL },
@@ -23,6 +29,60 @@ export function constructGotRequest(allData: RequestSpec): GotRequest {
   return got(completeUrl, options);
 }
 
+function getFileFromPath(filePath: string) {
+  filePath = path.resolve(filePath.slice(7)); // removes file:// prefix
+  const fileName = path.basename(filePath);
+  return fileFromPathSync(filePath, fileName);
+}
+
+function constructFormUrlEncoded(request: RequestSpec) {
+  const formValues = request.httpRequest.formValues;
+  if (!formValues) return "";
+  const result = new URLSearchParams();
+  if (formValues) {
+    request.httpRequest.headers["content-type"] = "application/x-www-form-urlencoded";
+  }
+
+  for (const { name, value } of formValues) {
+    result.append(name, value);
+  }
+
+  return result.toString();
+}
+
+function constructFormData(request: RequestSpec) {
+  const formValues = request.httpRequest.formValues;
+  if (!formValues) return;
+  const multipart = new FormData();
+
+  for (const fv of formValues) {
+    if (isFilePath(fv.value)) {
+      multipart.append(fv.name, getFileFromPath(fv.value));
+    } else {
+      multipart.append(fv.name, fv.value);
+    }
+  }
+  const fde = new FormDataEncoder(multipart);
+
+  request.httpRequest.headers["content-type"] = fde.contentType; //FormDataEncoder builds the actual content-type header.
+  return Readable.from(fde);
+}
+
+export function getBody(request: RequestSpec) {
+  const body = request.httpRequest.body;
+  const formValues = request.httpRequest.formValues;
+
+  if (request.httpRequest.headers["content-type"] == "multipart/form-data" || hasFile(formValues)) {
+    return constructFormData(request);
+  }
+
+  if (formValues) {
+    return constructFormUrlEncoded(request);
+  }
+
+  return getStringValueIfDefined(body);
+}
+
 export async function executeGotRequest(httpRequest: GotRequest): Promise<{
   response: { [key: string]: any };
   executionTime: number;

src/mergeData.ts

@@ -51,7 +51,7 @@ function getMergedParams(commonParams: RawParams, requestParams: RawParams): Par
 
 function getMergedHeaders(
   commonHeaders: RawHeaders,
-  requestHeaders: RawHeaders,
+  requestHeaders: RawHeaders
 ): { [name: string]: string } {
   if (Array.isArray(commonHeaders)) {
     commonHeaders = getArrayHeadersAsObject(commonHeaders);
@@ -80,7 +80,7 @@ function getMergedOptions(cOptions: RawOptions = {}, rOptions: RawOptions = {}):
 
 function getMergedSetVars(
   setvars: RawSetVars = {},
-  captures: Captures = {},
+  captures: Captures = {}
 ): { mergedVars: SetVar[]; hasJsonVars: boolean } {
   const mergedVars: SetVar[] = [];
   let hasJsonVars = false;
@@ -155,7 +155,7 @@ export function mergePrefixBasedTests(tests: RawTests) {
 
 function getMergedTests(
   cTests: RawTests = {},
-  rTests: RawTests = {},
+  rTests: RawTests = {}
 ): { mergedTests: Tests; hasJsonTests: boolean } {
   // Convert $. and h. at root level into headers and json keys
   mergePrefixBasedTests(cTests);
@@ -208,15 +208,16 @@ export function getMergedData(commonData: Common, requestData: RawRequest): Requ
   const params = getMergedParams(commonData.params, requestData.params);
   const headers = getMergedHeaders(commonData.headers, requestData.headers);
   const body = requestData.body;
+  const formValues = getMergedParams([], requestData.formValues);
   const options = getMergedOptions(commonData.options, requestData.options);
 
   const { mergedTests: tests, hasJsonTests: hasJsonTests } = getMergedTests(
     commonData?.tests,
-    requestData.tests,
+    requestData.tests
   );
   const { mergedVars: setvars, hasJsonVars: hasJsonVars } = getMergedSetVars(
     requestData.setvars,
-    requestData.capture,
+    requestData.capture
   );
 
   const mergedData: RequestSpec = {
@@ -228,6 +229,7 @@ export function getMergedData(commonData: Common, requestData: RawRequest): Requ
       params,
       headers,
       body,
+      formValues: formValues.length > 0 ? formValues : undefined,
     },
     options,
     tests,

src/models.ts

@@ -1,4 +1,4 @@
-import { CancelableRequest, Response, Method, OptionsOfTextResponseBody } from "got";
+import { CancelableRequest, Response, Method } from "got";
 
 export interface Header {
   name: string;
@@ -85,6 +85,7 @@ export interface RawRequest {
   headers: RawHeaders;
   params: RawParams;
   body?: string;
+  formValues?: RawParams;
   options?: RawOptions;
   tests?: RawTests;
   capture?: Captures;
@@ -101,6 +102,7 @@ export interface RequestSpec {
     params: Param[];
     headers: { [key: string]: string };
     body?: any;
+    formValues?: Param[];
   };
   expectJson: boolean;
   options: Options;

src/utils/typeUtils.ts

@@ -21,7 +21,7 @@ export function getStringIfNotScalar(data: any): Exclude<any, object> {
 
 export function getStringValueIfDefined<
   T extends undefined | Exclude<any, undefined>,
-  R = T extends undefined ? undefined : string,
+  R = T extends undefined ? undefined : string
 >(value: T): R {
   if (typeof value === "undefined") return undefined as R;
   if (typeof value === "object") return JSON.stringify(value) as R; // handles dicts, arrays, null, date (all obj)
@@ -32,3 +32,27 @@ export function getStrictStringValue(value: any): string {
   if (typeof value === "undefined") return "undefined";
   return getStringValueIfDefined(value);
 }
+
+export function isString(value: any): boolean {
+  return typeof value === "string" || value instanceof String;
+}
+
+export function isFilePath(value: any): boolean {
+  if (!isString(value)) {
+    return false;
+  }
+  const fileRegex = /file:\/\/([^\s]+)/g;
+  return fileRegex.test(value);
+}
+
+export function hasFile(formValues: any): boolean {
+  if (!formValues) {
+    return false;
+  }
+  for (const formValue of formValues) {
+    if (isFilePath(formValue.value)) {
+      return true;
+    }
+  }
+  return false;
+}