Skip to content

[Fiber] Move runWithFiberInDEV from CommitWork to CommitEffects #30882

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

Merged
merged 5 commits into from
Sep 6, 2024
Merged

[Fiber] Move runWithFiberInDEV from CommitWork to CommitEffects #30882

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
123ae6e
Remove runWithFiberInDEV branches around recursive calls
sebmarkbage Sep 4, 2024
daec869
Wrap CommitHostEffects in runWithFiberInDEV at the same place as try/…
sebmarkbage Sep 4, 2024
1de0845
Wrap user space calls in runWithFiberInDEV
sebmarkbage Sep 4, 2024
d6ea028
Wrap remaining Commit Effects in runWithFiberInDEV
sebmarkbage Sep 4, 2024
731d483
Wrap warnings to associate the cause
sebmarkbage Sep 4, 2024
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
Prev Previous commit
Next Next commit
Wrap remaining Commit Effects in runWithFiberInDEV
  • Loading branch information
@sebmarkbage
sebmarkbage committed Sep 6, 2024
commit d6ea02805ff61c4462be9eb6838b7e3f41dbe575
160 changes: 118 additions & 42 deletions packages/react-reconciler/src/ReactFiberCommitEffects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,11 @@ export function commitClassCallbacks(finishedWork: Fiber) {
// but instead we rely on them being set during last render.
// TODO: revisit this when we implement resuming.
try {
commitCallbacks(updateQueue, instance);
if (__DEV__) {
runWithFiberInDEV(finishedWork, commitCallbacks, updateQueue, instance);
} else {
commitCallbacks(updateQueue, instance);
}
} catch (error) {
captureCommitPhaseError(finishedWork, finishedWork.return, error);
}
Expand All @@ -525,7 +529,16 @@ export function commitClassHiddenCallbacks(finishedWork: Fiber) {
if (updateQueue !== null) {
const instance = finishedWork.stateNode;
try {
commitHiddenCallbacks(updateQueue, instance);
if (__DEV__) {
runWithFiberInDEV(
finishedWork,
commitHiddenCallbacks,
updateQueue,
instance,
);
} else {
commitHiddenCallbacks(updateQueue, instance);
}
} catch (error) {
captureCommitPhaseError(finishedWork, finishedWork.return, error);
}
Expand All @@ -551,7 +564,11 @@ export function commitRootCallbacks(finishedWork: Fiber) {
}
}
try {
commitCallbacks(updateQueue, instance);
if (__DEV__) {
runWithFiberInDEV(finishedWork, commitCallbacks, updateQueue, instance);
} else {
commitCallbacks(updateQueue, instance);
}
} catch (error) {
captureCommitPhaseError(finishedWork, finishedWork.return, error);
}
Expand All @@ -563,6 +580,14 @@ if (__DEV__) {
didWarnAboutUndefinedSnapshotBeforeUpdate = new Set();
}

function callGetSnapshotBeforeUpdates(
instance: any,
prevProps: any,
prevState: any,
) {
return instance.getSnapshotBeforeUpdate(prevProps, prevState);
}

export function commitClassSnapshot(finishedWork: Fiber, current: Fiber) {
const prevProps = current.memoizedProps;
const prevState = current.memoizedState;
Expand Down Expand Up @@ -599,15 +624,20 @@ export function commitClassSnapshot(finishedWork: Fiber, current: Fiber) {
}
}
try {
const snapshot = instance.getSnapshotBeforeUpdate(
resolveClassComponentProps(
finishedWork.type,
prevProps,
finishedWork.elementType === finishedWork.type,
),
prevState,
const resolvedPrevProps = resolveClassComponentProps(
finishedWork.type,
prevProps,
finishedWork.elementType === finishedWork.type,
);
let snapshot;
if (__DEV__) {
snapshot = runWithFiberInDEV(
finishedWork,
callGetSnapshotBeforeUpdates,
instance,
resolvedPrevProps,
prevState,
);
const didWarnSet =
((didWarnAboutUndefinedSnapshotBeforeUpdate: any): Set<mixed>);
if (snapshot === undefined && !didWarnSet.has(finishedWork.type)) {
Expand All @@ -618,6 +648,12 @@ export function commitClassSnapshot(finishedWork: Fiber, current: Fiber) {
getComponentNameFromFiber(finishedWork),
);
}
} else {
snapshot = callGetSnapshotBeforeUpdates(
instance,
resolvedPrevProps,
prevState,
);
}
instance.__reactInternalSnapshotBeforeUpdate = snapshot;
} catch (error) {
Expand Down Expand Up @@ -730,7 +766,11 @@ export function safelyAttachRef(
nearestMountedAncestor: Fiber | null,
) {
try {
commitAttachRef(current);
if (__DEV__) {
runWithFiberInDEV(current, commitAttachRef, current);
} else {
commitAttachRef(current);
}
} catch (error) {
captureCommitPhaseError(current, nearestMountedAncestor, error);
}
Expand All @@ -749,12 +789,20 @@ export function safelyDetachRef(
if (shouldProfile(current)) {
try {
startLayoutEffectTimer();
refCleanup();
if (__DEV__) {
runWithFiberInDEV(current, refCleanup);
} else {
refCleanup();
}
} finally {
recordLayoutEffectDuration(current);
}
} else {
refCleanup();
if (__DEV__) {
runWithFiberInDEV(current, refCleanup);
} else {
refCleanup();
}
}
} catch (error) {
captureCommitPhaseError(current, nearestMountedAncestor, error);
Expand All @@ -771,12 +819,20 @@ export function safelyDetachRef(
if (shouldProfile(current)) {
try {
startLayoutEffectTimer();
ref(null);
if (__DEV__) {
(runWithFiberInDEV(current, ref, null): void);
} else {
ref(null);
}
} finally {
recordLayoutEffectDuration(current);
}
} else {
ref(null);
if (__DEV__) {
(runWithFiberInDEV(current, ref, null): void);
} else {
ref(null);
}
}
} catch (error) {
captureCommitPhaseError(current, nearestMountedAncestor, error);
Expand Down Expand Up @@ -810,6 +866,44 @@ export function safelyCallDestroy(
}
}

function commitProfiler(
finishedWork: Fiber,
current: Fiber | null,
commitTime: number,
effectDuration: number,
) {
const {onCommit, onRender} = finishedWork.memoizedProps;

let phase = current === null ? 'mount' : 'update';
if (enableProfilerNestedUpdatePhase) {
if (isCurrentUpdateNested()) {
phase = 'nested-update';
}
}

if (typeof onRender === 'function') {
onRender(
finishedWork.memoizedProps.id,
phase,
finishedWork.actualDuration,
finishedWork.treeBaseDuration,
finishedWork.actualStartTime,
commitTime,
);
}

if (enableProfilerCommitHooks) {
if (typeof onCommit === 'function') {
onCommit(
finishedWork.memoizedProps.id,
phase,
effectDuration,
commitTime,
);
}
}
}

export function commitProfilerUpdate(
finishedWork: Fiber,
current: Fiber | null,
Expand All @@ -818,35 +912,17 @@ export function commitProfilerUpdate(
) {
if (enableProfilerTimer && getExecutionContext() & CommitContext) {
try {
const {onCommit, onRender} = finishedWork.memoizedProps;

let phase = current === null ? 'mount' : 'update';
if (enableProfilerNestedUpdatePhase) {
if (isCurrentUpdateNested()) {
phase = 'nested-update';
}
}

if (typeof onRender === 'function') {
onRender(
finishedWork.memoizedProps.id,
phase,
finishedWork.actualDuration,
finishedWork.treeBaseDuration,
finishedWork.actualStartTime,
if (__DEV__) {
runWithFiberInDEV(
finishedWork,
commitProfiler,
finishedWork,
current,
commitTime,
effectDuration,
);
}

if (enableProfilerCommitHooks) {
if (typeof onCommit === 'function') {
onCommit(
finishedWork.memoizedProps.id,
phase,
effectDuration,
commitTime,
);
}
} else {
commitProfiler(finishedWork, current, commitTime, effectDuration);
}
} catch (error) {
captureCommitPhaseError(finishedWork, finishedWork.return, error);
Expand Down