[crud] Basic implementation

This PR introduces a new experimental hook `useResourceEffect`, which is something that we're doing some very early initial tests on.

This may likely not pan out and will be removed or modified if so. Please do not rely on it as it will break.
This commit is contained in:
lauren
2024-11-15 13:27:26 -05:00
committed by Lauren Tan
parent 0480cdb58c
commit 0106aabc6d
19 changed files with 1301 additions and 32 deletions
+28 -6
View File
@@ -14,6 +14,11 @@ import type {CapturedValue} from './ReactCapturedValue';
import {isRendering, setIsRendering} from './ReactCurrentFiber';
import {captureCommitPhaseError} from './ReactFiberWorkLoop';
import {
ResourceEffectIdentityKind,
ResourceEffectUpdateKind,
SimpleEffectKind,
} from './ReactFiberHooks';
// These indirections exists so we can exclude its stack frame in DEV (and anything below it).
// TODO: Consider marking the whole bundle instead of these boundaries.
@@ -176,12 +181,29 @@ export const callComponentWillUnmountInDEV: (
: (null: any);
const callCreate = {
'react-stack-bottom-frame': function (effect: Effect): (() => void) | void {
const create = effect.create;
const inst = effect.inst;
const destroy = create();
inst.destroy = destroy;
return destroy;
'react-stack-bottom-frame': function (
effect: Effect,
): (() => void) | mixed | void {
switch (effect.kind) {
case SimpleEffectKind: {
const create = effect.create;
const inst = effect.inst;
const destroy = create();
inst.destroy = destroy;
return destroy;
}
case ResourceEffectIdentityKind: {
return effect.create();
}
case ResourceEffectUpdateKind:
default: {
if (__DEV__) {
console.error(
'Could not call create on an update to a ResourceEffect. This is a bug in React.',
);
}
}
}
},
};
+125 -6
View File
@@ -18,6 +18,7 @@ import {
enableProfilerNestedUpdatePhase,
enableSchedulingProfiler,
enableScopeAPI,
enableUseResourceEffectHook,
} from 'shared/ReactFeatureFlags';
import {
ClassComponent,
@@ -49,6 +50,7 @@ import {
Layout as HookLayout,
Insertion as HookInsertion,
Passive as HookPassive,
HasEffect as HookHasEffect,
} from './ReactHookEffectTags';
import {didWarnAboutReassigningProps} from './ReactFiberBeginWork';
import {
@@ -70,6 +72,11 @@ import {
} from './ReactFiberCallUserSpace';
import {runWithFiberInDEV} from './ReactCurrentFiber';
import {
ResourceEffectIdentityKind,
ResourceEffectUpdateKind,
SimpleEffectKind,
} from './ReactFiberHooks';
function shouldProfile(current: Fiber): boolean {
return (
@@ -146,19 +153,68 @@ export function commitHookEffectListMount(
// Mount
let destroy;
if (enableUseResourceEffectHook) {
if (effect.kind === ResourceEffectIdentityKind) {
if (__DEV__) {
effect.resource = runWithFiberInDEV(
finishedWork,
callCreateInDEV,
effect,
);
if (effect.resource == null) {
console.error(
'useResourceEffect must provide a callback which returns a resource. ' +
'If a managed resource is not needed here, use useEffect. Received %s',
effect.resource,
);
}
} else {
effect.resource = effect.create();
}
if (effect.next.kind === ResourceEffectUpdateKind) {
effect.next.resource = effect.resource;
} else {
if (__DEV__) {
console.error(
'Found identity effect without an update effect. This is a bug in React.',
);
}
}
destroy = effect.destroy;
}
if (effect.kind === ResourceEffectUpdateKind) {
if (
// We don't want to fire updates on remount during Activity
(flags & HookHasEffect) > 0 &&
typeof effect.update === 'function' &&
effect.resource != null
) {
// TODO(@poteto) what about multiple updates?
effect.update(effect.resource);
}
}
}
if (__DEV__) {
if ((flags & HookInsertion) !== NoHookEffect) {
setIsRunningInsertionEffect(true);
}
destroy = runWithFiberInDEV(finishedWork, callCreateInDEV, effect);
if (effect.kind === SimpleEffectKind) {
destroy = runWithFiberInDEV(
finishedWork,
callCreateInDEV,
effect,
);
}
if ((flags & HookInsertion) !== NoHookEffect) {
setIsRunningInsertionEffect(false);
}
} else {
const create = effect.create;
const inst = effect.inst;
destroy = create();
inst.destroy = destroy;
if (effect.kind === SimpleEffectKind) {
const create = effect.create;
const inst = effect.inst;
destroy = create();
inst.destroy = destroy;
}
}
if (enableSchedulingProfiler) {
@@ -176,6 +232,11 @@ export function commitHookEffectListMount(
hookName = 'useLayoutEffect';
} else if ((effect.tag & HookInsertion) !== NoFlags) {
hookName = 'useInsertionEffect';
} else if (
enableUseResourceEffectHook &&
effect.kind === ResourceEffectIdentityKind
) {
hookName = 'useResourceEffect';
} else {
hookName = 'useEffect';
}
@@ -244,9 +305,34 @@ export function commitHookEffectListUnmount(
if ((effect.tag & flags) === flags) {
// Unmount
const inst = effect.inst;
if (
enableUseResourceEffectHook &&
effect.kind === ResourceEffectIdentityKind &&
effect.resource != null
) {
inst.destroy = effect.destroy;
}
const destroy = inst.destroy;
if (destroy !== undefined) {
inst.destroy = undefined;
let resource;
if (enableUseResourceEffectHook) {
if (effect.kind === ResourceEffectIdentityKind) {
resource = effect.resource;
effect.resource = null;
// TODO(@poteto) very sketchy
if (effect.next.kind === ResourceEffectUpdateKind) {
effect.next.resource = null;
effect.next.update = undefined;
} else {
if (__DEV__) {
console.error(
'Found identity effect without an update effect. This is a bug in React.',
);
}
}
}
}
if (enableSchedulingProfiler) {
if ((flags & HookPassive) !== NoHookEffect) {
markComponentPassiveEffectUnmountStarted(finishedWork);
@@ -260,7 +346,16 @@ export function commitHookEffectListUnmount(
setIsRunningInsertionEffect(true);
}
}
safelyCallDestroy(finishedWork, nearestMountedAncestor, destroy);
if (enableUseResourceEffectHook) {
safelyCallDestroyWithResource(
finishedWork,
nearestMountedAncestor,
destroy,
resource,
);
} else {
safelyCallDestroy(finishedWork, nearestMountedAncestor, destroy);
}
if (__DEV__) {
if ((flags & HookInsertion) !== NoHookEffect) {
setIsRunningInsertionEffect(false);
@@ -895,6 +990,30 @@ function safelyCallDestroy(
}
}
function safelyCallDestroyWithResource(
current: Fiber,
nearestMountedAncestor: Fiber | null,
destroy: mixed => void,
resource: mixed,
) {
const destroy_ = resource == null ? destroy : destroy.bind(null, resource);
if (__DEV__) {
runWithFiberInDEV(
current,
callDestroyInDEV,
current,
nearestMountedAncestor,
destroy_,
);
} else {
try {
destroy_();
} catch (error) {
captureCommitPhaseError(current, nearestMountedAncestor, error);
}
}
}
function commitProfiler(
finishedWork: Fiber,
current: Fiber | null,
+424 -20
View File
@@ -48,6 +48,7 @@ import {
disableLegacyMode,
enableNoCloningMemoCache,
enableContextProfiling,
enableUseResourceEffectHook,
} from 'shared/ReactFeatureFlags';
import {
REACT_CONTEXT_TYPE,
@@ -218,13 +219,44 @@ type EffectInstance = {
destroy: void | (() => void),
};
export type Effect = {
export const SimpleEffectKind: 0 = 0;
export const ResourceEffectIdentityKind: 1 = 1;
export const ResourceEffectUpdateKind: 2 = 2;
export type EffectKind =
| typeof SimpleEffectKind
| typeof ResourceEffectIdentityKind
| typeof ResourceEffectUpdateKind;
export type Effect =
| SimpleEffect
| ResourceEffectIdentity
| ResourceEffectUpdate;
export type SimpleEffect = {
kind: typeof SimpleEffectKind,
tag: HookFlags,
create: () => (() => void) | void,
inst: EffectInstance,
deps: Array<mixed> | null,
create: () => (() => void) | void,
createDeps: Array<mixed> | void | null,
next: Effect,
};
export type ResourceEffectIdentity = {
kind: typeof ResourceEffectIdentityKind,
tag: HookFlags,
inst: EffectInstance,
create: () => mixed,
createDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
next: Effect,
resource: mixed,
};
export type ResourceEffectUpdate = {
kind: typeof ResourceEffectUpdateKind,
tag: HookFlags,
inst: EffectInstance,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
next: Effect,
resource: mixed,
};
type StoreInstance<T> = {
value: T,
@@ -347,6 +379,23 @@ function checkDepsAreArrayDev(deps: mixed): void {
}
}
function checkDepsAreNonEmptyArrayDev(deps: mixed): void {
if (__DEV__) {
if (
deps !== undefined &&
deps !== null &&
isArray(deps) &&
deps.length === 0
) {
console.error(
'%s received a dependency array with no dependencies. When ' +
'specified, the dependency array must have at least one dependency.',
currentHookNameInDev,
);
}
}
}
function warnOnHookMismatchInDev(currentHookName: HookType): void {
if (__DEV__) {
const componentName = getComponentNameFromFiber(currentlyRenderingFiber);
@@ -1718,10 +1767,10 @@ function mountSyncExternalStore<T>(
// directly, without storing any additional state. For the same reason, we
// don't need to set a static flag, either.
fiber.flags |= PassiveEffect;
pushEffect(
pushSimpleEffect(
HookHasEffect | HookPassive,
updateStoreInstance.bind(null, fiber, inst, nextSnapshot, getSnapshot),
createEffectInstance(),
updateStoreInstance.bind(null, fiber, inst, nextSnapshot, getSnapshot),
null,
);
@@ -1788,10 +1837,10 @@ function updateSyncExternalStore<T>(
workInProgressHook.memoizedState.tag & HookHasEffect)
) {
fiber.flags |= PassiveEffect;
pushEffect(
pushSimpleEffect(
HookHasEffect | HookPassive,
updateStoreInstance.bind(null, fiber, inst, nextSnapshot, getSnapshot),
createEffectInstance(),
updateStoreInstance.bind(null, fiber, inst, nextSnapshot, getSnapshot),
null,
);
@@ -2448,10 +2497,10 @@ function updateActionStateImpl<S, P>(
const prevAction = actionQueueHook.memoizedState;
if (action !== prevAction) {
currentlyRenderingFiber.flags |= PassiveEffect;
pushEffect(
pushSimpleEffect(
HookHasEffect | HookPassive,
actionStateActionEffect.bind(null, actionQueue, action),
createEffectInstance(),
actionStateActionEffect.bind(null, actionQueue, action),
null,
);
}
@@ -2508,20 +2557,67 @@ function rerenderActionState<S, P>(
return [state, dispatch, false];
}
function pushEffect(
function pushSimpleEffect(
tag: HookFlags,
create: () => (() => void) | void,
inst: EffectInstance,
deps: Array<mixed> | null,
create: () => (() => void) | void,
createDeps: Array<mixed> | void | null,
): Effect {
const effect: Effect = {
const effect: SimpleEffect = {
kind: SimpleEffectKind,
tag,
create,
createDeps,
inst,
deps,
// Circular
next: (null: any),
};
return pushEffectImpl(effect);
}
function pushResourceEffectIdentity(
tag: HookFlags,
inst: EffectInstance,
create: () => mixed,
createDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
resource: mixed,
): Effect {
const effect: ResourceEffectIdentity = {
kind: ResourceEffectIdentityKind,
tag,
create,
createDeps,
inst,
destroy,
resource,
// Circular
next: (null: any),
};
return pushEffectImpl(effect);
}
function pushResourceEffectUpdate(
tag: HookFlags,
inst: EffectInstance,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
resource: mixed,
): Effect {
const effect: ResourceEffectUpdate = {
kind: ResourceEffectUpdateKind,
tag,
update,
updateDeps,
inst,
resource,
// Circular
next: (null: any),
};
return pushEffectImpl(effect);
}
function pushEffectImpl(effect: Effect): Effect {
let componentUpdateQueue: null | FunctionComponentUpdateQueue =
(currentlyRenderingFiber.updateQueue: any);
if (componentUpdateQueue === null) {
@@ -2565,10 +2661,10 @@ function mountEffectImpl(
const hook = mountWorkInProgressHook();
const nextDeps = deps === undefined ? null : deps;
currentlyRenderingFiber.flags |= fiberFlags;
hook.memoizedState = pushEffect(
hook.memoizedState = pushSimpleEffect(
HookHasEffect | hookFlags,
create,
createEffectInstance(),
create,
nextDeps,
);
}
@@ -2589,9 +2685,15 @@ function updateEffectImpl(
if (currentHook !== null) {
if (nextDeps !== null) {
const prevEffect: Effect = currentHook.memoizedState;
const prevDeps = prevEffect.deps;
const prevDeps = prevEffect.createDeps;
// $FlowFixMe[incompatible-call] (@poteto)
if (areHookInputsEqual(nextDeps, prevDeps)) {
hook.memoizedState = pushEffect(hookFlags, create, inst, nextDeps);
hook.memoizedState = pushSimpleEffect(
hookFlags,
inst,
create,
nextDeps,
);
return;
}
}
@@ -2599,10 +2701,10 @@ function updateEffectImpl(
currentlyRenderingFiber.flags |= fiberFlags;
hook.memoizedState = pushEffect(
hook.memoizedState = pushSimpleEffect(
HookHasEffect | hookFlags,
create,
inst,
create,
nextDeps,
);
}
@@ -2639,6 +2741,150 @@ function updateEffect(
updateEffectImpl(PassiveEffect, HookPassive, create, deps);
}
function mountResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
if (
__DEV__ &&
(currentlyRenderingFiber.mode & StrictEffectsMode) !== NoMode &&
(currentlyRenderingFiber.mode & NoStrictPassiveEffectsMode) === NoMode
) {
mountResourceEffectImpl(
MountPassiveDevEffect | PassiveEffect | PassiveStaticEffect,
HookPassive,
create,
createDeps,
update,
updateDeps,
destroy,
);
} else {
mountResourceEffectImpl(
PassiveEffect | PassiveStaticEffect,
HookPassive,
create,
createDeps,
update,
updateDeps,
destroy,
);
}
}
function mountResourceEffectImpl(
fiberFlags: Flags,
hookFlags: HookFlags,
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
const hook = mountWorkInProgressHook();
currentlyRenderingFiber.flags |= fiberFlags;
hook.memoizedState = pushResourceEffectIdentity(
HookHasEffect | hookFlags,
createEffectInstance(),
create,
createDeps,
destroy,
);
hook.memoizedState = pushResourceEffectUpdate(
hookFlags,
createEffectInstance(),
update,
updateDeps,
);
}
function updateResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
updateResourceEffectImpl(
PassiveEffect,
HookPassive,
create,
createDeps,
update,
updateDeps,
destroy,
);
}
function updateResourceEffectImpl(
fiberFlags: Flags,
hookFlags: HookFlags,
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
const hook = updateWorkInProgressHook();
const effect: Effect = hook.memoizedState;
const inst = effect.inst;
const nextCreateDeps = createDeps === undefined ? null : createDeps;
const nextUpdateDeps = updateDeps === undefined ? null : updateDeps;
let isCreateDepsSame: boolean;
let isUpdateDepsSame: boolean;
if (currentHook !== null) {
const prevEffect: Effect = currentHook.memoizedState;
if (nextCreateDeps !== null) {
let prevCreateDeps;
// TODO(@poteto) seems sketchy
if (prevEffect.kind === ResourceEffectIdentityKind) {
prevCreateDeps =
prevEffect.createDeps != null ? prevEffect.createDeps : null;
} else {
prevCreateDeps =
prevEffect.next.createDeps != null
? prevEffect.next.createDeps
: null;
}
isCreateDepsSame = areHookInputsEqual(nextCreateDeps, prevCreateDeps);
}
if (nextUpdateDeps !== null) {
const prevUpdateDeps =
prevEffect.updateDeps != null ? prevEffect.updateDeps : null;
isUpdateDepsSame = areHookInputsEqual(nextUpdateDeps, prevUpdateDeps);
}
}
if (!(isCreateDepsSame && isUpdateDepsSame)) {
currentlyRenderingFiber.flags |= fiberFlags;
}
const resource =
currentHook !== null
? (currentHook.memoizedState as Effect).resource
: undefined;
hook.memoizedState = pushResourceEffectIdentity(
isCreateDepsSame ? hookFlags : HookHasEffect | hookFlags,
inst,
create,
nextCreateDeps,
destroy,
resource,
);
hook.memoizedState = pushResourceEffectUpdate(
isUpdateDepsSame ? hookFlags : HookHasEffect | hookFlags,
inst,
update,
nextUpdateDeps,
resource,
);
}
function useEffectEventImpl<Args, Return, F: (...Array<Args>) => Return>(
payload: EventFunctionPayload<Args, Return, F>,
) {
@@ -3789,6 +4035,9 @@ if (enableUseMemoCacheHook) {
if (enableUseEffectEventHook) {
(ContextOnlyDispatcher: Dispatcher).useEffectEvent = throwInvalidHookError;
}
if (enableUseResourceEffectHook) {
(ContextOnlyDispatcher: Dispatcher).useResourceEffect = throwInvalidHookError;
}
if (enableAsyncActions) {
(ContextOnlyDispatcher: Dispatcher).useHostTransitionStatus =
throwInvalidHookError;
@@ -3832,6 +4081,9 @@ if (enableUseMemoCacheHook) {
if (enableUseEffectEventHook) {
(HooksDispatcherOnMount: Dispatcher).useEffectEvent = mountEvent;
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnMount: Dispatcher).useResourceEffect = mountResourceEffect;
}
if (enableAsyncActions) {
(HooksDispatcherOnMount: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -3875,6 +4127,10 @@ if (enableUseMemoCacheHook) {
if (enableUseEffectEventHook) {
(HooksDispatcherOnUpdate: Dispatcher).useEffectEvent = updateEvent;
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnUpdate: Dispatcher).useResourceEffect =
updateResourceEffect;
}
if (enableAsyncActions) {
(HooksDispatcherOnUpdate: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -3918,6 +4174,10 @@ if (enableUseMemoCacheHook) {
if (enableUseEffectEventHook) {
(HooksDispatcherOnRerender: Dispatcher).useEffectEvent = updateEvent;
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnRerender: Dispatcher).useResourceEffect =
updateResourceEffect;
}
if (enableAsyncActions) {
(HooksDispatcherOnRerender: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -4108,6 +4368,27 @@ if (__DEV__) {
return mountEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnMountInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
): void {
currentHookNameInDev = 'useResourceEffect';
mountHookTypesDev();
checkDepsAreNonEmptyArrayDev(updateDeps);
return mountResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(HooksDispatcherOnMountInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -4300,6 +4581,26 @@ if (__DEV__) {
return mountEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnMountWithHookTypesInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
): void {
currentHookNameInDev = 'useResourceEffect';
updateHookTypesDev();
return mountResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(HooksDispatcherOnMountWithHookTypesInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -4491,6 +4792,26 @@ if (__DEV__) {
return updateEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnUpdateInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
currentHookNameInDev = 'useResourceEffect';
updateHookTypesDev();
return updateResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(HooksDispatcherOnUpdateInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -4682,6 +5003,26 @@ if (__DEV__) {
return updateEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(HooksDispatcherOnRerenderInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
currentHookNameInDev = 'useResourceEffect';
updateHookTypesDev();
return updateResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(HooksDispatcherOnRerenderInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -4897,6 +5238,27 @@ if (__DEV__) {
return mountEvent(callback);
};
}
if (InvalidNestedHooksDispatcherOnMountInDEV) {
(HooksDispatcherOnRerenderInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
): void {
currentHookNameInDev = 'useResourceEffect';
warnInvalidHookAccess();
mountHookTypesDev();
return mountResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(InvalidNestedHooksDispatcherOnMountInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -5115,6 +5477,27 @@ if (__DEV__) {
return updateEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(InvalidNestedHooksDispatcherOnUpdateInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
currentHookNameInDev = 'useResourceEffect';
warnInvalidHookAccess();
updateHookTypesDev();
return updateResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(InvalidNestedHooksDispatcherOnUpdateInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
@@ -5333,6 +5716,27 @@ if (__DEV__) {
return updateEvent(callback);
};
}
if (enableUseResourceEffectHook) {
(InvalidNestedHooksDispatcherOnRerenderInDEV: Dispatcher).useResourceEffect =
function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) {
currentHookNameInDev = 'useResourceEffect';
warnInvalidHookAccess();
updateHookTypesDev();
return updateResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
};
}
if (enableAsyncActions) {
(InvalidNestedHooksDispatcherOnRerenderInDEV: Dispatcher).useHostTransitionStatus =
useHostTransitionStatus;
+8
View File
@@ -47,6 +47,7 @@ export type HookType =
| 'useRef'
| 'useEffect'
| 'useEffectEvent'
| 'useResourceEffect'
| 'useInsertionEffect'
| 'useLayoutEffect'
| 'useCallback'
@@ -412,6 +413,13 @@ export type Dispatcher = {
deps: Array<mixed> | void | null,
): void,
useEffectEvent?: <Args, F: (...Array<Args>) => mixed>(callback: F) => F,
useResourceEffect?: (
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
) => void,
useInsertionEffect(
create: () => (() => void) | void,
deps: Array<mixed> | void | null,
@@ -41,6 +41,7 @@ let waitFor;
let waitForThrow;
let waitForPaint;
let assertLog;
let useResourceEffect;
describe('ReactHooksWithNoopRenderer', () => {
beforeEach(() => {
@@ -66,6 +67,7 @@ describe('ReactHooksWithNoopRenderer', () => {
useDeferredValue = React.useDeferredValue;
Suspense = React.Suspense;
Activity = React.unstable_Activity;
useResourceEffect = React.experimental_useResourceEffect;
ContinuousEventPriority =
require('react-reconciler/constants').ContinuousEventPriority;
if (gate(flags => flags.enableSuspenseList)) {
@@ -3252,6 +3254,681 @@ describe('ReactHooksWithNoopRenderer', () => {
});
});
// @gate enableUseResourceEffectHook
describe('useResourceEffect', () => {
class Resource {
isDeleted: false;
id: string;
opts: mixed;
constructor(id, opts) {
this.id = id;
this.opts = opts;
}
update(opts) {
if (this.isDeleted) {
console.error('Cannot update deleted resource');
return;
}
this.opts = opts;
}
destroy() {
this.isDeleted = true;
}
}
// @gate enableUseResourceEffectHook
it('validates create return value', async () => {
function App({id}) {
useResourceEffect(() => {
Scheduler.log(`create(${id})`);
}, [id]);
return null;
}
await expect(async () => {
await act(() => {
ReactNoop.render(<App id={1} />);
});
}).toErrorDev(
'useResourceEffect must provide a callback which returns a resource. ' +
'If a managed resource is not needed here, use useEffect. Received undefined',
{withoutStack: true},
);
});
// @gate enableUseResourceEffectHook
it('validates non-empty update deps', async () => {
function App({id}) {
useResourceEffect(
() => {
Scheduler.log(`create(${id})`);
return {};
},
[id],
() => {
Scheduler.log('update');
},
[],
);
return null;
}
await expect(async () => {
await act(() => {
ReactNoop.render(<App id={1} />);
});
}).toErrorDev(
'useResourceEffect received a dependency array with no dependencies. ' +
'When specified, the dependency array must have at least one dependency.',
);
});
// @gate enableUseResourceEffectHook
it('simple mount and update', async () => {
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
[opts],
resource => {
resource.destroy();
Scheduler.log(`destroy(${resource.id}, ${resource.opts.username})`);
},
);
return null;
}
await act(() => {
ReactNoop.render(<App id={1} username="Jack" />);
});
assertLog(['create(1, Jack)']);
await act(() => {
ReactNoop.render(<App id={1} username="Lauren" />);
});
assertLog(['update(1, Lauren)']);
await act(() => {
ReactNoop.render(<App id={1} username="Lauren" />);
});
assertLog([]);
await act(() => {
ReactNoop.render(<App id={1} username="Jordan" />);
});
assertLog(['update(1, Jordan)']);
await act(() => {
ReactNoop.render(<App id={2} username="Jack" />);
});
assertLog(['destroy(1, Jordan)', 'create(2, Jack)']);
await act(() => {
ReactNoop.render(null);
});
assertLog(['destroy(2, Jack)']);
});
// @gate enableUseResourceEffectHook
it('simple mount with no update', async () => {
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
[opts],
resource => {
resource.destroy();
Scheduler.log(`destroy(${resource.id}, ${resource.opts.username})`);
},
);
return null;
}
await act(() => {
ReactNoop.render(<App id={1} username="Jack" />);
});
assertLog(['create(1, Jack)']);
await act(() => {
ReactNoop.render(null);
});
assertLog(['destroy(1, Jack)']);
});
// @gate enableUseResourceEffectHook
it('calls update on every render if no deps are specified', async () => {
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
);
return null;
}
await act(() => {
ReactNoop.render(<App id={1} username="Jack" />);
});
assertLog(['create(1, Jack)']);
await act(() => {
ReactNoop.render(<App id={1} username="Jack" />);
});
assertLog(['update(1, Jack)']);
await act(() => {
ReactNoop.render(<App id={2} username="Jack" />);
});
assertLog(['create(2, Jack)', 'update(2, Jack)']);
await act(() => {
ReactNoop.render(<App id={2} username="Lauren" />);
});
assertLog(['update(2, Lauren)']);
});
// @gate enableUseResourceEffectHook
it('does not unmount previous useResourceEffect between updates', async () => {
function App({id}) {
useResourceEffect(
() => {
const resource = new Resource(id);
Scheduler.log(`create(${resource.id})`);
return resource;
},
[],
resource => {
Scheduler.log(`update(${resource.id})`);
},
undefined,
resource => {
Scheduler.log(`destroy(${resource.id})`);
resource.destroy();
},
);
return <Text text={'Id: ' + id} />;
}
await act(async () => {
ReactNoop.render(<App id={0} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
});
assertLog(['create(0)']);
await act(async () => {
ReactNoop.render(<App id={1} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 1', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 1" />);
});
assertLog(['update(0)']);
});
// @gate enableUseResourceEffectHook
it('unmounts only on deletion', async () => {
function App({id}) {
useResourceEffect(
() => {
const resource = new Resource(id);
Scheduler.log(`create(${resource.id})`);
return resource;
},
undefined,
resource => {
Scheduler.log(`update(${resource.id})`);
},
undefined,
resource => {
Scheduler.log(`destroy(${resource.id})`);
resource.destroy();
},
);
return <Text text={'Id: ' + id} />;
}
await act(async () => {
ReactNoop.render(<App id={0} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
});
assertLog(['create(0)']);
ReactNoop.render(null);
await waitForAll(['destroy(0)']);
expect(ReactNoop).toMatchRenderedOutput(null);
});
// @gate enableUseResourceEffectHook
it('unmounts on deletion', async () => {
function Wrapper(props) {
return <App {...props} />;
}
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
[opts],
resource => {
resource.destroy();
Scheduler.log(`destroy(${resource.id}, ${resource.opts.username})`);
},
);
return <Text text={'Id: ' + id} />;
}
await act(async () => {
ReactNoop.render(<Wrapper id={0} username="Sathya" />, () =>
Scheduler.log('Sync effect'),
);
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
});
assertLog(['create(0, Sathya)']);
await act(async () => {
ReactNoop.render(<Wrapper id={0} username="Lauren" />, () =>
Scheduler.log('Sync effect'),
);
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
});
assertLog(['update(0, Lauren)']);
ReactNoop.render(null);
await waitForAll(['destroy(0, Lauren)']);
expect(ReactNoop).toMatchRenderedOutput(null);
});
// @gate enableUseResourceEffectHook
it('handles errors in create on mount', async () => {
function App({id}) {
useResourceEffect(
() => {
Scheduler.log(`Mount A [${id}]`);
return {};
},
undefined,
undefined,
undefined,
resource => {
Scheduler.log(`Unmount A [${id}]`);
},
);
useResourceEffect(
() => {
Scheduler.log('Oops!');
throw new Error('Oops!');
// eslint-disable-next-line no-unreachable
Scheduler.log(`Mount B [${id}]`);
return {};
},
undefined,
undefined,
undefined,
resource => {
Scheduler.log(`Unmount B [${id}]`);
},
);
return <Text text={'Id: ' + id} />;
}
await expect(async () => {
await act(async () => {
ReactNoop.render(<App id={0} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
});
}).rejects.toThrow('Oops');
assertLog([
'Mount A [0]',
'Oops!',
// Clean up effect A. There's no effect B to clean-up, because it
// never mounted.
'Unmount A [0]',
]);
expect(ReactNoop).toMatchRenderedOutput(null);
});
// @gate enableUseResourceEffectHook
it('handles errors in create on update', async () => {
function App({id}) {
useResourceEffect(
() => {
Scheduler.log(`Mount A [${id}]`);
return {};
},
[],
() => {
if (id === 1) {
Scheduler.log('Oops!');
throw new Error('Oops error!');
}
Scheduler.log(`Update A [${id}]`);
},
[id],
() => {
Scheduler.log(`Unmount A [${id}]`);
},
);
return <Text text={'Id: ' + id} />;
}
await act(async () => {
ReactNoop.render(<App id={0} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
ReactNoop.flushPassiveEffects();
assertLog(['Mount A [0]']);
});
await expect(async () => {
await act(async () => {
// This update will trigger an error
ReactNoop.render(<App id={1} />, () => Scheduler.log('Sync effect'));
await waitFor(['Id: 1', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 1" />);
ReactNoop.flushPassiveEffects();
assertLog(['Oops!', 'Unmount A [1]']);
expect(ReactNoop).toMatchRenderedOutput(null);
});
}).rejects.toThrow('Oops error!');
});
// @gate enableUseResourceEffectHook
it('handles errors in destroy on update', async () => {
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`Mount A [${id}, ${resource.opts.username}]`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`Update A [${id}, ${resource.opts.username}]`);
},
[opts],
resource => {
Scheduler.log(`Oops, ${resource.opts.username}!`);
if (id === 1) {
throw new Error(`Oops ${resource.opts.username} error!`);
}
Scheduler.log(`Unmount A [${id}, ${resource.opts.username}]`);
},
);
return <Text text={'Id: ' + id} />;
}
await act(async () => {
ReactNoop.render(<App id={0} username="Lauren" />, () =>
Scheduler.log('Sync effect'),
);
await waitFor(['Id: 0', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 0" />);
ReactNoop.flushPassiveEffects();
assertLog(['Mount A [0, Lauren]']);
});
await expect(async () => {
await act(async () => {
// This update will trigger an error during passive effect unmount
ReactNoop.render(<App id={1} username="Sathya" />, () =>
Scheduler.log('Sync effect'),
);
await waitFor(['Id: 1', 'Sync effect']);
expect(ReactNoop).toMatchRenderedOutput(<span prop="Id: 1" />);
ReactNoop.flushPassiveEffects();
assertLog(['Oops, Lauren!', 'Mount A [1, Sathya]', 'Oops, Sathya!']);
});
// TODO(lauren) more explicit assertions. this is weird because we
// destroy both the first and second resource
}).rejects.toThrow();
expect(ReactNoop).toMatchRenderedOutput(null);
});
// @gate enableUseResourceEffectHook && enableActivity
it('composes with activity', async () => {
function App({id, username}) {
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
[opts],
resource => {
resource.destroy();
Scheduler.log(`destroy(${resource.id}, ${resource.opts.username})`);
},
);
return null;
}
const root = ReactNoop.createRoot();
await act(() => {
root.render(
<Activity mode="hidden">
<App id={0} username="Rick" />
</Activity>,
);
});
assertLog([]);
await act(() => {
root.render(
<Activity mode="hidden">
<App id={0} username="Lauren" />
</Activity>,
);
});
assertLog([]);
await act(() => {
root.render(
<Activity mode="visible">
<App id={0} username="Rick" />
</Activity>,
);
});
assertLog(['create(0, Rick)']);
await act(() => {
root.render(
<Activity mode="visible">
<App id={0} username="Lauren" />
</Activity>,
);
});
assertLog(['update(0, Lauren)']);
await act(() => {
root.render(
<Activity mode="hidden">
<App id={0} username="Lauren" />
</Activity>,
);
});
assertLog(['destroy(0, Lauren)']);
});
// @gate enableUseResourceEffectHook
it('composes with suspense', async () => {
function TextBox({text}) {
return <AsyncText text={text} ms={0} />;
}
let setUsername_;
function App({id}) {
const [username, setUsername] = useState('Mofei');
setUsername_ = setUsername;
const opts = useMemo(() => {
return {username};
}, [username]);
useResourceEffect(
() => {
const resource = new Resource(id, opts);
Scheduler.log(`create(${resource.id}, ${resource.opts.username})`);
return resource;
},
[id],
resource => {
resource.update(opts);
Scheduler.log(`update(${resource.id}, ${resource.opts.username})`);
},
[opts],
resource => {
resource.destroy();
Scheduler.log(`destroy(${resource.id}, ${resource.opts.username})`);
},
);
return (
<>
<Text text={'Sync: ' + username} />
<Suspense fallback={<Text text={'Loading'} />}>
<TextBox text={username} />
</Suspense>
</>
);
}
await act(async () => {
ReactNoop.render(<App id={0} />);
await waitFor([
'Sync: Mofei',
'Suspend! [Mofei]',
'Loading',
'create(0, Mofei)',
]);
expect(ReactNoop).toMatchRenderedOutput(
<>
<span prop="Sync: Mofei" />
<span prop="Loading" />
</>,
);
ReactNoop.flushPassiveEffects();
assertLog([]);
Scheduler.unstable_advanceTime(10);
await advanceTimers(10);
assertLog(['Promise resolved [Mofei]']);
});
assertLog(['Mofei']);
expect(ReactNoop).toMatchRenderedOutput(
<>
<span prop="Sync: Mofei" />
<span prop="Mofei" />
</>,
);
await act(async () => {
ReactNoop.render(<App id={1} />, () => Scheduler.log('Sync effect'));
await waitFor([
'Sync: Mofei',
'Mofei',
'Sync effect',
'destroy(0, Mofei)',
'create(1, Mofei)',
]);
expect(ReactNoop).toMatchRenderedOutput(
<>
<span prop="Sync: Mofei" />
<span prop="Mofei" />
</>,
);
ReactNoop.flushPassiveEffects();
assertLog([]);
});
await act(async () => {
setUsername_('Lauren');
await waitFor([
'Sync: Lauren',
'Suspend! [Lauren]',
'Loading',
'update(1, Lauren)',
]);
expect(ReactNoop).toMatchRenderedOutput(
<>
<span prop="Sync: Lauren" />
<span hidden={true} prop="Mofei" />
<span prop="Loading" />
</>,
);
ReactNoop.flushPassiveEffects();
assertLog([]);
Scheduler.unstable_advanceTime(10);
await advanceTimers(10);
assertLog(['Promise resolved [Lauren]']);
});
assertLog(['Lauren']);
expect(ReactNoop).toMatchRenderedOutput(
<>
<span prop="Sync: Lauren" />
<span prop="Lauren" />
</>,
);
});
});
describe('useCallback', () => {
it('memoizes callback by comparing inputs', async () => {
class IncrementButton extends React.PureComponent {
+1
View File
@@ -60,6 +60,7 @@ export {
useDeferredValue,
useEffect,
experimental_useEffectEvent,
experimental_useResourceEffect,
useImperativeHandle,
useInsertionEffect,
useLayoutEffect,
@@ -41,6 +41,7 @@ export {
useDeferredValue,
useEffect,
experimental_useEffectEvent,
experimental_useResourceEffect,
useImperativeHandle,
useInsertionEffect,
useLayoutEffect,
+1
View File
@@ -19,6 +19,7 @@ export {
createElement,
createRef,
experimental_useEffectEvent,
experimental_useResourceEffect,
forwardRef,
Fragment,
isValidElement,
+2
View File
@@ -42,6 +42,7 @@ import {
useContext,
useEffect,
useEffectEvent,
useResourceEffect,
useImperativeHandle,
useDebugValue,
useInsertionEffect,
@@ -89,6 +90,7 @@ export {
useContext,
useEffect,
useEffectEvent as experimental_useEffectEvent,
useResourceEffect as experimental_useResourceEffect,
useImperativeHandle,
useDebugValue,
useInsertionEffect,
+18
View File
@@ -226,6 +226,24 @@ export function useEffectEvent<Args, F: (...Array<Args>) => mixed>(
return dispatcher.useEffectEvent(callback);
}
export function useResourceEffect(
create: () => mixed,
createDeps: Array<mixed> | void | null,
update: ((resource: mixed) => void) | void,
updateDeps: Array<mixed> | void | null,
destroy: ((resource: mixed) => void) | void,
): void {
const dispatcher = resolveDispatcher();
// $FlowFixMe[not-a-function] This is unstable, thus optional
return dispatcher.useResourceEffect(
create,
createDeps,
update,
updateDeps,
destroy,
);
}
export function useOptimistic<S, A>(
passthrough: S,
reducer: ?(S, A) => S,
+5
View File
@@ -161,6 +161,11 @@ export const transitionLaneExpirationMs = 5000;
*/
export const enableInfiniteRenderLoopDetection = false;
/**
* Experimental new hook for better managing resources in effects.
*/
export const enableUseResourceEffectHook = false;
// -----------------------------------------------------------------------------
// Ready for next major.
//
@@ -25,3 +25,4 @@ export const enableShallowPropDiffing = __VARIANT__;
export const passChildrenWhenCloningPersistedNodes = __VARIANT__;
export const enableFabricCompleteRootInCommitPhase = __VARIANT__;
export const enableSiblingPrerendering = __VARIANT__;
export const enableUseResourceEffectHook = __VARIANT__;
@@ -25,6 +25,7 @@ export const {
enableObjectFiber,
enablePersistedModeClonedFlag,
enableShallowPropDiffing,
enableUseResourceEffectHook,
passChildrenWhenCloningPersistedNodes,
enableSiblingPrerendering,
} = dynamicFlags;
@@ -84,6 +84,7 @@ export const syncLaneExpirationMs = 250;
export const transitionLaneExpirationMs = 5000;
export const useModernStrictMode = true;
export const enableSiblingPrerendering = true;
export const enableUseResourceEffectHook = false;
// Profiling Only
export const enableProfilerTimer = __PROFILE__;
@@ -83,6 +83,8 @@ export const renameElementSymbol = true;
export const enableShallowPropDiffing = false;
export const enableSiblingPrerendering = true;
export const enableUseResourceEffectHook = false;
// TODO: This must be in sync with the main ReactFeatureFlags file because
// the Test Renderer's value must be the same as the one used by the
// react package.
@@ -80,6 +80,7 @@ export const transitionLaneExpirationMs = 5000;
export const useModernStrictMode = true;
export const enableFabricCompleteRootInCommitPhase = false;
export const enableSiblingPrerendering = true;
export const enableUseResourceEffectHook = false;
// Flow magic to verify the exports of this file match the original version.
((((null: any): ExportsType): FeatureFlagsType): ExportsType);
@@ -94,5 +94,7 @@ export const enableOwnerStacks = false;
export const enableShallowPropDiffing = false;
export const enableSiblingPrerendering = true;
export const enableUseResourceEffectHook = false;
// Flow magic to verify the exports of this file match the original version.
((((null: any): ExportsType): FeatureFlagsType): ExportsType);
@@ -42,6 +42,8 @@ export const enableSchedulingProfiler = __VARIANT__;
export const enableInfiniteRenderLoopDetection = __VARIANT__;
export const enableSiblingPrerendering = __VARIANT__;
export const enableUseResourceEffectHook = __VARIANT__;
// TODO: These flags are hard-coded to the default values used in open source.
// Update the tests so that they pass in either mode, then set these
// to __VARIANT__.
@@ -31,6 +31,7 @@ export const {
enableSiblingPrerendering,
enableTransitionTracing,
enableTrustedTypesIntegration,
enableUseResourceEffectHook,
favorSafetyOverHydrationPerf,
renameElementSymbol,
retryLaneExpirationMs,