fix: in-line docs, un-needed AbortController creation

[toddbaert]

This PR:

• clarifies some doc around useWhenProviderReady (it really only works with READY)
• moves AbortController instantiation so we don't create it every render if we don't need to

[gemini-code-assist]

Summary of Changes

Hello @toddbaert, 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 React SDK by improving both documentation accuracy and runtime efficiency. It ensures that a specific provider status hook's behavior is clearly communicated to developers and optimizes resource usage by deferring the creation of an AbortController until it is actually needed within an effect.

Highlights

• Documentation Clarity: Clarified the inline documentation for useWhenProviderReady to explicitly state that it only works with a READY provider status, guiding users to useOpenFeatureClientStatus for other statuses.
• Performance Optimization: Refactored the useOpenFeatureClientStatus hook to instantiate AbortController inside the useEffect hook, preventing its unnecessary creation on every render cycle.

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

[lukas-reining]

That makes much sense!

[gemini-code-assist]

Code Review

This pull request introduces two valuable improvements to the React package. It optimizes the useOpenFeatureClientStatus hook by moving the AbortController instantiation into the useEffect hook, which correctly avoids creating a new controller on every component render and improves performance. Additionally, it clarifies the documentation for the useWhenProviderReady hook, making its behavior more explicit and guiding developers on using useOpenFeatureClientStatus for observing provider states other than READY. Both changes are well-executed and enhance the library's quality and developer experience.

[MattIPv4]

Good AbortController change -- the note seems redundant given three lines above and two lines below both already state it only looks at READY but the link to the other hook is useful 👍

[toddbaert]

Good AbortController change -- the note seems redundant given three lines above and two lines below both already state it only looks at READY but the link to the other hook is useful 👍

We are triple emphasizing it because a lot of people seem to misuse it 😅 . I'm almost considering deprecating it and creating something different.