Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 6x 6x 6x 6x 6x 6x 6x 6x 6x 1x 1x 6x 6x 6x 6x 6x 1x 5x 5x 5x 25x | /*
* Copyright 2022 Harness Inc. All rights reserved.
* Use of this source code is governed by the PolyForm Shield 1.0.0 license
* that can be found in the licenses directory at the root of this repository, also available at
* https://polyformproject.org/wp-content/uploads/2020/06/PolyForm-Shield-1.0.0.txt.
*/
import React from 'react'
import { Container, Tab, Tabs, Layout } from '@wings-software/uicore'
import { Expander } from '@blueprintjs/core'
import cx from 'classnames'
import type { FormikProps } from 'formik'
import { isEmpty, noop, omit } from 'lodash-es'
import { useParams } from 'react-router-dom'
import { useStrings } from 'framework/strings'
import { useFeatureFlag } from '@common/hooks/useFeatureFlag'
import { FeatureFlag } from '@common/featureFlags'
import { StepWidgetWithFormikRef } from '@pipeline/components/AbstractSteps/StepWidget'
import { AdvancedStepsWithRef } from '@pipeline/components/PipelineSteps/AdvancedSteps/AdvancedSteps'
import type { PipelineStep } from '@pipeline/components/PipelineSteps/PipelineStep'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import { StageType } from '@pipeline/utils/stageHelpers'
import type { StepElementConfig } from 'services/cd-ng'
import useCurrentModule from '@common/hooks/useCurrentModule'
import { ModuleName } from 'framework/types/ModuleName'
import { SaveTemplateButton } from '@pipeline/components/PipelineStudio/SaveTemplateButton/SaveTemplateButton'
import type { TemplateStepNode } from 'services/pipeline-ng'
import { TemplateBar } from '@pipeline/components/PipelineStudio/TemplateBar/TemplateBar'
import { getStepDataFromValues } from '@pipeline/utils/stepUtils'
import type { ModulePathParams } from '@common/interfaces/RouteInterfaces'
import { StepCommandsProps, StepCommandsViews, TabTypes, Values } from './StepCommandTypes'
import css from './StepCommands.module.scss'
export type StepFormikRef<T = unknown> = {
isDirty(): FormikProps<T>['dirty'] | undefined
submitForm: FormikProps<T>['submitForm']
getErrors(): FormikProps<T>['errors']
setFieldError(key: string, error: string): void
getValues(): T
resetForm: FormikProps<T>['resetForm']
}
export type StepCommandsRef<T = unknown> =
| ((instance: StepFormikRef<T> | null) => void)
| React.MutableRefObject<StepFormikRef<T> | null>
| null
enum StepCommandTabs {
StepConfiguration = 'StepConfiguration',
Advanced = 'Advanced'
}
export function StepCommands(
props: StepCommandsProps & { checkDuplicateStep?: () => boolean },
ref: StepCommandsRef
): React.ReactElement {
const {
step,
onChange,
onUpdate,
onUseTemplate,
onRemoveTemplate,
isStepGroup,
isReadonly,
stepsFactory,
hiddenPanels,
checkDuplicateStep,
hasStepGroupAncestor,
withoutTabs,
isNewStep = true,
stageType = StageType.DEPLOY,
stepViewType,
className = '',
viewType,
allowableTypes
} = props
const { getString } = useStrings()
const templatesEnabled = useFeatureFlag(FeatureFlag.NG_TEMPLATES)
const [activeTab, setActiveTab] = React.useState(StepCommandTabs.StepConfiguration)
const stepRef = React.useRef<FormikProps<unknown> | null>(null)
const advancedConfRef = React.useRef<FormikProps<unknown> | null>(null)
const isTemplateStep = !!(step as TemplateStepNode)?.template
const { module } = useParams<ModulePathParams>()
const { isModule } = useCurrentModule()
async function handleTabChange(newTab: StepCommandTabs, prevTab: StepCommandTabs): Promise<void> {
Iif (prevTab === StepCommandTabs.StepConfiguration && stepRef.current) {
if (checkDuplicateStep?.()) {
return Promise.resolve()
}
// please do not remove the await below.
// This is required for errors to be populated correctly
await stepRef.current.submitForm()
if (isEmpty(stepRef.current.errors)) {
setActiveTab(newTab)
}
} else Iif (prevTab === StepCommandTabs.Advanced && advancedConfRef.current) {
// please do not remove the await below.
// This is required for errors to be populated correctly
await advancedConfRef.current.submitForm()
if (isEmpty(advancedConfRef.current.errors)) {
setActiveTab(newTab)
}
}
}
const stepType: StepType = isStepGroup
? StepType.StepGroup
: isTemplateStep
? StepType.Template
: ((step as StepElementConfig).type as StepType)
React.useImperativeHandle(ref, () => ({
setFieldError(fieldName: string, error: string) {
if (activeTab === StepCommandTabs.StepConfiguration && stepRef.current) {
stepRef.current.setFieldError(fieldName, error)
}
},
isDirty() {
if (activeTab === StepCommandTabs.StepConfiguration && stepRef.current) {
return stepRef.current.dirty
}
if (activeTab === StepCommandTabs.Advanced && advancedConfRef.current) {
return advancedConfRef.current.dirty
}
},
submitForm() {
if (activeTab === StepCommandTabs.StepConfiguration && stepRef.current) {
return stepRef.current.submitForm()
}
if (activeTab === StepCommandTabs.Advanced && advancedConfRef.current) {
return advancedConfRef.current.submitForm()
}
},
getErrors() {
return activeTab === StepCommandTabs.StepConfiguration && stepRef.current
? stepRef.current.errors
: activeTab === StepCommandTabs.Advanced && advancedConfRef.current
? advancedConfRef.current.errors
: {}
},
getValues() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const stepObj = isStepGroup
? (stepsFactory.getStep(StepType.StepGroup) as PipelineStep<any>)
: stepType === StepType.Template
? (stepsFactory.getStep(StepType.Template) as PipelineStep<any>)
: (stepsFactory.getStep((step as StepElementConfig).type) as PipelineStep<any>)
return activeTab === StepCommandTabs.StepConfiguration && stepRef.current
? stepObj.processFormData(stepRef.current.values)
: activeTab === StepCommandTabs.Advanced && advancedConfRef.current
? advancedConfRef.current.values
: {}
},
resetForm() {
if (activeTab === StepCommandTabs.StepConfiguration && stepRef.current) {
return stepRef.current?.resetForm()
}
if (activeTab === StepCommandTabs.Advanced && advancedConfRef.current) {
return advancedConfRef.current.resetForm()
}
return noop
}
}))
const getStepWidgetWithFormikRef = () => {
return (
<StepWidgetWithFormikRef
factory={stepsFactory}
initialValues={step}
readonly={isReadonly}
isNewStep={isNewStep}
onChange={onChange}
onUpdate={onUpdate}
type={stepType}
stepViewType={stepViewType}
ref={stepRef}
allowableTypes={allowableTypes}
/>
)
}
if (withoutTabs) {
return <div className={cx(css.stepCommand, css.withoutTabs)}>{getStepWidgetWithFormikRef()}</div>
}
const getStepDataForTemplate = async (): Promise<StepElementConfig> => {
const stepObj = stepsFactory.getStep((step as StepElementConfig).type) as PipelineStep<any>
if (activeTab === StepCommandTabs.StepConfiguration && stepRef.current) {
await stepRef.current.validateForm()
const errors = omit(stepRef.current.errors, 'name')
if (isEmpty(errors)) {
return getStepDataFromValues(stepObj.processFormData(stepRef.current.values), step)
} else {
await stepRef.current.submitForm()
throw errors
}
} else if (activeTab === StepCommandTabs.Advanced && advancedConfRef.current) {
await advancedConfRef.current.validateForm()
const errors = omit(advancedConfRef.current.errors, 'name')
if (isEmpty(errors)) {
return getStepDataFromValues(
{ ...(advancedConfRef.current.values as Partial<Values>), tab: TabTypes.Advanced },
step
)
} else {
await advancedConfRef.current.submitForm()
throw errors
}
} else {
return step as StepElementConfig
}
}
const showAdvancedTab = isModule(ModuleName.CF) ? false : stageType !== StageType.FEATURE
return (
<div className={cx(css.stepCommand, className)}>
{stepType === StepType.Template && onUseTemplate && onRemoveTemplate ? (
<Layout.Vertical margin={'xlarge'} spacing={'xxlarge'}>
<TemplateBar
templateLinkConfig={(step as TemplateStepNode).template}
onOpenTemplateSelector={onUseTemplate}
onRemoveTemplate={onRemoveTemplate}
/>
<Container>{getStepWidgetWithFormikRef()}</Container>
</Layout.Vertical>
) : (
<div className={cx(css.stepTabs, { stepTabsAdvanced: activeTab === StepCommandTabs.Advanced })}>
<Tabs id="step-commands" selectedTabId={activeTab} onChange={handleTabChange}>
<Tab
id={StepCommandTabs.StepConfiguration}
title={isStepGroup ? getString('stepGroupConfiguration') : getString('stepConfiguration')}
panel={getStepWidgetWithFormikRef()}
/>
{showAdvancedTab && (
<Tab
id={StepCommandTabs.Advanced}
title={getString('advancedTitle')}
panel={
<AdvancedStepsWithRef
step={step}
isReadonly={isReadonly}
stepsFactory={stepsFactory}
allowableTypes={allowableTypes}
onChange={onChange}
onUpdate={onUpdate}
hiddenPanels={hiddenPanels}
isStepGroup={isStepGroup}
hasStepGroupAncestor={hasStepGroupAncestor}
ref={advancedConfRef}
stageType={stageType}
stepType={stepType}
/>
}
/>
)}
{templatesEnabled &&
!isStepGroup &&
viewType === StepCommandsViews.Pipeline &&
module !== 'cf' &&
(step as StepElementConfig).type !== StepType.FlagConfiguration ? (
<>
<Expander />
<SaveTemplateButton data={getStepDataForTemplate} type={'Step'} />
</>
) : null}
</Tabs>
</div>
)}
</div>
)
}
export const StepCommandsWithRef = React.forwardRef(StepCommands)
|