Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added ApprovalTask Node to the Pipeline Visualization
- Loading branch information
1 parent
d6e2e1e
commit 1f4e00f
Showing
15 changed files
with
706 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
220 changes: 220 additions & 0 deletions
220
...packages/pipelines-plugin/src/components/pipelines/pipeline-topology/ApprovalTaskNode.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| import * as React from 'react'; | ||
| import { Tooltip } from '@patternfly/react-core'; | ||
| import { observer, Node, NodeModel, useHover, createSvgIdUrl } from '@patternfly/react-topology'; | ||
| import * as cx from 'classnames'; | ||
| import * as _ from 'lodash'; | ||
| import { useTranslation } from 'react-i18next'; | ||
| import { Link } from 'react-router-dom-v5-compat'; | ||
| import { | ||
| K8sResourceKind, | ||
| WatchK8sResults, | ||
| getGroupVersionKindForModel, | ||
| } from '@console/dynamic-plugin-sdk/src/lib-core'; | ||
| import { useK8sWatchResources } from '@console/dynamic-plugin-sdk/src/utils/k8s/hooks'; | ||
| import { resourcePathFromModel, truncateMiddle } from '@console/internal/components/utils'; | ||
| import { ApprovalTaskModel, CustomRunModelV1Beta1 } from '@console/pipelines-plugin/src/models'; | ||
| import { pipelineRunFilterReducer } from '@console/pipelines-plugin/src/utils/pipeline-filter-reducer'; | ||
| import { SvgDropShadowFilter } from '@console/topology/src/components/svg'; | ||
| import { | ||
| TaskKind, | ||
| ApprovalTaskKind, | ||
| ApprovalStatus, | ||
| ComputedStatus, | ||
| CustomRunKind, | ||
| CustomRunStatus, | ||
| } from '../../../types'; | ||
| import { getApprovalStatusColor } from '../../../utils/pipeline-augment'; | ||
| import { ApprovalStatusIcon } from '../detail-page-tabs/pipeline-details/StatusIcon'; | ||
| import { TaskNodeModelData } from './types'; | ||
|
|
||
| import './CustomTaskNode.scss'; | ||
|
|
||
| type ApprovalTaskNodeProps = { | ||
| element: Node<NodeModel, TaskNodeModelData>; | ||
| disableTooltip?: boolean; | ||
| }; | ||
|
|
||
| type WatchResource = { | ||
| [key: string]: K8sResourceKind[] | K8sResourceKind; | ||
| }; | ||
|
|
||
| interface ApprovalTaskComponentProps { | ||
| pipelineRunName?: string; | ||
| name: string; | ||
| loaded?: boolean; | ||
| task?: { | ||
| data: TaskKind; | ||
| }; | ||
| status: string; | ||
| namespace: string; | ||
| disableVisualizationTooltip?: boolean; | ||
| width: number; | ||
| height: number; | ||
| customTask?: K8sResourceKind; | ||
| } | ||
|
|
||
| const FILTER_ID = 'SvgTaskDropShadowFilterId'; | ||
|
|
||
| const ApprovalTaskComponent: React.FC<ApprovalTaskComponentProps> = ({ | ||
| pipelineRunName, | ||
| namespace, | ||
| task, | ||
| status, | ||
| name, | ||
| disableVisualizationTooltip, | ||
| width, | ||
| height, | ||
| customTask, | ||
| }) => { | ||
| const { t } = useTranslation(); | ||
| const showStatusState: boolean = !!pipelineRunName; | ||
| const visualName = name || _.get(task, ['metadata', 'name'], ''); | ||
| const nameRef = React.useRef(); | ||
| const pillRef = React.useRef(); | ||
|
|
||
| const path = `${resourcePathFromModel(ApprovalTaskModel, customTask?.metadata?.name, namespace)}`; | ||
|
|
||
| const enableLogLink = status !== ApprovalStatus.Idle && !!path; | ||
| const taskStatusColor = status | ||
| ? getApprovalStatusColor(status).pftoken.value | ||
| : getApprovalStatusColor(ApprovalStatus.Idle).pftoken.value; | ||
|
|
||
| const [hover, hoverRef] = useHover(); | ||
| const truncatedVisualName = React.useMemo( | ||
| () => truncateMiddle(visualName, { length: showStatusState ? 11 : 14, truncateEnd: true }), | ||
| [visualName, showStatusState], | ||
| ); | ||
|
|
||
| const renderVisualName = ( | ||
| <text | ||
| ref={nameRef} | ||
| x={showStatusState ? 30 : width / 2} | ||
| y={height / 2 + 1} | ||
| className={cx('odc-pipeline-vis-task-text', { | ||
| 'is-text-center': !pipelineRunName, | ||
| 'is-linked': enableLogLink, | ||
| })} | ||
| > | ||
| {truncatedVisualName} | ||
| </text> | ||
| ); | ||
|
|
||
| let taskPill = ( | ||
| <g ref={hoverRef}> | ||
| <SvgDropShadowFilter dy={1} id={FILTER_ID} /> | ||
| <rect | ||
| filter={hover ? createSvgIdUrl(FILTER_ID) : ''} | ||
| width={width} | ||
| height={height} | ||
| rx={5} | ||
| className={cx('odc-pipeline-vis-task', { | ||
| 'is-selected': !!pipelineRunName && hover, | ||
| 'is-linked': !!pipelineRunName && enableLogLink, | ||
| })} | ||
| style={{ | ||
| stroke: pipelineRunName | ||
| ? status | ||
| ? getApprovalStatusColor(status).pftoken.value | ||
| : getApprovalStatusColor(ApprovalStatus.Idle).pftoken.value | ||
| : '', | ||
| }} | ||
| /> | ||
| {visualName !== truncatedVisualName && disableVisualizationTooltip ? ( | ||
| <Tooltip triggerRef={nameRef} content={visualName}> | ||
| {renderVisualName} | ||
| </Tooltip> | ||
| ) : ( | ||
| renderVisualName | ||
| )} | ||
|
|
||
| {showStatusState && ( | ||
| <svg | ||
| width={30} | ||
| height={30} | ||
| viewBox="-10 -7 30 30" | ||
| style={{ | ||
| color: taskStatusColor, | ||
| }} | ||
| > | ||
| <ApprovalStatusIcon status={status} /> | ||
| </svg> | ||
| )} | ||
| </g> | ||
| ); | ||
|
|
||
| if (!disableVisualizationTooltip) { | ||
| taskPill = ( | ||
| <Tooltip | ||
| triggerRef={pillRef} | ||
| position="bottom" | ||
| enableFlip={false} | ||
| content={t('pipelines-plugin~Approval Task')} | ||
| > | ||
| <g ref={pillRef}>{taskPill}</g> | ||
| </Tooltip> | ||
| ); | ||
| } | ||
| return ( | ||
| <g className={cx('odc-pipeline-topology__task-node', { 'is-link': enableLogLink })}> | ||
| {enableLogLink ? <Link to={path}>{taskPill}</Link> : taskPill} | ||
| </g> | ||
| ); | ||
| }; | ||
|
|
||
| const ApprovalTaskNode: React.FC<ApprovalTaskNodeProps> = ({ element, disableTooltip }) => { | ||
| const { height, width } = element.getBounds(); | ||
|
|
||
| const { pipeline, pipelineRun, task } = element.getData(); | ||
|
|
||
| const customTaskName = `${pipelineRun?.metadata?.name}-${task?.name}`; | ||
| const pipelineRunStatus = pipelineRun && pipelineRunFilterReducer(pipelineRun); | ||
| let customTaskStatus: string = ''; | ||
|
|
||
| const watchedResources = { | ||
| customRun: { | ||
| groupVersionKind: getGroupVersionKindForModel(CustomRunModelV1Beta1), | ||
| name: customTaskName, | ||
| namespace: pipeline?.metadata?.namespace, | ||
| prop: 'task', | ||
| }, | ||
| approvalTask: { | ||
| groupVersionKind: getGroupVersionKindForModel(ApprovalTaskModel), | ||
| name: customTaskName, | ||
| namespace: pipeline?.metadata?.namespace, | ||
| prop: 'task', | ||
| }, | ||
| }; | ||
|
|
||
| const resourcesData: WatchK8sResults<WatchResource> = useK8sWatchResources<WatchResource>( | ||
| watchedResources, | ||
| ); | ||
|
|
||
| let approvalStatus = (resourcesData?.approvalTask?.data as ApprovalTaskKind)?.status | ||
| ?.approvalState; | ||
| if (pipelineRunStatus === ComputedStatus.Running && !approvalStatus) { | ||
| approvalStatus = ApprovalStatus.Idle; | ||
| } | ||
| if ( | ||
| (resourcesData?.customRun?.data as CustomRunKind)?.spec?.status === CustomRunStatus.RunCancelled | ||
| ) { | ||
| approvalStatus = ApprovalStatus.TimedOut; | ||
| } | ||
| customTaskStatus = approvalStatus; | ||
|
|
||
| const taskComponent: JSX.Element = ( | ||
| <ApprovalTaskComponent | ||
| pipelineRunName={pipelineRun?.metadata?.name} | ||
| name={task.name || ''} | ||
| task={task.taskSpec && { data: { spec: task.taskSpec } }} | ||
| namespace={pipeline?.metadata?.namespace} | ||
| status={customTaskStatus} | ||
| disableVisualizationTooltip={disableTooltip} | ||
| width={width} | ||
| height={height} | ||
| customTask={resourcesData.approvalTask?.data as ApprovalTaskKind} | ||
| /> | ||
| ); | ||
| return taskComponent; | ||
| }; | ||
|
|
||
| export default React.memo(observer(ApprovalTaskNode)); |
37 changes: 37 additions & 0 deletions
37
.../packages/pipelines-plugin/src/components/pipelines/pipeline-topology/CustomTaskNode.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| .odc-pipeline-topology__task-node { | ||
| &.is-link { | ||
| > a:hover { | ||
| text-decoration: none; | ||
| } | ||
| } | ||
| &:focus { | ||
| outline: -webkit-focus-ring-color auto 5px; | ||
| } | ||
| } | ||
|
|
||
| .odc-pipeline-vis-task { | ||
| fill: var(--pf-v5-global--BackgroundColor--light-100); | ||
| stroke-width: 1; | ||
| cursor: default; | ||
|
|
||
| &.is-selected { | ||
| stroke-width: 2; | ||
| } | ||
| &.is-linked { | ||
| cursor: pointer; | ||
| } | ||
| } | ||
|
|
||
| .odc-pipeline-vis-task-text { | ||
| cursor: default; | ||
| dominant-baseline: middle; | ||
| fill: var(--pf-v5-global--Color--100); | ||
| font-size: var(--pf-global--FontSize--sm); | ||
|
|
||
| &.is-text-center { | ||
| text-anchor: middle; | ||
| } | ||
| &.is-linked { | ||
| cursor: pointer; | ||
| } | ||
| } |
Oops, something went wrong.