[Fiber] Highlight hydration and offscreen render phases (#31752)
This highlights the render phase as the tertiary color (green) when we're render a hydration lane or offscreen lane. I call the "Render" phase "Hydrated" instead in this case. For the offscreen case we don't currently have a differentiation between hydrated or activity. I just called that "Prepared". Even for the hydration case where there's no discovered client rendered boundaries it's more like it's preparing for an interaction rather than blocking one. Where as for the other lanes the hydration might block something. <img width="1173" alt="Screenshot 2024-12-12 at 11 23 14 PM" src="https://github.com/user-attachments/assets/49ab1508-840f-4188-a085-18fe94b14187" /> In a follow up I'd like to color the components in the Components tree green if they were hydrated but not the ones that was actually client rendered e.g. due to a mismatch or forced client rendering so you can tell the difference. Unfortunately, the current signals we have for this get reset earlier in the commit phase than when we log these. Another thing is that a failed hydration should probably be colored red even though it ends up committing successfully. I.e. a recoverable error.
Sebastian Markbåge committed
Dec 14, 2024 at 13:49 UTC
c32780eeb4c44e138d09a35da841926f512d3b07
3 files changed
+94
-17
packages/react-reconciler/src/ReactFiberLane.js
+12
@@ -621,6 +621,18 @@ export function includesTransitionLane(lanes: Lanes): boolean {
621
return (lanes & TransitionLanes) !== NoLanes;
622
}
623
624
+export function includesOnlyHydrationLanes(lanes: Lanes): boolean {
625
+ return (lanes & HydrationLanes) === lanes;
626
+}
627
+
628
+export function includesOnlyOffscreenLanes(lanes: Lanes): boolean {
629
+ return (lanes & OffscreenLane) === lanes;
630
+}
631
+
632
+export function includesOnlyHydrationOrOffscreenLanes(lanes: Lanes): boolean {
633
+ return (lanes & (HydrationLanes | OffscreenLane)) === lanes;
634
+}
635
+
636
export function includesBlockingLane(lanes: Lanes): boolean {
637
const SyncDefaultLanes =
638
InputContinuousHydrationLane |
packages/react-reconciler/src/ReactFiberPerformanceTrack.js
+60
-10
@@ -9,9 +9,16 @@
9
10
import type {Fiber} from './ReactInternalTypes';
11
12
+import type {Lanes} from './ReactFiberLane';
13
+
14
import getComponentNameFromFiber from './getComponentNameFromFiber';
15
14
-import {getGroupNameOfHighestPriorityLane} from './ReactFiberLane';
16
+import {
17
+ getGroupNameOfHighestPriorityLane,
18
+ includesOnlyHydrationLanes,
19
+ includesOnlyOffscreenLanes,
20
+ includesOnlyHydrationOrOffscreenLanes,
21
+} from './ReactFiberLane';
22
23
import {enableProfilerTimer} from 'shared/ReactFeatureFlags';
24
@@ -51,7 +58,7 @@ const reusableLaneOptions = {
58
},
59
};
60
54
-export function setCurrentTrackFromLanes(lanes: number): void {
61
+export function setCurrentTrackFromLanes(lanes: Lanes): void {
62
reusableLaneDevToolDetails.track = getGroupNameOfHighestPriorityLane(lanes);
63
}
64
@@ -223,6 +230,7 @@ export function logBlockingStart(
230
eventType: null | string,
231
eventIsRepeat: boolean,
232
renderStartTime: number,
233
+ lanes: Lanes,
234
): void {
235
if (supportsUserTiming) {
236
reusableLaneDevToolDetails.track = 'Blocking';
@@ -240,7 +248,11 @@ export function logBlockingStart(
248
}
249
if (updateTime > 0) {
250
// Log the time from when we called setState until we started rendering.
243
- reusableLaneDevToolDetails.color = 'primary-light';
251
+ reusableLaneDevToolDetails.color = includesOnlyHydrationOrOffscreenLanes(
252
+ lanes,
253
+ )
254
+ ? 'tertiary-light'
255
+ : 'primary-light';
256
reusableLaneOptions.start = updateTime;
257
reusableLaneOptions.end = renderStartTime;
258
performance.measure('Blocked', reusableLaneOptions);
@@ -292,33 +304,65 @@ export function logTransitionStart(
304
}
305
}
306
295
-export function logRenderPhase(startTime: number, endTime: number): void {
307
+export function logRenderPhase(
308
+ startTime: number,
309
+ endTime: number,
310
+ lanes: Lanes,
311
+): void {
312
if (supportsUserTiming) {
297
- reusableLaneDevToolDetails.color = 'primary-dark';
313
+ reusableLaneDevToolDetails.color = includesOnlyHydrationOrOffscreenLanes(
314
+ lanes,
315
+ )
316
+ ? 'tertiary-dark'
317
+ : 'primary-dark';
318
reusableLaneOptions.start = startTime;
319
reusableLaneOptions.end = endTime;
300
- performance.measure('Render', reusableLaneOptions);
320
+ performance.measure(
321
+ includesOnlyOffscreenLanes(lanes)
322
+ ? 'Prepared'
323
+ : includesOnlyHydrationLanes(lanes)
324
+ ? 'Hydrated'
325
+ : 'Render',
326
+ reusableLaneOptions,
327
+ );
328
}
329
}
330
331
export function logInterruptedRenderPhase(
332
startTime: number,
333
endTime: number,
334
+ lanes: Lanes,
335
): void {
336
if (supportsUserTiming) {
309
- reusableLaneDevToolDetails.color = 'primary-dark';
337
+ reusableLaneDevToolDetails.color = includesOnlyHydrationOrOffscreenLanes(
338
+ lanes,
339
+ )
340
+ ? 'tertiary-dark'
341
+ : 'primary-dark';
342
reusableLaneOptions.start = startTime;
343
reusableLaneOptions.end = endTime;
312
- performance.measure('Interrupted Render', reusableLaneOptions);
344
+ performance.measure(
345
+ includesOnlyOffscreenLanes(lanes)
346
+ ? 'Prewarm'
347
+ : includesOnlyHydrationLanes(lanes)
348
+ ? 'Interrupted Hydration'
349
+ : 'Interrupted Render',
350
+ reusableLaneOptions,
351
+ );
352
}
353
}
354
355
export function logSuspendedRenderPhase(
356
startTime: number,
357
endTime: number,
358
+ lanes: Lanes,
359
): void {
360
if (supportsUserTiming) {
321
- reusableLaneDevToolDetails.color = 'primary-dark';
361
+ reusableLaneDevToolDetails.color = includesOnlyHydrationOrOffscreenLanes(
362
+ lanes,
363
+ )
364
+ ? 'tertiary-dark'
365
+ : 'primary-dark';
366
reusableLaneOptions.start = startTime;
367
reusableLaneOptions.end = endTime;
368
performance.measure('Prewarm', reusableLaneOptions);
@@ -328,10 +372,15 @@ export function logSuspendedRenderPhase(
372
export function logSuspendedWithDelayPhase(
373
startTime: number,
374
endTime: number,
375
+ lanes: Lanes,
376
): void {
377
// This means the render was suspended and cannot commit until it gets unblocked.
378
if (supportsUserTiming) {
334
- reusableLaneDevToolDetails.color = 'primary-dark';
379
+ reusableLaneDevToolDetails.color = includesOnlyHydrationOrOffscreenLanes(
380
+ lanes,
381
+ )
382
+ ? 'tertiary-dark'
383
+ : 'primary-dark';
384
reusableLaneOptions.start = startTime;
385
reusableLaneOptions.end = endTime;
386
performance.measure('Suspended', reusableLaneOptions);
@@ -341,6 +390,7 @@ export function logSuspendedWithDelayPhase(
390
export function logErroredRenderPhase(
391
startTime: number,
392
endTime: number,
393
+ lanes: Lanes,
394
): void {
395
if (supportsUserTiming) {
396
reusableLaneDevToolDetails.color = 'error';
packages/react-reconciler/src/ReactFiberWorkLoop.js
+22
-7
@@ -1035,7 +1035,7 @@ export function performWorkOnRoot(
1035
if (errorRetryLanes !== NoLanes) {
1036
if (enableProfilerTimer && enableComponentPerformanceTrack) {
1037
setCurrentTrackFromLanes(lanes);
1038
- logErroredRenderPhase(renderStartTime, renderEndTime);
1038
+ logErroredRenderPhase(renderStartTime, renderEndTime, lanes);
1039
finalizeRender(lanes, renderEndTime);
1040
}
1041
lanes = errorRetryLanes;
@@ -1066,7 +1066,7 @@ export function performWorkOnRoot(
1066
if (exitStatus === RootFatalErrored) {
1067
if (enableProfilerTimer && enableComponentPerformanceTrack) {
1068
setCurrentTrackFromLanes(lanes);
1069
- logErroredRenderPhase(renderStartTime, renderEndTime);
1069
+ logErroredRenderPhase(renderStartTime, renderEndTime, lanes);
1070
finalizeRender(lanes, renderEndTime);
1071
}
1072
prepareFreshStack(root, NoLanes);
@@ -1207,7 +1207,7 @@ function finishConcurrentRender(
1207
// until we receive more data.
1208
if (enableProfilerTimer && enableComponentPerformanceTrack) {
1209
setCurrentTrackFromLanes(lanes);
1210
- logSuspendedRenderPhase(renderStartTime, renderEndTime);
1210
+ logSuspendedRenderPhase(renderStartTime, renderEndTime, lanes);
1211
finalizeRender(lanes, renderEndTime);
1212
trackSuspendedTime(lanes, renderEndTime);
1213
}
@@ -1757,9 +1757,17 @@ function prepareFreshStack(root: FiberRoot, lanes: Lanes): Fiber {
1757
// then this is considered a prewarm and not an interrupted render because
1758
// we couldn't have shown anything anyway so it's not a bad thing that we
1759
// got interrupted.
1760
- logSuspendedRenderPhase(previousRenderStartTime, renderStartTime);
1760
+ logSuspendedRenderPhase(
1761
+ previousRenderStartTime,
1762
+ renderStartTime,
1763
+ lanes,
1764
+ );
1765
} else {
1762
- logInterruptedRenderPhase(previousRenderStartTime, renderStartTime);
1766
+ logInterruptedRenderPhase(
1767
+ previousRenderStartTime,
1768
+ renderStartTime,
1769
+ lanes,
1770
+ );
1771
}
1772
finalizeRender(workInProgressRootRenderLanes, renderStartTime);
1773
}
@@ -1783,6 +1791,7 @@ function prepareFreshStack(root: FiberRoot, lanes: Lanes): Fiber {
1791
: clampedUpdateTime >= 0
1792
? clampedUpdateTime
1793
: renderStartTime,
1794
+ lanes,
1795
);
1796
}
1797
logBlockingStart(
@@ -1791,6 +1800,7 @@ function prepareFreshStack(root: FiberRoot, lanes: Lanes): Fiber {
1800
blockingEventType,
1801
blockingEventIsRepeat,
1802
renderStartTime,
1803
+ lanes,
1804
);
1805
clearBlockingTimers();
1806
}
@@ -1817,6 +1827,7 @@ function prepareFreshStack(root: FiberRoot, lanes: Lanes): Fiber {
1827
: clampedUpdateTime >= 0
1828
? clampedUpdateTime
1829
: renderStartTime,
1830
+ lanes,
1831
);
1832
}
1833
logTransitionStart(
@@ -3202,9 +3213,13 @@ function commitRootImpl(
3213
// Log the previous render phase once we commit. I.e. we weren't interrupted.
3214
setCurrentTrackFromLanes(lanes);
3215
if (exitStatus === RootErrored) {
3205
- logErroredRenderPhase(completedRenderStartTime, completedRenderEndTime);
3216
+ logErroredRenderPhase(
3217
+ completedRenderStartTime,
3218
+ completedRenderEndTime,
3219
+ lanes,
3220
+ );
3221
} else {
3207
- logRenderPhase(completedRenderStartTime, completedRenderEndTime);
3222
+ logRenderPhase(completedRenderStartTime, completedRenderEndTime, lanes);
3223
}
3224
}
3225