From f69748601d5c1fd1fc3585d6d1d1970c2c13a272 Mon Sep 17 00:00:00 2001 From: Andrew Clark Date: Tue, 18 Apr 2017 14:46:56 -0700 Subject: [PATCH] Remove unstable_asyncRender() API in favor of always using a wrapper --- src/renderers/dom/fiber/ReactDOMFiber.js | 169 +++++++----------- .../__tests__/ReactDOMFiberAsync-test.js | 82 +++++---- .../shared/fiber/ReactFiberBeginWork.js | 2 +- .../shared/fiber/ReactFiberClassComponent.js | 10 +- .../shared/fiber/ReactFiberReconciler.js | 104 +++-------- .../shared/fiber/ReactFiberScheduler.js | 9 +- 6 files changed, 152 insertions(+), 224 deletions(-) diff --git a/src/renderers/dom/fiber/ReactDOMFiber.js b/src/renderers/dom/fiber/ReactDOMFiber.js index 7f8c39e1c5..7dd9c8a3f2 100644 --- a/src/renderers/dom/fiber/ReactDOMFiber.js +++ b/src/renderers/dom/fiber/ReactDOMFiber.js @@ -387,7 +387,6 @@ function renderSubtreeIntoContainer( parentComponent: ?ReactComponent, children: ReactNodeList, containerNode: DOMContainerElement | Document, - async: boolean, callback: ?Function, ) { validateContainer(containerNode); @@ -401,104 +400,84 @@ function renderSubtreeIntoContainer( while (container.lastChild) { container.removeChild(container.lastChild); } - const newRoot = async - ? DOMRenderer.createAsyncContainer(container) - : DOMRenderer.createContainer(container); + const newRoot = DOMRenderer.createContainer(container); root = (container._reactRootContainer = newRoot); // Initial mount should not be batched. DOMRenderer.unbatchedUpdates(() => { DOMRenderer.updateContainer(children, newRoot, parentComponent, callback); }); } else { - if (async) { - DOMRenderer.updateAsyncContainer( - children, - root, - parentComponent, - callback, - ); - } else { - DOMRenderer.updateContainer(children, root, parentComponent, callback); - } + DOMRenderer.updateContainer(children, root, parentComponent, callback); } return DOMRenderer.getPublicRootInstance(root); } -function render( - element: ReactElement, - container: DOMContainerElement, - async: boolean, - callback: ?Function, -) { - validateContainer(container); - - if (ReactFeatureFlags.disableNewFiberFeatures) { - // Top-level check occurs here instead of inside child reconciler because - // because requirements vary between renderers. E.g. React Art - // allows arrays. - if (!isValidElement(element)) { - if (typeof element === 'string') { - invariant( - false, - 'ReactDOM.render(): Invalid component element. Instead of ' + - "passing a string like 'div', pass " + - "React.createElement('div') or
.", - ); - } else if (typeof element === 'function') { - invariant( - false, - 'ReactDOM.render(): Invalid component element. Instead of ' + - 'passing a class like Foo, pass React.createElement(Foo) ' + - 'or .', - ); - } else if (element != null && typeof element.props !== 'undefined') { - // Check if it quacks like an element - invariant( - false, - 'ReactDOM.render(): Invalid component element. This may be ' + - 'caused by unintentionally loading two independent copies ' + - 'of React.', - ); - } else { - invariant(false, 'ReactDOM.render(): Invalid component element.'); - } - } - } - - if (__DEV__) { - const isRootRenderedBySomeReact = !!container._reactRootContainer; - const rootEl = getReactRootElementInContainer(container); - const hasNonRootReactChild = !!(rootEl && - ReactDOMComponentTree.getInstanceFromNode(rootEl)); - - warning( - !hasNonRootReactChild || isRootRenderedBySomeReact, - 'render(...): Replacing React-rendered children with a new root ' + - 'component. If you intended to update the children of this node, ' + - 'you should instead have the existing children update their state ' + - 'and render the new components instead of calling ReactDOM.render.', - ); - - warning( - !container.tagName || container.tagName.toUpperCase() !== 'BODY', - 'render(): Rendering components directly into document.body is ' + - 'discouraged, since its children are often manipulated by third-party ' + - 'scripts and browser extensions. This may lead to subtle ' + - 'reconciliation issues. Try rendering into a container element created ' + - 'for your app.', - ); - } - - return renderSubtreeIntoContainer(null, element, container, async, callback); -} - var ReactDOM = { render( element: ReactElement, container: DOMContainerElement, callback: ?Function, ) { - return render(element, container, false, callback); + validateContainer(container); + + if (ReactFeatureFlags.disableNewFiberFeatures) { + // Top-level check occurs here instead of inside child reconciler because + // because requirements vary between renderers. E.g. React Art + // allows arrays. + if (!isValidElement(element)) { + if (typeof element === 'string') { + invariant( + false, + 'ReactDOM.render(): Invalid component element. Instead of ' + + "passing a string like 'div', pass " + + "React.createElement('div') or
.", + ); + } else if (typeof element === 'function') { + invariant( + false, + 'ReactDOM.render(): Invalid component element. Instead of ' + + 'passing a class like Foo, pass React.createElement(Foo) ' + + 'or .', + ); + } else if (element != null && typeof element.props !== 'undefined') { + // Check if it quacks like an element + invariant( + false, + 'ReactDOM.render(): Invalid component element. This may be ' + + 'caused by unintentionally loading two independent copies ' + + 'of React.', + ); + } else { + invariant(false, 'ReactDOM.render(): Invalid component element.'); + } + } + } + + if (__DEV__) { + const isRootRenderedBySomeReact = !!container._reactRootContainer; + const rootEl = getReactRootElementInContainer(container); + const hasNonRootReactChild = !!(rootEl && + ReactDOMComponentTree.getInstanceFromNode(rootEl)); + + warning( + !hasNonRootReactChild || isRootRenderedBySomeReact, + 'render(...): Replacing React-rendered children with a new root ' + + 'component. If you intended to update the children of this node, ' + + 'you should instead have the existing children update their state ' + + 'and render the new components instead of calling ReactDOM.render.', + ); + + warning( + !container.tagName || container.tagName.toUpperCase() !== 'BODY', + 'render(): Rendering components directly into document.body is ' + + 'discouraged, since its children are often manipulated by third-party ' + + 'scripts and browser extensions. This may lead to subtle ' + + 'reconciliation issues. Try rendering into a container element created ' + + 'for your app.', + ); + } + + return renderSubtreeIntoContainer(null, element, container, callback); }, unstable_renderSubtreeIntoContainer( @@ -515,17 +494,10 @@ var ReactDOM = { parentComponent, element, containerNode, - false, callback, ); }, - unstable_asyncRender: (null: ?( - element: ReactElement, - container: DOMContainerElement, - callback: ?Function, - ) => *), - unmountComponentAtNode(container: DOMContainerElement) { invariant( isValidContainer(container), @@ -547,7 +519,7 @@ var ReactDOM = { // Unmount should not be batched. return DOMRenderer.unbatchedUpdates(() => { - return renderSubtreeIntoContainer(null, null, container, false, () => { + return renderSubtreeIntoContainer(null, null, container, () => { container._reactRootContainer = null; }); }); @@ -581,21 +553,6 @@ var ReactDOM = { }, }; -if (ReactDOMFeatureFlags.enableAsyncSubtreeAPI) { - ReactDOM.unstable_asyncRender = function( - element: ReactElement, - container: DOMContainerElement, - callback: ?Function, - ) { - return render(element, container, true, callback); - }; -} else { - // We set this to null on the ReactDOM export, then delete if the feature - // flag is not enabled so that it's undiscoverable. - // TODO: Is there a better way to satisfy Flow? - delete ReactDOM.unstable_asyncRender; -} - if (typeof injectInternals === 'function') { injectInternals({ findFiberByHostInstance: ReactDOMComponentTree.getClosestInstanceFromNode, diff --git a/src/renderers/dom/fiber/__tests__/ReactDOMFiberAsync-test.js b/src/renderers/dom/fiber/__tests__/ReactDOMFiberAsync-test.js index 0a69378086..e8b369a55c 100644 --- a/src/renderers/dom/fiber/__tests__/ReactDOMFiberAsync-test.js +++ b/src/renderers/dom/fiber/__tests__/ReactDOMFiberAsync-test.js @@ -38,44 +38,11 @@ describe('ReactDOMFiberAsync', () => { ReactDOM = require('react-dom'); }); - it('unstable_asyncRender creates an async tree', () => { - ReactDOM.unstable_asyncRender(
Hi
, container); - expect(container.textContent).toEqual(''); - jest.runAllTimers(); - expect(container.textContent).toEqual('Hi'); - - ReactDOM.unstable_asyncRender(
Bye
, container); - expect(container.textContent).toEqual('Hi'); - jest.runAllTimers(); - expect(container.textContent).toEqual('Bye'); - }); - - it('updates inside an async tree are async by default', () => { - let instance; - class Component extends React.Component { - state = {step: 0}; - render() { - instance = this; - return
{this.state.step}
; - } - } - - ReactDOM.unstable_asyncRender(, container); - expect(container.textContent).toEqual(''); - jest.runAllTimers(); - expect(container.textContent).toEqual('0'); - - instance.setState({step: 1}); - expect(container.textContent).toEqual('0'); - jest.runAllTimers(); - expect(container.textContent).toEqual('1'); - }); - it('unstable_asyncUpdates creates an async subtree', () => { let instance; class Component extends React.Component { state = {step: 0}; - unstable_asyncUpdates = true; + static unstable_asyncUpdates = true; render() { instance = this; return
{this.state.step}
; @@ -93,7 +60,7 @@ describe('ReactDOMFiberAsync', () => { it('updates inside an async subtree are async by default', () => { class Component extends React.Component { - unstable_asyncUpdates = true; + static unstable_asyncUpdates = true; render() { return ; } @@ -116,6 +83,51 @@ describe('ReactDOMFiberAsync', () => { jest.runAllTimers(); expect(container.textContent).toEqual('1'); }); + + it('unstable_asyncUpdates at the root makes the entire tree async', () => { + class Async extends React.Component { + static unstable_asyncUpdates = true; + render() { + return this.props.children; + } + } + ReactDOM.render(
Hi
, container); + expect(container.textContent).toEqual(''); + jest.runAllTimers(); + expect(container.textContent).toEqual('Hi'); + + ReactDOM.render(
Bye
, container); + expect(container.textContent).toEqual('Hi'); + jest.runAllTimers(); + expect(container.textContent).toEqual('Bye'); + }); + + it('updates inside an async tree are async by default', () => { + class Async extends React.Component { + static unstable_asyncUpdates = true; + render() { + return this.props.children; + } + } + let instance; + class Component extends React.Component { + state = {step: 0}; + render() { + instance = this; + return
{this.state.step}
; + } + } + + ReactDOM.render(, container); + expect(container.textContent).toEqual(''); + jest.runAllTimers(); + expect(container.textContent).toEqual('0'); + + instance.setState({step: 1}); + expect(container.textContent).toEqual('0'); + jest.runAllTimers(); + expect(container.textContent).toEqual('1'); + }); }); } }); diff --git a/src/renderers/shared/fiber/ReactFiberBeginWork.js b/src/renderers/shared/fiber/ReactFiberBeginWork.js index 2e58f752c2..050e9d951d 100644 --- a/src/renderers/shared/fiber/ReactFiberBeginWork.js +++ b/src/renderers/shared/fiber/ReactFiberBeginWork.js @@ -66,7 +66,7 @@ module.exports = function( config: HostConfig, hostContext: HostContext, scheduleUpdate: (fiber: Fiber, priorityLevel: PriorityLevel) => void, - getPriorityContext: (fiber: Fiber) => PriorityLevel, + getPriorityContext: (fiber: Fiber, forceAsync: boolean) => PriorityLevel, ) { const { shouldSetTextContent, diff --git a/src/renderers/shared/fiber/ReactFiberClassComponent.js b/src/renderers/shared/fiber/ReactFiberClassComponent.js index 0e5cf81ffe..c03fe3ca29 100644 --- a/src/renderers/shared/fiber/ReactFiberClassComponent.js +++ b/src/renderers/shared/fiber/ReactFiberClassComponent.js @@ -60,7 +60,7 @@ if (__DEV__) { module.exports = function( scheduleUpdate: (fiber: Fiber, priorityLevel: PriorityLevel) => void, - getPriorityContext: (fiber: Fiber) => PriorityLevel, + getPriorityContext: (fiber: Fiber, forceAsync: boolean) => PriorityLevel, memoizeProps: (workInProgress: Fiber, props: any) => void, memoizeState: (workInProgress: Fiber, state: any) => void, ) { @@ -69,7 +69,7 @@ module.exports = function( isMounted, enqueueSetState(instance, partialState, callback) { const fiber = ReactInstanceMap.get(instance); - const priorityLevel = getPriorityContext(fiber); + const priorityLevel = getPriorityContext(fiber, false); callback = callback === undefined ? null : callback; if (__DEV__) { warnOnInvalidCallback(callback, 'setState'); @@ -79,7 +79,7 @@ module.exports = function( }, enqueueReplaceState(instance, state, callback) { const fiber = ReactInstanceMap.get(instance); - const priorityLevel = getPriorityContext(fiber); + const priorityLevel = getPriorityContext(fiber, false); callback = callback === undefined ? null : callback; if (__DEV__) { warnOnInvalidCallback(callback, 'replaceState'); @@ -89,7 +89,7 @@ module.exports = function( }, enqueueForceUpdate(instance, callback) { const fiber = ReactInstanceMap.get(instance); - const priorityLevel = getPriorityContext(fiber); + const priorityLevel = getPriorityContext(fiber, false); callback = callback === undefined ? null : callback; if (__DEV__) { warnOnInvalidCallback(callback, 'forceUpdate'); @@ -308,7 +308,7 @@ module.exports = function( instance.refs = emptyObject; instance.context = getMaskedContext(workInProgress, unmaskedContext); - if (instance.unstable_asyncUpdates === true) { + if (workInProgress.type.unstable_asyncUpdates === true) { workInProgress.internalContextTag |= AsyncUpdates; } diff --git a/src/renderers/shared/fiber/ReactFiberReconciler.js b/src/renderers/shared/fiber/ReactFiberReconciler.js index a0151b30a8..309ede457f 100644 --- a/src/renderers/shared/fiber/ReactFiberReconciler.js +++ b/src/renderers/shared/fiber/ReactFiberReconciler.js @@ -124,19 +124,12 @@ export type HostConfig = { export type Reconciler = { createContainer(containerInfo: C): OpaqueRoot, - createAsyncContainer(containerInfo: C): OpaqueRoot, updateContainer( element: ReactNodeList, container: OpaqueRoot, parentComponent: ?ReactComponent, callback: ?Function, ): void, - updateAsyncContainer( - element: ReactNodeList, - container: OpaqueRoot, - parentComponent: ?ReactComponent, - callback: ?Function, - ): void, performWithPriority(priorityLevel: PriorityLevel, fn: Function): void, batchedUpdates(fn: () => A): A, unbatchedUpdates(fn: () => A): A, @@ -193,7 +186,13 @@ module.exports = function( } } - const priorityLevel = getPriorityContext(current); + // Check if the top-level element is an async wrapper component. If so, treat + // updates to the root as async. This is a bit weird but lets us avoid a separate + // `renderAsync` API. + const forceAsync = element != null && + element.type != null && + (element.type: any).unstable_asyncUpdates === true; + const priorityLevel = getPriorityContext(current, forceAsync); const nextState = {element}; callback = callback === undefined ? null : callback; if (__DEV__) { @@ -208,85 +207,40 @@ module.exports = function( scheduleUpdate(current, priorityLevel); } - function updateContainer( - element: ReactNodeList, - container: OpaqueRoot, - parentComponent: ?ReactComponent, - async: boolean, - callback: ?Function, - ) { - // TODO: Make messages more user-friendly? - if (__DEV__) { - warning( - !async || container.current.internalContextTag & AsyncUpdates, - 'Attempted to schedule an asynchronous update on a sync container.', - ); - } - - // TODO: If this is a nested container, this won't be the root. - const current = container.current; - - if (__DEV__) { - if (ReactFiberInstrumentation.debugTool) { - if (current.alternate === null) { - ReactFiberInstrumentation.debugTool.onMountContainer(container); - } else if (element === null) { - ReactFiberInstrumentation.debugTool.onUnmountContainer(container); - } else { - ReactFiberInstrumentation.debugTool.onUpdateContainer(container); - } - } - } - - const context = getContextForSubtree(parentComponent); - if (container.context === null) { - container.context = context; - } else { - container.pendingContext = context; - } - - scheduleTopLevelUpdate(current, element, callback); - } - return { createContainer(containerInfo: C): OpaqueRoot { return createFiberRoot(containerInfo); }, - createAsyncContainer(containerInfo: C): OpaqueRoot { - const fiberRoot = createFiberRoot(containerInfo); - fiberRoot.current.internalContextTag |= AsyncUpdates; - return fiberRoot; - }, - updateContainer( element: ReactNodeList, container: OpaqueRoot, parentComponent: ?ReactComponent, callback: ?Function, ): void { - updateContainer( - element, - container, - parentComponent, - false, // async = false - callback, - ); - }, + // TODO: If this is a nested container, this won't be the root. + const current = container.current; - updateAsyncContainer( - element: ReactNodeList, - container: OpaqueRoot, - parentComponent: ?ReactComponent, - callback: ?Function, - ) { - updateContainer( - element, - container, - parentComponent, - true, // async = true - callback, - ); + if (__DEV__) { + if (ReactFiberInstrumentation.debugTool) { + if (current.alternate === null) { + ReactFiberInstrumentation.debugTool.onMountContainer(container); + } else if (element === null) { + ReactFiberInstrumentation.debugTool.onUnmountContainer(container); + } else { + ReactFiberInstrumentation.debugTool.onUpdateContainer(container); + } + } + } + + const context = getContextForSubtree(parentComponent); + if (container.context === null) { + container.context = context; + } else { + container.pendingContext = context; + } + + scheduleTopLevelUpdate(current, element, callback); }, performWithPriority, diff --git a/src/renderers/shared/fiber/ReactFiberScheduler.js b/src/renderers/shared/fiber/ReactFiberScheduler.js index dddec0a83f..c2e05aefd2 100644 --- a/src/renderers/shared/fiber/ReactFiberScheduler.js +++ b/src/renderers/shared/fiber/ReactFiberScheduler.js @@ -1345,12 +1345,17 @@ module.exports = function( } } - function getPriorityContext(fiber: Fiber): PriorityLevel { + function getPriorityContext( + fiber: Fiber, + forceAsync: boolean, + ): PriorityLevel { let priorityLevel = priorityContext; if (priorityLevel === NoWork) { if ( !useSyncScheduling || - (enableAsyncSubtreeAPI === true && fiber.internalContextTag & AsyncUpdates) + (enableAsyncSubtreeAPI === true && + fiber.internalContextTag & AsyncUpdates) || + forceAsync ) { priorityLevel = LowPriority; } else {