All files / modules/20-rbac/components/NotificationList NotificationList.tsx

53.4% Statements 55/103
36.84% Branches 28/76
29.63% Functions 8/27
53% Lines 53/100

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              10x 10x 10x 10x                     10x 10x 10x 10x 10x 10x 10x 10x   10x 10x 10x 10x 10x 10x                                                                 10x 6x 6x 6x 6x 6x 6x 6x   6x               6x                                                           6x                                                     6x                 6x                             6x                                                         6x                                                                                                                                                                                                       10x 9x 9x 9x   9x         9x         9x         9x         9x   9x 12x   6x   6x                   9x               9x 12x 24x     9x     6x                                                             10x  
/*
 * 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, { useState } from 'react'
import * as Yup from 'yup'
import cx from 'classnames'
import {
  Button,
  ButtonVariation,
  Container,
  Formik,
  FormInput,
  Icon,
  Layout,
  SelectOption,
  Text
} from '@wings-software/uicore'
import { Form, FormikProps } from 'formik'
import produce from 'immer'
import { useParams } from 'react-router-dom'
import { useStrings } from 'framework/strings'
import { NotificationSettingConfigDTO, usePutUserGroup, UserGroupDTO } from 'services/cd-ng'
import { TestEmailNotifications } from '@notifications/modals/ConfigureNotificationsModal/views/ConfigureEmailNotifications/ConfigureEmailNotifications'
import { TestPagerDutyNotifications } from '@notifications/modals/ConfigureNotificationsModal/views/ConfigurePagerDutyNotifications/ConfigurePagerDutyNotifications'
import { TestSlackNotifications } from '@notifications/modals/ConfigureNotificationsModal/views/ConfigureSlackNotifications/ConfigureSlackNotifications'
import type { ProjectPathProps } from '@common/interfaces/RouteInterfaces'
import { useToaster } from '@common/exports'
import { TestMSTeamsNotifications } from '@notifications/modals/ConfigureNotificationsModal/views/ConfigureMSTeamsNotifications/ConfigureMSTeamsNotifications'
import { getNotificationByConfig } from '@notifications/Utils/Utils'
import { EmailSchema, URLValidationSchema } from '@common/utils/Validation'
import useRBACError from '@rbac/utils/useRBACError/useRBACError'
import css from './NotificationList.module.scss'
 
interface NotificationListProps {
  userGroup: UserGroupDTO
  onSubmit: () => void
}
 
interface RowData extends NotificationSettingConfigDTO {
  groupEmail?: string
  recipient?: string
  slackWebhookUrl?: string
  pagerDutyKey?: string
  msTeamKeys?: string
}
export interface NotificationOption {
  label: string
  value: NonNullable<NotificationSettingConfigDTO['type']>
}
 
interface FieldDetails {
  name: keyof RowData
  textPlaceholder: string
}
 
interface ChannelRow {
  data: NotificationSettingConfigDTO | null
  userGroup: UserGroupDTO
  onSubmit: () => void
  options: SelectOption[]
  onRowDelete?: () => void
  notificationItems: SelectOption[]
}
 
const ChannelRow: React.FC<ChannelRow> = ({ data, userGroup, onSubmit, notificationItems, options, onRowDelete }) => {
  const { accountId, projectIdentifier, orgIdentifier } = useParams<ProjectPathProps>()
  const { getRBACErrorMessage } = useRBACError()
  const [isCreate, setIsCreate] = useState<boolean>(data ? false : true)
  const { getString } = useStrings()
  const [edit, setEdit] = useState<boolean>(false)
  const enableEdit = isCreate || edit
  const { showSuccess, showError } = useToaster()
 
  const { mutate: updateNotifications, loading } = usePutUserGroup({
    queryParams: {
      accountIdentifier: accountId,
      orgIdentifier,
      projectIdentifier
    }
  })
 
  const getFieldDetails = (type: NotificationSettingConfigDTO['type']): FieldDetails => {
    switch (type) {
      case 'EMAIL':
        return {
          name: 'groupEmail',
          textPlaceholder: getString('notifications.emailOrAlias')
        }
      case 'SLACK':
        return {
          name: 'slackWebhookUrl',
          textPlaceholder: getString('notifications.labelWebhookUrl')
        }
      case 'PAGERDUTY':
        return {
          name: 'pagerDutyKey',
          textPlaceholder: getString('notifications.labelPagerDuty')
        }
      case 'MSTEAMS':
        return {
          name: 'msTeamKeys',
          textPlaceholder: getString('notifications.labelMSTeam')
        }
      default:
        return {
          name: 'recipient',
          textPlaceholder: ''
        }
    }
  }
 
  const handleSubmit = async (values: RowData): Promise<void> => {
    const recipient = getFieldDetails(values.type).name
    if (isCreate) {
      userGroup.notificationConfigs?.push({
        type: values.type,
        [recipient]: values[recipient]
      })
    }
    if (edit) {
      userGroup.notificationConfigs = userGroup.notificationConfigs?.map(val => {
        return val.type === values.type ? values : val
      })
    }
    try {
      const edited = await updateNotifications(userGroup)
      /* istanbul ignore else */ Iif (edited) {
        showSuccess(getString('rbac.updateNotificationSuccess'))
        onSubmit()
        setEdit(false)
        setIsCreate(false)
      }
    } catch (e) {
      /* istanbul ignore next */
      showError(getRBACErrorMessage(e))
    }
  }
 
  const handleTest = async (formikProps: FormikProps<RowData>): Promise<boolean> => {
    const errors = await formikProps.validateForm()
    if (Object.keys(errors).length) {
      formikProps.setFieldTouched(getFieldDetails(formikProps.values.type).name, true)
      return false
    }
    return true
  }
 
  const handleDelete = async (values: RowData): Promise<void> => {
    userGroup.notificationConfigs = userGroup.notificationConfigs?.filter(val => val.type != values.type)
    try {
      const deleted = await updateNotifications(userGroup)
      /* istanbul ignore else */ Iif (deleted) {
        showSuccess(getString('rbac.updateNotificationSuccess'))
        onSubmit()
        setEdit(false)
      }
    } catch (e) {
      /* istanbul ignore next */
      showError(getRBACErrorMessage(e))
    }
  }
 
  return (
    <>
      <Formik<RowData>
        initialValues={{ ...data }}
        validationSchema={Yup.object().shape({
          type: Yup.string().required(),
          groupEmail: Yup.string().when(['type'], {
            is: 'EMAIL',
            then: EmailSchema()
          }),
          slackWebhookUrl: Yup.string().when(['type'], {
            is: 'SLACK',
            then: URLValidationSchema()
          }),
          pagerDutyKey: Yup.string().when(['type'], {
            is: 'PAGERDUTY',
            then: Yup.string().trim().required(getString('notifications.validationPDKey'))
          }),
          msTeamKeys: Yup.string().when(['type'], {
            is: 'MSTEAMS',
            then: URLValidationSchema()
          })
        })}
        formName="NotificationForm"
        onSubmit={values => {
          handleSubmit(values)
        }}
      >
        {formikProps => {
          return (
            <Form>
              <Layout.Horizontal spacing="small" className={cx(css.card, { [css.centerAlign]: !enableEdit })}>
                {enableEdit ? (
                  <>
                    <Container width="35%">
                      <FormInput.Select
                        name="type"
                        placeholder={getString('common.selectAChannel')}
                        items={edit ? options : notificationItems}
                        disabled={edit}
                      />
                    </Container>
                    <Container width="40%">
                      <FormInput.Text
                        name={getFieldDetails(formikProps.values.type).name}
                        placeholder={getFieldDetails(formikProps.values.type).textPlaceholder}
                      />
                    </Container>
                  </>
                ) : (
                  <>
                    <Container width="35%">
                      <Layout.Horizontal spacing="small">
                        <Icon name={getNotificationByConfig(data).icon} />
                        <Text>{getNotificationByConfig(data).label}</Text>
                      </Layout.Horizontal>
                    </Container>
                    <Container width="40%">
                      <Text lineClamp={1} className={css.overflow}>
                        {getNotificationByConfig(data).value}
                      </Text>
                    </Container>
                  </>
                )}
                <Container width="25%">
                  <Layout.Horizontal flex={{ justifyContent: 'flex-end' }} spacing="xsmall">
                    {formikProps.values.type == 'EMAIL' ? (
                      <TestEmailNotifications
                        onClick={() => handleTest(formikProps)}
                        buttonProps={{
                          minimal: true
                        }}
                      />
                    ) : null}
                    {formikProps.values.type == 'SLACK' ? (
                      <TestSlackNotifications
                        data={formikProps.values as any}
                        onClick={() => handleTest(formikProps)}
                        buttonProps={{
                          minimal: true
                        }}
                      />
                    ) : null}
                    {formikProps.values.type == 'PAGERDUTY' ? (
                      <TestPagerDutyNotifications
                        data={formikProps.values as any}
                        onClick={() => handleTest(formikProps)}
                        buttonProps={{
                          minimal: true
                        }}
                      />
                    ) : null}
                    {formikProps.values.type == 'MSTEAMS' ? (
                      <TestMSTeamsNotifications
                        data={formikProps.values as any}
                        buttonProps={{
                          minimal: true
                        }}
                        errors={{}}
                        onClick={() => handleTest(formikProps)}
                      />
                    ) : null}
                    {enableEdit ? (
                      <Button text={getString('save')} minimal type="submit" disabled={loading} />
                    ) : (
                      <>
                        <Button icon="edit" minimal onClick={() => setEdit(true)} className={css.button} />
                        <Button
                          icon="trash"
                          minimal
                          onClick={() => handleDelete(formikProps.values)}
                          className={css.button}
                        />
                      </>
                    )}
                    {isCreate ? (
                      <Button icon="trash" minimal onClick={() => onRowDelete?.()} className={css.button} />
                    ) : null}
                  </Layout.Horizontal>
                </Container>
              </Layout.Horizontal>
            </Form>
          )
        }}
      </Formik>
    </>
  )
}
 
