handle uncaught error in batch actions (#1184)

* handle uncaught error in batch actions

* clean up batch/bulk code

* fix mocks for tests

src/lib/components/workflow/batch-operation-confirmation-modal.svelte

@@ -4,7 +4,6 @@
   import { pluralize } from '$lib/utilities/pluralize';
   import Input from '$lib/holocene/input/input.svelte';
   export let action: 'Terminate' | 'Cancel';
-  export let loading: boolean;
   export let allSelected: boolean;
   export let actionableWorkflowsLength: number;
   export let query: string;
@@ -36,7 +35,6 @@
   confirmType="destructive"
   confirmDisabled={reason === ''}
   {confirmText}
-  {loading}
   on:cancelModal={handleCancelModal}
   on:confirmModal={handleConfirmModal}
 >

src/lib/pages/workflows-with-new-search.svelte

@@ -48,7 +48,6 @@
   let batchCancelConfirmationModal: BatchOperationConfirmationModal;
   let allSelected: boolean = false;
   let pageSelected: boolean = false;
-  let terminating: boolean = false;
 
   $: query = $page.url.searchParams.get('query');
 
@@ -91,8 +90,6 @@
   };
 
   const resetPageToDefaultState = () => {
-    terminating = false;
-
     $workflowFilters = [];
     $workflowSorts = [];
     updateQueryParameters({
@@ -133,82 +130,43 @@
   };
 
   const terminateWorkflows = async (event: CustomEvent<{ reason: string }>) => {
-    const { namespace } = $page.params;
-    const { reason } = event.detail;
-
+    const options = {
+      namespace: $page.params.namespace,
+      reason: event.detail.reason,
+    };
     if (allSelected) {
-      // Idea: persist the job ID and display a progress indicator for large jobs
       await batchTerminateByQuery({
-        namespace,
-        reason,
+        ...options,
         query: batchOperationQuery,
       });
-      toaster.push({
-        message: 'The batch terminate request is processing in the background.',
-        id: 'batch-terminate-success-toast',
-      });
     } else {
-      terminating = true;
-      try {
-        const jobId = await bulkTerminateByIDs({
-          namespace,
-          reason,
-          workflows: terminableWorkflows,
-        });
-        const workflowsTerminated = await pollBatchOperation({
-          namespace,
-          jobId,
-        });
-        toaster.push({
-          message: `Successfully terminated ${workflowsTerminated} workflows.`,
-          id: 'batch-terminate-success-toast',
-        });
-      } catch (error) {
-        toaster.push({
-          variant: 'error',
-          message: 'Unable to terminate workflows.',
-        });
-      }
+      await bulkTerminateByIDs({
+        ...options,
+        workflows: terminableWorkflows,
+      });
     }
+
     resetPageToDefaultState();
   };
 
   const cancelWorkflows = async (event: CustomEvent<{ reason: string }>) => {
-    const { namespace } = $page.params;
-    const { reason } = event.detail;
+    const options = {
+      namespace: $page.params.namespace,
+      reason: event.detail.reason,
+    };
 
     if (allSelected) {
       await batchCancelByQuery({
-        namespace,
-        reason,
+        ...options,
         query: batchOperationQuery,
       });
-      toaster.push({
-        message: 'The batch cancel request is processing in the background.',
-        id: 'batch-cancel-success-toast',
-      });
     } else {
-      try {
-        const jobId = await bulkCancelByIDs({
-          namespace,
-          reason,
-          workflows: cancelableWorkflows,
-        });
-        const workflowsCancelled = await pollBatchOperation({
-          namespace,
-          jobId,
-        });
-        toaster.push({
-          message: `Successfully cancelled ${workflowsCancelled} workflows.`,
-          id: 'batch-cancel-success-toast',
-        });
-      } catch {
-        toaster.push({
-          variant: 'error',
-          message: 'Unable to cancel workflows.',
-        });
-      }
+      await bulkCancelByIDs({
+        ...options,
+        workflows: cancelableWorkflows,
+      });
     }
+
     resetPageToDefaultState();
   };
 
@@ -246,7 +204,6 @@
 <BatchOperationConfirmationModal
   action="Terminate"
   bind:this={batchTerminateConfirmationModal}
-  loading={terminating}
   {allSelected}
   actionableWorkflowsLength={terminableWorkflows.length}
   query={batchOperationQuery}
@@ -255,7 +212,6 @@
 <BatchOperationConfirmationModal
   action="Cancel"
   bind:this={batchCancelConfirmationModal}
-  loading={false}
   {allSelected}
   actionableWorkflowsLength={cancelableWorkflows.length}
   query={batchOperationQuery}

src/lib/services/batch-service.test.ts

@@ -12,7 +12,15 @@ const mockWorkflows = [
 ];
 
 vi.mock('../utilities/request-from-api', () => ({
-  requestFromAPI: vi.fn().mockResolvedValue({ jobId: 'abc-123' }),
+  requestFromAPI: vi.fn().mockImplementation((route) => {
+    if (route.includes('/describe')) {
+      return new Promise((resolve) =>
+        resolve({ state: 'Completed', completedOperationCount: '10' }),
+      );
+    }
+
+    return new Promise((resolve) => resolve('xxx'));
+  }),
 }));
 
 vi.mock('uuid', () => ({
@@ -27,7 +35,7 @@ vi.mock('../stores/versions', () => {
 
 describe('Batch Service', () => {
   afterEach(() => {
-    vi.restoreAllMocks();
+    vi.clearAllMocks();
   });
 
   describe('when temporal server version is <= 1.19', () => {
@@ -44,7 +52,7 @@ describe('Batch Service', () => {
         workflows: mockWorkflows,
       });
 
-      expect(requestFromAPI).toHaveBeenCalledOnce();
+      expect(requestFromAPI).toHaveBeenCalledTimes(2);
       expect(requestFromAPI).toHaveBeenCalledWith(
         'http://localhost:8233/api/v1/namespaces/default/batch-operations',
         {
@@ -65,7 +73,7 @@ describe('Batch Service', () => {
         workflows: mockWorkflows,
       });
 
-      expect(requestFromAPI).toHaveBeenCalledOnce();
+      expect(requestFromAPI).toHaveBeenCalledTimes(2);
       expect(requestFromAPI).toHaveBeenCalledWith(
         'http://localhost:8233/api/v1/namespaces/default/batch-operations',
         {
@@ -94,7 +102,7 @@ describe('Batch Service', () => {
         workflows: mockWorkflows,
       });
 
-      expect(requestFromAPI).toHaveBeenCalledOnce();
+      expect(requestFromAPI).toHaveBeenCalledTimes(2);
       expect(requestFromAPI).toHaveBeenCalledWith(
         'http://localhost:8233/api/v1/namespaces/default/batch-operations',
         {
@@ -115,7 +123,7 @@ describe('Batch Service', () => {
         workflows: mockWorkflows,
       });
 
-      expect(requestFromAPI).toHaveBeenCalledOnce();
+      expect(requestFromAPI).toHaveBeenCalledTimes(2);
       expect(requestFromAPI).toHaveBeenCalledWith(
         'http://localhost:8233/api/v1/namespaces/default/batch-operations',
         {

src/lib/services/batch-service.ts

@@ -9,6 +9,7 @@ import type {
 } from 'src/types';
 import { isVersionNewer } from '$lib/utilities/version-check';
 import { temporalVersion } from '$lib/stores/versions';
+import { toaster } from '$lib/stores/toaster';
 
 type CreateBatchOperationOptions = {
   namespace: string;
@@ -74,32 +75,84 @@ const createBatchOperationOptions = ({
 
 export async function bulkTerminateByIDs(
   options: CreateBatchOperationWithIDsOptions,
-) {
-  const fullOptions = createBatchOperationOptions(options);
-  return terminateWorkflows(fullOptions);
+): Promise<void> {
+  try {
+    const fullOptions = createBatchOperationOptions(options);
+    const jobId = await terminateWorkflows(fullOptions);
+    const workflowsTerminated = await pollBatchOperation({
+      namespace: fullOptions.namespace,
+      jobId,
+    });
+    toaster.push({
+      message: `Successfully terminated ${workflowsTerminated} workflows.`,
+      id: 'batch-terminate-success-toast',
+    });
+  } catch {
+    toaster.push({
+      message: 'Unable to terminate Workflows.',
+      variant: 'error',
+    });
+  }
 }
 
 export async function batchTerminateByQuery({
   namespace,
   query,
   reason,
-}: CreateBatchOperationWithQueryOptions) {
-  return terminateWorkflows({ namespace, query, reason });
+}: CreateBatchOperationWithQueryOptions): Promise<void> {
+  try {
+    await terminateWorkflows({ namespace, query, reason });
+    toaster.push({
+      message: 'The batch terminate request is processing in the background.',
+      id: 'batch-terminate-success-toast',
+    });
+  } catch {
+    toaster.push({
+      message: 'Unable to terminate Workflows.',
+      variant: 'error',
+    });
+  }
 }
 
 export async function bulkCancelByIDs(
   options: CreateBatchOperationWithIDsOptions,
-): Promise<string> {
-  const fullOptions = createBatchOperationOptions(options);
-  return cancelWorkflows(fullOptions);
+): Promise<void> {
+  try {
+    const fullOptions = createBatchOperationOptions(options);
+    const jobId = await cancelWorkflows(fullOptions);
+    const workflowsCancelled = await pollBatchOperation({
+      namespace: fullOptions.namespace,
+      jobId,
+    });
+    toaster.push({
+      message: `Successfully cancelled ${workflowsCancelled} workflows.`,
+      id: 'batch-cancel-success-toast',
+    });
+  } catch {
+    toaster.push({
+      message: 'Unable to cancel Workflows.',
+      variant: 'error',
+    });
+  }
 }
 
 export async function batchCancelByQuery({
   namespace,
   query,
   reason,
-}: CreateBatchOperationWithQueryOptions) {
-  return cancelWorkflows({ namespace, query, reason });
+}: CreateBatchOperationWithQueryOptions): Promise<void> {
+  try {
+    await cancelWorkflows({ namespace, query, reason });
+    toaster.push({
+      message: 'The batch cancel request is processing in the background.',
+      id: 'batch-cancel-success-toast',
+    });
+  } catch {
+    toaster.push({
+      message: 'Unable to cancel Workflows.',
+      variant: 'error',
+    });
+  }
 }
 
 async function cancelWorkflows({