-
Notifications
You must be signed in to change notification settings - Fork 41
test: Fix issue with flaky flagd RPC Resolver tests #530
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
test: Fix issue with flaky flagd RPC Resolver tests #530
Conversation
Signed-off-by: Kyle Julian <[email protected]>
Summary of ChangesHello @kylejuliandev, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the stability of the "flagd" RPC Resolver tests. By introducing "AutoResetEvent" as a synchronization primitive, the tests now accurately wait for specific asynchronous events, such as "flagdProviderEvent" assignments or cache purges/deletions, to complete before making assertions. This change addresses intermittent failures by preventing race conditions and ensuring that test logic executes only when the system is in the expected state, leading to more reliable and consistent test results. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request effectively addresses the flaky tests by replacing a polling mechanism with AutoResetEvent for better synchronization in asynchronous test scenarios. The approach is sound and correctly implemented to make the tests more reliable. I have a couple of suggestions to further improve code quality by removing an unused variable and abstracting a magic number into a constant for better maintainability.
test/OpenFeature.Contrib.Providers.Flagd.Test/Resolver/Rpc/RpcResolverTests.cs
Outdated
Show resolved
Hide resolved
test/OpenFeature.Contrib.Providers.Flagd.Test/Resolver/Rpc/RpcResolverTests.cs
Outdated
Show resolved
Hide resolved
Signed-off-by: Kyle Julian <[email protected]>
This PR
Fix flaky tests but leveraging AutoResetEvent to callback at the point relevant for the test. Instead of always waiting for the flagdProviderEvent to be assigned, which happens before the cache purging, occassionally causing some tests to fail we use the reset event to wait before making the assertions.
Introduced in #515
Related Issues
Notes
Follow-up Tasks
How to test