Skip to content
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.

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

Scheduling Profiler does not warn about long transitions #22614

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -1581,6 +1581,143 @@ describe('preprocessData', () => {
);
}
});

it('should not warn about transition updates scheduled during commit phase', async () => {
function Component() {
const [value, setValue] = React.useState(0);
// eslint-disable-next-line no-unused-vars
const [isPending, startTransition] = React.useTransition();

Scheduler.unstable_yieldValue(
`Component rendered with value ${value}`,
);

// Fake a long render
if (value !== 0) {
Scheduler.unstable_yieldValue('Long render');
startTime += 20000;
}

React.useLayoutEffect(() => {
startTransition(() => {
setValue(1);
});
}, []);

return value;
}

if (gate(flags => flags.enableSchedulingProfiler)) {
const cpuProfilerSample = creactCpuProfilerSample();

const root = ReactDOM.createRoot(document.createElement('div'));
act(() => {
root.render(<Component />);
});

expect(Scheduler).toHaveYielded([
'Component rendered with value 0',
'Component rendered with value 0',
'Component rendered with value 1',
'Long render',
]);

const testMarks = [];
clearedMarks.forEach(markName => {
if (markName === '--component-render-start-Component') {
// Fake a long running render
startTime += 20000;
}

testMarks.push({
pid: ++pid,
tid: ++tid,
ts: ++startTime,
args: {data: {}},
cat: 'blink.user_timing',
name: markName,
ph: 'R',
});
});

const data = await preprocessData([
cpuProfilerSample,
...createBoilerplateEntries(),
...testMarks,
]);

data.schedulingEvents.forEach(event => {
expect(event.warning).toBeNull();
});
}
});

it('should not warn about deferred value updates scheduled during commit phase', async () => {
function Component() {
const [value, setValue] = React.useState(0);
const deferredValue = React.useDeferredValue(value);
bvaughn marked this conversation as resolved.
Show resolved Hide resolved

Scheduler.unstable_yieldValue(
`Component rendered with value ${value} and deferredValue ${deferredValue}`,
);

// Fake a long render
if (deferredValue !== 0) {
Scheduler.unstable_yieldValue('Long render');
startTime += 20000;
}

React.useLayoutEffect(() => {
setValue(1);
}, []);

return value + deferredValue;
}

if (gate(flags => flags.enableSchedulingProfiler)) {
const cpuProfilerSample = creactCpuProfilerSample();

const root = ReactDOM.createRoot(document.createElement('div'));
act(() => {
root.render(<Component />);
});

expect(Scheduler).toHaveYielded([
'Component rendered with value 0 and deferredValue 0',
'Component rendered with value 1 and deferredValue 0',
'Component rendered with value 1 and deferredValue 1',
'Long render',
]);

const testMarks = [];
clearedMarks.forEach(markName => {
if (markName === '--component-render-start-Component') {
// Fake a long running render
startTime += 20000;
}

testMarks.push({
pid: ++pid,
tid: ++tid,
ts: ++startTime,
args: {data: {}},
cat: 'blink.user_timing',
name: markName,
ph: 'R',
});
});

const data = await preprocessData([
cpuProfilerSample,
...createBoilerplateEntries(),
...testMarks,
]);

data.schedulingEvents.forEach(event => {
expect(event.warning).toBeNull();
});
}
});
});

describe('errors thrown while rendering', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -970,7 +970,16 @@ export default async function preprocessData(
// See how long the subsequent batch of React work was.
const [startTime, stopTime] = getBatchRange(batchUID, profilerData);
if (stopTime - startTime > NESTED_UPDATE_DURATION_THRESHOLD) {
schedulingEvent.warning = WARNING_STRINGS.NESTED_UPDATE;
// Don't warn about transition updates scheduled during the commit phase.
// e.g. useTransition, useDeferredValue
// These are allowed to be long-running.
if (
!schedulingEvent.lanes.some(
lane => profilerData.laneToLabelMap.get(lane) === 'Transition',
)
) {
schedulingEvent.warning = WARNING_STRINGS.NESTED_UPDATE;
}
}
});
state.potentialSuspenseEventsOutsideOfTransition.forEach(
Expand Down