Skip to content

Commit e8e42f5

Browse files
acdliteacdlite
committed
Add Visibility flag for hiding/unhiding trees
There's `beforeblur` logic in the snapshot phase that needs to visit every Suspense boundary whose visibility is toggled. Right now it does that by visiting Placement and Deletion effects. That includes many unrelated nodes. By adding a new flag specifically for toggling Visibility, we will only visit the relevant Suspense (and Offscreen) boundaries, instead of all nodes that have a Placement. Potential follow-ups (not urgent): - The `beforeblur` logic also has a check to see whether the visibility was toggled on or off. It only cares about things being hidden. As a follow up, I can split the Visibility flag into separate Hide/Show flags, and only visit Hide. - Now that this is separate from Update, we can move the rest of the Suspense's layout effects (like attaching retry listeners) to the passive phase.
1 parent 0dd809b commit e8e42f5

File tree

3 files changed

+40
-35
lines changed

3 files changed

+40
-35
lines changed

‎packages/react-reconciler/src/ReactFiberCompleteWork.new.js‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ import {
7373
NoFlags,
7474
DidCapture,
7575
Snapshot,
76+
Visibility,
7677
MutationMask,
7778
LayoutMask,
7879
PassiveMask,
@@ -1154,8 +1155,8 @@ function completeWork(
11541155
// TODO: Only schedule updates if not prevDidTimeout.
11551156
if (nextDidTimeout) {
11561157
// If this boundary just timed out, schedule an effect to attach a
1157-
// retry listener to the promise. This flag is also used to hide the
1158-
// primary children.
1158+
// retry listener to the promise.
1159+
// TODO: Move to passive phase
11591160
workInProgress.flags |= Update;
11601161
}
11611162
}
@@ -1167,7 +1168,7 @@ function completeWork(
11671168
// primary children. In mutation mode, we also need the flag to
11681169
// *unhide* children that were previously hidden, so check if this
11691170
// is currently timed out, too.
1170-
workInProgress.flags |= Update;
1171+
workInProgress.flags |= Update | Visibility;
11711172
}
11721173
}
11731174
if (
@@ -1176,6 +1177,7 @@ function completeWork(
11761177
workInProgress.memoizedProps.suspenseCallback != null
11771178
) {
11781179
// Always notify the callback
1180+
// TODO: Move to passive phase
11791181
workInProgress.flags |= Update;
11801182
}
11811183
bubbleProperties(workInProgress);
@@ -1523,7 +1525,7 @@ function completeWork(
15231525
prevIsHidden !== nextIsHidden &&
15241526
newProps.mode !== 'unstable-defer-without-hiding'
15251527
) {
1526-
workInProgress.flags |= Update;
1528+
workInProgress.flags |= Update | Visibility;
15271529
}
15281530
}
15291531

‎packages/react-reconciler/src/ReactFiberFlags.js‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,59 +10,59 @@
1010
export type Flags = number;
1111

1212
// Don't change these two values. They're used by React Dev Tools.
13-
export const NoFlags = /* */ 0b000000000000000000;
14-
export const PerformedWork = /* */ 0b000000000000000001;
13+
export const NoFlags = /* */ 0b0000000000000000000;
14+
export const PerformedWork = /* */ 0b0000000000000000001;
1515

1616
// You can change the rest (and add more).
17-
export const Placement = /* */ 0b000000000000000010;
18-
export const Update = /* */ 0b000000000000000100;
19-
export const PlacementAndUpdate = /* */ 0b000000000000000110;
20-
export const Deletion = /* */ 0b000000000000001000;
21-
export const ContentReset = /* */ 0b000000000000010000;
22-
export const Callback = /* */ 0b000000000000100000;
23-
export const DidCapture = /* */ 0b000000000001000000;
24-
export const Ref = /* */ 0b000000000010000000;
25-
export const Snapshot = /* */ 0b000000000100000000;
26-
export const Passive = /* */ 0b000000001000000000;
27-
// TODO (effects) Remove this bit once the new reconciler is synced to the old.
28-
export const PassiveUnmountPendingDev = /* */ 0b000010000000000000;
29-
export const Hydrating = /* */ 0b000000010000000000;
30-
export const HydratingAndUpdate = /* */ 0b000000010000000100;
17+
export const Placement = /* */ 0b0000000000000000010;
18+
export const Update = /* */ 0b0000000000000000100;
19+
export const PlacementAndUpdate = /* */ 0b0000000000000000110;
20+
export const Deletion = /* */ 0b0000000000000001000;
21+
export const ContentReset = /* */ 0b0000000000000010000;
22+
export const Callback = /* */ 0b0000000000000100000;
23+
export const DidCapture = /* */ 0b0000000000001000000;
24+
export const Ref = /* */ 0b0000000000010000000;
25+
export const Snapshot = /* */ 0b0000000000100000000;
26+
export const Passive = /* */ 0b0000000001000000000;
27+
export const Hydrating = /* */ 0b0000000010000000000;
28+
export const HydratingAndUpdate = /* */ 0b0000000010000000100;
29+
export const Visibility = /* */ 0b0000000100000000000;
3130

