All files / modules/75-cf/hooks useGitSync.tsx

87.04% Statements 47/54
75.67% Branches 199/263
71.43% Functions 10/14
86.54% Lines 45/52

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              14x 14x   14x 14x   14x 14x 14x 14x 14x 14x                                                                   14x   14x         15x 15x   15x               15x               15x   15x 12x       15x 12x       15x 12x       15x 12x       15x 12x     12x       15x   15x 1x 1x     15x                             15x                         15x                                     15x 2x 1x                     1x 1x       15x 1x                     1x 1x     15x                            
/*
 * 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 { useParams } from 'react-router-dom'
import React, { useEffect, useMemo, useState } from 'react'
import type { ObjectSchema } from 'yup'
import * as yup from 'yup'
import { useModalHook } from '@harness/use-modal'
import type { ModulePathParams, ProjectPathProps } from '@common/interfaces/RouteInterfaces'
import { GitRepo, GitSyncErrorResponse, useGetGitRepo, usePatchGitRepo } from 'services/cf'
import { useFeatureFlag } from '@common/hooks/useFeatureFlag'
import { FeatureFlag } from '@common/featureFlags'
import { useStrings } from 'framework/strings'
import GitErrorModal from '@cf/components/GitErrorModal/GitErrorModal'
import InvalidYamlModal from '@cf/components/InvalidYamlModal/InvalidYamlModal'
 
export interface GitDetails {
  branch: string
  filePath: string
  repoIdentifier: string
  rootFolder: string
  commitMsg: string
}
 
export interface GitSyncFormValues {
  gitDetails: GitDetails
  autoCommit: boolean
}
 
interface GitSyncFormMeta {
  gitSyncInitialValues: GitSyncFormValues
  gitSyncValidationSchema: ObjectSchema<Record<string, unknown> | undefined>
}
 
export interface UseGitSync {
  gitRepoDetails?: GitRepo
  isAutoCommitEnabled: boolean
  isGitSyncEnabled: boolean
  isGitSyncPaused: boolean
  isGitSyncActionsEnabled: boolean
  gitSyncLoading: boolean
  apiError: string
  handleAutoCommit: (newAutoCommitValue: boolean) => Promise<void>
  handleGitPause: (newGitPauseValue: boolean) => Promise<void>
  getGitSyncFormMeta: (autoCommitMessage?: string) => GitSyncFormMeta
  handleError: (error: GitSyncErrorResponse) => void
}
 
export const GIT_SYNC_ERROR_CODE = 424
 
export const useGitSync = (): UseGitSync => {
  const {
    projectIdentifier,
    accountId: accountIdentifier,
    orgIdentifier
  } = useParams<ProjectPathProps & ModulePathParams>()
  const { getString } = useStrings()
 
  const getGitRepo = useGetGitRepo({
    identifier: projectIdentifier,
    queryParams: {
      accountIdentifier,
      orgIdentifier
    }
  })
 
  const patchGitRepo = usePatchGitRepo({
    identifier: projectIdentifier,
    queryParams: {
      accountIdentifier,
      orgIdentifier
    }
  })
 
  const FF_GITSYNC = useFeatureFlag(FeatureFlag.FF_GITSYNC)
 
  const isGitSyncEnabled = useMemo<boolean>(
    () => !!(FF_GITSYNC && getGitRepo?.data?.repoSet && getGitRepo?.data?.repoDetails?.enabled),
    [FF_GITSYNC, getGitRepo?.data?.repoDetails?.enabled, getGitRepo?.data?.repoSet]
  )
 
  const isAutoCommitEnabled = useMemo<boolean>(
    () => !!(FF_GITSYNC && getGitRepo?.data?.repoSet && getGitRepo?.data?.repoDetails?.autoCommit),
    [FF_GITSYNC, getGitRepo?.data?.repoDetails?.autoCommit, getGitRepo?.data?.repoSet]
  )
 
  const isGitSyncActionsEnabled = useMemo<boolean>(
    () => !!(FF_GITSYNC && getGitRepo?.data?.repoSet),
    [FF_GITSYNC, getGitRepo?.data?.repoSet]
  )
 
  const isGitSyncPaused = useMemo<boolean>(
    () => !!(FF_GITSYNC && getGitRepo?.data?.repoSet && !getGitRepo?.data?.repoDetails?.enabled),
    [FF_GITSYNC, getGitRepo?.data?.repoDetails?.enabled, getGitRepo?.data?.repoSet]
  )
 
  useEffect(() => {
    Iif (getGitRepo.data?.repoDetails?.yamlError) {
      showInvalidYamlModal()
    } else {
      hideInvalidYamlModal()
    }
  }, [getGitRepo.data?.repoDetails?.yamlError])
 
  const [apiError, setApiError] = useState<string>('')
 
  const handleError = (error: GitSyncErrorResponse): void => {
    setApiError(error.message)
    showErrorModal()
  }
 
  const [showErrorModal, hideErrorModal] = useModalHook(
    () => (
      <GitErrorModal
        onClose={hideErrorModal}
        onSubmit={() => {
          const newGitPauseValue = false
          handleGitPause(newGitPauseValue)
          hideErrorModal()
        }}
        apiError={apiError}
      />
    ),
    [apiError]
  )
 
  const [showInvalidYamlModal, hideInvalidYamlModal] = useModalHook(
    () => (
      <InvalidYamlModal
        handleRetry={() => getGitRepo.refetch()}
        isLoading={getGitRepo.loading}
        apiError={getGitRepo.data?.repoDetails?.yamlError}
        flagsYamlFilename={getGitRepo.data?.repoDetails?.filePath}
        handleClose={hideInvalidYamlModal}
      />
    ),
    [getGitRepo.data?.repoDetails?.yamlError, getGitRepo.loading]
  )
 
  const getGitSyncFormMeta = (autoCommitMessage?: string): GitSyncFormMeta => ({
    gitSyncInitialValues: {
      gitDetails: {
        branch: getGitRepo?.data?.repoDetails?.branch || '',
        filePath: getGitRepo?.data?.repoDetails?.filePath || '',
        repoIdentifier: getGitRepo?.data?.repoDetails?.repoIdentifier || '',
        rootFolder: getGitRepo?.data?.repoDetails?.rootFolder || '',
        commitMsg:
          isAutoCommitEnabled && autoCommitMessage
            ? getString('cf.gitSync.autoCommitMsg', { msg: autoCommitMessage })
            : ''
      },
      autoCommit: isAutoCommitEnabled
    },
    gitSyncValidationSchema: yup.object().shape({
      commitMsg: isGitSyncEnabled ? yup.string().required(getString('cf.gitSync.commitMsgRequired')) : yup.string()
    })
  })
 
  const handleAutoCommit = async (newAutoCommitValue: boolean): Promise<void> => {
    if (isAutoCommitEnabled !== newAutoCommitValue) {
      const instruction = {
        instructions: [
          {
            kind: 'setAutoCommit',
            parameters: {
              autoCommit: newAutoCommitValue
            }
          }
        ]
      }
 
      await patchGitRepo.mutate(instruction)
      await getGitRepo.refetch()
    }
  }
 
  const handleGitPause = async (newGitPauseValue: boolean): Promise<void> => {
    const instruction = {
      instructions: [
        {
          kind: 'setEnabled',
          parameters: {
            enabled: newGitPauseValue
          }
        }
      ]
    }
 
    await patchGitRepo.mutate(instruction)
    await getGitRepo.refetch()
  }
 
  return {
    gitRepoDetails: getGitRepo?.data?.repoDetails,
    isAutoCommitEnabled,
    isGitSyncEnabled,
    isGitSyncPaused,
    isGitSyncActionsEnabled,
    gitSyncLoading: getGitRepo.loading || patchGitRepo.loading,
    apiError,
    handleAutoCommit,
    handleGitPause,
    getGitSyncFormMeta,
    handleError
  }
}