All files / modules/10-common/hooks useGetUsageAndLimit.ts

96.43% Statements 54/56
77.78% Branches 98/126
88.89% Functions 8/9
96.43% Lines 54/56

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              14x 14x 14x 14x                   14x 14x 14x   14x 14x 14x                                                                                                                         8x       8x   2x         2x     2x 2x           2x     2x 2x           2x     2x             8x               8x         8x   8x   8x 4x                 8x     14x     8x 8x       8x 8x           8x                         8x                         8x                         8x                         8x                 4x   1x                   1x   1x                     1x   1x                   1x   1x                           1x       8x 4x                                       8x     14x 8x 8x 8x    
/*
 * 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 { useState } from 'react'
import moment from 'moment'
import { useParams } from 'react-router-dom'
import {
  useGetLicensesAndSummary,
  GetLicensesAndSummaryQueryParams,
  CILicenseSummaryDTO,
  CFLicenseSummaryDTO,
  CELicenseSummaryDTO,
  CDLicenseSummaryDTO,
  useGetCDLicenseUsageForServiceInstances,
  useGetCDLicenseUsageForServices
} from 'services/cd-ng'
import { useDeepCompareEffect } from '@common/hooks'
import { useGetLicenseUsage as useGetFFUsage } from 'services/cf'
import { useGetUsage as useGetCIUsage } from 'services/ci'
import type { AccountPathProps } from '@common/interfaces/RouteInterfaces'
import { ModuleName } from 'framework/types/ModuleName'
import { useGetCCMLicenseUsage } from 'services/ce'
import { useLicenseStore } from 'framework/LicenseStore/LicenseStoreContext'
 
export interface UsageAndLimitReturn {
  limitData: LimitReturn
  usageData: UsageReturn
}
 
interface UsageReturn {
  usage?: UsageProps
  loadingUsage?: boolean
  usageErrorMsg?: string
  refetchUsage?: () => void
}
 
interface UsageProp {
  count?: number
  displayName?: string
}
 
interface UsageProps {
  ci?: {
    activeCommitters?: UsageProp
  }
  ff?: {
    activeClientMAUs?: UsageProp
    activeFeatureFlagUsers?: UsageProp
  }
  ccm?: {
    activeSpend?: UsageProp
  }
  cd?: {
    activeServices?: UsageProp
    activeServiceInstances?: UsageProp
  }
}
 
interface LimitProps {
  ci?: {
    totalDevelopers?: number
  }
  ff?: {
    totalClientMAUs?: number
    totalFeatureFlagUnits?: number
  }
  cd?: {
    totalServiceInstances?: number
    totalWorkload?: number
  }
  ccm?: {
    totalSpendLimit?: number
  }
}
 
interface LimitReturn {
  limit?: LimitProps
  loadingLimit?: boolean
  limitErrorMsg?: string
  refetchLimit?: () => void
}
 
function useGetLimit(module: ModuleName): LimitReturn {
  const { accountId } = useParams<AccountPathProps>()
 
  function getLimitByModule(): LimitProps | undefined {
    let moduleLimit
    switch (module) {
      case ModuleName.CI: {
        moduleLimit = {
          ci: {
            totalDevelopers: (limitData?.data as CILicenseSummaryDTO)?.totalDevelopers
          }
        }
        break
      }
      case ModuleName.CF: {
        const cfData = limitData?.data as CFLicenseSummaryDTO
        moduleLimit = {
          ff: {
            totalClientMAUs: cfData?.totalClientMAUs,
            totalFeatureFlagUnits: cfData?.totalFeatureFlagUnits
          }
        }
        break
      }
      case ModuleName.CD: {
        const cdData = limitData?.data as CDLicenseSummaryDTO
        moduleLimit = {
          cd: {
            totalServiceInstances: cdData?.totalServiceInstances,
            totalWorkload: cdData?.totalWorkload
          }
        }
        break
      }
      case ModuleName.CE: {
        moduleLimit = {
          ccm: {
            totalSpendLimit: (limitData?.data as CELicenseSummaryDTO)?.totalSpendLimit
          }
        }
      }
    }
    return moduleLimit
  }
 
  const {
    data: limitData,
    loading: loadingLimit,
    error: limitError,
    refetch: refetchLimit
  } = useGetLicensesAndSummary({
    queryParams: { moduleType: module as GetLicensesAndSummaryQueryParams['moduleType'] },
    accountIdentifier: accountId
  })
 
  const [limitReturn, setLimitReturn] = useState<LimitReturn>({})
 
  const limit = getLimitByModule()
 
  useDeepCompareEffect(() => {
    setLimitReturn({
      limit,
      limitErrorMsg: limitError?.message,
      loadingLimit,
      refetchLimit
    })
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [limitData, loadingLimit, limitError])
 
  return limitReturn
}
 
const timestamp = moment.now()
 
function useGetCCMTimeStamp(): number {
  const { licenseInformation } = useLicenseStore()
  return licenseInformation?.CE?.startTime || 0
}
 
function useGetUsage(module: ModuleName): UsageReturn {
  const { accountId } = useParams<AccountPathProps>()
  const [usageData, setUsageData] = useState<UsageReturn>({})
  const {
    data: ciUsageData,
    loading: loadingCIUsage,
    error: ciUsageError,
    refetch: refetchCIUsage
  } = useGetCIUsage({
    queryParams: {
      accountIdentifier: accountId,
      timestamp
    },
    lazy: module !== ModuleName.CI
  })
 
  const {
    data: ffUsageData,
    loading: loadingFFUsage,
    error: ffUsageError,
    refetch: refetchFFUsage
  } = useGetFFUsage({
    queryParams: {
      accountIdentifier: accountId,
      timestamp
    },
    lazy: module !== ModuleName.CF
  })
 
  const {
    data: ccmUsageData,
    loading: loadingCCMUsage,
    error: ccmUsageError,
    refetch: refetchCCMUsage
  } = useGetCCMLicenseUsage({
    queryParams: {
      accountIdentifier: accountId,
      timestamp: useGetCCMTimeStamp()
    },
    lazy: module !== ModuleName.CE
  })
 
  const {
    data: cdSIUsageData,
    loading: loadingCDSIUsage,
    error: cdSIUsageError,
    refetch: refetchCDSIUsage
  } = useGetCDLicenseUsageForServiceInstances({
    queryParams: {
      accountIdentifier: accountId,
      timestamp
    },
    lazy: module !== ModuleName.CD
  })
 
  const {
    data: cdUsageData,
    loading: loadingCDUsage,
    error: cdUsageError,
    refetch: refetchCDUsage
  } = useGetCDLicenseUsageForServices({
    queryParams: {
      accountIdentifier: accountId,
      timestamp
    },
    lazy: module !== ModuleName.CD
  })
 
  function setUsageByModule(): void {
    switch (module) {
      case ModuleName.CI:
        setUsageData({
          usage: {
            ci: {
              activeCommitters: ciUsageData?.data?.activeCommitters
            }
          },
          loadingUsage: loadingCIUsage,
          usageErrorMsg: ciUsageError?.message,
          refetchUsage: refetchCIUsage
        })
        break
      case ModuleName.CF:
        setUsageData({
          usage: {
            ff: {
              activeClientMAUs: ffUsageData?.activeClientMAUs,
              activeFeatureFlagUsers: ffUsageData?.activeFeatureFlagUsers
            }
          },
          loadingUsage: loadingFFUsage,
          usageErrorMsg: ffUsageError?.message,
          refetchUsage: refetchFFUsage
        })
        break
      case ModuleName.CE:
        setUsageData({
          usage: {
            ccm: {
              activeSpend: ccmUsageData?.data?.activeSpend
            }
          },
          loadingUsage: loadingCCMUsage,
          usageErrorMsg: ccmUsageError?.message,
          refetchUsage: refetchCCMUsage
        })
        break
      case ModuleName.CD:
        setUsageData({
          usage: {
            cd: {
              activeServiceInstances: cdSIUsageData?.data?.activeServiceInstances,
              activeServices: cdUsageData?.data?.activeServices
            }
          },
          loadingUsage: loadingCDSIUsage || loadingCDUsage,
          usageErrorMsg: cdSIUsageError?.message || cdUsageError?.message,
          refetchUsage: () => {
            refetchCDSIUsage()
            refetchCDUsage()
          }
        })
        break
    }
  }
 
  useDeepCompareEffect(() => {
    setUsageByModule()
    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [
    ciUsageData,
    ciUsageError,
    loadingCIUsage,
    ffUsageData,
    ffUsageError,
    loadingFFUsage,
    ccmUsageData,
    ccmUsageError,
    loadingCCMUsage,
    cdSIUsageData,
    cdUsageData,
    cdSIUsageError,
    cdUsageError,
    loadingCDSIUsage,
    loadingCDUsage
  ])
 
  return usageData
}
 
export function useGetUsageAndLimit(module: ModuleName): UsageAndLimitReturn {
  const limit = useGetLimit(module)
  const usage = useGetUsage(module)
  return { limitData: limit, usageData: usage }
}