From e0a4ae9c4d960a8b03651dc99ef54bac4990c926 Mon Sep 17 00:00:00 2001
From: Vladimir Filonov <vladimir@filonov.dev>
Date: Thu, 17 Oct 2024 16:44:42 +0400
Subject: [PATCH] feat: Possibility to run workflows for incidents manually
 (#2226)

---
 keep-ui/app/alerts/alerts.tsx                 |  4 +--
 keep-ui/app/incidents/[id]/incident-info.tsx  | 28 ++++++++++++++++++-
 keep-ui/app/incidents/incidents-table.tsx     | 24 +++++++++++++++-
 .../manual-run-workflow-modal.tsx}            | 16 +++++++----
 keep/api/routes/workflows.py                  | 28 ++++++++++++-------
 keep/workflowmanager/workflowscheduler.py     | 23 +++++++++++----
 6 files changed, 97 insertions(+), 26 deletions(-)
 rename keep-ui/app/{alerts/alert-run-workflow-modal.tsx => workflows/manual-run-workflow-modal.tsx} (79%)

diff --git a/keep-ui/app/alerts/alerts.tsx b/keep-ui/app/alerts/alerts.tsx
index 5d8ff0151..e780179ed 100644
--- a/keep-ui/app/alerts/alerts.tsx
+++ b/keep-ui/app/alerts/alerts.tsx
@@ -9,7 +9,7 @@ import AlertNoteModal from "./alert-note-modal";
 import { useProviders } from "utils/hooks/useProviders";
 import { AlertDto } from "./models";
 import { AlertMethodModal } from "./alert-method-modal";
-import AlertRunWorkflowModal from "./alert-run-workflow-modal";
+import ManualRunWorkflowModal from "@/app/workflows/manual-run-workflow-modal";
 import AlertDismissModal from "./alert-dismiss-modal";
 import { ViewAlertModal } from "./ViewAlertModal";
 import { useRouter, useSearchParams } from "next/navigation";
