All files / modules/30-secrets/pages/secretDetails SecretDetails.tsx

71.88% Statements 69/96
44.68% Branches 42/94
61.54% Functions 8/13
71.88% Lines 69/96

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              10x 10x 10x 10x 10x                       10x                   10x 10x   10x 10x     10x 10x 10x 10x 10x 10x 10x 10x 10x                           10x       10x 2x 2x 2x 2x     2x 2x 2x   2x 1x 1x                           2x                 2x                             2x         2x                 2x 1x 1x 1x       1x             2x             2x                                         2x                         2x           2x                                                                                                 10x 15x 13x 13x 13x   13x   13x 13x   13x   13x 7x     13x               13x 2x 1x 1x   1x             13x 2x 2x 2x         13x                   1x                                                           10x  
/*
 * 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, { useState, useEffect } from 'react'
import { useParams } from 'react-router-dom'
import { parse } from 'yaml'
import { omit, without, defaultTo } from 'lodash-es'
import {
  Layout,
  Container,
  Button,
  ButtonVariation,
  PageHeader,
  VisualYamlSelectedView as SelectedView,
  VisualYamlToggle,
  useConfirmationDialog,
  useToaster
} from '@wings-software/uicore'
 
import {
  SecretTextSpecDTO,
  usePutSecretViaYaml,
  ResponseSecretResponseWrapper,
  useGetYamlSchema,
  useGetYamlSnippetMetadata,
  useGetYamlSnippet,
  SecretResponseWrapper
} from 'services/cd-ng'
 
import { useStrings } from 'framework/strings'
import YamlBuilder from '@common/components/YAMLBuilder/YamlBuilder'
import type { SnippetFetchResponse, YamlBuilderHandlerBinding } from '@common/interfaces/YAMLBuilderProps'
import useCreateSSHCredModal from '@secrets/modals/CreateSSHCredModal/useCreateSSHCredModal'
import useCreateUpdateSecretModal from '@secrets/modals/CreateSecretModal/useCreateUpdateSecretModal'
import type { SecretIdentifiers } from '@secrets/components/CreateUpdateSecret/CreateUpdateSecret'
import type { ModulePathParams, ProjectPathProps, SecretsPathProps } from '@common/interfaces/RouteInterfaces'
import { getSnippetTags } from '@common/utils/SnippetUtils'
import { useDocumentTitle } from '@common/hooks/useDocumentTitle'
import { ResourceType } from '@rbac/interfaces/ResourceType'
import RbacButton from '@rbac/components/Button/Button'
import { PermissionIdentifier } from '@rbac/interfaces/PermissionIdentifier'
import { yamlStringify } from '@common/utils/YamlHelperMethods'
import useRBACError from '@rbac/utils/useRBACError/useRBACError'
import ViewSecretDetails from './views/ViewSecretDetails'
import './SecretDetails.module.scss'
 
interface SecretDetailsProps {
  secretData?: ResponseSecretResponseWrapper
  refetch?: () => void
}
 
interface YAMLSecretDetailsProps {
  refetch?: () => void
  secretData: SecretResponseWrapper
  edit?: boolean
  setEdit: React.Dispatch<React.SetStateAction<boolean | undefined>>
}
 
const yamlSanityConfig = {
  removeEmptyString: false
}
 
const YAMLSecretDetails: React.FC<YAMLSecretDetailsProps> = ({ refetch, secretData, edit, setEdit }) => {
  const { getRBACErrorMessage } = useRBACError()
  const { getString } = useStrings()
  const { showSuccess, showError } = useToaster()
  const { accountId, projectIdentifier, orgIdentifier, secretId } = useParams<
    ProjectPathProps & SecretsPathProps & ModulePathParams
  >()
  const [yamlHandler, setYamlHandler] = React.useState<YamlBuilderHandlerBinding | undefined>()
  const [snippetFetchResponse, setSnippetFetchResponse] = React.useState<SnippetFetchResponse>()
  const [fieldsRemovedFromYaml, setFieldsRemovedFromYaml] = useState(['draft', 'createdAt', 'updatedAt'])
 
  useEffect(() => {
    Eif (secretData.secret.type !== 'SecretText') {
      return
    }
 
    switch ((secretData.secret.spec as SecretTextSpecDTO)?.valueType) {
      case 'Inline':
        setFieldsRemovedFromYaml([...fieldsRemovedFromYaml, 'secret.spec.value'])
        break
      case 'Reference':
        // 'value' field should be persisted in visual->yaml transistion for reference type
        setFieldsRemovedFromYaml(without(fieldsRemovedFromYaml, 'secret.spec.value'))
        break
    }
  }, [secretData])
 
  const { data: secretSchema } = useGetYamlSchema({
    queryParams: {
      entityType: 'Secrets',
      projectIdentifier,
      orgIdentifier,
      accountIdentifier: accountId
    }
  })
 
  const { data: snippetData } = useGetYamlSnippetMetadata({
    queryParams: {
      tags: getSnippetTags('Secrets')
    },
    queryParamStringifyOptions: {
      arrayFormat: 'repeat'
    }
  })
 
  const {
    data: snippet,
    refetch: refetchSnippet,
    cancel,
    loading: isFetchingSnippet,
    error: errorFetchingSnippet
  } = useGetYamlSnippet({
    identifier: '',
    lazy: true
  })
 
  const onSnippetCopy = async (identifier: string): Promise<void> => {
    cancel()
    await refetchSnippet({
      pathParams: {
        identifier
      }
    })
  }
 
  useEffect(() => {
    let snippetStr = ''
    try {
      snippetStr = snippet?.data ? yamlStringify(snippet.data, { indent: 4 }) : ''
    } catch {
      /**/
    }
    setSnippetFetchResponse({
      snippet: snippetStr,
      loading: isFetchingSnippet,
      error: errorFetchingSnippet
    })
  }, [isFetchingSnippet])
 
  const { mutate: updateSecretYaml } = usePutSecretViaYaml({
    identifier: secretId,
    queryParams: { accountIdentifier: accountId, orgIdentifier, projectIdentifier },
    // this is required to make sure backend understands the content type correctly
    requestOptions: { headers: { 'content-type': 'application/yaml' } }
  })
 
  const handleSaveYaml = async (): Promise<void> => {
    const yamlData = yamlHandler?.getLatestYaml()
    let jsonData
    try {
      jsonData = parse(defaultTo(yamlData, ''))
    } catch (err) {
      showError(err.message)
    }
 
    if (yamlData && jsonData) {
      try {
        await updateSecretYaml(yamlData as any)
        showSuccess(getString('secrets.secret.updateSuccess'))
        setEdit(false)
        refetch?.()
      } catch (err) {
        showError(getRBACErrorMessage(err))
      }
    }
  }
 
  const { openDialog } = useConfirmationDialog({
    cancelButtonText: getString('cancel'),
    contentText: getString('continueWithoutSavingText'),
    titleText: getString('continueWithoutSavingTitle'),
    confirmButtonText: getString('confirm'),
    onCloseDialog: isConfirmed => {
      if (isConfirmed) {
        setEdit(false)
        refetch?.()
      }
    }
  })
 
  const resetEditor = (event: React.MouseEvent<Element, MouseEvent>): void => {
    event.preventDefault()
    event.stopPropagation()
    openDialog()
  }
 
  return (
    <Container>
      {edit && (
        <>
          <YamlBuilder
            entityType={'Secrets'}
            fileName={`${secretData.secret.name}.yaml`}
            existingJSON={omit(secretData, fieldsRemovedFromYaml)}
            bind={setYamlHandler}
            onSnippetCopy={onSnippetCopy}
            snippetFetchResponse={snippetFetchResponse}
            schema={secretSchema?.data}
            isReadOnlyMode={false}
            snippets={snippetData?.data?.yamlSnippets}
            yamlSanityConfig={yamlSanityConfig}
            showSnippetSection={false}
          />
          <Layout.Horizontal spacing="medium">
            <Button
              intent="primary"
              text={getString('save')}
              onClick={handleSaveYaml}
              margin={{ top: 'large' }}
              variation={ButtonVariation.PRIMARY}
            />
            <Button
              text={getString('cancel')}
              margin={{ top: 'large' }}
              onClick={resetEditor}
              variation={ButtonVariation.TERTIARY}
            />
          </Layout.Horizontal>
        </>
      )}
      {!edit && (
        <YamlBuilder
          entityType={'Secrets'}
          existingJSON={omit(secretData, fieldsRemovedFromYaml)}
          fileName={`${secretData.secret.name}.yaml`}
          isReadOnlyMode={true}
          showSnippetSection={false}
          onEnableEditMode={() => setEdit(true)}
          yamlSanityConfig={yamlSanityConfig}
        />
      )}
    </Container>
  )
}
 
