Skip to content

Make workflow actions more discoverable #2849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
laurakwhit merged 4 commits into from
Aug 8, 2025
Merged

Make workflow actions more discoverable #2849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a434838
Move actions out of SplitButton
laurakwhit Aug 7, 2025
ee44598
Adjust responsiveness of actions
laurakwhit Aug 7, 2025
ab7ad69
Update to svelte 5
laurakwhit Aug 7, 2025
cad9703
Fix tests
laurakwhit Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
302 changes: 169 additions & 133 deletions src/lib/components/workflow-actions.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@
import SignalConfirmationModal from '$lib/components/workflow/client-actions/signal-confirmation-modal.svelte';
import TerminateConfirmationModal from '$lib/components/workflow/client-actions/terminate-confirmation-modal.svelte';
import UpdateConfirmationModal from '$lib/components/workflow/client-actions/update-confirmation-modal.svelte';
import Button from '$lib/holocene/button.svelte';
import { MenuDivider, MenuItem } from '$lib/holocene/menu';
import SplitButton from '$lib/holocene/split-button.svelte';
import MenuButton from '$lib/holocene/menu/menu-button.svelte';
import MenuContainer from '$lib/holocene/menu/menu-container.svelte';
import Menu from '$lib/holocene/menu/menu.svelte';
import { translate } from '$lib/i18n/translate';
import { isCloud } from '$lib/stores/advanced-visibility';
import { coreUserStore } from '$lib/stores/core-user';
Expand All @@ -25,88 +28,97 @@
import { workflowTerminateEnabled } from '$lib/utilities/workflow-terminate-enabled';
import { workflowUpdateEnabled } from '$lib/utilities/workflow-update-enabled';
export let workflow: WorkflowExecution;
export let namespace: string;
export let cancelInProgress: boolean;
export let isRunning: boolean;
export let first: string | undefined = undefined;
export let next: string | undefined = undefined;
interface Props {
workflow: WorkflowExecution;
namespace: string;
cancelInProgress: boolean;
isRunning: boolean;
first?: string;
next?: string;
}
let { workflow, namespace, cancelInProgress, isRunning, first, next }: Props =
$props();
let cancelConfirmationModalOpen = false;
let terminateConfirmationModalOpen = false;
let resetConfirmationModalOpen = false;
let signalConfirmationModalOpen = false;
let updateConfirmationModalOpen = false;
let cancelConfirmationModalOpen = $state(false);
let terminateConfirmationModalOpen = $state(false);
let resetConfirmationModalOpen = $state(false);
let signalConfirmationModalOpen = $state(false);
let updateConfirmationModalOpen = $state(false);
let resetDescription: string;
let coreUser = coreUserStore();
$: cancelEnabled = workflowCancelEnabled(
$page.data.settings,
$coreUser,
namespace,
let cancelEnabled = $derived(
workflowCancelEnabled($page.data.settings, $coreUser, namespace),
);
$: signalEnabled = workflowSignalEnabled(
$page.data.settings,
$coreUser,
namespace,
let signalEnabled = $derived(
workflowSignalEnabled($page.data.settings, $coreUser, namespace),
);
$: updateEnabled = workflowUpdateEnabled(
$page.data.settings,
$coreUser,
namespace,
let updateEnabled = $derived(
workflowUpdateEnabled($page.data.settings, $coreUser, namespace),
);
$: terminateEnabled = workflowTerminateEnabled(
$page.data.settings,
$coreUser,
namespace,
let terminateEnabled = $derived(
workflowTerminateEnabled($page.data.settings, $coreUser, namespace),
);
$: resetAuthorized = workflowResetEnabled(
$page.data.settings,
$coreUser,
namespace,
let resetAuthorized = $derived(
workflowResetEnabled($page.data.settings, $coreUser, namespace),
);
// https://github.com/temporalio/temporal/releases/tag/v1.27.1
$: canResetWithPendingChildWorkflows =
let canResetWithPendingChildWorkflows = $derived(
minimumVersionRequired('1.27.1', $temporalVersion) ||
$isCloud ||
workflow.pendingChildren.length === 0;
$isCloud ||
workflow.pendingChildren.length === 0,
);
$: resetEnabled =
let resetEnabled = $derived(
resetAuthorized &&
canResetWithPendingChildWorkflows &&
$resetEvents.length > 0;
$: actionsDisabled = !resetEnabled && !signalEnabled && !terminateEnabled;
let workflowActions: {
label: string;
onClick: () => void;
enabled: boolean;
testId: string;
destructive?: boolean;
description?: string;
}[];
canResetWithPendingChildWorkflows &&
$resetEvents.length > 0,
);
let actionsDisabled = $derived(
!resetEnabled && !signalEnabled && !terminateEnabled,
);
$: {
const getResetDescription = ({
resetAuthorized,
canResetWithPendingChildWorkflows,
resetEvents,
}) => {
if (!resetAuthorized) {
resetDescription = translate('workflows.reset-disabled-unauthorized');
return translate('workflows.reset-disabled-unauthorized');
} else if (resetAuthorized && !canResetWithPendingChildWorkflows) {
resetDescription = translate('workflows.reset-disabled-pending-children');
return translate('workflows.reset-disabled-pending-children');
} else if (
resetAuthorized &&
canResetWithPendingChildWorkflows &&
$resetEvents.length === 0
resetEvents.length === 0
) {
resetDescription = translate('workflows.reset-disabled-no-events');
return translate('workflows.reset-disabled-no-events');
}
}
return '';
};
let resetDescription = $derived(
getResetDescription({
resetAuthorized,
canResetWithPendingChildWorkflows,
resetEvents: $resetEvents,
}),
);
$: workflowActions = [
let workflowActions: {
label: string;
onClick: () => void;
enabled: boolean;
testId: string;
destructive?: boolean;
description?: string;
}[] = $derived([
{
label: translate('workflows.reset'),
onClick: () => (resetConfirmationModalOpen = true),
Expand Down Expand Up @@ -138,89 +150,113 @@
? ''
: translate('workflows.terminate-disabled'),
},
];
]);
</script>

{#if isRunning}
<SplitButton
id="workflow-actions"
menuClass="w-[16rem] md:w-[24rem]"
position="right"
disabled={actionsDisabled}
primaryActionDisabled={!cancelEnabled || cancelInProgress}
on:click={() => (cancelConfirmationModalOpen = true)}
label={translate('workflows.request-cancellation')}
menuLabel={translate('workflows.workflow-actions')}
>
{#each workflowActions as { onClick, destructive, label, enabled, testId, description }}
{#if destructive}
<MenuDivider />
{/if}
<MenuItem
on:click={onClick}
{destructive}
disabled={!enabled}
data-testid={testId}
{description}
<div class="flex items-center gap-2">
{#if isRunning}
<Button
on:click={() => (cancelConfirmationModalOpen = true)}
disabled={!cancelEnabled || cancelInProgress}
size="sm"
>
{translate('workflows.request-cancellation')}
</Button>
<MenuContainer>
<MenuButton
disabled={actionsDisabled}
hasIndicator
controls="workflow-actions"
variant="secondary"
size="sm"
>
{label}
</MenuItem>
{/each}
{#if !workflowCreateDisabled($page)}
<MenuDivider />
<MenuItem
on:click={() =>
goto(
routeForWorkflowStart({
namespace,
workflowId: workflow.id,
taskQueue: workflow.taskQueue,
workflowType: workflow.name,
}),
)}
data-testid="start-workflow-button"
{translate('workflows.more-actions')}
</MenuButton>
<Menu
id="workflow-actions"
position="right"
class="w-[16rem] md:w-[24rem]"
>
{translate('workflows.start-workflow-like-this-one')}
</MenuItem>
{/if}
</SplitButton>
{:else}
<SplitButton
id="workflow-actions"
menuClass="w-[16rem]"
position="right"
primaryActionDisabled={!resetEnabled}
on:click={() => (resetConfirmationModalOpen = true)}
label={translate('workflows.reset')}
menuLabel={translate('workflows.workflow-actions')}
>
<MenuItem
on:click={() =>
goto(
routeForWorkflowStart({
namespace,
workflowId: workflow.id,
taskQueue: workflow.taskQueue,
workflowType: workflow.name,
}),
)}
disabled={workflowCreateDisabled($page)}
data-testid="start-workflow-button"
{#each workflowActions as { onClick, destructive, label, enabled, testId, description }}
{#if destructive}
<MenuDivider />
{/if}
<MenuItem
on:click={onClick}
{destructive}
disabled={!enabled}
data-testid={testId}
{description}
>
{label}
</MenuItem>
{/each}
{#if !workflowCreateDisabled($page)}
<MenuDivider />
<MenuItem
on:click={() =>
goto(
routeForWorkflowStart({
namespace,
workflowId: workflow.id,
taskQueue: workflow.taskQueue,
workflowType: workflow.name,
}),
)}
data-testid="start-workflow-button"
>
{translate('workflows.start-workflow-like-this-one')}
</MenuItem>
{/if}
</Menu>
</MenuContainer>
{:else}
<Button
on:click={() => (resetConfirmationModalOpen = true)}
disabled={!resetEnabled}
size="sm"
>
{translate('workflows.start-workflow-like-this-one')}
</MenuItem>
{#if terminateEnabled && next}
<MenuDivider />
<MenuItem
on:click={() => (terminateConfirmationModalOpen = true)}
data-testid="terminate-button"
destructive
{translate('workflows.reset')}
</Button>
<MenuContainer>
<MenuButton
hasIndicator
controls="workflow-actions"
variant="secondary"
size="sm"
>
{translate('workflows.terminate-latest')}
</MenuItem>
{/if}
</SplitButton>
{/if}
{translate('workflows.more-actions')}
</MenuButton>
<Menu id="workflow-actions" position="right" class="w-[16rem]">
<MenuItem
on:click={() =>
goto(
routeForWorkflowStart({
namespace,
workflowId: workflow.id,
taskQueue: workflow.taskQueue,
workflowType: workflow.name,
}),
)}
disabled={workflowCreateDisabled($page)}
data-testid="start-workflow-button"
>
{translate('workflows.start-workflow-like-this-one')}
</MenuItem>
{#if terminateEnabled && next}
<MenuDivider />
<MenuItem
on:click={() => (terminateConfirmationModalOpen = true)}
data-testid="terminate-button"
destructive
>
{translate('workflows.terminate-latest')}
</MenuItem>
{/if}
</Menu>
</MenuContainer>
{/if}
</div>
Copy link
Contributor

@andrewzamojc andrewzamojc Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment: Although at first the components seemed repeated, the items are so different. I like the isRunning separation for around the whole thing.


{#if resetEnabled}
<ResetConfirmationModal
Expand Down
1 change: 1 addition & 0 deletions src/lib/i18n/locales/en/workflows.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ export const Strings = {
json: 'JSON',
download: 'Download',
'workflow-actions': 'Workflow Actions',
'more-actions': 'More Actions',
'reset-disabled-unauthorized':
'Resetting workflows is not enabled, please contact your administrator for assistance.',
'reset-disabled-pending-children':
Expand Down
10 changes: 5 additions & 5 deletions src/lib/layouts/workflow-header.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,15 @@
</div>
</div>
<header class="flex flex-col gap-4">
<div class="flex flex-col items-center justify-between gap-4 lg:flex-row">
<div class="flex flex-col items-center justify-between gap-4 xl:flex-row">
<div
class="flex w-full flex-col items-start gap-4 lg:flex-row lg:items-center"
class="flex w-full flex-col items-start gap-4 xl:flex-row xl:items-center"
>
<div
class="flex flex-wrap items-center justify-between gap-4 max-lg:w-full"
class="flex flex-wrap items-center justify-between gap-4 max-xl:w-full"
>
<WorkflowStatus status={workflow?.status} big />
<div class="lg:hidden">
<div class="xl:hidden">
<WorkflowActions
{isRunning}
{cancelInProgress}
Expand All @@ -137,7 +137,7 @@
</h1>
</div>
</div>
<div class="max-lg:hidden">
<div class="max-xl:hidden">
<WorkflowActions
{isRunning}
{cancelInProgress}
Expand Down
Loading
Loading