const NotificationList: React.FC<NotificationListProps> = ({ userGroup, onSubmit }) => {
  const notifications = userGroup.notificationConfigs
  const [values, setValues] = useState<(NotificationSettingConfigDTO | null)[]>(notifications || [])
  const { getString } = useStrings()
 
  const EmailNotification: NotificationOption = {
    label: getString('notifications.emailOrAlias'),
    value: 'EMAIL'
  }
 
  const SlackNotification: NotificationOption = {
    label: getString('notifications.labelWebhookUrl'),
    value: 'SLACK'
  }
 
  const PDNotification: NotificationOption = {
    label: getString('notifications.labelPagerDuty'),
    value: 'PAGERDUTY'
  }
 
  const MSNotification: NotificationOption = {
    label: getString('notifications.labelMSTeam'),
    value: 'MSTEAMS'
  }
 
  const options = [EmailNotification, SlackNotification, PDNotification, MSNotification]
 
  const getNotificationOption = (type: NotificationSettingConfigDTO['type']): NotificationOption => {
    switch (type) {
      case 'EMAIL':
        return EmailNotification
      case 'SLACK':
        return SlackNotification
      case 'PAGERDUTY':
        return PDNotification
      case 'MSTEAMS':
        return MSNotification
      default:
        return EmailNotification
    }
  }
 
  const onRowDelete = (index: number): void => {
    setValues(
      produce(values, draft => {
        draft.splice(index, 1)
      })
    )
  }
 
  const getNotificationItems = (): SelectOption[] => {
    const existingOptions = values?.map(value => (value?.type ? getNotificationOption(value.type) : null))
    return options.filter(val => !existingOptions.includes(val))
  }
 
  return (
    <>
      {values?.map((item, index) => (
        <div key={index}>
          <ChannelRow
            data={item}
            onSubmit={onSubmit}
            onRowDelete={() => onRowDelete(index)}
            notificationItems={getNotificationItems()}
            options={options}
            userGroup={userGroup}
          />
        </div>
      ))}
      <Layout.Horizontal padding={{ top: 'small' }}>
        {values.length < 4 && !values.includes(null) ? (
          <Button
            text={getString('plusNumber', { number: getString('common.channel') })}
            data-testid="addChannel"
            variation={ButtonVariation.LINK}
            onClick={() => {
              setValues(
                produce(values, draft => {
                  draft.push(null)
                })
              )
            }}
          />
        ) : null}
      </Layout.Horizontal>
    </>
  )
}
 
export default NotificationList