-
-
Notifications
You must be signed in to change notification settings - Fork 730
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This PR sets up the feature flag for the new strategy configuration and duplicates the components for the new setup
- Loading branch information
1 parent
2322e11
commit ec67045
Showing
9 changed files
with
656 additions
and
3 deletions.
There are no files selected for viewing
20 changes: 20 additions & 0 deletions
20
...ponent/feature/FeatureStrategy/NewFeatureStrategyCreate/NewFeatureStrategyCreate.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import { formatAddStrategyApiCode } from 'component/feature/FeatureStrategy/FeatureStrategyCreate/FeatureStrategyCreate'; | ||
|
||
test('formatAddStrategyApiCode', () => { | ||
expect( | ||
formatAddStrategyApiCode( | ||
'projectId', | ||
'featureId', | ||
'environmentId', | ||
{ id: 'strategyId' }, | ||
'unleashUrl', | ||
), | ||
).toMatchInlineSnapshot(` | ||
"curl --location --request POST 'unleashUrl/api/admin/projects/projectId/features/featureId/environments/environmentId/strategies' \\\\ | ||
--header 'Authorization: INSERT_API_KEY' \\\\ | ||
--header 'Content-Type: application/json' \\\\ | ||
--data-raw '{ | ||
\\"id\\": \\"strategyId\\" | ||
}'" | ||
`); | ||
}); |
249 changes: 249 additions & 0 deletions
249
...c/component/feature/FeatureStrategy/NewFeatureStrategyCreate/NewFeatureStrategyCreate.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,249 @@ | ||
import React, { useEffect, useRef, useState } from 'react'; | ||
import { useRequiredPathParam } from 'hooks/useRequiredPathParam'; | ||
import { useRequiredQueryParam } from 'hooks/useRequiredQueryParam'; | ||
import { FeatureStrategyForm } from 'component/feature/FeatureStrategy/FeatureStrategyForm/FeatureStrategyForm'; | ||
import FormTemplate from 'component/common/FormTemplate/FormTemplate'; | ||
import useUiConfig from 'hooks/api/getters/useUiConfig/useUiConfig'; | ||
import useFeatureStrategyApi from 'hooks/api/actions/useFeatureStrategyApi/useFeatureStrategyApi'; | ||
import { formatUnknownError } from 'utils/formatUnknownError'; | ||
import { useNavigate } from 'react-router-dom'; | ||
import useToast from 'hooks/useToast'; | ||
import { IFeatureStrategy, IFeatureStrategyPayload } from 'interfaces/strategy'; | ||
import { | ||
createStrategyPayload, | ||
featureStrategyDocsLink, | ||
featureStrategyDocsLinkLabel, | ||
featureStrategyHelp, | ||
formatFeaturePath, | ||
} from '../FeatureStrategyEdit/FeatureStrategyEdit'; | ||
import { CREATE_FEATURE_STRATEGY } from 'component/providers/AccessProvider/permissions'; | ||
import { ISegment } from 'interfaces/segment'; | ||
import { formatStrategyName } from 'utils/strategyNames'; | ||
import { useFormErrors } from 'hooks/useFormErrors'; | ||
import { createFeatureStrategy } from 'utils/createFeatureStrategy'; | ||
import { useStrategy } from 'hooks/api/getters/useStrategy/useStrategy'; | ||
import { useCollaborateData } from 'hooks/useCollaborateData'; | ||
import { useFeature } from 'hooks/api/getters/useFeature/useFeature'; | ||
import { IFeatureToggle } from 'interfaces/featureToggle'; | ||
import { comparisonModerator } from '../featureStrategy.utils'; | ||
import { useChangeRequestApi } from 'hooks/api/actions/useChangeRequestApi/useChangeRequestApi'; | ||
import { useChangeRequestsEnabled } from 'hooks/useChangeRequestsEnabled'; | ||
import { usePendingChangeRequests } from 'hooks/api/getters/usePendingChangeRequests/usePendingChangeRequests'; | ||
import { usePlausibleTracker } from 'hooks/usePlausibleTracker'; | ||
import useQueryParams from 'hooks/useQueryParams'; | ||
import { useSegments } from 'hooks/api/getters/useSegments/useSegments'; | ||
import { useDefaultStrategy } from '../../../project/Project/ProjectSettings/ProjectDefaultStrategySettings/ProjectEnvironment/ProjectEnvironmentDefaultStrategy/EditDefaultStrategy'; | ||
|
||
export const NewFeatureStrategyCreate = () => { | ||
const projectId = useRequiredPathParam('projectId'); | ||
const featureId = useRequiredPathParam('featureId'); | ||
const environmentId = useRequiredQueryParam('environmentId'); | ||
const strategyName = useRequiredQueryParam('strategyName'); | ||
const { strategy: defaultStrategy, defaultStrategyFallback } = | ||
useDefaultStrategy(projectId, environmentId); | ||
const shouldUseDefaultStrategy: boolean = JSON.parse( | ||
useQueryParams().get('defaultStrategy') || 'false', | ||
); | ||
|
||
const { segments: allSegments } = useSegments(); | ||
const strategySegments = (allSegments || []).filter((segment) => { | ||
return defaultStrategy?.segments?.includes(segment.id); | ||
}); | ||
|
||
const [strategy, setStrategy] = useState<Partial<IFeatureStrategy>>({}); | ||
|
||
const [segments, setSegments] = useState<ISegment[]>( | ||
shouldUseDefaultStrategy ? strategySegments : [], | ||
); | ||
const { strategyDefinition } = useStrategy(strategyName); | ||
const errors = useFormErrors(); | ||
|
||
const { addStrategyToFeature, loading } = useFeatureStrategyApi(); | ||
const { addChange } = useChangeRequestApi(); | ||
const { setToastData, setToastApiError } = useToast(); | ||
const { uiConfig } = useUiConfig(); | ||
const { unleashUrl } = uiConfig; | ||
const navigate = useNavigate(); | ||
|
||
const { feature, refetchFeature } = useFeature(projectId, featureId); | ||
const ref = useRef<IFeatureToggle>(feature); | ||
const { isChangeRequestConfigured } = useChangeRequestsEnabled(projectId); | ||
const { refetch: refetchChangeRequests } = | ||
usePendingChangeRequests(projectId); | ||
const { trackEvent } = usePlausibleTracker(); | ||
|
||
const { data, staleDataNotification, forceRefreshCache } = | ||
useCollaborateData<IFeatureToggle>( | ||
{ | ||
unleashGetter: useFeature, | ||
params: [projectId, featureId], | ||
dataKey: 'feature', | ||
refetchFunctionKey: 'refetchFeature', | ||
options: {}, | ||
}, | ||
feature, | ||
{ | ||
afterSubmitAction: refetchFeature, | ||
}, | ||
comparisonModerator, | ||
); | ||
|
||
useEffect(() => { | ||
if (ref.current.name === '' && feature.name) { | ||
forceRefreshCache(feature); | ||
ref.current = feature; | ||
} | ||
}, [feature.name]); | ||
|
||
useEffect(() => { | ||
if (shouldUseDefaultStrategy) { | ||
const strategyTemplate = defaultStrategy || defaultStrategyFallback; | ||
if (strategyTemplate.parameters?.groupId === '' && featureId) { | ||
setStrategy({ | ||
...strategyTemplate, | ||
parameters: { | ||
...strategyTemplate.parameters, | ||
groupId: featureId, | ||
}, | ||
} as any); | ||
} else { | ||
setStrategy(strategyTemplate as any); | ||
} | ||
} else if (strategyDefinition) { | ||
setStrategy(createFeatureStrategy(featureId, strategyDefinition)); | ||
} | ||
}, [ | ||
featureId, | ||
JSON.stringify(strategyDefinition), | ||
shouldUseDefaultStrategy, | ||
]); | ||
|
||
const onAddStrategy = async (payload: IFeatureStrategyPayload) => { | ||
await addStrategyToFeature( | ||
projectId, | ||
featureId, | ||
environmentId, | ||
payload, | ||
); | ||
|
||
setToastData({ | ||
title: 'Strategy created', | ||
type: 'success', | ||
confetti: true, | ||
}); | ||
}; | ||
|
||
const onStrategyRequestAdd = async (payload: IFeatureStrategyPayload) => { | ||
await addChange(projectId, environmentId, { | ||
action: 'addStrategy', | ||
feature: featureId, | ||
payload, | ||
}); | ||
// FIXME: segments in change requests | ||
setToastData({ | ||
title: 'Strategy added to draft', | ||
type: 'success', | ||
confetti: true, | ||
}); | ||
refetchChangeRequests(); | ||
}; | ||
|
||
const payload = createStrategyPayload(strategy, segments); | ||
|
||
const onSubmit = async () => { | ||
trackEvent('strategyTitle', { | ||
props: { | ||
hasTitle: Boolean(strategy.title), | ||
on: 'create', | ||
}, | ||
}); | ||
|
||
try { | ||
if (isChangeRequestConfigured(environmentId)) { | ||
await onStrategyRequestAdd(payload); | ||
} else { | ||
await onAddStrategy(payload); | ||
} | ||
refetchFeature(); | ||
navigate(formatFeaturePath(projectId, featureId)); | ||
} catch (error: unknown) { | ||
setToastApiError(formatUnknownError(error)); | ||
} | ||
}; | ||
|
||
const emptyFeature = !data || !data.project; | ||
|
||
if (emptyFeature) return null; | ||
|
||
return ( | ||
<FormTemplate | ||
modal | ||
title={formatStrategyName(strategyName)} | ||
description={featureStrategyHelp} | ||
documentationLink={featureStrategyDocsLink} | ||
documentationLinkLabel={featureStrategyDocsLinkLabel} | ||
formatApiCode={() => | ||
formatAddStrategyApiCode( | ||
projectId, | ||
featureId, | ||
environmentId, | ||
payload, | ||
unleashUrl, | ||
) | ||
} | ||
> | ||
<h1>NEW CREATE FORM</h1> | ||
<FeatureStrategyForm | ||
projectId={projectId} | ||
feature={data} | ||
strategy={strategy} | ||
setStrategy={setStrategy} | ||
segments={segments} | ||
setSegments={setSegments} | ||
environmentId={environmentId} | ||
onSubmit={onSubmit} | ||
loading={loading} | ||
permission={CREATE_FEATURE_STRATEGY} | ||
errors={errors} | ||
isChangeRequest={isChangeRequestConfigured(environmentId)} | ||
/> | ||
{staleDataNotification} | ||
</FormTemplate> | ||
); | ||
}; | ||
|
||
export const formatCreateStrategyPath = ( | ||
projectId: string, | ||
featureId: string, | ||
environmentId: string, | ||
strategyName: string, | ||
defaultStrategy: boolean = false, | ||
): string => { | ||
const params = new URLSearchParams({ | ||
environmentId, | ||
strategyName, | ||
defaultStrategy: String(defaultStrategy), | ||
}); | ||
|
||
return `/projects/${projectId}/features/${featureId}/strategies/create?${params}`; | ||
}; | ||
|
||
export const formatAddStrategyApiCode = ( | ||
projectId: string, | ||
featureId: string, | ||
environmentId: string, | ||
strategy: Partial<IFeatureStrategy>, | ||
unleashUrl?: string, | ||
): string => { | ||
if (!unleashUrl) { | ||
return ''; | ||
} | ||
|
||
const url = `${unleashUrl}/api/admin/projects/${projectId}/features/${featureId}/environments/${environmentId}/strategies`; | ||
const payload = JSON.stringify(strategy, undefined, 2); | ||
|
||
return `curl --location --request POST '${url}' \\ | ||
--header 'Authorization: INSERT_API_KEY' \\ | ||
--header 'Content-Type: application/json' \\ | ||
--data-raw '${payload}'`; | ||
}; |
54 changes: 54 additions & 0 deletions
54
.../component/feature/FeatureStrategy/NewFeatureStrategyEdit/NewFeatureStrategyEdit.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import { formatUpdateStrategyApiCode } from 'component/feature/FeatureStrategy/FeatureStrategyEdit/FeatureStrategyEdit'; | ||
import { IFeatureStrategy, IStrategy } from 'interfaces/strategy'; | ||
|
||
test('formatUpdateStrategyApiCode', () => { | ||
const strategy: IFeatureStrategy = { | ||
id: 'a', | ||
name: 'b', | ||
parameters: { | ||
c: 1, | ||
b: 2, | ||
a: 3, | ||
}, | ||
constraints: [], | ||
}; | ||
|
||
const strategyDefinition: IStrategy = { | ||
name: 'c', | ||
displayName: 'd', | ||
description: 'e', | ||
editable: false, | ||
deprecated: false, | ||
parameters: [ | ||
{ name: 'a', description: '', type: '', required: false }, | ||
{ name: 'b', description: '', type: '', required: false }, | ||
{ name: 'c', description: '', type: '', required: false }, | ||
], | ||
}; | ||
|
||
expect( | ||
formatUpdateStrategyApiCode( | ||
'projectId', | ||
'featureId', | ||
'environmentId', | ||
'strategyId', | ||
strategy, | ||
strategyDefinition, | ||
'unleashUrl', | ||
), | ||
).toMatchInlineSnapshot(` | ||
"curl --location --request PUT 'unleashUrl/api/admin/projects/projectId/features/featureId/environments/environmentId/strategies/strategyId' \\\\ | ||
--header 'Authorization: INSERT_API_KEY' \\\\ | ||
--header 'Content-Type: application/json' \\\\ | ||
--data-raw '{ | ||
\\"id\\": \\"a\\", | ||
\\"name\\": \\"b\\", | ||
\\"parameters\\": { | ||
\\"a\\": 3, | ||
\\"b\\": 2, | ||
\\"c\\": 1 | ||
}, | ||
\\"constraints\\": [] | ||
}'" | ||
`); | ||
}); |
Oops, something went wrong.