45407 refactor(api): add overloads to commonRequest for type-safe void responses

Author: Maria-Lordwill

frontend/src/public/api/commonRequest.ts

@@ -93,11 +93,23 @@ axiosInstance.interceptors.response.use(
   },
 );
 
+export async function commonRequest(
+  rawUrl: string,
+  params: Partial<AxiosRequestConfig>,
+  options: Partial<ICommonRequestOptions> & { responseType: 'empty' },
+): Promise<void>;
+export async function commonRequest<T>(
+  rawUrl: string,
+  params?: Partial<AxiosRequestConfig>,
+  options?: Partial<ICommonRequestOptions>,
+): Promise<T>;
+
+/* eslint-disable consistent-return */
 export async function commonRequest<T>(
   rawUrl: string,
   params: Partial<AxiosRequestConfig> = {},
   options: Partial<ICommonRequestOptions> = {},
-): Promise<T> {
+): Promise<T | void> {
   const {
     api: { publicUrl, urls },
   } = getBrowserConfigEnv();
@@ -121,7 +133,7 @@ export async function commonRequest<T>(
     const response = await axiosInstance(fullUrl, config);
 
     if (options.responseType === 'empty') {
-      return undefined as unknown as T;
+      return;
     }
 
     return response.data as T;
@@ -130,6 +142,7 @@ export async function commonRequest<T>(
       throw error;
     }
     logger.error(error);
-    return undefined as unknown as T;
+    
   }
 }
+/* eslint-enable consistent-return */

frontend/src/public/redux/workflows/__tests__/saga.test.ts

@@ -15,7 +15,7 @@ import { cloneWorkflowAction, deleteWorkflowAction, returnWorkflowToTaskAction,
 describe('workflows saga', () => {
   it('deleteWorkflowSaga work', () => {
     const saga = deleteWorkflowSaga({ type: deleteWorkflowAction.type, payload: { workflowId: 1 } });
-    const deleteApiMock = jest.spyOn(deleteApi, 'deleteWorkflow').mockImplementation(() => Promise.resolve(null));
+    const deleteApiMock = jest.spyOn(deleteApi, 'deleteWorkflow').mockImplementation(() => Promise.resolve());
     const notificationManagerSuccessMock = jest.spyOn(NotificationManager, 'success');
     saga.next();
     saga.next();
@@ -33,7 +33,7 @@ describe('workflows saga', () => {
     });
     const finishWorkflowApiMock = jest
       .spyOn(finishWorkflowApi, 'finishWorkflow')
-      .mockImplementation(() => Promise.resolve(null));
+      .mockImplementation(() => Promise.resolve());
     const notificationManagerSuccessMock = jest.spyOn(NotificationManager, 'success');
     saga.next();
     saga.next();