feat: Add optional CancellationToken parameter to SetProviderAsync

[kylejuliandev]

This PR

Add new methods to pass CancellationTokens for SetProviderAsync(FeatureProvider, CancellationToken) and SetProviderAsync(string, FeatureProvider, CancellationToken) so that cancellations can be propagated to Provider initialization method.

Related Issues

Fixes #637

Notes

Follow-up Tasks

How to test

[gemini-code-assist]

Summary of Changes

Hello @kylejuliandev, 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 enhances the OpenFeature API by introducing an optional CancellationToken parameter to the SetProviderAsync methods. This allows callers to propagate cancellation requests to the underlying feature provider's initialization process, providing better control over asynchronous operations and improving responsiveness in scenarios where provider setup might be long-running or needs to be aborted.

Highlights

• CancellationToken Support: Added an optional CancellationToken parameter to both SetProviderAsync overloads, allowing for the cancellation of provider initialization processes.
• API Modification: The SetProviderAsync(FeatureProvider) and SetProviderAsync(string, FeatureProvider) methods in src/OpenFeature/Api.cs now accept an optional CancellationToken.
• Test Coverage: A new test case, OpenFeature_Should_Initialize_Provider_WithCancellationToken, has been added to test/OpenFeature.Tests/OpenFeatureTests.cs to validate the correct propagation and usage of the CancellationToken during provider initialization.

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 introduces an optional CancellationToken to the SetProviderAsync methods, enabling cancellation of provider initializations. The changes are well-implemented, propagating the token through the repository to the provider. My review includes a suggestion to restore a helpful XML documentation comment that appears to have been removed accidentally, and a recommendation to add a test case to verify the cancellation behavior, which will enhance the robustness of the test suite.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.21%. Comparing base (6b6f478) to head (3d62d2b).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #638      +/-   ##
==========================================
+ Coverage   93.20%   93.21%   +0.01%     
==========================================
  Files          69       69              
  Lines        2987     2993       +6     
  Branches      359      359              
==========================================
+ Hits         2784     2790       +6     
  Misses        143      143              
  Partials       60       60              

☔ 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.