feat(orchestrator): display a confirmation dialog before the user abo…

…rts a running workflow (#1215) * display a confirmation dialog before the user aborts a running workflow * Fix lint issue * Move dialog action component out of the parent component
janus-idp · Feb 18, 2024 · 1453cf8 · 1453cf8
1 parent a7e936d
commit 1453cf8
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 20 deletions.
diff --git a/plugins/orchestrator/src/components/InfoDialog.tsx b/plugins/orchestrator/src/components/InfoDialog.tsx
@@ -17,7 +17,7 @@ export type InfoDialogProps = {
   open: boolean;
   onClose?: () => void;
   dialogActions?: React.ReactNode;
-  children: React.ReactNode;
+  children?: React.ReactNode;
 };
 
 export type ParentComponentRef = HTMLElement;

diff --git a/plugins/orchestrator/src/components/WorkflowInstancePage.tsx b/plugins/orchestrator/src/components/WorkflowInstancePage.tsx
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
 import { useNavigate } from 'react-router-dom';
 
 import {
@@ -27,8 +27,29 @@ import { executeWorkflowRouteRef, workflowInstanceRouteRef } from '../routes';
 import { isNonNullable } from '../utils/TypeGuards';
 import { buildUrl } from '../utils/UrlUtils';
 import { BaseOrchestratorPage } from './BaseOrchestratorPage';
+import { InfoDialog } from './InfoDialog';
 import { WorkflowInstancePageContent } from './WorkflowInstancePageContent';
 
+export type AbortConfirmationDialogActionsProps = {
+  handleSubmit: () => void;
+  handleCancel: () => void;
+};
+
+const AbortConfirmationDialogContent = () => (
+  <div>Are you sure you want to abort this workflow instance?</div>
+);
+
+const AbortConfirmationDialogActions = (
+  props: AbortConfirmationDialogActionsProps,
+) => (
+  <>
+    <Button onClick={props.handleCancel}>Cancel</Button>
+    <Button onClick={props.handleSubmit} color="primary">
+      Ok
+    </Button>
+  </>
+);
+
 export const WorkflowInstancePage = ({
   instanceId,
 }: {
@@ -40,6 +61,8 @@ export const WorkflowInstancePage = ({
   const { instanceId: queryInstanceId } = useRouteRefParams(
     workflowInstanceRouteRef,
   );
+  const [isAbortConfirmationDialogOpen, setIsAbortConfirmationDialogOpen] =
+    useState(false);
 
   const fetchInstance = React.useCallback(async () => {
     if (!instanceId && !queryInstanceId) {
@@ -73,26 +96,24 @@ export const WorkflowInstancePage = ({
     [value],
   );
 
+  const toggleAbortConfirmationDialog = () => {
+    setIsAbortConfirmationDialogOpen(!isAbortConfirmationDialogOpen);
+  };
+
   const handleAbort = React.useCallback(async () => {
     if (value) {
-      // eslint-disable-next-line no-alert
-      const yes = window.confirm(
-        'Are you sure you want to abort this instance?',
-      );
-
-      if (yes) {
-        try {
-          await orchestratorApi.abortWorkflow(value.instance.id);
-          restart();
-        } catch (e) {
-          // eslint-disable-next-line no-alert
-          window.alert(
-            `The abort operation failed with the following error: ${
-              (e as Error).message
-            }`,
-          );
-        }
+      try {
+        await orchestratorApi.abortWorkflow(value.instance.id);
+        restart();
+      } catch (e) {
+        // eslint-disable-next-line no-alert
+        window.alert(
+          `The abort operation failed with the following error: ${
+            (e as Error).message
+          }`,
+        );
       }
+      setIsAbortConfirmationDialogOpen(false);
     }
   }, [orchestratorApi, restart, value]);
 
@@ -122,14 +143,28 @@ export const WorkflowInstancePage = ({
       {!loading && isNonNullable(value) ? (
         <>
           <ContentHeader title="">
+            <InfoDialog
+              title="Abort workflow"
+              onClose={toggleAbortConfirmationDialog}
+              open={isAbortConfirmationDialogOpen}
+              dialogActions={
+                <AbortConfirmationDialogActions
+                  handleCancel={toggleAbortConfirmationDialog}
+                  handleSubmit={handleAbort}
+                />
+              }
+              children={<AbortConfirmationDialogContent />}
+            />
             <Grid container item justifyContent="flex-end" spacing={1}>
               {!canRerun && (
                 <Grid item>
                   <Button
                     variant="contained"
                     color="secondary"
                     disabled={!canAbort}
-                    onClick={canAbort ? handleAbort : undefined}
+                    onClick={
+                      canAbort ? toggleAbortConfirmationDialog : undefined
+                    }
                   >
                     Abort
                   </Button>