Add 100% coverage for callApi

Author: ktmud

packages/superset-ui-connection/src/SupersetClientClass.ts

@@ -58,6 +58,9 @@ export default class SupersetClientClass {
   }: ClientConfig = {}) {
     const url = new URL(
       host || protocol ? `${protocol || 'https:'}//${host || 'localhost'}` : baseUrl,
+      // baseUrl for API could also be relative, so we provide current location.href
+      // as the base of baseUrl
+      window.location.href || 'http://localhost',
     );
     this.baseUrl = url.href.replace(/\/+$/, ''); // always strip trailing slash
     this.host = url.host;

packages/superset-ui-connection/src/callApi/callApi.ts

@@ -12,16 +12,17 @@ function tryParsePayload(payload: Payload) {
 }
 
 /**
- * Try appending search params to an URL.
+ * Try appending search params to an URL if needed.
  */
 function getFullUrl(partialUrl: string, params: CallApi['searchParams']) {
-  const url = new URL(partialUrl);
   if (params) {
+    const url = new URL(partialUrl, window.location.href);
     const search = params instanceof URLSearchParams ? params : new URLSearchParams(params);
     // will completely override any existing search params
     url.search = search.toString();
+    return url.href;
   }
-  return url.href;
+  return partialUrl;
 }
 
 /**
@@ -96,7 +97,7 @@ export default async function callApi({
 
   if (method === 'POST' || method === 'PATCH' || method === 'PUT') {
     if (postPayload && jsonPayload) {
-      throw new Error('Please provide only one of jsonPayload and postPayload');
+      throw new Error('Please provide only one of jsonPayload or postPayload');
     }
     if (postPayload instanceof FormData) {
       request.body = postPayload;

packages/superset-ui-connection/test/callApi/callApi.test.ts

@@ -488,4 +488,68 @@ describe('callApi()', () => {
       expect(error.message).toEqual('Invalid payload:\n\nhaha');
     }
   });
+
+  it('should accept search params object', async () => {
+    expect.assertions(3);
+    window.location.href = 'http://localhost';
+    fetchMock.get(`glob:*/get-search*`, { yes: 'ok' });
+    const response = await callApi({
+      url: '/get-search',
+      searchParams: {
+        abc: 1,
+      },
+      method: 'GET',
+    });
+    const result = await response.json();
+    expect(response.status).toEqual(200);
+    expect(result).toEqual({ yes: 'ok' });
+    expect(fetchMock.lastUrl()).toEqual(`http://localhost/get-search?abc=1`);
+  });
+
+  it('should accept URLSearchParams', async () => {
+    expect.assertions(2);
+    window.location.href = 'http://localhost';
+    fetchMock.post(`glob:*/post-search*`, { yes: 'ok' });
+    await callApi({
+      url: '/post-search',
+      searchParams: new URLSearchParams({
+        abc: '1',
+      }),
+      method: 'POST',
+      jsonPayload: { request: 'ok' },
+    });
+    expect(fetchMock.lastUrl()).toEqual(`http://localhost/post-search?abc=1`);
+    expect(fetchMock.lastOptions()).toEqual(
+      expect.objectContaining({
+        body: JSON.stringify({ request: 'ok' }),
+      }),
+    );
+  });
+
+  it('should throw when both payloads provided', async () => {
+    expect.assertions(1);
+    fetchMock.post('/post-both-payload', {});
+    try {
+      await callApi({
+        url: '/post-both-payload',
+        method: 'POST',
+        postPayload: { a: 1 },
+        jsonPayload: '{}',
+      });
+    } catch (error) {
+      expect((error as Error).message).toContain('provide only one of jsonPayload or postPayload');
+    }
+  });
+
+  it('should accept FormData as postPayload', async () => {
+    expect.assertions(1);
+    fetchMock.post('/post-formdata', {});
+    const payload = new FormData();
+    await callApi({
+      url: '/post-formdata',
+      method: 'POST',
+      postPayload: payload,
+    });
+    expect(fetchMock.lastOptions().body).toBe(payload);
+  });
 });