Use a modern React context for identity in the app #30098
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This removes the last usage of the old and deprecated React context API (which will be removed from React 19, and outputs deprecation warnings in React 18.3). Modern context can be used through `contextType` in class components, but it makes them not explicit when consumed (it would have been `this.context.me`, not `this.context.identity.me`). I preferred to switch to injecting an `identity` prop using a wrapper component inspired by `withOptionalRouter`, so consuming identity is explicit (`this.props.identity`).
renchap
added
refactoring
1 task
Comment on lines
+46
to
+74
| /* Injects an `identity` props into the wrapped component to be able to use the new context in class components */ | ||
| export function withIdentity< | ||
| ComponentType extends React.ComponentType<IdentityProps>, | ||
| >(Component: ComponentType) { | ||
| const displayName = `withIdentity(${Component.displayName ?? Component.name})`; | ||
| const C = (props: React.ComponentProps<ComponentType>) => { | ||
| const { wrappedComponentRef, ...remainingProps } = props; | ||
|
|
||
| return ( | ||
| <IdentityContext.Consumer> | ||
| {(context) => { | ||
| return ( | ||
| // @ts-expect-error - Dynamic covariant generic components are tough to type. | ||
| <Component | ||
| {...remainingProps} | ||
| identity={context} | ||
| ref={wrappedComponentRef} | ||
| /> | ||
| ); | ||
| }} | ||
| </IdentityContext.Consumer> | ||
| ); | ||
| }; | ||
|
|
||
| C.displayName = displayName; | ||
| C.WrappedComponent = Component; | ||
|
|
||
| return hoistStatics(C, Component); | ||
| } |
There was a problem hiding this comment.
I wonder if there's a more idiomatic way to write those wrappers…
There was a problem hiding this comment.
Most of the complexity here comes from handling the refs & display name, I am not sure if this can be made simpler.
ClearlyClaire
approved these changes
May 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This removes the last usage of the old and deprecated React context API (which will be removed from React 19, and outputs deprecation warnings in React 18.3).
Modern context can be used through
contextTypein class components, but it makes them not explicit when consumed (it would have beenthis.context.me, notthis.context.identity.me).I preferred to switch to injecting an
identityprop using a wrapper component inspired bywithOptionalRouter, so consuming identity is explicit (this.props.identity).