-
Notifications
You must be signed in to change notification settings - Fork 49
fix: compare full EvaluationDetails to prevent stale data #1287
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
2 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -585,6 +585,79 @@ describe('evaluation', () => { | |
| return new TestingProvider(CONFIG, DELAY); // delay init by 100ms | ||
| }; | ||
|
|
||
| describe('provider ready event updates', () => { | ||
| it('should update EvaluationDetails when provider becomes ready (including reason)', async () => { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This test failed before I updated the compare. |
||
| const PROVIDER_READY_DOMAIN = 'provider-ready-test'; | ||
| const TEST_FLAG_KEY = 'test-flag'; | ||
| const FLAG_VALUE = true; | ||
|
|
||
| // Create a provider that will delay initialization | ||
| const provider = new TestingProvider( | ||
| { | ||
| [TEST_FLAG_KEY]: { | ||
| disabled: false, | ||
| variants: { | ||
| on: FLAG_VALUE, | ||
| off: false, | ||
| }, | ||
| defaultVariant: 'on', | ||
| }, | ||
| }, | ||
| DELAY, | ||
| ); | ||
|
|
||
| OpenFeature.setProvider(PROVIDER_READY_DOMAIN, provider); | ||
|
|
||
| let capturedDetails: EvaluationDetails<boolean> | undefined; | ||
| let renderCount = 0; | ||
|
|
||
| function TestComponent() { | ||
| renderCount++; | ||
| const details = useBooleanFlagDetails(TEST_FLAG_KEY, FLAG_VALUE); | ||
| capturedDetails = details; | ||
|
|
||
| return ( | ||
| <div> | ||
| <div data-testid="value">{String(details.value)}</div> | ||
| <div data-testid="reason">{details.reason}</div> | ||
| <div data-testid="render-count">{renderCount}</div> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| render( | ||
| <OpenFeatureProvider domain={PROVIDER_READY_DOMAIN}> | ||
| <TestComponent /> | ||
| </OpenFeatureProvider>, | ||
| ); | ||
|
|
||
| // Initial render - provider is NOT_READY, should use default value with ERROR reason | ||
| expect(capturedDetails?.value).toBe(FLAG_VALUE); | ||
| expect(capturedDetails?.reason).toBe(StandardResolutionReasons.ERROR); | ||
| expect(capturedDetails?.errorCode).toBe(ErrorCode.PROVIDER_NOT_READY); | ||
| expect(screen.getByTestId('reason')).toHaveTextContent(StandardResolutionReasons.ERROR); | ||
|
|
||
| const initialRenderCount = renderCount; | ||
|
|
||
| // Wait for provider to become ready and component to re-render | ||
| await waitFor( | ||
| () => { | ||
| expect(capturedDetails?.reason).toBe(StandardResolutionReasons.STATIC); | ||
| }, | ||
| { timeout: DELAY * 2 }, | ||
| ); | ||
|
|
||
| // After provider is ready, same value but different reason and no error | ||
| expect(capturedDetails?.value).toBe(FLAG_VALUE); | ||
| expect(capturedDetails?.errorCode).toBeUndefined(); | ||
| expect(screen.getByTestId('value')).toHaveTextContent(String(FLAG_VALUE)); | ||
| expect(screen.getByTestId('reason')).toHaveTextContent(StandardResolutionReasons.STATIC); | ||
|
|
||
| // Verify that a re-render occurred | ||
| expect(renderCount).toBeGreaterThan(initialRenderCount); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when using the noop provider', () => { | ||
| function TestComponent() { | ||
| const { value } = useSuspenseFlag(SUSPENSE_FLAG_KEY, DEFAULT); | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good callout.