@@ -151,7 +151,7 @@ export default function Alerts({ presetName }: AlertsProps) {
         alert={noteModalAlert ?? null}
       />
       {selectedPreset && <AlertMethodModal presetName={selectedPreset.name} />}
-      <AlertRunWorkflowModal
+      <ManualRunWorkflowModal
         alert={runWorkflowModalAlert}
         handleClose={() => setRunWorkflowModalAlert(null)}
       />
diff --git a/keep-ui/app/incidents/[id]/incident-info.tsx b/keep-ui/app/incidents/[id]/incident-info.tsx
index 364965010..b8b1314de 100644
--- a/keep-ui/app/incidents/[id]/incident-info.tsx
+++ b/keep-ui/app/incidents/[id]/incident-info.tsx
@@ -3,7 +3,7 @@ import { IncidentDto } from "../models";
 import CreateOrUpdateIncident from "../create-or-update-incident";
 import Modal from "@/components/ui/Modal";
 import React, { useState } from "react";
-import { MdBlock, MdDone, MdModeEdit } from "react-icons/md";
+import {MdBlock, MdDone, MdModeEdit, MdPlayArrow} from "react-icons/md";
 import { useIncident, useIncidentFutureIncidents } from "@/utils/hooks/useIncidents";
 
 import {
@@ -23,6 +23,7 @@ import {STATUS_ICONS} from "@/app/incidents/statuses";
 import remarkRehype from "remark-rehype";
 import rehypeRaw from "rehype-raw";
 import Markdown from "react-markdown";
+import ManualRunWorkflowModal from "@/app/workflows/manual-run-workflow-modal";
 
 interface Props {
   incident: IncidentDto;
@@ -92,6 +93,9 @@ export default function IncidentInformation({ incident }: Props) {
   const { mutate } = useIncident(incident.id);
   const [isFormOpen, setIsFormOpen] = useState<boolean>(false);
 
+  const [runWorkflowModalIncident, setRunWorkflowModalIncident] =
+    useState<IncidentDto | null>();
+
   const handleCloseForm = () => {
     setIsFormOpen(false);
   };
@@ -104,6 +108,10 @@ export default function IncidentInformation({ incident }: Props) {
     setIsFormOpen(false);
     mutate();
   };
+  const handleRunWorkflow = () => {
+    setRunWorkflowModalIncident(incident);
+    mutate();
+  };
 
   const [changeStatusIncident, setChangeStatusIncident] =
     useState<IncidentDto | null>();
@@ -141,12 +149,26 @@ export default function IncidentInformation({ incident }: Props) {
           <Title className="flex-grow items-center">
             {incident.is_confirmed ? "⚔️ " : "Possible "}Incident
           </Title>
+          <Button
+              color="orange"
+              size="xs"
+              variant="secondary"
+              icon={MdPlayArrow}
+              tooltip="Run Workflow"
+              onClick={(e: React.MouseEvent) => {
+                e.preventDefault();
+                e.stopPropagation();
+                handleRunWorkflow();
+              }}
+            />
           {incident.is_confirmed && (
+
             <Button
               color="orange"
               size="xs"
               variant="secondary"
               icon={MdModeEdit}
+              tooltip="Edit Incident"
               onClick={(e: React.MouseEvent) => {
                 e.preventDefault();
                 e.stopPropagation();
@@ -312,6 +334,10 @@ export default function IncidentInformation({ incident }: Props) {
         mutate={mutate}
         handleClose={() => setChangeStatusIncident(null)}
       />
+      <ManualRunWorkflowModal
+        incident={runWorkflowModalIncident}
+        handleClose={() => setRunWorkflowModalIncident(null)}
+      />
     </div>
   );
 }
diff --git a/keep-ui/app/incidents/incidents-table.tsx b/keep-ui/app/incidents/incidents-table.tsx
index ae1abe5ea..a5cc6b532 100644
--- a/keep-ui/app/incidents/incidents-table.tsx
+++ b/keep-ui/app/incidents/incidents-table.tsx
@@ -11,7 +11,7 @@ import {
 import {
   MdRemoveCircle,
   MdModeEdit,
-  MdKeyboardDoubleArrowRight,
+  MdKeyboardDoubleArrowRight, MdPlayArrow,
 } from "react-icons/md";
 import { useSession } from "next-auth/react";
 import { IncidentDto, PaginatedIncidentsDto } from "./models";
@@ -25,6 +25,8 @@ import {STATUS_ICONS} from "@/app/incidents/statuses";
 import Markdown from "react-markdown";
 import remarkRehype from "remark-rehype";
 import rehypeRaw from "rehype-raw";
+import ManualRunWorkflowModal from "@/app/workflows/manual-run-workflow-modal";
+import {AlertDto} from "@/app/alerts/models";
 
 const columnHelper = createColumnHelper<IncidentDto>();
 
@@ -53,6 +55,8 @@ export default function IncidentsTable({
   });
   const [changeStatusIncident, setChangeStatusIncident] =
     useState<IncidentDto | null>();
+  const [runWorkflowModalIncident, setRunWorkflowModalIncident] =
+    useState<IncidentDto | null>();
 
   const handleChangeStatus = (e: React.MouseEvent, incident: IncidentDto) => {
     e.preventDefault();
@@ -60,6 +64,12 @@ export default function IncidentsTable({
     setChangeStatusIncident(incident);
   };
 
+  const handleRunWorkflow = (e: React.MouseEvent, incident: IncidentDto) => {
+    e.preventDefault();
+    e.stopPropagation();
+    setRunWorkflowModalIncident(incident);
+  }
+
   useEffect(() => {
     if (incidents.limit != pagination.pageSize) {
       setPagination({
@@ -198,6 +208,14 @@ export default function IncidentsTable({
             tooltip="Change status"
             onClick={(e) => handleChangeStatus(e, row.original!)}
           />
+          <Button
+            color="orange"
+            size="xs"
+            variant="secondary"
+            icon={MdPlayArrow}
+            tooltip="Run Workflow"
+            onClick={(e) => handleRunWorkflow(e, row.original!)}
+          />
           <Button
             color="red"
             size="xs"
@@ -248,6 +266,10 @@ export default function IncidentsTable({
         mutate={mutate}
         handleClose={() => setChangeStatusIncident(null)}
       />
+      <ManualRunWorkflowModal
+        incident={runWorkflowModalIncident}
+        handleClose={() => setRunWorkflowModalIncident(null)}
+      />
       <div className="mt-4 mb-8">
         <IncidentPagination table={table} isRefreshAllowed={true} />
       </div>
diff --git a/keep-ui/app/alerts/alert-run-workflow-modal.tsx b/keep-ui/app/workflows/manual-run-workflow-modal.tsx
similarity index 79%
rename from keep-ui/app/alerts/alert-run-workflow-modal.tsx
rename to keep-ui/app/workflows/manual-run-workflow-modal.tsx
index 6ab2fa87a..753dd0baf 100644
--- a/keep-ui/app/alerts/alert-run-workflow-modal.tsx
+++ b/keep-ui/app/workflows/manual-run-workflow-modal.tsx
@@ -1,5 +1,5 @@
-import { Button, Select, SelectItem } from "@tremor/react";
-import { AlertDto } from "./models";
+import {Button, Select, SelectItem, Title} from "@tremor/react";
+
 import Modal from "@/components/ui/Modal";
 import { useWorkflows } from "utils/hooks/useWorkflows";
 import { useState } from "react";
@@ -7,13 +7,16 @@ import { useSession } from "next-auth/react";
 import { getApiURL } from "utils/apiUrl";
 import { toast } from "react-toastify";
 import { useRouter } from "next/navigation";
+import { IncidentDto } from "@/app/incidents/models";
+import { AlertDto } from "@/app/alerts/models";
 
 interface Props {
-  alert: AlertDto | null | undefined;
+  alert?: AlertDto | null | undefined;
+  incident?: IncidentDto | null | undefined;
   handleClose: () => void;
 }
 
-export default function AlertRunWorkflowModal({ alert, handleClose }: Props) {
+export default function ManualRunWorkflowModal({ alert, incident, handleClose }: Props) {
   /**
    *
    */
@@ -25,7 +28,7 @@ export default function AlertRunWorkflowModal({ alert, handleClose }: Props) {
   const router = useRouter();
   const apiUrl = getApiURL();
 
-  const isOpen = !!alert;
+  const isOpen = !!alert || !!incident;
 
   const clearAndClose = () => {
     setSelectedWorkflowId(undefined);
@@ -41,7 +44,7 @@ export default function AlertRunWorkflowModal({ alert, handleClose }: Props) {
           Authorization: `Bearer ${session?.accessToken}`,
           "Content-Type": "application/json",
         },
-        body: JSON.stringify(alert),
+        body: JSON.stringify({"type": alert ? "alert" : "incident", "body": alert ? alert : incident}),
       }
     );
 
@@ -61,6 +64,7 @@ export default function AlertRunWorkflowModal({ alert, handleClose }: Props) {
 
   return (
     <Modal onClose={clearAndClose} isOpen={isOpen} className="overflow-visible">
+      <Title className="mb-1">Select Workflow to run</Title>
       {workflows && (
         <Select
           value={selectedWorkflowId}
diff --git a/keep/api/routes/workflows.py b/keep/api/routes/workflows.py
index 732aeeb1f..d4acac775 100644
--- a/keep/api/routes/workflows.py
+++ b/keep/api/routes/workflows.py
@@ -27,7 +27,7 @@
     get_workflow_by_name,
 )
 from keep.api.core.db import get_workflow_executions as get_workflow_executions_db
-from keep.api.models.alert import AlertDto
+from keep.api.models.alert import AlertDto, IncidentDto
 from keep.api.models.workflow import (
     WorkflowCreateOrUpdateDTO,
     WorkflowDTO,
@@ -181,25 +181,33 @@ def run_workflow(
 
     # Finally, run it
     try:
+
+        if body.get("type", "alert") == "alert":
+            event_class = AlertDto
+        else:
+            event_class = IncidentDto
+
+        event_body = body.get("body", {})
+
         # if its event that was triggered by the UI with the Modal
-        if "test-workflow" in body.get("fingerprint", "") or not body:
+        if "test-workflow" in event_body.get("fingerprint", "") or not body:
             # some random
-            body["id"] = body.get("fingerprint", "manual-run")
-            body["name"] = body.get("fingerprint", "manual-run")
-            body["lastReceived"] = datetime.datetime.now(
+            event_body["id"] = event_body.get("fingerprint", "manual-run")
+            event_body["name"] = event_body.get("fingerprint", "manual-run")
+            event_body["lastReceived"] = datetime.datetime.now(
                 tz=datetime.timezone.utc
             ).isoformat()
-            if "source" in body and not isinstance(body["source"], list):
-                body["source"] = [body["source"]]
+            if "source" in event_body and not isinstance(event_body["source"], list):
+                event_body["source"] = [event_body["source"]]
         try:
-            alert = AlertDto(**body)
+            event = event_class(**event_body)
         except TypeError:
             raise HTTPException(
                 status_code=400,
-                detail="Invalid alert format",
+                detail="Invalid event format",
             )
         workflow_execution_id = workflowmanager.scheduler.handle_manual_event_workflow(
-            workflow_id, tenant_id, created_by, alert
+            workflow_id, tenant_id, created_by, event
         )
     except Exception as e:
         logger.exception(
diff --git a/keep/workflowmanager/workflowscheduler.py b/keep/workflowmanager/workflowscheduler.py
index 93611d3d4..5ed3d139c 100644
--- a/keep/workflowmanager/workflowscheduler.py
+++ b/keep/workflowmanager/workflowscheduler.py
@@ -211,20 +211,30 @@ def run_workflow_wrapper(
         }
 
     def handle_manual_event_workflow(
-        self, workflow_id, tenant_id, triggered_by_user, alert: AlertDto
+        self, workflow_id, tenant_id, triggered_by_user, event: [AlertDto | IncidentDto]
     ):
         self.logger.info(f"Running manual event workflow {workflow_id}...")
         try:
             unique_execution_number = self._get_unique_execution_number()
             self.logger.info(f"Unique execution number: {unique_execution_number}")
+
+            if isinstance(event, IncidentDto):
+                event_id = str(event.id)
+                event_type = "incident"
+                fingerprint = "incident:{}".format(event_id)
+            else:
+                event_id = event.event_id
+                event_type = "alert"
+                fingerprint = event.fingerprint
+
             workflow_execution_id = create_workflow_execution(
                 workflow_id=workflow_id,
                 tenant_id=tenant_id,
                 triggered_by=f"manually by {triggered_by_user}",
                 execution_number=unique_execution_number,
-                fingerprint=alert.fingerprint,
-                event_id=alert.event_id,
-                event_type="alert",
+                fingerprint=fingerprint,
+                event_id=event_id,
+                event_type=event_type,
             )
             self.logger.info(f"Workflow execution id: {workflow_execution_id}")
         # This is kinda WTF exception since create_workflow_execution shouldn't fail for manual
@@ -242,7 +252,7 @@ def handle_manual_event_workflow(
             },
         )
         with self.lock:
-            alert.trigger = "manual"
+            event.trigger = "manual"
             self.workflows_to_run.append(
                 {
                     "workflow_id": workflow_id,
@@ -250,7 +260,8 @@ def handle_manual_event_workflow(
                     "tenant_id": tenant_id,
                     "triggered_by": "manual",
                     "triggered_by_user": triggered_by_user,
-                    "event": alert,
+                    "event": event,
+                    "retry": True,
                 }
             )
         return workflow_execution_id