Merge pull request #278 from wolfpackthatcodes/refactoring/improving-tests

Refactoring & improving tests

Author: luisaveiro

code/package.json

@@ -52,6 +52,7 @@
     "test:ui": "yarn run test --ui --coverage --open=false"
   },
   "devDependencies": {
+    "@faker-js/faker": "^9.2.0",
     "@types/node": "^22.9.3",
     "@typescript-eslint/eslint-plugin": "^7.0.0",
     "@typescript-eslint/parser": "^6.21.0",

code/src/http/httpClient.ts

@@ -13,6 +13,7 @@ import {
   InvalidHeaderFormatException,
   InvalidRequestBodyFormatException,
 } from './exceptions';
+import { MultipartDataSerializer } from './serializers';
 
 export default class HttpClient {
   /**
@@ -25,7 +26,7 @@ export default class HttpClient {
   /**
    * The request body data.
    *
-   * @var {object | string | undefined}
+   * @var { object | string | undefined}
    */
   private body?: object | string;
 
@@ -41,7 +42,14 @@ export default class HttpClient {
    *
    * @var {MockedResponse}
    */
-  private mockedResponses: MockedResponses;
+  private readonly mockedResponses: MockedResponses;
+
+  /**
+   * The Multipart Data Serializer instance.
+   *
+   * @var {MultipartDataSerializer}
+   */
+  private readonly multipartDataSerializer: MultipartDataSerializer;
 
   /**
    * Number of attempts for the request.
@@ -65,18 +73,18 @@ export default class HttpClient {
   private retries: number = 0;
 
   /**
-   * The number of milliseconds to wait between retries.
+   * The callback that will determine if the request should be retried.
    *
-   * @var {number}
+   * @var {function}
    */
-  private retryDelay: number = 0;
+  private retryCallback?: (response: Response | undefined, request: this, error?: unknown) => boolean | null;
 
   /**
-   * The callback that will determine if the request should be retried.
+   * The number of milliseconds to wait between retries.
    *
-   * @var {function}
+   * @var {number}
    */
-  private retryCallback?: (response: Response | undefined, request: this, error?: unknown) => boolean | null;
+  private retryDelay: number = 0;
 
   /**
    * The URL for the request.
@@ -100,6 +108,7 @@ export default class HttpClient {
    */
   constructor(baseUrl?: string, options?: object) {
     this.mockedResponses = new MockedResponses();
+    this.multipartDataSerializer = new MultipartDataSerializer();
 
     this.setBaseUrl(baseUrl);
     this.setOptions(options);
@@ -144,7 +153,7 @@ export default class HttpClient {
    */
   public asForm(): this {
     this.setBodyFormat('FormData');
-    this.contentType('multipart/form-data');
+    this.contentType(`multipart/form-data; boundary=${this.multipartDataSerializer.getBoundary()}`);
 
     return this;
   }
@@ -210,14 +219,11 @@ export default class HttpClient {
     let url = this.url
       .split('://')
       .map((urlSlug) => urlSlug.replace(/\/{2,}/g, '/'))
-      .join('://');
-
-    if (!url.endsWith('/')) {
-      url += '/';
-    }
+      .join('://')
+      .replace(/\/$/, '');
 
     if (!(url.startsWith('http://') || url.startsWith('https://'))) {
-      url = this.baseUrl.replace(/\/$/, '') + url;
+      url = this.baseUrl.replace(/\/$/, '') + '/' + url.replace(/^\//, '');
     }
 
     if (this.urlQueryParameters !== undefined) {
@@ -376,13 +382,19 @@ export default class HttpClient {
         throw new InvalidRequestBodyFormatException('Cannot parse a string as FormData.');
       }
 
-      const formData = new FormData();
+      let formData: FormData;
+
+      if (this.body instanceof FormData) {
+        formData = this.body;
+      } else {
+        formData = new FormData();
 
-      for (const [key, value] of Object.entries(this.body)) {
-        formData.append(key, value);
+        for (const [key, value] of Object.entries(this.body)) {
+          formData.append(key, value);
+        }
       }
 
-      return formData;
+      return this.multipartDataSerializer.generateMultipartPayload(formData);
     }
 
     if (this.bodyFormat === 'URLSearchParams') {
@@ -548,11 +560,11 @@ export default class HttpClient {
   /**
    * Specify the body data of the request.
    *
-   * @param {object | string} body
+   * @param {FormData | object | string} body
    *
    * @return {void}
    */
-  private setBody(body: object | string): void {
+  private setBody(body: FormData | object | string): void {
     this.body = body;
   }
 

code/src/http/responses/mockedResponses.ts

@@ -1,4 +1,4 @@
-import Str from '@/support/str';
+import Str from '@/utils/str';
 import { MissingMockedResponseException } from '../exceptions';
 
 export default class MockedResponses {
@@ -44,7 +44,9 @@ export default class MockedResponses {
   public getMockedResponse(requestUrl: string): Promise<Response> {
     type ObjectKey = keyof typeof this.mockedResponses;
 
-    const mockedUrl = Object.keys(this.mockedResponses).find((url) => {
+    const mockedUrl = Object.keys(this.mockedResponses).find((url: string) => {
+      url = url.replace(/\/\*$/, '*');
+
       return url === requestUrl || url === '*' ? true : Str.is(Str.start(url, '*'), requestUrl);
     }) as ObjectKey;
 

code/src/http/serializers/index.ts

@@ -0,0 +1,3 @@
+import MultipartDataSerializer from './multipartDataSerializer';
+
+export { MultipartDataSerializer };

code/src/http/serializers/multipartDataSerializer.ts

@@ -0,0 +1,66 @@
+export default class MultipartDataSerializer {
+  /**
+   * A unique boundary string used to separate parts of the multipart/form-data payload.
+   *
+   * @type {string}
+   */
+  private readonly boundary: string;
+
+  /**
+   * Create a new Multipart Data Serializer instance.
+   */
+  constructor() {
+    this.boundary = this.generateBoundary();
+  }
+
+  /**
+   * Generates a unique boundary string for a multipart/form-data payload.
+   * The boundary ensures proper separation of parts in the payload.
+   *
+   * @returns {string}
+   */
+  private generateBoundary(): string {
+    return `----form-data-boundary-${Date.now()}`;
+  }
+
+  /**
+   * Creates a multipart/form-data payload from a given FormData object.
+   *
+   * @param {FormData} data
+   *
+   * @returns {string}
+   */
+  public generateMultipartPayload(data: FormData): string {
+    const lines: string[] = [];
+
+    data.forEach((value, key) => {
+      lines.push(`--${this.boundary}`);
+
+      if (value instanceof File) {
+        lines.push(
+          `Content-Disposition: form-data; name="${key}"; filename="${value.name}"`,
+          `Content-Type: ${value.type || 'application/octet-stream'}`,
+        );
+        lines.push('');
+        lines.push(value as unknown as string);
+      } else {
+        lines.push(`Content-Disposition: form-data; name="${key}"`);
+        lines.push('');
+        lines.push(value);
+      }
+    });
+
+    lines.push(`--${this.boundary}--`);
+
+    return lines.join('\r\n');
+  }
+
+  /**
+   * Retrieves the boundary string used for the multipart/form-data payload.
+   *
+   * @returns {string}
+   */
+  public getBoundary(): string {
+    return this.boundary;
+  }
+}