Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

React 18 conditional support #1449

Closed
wants to merge 4 commits into from
Closed

React 18 conditional support #1449

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af52b8a
Draft React 18 alternative support
Apr 25, 2022
47912e2
Conditions wrong way around
Apr 25, 2022
f2bc39b
Promise based approach
May 1, 2022
503fd63
Changes
May 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions node_package/src/ReactOnRails.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ import type {
AuthenticityHeaders,
StoreGenerator
} from './types/index';
import reactHydrate from './reactHydrate';
import reactRender from './reactRender';
import { reactHydrate, reactRender } from './helpers/renderHelper';

/* eslint-disable @typescript-eslint/no-explicit-any */
type Store = any;
Expand Down
7 changes: 3 additions & 4 deletions node_package/src/clientStartup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ import type {

import createReactOutput from './createReactOutput';
import {isServerRenderHash} from './isServerRenderResult';
import reactHydrate from './reactHydrate';
import reactRender from './reactRender';
import { reactHydrate, reactRender, canHydrate } from './helpers/renderHelper';

declare global {
interface Window {
Expand Down Expand Up @@ -152,8 +151,7 @@ function render(el: Element, railsContext: RailsContext): void {
}

// Hydrate if available and was server rendered
// @ts-expect-error potentially present if React 18 or greater
const shouldHydrate = !!(ReactDOM.hydrate || ReactDOM.hydrateRoot) && !!domNode.innerHTML;
const shouldHydrate = canHydrate && !!domNode.innerHTML;

const reactElementOrRouterResult = createReactOutput({
componentObj,
Expand Down Expand Up @@ -213,6 +211,7 @@ function unmount(el: Element): void {
const domNode = document.getElementById(domNodeId);
if(domNode === null){return;}
try {
// Might need updating? https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unmountComponentAtNode is considered legacy https://reactjs.org/docs/react-dom.html#unmountcomponentatnode but would need to store references to root instead if we were to update

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see #1466.

ReactDOM.unmountComponentAtNode(domNode);
} catch (e) {
console.info(`Caught error calling unmountComponentAtNode: ${e.message} for domNode`,
Expand Down
12 changes: 12 additions & 0 deletions node_package/src/helpers/legacyRootHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import ReactDOM from 'react-dom';
import type { RootRenderFunction, RootHydrateFunction } from '../types';

export const canHydrate = !!ReactDOM.hydrate

export const hydrate: RootHydrateFunction = (domNode, reactElement) => {
return ReactDOM.hydrate(reactElement, domNode)
}

export const render: RootRenderFunction = (domNode, reactElement) => {
return ReactDOM.render(reactElement, domNode);
}
14 changes: 14 additions & 0 deletions node_package/src/helpers/modernRootHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// @ts-expect-error react-dom/client only available in React 18
// eslint-disable-next-line import/no-unresolved
import ReactDOM from 'react-dom/client';
import type { RootRenderFunction, RootHydrateFunction } from '../types';

export const canHydrate = !!ReactDOM.hydrateRoot;

export const hydrate: RootHydrateFunction = (domNode, reactElement) => ReactDOM.hydrateRoot(domNode, reactElement);

export const render: RootRenderFunction = (domNode, reactElement) => {
const root = ReactDOM.createRoot(domNode);
root.render(reactElement);
return root;
};
19 changes: 19 additions & 0 deletions node_package/src/helpers/renderHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import supportsReactCreateRoot from './supportsReactCreateRoot';
import * as legacyRootHandler from './legacyRootHandler';
import * as modernRootHandler from './modernRootHandler';


let toExport;

if (supportsReactCreateRoot) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be good based not only on React version but also some configuration option so it's an opt-in

toExport = modernRootHandler;
} else {
toExport = legacyRootHandler;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Struggling to find a nicer way to get this going, can't think of a way to do a dynamic import and then reexport

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be fairly trivial with top-level await though 🤔


export const {
canHydrate,
hydrate: reactHydrate,
render: reactRender
} = toExport;

0 node_package/src/supportsReactCreateRoot.ts → ...ge/src/helpers/supportsReactCreateRoot.ts
View file
Open in desktop
File renamed without changes.
12 changes: 0 additions & 12 deletions node_package/src/reactHydrate.ts
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions node_package/src/reactRender.ts
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions node_package/src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ interface RenderFunction {

type ReactComponentOrRenderFunction = ReactComponent | RenderFunction;

type RootRenderFunction = (domNode: Element, reactElement: ReactElement) => void | Element | Component;

type RootHydrateFunction = RootRenderFunction;

export type { // eslint-disable-line import/prefer-default-export
ReactComponentOrRenderFunction,
ReactComponent,
Expand All @@ -61,6 +65,8 @@ export type { // eslint-disable-line import/prefer-default-export
StoreGenerator,
CreateReactOutputResult,
ServerRenderResult,
RootRenderFunction,
RootHydrateFunction,
}

export interface RegisteredComponent {
Expand Down