-
Notifications
You must be signed in to change notification settings - Fork 37
[FSSDK-12296] Async Hook implementation #324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c967727
[FSSDK-12296] decideAsync impl.
junaed-optimizely bfe2941
[FSSDK-12296] decideForKeysAsync, decideAllAsync impl.
junaed-optimizely b54e1e2
[FSSDK-12296] decideAllAsync tests addition
junaed-optimizely d2b8c8a
[FSSDK-12296] common code abstraction
junaed-optimizely 6ac4f7a
[FSSDK-12296] review update
junaed-optimizely File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,31 @@ | ||
| /** | ||
| * Copyright 2026, Optimizely | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import type { OptimizelyDecideOption, OptimizelyDecision } from '@optimizely/optimizely-sdk'; | ||
|
|
||
| export interface UseDecideConfig { | ||
| decideOptions?: OptimizelyDecideOption[]; | ||
| } | ||
|
|
||
| export type UseDecideResult = | ||
| | { isLoading: true; error: null; decision: null } | ||
| | { isLoading: false; error: Error; decision: null } | ||
| | { isLoading: false; error: null; decision: OptimizelyDecision }; | ||
|
|
||
| export type UseDecideMultiResult = | ||
| | { isLoading: true; error: null; decisions: Record<string, never> } | ||
| | { isLoading: false; error: Error; decisions: Record<string, never> } | ||
| | { isLoading: false; error: null; decisions: Record<string, OptimizelyDecision> }; |
This file contains hidden or 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,102 @@ | ||
| /** | ||
| * Copyright 2026, Optimizely | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { useEffect, useState } from 'react'; | ||
| import type { OptimizelyUserContext } from '@optimizely/optimizely-sdk'; | ||
|
|
||
| import type { Client } from '@optimizely/optimizely-sdk'; | ||
| import type { ProviderState } from '../provider/index'; | ||
|
|
||
| interface AsyncState<TResult> { | ||
| result: TResult; | ||
| error: Error | null; | ||
| isLoading: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * Shared async decision state machine used by useDecideAsync, | ||
| * useDecideForKeysAsync, and useDecideAllAsync. | ||
| * | ||
| * Handles: loading state, error propagation, cancellation of stale promises, | ||
| * and redundant re-render avoidance on first mount. | ||
| * | ||
| * @param state - Provider state from useProviderState | ||
| * @param client - Optimizely client instance | ||
| * @param fdVersion - Forced decision version counter (triggers re-evaluation) | ||
| * @param emptyResult - Default/empty result value (null for single, {} for multi) | ||
| * @param execute - Callback that performs the async SDK call | ||
| */ | ||
| export function useAsyncDecision<TResult>( | ||
| state: ProviderState, | ||
| client: Client, | ||
| fdVersion: number, | ||
| emptyResult: TResult, | ||
| execute: (userContext: OptimizelyUserContext) => Promise<TResult> | ||
| ): AsyncState<TResult> { | ||
| const [asyncState, setAsyncState] = useState<AsyncState<TResult>>({ | ||
| result: emptyResult, | ||
| error: null, | ||
| isLoading: true, | ||
| }); | ||
|
|
||
| useEffect(() => { | ||
| const { userContext, error } = state; | ||
| const hasConfig = client.getOptimizelyConfig() !== null; | ||
|
|
||
| // Store-level error — no async call needed | ||
| if (error) { | ||
| setAsyncState({ result: emptyResult, error, isLoading: false }); | ||
| return; | ||
| } | ||
|
|
||
| // Ensure loading state (skip if already loading to avoid re-render) | ||
| setAsyncState((prev) => { | ||
| if (prev.isLoading) return prev; | ||
| return { result: emptyResult, error: null, isLoading: true }; | ||
| }); | ||
|
|
||
| // Store not ready — wait for config/user context | ||
| if (!hasConfig || userContext === null) { | ||
| return; | ||
| } | ||
|
|
||
| // Store is ready — fire async decision | ||
| let cancelled = false; | ||
|
|
||
| execute(userContext).then( | ||
| (result) => { | ||
| if (!cancelled) { | ||
| setAsyncState({ result, error: null, isLoading: false }); | ||
| } | ||
| }, | ||
| (err) => { | ||
| if (!cancelled) { | ||
| setAsyncState({ | ||
| result: emptyResult, | ||
| error: err instanceof Error ? err : new Error(String(err)), | ||
| isLoading: false, | ||
| }); | ||
| } | ||
| } | ||
| ); | ||
|
|
||
| return () => { | ||
| cancelled = true; | ||
| }; | ||
| }, [state, fdVersion, client, execute, emptyResult]); | ||
|
|
||
| return asyncState; | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.