fix: remove explicit return type for React OpenFeatureProvider
#1313
Conversation
`JSX.Element` too narrow for React 19+ as types have widened to include Portals etc Signed-off-by: Sam <sam@andomain.co.uk>
Summary of ChangesHello @andomain, 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 updates the React SDK to improve its compatibility with newer React versions, specifically React 19 and beyond. By removing a restrictive type annotation from the 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes the explicit JSX.Element return type from the OpenFeatureProvider component to improve compatibility with newer versions of React. The change is correct and well-justified. I've added one suggestion to improve the related JSDoc for better clarity and correctness.
| * @returns {OpenFeatureProvider} context provider | ||
| */ | ||
| export function OpenFeatureProvider({ client, domain, children, ...options }: ProviderProps): JSX.Element { | ||
| export function OpenFeatureProvider({ client, domain, children, ...options }: ProviderProps) { |
There was a problem hiding this comment.
The JSDoc for the return value on line 32 is misleading. @returns {OpenFeatureProvider} uses the function's name instead of its return type. For better clarity and correctness, please consider updating it to specify that the function returns a JSX element.
For example:
* @returns {JSX.Element} The OpenFeature provider component.I'm placing this comment here as I'm unable to comment on unchanged lines.
There was a problem hiding this comment.
I will leave this as is as it is how the function was typed before and indicated it returns the context provider itself
andomain
changed the title
OpenFeatureProviderOpenFeatureProvider
2 participants
This PR
This PR removes the explicit
JSX.Elementreturn type from the type signature of the React SDKOpenFeatureProvider.JSX.Elementis narrow for React 19+ as types have widened to include Portals etc. & this was throwing TS compilation errorsRelated Issues
Fixes #1307
Notes
As this is purely a type change I didn't feel it necessary to add additional tests, happy to investigate further if required though