From b320645459741a1adb0eb99cb40a899ca1bfb5a9 Mon Sep 17 00:00:00 2001
From: Laura Whitaker <laura.whitaker@temporal.io>
Date: Fri, 2 Jun 2023 13:17:48 -0600
Subject: [PATCH] [DT-1051] Add identity and reason to Terminate in the UI
 (#1399)

* Fix extra space if there is no user defined reason

* Add Web UI reason to terminate and reset on workflow

* Add identity to terminate workflow

* Remove workflow and use workflows namespace instead

* Refactor reason and placeholder into utils with tests

* Fix batch cancel toast translation

* Add identity to terminateWorkflows
---
 src/lib/components/workflow-actions.svelte    |  16 ++-
 .../batch-operation-confirmation-modal.svelte |  34 +-----
 src/lib/i18n/locales/en/workflows.ts          |   7 +-
 src/lib/models/workflow-actions.ts            |   6 +
 .../pages/workflows-with-new-search.svelte    |   5 +-
 src/lib/services/batch-service.ts             |   4 +-
 src/lib/services/workflow-service.ts          |   7 +-
 src/lib/utilities/workflow-actions.test.ts    | 112 ++++++++++++++++++
 src/lib/utilities/workflow-actions.ts         |  50 ++++++++
 static/i18n/locales/en/workflows.json         |   7 +-
 10 files changed, 207 insertions(+), 41 deletions(-)
 create mode 100644 src/lib/utilities/workflow-actions.test.ts
 create mode 100644 src/lib/utilities/workflow-actions.ts

diff --git a/src/lib/components/workflow-actions.svelte b/src/lib/components/workflow-actions.svelte
index c3918bd18..eaefb5837 100644
--- a/src/lib/components/workflow-actions.svelte
+++ b/src/lib/components/workflow-actions.svelte
@@ -5,7 +5,10 @@
     signalWorkflow,
     terminateWorkflow,
   } from '$lib/services/workflow-service';
+  import { authUser } from '$lib/stores/auth-user';
 
+  import { formatReason } from '$lib/utilities/workflow-actions';
+  import { Action } from '$lib/models/workflow-actions';
   import { writeActionsAreAllowed } from '$lib/utilities/write-actions-are-allowed';
   import { ResetReapplyType } from '$lib/models/workflow-actions';
 
@@ -90,7 +93,12 @@
     terminateWorkflow({
       workflow,
       namespace,
-      reason,
+      reason: formatReason({
+        action: Action.Terminate,
+        reason,
+        email: $authUser.email,
+      }),
+      identity: $authUser.email,
     })
       .then(handleSuccessfulTermination)
       .catch(handleTerminationError);
@@ -153,7 +161,11 @@
         workflowId: workflow.id,
         runId: workflow.runId,
         eventId: resetId,
-        reason: resetReason,
+        reason: formatReason({
+          action: Action.Reset,
+          reason: resetReason,
+          email: $authUser.email,
+        }),
         resetReapplyType,
       });
 
diff --git a/src/lib/components/workflow/batch-operation-confirmation-modal.svelte b/src/lib/components/workflow/batch-operation-confirmation-modal.svelte
index ce001c7af..aac326838 100644
--- a/src/lib/components/workflow/batch-operation-confirmation-modal.svelte
+++ b/src/lib/components/workflow/batch-operation-confirmation-modal.svelte
@@ -1,10 +1,3 @@
-<script lang="ts" context="module">
-  export enum Action {
-    Terminate,
-    Cancel,
-  }
-</script>
-
 <script lang="ts">
   import { createEventDispatcher } from 'svelte';
   import Modal from '$lib/holocene/modal.svelte';
@@ -13,6 +6,8 @@
   import { allSelected } from '$lib/pages/workflows-with-new-search.svelte';
   import { translate } from '$lib/i18n/translate';
   import Translate from '$lib/i18n/translate.svelte';
+  import { formatReason, getPlacholder } from '$lib/utilities/workflow-actions';
+  import { Action } from '$lib/models/workflow-actions';
 
   export let action: Action;
   export let actionableWorkflowsLength: number;
@@ -32,31 +27,14 @@
       ? translate('workflows', 'cancel')
       : translate('workflows', 'terminate');
 
-  $: pastTenseActionText =
-    action === Action.Cancel
-      ? translate('workflows', 'canceled')
-      : translate('workflows', 'terminated');
+  $: placeholder = getPlacholder(action, $authUser.email);
 
