✅ Add tests for searchParams utils

Author: cermakjiri

packages/@ackee/antonio-core/src/modules/request/utils/url/__tests__/searchParams.test.ts

@@ -0,0 +1,40 @@
+import { getValidSearchParams, encodeParamsToSearchParams } from '../searchParams';
+
+describe('getValidSearchParams', () => {
+    it('returns params without null, undefined or empty string', () => {
+        const params = new URLSearchParams({
+            a: 'null',
+            b: 'undefined',
+            c: '',
+            d: 'foo',
+        });
+
+        const validParams = getValidSearchParams(params);
+
+        expect(validParams.has('d')).toBe(true);
+        expect(Array.from(validParams.entries()).length).toBe(1);
+    });
+});
+
+describe.only('encodeParamsToSearchParams', () => {
+    it(`returns undefined if undefined params received`, () => {
+        expect(encodeParamsToSearchParams()).toBe(undefined);
+    });
+
+    it(`returns received params if they're instace of URLSearchParams`, () => {
+        const params = new URLSearchParams();
+        expect(encodeParamsToSearchParams(params)).toBe(params);
+    });
+
+    // TODO:
+    it.skip(`encodes object literal to an instance of URLSearchParams`, () => {
+        const params = {
+            a: 1,
+            b: ['a', 'b'],
+            c: 'foo',
+        };
+
+        // TODO: continue here
+        // const result = encodeParamsToSearchParams(params);
+    });
+});

packages/@ackee/antonio-core/src/modules/request/utils/url/index.ts

@@ -24,7 +24,7 @@ export function createRequestUrl(
 
         const url = joinUrlChunks(requestConfig.baseURL, requestUrl);
 
-        const searchParams = encodeParamsToSearchParams(requestConfig.params || requestConfig.params);
+        const searchParams = encodeParamsToSearchParams(requestConfig.params);
         url.search = getValidSearchParams(searchParams).toString();
 
         return url.toString();

packages/@ackee/antonio-core/src/modules/request/utils/url/searchParams.ts

@@ -4,6 +4,7 @@ const isValidSearchParam = (value: string) => {
     return value !== 'undefined' && value !== 'null' && value !== '';
 };
 
+// TODO: add test
 export function getValidSearchParams(searchParams?: URLSearchParams): URLSearchParams {
     const validSearchParams = new URLSearchParams();
 
@@ -18,6 +19,7 @@ export function getValidSearchParams(searchParams?: URLSearchParams): URLSearchP
     return validSearchParams;
 }
 
+// TODO: add test
 export function encodeParamsToSearchParams(params?: RequestSearchParams): URLSearchParams | undefined {
     if (params === undefined) {
         return;
@@ -27,6 +29,10 @@ export function encodeParamsToSearchParams(params?: RequestSearchParams): URLSea
         return params;
     }
 
+    // TODO: if requestCOnfig contains paramsSerializer
+    // BE might require array items to have been suffixed with `[]`:
+    // ['includeTag[]', 1], not only ['includeTag', 1] (e.g. on Expenses)
+
     const searchParams = new URLSearchParams();
 
     for (const [name, value] of Object.entries(params)) {