All files / modules/75-cd/components/PipelineStudio/DeployServiceSpecifications DeployServiceSpecifications.tsx

71.72% Statements 104/145
61.98% Branches 269/434
61.54% Functions 16/26
72.22% Lines 104/144

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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421              4x 4x 4x                   4x 4x 4x 4x 4x     4x 4x 4x 4x 4x       4x   4x 4x     4x 4x 4x 4x   4x 4x 4x 4x 4x 4x   4x 43x 43x                       43x 43x 43x     43x     8x         43x 43x 43x             43x 43x     43x 43x 43x 43x   43x 43x 43x 43x   43x 9x         6x       43x 17x 1x       43x       43x 9x 9x 18x 8x     9x     43x 18x 12x 12x 12x 36x 24x               24x       24x 24x 6x         24x 8x   24x             12x       43x 9x         43x 21x 21x   21x                       21x 21x       21x             43x 32x 2x 2x 2x   2x     2x       2x       43x 6x 6x 6x                             6x     43x                                                   43x                                     43x                                 43x                       43x 37x     43x                                                                                                                                                                                                      
/*
 * 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, { useCallback, useContext, useEffect, useState } from 'react'
import { useParams } from 'react-router-dom'
import {
  Card,
  Checkbox,
  Container,
  FormikForm,
  Layout,
  RUNTIME_INPUT_VALUE,
  SelectOption,
  Text
} from '@wings-software/uicore'
import { Color } from '@harness/design-system'
import produce from 'immer'
import { debounce, get, isEmpty, set, unset } from 'lodash-es'
import { StepViewType } from '@pipeline/components/AbstractSteps/Step'
import { useStrings } from 'framework/strings'
 
import type { ProjectPathProps } from '@common/interfaces/RouteInterfaces'
import { StepType } from '@pipeline/components/PipelineSteps/PipelineStepInterface'
import { ServiceConfig, StageElementConfig, useGetServiceList } from 'services/cd-ng'
import factory from '@pipeline/components/PipelineSteps/PipelineStepFactory'
import { usePipelineContext } from '@pipeline/components/PipelineStudio/PipelineContext/PipelineContext'
import {
  getFlattenedStages,
  getStageIndexFromPipeline
} from '@pipeline/components/PipelineStudio/StageBuilder/StageBuilderUtil'
import { StepWidget } from '@pipeline/components/AbstractSteps/StepWidget'
import type { K8SDirectServiceStep } from '@cd/components/PipelineSteps/K8sServiceSpec/K8sServiceSpecInterface'
import DeployServiceErrors from '@cd/components/PipelineStudio/DeployServiceSpecifications/DeployServiceErrors'
import PropagateWidget, {
  setupMode
} from '@cd/components/PipelineStudio/DeployServiceSpecifications/PropagateWidget/PropagateWidget'
import { StageErrorContext } from '@pipeline/context/StageErrorContext'
import { useValidationErrors } from '@pipeline/components/PipelineStudio/PiplineHooks/useValidationErrors'
import { DeployTabs } from '@cd/components/PipelineStudio/DeployStageSetupShell/DeployStageSetupShellUtils'
import SelectDeploymentType from '@cd/components/PipelineStudio/DeployServiceSpecifications/SelectDeploymentType'
import type { DeploymentStageElementConfig } from '@pipeline/utils/pipelineTypes'
import { useDeepCompareEffect } from '@common/hooks'
import { StageType } from '@pipeline/utils/stageHelpers'
import { useFeatureFlags } from '@common/hooks/useFeatureFlag'
import { Scope } from '@common/interfaces/SecretsInterface'
import { getIdentifierFromValue } from '@common/components/EntityReference/EntityReference'
import stageCss from '../DeployStageSetupShell/DeployStage.module.scss'
 
export default function DeployServiceSpecifications(props: React.PropsWithChildren<unknown>): JSX.Element {
  const { getString } = useStrings()
  const { accountId, orgIdentifier, projectIdentifier } = useParams<ProjectPathProps>()
  const {
    state: {
      pipeline,
      templateTypes,
      selectionState: { selectedStageId }
    },
    allowableTypes,
    isReadonly,
    scope,
    getStageFromPipeline,
    updateStage
  } = usePipelineContext()
  const scrollRef = React.useRef<HTMLDivElement | null>(null)
  const { NG_NATIVE_HELM } = useFeatureFlags()
 
  // eslint-disable-next-line react-hooks/exhaustive-deps
  const debounceUpdateStage = useCallback(
    debounce(
      (changedStage?: StageElementConfig) =>
        changedStage ? updateStage(changedStage) : /* istanbul ignore next */ Promise.resolve(),
      300
    ),
    [updateStage]
  )
  const { stage } = getStageFromPipeline<DeploymentStageElementConfig>(selectedStageId || '')
  const getDeploymentType = (): string => {
    return get(
      stage,
      'stage.spec.serviceConfig.serviceDefinition.type',
      !NG_NATIVE_HELM ? 'Kubernetes' : /* istanbul ignore next */ undefined
    )
  }
 
  const [setupModeType, setSetupMode] = useState('')
  const [checkedItems, setCheckedItems] = useState({
    overrideSetCheckbox: false
  })
  const [selectedPropagatedState, setSelectedPropagatedState] = useState<SelectOption>()
  const [serviceIdNameMap, setServiceIdNameMap] = useState<{ [key: string]: string }>()
  const [selectedDeploymentType, setSelectedDeploymentType] = useState(getDeploymentType())
  const [previousStageList, setPreviousStageList] = useState<SelectOption[]>([])
 
  const { index: stageIndex } = getStageIndexFromPipeline(pipeline, selectedStageId || '')
  const { stages } = getFlattenedStages(pipeline)
  const { submitFormsForTab } = useContext(StageErrorContext)
  const { errorMap } = useValidationErrors()
 
  useEffect(() => {
    if (
      !stage?.stage?.spec?.serviceConfig?.serviceDefinition &&
      !stage?.stage?.spec?.serviceConfig?.useFromStage?.stage &&
      stage?.stage?.type === StageType.DEPLOY
    ) {
      setDefaultServiceSchema()
    }
  }, [])
 
  useEffect(() => {
    if (errorMap.size > 0) {
      submitFormsForTab(DeployTabs.SERVICE)
    }
  }, [errorMap])
 
  const { data: serviceResponse } = useGetServiceList({
    queryParams: { accountIdentifier: accountId, orgIdentifier, projectIdentifier }
  })
 
  useEffect(() => {
    const serviceIdNameMapping: { [key: string]: string } = {}
    serviceResponse?.data?.content?.forEach(service => {
      if (service.service?.identifier) {
        serviceIdNameMapping[service.service?.identifier] = service.service?.name || ''
      }
    })
    setServiceIdNameMap(serviceIdNameMapping)
  }, [serviceResponse])
 
  useDeepCompareEffect(() => {
    if (stages && stages.length > 0) {
      const newPreviousStageList: SelectOption[] = []
      const currentStageType = stage?.stage?.type
      stages.forEach((item, index) => {
        if (index < stageIndex) {
          Iif (item.stage?.template) {
            const stageType = get(templateTypes, getIdentifierFromValue(item.stage.template.templateRef))
            if (currentStageType === stageType) {
              newPreviousStageList.push({
                label: `Stage [${item.stage?.name}] - [Template]`,
                value: item.stage?.identifier || ''
              })
            }
          } else Eif (
            currentStageType === item?.stage?.type &&
            !get(item.stage, `spec.serviceConfig.useFromStage.stage`)
          ) {
            let serviceName = (item.stage as DeploymentStageElementConfig)?.spec?.serviceConfig?.service?.name
            if (isEmpty(serviceName) && serviceIdNameMap) {
              serviceName =
                serviceIdNameMap[
                  (item.stage as DeploymentStageElementConfig)?.spec?.serviceConfig?.serviceRef as string
                ]
            }
            if (isEmpty(serviceName)) {
              serviceName = (item.stage as DeploymentStageElementConfig)?.spec?.serviceConfig?.serviceRef || ''
            }
            newPreviousStageList.push({
              label: `Stage [${item.stage?.name}] - Service [${serviceName}]`,
              value: item.stage?.identifier || ''
            })
          }
        }
      })
      setPreviousStageList(newPreviousStageList)
    }
  }, [stages, serviceIdNameMap])
 
  useEffect(() => {
    Iif (stageIndex === 0) {
      setSetupMode(setupMode.DIFFERENT)
    }
  }, [stageIndex])
 
  useEffect(() => {
    const useFromStage = stage?.stage?.spec?.serviceConfig?.useFromStage
    const stageOverrides = stage?.stage?.spec?.serviceConfig?.stageOverrides
 
    Iif (useFromStage) {
      setSetupMode(setupMode.PROPAGATE)
      if (previousStageList && previousStageList.length > 0) {
        const selectedIdentifier = useFromStage?.stage
        const selectedOption = previousStageList.find(v => v.value === selectedIdentifier)
        setSelectedPropagatedState(selectedOption)
        setCheckedItems({
          ...checkedItems,
          overrideSetCheckbox: !!stageOverrides
        })
      }
    } else {
      setSetupMode(setupMode.DIFFERENT)
      setSelectedPropagatedState({
        label: '',
        value: ''
      })
      setCheckedItems({
        ...checkedItems,
        overrideSetCheckbox: !!stageOverrides
      })
    }
  }, [stage?.stage?.spec, previousStageList])
 
  useEffect(() => {
    if (selectedPropagatedState && selectedPropagatedState.value) {
      const stageData = produce(stage, draft => {
        Eif (draft) {
          set(draft, 'stage.spec.serviceConfig.useFromStage', { stage: selectedPropagatedState.value })
        }
        Iif (draft?.stage?.spec?.serviceConfig?.serviceDefinition) {
          delete draft.stage.spec.serviceConfig.serviceDefinition
        }
        Iif (draft?.stage?.spec?.serviceConfig?.serviceRef !== undefined) {
          delete draft.stage.spec.serviceConfig.serviceRef
        }
      })
      debounceUpdateStage(stageData?.stage)
    }
  }, [selectedPropagatedState])
 
  const setDefaultServiceSchema = (): Promise<void> => {
    const stageData = produce(stage, draft => {
      Eif (draft) {
        set(draft, 'stage.spec', {
          ...stage?.stage?.spec,
          serviceConfig: {
            serviceRef: getScopeBasedDefaultServiceRef(),
            serviceDefinition: {
              type: !NG_NATIVE_HELM ? 'Kubernetes' : undefined,
              spec: {
                variables: []
              }
            }
          }
        })
      }
    })
 
    return debounceUpdateStage(stageData?.stage)
  }
 
  const setStageOverrideSchema = (): Promise<void> => {
    const stageData = produce(stage, draft => {
      if (draft) {
        set(draft, 'stage.spec', {
          ...stage?.stage?.spec,
          serviceConfig: {
            ...stage?.stage?.spec?.serviceConfig,
            stageOverrides: {
              artifacts: {
                // primary: null,
                sidecars: []
              },
              manifests: [],
              variables: []
            }
          }
        })
      }
      if (draft?.stage?.spec?.serviceConfig.serviceDefinition) {
        delete draft.stage.spec.serviceConfig.serviceDefinition
      }
    })
 
    return debounceUpdateStage(stageData?.stage)
  }
 
  const handleChange = (event: React.FormEvent<HTMLInputElement>): void => {
    const _isChecked = (event.target as HTMLInputElement).checked
    setCheckedItems({
      ...checkedItems,
      overrideSetCheckbox: _isChecked
    })
    if (_isChecked) {
      setStageOverrideSchema()
    } else {
      const stageData = produce(stage, draft => {
        if (stage?.stage?.spec?.serviceConfig?.stageOverrides) {
          unset(draft?.stage?.spec?.serviceConfig, 'stageOverrides')
        }
      })
 
      debounceUpdateStage(stageData?.stage)
    }
  }
 
  const updateService = useCallback(
    (value: ServiceConfig) => {
      const stageData = produce(stage, draft => {
        const serviceObj = get(draft, 'stage.spec.serviceConfig', {})
        if (value.service) {
          serviceObj.service = value.service
          delete serviceObj.serviceRef
        } else {
          serviceObj.serviceRef = value.serviceRef
          delete serviceObj.service
        }
      })
      debounceUpdateStage(stageData?.stage)
    },
    [debounceUpdateStage, stage, stage?.stage?.spec?.serviceConfig?.serviceDefinition]
  )
 
  const handleDeploymentTypeChange = useCallback(
    (deploymentType: string): void => {
      const stageData = produce(stage, draft => {
        const serviceDefinition = get(draft, 'stage.spec.serviceConfig.serviceDefinition', {})
        serviceDefinition.type = deploymentType
      })
      setSelectedDeploymentType(deploymentType)
      updateStage(stageData?.stage as StageElementConfig)
    },
    [stage, updateStage]
  )
 
  const getScopeBasedDefaultServiceRef = React.useCallback(() => {
    return scope === Scope.PROJECT ? '' : RUNTIME_INPUT_VALUE
  }, [scope])
 
  return (
    <FormikForm>
      <div className={stageCss.serviceOverrides} ref={scrollRef}>
        <DeployServiceErrors domRef={scrollRef as React.MutableRefObject<HTMLElement | undefined>} />
        <div className={stageCss.contentSection}>
          {previousStageList.length > 0 && (
            <Container margin={{ bottom: 'xlarge', left: 'xlarge' }}>
              <PropagateWidget
                setupModeType={setupModeType}
                selectedPropagatedState={selectedPropagatedState}
                previousStageList={previousStageList}
                isReadonly={isReadonly}
                setSetupMode={setSetupMode}
                setSelectedPropagatedState={setSelectedPropagatedState}
                initWithServiceDefinition={setDefaultServiceSchema}
              />
              {setupModeType === setupMode.PROPAGATE && selectedPropagatedState?.value && (
                <Container margin={{ top: 'large' }}>
                  <Container padding={{ bottom: 'small' }} border={{ bottom: true }}>
                    <Text color={Color.GREY_800} font={{ weight: 'bold' }}>
                      {getString('cd.pipelineSteps.serviceTab.stageOverrides')}
                    </Text>
                  </Container>
                  <Checkbox
                    color={Color.GREY_500}
                    font={{ weight: 'semi-bold' }}
                    margin={{ top: 'medium' }}
                    label={getString('cd.pipelineSteps.serviceTab.overrideChanges')}
                    checked={checkedItems.overrideSetCheckbox}
                    onChange={handleChange}
                  />
                </Container>
              )}
            </Container>
          )}
          {setupModeType === setupMode.DIFFERENT ? (
            <>
              <div className={stageCss.tabHeading}>{getString('cd.pipelineSteps.serviceTab.aboutYourService')}</div>
              <Card className={stageCss.sectionCard} id="aboutService">
                <StepWidget
                  type={StepType.DeployService}
                  readonly={isReadonly || scope === Scope.ORG || scope === Scope.ACCOUNT}
                  initialValues={{
                    service: get(stage, 'stage.spec.serviceConfig.service', {}),
                    serviceRef: get(stage, 'stage.spec.serviceConfig.serviceRef', getScopeBasedDefaultServiceRef())
                  }}
                  allowableTypes={allowableTypes}
                  onUpdate={data => updateService(data)}
                  factory={factory}
                  stepViewType={StepViewType.Edit}
                />
              </Card>
              <div className={stageCss.tabHeading} id="serviceDefinition">
                {getString('pipelineSteps.deploy.serviceSpecifications.serviceDefinition')}
              </div>
              <SelectDeploymentType
                selectedDeploymentType={selectedDeploymentType}
                isReadonly={isReadonly}
                handleDeploymentTypeChange={handleDeploymentTypeChange}
              />
              <Layout.Horizontal>
                <StepWidget<K8SDirectServiceStep>
                  factory={factory}
                  readonly={isReadonly}
                  initialValues={{
                    stageIndex,
                    setupModeType
                  }}
                  allowableTypes={allowableTypes}
                  type={StepType.K8sServiceSpec}
                  stepViewType={StepViewType.Edit}
                />
              </Layout.Horizontal>
            </>
          ) : (
            checkedItems.overrideSetCheckbox &&
            selectedPropagatedState?.value && (
              <StepWidget<K8SDirectServiceStep>
                factory={factory}
                readonly={isReadonly}
                initialValues={{
                  stageIndex,
                  setupModeType
                }}
                allowableTypes={allowableTypes}
                type={StepType.K8sServiceSpec}
                stepViewType={StepViewType.Edit}
              />
            )
          )}
          {((setupModeType === setupMode.PROPAGATE && selectedPropagatedState?.value) ||
            setupModeType === setupMode.DIFFERENT) && (
            <Container margin={{ top: 'xxlarge' }}>{props.children}</Container>
          )}
        </div>
      </div>
    </FormikForm>
  )
}