fix: merge SetProviderAndWait fixes into next

[dd-oleksii]

This PR

Merge of #474 along with latest changes from main into next. cc @erka

Related Issues

#474
#460

Notes

Follow-up Tasks

How to test

[gemini-code-assist]

Summary of Changes

Hello @dd-oleksii, I'm Gemini Code Assist¹! 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 integrates critical fixes and improvements related to provider registration and lifecycle management, specifically addressing the SetProviderAndWait functionality. The changes streamline the process of setting and initializing feature providers, enhance error handling, and improve the robustness of event handling during provider shutdowns. This ensures a more predictable and stable experience when managing feature flag providers within the SDK.

Highlights

• Provider Lifecycle Management Refinement: Refactored the internal mechanisms for setting and managing feature providers, separating initialization and shutdown logic into distinct helper functions (initNew and shutdownOld). This improves clarity and maintainability of provider lifecycle management.
• Enhanced SetProviderAndWait Functionality: The SetProviderAndWait and SetNamedProviderAndWait functions now correctly wait for provider initialization to complete by utilizing a channel, ensuring synchronous behavior as intended. Error handling for nil providers has also been added.
• Improved Event Executor Robustness: Internal provider registration functions in event_executor.go no longer return errors, simplifying their call sites. The shutdown semaphore for event handlers was changed to a buffered channel, preventing potential deadlocks during provider shutdown and logging a warning instead of returning an error on timeout.
• Dependency Updates: Updated golang.org/x/sync and golang.org/x/text modules to their latest versions, ensuring the project benefits from the most recent bug fixes and performance improvements.
• Test Reliability Improvements: Adjusted event emission timing in event_executor_test.go to ensure events are invoked after handlers are registered, leading to more reliable and accurate test results.

Changelog

• event_executor.go
  • Removed unused imports for fmt and time.
  • Modified registerDefaultProvider, registerNamedEventingProvider, and startListeningAndShutdownOld functions to no longer return errors.
  • Updated startListeningAndShutdownOld to use a non-blocking send to the shutdown semaphore and log a warning instead of returning an error on timeout.
• event_executor_test.go
  • Removed error checks from calls to registerDefaultProvider and registerNamedEventingProvider.
  • Relocated eventingImpl.Invoke calls in TestEventHandler_HandlersRunImmediately to occur after event handler registration, ensuring proper test execution.
• go.mod
  • Updated golang.org/x/sync dependency from v0.18.0 to v0.19.0.
  • Updated golang.org/x/text dependency from v0.31.0 to v0.33.0.
• go.sum
  • Updated checksums for golang.org/x/sync and golang.org/x/text modules to reflect new versions.
• openfeature_api.go
  • Refactored SetProvider and SetProviderAndWait to use a new setProviderWithContext helper function.
  • Introduced initNew and shutdownOld helper functions to encapsulate provider initialization and shutdown logic.
  • Added nil provider checks to SetProvider and SetNamedProvider functions.
  • Modified SetProviderAndWait and SetNamedProviderAndWait to explicitly wait for provider initialization completion via a channel.
  • Removed the async parameter from internal setProviderWithContext and setNamedProviderWithContext functions.
  • Reordered GetProviderMetadata and GetNamedProviderMetadata methods within the file.
• reference.go
  • Changed the shutdownSemaphore channel in newProviderRef to be buffered with a capacity of 1.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request refactors the provider setting logic, particularly around SetProviderAndWait. The changes introduce a clearer separation of concerns for provider initialization and shutdown, using channels to manage asynchronous operations. This improves the robustness of setting providers. My review found a minor inconsistency in error handling for SetProviderAndWait compared to SetNamedProviderAndWait, for which I've suggested a fix to improve consistency and error reporting.

[codecov]

Codecov Report

❌ Patch coverage is 84.74576% with 9 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (next@05198d3). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
openfeature_api.go	87.23%	3 Missing and 3 partials ⚠️
event_executor.go	72.72%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             next     #475   +/-   ##
=======================================
  Coverage        ?   86.15%           
=======================================
  Files           ?       21           
  Lines           ?     1936           
  Branches        ?        0           
=======================================
  Hits            ?     1668           
  Misses          ?      231           
  Partials        ?       37           

Flag	Coverage Δ
e2e	86.15% <84.74%> (?)
unit	86.15% <84.74%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[erka]

Thank you @dd-oleksii but maybe it makes sense to focus on the original PR and the main branch for now. An extra PR might not add much value in fixing the issue and could increase the scope, especially with potential merge conflicts from other changes anyway.