Skip to content
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

feat(ui): Retry a single workflow step manually #13343

Merged
merged 2 commits into from
Oct 8, 2024
Merged

feat(ui): Retry a single workflow step manually #13343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
784f871
feat: add node retry
Adrien-D Jul 15, 2024
c229a2a
fix: retry node field selector and typo
Adrien-D Jul 29, 2024
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
100 changes: 100 additions & 0 deletions ui/src/app/workflows/components/retry-workflow-node-panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import {Checkbox} from 'argo-ui/src/components/checkbox';
import {Tooltip} from 'argo-ui/src/components/tooltip/tooltip';
import React, {useState} from 'react';

import {Parameter, RetryOpts, Workflow} from '../../../models';
import {ParametersInput} from '../../shared/components/parameters-input';
import {services} from '../../shared/services';
import {Utils} from '../../shared/utils';
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
import {ErrorNotice} from '../../shared/components/error-notice';

interface Props {
nodeId: string;
workflow: Workflow;
isArchived: boolean;
isWorkflowInCluster: boolean;
onRetrySuccess: () => void;
}

export function RetryWorkflowNode(props: Props) {
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
const [overrideParameters, setOverrideParameters] = useState(false);
const [restartSuccessful, setRestartSuccessful] = useState(false);
const [workflowParameters, setWorkflowParameters] = useState<Parameter[]>(JSON.parse(JSON.stringify(props.workflow.spec.arguments.parameters || [])));
const [error, setError] = useState<Error>();

async function submit() {
const parameters: RetryOpts['parameters'] = overrideParameters
? [...workflowParameters.filter(p => Utils.getValueFromParameter(p) !== undefined).map(p => p.name + '=' + Utils.getValueFromParameter(p))]
: [];
const opts: RetryOpts = {
parameters,
restartSuccessful,
nodeFieldSelector: `id=${props.nodeId}`
};

try {
props.isArchived && !props.isWorkflowInCluster
? await services.workflows.retryArchived(props.workflow.metadata.uid, props.workflow.metadata.namespace, opts)
: await services.workflows.retry(props.workflow.metadata.name, props.workflow.metadata.namespace, opts);
props.onRetrySuccess();
} catch (err) {
setError(err);
}
}

return (
<div style={{padding: 16}}>
<h4>Retry Node</h4>
<h5>
{props.workflow.metadata.namespace}/{props.nodeId}
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
</h5>

<p>Note: Retrying this node will re-execute this node and all downstream nodes.</p>

{error && <ErrorNotice error={error} />}
<div className='white-box'>
{/* Override Parameters */}
<div key='override-parameters' style={{marginBottom: 25}}>
<label>Override Parameters</label>
<div className='columns small-9'>
<Checkbox checked={overrideParameters} onChange={setOverrideParameters} />
</div>
</div>

{overrideParameters && (
<div key='parameters' style={{marginBottom: 25}}>
<label>Parameters</label>
{workflowParameters.length > 0 ? (
<ParametersInput parameters={workflowParameters} onChange={setWorkflowParameters} />
) : (
<>
<br />
<label>No parameters</label>
</>
)}
</div>
)}

{/* Restart Successful */}
<div key='restart-successful' style={{marginBottom: 25}}>
<label>
Restart Successful{' '}
<Tooltip content='Leaving this box unchecked avoids re-running nodes that have run successfully before'>
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
<i className='fa fa-question-circle' style={{marginLeft: 4}} />
</Tooltip>
</label>
<div className='columns small-9'>
<Checkbox checked={restartSuccessful} onChange={setRestartSuccessful} />
</div>
</div>

{/* Retry button */}
<div key='retry'>
<button onClick={submit} className='argo-button argo-button--base'>
<i className='fa fa-undo-alt' /> Retry
</button>
</div>
</div>
</div>
);
}
25 changes: 23 additions & 2 deletions ui/src/app/workflows/components/workflow-details/workflow-details.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ import {SuspendInputs} from './suspend-inputs';
import {WorkflowResourcePanel} from './workflow-resource-panel';

