All files / modules/75-cf/components/PipelineSteps/FlagConfigurationStep FlagConfigurationStepWidget.tsx

88.71% Statements 55/62
80.91% Branches 89/110
66.67% Functions 10/15
88.33% Lines 53/60

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              3x 3x                   3x 3x 3x 3x 3x 3x 3x 3x 3x   3x 3x                   3x         9x 9x 9x   9x   9x                     9x         9x                           9x   9x 9x   9x 5x       9x 8x 5x 4x   5x     3x     9x 5x       5x           9x 5x 2x     3x     9x 2x                       7x 1x                           6x                           3x 3x 3x   3x 3x     3x 3x     3x                                                                                                 3x  
/*
 * 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, { forwardRef, useMemo, useRef, useState } from 'react'
import {
  Container,
  Formik,
  FormInput,
  Layout,
  MultiTypeInputType,
  SelectOption,
  PageError,
  RUNTIME_INPUT_VALUE
} from '@wings-software/uicore'
import * as Yup from 'yup'
import { useParams } from 'react-router-dom'
import { setFormikRef, StepFormikFowardRef, StepViewType } from '@pipeline/components/AbstractSteps/Step'
import { getNameAndIdentifierSchema } from '@pipeline/components/PipelineSteps/Steps/StepsValidateUtils'
import { getErrorMessage } from '@cf/utils/CFUtils'
import { GetEnvironmentListQueryParams, useGetEnvironmentList } from 'services/cd-ng'
import { GetAllFeaturesQueryParams, useGetAllFeatures } from 'services/cf'
import { useStrings } from 'framework/strings'
import { ContainerSpinner } from '@common/components/ContainerSpinner/ContainerSpinner'
import type { FlagConfigurationStepData } from './types'
import FlagChanges from './FlagChanges/FlagChanges'
import preProcessFormValues from './preProcessFormValues'
 
export interface FlagConfigurationStepWidgetProps {
  initialValues: FlagConfigurationStepData
  isNewStep?: boolean
  readonly?: boolean
  onUpdate: (data: FlagConfigurationStepData) => void
  stepViewType?: StepViewType
}
 
const FlagConfigurationStepWidget = forwardRef(
  (
    { initialValues, onUpdate, isNewStep, readonly, stepViewType }: FlagConfigurationStepWidgetProps,
    formikRef: StepFormikFowardRef<FlagConfigurationStepData>
  ) => {
    const [isInitialRender, setIsInitialRender] = useState<boolean>(true)
    const formValuesRef = useRef<FlagConfigurationStepData>({} as FlagConfigurationStepData)
    const { getString } = useStrings()
 
    const { accountId: accountIdentifier, orgIdentifier, projectIdentifier } = useParams<Record<string, string>>()
 
    const envQueryParams: GetEnvironmentListQueryParams = {
      accountIdentifier,
      orgIdentifier,
      projectIdentifier
    }
 
    const {
      data: environmentsData,
      loading: loadingEnvironments,
      error: errorEnvironments,
      refetch: refetchEnvironments
    } = useGetEnvironmentList({
      queryParams: envQueryParams,
      debounce: 250
    })
 
    const featureQueryParams: GetAllFeaturesQueryParams = {
      accountIdentifier,
      orgIdentifier,
      projectIdentifier,
      environmentIdentifier: formValuesRef.current?.spec?.environment || '',
      pageSize: 15,
      pageNumber: 0
    }
 
    const {
      data: featuresData,
      loading: loadingFeatures,
      error: errorFeatures,
      refetch: refetchFeatures
    } = useGetAllFeatures({ queryParams: featureQueryParams, debounce: 250 })
 
    const loading = loadingEnvironments || loadingFeatures
    const error = errorEnvironments || errorFeatures
 
    const initialFormValues = useMemo(
      () => preProcessFormValues(initialValues, featuresData),
      [initialValues, featuresData]
    )
 
    const showLoading = useMemo<boolean>(() => {
      if (isInitialRender) {
        if (!error) {
          setIsInitialRender(loading)
        }
        return loading
      }
 
      return false
    }, [isInitialRender, error, loading])
 
    const environmentItems = useMemo<SelectOption[]>(() => {
      Iif (!environmentsData?.data?.content?.length) {
        return []
      }
 
      return environmentsData.data.content.map(({ environment }) => ({
        label: environment?.name,
        value: environment?.identifier
      })) as SelectOption[]
    }, [environmentsData?.data?.content])
 
    const featureItems = useMemo<SelectOption[]>(() => {
      if (!featuresData?.features?.length) {
        return []
      }
 
      return featuresData.features.map(({ name, identifier }) => ({ label: name, value: identifier }))
    }, [featuresData?.features])
 
    if (showLoading) {
      return (
        <Container
          height="100%"
          width="100%"
          padding={{ top: 'huge' }}
          data-testid="flag-configuration-step-widget-loading"
        >
          <ContainerSpinner />
        </Container>
      )
    }
 
    if (error) {
      return (
        <Container padding={{ top: 'huge' }} data-testid="flag-configuration-step-widget-error">
          <PageError
            message={getErrorMessage(error)}
            width={450}
            onClick={() => {
              refetchFeatures()
              refetchEnvironments()
            }}
          />
        </Container>
      )
    }
 
    return (
      <Formik<FlagConfigurationStepData>
        formName="FeatureFlagConfigurationForm"
        onSubmit={onUpdate}
        initialValues={initialFormValues}
        validationSchema={Yup.object().shape({
          ...getNameAndIdentifierSchema(getString, stepViewType),
          spec: Yup.object().shape({
            environment: Yup.string().required(getString('cf.pipeline.flagConfiguration.environmentRequired')),
            feature: Yup.mixed().required(getString('cf.pipeline.flagConfiguration.flagRequired'))
          })
        })}
      >
        {formik => {
          setFormikRef(formikRef, formik)
          const { values: formValues, setFieldValue } = formik
          formValuesRef.current = formValues
 
          const currentFeature = featuresData?.features?.find(
            ({ identifier }) => identifier === formValues?.spec.feature
          )
 
          const currentEnvironment = environmentsData?.data?.content?.find(
            ({ environment }) => environment?.identifier === formValues?.spec.environment
          )?.environment
 
          return (
            <Layout.Vertical padding={{ right: 'xlarge' }}>
              <FormInput.InputWithIdentifier
                isIdentifierEditable={isNewStep && !readonly}
                inputLabel={getString('cf.pipeline.flagConfiguration.stepName')}
                inputGroupProps={{ disabled: readonly }}
              />
              <FormInput.Select
                name="spec.environment"
                items={environmentItems}
                label={getString('cf.pipeline.flagConfiguration.selectEnvironment')}
                disabled={readonly}
                onQueryChange={searchTerm => refetchEnvironments({ queryParams: { ...envQueryParams, searchTerm } })}
              />
              <FormInput.MultiTypeInput
                name="spec.feature"
                useValue={true}
                selectItems={featureItems}
                label={getString('cf.pipeline.flagConfiguration.selectFlag')}
                disabled={readonly}
                multiTypeInputProps={{
                  disabled: readonly,
                  allowableTypes: [MultiTypeInputType.FIXED, MultiTypeInputType.RUNTIME],
                  onInput: event =>
                    refetchFeatures({
                      queryParams: { ...featureQueryParams, name: (event.target as HTMLInputElement).value }
                    })
                }}
              />
 
              <FlagChanges
                selectedFeature={
                  formValues.spec.feature === RUNTIME_INPUT_VALUE ? formValues.spec.feature : currentFeature
                }
                selectedEnvironmentId={currentEnvironment?.identifier}
                initialInstructions={initialValues.spec.instructions}
                clearField={(fieldName: string) => setFieldValue(fieldName, undefined)}
                setField={(fieldName: string, value: unknown) => setFieldValue(fieldName, value)}
                fieldValues={formValues}
                showRuntimeFixedSelector
              />
            </Layout.Vertical>
          )
        }}
      </Formik>
    )
  }
)
 
export default FlagConfigurationStepWidget