import type {Fiber} from './ReactInternalTypes';
import type {Lanes} from './ReactFiberLane';
import type {CapturedValue} from './ReactCapturedValue';
import {SuspenseComponent} from './ReactWorkTags';
import getComponentNameFromFiber from './getComponentNameFromFiber';
import {
getGroupNameOfHighestPriorityLane,
includesOnlyHydrationLanes,
includesOnlyOffscreenLanes,
includesOnlyHydrationOrOffscreenLanes,
includesSomeLane,
} from './ReactFiberLane';
import {
addValueToProperties,
addObjectToProperties,
addObjectDiffToProperties,
} from 'shared/ReactPerformanceTrackProperties';
import {enableProfilerTimer} from 'shared/ReactFeatureFlags';
const supportsUserTiming =
enableProfilerTimer &&
typeof console !== 'undefined' &&
typeof console.timeStamp === 'function' &&
(!__DEV__ ||
(typeof performance !== 'undefined' &&
typeof performance.measure === 'function'));
const COMPONENTS_TRACK = 'Components ⚛';
const LANES_TRACK_GROUP = 'Scheduler ⚛';
let currentTrack: string = 'Blocking';
export function setCurrentTrackFromLanes(lanes: Lanes): void {
currentTrack = getGroupNameOfHighestPriorityLane(lanes);
}
export function markAllLanesInOrder() {
if (supportsUserTiming) {
console.timeStamp(
'Blocking Track',
0.003,
0.003,
'Blocking',
LANES_TRACK_GROUP,
'primary-light',
);
console.timeStamp(
'Transition Track',
0.003,
0.003,
'Transition',
LANES_TRACK_GROUP,
'primary-light',
);
console.timeStamp(
'Suspense Track',
0.003,
0.003,
'Suspense',
LANES_TRACK_GROUP,
'primary-light',
);
console.timeStamp(
'Idle Track',
0.003,
0.003,
'Idle',
LANES_TRACK_GROUP,
'primary-light',
);
}
}
function logComponentTrigger(
fiber: Fiber,
startTime: number,
endTime: number,
trigger: string,
) {
if (supportsUserTiming) {
reusableComponentOptions.start = startTime;
reusableComponentOptions.end = endTime;
reusableComponentDevToolDetails.color = 'warning';
reusableComponentDevToolDetails.tooltipText = trigger;
reusableComponentDevToolDetails.properties = null;
const debugTask = fiber._debugTask;
if (__DEV__ && debugTask) {
debugTask.run(
performance.measure.bind(
performance,
trigger,
reusableComponentOptions,
),
);
} else {
performance.measure(trigger, reusableComponentOptions);
}
}
}
export function logComponentMount(
fiber: Fiber,
startTime: number,
endTime: number,
): void {
logComponentTrigger(fiber, startTime, endTime, 'Mount');
}
export function logComponentUnmount(
fiber: Fiber,
startTime: number,
endTime: number,
): void {
logComponentTrigger(fiber, startTime, endTime, 'Unmount');
}
export function logComponentReappeared(
fiber: Fiber,
startTime: number,
endTime: number,
): void {
logComponentTrigger(fiber, startTime, endTime, 'Reconnect');
}
export function logComponentDisappeared(
fiber: Fiber,
startTime: number,
endTime: number,
): void {
logComponentTrigger(fiber, startTime, endTime, 'Disconnect');
}
let alreadyWarnedForDeepEquality = false;
export function pushDeepEquality(): boolean {
if (__DEV__) {
return alreadyWarnedForDeepEquality;
}
return false;
}
export function popDeepEquality(prev: boolean): void {
if (__DEV__) {
alreadyWarnedForDeepEquality = prev;
}
}
const reusableComponentDevToolDetails = {
color: 'primary',
properties: (null: null | Array<[string, string]>),
tooltipText: '',
track: COMPONENTS_TRACK,
};
const reusableComponentOptions = {
start: -0,
end: -0,
detail: {
devtools: reusableComponentDevToolDetails,
},
};
const resuableChangedPropsEntry = ['Changed Props', ''];
const DEEP_EQUALITY_WARNING =
'This component received deeply equal props. It might benefit from useMemo or the React Compiler in its owner.';
const reusableDeeplyEqualPropsEntry = ['Changed Props', DEEP_EQUALITY_WARNING];
export function logComponentRender(
fiber: Fiber,
startTime: number,
endTime: number,
wasHydrated: boolean,
committedLanes: Lanes,
): void {
const name = getComponentNameFromFiber(fiber);
if (name === null) {
return;
}
if (supportsUserTiming) {
const alternate = fiber.alternate;
let selfTime: number = (fiber.actualDuration: any);
if (alternate === null || alternate.child !== fiber.child) {
for (let child = fiber.child; child !== null; child = child.sibling) {
selfTime -= (child.actualDuration: any);
}
}
const color =
selfTime < 0.5
? wasHydrated
? 'tertiary-light'
: 'primary-light'
: selfTime < 10
? wasHydrated
? 'tertiary'
: 'primary'
: selfTime < 100
? wasHydrated
? 'tertiary-dark'
: 'primary-dark'
: 'error';
const debugTask = fiber._debugTask;
if (__DEV__ && debugTask) {
const props = fiber.memoizedProps;
if (
props !== null &&
alternate !== null &&
alternate.memoizedProps !== props
) {
const properties: Array<[string, string]> = [resuableChangedPropsEntry];
const isDeeplyEqual = addObjectDiffToProperties(
alternate.memoizedProps,
props,
properties,
0,
);
if (properties.length > 1) {
if (
isDeeplyEqual &&
!alreadyWarnedForDeepEquality &&
!includesSomeLane(alternate.lanes, committedLanes) &&
(fiber.actualDuration: any) > 100
) {
alreadyWarnedForDeepEquality = true;
properties[0] = reusableDeeplyEqualPropsEntry;
reusableComponentDevToolDetails.color = 'warning';
reusableComponentDevToolDetails.tooltipText = DEEP_EQUALITY_WARNING;
} else {
reusableComponentDevToolDetails.color = color;
reusableComponentDevToolDetails.tooltipText = name;
}
reusableComponentDevToolDetails.properties = properties;
reusableComponentOptions.start = startTime;
reusableComponentOptions.end = endTime;
debugTask.run(
performance.measure.bind(
performance,
name,
reusableComponentOptions,
),
);
return;
}
}
debugTask.run(
console.timeStamp.bind(
console,
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
color,
),
);
} else {
console.timeStamp(
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
color,
);
}
}
}
export function logComponentErrored(
fiber: Fiber,
startTime: number,
endTime: number,
errors: Array<CapturedValue<mixed>>,
): void {
if (supportsUserTiming) {
const name = getComponentNameFromFiber(fiber);
if (name === null) {
return;
}
if (__DEV__) {
let debugTask: ?ConsoleTask = null;
const properties: Array<[string, string]> = [];
for (let i = 0; i < errors.length; i++) {
const capturedValue = errors[i];
if (debugTask == null && capturedValue.source !== null) {
debugTask = capturedValue.source._debugTask;
}
const error = capturedValue.value;
const message =
typeof error === 'object' &&
error !== null &&
typeof error.message === 'string'
?
String(error.message)
:
String(error);
properties.push(['Error', message]);
}
if (fiber.key !== null) {
addValueToProperties('key', fiber.key, properties, 0, '');
}
if (fiber.memoizedProps !== null) {
addObjectToProperties(fiber.memoizedProps, properties, 0, '');
}
if (debugTask == null) {
debugTask = fiber._debugTask;
}
const options = {
start: startTime,
end: endTime,
detail: {
devtools: {
color: 'error',
track: COMPONENTS_TRACK,
tooltipText:
fiber.tag === SuspenseComponent
? 'Hydration failed'
: 'Error boundary caught an error',
properties,
},
},
};
if (__DEV__ && debugTask) {
debugTask.run(
performance.measure.bind(performance, name, options),
);
} else {
performance.measure(name, options);
}
} else {
console.timeStamp(
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'error',
);
}
}
}
function logComponentEffectErrored(
fiber: Fiber,
startTime: number,
endTime: number,
errors: Array<CapturedValue<mixed>>,
): void {
if (supportsUserTiming) {
const name = getComponentNameFromFiber(fiber);
if (name === null) {
return;
}
if (__DEV__) {
const properties: Array<[string, string]> = [];
for (let i = 0; i < errors.length; i++) {
const capturedValue = errors[i];
const error = capturedValue.value;
const message =
typeof error === 'object' &&
error !== null &&
typeof error.message === 'string'
?
String(error.message)
:
String(error);
properties.push(['Error', message]);
}
if (fiber.key !== null) {
addValueToProperties('key', fiber.key, properties, 0, '');
}
if (fiber.memoizedProps !== null) {
addObjectToProperties(fiber.memoizedProps, properties, 0, '');
}
const options = {
start: startTime,
end: endTime,
detail: {
devtools: {
color: 'error',
track: COMPONENTS_TRACK,
tooltipText: 'A lifecycle or effect errored',
properties,
},
},
};
const debugTask = fiber._debugTask;
if (debugTask) {
debugTask.run(
performance.measure.bind(performance, name, options),
);
} else {
performance.measure(name, options);
}
} else {
console.timeStamp(
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'error',
);
}
}
}
export function logComponentEffect(
fiber: Fiber,
startTime: number,
endTime: number,
selfTime: number,
errors: null | Array<CapturedValue<mixed>>,
): void {
if (errors !== null) {
logComponentEffectErrored(fiber, startTime, endTime, errors);
return;
}
const name = getComponentNameFromFiber(fiber);
if (name === null) {
return;
}
if (supportsUserTiming) {
const color =
selfTime < 1
? 'secondary-light'
: selfTime < 100
? 'secondary'
: selfTime < 500
? 'secondary-dark'
: 'error';
const debugTask = fiber._debugTask;
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
color,
),
);
} else {
console.timeStamp(
name,
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
color,
);
}
}
}
export function logYieldTime(startTime: number, endTime: number): void {
if (supportsUserTiming) {
const yieldDuration = endTime - startTime;
if (yieldDuration < 3) {
return;
}
const color =
yieldDuration < 5
? 'primary-light'
: yieldDuration < 10
? 'primary'
: yieldDuration < 100
? 'primary-dark'
: 'error';
console.timeStamp(
'Blocked',
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
color,
);
}
}
export function logSuspendedYieldTime(
startTime: number,
endTime: number,
suspendedFiber: Fiber,
): void {
if (supportsUserTiming) {
const debugTask = suspendedFiber._debugTask;
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
'Suspended',
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'primary-light',
),
);
} else {
console.timeStamp(
'Suspended',
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'primary-light',
);
}
}
}
export function logActionYieldTime(
startTime: number,
endTime: number,
suspendedFiber: Fiber,
): void {
if (supportsUserTiming) {
const debugTask = suspendedFiber._debugTask;
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
'Action',
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'primary-light',
),
);
} else {
console.timeStamp(
'Action',
startTime,
endTime,
COMPONENTS_TRACK,
undefined,
'primary-light',
);
}
}
}
export function logBlockingStart(
updateTime: number,
eventTime: number,
eventType: null | string,
eventIsRepeat: boolean,
isSpawnedUpdate: boolean,
renderStartTime: number,
lanes: Lanes,
debugTask: null | ConsoleTask,
): void {
if (supportsUserTiming) {
currentTrack = 'Blocking';
const eventEndTime = updateTime > 0 ? updateTime : renderStartTime;
if (eventTime > 0 && eventType !== null && eventEndTime > eventTime) {
const color = eventIsRepeat ? 'secondary-light' : 'warning';
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
eventIsRepeat ? '' : 'Event: ' + eventType,
eventTime,
eventEndTime,
currentTrack,
LANES_TRACK_GROUP,
color,
),
);
} else {
console.timeStamp(
eventIsRepeat ? '' : 'Event: ' + eventType,
eventTime,
eventEndTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
if (updateTime > 0 && renderStartTime > updateTime) {
const color = isSpawnedUpdate
? 'error'
: includesOnlyHydrationOrOffscreenLanes(lanes)
? 'tertiary-light'
: 'primary-light';
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
isSpawnedUpdate
? 'Cascading Update'
: renderStartTime - updateTime > 5
? 'Update Blocked'
: 'Update',
updateTime,
renderStartTime,
currentTrack,
LANES_TRACK_GROUP,
color,
),
);
} else {
console.timeStamp(
isSpawnedUpdate
? 'Cascading Update'
: renderStartTime - updateTime > 5
? 'Update Blocked'
: 'Update',
updateTime,
renderStartTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
}
}
export function logTransitionStart(
startTime: number,
updateTime: number,
eventTime: number,
eventType: null | string,
eventIsRepeat: boolean,
renderStartTime: number,
debugTask: null | ConsoleTask,
): void {
if (supportsUserTiming) {
currentTrack = 'Transition';
const eventEndTime =
startTime > 0 ? startTime : updateTime > 0 ? updateTime : renderStartTime;
if (eventTime > 0 && eventEndTime > eventTime && eventType !== null) {
const color = eventIsRepeat ? 'secondary-light' : 'warning';
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
eventIsRepeat ? '' : 'Event: ' + eventType,
eventTime,
eventEndTime,
currentTrack,
LANES_TRACK_GROUP,
color,
),
);
} else {
console.timeStamp(
eventIsRepeat ? '' : 'Event: ' + eventType,
eventTime,
eventEndTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
const startEndTime = updateTime > 0 ? updateTime : renderStartTime;
if (startTime > 0 && startEndTime > startTime) {
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
'Action',
startTime,
startEndTime,
currentTrack,
LANES_TRACK_GROUP,
'primary-dark',
),
);
} else {
console.timeStamp(
'Action',
startTime,
startEndTime,
currentTrack,
LANES_TRACK_GROUP,
'primary-dark',
);
}
}
if (updateTime > 0 && renderStartTime > updateTime) {
if (__DEV__ && debugTask) {
debugTask.run(
console.timeStamp.bind(
console,
renderStartTime - updateTime > 5 ? 'Update Blocked' : 'Update',
updateTime,
renderStartTime,
currentTrack,
LANES_TRACK_GROUP,
'primary-light',
),
);
} else {
console.timeStamp(
renderStartTime - updateTime > 5 ? 'Update Blocked' : 'Update',
updateTime,
renderStartTime,
currentTrack,
LANES_TRACK_GROUP,
'primary-light',
);
}
}
}
}
export function logRenderPhase(
startTime: number,
endTime: number,
lanes: Lanes,
): void {
if (supportsUserTiming) {
const color = includesOnlyHydrationOrOffscreenLanes(lanes)
? 'tertiary-dark'
: 'primary-dark';
console.timeStamp(
includesOnlyOffscreenLanes(lanes)
? 'Prepared'
: includesOnlyHydrationLanes(lanes)
? 'Hydrated'
: 'Render',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
export function logInterruptedRenderPhase(
startTime: number,
endTime: number,
lanes: Lanes,
): void {
if (supportsUserTiming) {
const color = includesOnlyHydrationOrOffscreenLanes(lanes)
? 'tertiary-dark'
: 'primary-dark';
console.timeStamp(
includesOnlyOffscreenLanes(lanes)
? 'Prewarm'
: includesOnlyHydrationLanes(lanes)
? 'Interrupted Hydration'
: 'Interrupted Render',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
export function logSuspendedRenderPhase(
startTime: number,
endTime: number,
lanes: Lanes,
): void {
if (supportsUserTiming) {
const color = includesOnlyHydrationOrOffscreenLanes(lanes)
? 'tertiary-dark'
: 'primary-dark';
console.timeStamp(
'Prewarm',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
export function logSuspendedWithDelayPhase(
startTime: number,
endTime: number,
lanes: Lanes,
): void {
if (supportsUserTiming) {
const color = includesOnlyHydrationOrOffscreenLanes(lanes)
? 'tertiary-dark'
: 'primary-dark';
console.timeStamp(
'Suspended',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
color,
);
}
}
export function logRecoveredRenderPhase(
startTime: number,
endTime: number,
lanes: Lanes,
recoverableErrors: Array<CapturedValue<mixed>>,
hydrationFailed: boolean,
): void {
if (supportsUserTiming) {
if (__DEV__) {
const properties: Array<[string, string]> = [];
for (let i = 0; i < recoverableErrors.length; i++) {
const capturedValue = recoverableErrors[i];
const error = capturedValue.value;
const message =
typeof error === 'object' &&
error !== null &&
typeof error.message === 'string'
?
String(error.message)
:
String(error);
properties.push(['Recoverable Error', message]);
}
performance.measure('Recovered', {
start: startTime,
end: endTime,
detail: {
devtools: {
color: 'primary-dark',
track: currentTrack,
trackGroup: LANES_TRACK_GROUP,
tooltipText: hydrationFailed
? 'Hydration Failed'
: 'Recovered after Error',
properties,
},
},
});
} else {
console.timeStamp(
'Recovered',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'error',
);
}
}
}
export function logErroredRenderPhase(
startTime: number,
endTime: number,
lanes: Lanes,
): void {
if (supportsUserTiming) {
console.timeStamp(
'Errored',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'error',
);
}
}
export function logInconsistentRender(
startTime: number,
endTime: number,
): void {
if (supportsUserTiming) {
console.timeStamp(
'Teared Render',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'error',
);
}
}
export function logSuspenseThrottlePhase(
startTime: number,
endTime: number,
): void {
if (supportsUserTiming) {
console.timeStamp(
'Throttled',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'secondary-light',
);
}
}
export function logSuspendedCommitPhase(
startTime: number,
endTime: number,
): void {
if (supportsUserTiming) {
console.timeStamp(
'Suspended on CSS or Images',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'secondary-light',
);
}
}
export function logCommitErrored(
startTime: number,
endTime: number,
errors: Array<CapturedValue<mixed>>,
passive: boolean,
): void {
if (supportsUserTiming) {
if (__DEV__) {
const properties: Array<[string, string]> = [];
for (let i = 0; i < errors.length; i++) {
const capturedValue = errors[i];
const error = capturedValue.value;
const message =
typeof error === 'object' &&
error !== null &&
typeof error.message === 'string'
?
String(error.message)
:
String(error);
properties.push(['Error', message]);
}
performance.measure('Errored', {
start: startTime,
end: endTime,
detail: {
devtools: {
color: 'error',
track: currentTrack,
trackGroup: LANES_TRACK_GROUP,
tooltipText: passive
? 'Remaining Effects Errored'
: 'Commit Errored',
properties,
},
},
});
} else {
console.timeStamp(
'Errored',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'error',
);
}
}
}
export function logCommitPhase(
startTime: number,
endTime: number,
errors: null | Array<CapturedValue<mixed>>,
): void {
if (errors !== null) {
logCommitErrored(startTime, endTime, errors, false);
return;
}
if (supportsUserTiming) {
console.timeStamp(
'Commit',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'secondary-dark',
);
}
}
export function logPaintYieldPhase(
startTime: number,
endTime: number,
delayedUntilPaint: boolean,
): void {
if (supportsUserTiming) {
console.timeStamp(
delayedUntilPaint ? 'Waiting for Paint' : '',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'secondary-light',
);
}
}
export function logPassiveCommitPhase(
startTime: number,
endTime: number,
errors: null | Array<CapturedValue<mixed>>,
): void {
if (errors !== null) {
logCommitErrored(startTime, endTime, errors, true);
return;
}
if (supportsUserTiming) {
console.timeStamp(
'Remaining Effects',
startTime,
endTime,
currentTrack,
LANES_TRACK_GROUP,
'secondary-dark',
);
}
}