All files / modules/75-cf/hooks useToggleFeatureFlag.ts

100% Statements 11/11
87.5% Branches 7/8
100% Functions 4/4
100% Lines 10/10

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              5x 5x                   5x 4x                     4x                   5x           17x                   17x   2x       2x              
/*
 * 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 { FeatureFlagActivationStatus } from '@cf/utils/CFUtils'
import { Feature, PatchFeatureQueryParams, usePatchFeature } from 'services/cf'
import type { GitDetails } from './useGitSync'
 
export interface UseToggleFeatureFlagProps {
  accountIdentifier: string
  orgIdentifier: string
  environmentIdentifier: string
  projectIdentifier: string
}
 
const makeInstruction = (isOn: boolean, gitDetails?: GitDetails) => {
  const instruction = {
    instructions: [
      {
        kind: 'setFeatureFlagState',
        parameters: {
          state: isOn ? FeatureFlagActivationStatus.ON : FeatureFlagActivationStatus.OFF
        }
      }
    ]
  }
 
  return gitDetails ? { ...instruction, gitDetails } : instruction
}
 
export interface UseToggleFeatureFlag {
  on: (flagIdentifier: string, gitDetails?: GitDetails) => Promise<Feature>
  off: (flagIdentifier: string, gitDetails?: GitDetails) => Promise<Feature>
  loading: boolean
  error: string | undefined
}
 
export const useToggleFeatureFlag = ({
  accountIdentifier,
  orgIdentifier,
  environmentIdentifier,
  projectIdentifier
}: UseToggleFeatureFlagProps): UseToggleFeatureFlag => {
  const { mutate, loading, error } = usePatchFeature({
    identifier: '',
    queryParams: {
      projectIdentifier,
      environmentIdentifier,
      accountIdentifier,
      orgIdentifier
    } as PatchFeatureQueryParams
  })
 
  return {
    on: (flagIdentifier: string, gitDetails?: GitDetails): Promise<Feature> =>
      mutate(makeInstruction(true, gitDetails), {
        pathParams: { identifier: flagIdentifier }
      }),
    off: (flagIdentifier: string, gitDetails?: GitDetails): Promise<Feature> =>
      mutate(makeInstruction(false, gitDetails), {
        pathParams: { identifier: flagIdentifier }
      }),
    loading,
    error: error?.message
  }
}