refactor: Deprecate GetApiInstance & Add Direct NewDefaultClient implementations

[jblacker]

This PR

completes the non-breaking changes of #414 in preparation of v2.

• Adds GetClient & GetNamedClient functions directly to the openfeature package using the api instance
• Mark GetApiInstance function as deprecated

Related Issues

• Fixes [DOC] inconsistent documentation for usage of openfeature.NewClient #350
• Fixes Remove the GetApiInstance function #414

Notes

• This only handles the non-breaking changes as the actual removal of the function

Follow-up Tasks

Follow up with breaking changes by removing the GetApiInstance function and no longer exporting IEvaluation

[gemini-code-assist]

Summary of Changes

Hello @jblacker, 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 introduces a significant API simplification by deprecating the GetApiInstance function and providing direct access to client instances through new GetClient and GetNamedClient functions at the top level of the openfeature package. This change streamlines client retrieval, making the API more intuitive and preparing the codebase for future breaking changes in v2. All internal usage has been updated to reflect this new pattern, ensuring a smooth transition for consumers.

Highlights

• API Deprecation: The GetApiInstance function within the openfeature package has been explicitly marked as deprecated, signaling its eventual removal in future versions.
• New Client Access Functions: Two new top-level functions, GetClient() and GetNamedClient(domain string), have been introduced directly into the openfeature package. These functions provide a more direct and streamlined way to obtain OpenFeature client instances without needing to first retrieve the API singleton.
• Codebase Migration: All existing internal and test code that previously relied on GetApiInstance().GetClient() or GetApiInstance().GetNamedClient() has been updated to use the newly introduced direct openfeature.GetClient() or openfeature.GetNamedClient() calls, ensuring consistency and adherence to the new API pattern.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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. ↩

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.57%. Comparing base (3d2b707) to head (68f2ad9).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #421      +/-   ##
==========================================
- Coverage   85.69%   85.57%   -0.12%     
==========================================
  Files          20       20              
  Lines        1433     1435       +2     
==========================================
  Hits         1228     1228              
- Misses        184      186       +2     
  Partials       21       21              

Flag	Coverage Δ
e2e	85.57% <100.00%> (-0.12%)	⬇️
unit	85.57% <100.00%> (-0.12%)	⬇️

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.

[gemini-code-assist]

Code Review

This pull request effectively deprecates GetApiInstance and introduces GetClient and GetNamedClient as more direct alternatives. The changes are consistently applied throughout the codebase, including in tests. The new functions are well-documented and the deprecation is clearly marked. I have one minor suggestion to improve the comment for the deprecated function to avoid confusion.

[erka]

Should we consider naming these functions NewClient and NewNamedClient instead of GetClient and GetNamedClient? Since they return a new object each time, the New* prefix might better explain it.

[jblacker]

There is already a function NewClient in the openfeature package. That would be a breaking change if we want to go that route.

[erka]

GetNamedClient is equivalent to NewClient, and GetClient is just NewClient(""). Is there a specific reason to introduce these additional functions?

[jblacker]

After checking that out a bit more I agree with you. I'll eliminate GetNamedClient as it's unnecessary. I'll update the docs as well to show NewClient should be preferred.

Since GetApiInstance().GetClient() is a common pattern how about we add a NewDefaultClient() as the new equivalent that just passes in the empty string for simplicity?

[jblacker]

With these changes we could also deprecate GetClient & GetNamedClient on IEvaluation since the implementations are identical and all just call the same private function under the hood. What do ya'll think?

[erka]

With these changes we could also deprecate GetClient & GetNamedClient on IEvaluation since the implementations are identical and all just call the same private function under the hood. What do ya'll think?

That’s a great question, but I think it would be best to address it separately.

[erka]

@jblacker please update the PR title to better reflect the changes.