-  let placeholder: string;
-  $: {
-    if ($authUser.email) {
-      placeholder = translate(
-        'workflows',
-        'batch-operation-confirmation-placeholder-by-email',
-        { action: pastTenseActionText, email: $authUser.email },
-      );
-    } else {
-      placeholder = translate(
-        'workflows',
-        'batch-operation-confirmation-placeholder',
-        { action: pastTenseActionText },
-      );
-    }
-  }
   let reason: string = '';
 
   const handleConfirmModal = () => {
-    dispatch('confirm', { reason: [reason.trim(), placeholder].join(' ') });
+    dispatch('confirm', {
+      reason: formatReason({ action, reason, email: $authUser.email }),
+    });
   };
 
   const handleCancelModal = () => {
diff --git a/src/lib/i18n/locales/en/workflows.ts b/src/lib/i18n/locales/en/workflows.ts
index 6ad7edc22..5e9e40de0 100644
--- a/src/lib/i18n/locales/en/workflows.ts
+++ b/src/lib/i18n/locales/en/workflows.ts
@@ -10,8 +10,8 @@ export const Strings = {
   cancel: 'Cancel',
   reason: 'Reason',
   'batch-operation-modal-title': '{{action}} Workflows',
-  'batch-operation-confirmation-placeholder': '{{action}} from the Web UI',
-  'batch-operation-confirmation-placeholder-by-email':
+  'workflow-action-reason-placeholder': '{{action}} from the Web UI',
+  'workflow-action-reason-placeholder-with-email':
     '{{action}} from the Web UI by {{email}}',
   'batch-operation-confirmation-all':
     'Are you sure you want to {{action}} all workflows matching the following query? This action cannot be undone.',
@@ -32,7 +32,7 @@ export const Strings = {
   'batch-cancel-all-success':
     'The batch $t(cancel) request is processing in the background.',
   'batch-terminate-success': 'Successfully $t(terminated) {{count}} workflows.',
-  'batch-cancel-success': 'Successfully $(canceled) {{count}} workflows.',
+  'batch-cancel-success': 'Successfully $t(canceled) {{count}} workflows.',
   'configure-workflows': 'Configure Workflow List',
   'configure-workflows-description':
     'Add (<1></1>), re-arrange (<2></2>), and remove (<3></3>), Workflow Headings to personalize the Workflow List Table.',
@@ -46,6 +46,7 @@ export const Strings = {
   terminated: 'Terminated',
   canceled: 'Canceled',
   paused: 'Paused',
+  reset: 'Reset',
   'n-selected': '{{count, number}} selected',
   'all-selected': 'All {{count, number}} selected.',
   'select-all': 'select all {{count, number}}',
diff --git a/src/lib/models/workflow-actions.ts b/src/lib/models/workflow-actions.ts
index fab0df901..128859d75 100644
--- a/src/lib/models/workflow-actions.ts
+++ b/src/lib/models/workflow-actions.ts
@@ -3,3 +3,9 @@ export enum ResetReapplyType {
   Signal = 1,
   None = 2,
 }
+
+export enum Action {
+  Cancel,
+  Reset,
+  Terminate,
+}
diff --git a/src/lib/pages/workflows-with-new-search.svelte b/src/lib/pages/workflows-with-new-search.svelte
index 67d758a0b..e1e788334 100644
--- a/src/lib/pages/workflows-with-new-search.svelte
+++ b/src/lib/pages/workflows-with-new-search.svelte
@@ -77,9 +77,8 @@
     bulkTerminateByIDs,
   } from '$lib/services/batch-service';
   import { updateQueryParameters } from '$lib/utilities/update-query-parameters';
-  import BatchOperationConfirmationModal, {
-    Action,
-  } from '$lib/components/workflow/batch-operation-confirmation-modal.svelte';
+  import BatchOperationConfirmationModal from '$lib/components/workflow/batch-operation-confirmation-modal.svelte';
+  import { Action } from '$lib/models/workflow-actions';
   import { supportsAdvancedVisibility } from '$lib/stores/advanced-visibility';
   import { toaster } from '$lib/stores/toaster';
   import WorkflowsSummaryConfigurableTable from '$lib/components/workflow/workflows-summary-configurable-table.svelte';
diff --git a/src/lib/services/batch-service.ts b/src/lib/services/batch-service.ts
index 3524234b4..8b4f2710e 100644
--- a/src/lib/services/batch-service.ts
+++ b/src/lib/services/batch-service.ts
@@ -5,6 +5,7 @@ import { requestFromAPI } from '$lib/utilities/request-from-api';
 import { routeForApi } from '$lib/utilities/route-for-api';
 import { isVersionNewer } from '$lib/utilities/version-check';
 import { temporalVersion } from '$lib/stores/versions';
+import { getAuthUser } from '$lib/stores/auth-user';
 
 import type {
   StartBatchOperationRequest,
@@ -152,12 +153,13 @@ async function terminateWorkflows({
 }: CreateBatchOperationOptions): Promise<string> {
   const route = routeForApi('batch-operations', { namespace });
   const jobId = uuidv4();
+  const identity = getAuthUser().email;
 
   const body: StartBatchOperationRequest = {
     jobId,
     namespace,
     reason,
-    terminationOperation: {},
+    terminationOperation: { ...(identity && { identity }) },
     ...(query && { visibilityQuery: query }),
     ...(executions && { executions }),
   };
diff --git a/src/lib/services/workflow-service.ts b/src/lib/services/workflow-service.ts
index 5a2d0ff3e..ae02fd474 100644
--- a/src/lib/services/workflow-service.ts
+++ b/src/lib/services/workflow-service.ts
@@ -60,6 +60,7 @@ type TerminateWorkflowOptions = {
   workflow: WorkflowExecution;
   namespace: string;
   reason: string;
+  identity?: string;
 };
 
 export type ResetWorkflowOptions = {
@@ -244,6 +245,7 @@ export async function terminateWorkflow({
   workflow,
   namespace,
   reason,
+  identity,
 }: TerminateWorkflowOptions): Promise<null> {
   const route = routeForApi('workflow.terminate', {
     namespace,
@@ -251,7 +253,10 @@ export async function terminateWorkflow({
     runId: workflow.runId,
   });
   return await requestFromAPI<null>(route, {
-    options: { method: 'POST', body: stringifyWithBigInt({ reason }) },
+    options: {
+      method: 'POST',
+      body: stringifyWithBigInt({ reason, ...(identity && { identity }) }),
+    },
     notifyOnError: false,
   });
 }
diff --git a/src/lib/utilities/workflow-actions.test.ts b/src/lib/utilities/workflow-actions.test.ts
new file mode 100644
index 000000000..56e6909b5
--- /dev/null
+++ b/src/lib/utilities/workflow-actions.test.ts
@@ -0,0 +1,112 @@
+import { describe, it, expect } from 'vitest';
+import { Action } from '../models/workflow-actions';
+import { getPlacholder, formatReason } from './workflow-actions';
+
+describe('getPlacholder', () => {
+  describe('without an authorized user', () => {
+    it('should return the correct placeholder', () => {
+      expect(getPlacholder(Action.Cancel)).toEqual('Canceled from the Web UI');
+      expect(getPlacholder(Action.Reset)).toEqual('Reset from the Web UI');
+      expect(getPlacholder(Action.Terminate)).toEqual(
+        'Terminated from the Web UI',
+      );
+    });
+  });
+
+  describe('with authorized user', () => {
+    it('should return the correct placeholder', () => {
+      expect(getPlacholder(Action.Cancel, 'test@temporal.io')).toEqual(
+        'Canceled from the Web UI by test@temporal.io',
+      );
+      expect(getPlacholder(Action.Reset, 'test@temporal.io')).toEqual(
+        'Reset from the Web UI by test@temporal.io',
+      );
+      expect(getPlacholder(Action.Terminate, 'test@temporal.io')).toEqual(
+        'Terminated from the Web UI by test@temporal.io',
+      );
+    });
+  });
+});
+
+describe('formatReason', () => {
+  describe('without an authorized user', () => {
+    it('should return the reason with the placeholder', () => {
+      expect(
+        formatReason({ action: Action.Cancel, reason: 'Testing' }),
+      ).toEqual('Testing Canceled from the Web UI');
+      expect(formatReason({ action: Action.Reset, reason: 'Testing' })).toEqual(
+        'Testing Reset from the Web UI',
+      );
+      expect(
+        formatReason({ action: Action.Terminate, reason: 'Testing' }),
+      ).toEqual('Testing Terminated from the Web UI');
+    });
+  });
+
+  it('should return the placeholder if there is no reason', () => {
+    const reason = '';
+    expect(formatReason({ action: Action.Cancel, reason })).toEqual(
+      'Canceled from the Web UI',
+    );
+    expect(formatReason({ action: Action.Reset, reason })).toEqual(
+      'Reset from the Web UI',
+    );
+    expect(formatReason({ action: Action.Terminate, reason })).toEqual(
+      'Terminated from the Web UI',
+    );
+  });
+
+  describe('with an authorized user', () => {
+    it('should return the reason with the placeholder', () => {
+      const reason = 'Testing';
+
+      expect(
+        formatReason({
+          action: Action.Cancel,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Testing Canceled from the Web UI by test@temporal.io');
+      expect(
+        formatReason({
+          action: Action.Reset,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Testing Reset from the Web UI by test@temporal.io');
+      expect(
+        formatReason({
+          action: Action.Terminate,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Testing Terminated from the Web UI by test@temporal.io');
+    });
+
+    it('should return the placeholder if there is no reason', () => {
+      const reason = '';
+
+      expect(
+        formatReason({
+          action: Action.Cancel,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Canceled from the Web UI by test@temporal.io');
+      expect(
+        formatReason({
+          action: Action.Reset,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Reset from the Web UI by test@temporal.io');
+      expect(
+        formatReason({
+          action: Action.Terminate,
+          reason,
+          email: 'test@temporal.io',
+        }),
+      ).toEqual('Terminated from the Web UI by test@temporal.io');
+    });
+  });
+});
diff --git a/src/lib/utilities/workflow-actions.ts b/src/lib/utilities/workflow-actions.ts
new file mode 100644
index 000000000..16eb1d167
--- /dev/null
+++ b/src/lib/utilities/workflow-actions.ts
@@ -0,0 +1,50 @@
+import { translate } from '$lib/i18n/translate';
+import { Action } from '$lib/models/workflow-actions';
+
+type PastActionText = 'terminated' | 'reset' | 'canceled';
+
+function unhandledAction(action: never) {
+  console.error('Unhandled action:', action);
+}
+
+const getPastTenseActionText = (action: Action): PastActionText => {
+  switch (action) {
+    case Action.Cancel:
+      return 'canceled';
+    case Action.Reset:
+      return 'reset';
+    case Action.Terminate:
+      return 'terminated';
+    default:
+      unhandledAction(action);
+  }
+};
+
+export const getPlacholder = (action: Action, email?: string): string => {
+  const translatedAction = translate(
+    'workflows',
+    getPastTenseActionText(action),
+  );
+
+  return email
+    ? translate('workflows', 'workflow-action-reason-placeholder-with-email', {
+        action: translatedAction,
+        email,
+      })
+    : translate('workflows', 'workflow-action-reason-placeholder', {
+        action: translatedAction,
+      });
+};
+
+export const formatReason = ({
+  action,
+  reason,
+  email,
+}: {
+  action: Action;
+  reason: string;
+  email?: string;
+}) => {
+  const placeholder = getPlacholder(action, email);
+  return reason ? [reason.trim(), placeholder].join(' ') : placeholder;
+};
diff --git a/static/i18n/locales/en/workflows.json b/static/i18n/locales/en/workflows.json
index c0fae68d9..2ceadc3ac 100644
--- a/static/i18n/locales/en/workflows.json
+++ b/static/i18n/locales/en/workflows.json
@@ -7,8 +7,8 @@
   "cancel": "Cancel",
   "reason": "Reason",
   "batch-operation-modal-title": "{{action}} Workflows",
-  "batch-operation-confirmation-placeholder": "{{action}} from the Web UI",
-  "batch-operation-confirmation-placeholder-by-email": "{{action}} from the Web UI by {{email}}",
+  "workflow-action-reason-placeholder": "{{action}} from the Web UI",
+  "workflow-action-reason-placeholder-with-email": "{{action}} from the Web UI by {{email}}",
   "batch-operation-confirmation-all": "Are you sure you want to {{action}} all workflows matching the following query? This action cannot be undone.",
   "batch-operation-count-disclaimer": "Note: The actual count of workflows that will be affected is the total number of running workflows matching this query at the time of clicking \"{{action}}\".",
   "batch-cancel-confirmation_one": "Are you sure you want to cancel {{count, number}} running workflow?",
@@ -19,7 +19,7 @@
   "batch-terminate-all-success": "The batch $t(terminate) request is processing in the background.",
   "batch-cancel-all-success": "The batch $t(cancel) request is processing in the background.",
   "batch-terminate-success": "Successfully $t(terminated) {{count}} workflows.",
-  "batch-cancel-success": "Successfully $(canceled) {{count}} workflows.",
+  "batch-cancel-success": "Successfully $t(canceled) {{count}} workflows.",
   "configure-workflows": "Configure Workflow List",
   "configure-workflows-description": "Add (<1></1>), re-arrange (<2></2>), and remove (<3></3>), Workflow Headings to personalize the Workflow List Table.",
   "all-statuses": "All Statuses",
@@ -32,6 +32,7 @@
   "terminated": "Terminated",
   "canceled": "Canceled",
   "paused": "Paused",
+  "reset": "Reset",
   "n-selected": "{{count, number}} selected",
   "all-selected": "All {{count, number}} selected.",
   "select-all": "select all {{count, number}}",