Skip to content

Commit 2304af0

Browse files
authored
refactor: use non-deprecated methods internally in react and nuxt packages (#3182)
1 parent 420d849 commit 2304af0

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@posthog/react": patch
3+
"@posthog/nuxt": patch
4+
---
5+
6+
refactor: use `getFeatureFlagResult` instead of deprecated `getFeatureFlagPayload` internally

packages/nuxt/src/runtime/composables/useFeatureFlagPayload.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ import type { JsonType } from 'posthog-js'
2525
*/
2626
export function useFeatureFlagPayload(flag: string) {
2727
const posthog = usePostHog()
28-
const featureFlagPayload = ref<JsonType | undefined>(posthog?.getFeatureFlagPayload?.(flag))
28+
const featureFlagPayload = ref<JsonType | undefined>(posthog?.getFeatureFlagResult?.(flag, { send_event: false })?.payload)
2929

3030
let unsubscribe: (() => void) | undefined
3131
onMounted(() => {
3232
if (!posthog) return
3333

3434
// Set initial value in case it wasn't available during setup
35-
featureFlagPayload.value = posthog.getFeatureFlagPayload(flag)
35+
featureFlagPayload.value = posthog.getFeatureFlagResult(flag, { send_event: false })?.payload
3636

3737
// Update when feature flags are loaded
3838
unsubscribe = posthog.onFeatureFlags?.(() => {
39-
featureFlagPayload.value = posthog.getFeatureFlagPayload(flag)
39+
featureFlagPayload.value = posthog.getFeatureFlagResult(flag, { send_event: false })?.payload
4040
})
4141
})
4242

packages/react/src/components/__tests__/PostHogFeature.test.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ describe('PostHogFeature component', () => {
4848
isFeatureEnabled: (flag: string) => !!FEATURE_FLAG_STATUS[flag],
4949
getFeatureFlag: (flag: string) => FEATURE_FLAG_STATUS[flag],
5050
getFeatureFlagPayload: (flag: string) => FEATURE_FLAG_PAYLOADS[flag],
51+
getFeatureFlagResult: (flag: string) => ({
52+
key: flag,
53+
enabled: !!FEATURE_FLAG_STATUS[flag],
54+
variant:
55+
typeof FEATURE_FLAG_STATUS[flag] === 'string' ? (FEATURE_FLAG_STATUS[flag] as string) : undefined,
56+
payload: FEATURE_FLAG_PAYLOADS[flag],
57+
}),
5158
onFeatureFlags: (callback: any) => {
5259
const activeFlags: string[] = []
5360
for (const flag in FEATURE_FLAG_STATUS) {

packages/react/src/hooks/useFeatureFlagPayload.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ import { PostHogContext } from '../context'
55
export function useFeatureFlagPayload(flag: string): JsonType {
66
const { client, bootstrap } = useContext(PostHogContext)
77

8-
const [featureFlagPayload, setFeatureFlagPayload] = useState<JsonType>(() => client.getFeatureFlagPayload(flag))
8+
const [featureFlagPayload, setFeatureFlagPayload] = useState<JsonType>(
9+
() => client.getFeatureFlagResult(flag, { send_event: false })?.payload
10+
)
911

1012
useEffect(() => {
1113
return client.onFeatureFlags(() => {
12-
setFeatureFlagPayload(client.getFeatureFlagPayload(flag))
14+
setFeatureFlagPayload(client.getFeatureFlagResult(flag, { send_event: false })?.payload)
1315
})
1416
}, [client, flag])
1517

0 commit comments

Comments
 (0)