const SecretDetails: React.FC<SecretDetailsProps> = props => {
  const { getString } = useStrings()
  const [edit, setEdit] = useState<boolean>()
  const [mode, setMode] = useState<SelectedView>(SelectedView.VISUAL)
  const data = props.secretData
 
  const [secretData, setSecretData] = useState(data?.data)
 
  const { openCreateSSHCredModal } = useCreateSSHCredModal({ onSuccess: props.refetch })
  const { openCreateSecretModal } = useCreateUpdateSecretModal({ onSuccess: props.refetch })
 
  useDocumentTitle([getString('overview'), defaultTo(secretData?.secret.name, ''), getString('common.secrets')])
 
  useEffect(() => {
    setSecretData(data?.data)
  }, [data?.data])
 
  Iif (!secretData) {
    return (
      <Container flex={{ align: 'center-center' }} padding="xxlarge">
        {getString('noData')}
      </Container>
    )
  }
 
  const handleVisualMode = (): void => {
    if (secretData.secret.type === 'SSHKey') {
      openCreateSSHCredModal(data?.data?.secret)
      return
    }
    openCreateSecretModal(secretData.secret.type, {
      identifier: secretData.secret?.identifier,
      orgIdentifier: secretData.secret?.orgIdentifier,
      projectIdentifier: secretData.secret?.projectIdentifier
    } as SecretIdentifiers)
  }
 
  const handleEdit = (): void => {
    Eif (mode === SelectedView.VISUAL) {
      handleVisualMode()
      return
    }
    setEdit(true)
  }
 
  return (
    <>
      <PageHeader size="standard" title={getString('overview')} />
      <Container padding={{ top: 'large', left: 'huge', right: 'huge' }}>
        <Container padding={{ bottom: 'large' }}>
          {edit ? null : (
            <Layout.Horizontal flex>
              <VisualYamlToggle
                selectedView={mode}
                onChange={nextMode => {
                  setMode(nextMode)
                }}
              />
              <RbacButton
                text={getString('editDetails')}
                icon="edit"
                onClick={handleEdit}
                permission={{
                  permission: PermissionIdentifier.UPDATE_SECRET,
                  resource: {
                    resourceType: ResourceType.SECRET,
                    resourceIdentifier: secretData.secret.identifier
                  }
                }}
                variation={ButtonVariation.PRIMARY}
              />
            </Layout.Horizontal>
          )}
        </Container>
        {mode === SelectedView.YAML ? (
          <YAMLSecretDetails refetch={props.refetch} secretData={secretData} edit={edit} setEdit={setEdit} />
        ) : (
          //View in Visual Mode
          <ViewSecretDetails secret={secretData} />
        )}
      </Container>
    </>
  )
}
 
export default SecretDetails