import './workflow-details.scss';
import {RetryWorkflowNode} from '../retry-workflow-node-panel';
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

function parseSidePanelParam(param: string) {
const [type, nodeId, container] = (param || '').split(':');
Expand Down Expand Up @@ -102,6 +103,7 @@ export function WorkflowDetails({history, location, match}: RouteComponentProps<
const [nodeId, setNodeId] = useState(queryParams.get('nodeId'));
const [nodePanelView, setNodePanelView] = useState(queryParams.get('nodePanelView'));
const [sidePanel, setSidePanel] = useState(queryParams.get('sidePanel'));
const [showRetryNode, setShowRetryNode] = useState<boolean>();
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
const [parameters, setParameters] = useState<Parameter[]>([]);
const sidePanelRef = useRef<HTMLDivElement>(null);
const [workflow, setWorkflow] = useState<Workflow>();
Expand Down Expand Up @@ -527,11 +529,29 @@ export function WorkflowDetails({history, location, match}: RouteComponentProps<
transition: isSidePanelAnimating ? `width ${ANIMATION_MS}ms` : 'unset',
width: isSidePanelExpanded ? `${sidePanelWidth}px` : 0
}}>
<button className='workflow-details__step-info-close' onClick={() => setNodeId(null)}>
<button
className='workflow-details__step-info-close'
onClick={() => {
if (showRetryNode) {
setShowRetryNode(false);
} else {
setNodeId(null);
}
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
}}>
<i className='argo-icon-close' />
</button>

<div className='workflow-details__step-info-drag-handle' {...sidePanelDragHandleProps} />
{selectedNode && (
{selectedNode && showRetryNode && (
<RetryWorkflowNode
nodeId={selectedNode.id}
workflow={workflow}
isArchived={isArchivedWorkflow(workflow)}
isWorkflowInCluster={isWorkflowInCluster(workflow)}
onRetrySuccess={() => setShowRetryNode(false)}
/>
)}
{selectedNode && !showRetryNode && (
<WorkflowNodeInfo
node={selectedNode}
onTabSelected={setNodePanelView}
Expand All @@ -541,6 +561,7 @@ export function WorkflowDetails({history, location, match}: RouteComponentProps<
onShowContainerLogs={(x, container) => setSidePanel(`logs:${x}:${container}`)}
onShowEvents={() => setSidePanel(`events:${nodeId}`)}
onShowYaml={() => setSidePanel(`yaml:${nodeId}`)}
onRetryNode={() => setShowRetryNode(true)}
archived={archived}
onResume={() => renderResumePopup()}
/>
Expand Down
7 changes: 7 additions & 0 deletions ui/src/app/workflows/components/workflow-node-info/workflow-node-info.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ interface Props {
onTabSelected?: (tabSelected: string) => void;
selectedTabKey?: string;
onResume?: () => void;
onRetryNode?: () => void;
}

const AttributeRow = (attr: {title: string; value: any}) => (
Expand Down Expand Up @@ -177,6 +178,7 @@ function WorkflowNodeSummary(props: Props) {
});
}
const showLogs = (x = 'main') => props.onShowContainerLogs(props.node.id, x);

return (
<div className='white-box'>
<div className='white-box__details' style={{paddingBottom: '8px'}}>
Expand All @@ -193,6 +195,11 @@ function WorkflowNodeSummary(props: Props) {
MANIFEST
</Button>
)}{' '}
{props.onRetryNode && ['Succeeded', 'Failed'].includes(props.node.phase) && (
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
<Button icon='undo-alt' onClick={() => props.onRetryNode()}>
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
RETRY NODE
</Button>
)}{' '}
{props.node.type === 'Pod' && props.onShowContainerLogs && (
<Button onClick={() => showLogs()} icon='bars'>
LOGS
Expand Down
Loading