3231
// Passive & Update & Callback & Ref & Snapshot
33-
export const LifecycleEffectMask = /* */ 0b000000001110100100;
32+
export const LifecycleEffectMask = /* */ 0b0000000001110100100;
3433

3534
// Union of all host effects
36-
export const HostEffectMask = /* */ 0b000000011111111111;
35+
export const HostEffectMask = /* */ 0b0000000111111111111;
3736

3837
// These are not really side effects, but we still reuse this field.
39-
export const Incomplete = /* */ 0b000000100000000000;
40-
export const ShouldCapture = /* */ 0b000001000000000000;
41-
export const ForceUpdateForLegacySuspense = /* */ 0b000100000000000000;
38+
export const Incomplete = /* */ 0b0000001000000000000;
39+
export const ShouldCapture = /* */ 0b0000010000000000000;
40+
// TODO (effects) Remove this bit once the new reconciler is synced to the old.
41+
export const PassiveUnmountPendingDev = /* */ 0b0000100000000000000;
42+
export const ForceUpdateForLegacySuspense = /* */ 0b0001000000000000000;
4243

4344
// Static tags describe aspects of a fiber that are not specific to a render,
4445
// e.g. a fiber uses a passive effect (even if there are no updates on this particular render).
4546
// This enables us to defer more work in the unmount case,
4647
// since we can defer traversing the tree during layout to look for Passive effects,
4748
// and instead rely on the static flag as a signal that there may be cleanup work.
48-
export const PassiveStatic = /* */ 0b001000000000000000;
49+
export const PassiveStatic = /* */ 0b0010000000000000000;
4950

5051
// Union of side effect groupings as pertains to subtreeFlags
51-
// TODO: Don't need to visit Placement during BeforeMutation phase
5252
// TODO: Only need to visit Deletions during BeforeMutation phase if an element
5353
// is focused.
54-
export const BeforeMutationMask = /* */ 0b000000000100001010;
55-
export const MutationMask = /* */ 0b000000010010011110;
56-
export const LayoutMask = /* */ 0b000000000010100100;
57-
export const PassiveMask = /* */ 0b000000001000001000;
54+
export const BeforeMutationMask = /* */ 0b0000000100100001000;
55+
export const MutationMask = /* */ 0b0000000110010011110;
56+
export const LayoutMask = /* */ 0b0000000000010100100;
57+
export const PassiveMask = /* */ 0b0000000001000001000;
5858

5959
// Union of tags that don't get reset on clones.
6060
// This allows certain concepts to persist without recalculting them,
6161
// e.g. whether a subtree contains passive effects or portals.
62-
export const StaticMask = /* */ 0b001000000000000000;
62+
export const StaticMask = /* */ 0b0010000000000000000;
6363

6464
// These flags allow us to traverse to fibers that have effects on mount
6565
// without traversing the entire tree after every commit for
6666
// double invoking
67-
export const MountLayoutDev = /* */ 0b010000000000000000;
68-
export const MountPassiveDev = /* */ 0b100000000000000000;
67+
export const MountLayoutDev = /* */ 0b0100000000000000000;
68+
export const MountPassiveDev = /* */ 0b1000000000000000000;

‎packages/react-reconciler/src/ReactFiberWorkLoop.new.js‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ import {
134134
HostEffectMask,
135135
Hydrating,
136136
HydratingAndUpdate,
137+
Visibility,
137138
BeforeMutationMask,
138139
MutationMask,
139140
LayoutMask,
@@ -2155,8 +2156,10 @@ function commitBeforeMutationEffectsImpl(fiber: Fiber) {
21552156

21562157
if (!shouldFireAfterActiveInstanceBlur && focusedInstanceHandle !== null) {
21572158
// Check to see if the focused element was inside of a hidden (Suspense) subtree.
2158-
// TODO: Move this out of the hot path using a dedicated effect tag.
21592159
if (
2160+
// TODO: Can optimize this further with separate Hide and Show flags. We
2161+
// only care about Hide here.
2162+
(flags & Visibility) !== NoFlags &&
21602163
fiber.tag === SuspenseComponent &&
21612164
isSuspenseBoundaryBeingHidden(current, fiber) &&
21622165
doesFiberContain(fiber, focusedInstanceHandle)

0 commit comments

Comments
 (0)