All files / modules/70-pipeline/components/PipelineStudio/FlowControl FlowControl.tsx

82.57% Statements 90/109
50% Branches 58/116
74.19% Functions 23/31
82.52% Lines 85/103

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              23x 23x 23x 23x 23x 23x                     23x 23x 23x 23x 23x   23x 23x 23x 23x 23x 23x 23x 23x 23x   23x 5x 5x 5x 5x 5x     5x     5x 5x 1x 1x           5x     23x 1x                                           23x             10x           10x   10x 10x                   10x 4x 4x 4x 4x 8x 4x   4x 4x 2x     4x       10x 10x 1x           1x 1x 1x     10x                         10x 1x 1x 1x   1x 1x     10x 1x 1x                 1x                                   10x       10x   10x       10x                                                                                     23x   23x               10x               5x 5x 5x 1x   5x                       16x           16x       16x                   14x                                                         1x                                                                                                             1x                                
/*
 * Copyright 2021 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 cx from 'classnames'
import { v4 as nameSpace, v5 as uuid } from 'uuid'
import produce from 'immer'
import * as Yup from 'yup'
import {
  Layout,
  Tag,
  Text,
  Formik,
  ButtonVariation,
  Button,
  ButtonSize,
  useToggleOpen,
  ConfirmationDialog
} from '@wings-software/uicore'
import { FontVariation, Intent } from '@harness/design-system'
import { set, debounce, cloneDeep, isEqual } from 'lodash-es'
import { FieldArray } from 'formik'
import { Tooltip } from '@blueprintjs/core'
import { String, useStrings } from 'framework/strings'
import type { UseStringsReturn } from 'framework/strings'
import { useGetBarriersSetupInfoList, StageDetail } from 'services/pipeline-ng'
import { useMutateAsGet } from '@common/hooks'
import { NameId } from '@common/components/NameIdDescriptionTags/NameIdDescriptionTags'
import { yamlStringify } from '@common/utils/YamlHelperMethods'
import RbacButton from '@rbac/components/Button/Button'
import { PermissionIdentifier } from '@rbac/interfaces/PermissionIdentifier'
import { ResourceType } from '@rbac/interfaces/ResourceType'
import { usePipelineContext } from '../PipelineContext/PipelineContext'
import css from './FlowControl.module.scss'
 
const getErrors = (barriers: Barrier[], getString: UseStringsReturn['getString']): Barrier[] => {
  const errors: unknown[] = []
  const barrierValueMap: { [key: string]: { indexes: number[] } } = {}
  for (let index = 0; index < barriers.length; index++) {
    const barrierId = barriers[index].identifier
    Iif (barrierValueMap[barrierId]) {
      barrierValueMap[barrierId].indexes.push(index)
    } else {
      barrierValueMap[barrierId] = { indexes: barrierId === '' ? [index] : [] }
    }
  }
  Object.values(barrierValueMap).forEach(({ indexes }: { indexes: number[] }) => {
    indexes.forEach((errIndex: number) => {
      Eif (barriers[errIndex].identifier === '') {
        set(errors, `[${errIndex}].name`, getString('secrets.secret.validationIdentifier'))
      } else {
        set(errors, `[${errIndex}].name`, getString('common.duplicateId'))
      }
    })
  })
  return errors as Barrier[]
}
 
const getValidBarriers = (barriers: Barrier[]): Barrier[] =>
  barriers.filter(barrier => barrier.identifier.length > 0 && barrier.name.length > 0)
 
interface Barrier {
  identifier: string
  name: string
  id?: string
  mode?: 'ADD' | 'EDIT' | null
  stages?: StageDetail[]
}
export interface BarrierListProps {
  list: Array<Barrier>
  createItem: (push: (data: Barrier) => void) => void
  deleteItem: (index: number, remove: (a: number) => void) => void
  commitItem: (data: Barrier, index: number) => void
  getString: UseStringsReturn['getString']
  loadingSetupInfo: boolean
}
 
export interface FlowControlRef {
  onRequestClose(): void
}
 
export function FlowControl(
  { onDiscard }: { onDiscard: () => void },
  ref: React.ForwardedRef<FlowControlRef>
): React.ReactElement {
  const {
    state: { pipeline, originalPipeline },
    updatePipeline
  } = usePipelineContext()
 
  const {
    isOpen: isConfirmationDialogOpen,
    open: openConfirmationDialog,
    close: closeConfirmationDialog
  } = useToggleOpen()
 
  const [barriers, updateBarriers] = React.useState<Barrier[]>(pipeline?.flowControl?.barriers || [])
  const { data, loading: loadingSetupInfo } = useMutateAsGet(useGetBarriersSetupInfoList, {
    body: yamlStringify({ pipeline: originalPipeline }) as unknown as void,
    requestOptions: {
      headers: {
        'content-type': 'application/yaml'
      }
    },
    debounce: 800
  })
 
  React.useEffect(() => {
    Eif (data?.data) {
      const barrierInfoList = data?.data
      const newBarriers = cloneDeep(barriers)
      barrierInfoList.forEach(barrierInfo => {
        if (!barrierInfo.stages?.length) {
          return
        }
        const matchingIndex = newBarriers.findIndex(brr => brr.identifier === barrierInfo.identifier)
        if (matchingIndex > -1) {
          newBarriers[matchingIndex].stages = barrierInfo.stages
        }
      })
      updateBarriers(newBarriers)
    }
  }, [data?.data])
 
  const debouncedUpdatePipeline = React.useCallback(debounce(updatePipeline, 300), [updatePipeline])
  const addBarrier = (push: (data: Barrier) => void): void => {
    const newBarrier: Barrier = {
      name: '',
      identifier: '',
      id: uuid('', nameSpace()),
      mode: 'ADD'
    }
    const updatedState: Barrier[] = [...barriers, newBarrier]
    push(newBarrier)
    updateBarriers(updatedState)
  }
 
  const commitBarrier = (barrierData: Barrier, index: number): void => {
    if (!barrierData?.name?.length || !barrierData?.identifier?.length) {
      return
    }
    const updatedBarriers: Barrier[] = produce(barriers, draft => {
      draft[index] = {
        ...barrierData,
        mode: null
      }
    })
    updateBarriers(updatedBarriers)
  }
 
  const deleteBarrier = (index: number, remove: (index: number) => void): void => {
    Iif (barriers[index]?.stages?.length) return
    const updatedBarriers: Barrier[] = produce(barriers, draft => {
      draft.splice(index, 1)
    })
    updateBarriers(updatedBarriers)
    remove(index)
  }
 
  const submitBarrier = (): void => {
    const validBarriers = getValidBarriers(barriers)
    debouncedUpdatePipeline({
      ...pipeline,
      flowControl: {
        barriers: validBarriers.map(barrier => ({
          name: barrier.name,
          identifier: barrier.identifier
        }))
      }
    })
    onDiscard()
  }
 
  function onRequestClose(): void {
    if (!isEqual(pipeline?.flowControl?.barriers, barriers)) {
      openConfirmationDialog()
      return
    }
    onDiscard()
  }
 
  function handleConfirmation(confirm: boolean): void {
    if (confirm) {
      submitBarrier()
    }
    closeConfirmationDialog()
  }
 
  React.useImperativeHandle(ref, () => ({
    onRequestClose
  }))
 
  const { getString } = useStrings()
 
  React.useImperativeHandle(ref, () => ({
    onRequestClose
  }))
 
  return (
    <>
      <ConfirmationDialog
        titleText={getString('pipeline.barriers.flowControl')}
        contentText={getString('pipeline.stepConfigHasChanges')}
        isOpen={isConfirmationDialogOpen}
        confirmButtonText={getString('applyChanges')}
        cancelButtonText={getString('cancel')}
        onClose={handleConfirmation}
        intent={Intent.WARNING}
      />
      <div className={css.flowControlPanelHeader}>
        <div className={css.flowControlTitle}>
          <Layout.Horizontal>
            <Text font={{ variation: FontVariation.H4 }} tooltipProps={{ dataTooltipId: 'pipelineVariables' }}>
              {pipeline?.name}: {getString('pipeline.barriers.flowControl')}
            </Text>
          </Layout.Horizontal>
        </div>
        <div className={css.mainActions}>
          <Button
            variation={ButtonVariation.SECONDARY}
            size={ButtonSize.SMALL}
            text={getString('applyChanges')}
            onClick={submitBarrier}
          />
          <Button minimal size={ButtonSize.SMALL} text={getString('pipeline.discard')} onClick={onDiscard} />
        </div>
      </div>
      <div className={css.container}>
        <BarrierList
          list={barriers}
          createItem={addBarrier}
          deleteItem={deleteBarrier}
          commitItem={commitBarrier}
          getString={getString}
          loadingSetupInfo={loadingSetupInfo}
        />
      </div>
    </>
  )
}
 
export const FlowControlWithRef = React.forwardRef(FlowControl)
 
export function BarrierList({
  list,
  createItem,
  deleteItem,
  commitItem,
  getString,
  loadingSetupInfo
}: BarrierListProps): React.ReactElement {
  return (
    <Formik
      initialValues={{ barriers: list }}
      onSubmit={value => {
        console.log(value) //eslint-disable-line
      }}
      formName="flowControl"
      validate={({ barriers }: { barriers: Barrier[] }) => {
        const errors: any = { barriers: [] }
        const identifierErrors = getErrors(barriers, getString)
        if (identifierErrors.length) {
          errors.barriers = identifierErrors
        }
        return errors
      }}
      validationSchema={Yup.object().shape({
        barriers: Yup.array().of(
          Yup.object().shape({
            name: Yup.string().required(getString('pipeline.barriers.validation.barrierNamerequired')),
            identifier: Yup.string().min(1).required(getString('common.duplicateId'))
          })
        )
      })}
    >
      {formik => (
        <>
          <Layout.Vertical spacing="small">
            <Text font={{ variation: FontVariation.H5 }}>{getString('pipeline.barriers.syncBarriers')}</Text>
            <FieldArray
              name="barriers"
              render={({ push, remove }) => {
                return (
                  <div>
                    <div className={css.barrierList}>
                      {list.map((barrier: Barrier, index) =>
                        !barrier.mode ? (
                          <div className={css.rowItem} key={barrier.id}>
                            <div>
                              <Text lineClamp={1} className={css.rowHeader}>
                                {barrier.name}
                              </Text>
                              <Text lineClamp={1}>{barrier.identifier}</Text>
                            </div>
                            <div>
                              {barrier.stages?.map((stage: StageDetail) => (
                                <Tag className={cx(css.tag, css.spaceRight)} key={stage.name}>
                                  <Text lineClamp={1} width={50} className={css.tagText}>
                                    {stage.name}
                                  </Text>
                                </Tag>
                              ))}
                            </div>
                            <div className={css.barrierAction}>
                              <Tooltip
                                content={
                                  barrier.stages?.length
                                    ? 'Deleting this barrier is not allowed as it is being used in one or more stages'
                                    : ''
                                }
                              >
                                <RbacButton
                                  permission={{
                                    permission: PermissionIdentifier.EDIT_PIPELINE,
                                    resource: {
                                      resourceType: ResourceType.PIPELINE
                                    }
                                  }}
                                  icon="main-trash"
                                  variation={ButtonVariation.ICON}
                                  className={cx(css.deleteIcon, {
                                    [css.disabledIcon]: loadingSetupInfo || barrier.stages?.length
                                  })}
                                  withoutCurrentColor
                                  iconProps={{ size: 16, color: '#6B6D85' }}
                                  onClick={() => deleteItem(index, remove)}
                                />
                              </Tooltip>
                            </div>
                          </div>
                        ) : (
                          <div className={css.rowItem} key={barrier.id}>
                            <div className={css.newBarrier}>
                              {barrier.name} <br />
                              <NameId
                                nameLabel="Barrier Name"
                                identifierProps={{
                                  inputName: `barriers[${index}].name`,
                                  idName: `barriers[${index}].identifier`,
                                  inputGroupProps: {
                                    inputGroup: {
                                      onBlur: () =>
                                        !formik.errors?.barriers?.[index] &&
                                        commitItem(formik.values.barriers[index], index)
                                    }
                                  }
                                }}
                              />
                            </div>
                            <div className={css.barrierAction}>
                              <RbacButton
                                permission={{
                                  permission: PermissionIdentifier.EDIT_PIPELINE,
                                  resource: {
                                    resourceType: ResourceType.PIPELINE
                                  }
                                }}
                                variation={ButtonVariation.ICON}
                                iconProps={{ color: '#6B6D85', size: 16 }}
                                icon="main-trash"
                                withoutCurrentColor
                                className={css.deleteIcon}
                                onClick={() => deleteItem(index, remove)}
                              />
                            </div>
                          </div>
                        )
                      )}
                    </div>
 
                    <RbacButton
                      permission={{
                        permission: PermissionIdentifier.EDIT_PIPELINE,
                        resource: {
                          resourceType: ResourceType.PIPELINE
                        }
                      }}
                      intent="primary"
                      variation={ButtonVariation.LINK}
                      icon="plus"
                      onClick={() => createItem(push)}
                      withoutCurrentColor
                      className={css.addbarrier}
                    >
                      <String stringID="pipeline.barriers.addBarrier" />
                    </RbacButton>
                  </div>
                )
              }}
            />
          </Layout.Vertical>
        </>
      )}
    </Formik>
  )
}