Skip to content

Commit

Permalink
[Fresh] Make all errors recoverable (#17438)
Browse files Browse the repository at this point in the history 
* [Fresh] Detect root updates more reliably

* [Fresh] Use WeakMap for root elements

* [Fresh] Make initial failures recoverable too

* Fix DevTools check

* Fix wrong flow type
  • Loading branch information
@gaearon
gaearon committed Nov 25, 2019
1 parent 54f6673 commit 6470e0f
Show file tree
Hide file tree
Showing 5 changed files with 195 additions and 80 deletions.
27 changes: 27 additions & 0 deletions packages/react-reconciler/src/ReactFiberDevToolsHook.js
View file
Expand Up @@ -14,12 +14,14 @@ import {inferPriorityFromExpirationTime} from './ReactFiberExpirationTime';
import type {Fiber} from './ReactFiber';
import type {FiberRoot} from './ReactFiberRoot';
import type {ExpirationTime} from './ReactFiberExpirationTime';
import type {ReactNodeList} from 'shared/ReactTypes';

import {DidCapture} from 'shared/ReactSideEffectTags';
import warningWithoutStack from 'shared/warningWithoutStack';

declare var __REACT_DEVTOOLS_GLOBAL_HOOK__: Object | void;

let onScheduleFiberRoot = null;
let onCommitFiberRoot = null;
let onCommitFiberUnmount = null;
let hasLoggedError = false;
Expand Down Expand Up @@ -54,6 +56,25 @@ export function injectInternals(internals: Object): boolean {
try {
const rendererID = hook.inject(internals);
// We have successfully injected, so now it is safe to set up hooks.
if (__DEV__) {
// Only used by Fast Refresh
if (typeof hook.onScheduleFiberRoot === 'function') {
onScheduleFiberRoot = (root, children) => {
try {
hook.onScheduleFiberRoot(rendererID, root, children);
} catch (err) {
if (__DEV__ && !hasLoggedError) {
hasLoggedError = true;
warningWithoutStack(
false,
'React DevTools encountered an error: %s',
err,
);
}
}
};
}
}
onCommitFiberRoot = (root, expirationTime) => {
try {
const didError = (root.current.effectTag & DidCapture) === DidCapture;
Expand Down Expand Up @@ -106,6 +127,12 @@ export function injectInternals(internals: Object): boolean {
return true;
}

export function onScheduleRoot(root: FiberRoot, children: ReactNodeList) {
if (typeof onScheduleFiberRoot === 'function') {
onScheduleFiberRoot(root, children);
}
}

export function onCommitRoot(root: FiberRoot, expirationTime: ExpirationTime) {
if (typeof onCommitFiberRoot === 'function') {
onCommitFiberRoot(root, expirationTime);
Expand Down
18 changes: 0 additions & 18 deletions packages/react-reconciler/src/ReactFiberInstrumentation.js
View file

This file was deleted.

18 changes: 4 additions & 14 deletions packages/react-reconciler/src/ReactFiberReconciler.js
View file
Expand Up @@ -48,7 +48,7 @@ import {
isContextProvider as isLegacyContextProvider,
} from './ReactFiberContext';
import {createFiberRoot} from './ReactFiberRoot';
import {injectInternals} from './ReactFiberDevToolsHook';
import {injectInternals, onScheduleRoot} from './ReactFiberDevToolsHook';
import {
requestCurrentTimeForUpdate,
computeExpirationForFiber,
Expand All @@ -69,7 +69,6 @@ import {
IsThisRendererActing,
} from './ReactFiberWorkLoop';
import {createUpdate, enqueueUpdate} from './ReactUpdateQueue';
import ReactFiberInstrumentation from './ReactFiberInstrumentation';
import {
getStackByFiberInDevAndProd,
phase as ReactCurrentFiberPhase,
Expand Down Expand Up @@ -230,6 +229,9 @@ export function updateContainer(
parentComponent: ?React$Component<any, any>,
callback: ?Function,
): ExpirationTime {
if (__DEV__) {
onScheduleRoot(container, element);
}
const current = container.current;
const currentTime = requestCurrentTimeForUpdate();
if (__DEV__) {
Expand All @@ -246,18 +248,6 @@ export function updateContainer(
suspenseConfig,
);

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;
Expand Down
99 changes: 68 additions & 31 deletions packages/react-refresh/src/ReactFreshRuntime.js
View file
Expand Up @@ -68,9 +68,17 @@ let helpersByRoot: Map<FiberRoot, RendererHelpers> = new Map();

// We keep track of mounted roots so we can schedule updates.
let mountedRoots: Set<FiberRoot> = new Set();
// If a root captures an error, we add its element to this Map so we can retry on edit.
let failedRoots: Map<FiberRoot, ReactNodeList> = new Map();
let didSomeRootFailOnMount = false;
// If a root captures an error, we remember it so we can retry on edit.
let failedRoots: Set<FiberRoot> = new Set();

// In environments that support WeakMap, we also remember the last element for every root.
// It needs to be weak because we do this even for roots that failed to mount.
// If there is no WeakMap, we won't attempt to do retrying.
// $FlowIssue
let rootElements: WeakMap<any, ReactNodeList> | null = // $FlowIssue
typeof WeakMap === 'function' ? new WeakMap() : null;

let isPerformingRefresh = false;

function computeFullKey(signature: Signature): string {
if (signature.fullKey !== null) {
Expand Down Expand Up @@ -171,11 +179,20 @@ function cloneSet<T>(set: Set<T>): Set<T> {
}

export function performReactRefresh(): RefreshUpdate | null {
if (__DEV__) {
if (pendingUpdates.length === 0) {
return null;
}
if (!__DEV__) {
throw new Error(
'Unexpected call to React Refresh in a production environment.',
);
}
if (pendingUpdates.length === 0) {
return null;
}
if (isPerformingRefresh) {
return null;
}

isPerformingRefresh = true;
try {
const staleFamilies = new Set();
const updatedFamilies = new Set();

Expand Down Expand Up @@ -216,17 +233,27 @@ export function performReactRefresh(): RefreshUpdate | null {
// If we don't do this, there is a risk they will be mutated while
// we iterate over them. For example, trying to recover a failed root
// may cause another root to be added to the failed list -- an infinite loop.
let failedRootsSnapshot = cloneMap(failedRoots);
let failedRootsSnapshot = cloneSet(failedRoots);
let mountedRootsSnapshot = cloneSet(mountedRoots);
let helpersByRootSnapshot = cloneMap(helpersByRoot);

failedRootsSnapshot.forEach((element, root) => {
failedRootsSnapshot.forEach(root => {
const helpers = helpersByRootSnapshot.get(root);
if (helpers === undefined) {
throw new Error(
'Could not find helpers for a root. This is a bug in React Refresh.',
);
}
if (!failedRoots.has(root)) {
// No longer failed.
}
if (rootElements === null) {
return;
}
if (!rootElements.has(root)) {
return;
}
const element = rootElements.get(root);
try {
helpers.scheduleRoot(root, element);
} catch (err) {
Expand All @@ -244,6 +271,9 @@ export function performReactRefresh(): RefreshUpdate | null {
'Could not find helpers for a root. This is a bug in React Refresh.',
);
}
if (!mountedRoots.has(root)) {
// No longer mounted.
}
try {
helpers.scheduleRefresh(root, update);
} catch (err) {
Expand All @@ -258,10 +288,8 @@ export function performReactRefresh(): RefreshUpdate | null {
throw firstError;
}
return update;
} else {
throw new Error(
'Unexpected call to React Refresh in a production environment.',
);
} finally {
isPerformingRefresh = false;
}
}

Expand Down Expand Up @@ -411,6 +439,11 @@ export function injectIntoGlobalHook(globalObject: any): void {
inject(injected) {
return nextID++;
},
onScheduleFiberRoot(
id: number,
root: FiberRoot,
children: ReactNodeList,
) {},
onCommitFiberRoot(
id: number,
root: FiberRoot,
Expand All @@ -437,6 +470,22 @@ export function injectIntoGlobalHook(globalObject: any): void {

// We also want to track currently mounted roots.
const oldOnCommitFiberRoot = hook.onCommitFiberRoot;
const oldOnScheduleFiberRoot = hook.onScheduleFiberRoot || (() => {});
hook.onScheduleFiberRoot = function(
id: number,
root: FiberRoot,
children: mixed,
) {
if (!isPerformingRefresh) {
// If it was intentionally scheduled, don't attempt to restore.
// This includes intentionally scheduled unmounts.
failedRoots.delete(root);
if (rootElements !== null) {
rootElements.set(root, children);
}
}
return oldOnScheduleFiberRoot.apply(this, arguments);
};
hook.onCommitFiberRoot = function(
id: number,
root: FiberRoot,
Expand Down Expand Up @@ -476,27 +525,14 @@ export function injectIntoGlobalHook(globalObject: any): void {
mountedRoots.delete(root);
if (didError) {
// We'll remount it on future edits.
// Remember what was rendered so we can restore it.
failedRoots.set(root, alternate.memoizedState.element);
failedRoots.add(root);
} else {
helpersByRoot.delete(root);
}
} else if (!wasMounted && !isMounted) {
if (didError && !failedRoots.has(root)) {
// The root had an error during the initial mount.
// We can't read its last element from the memoized state
// because there was no previously committed alternate.
// Ideally, it would be nice if we had a way to extract
// the last attempted rendered element, but accessing the update queue
// would tie this package too closely to the reconciler version.
// So instead, we just set a flag.
// TODO: Maybe we could fix this as the same time as when we fix
// DevTools to not depend on `alternate.memoizedState.element`.
didSomeRootFailOnMount = true;
} else if (!didError && failedRoots.has(root)) {
// The error is fixed but the component is still unmounted.
// This means that the unmount was not caused by a failed refresh.
failedRoots.delete(root);
if (didError) {
// We'll remount it on future edits.
failedRoots.add(root);
}
}
} else {
Expand All @@ -514,7 +550,8 @@ export function injectIntoGlobalHook(globalObject: any): void {
}

export function hasUnrecoverableErrors() {
return didSomeRootFailOnMount;
// TODO: delete this after removing dependency in RN.
return false;
}

// Exposed for testing.
Expand Down

0 comments on commit 6470e0f

Please sign in to comment.