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.

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

Jump to bottom

Use SyncLane for discrete event hydration #21038

Merged
merged 1 commit into from
Mar 22, 2021
Merged

Use SyncLane for discrete event hydration #21038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
119 changes: 63 additions & 56 deletions packages/react-dom/src/__tests__/ReactDOMServerPartialHydration-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2187,17 +2187,17 @@ describe('ReactDOMServerPartialHydration', () => {
expect(container.textContent).toBe('Click meHello');

// We're now partially hydrated.
a.click();
await act(async () => {
a.click();
});
expect(clicks).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();

await act(async () => {
suspend = false;
resolve();
await promise;
});
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to update these tests because sync work is scheduled with a microtask.

expect(clicks).toBe(1);

expect(container.textContent).toBe('Hello');
Expand Down Expand Up @@ -2270,18 +2270,19 @@ describe('ReactDOMServerPartialHydration', () => {
jest.runAllTimers();

// We're now partially hydrated.
a.click();
await act(async () => {
a.click();
});
// We should not have invoked the event yet because we're not
// yet hydrated.
expect(onEvent).toHaveBeenCalledTimes(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();
await act(async () => {
suspend = false;
resolve();
await promise;
});

expect(onEvent).toHaveBeenCalledTimes(2);

Expand Down Expand Up @@ -2344,25 +2345,27 @@ describe('ReactDOMServerPartialHydration', () => {
root.render(<App />);

// We'll do one click before hydrating.
a.click();
await act(async () => {
a.click();
});
// This should be delayed.
expect(clicks).toBe(0);

Scheduler.unstable_flushAll();
jest.runAllTimers();

// We're now partially hydrated.
a.click();
await act(async () => {
a.click();
});
expect(clicks).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();

await act(async () => {
suspend = false;
resolve();
await promise;
});
expect(clicks).toBe(2);

document.body.removeChild(container);
Expand Down Expand Up @@ -2436,19 +2439,19 @@ describe('ReactDOMServerPartialHydration', () => {
jest.runAllTimers();

// We're now partially hydrated.
a.click();
await act(async () => {
a.click();
});
// We should not have invoked the event yet because we're not
// yet hydrated.
expect(onEvent).toHaveBeenCalledTimes(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();

await act(async () => {
suspend = false;
resolve();
await promise;
});
expect(onEvent).toHaveBeenCalledTimes(2);

document.body.removeChild(container);
Expand Down Expand Up @@ -2510,17 +2513,18 @@ describe('ReactDOMServerPartialHydration', () => {
jest.runAllTimers();

// We're now partially hydrated.
span.click();
await act(async () => {
span.click();
});
expect(clicksOnChild).toBe(0);
expect(clicksOnParent).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();
await act(async () => {
suspend = false;
resolve();
await promise;
});

expect(clicksOnChild).toBe(1);
// This will be zero due to the stopPropagation.
Expand Down Expand Up @@ -2589,16 +2593,17 @@ describe('ReactDOMServerPartialHydration', () => {
Scheduler.unstable_flushAll();

// The Suspense boundary is not yet hydrated.
a.click();
await act(async () => {
a.click();
});
expect(clicks).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();
await act(async () => {
suspend = false;
resolve();
await promise;
});

// We're now full hydrated.

Expand Down Expand Up @@ -2858,20 +2863,22 @@ describe('ReactDOMServerPartialHydration', () => {
expect(container.textContent).toBe('Click meHello');

// We're now partially hydrated.
form.dispatchEvent(
new Event('submit', {
bubbles: true,
}),
);
await act(async () => {
form.dispatchEvent(
new Event('submit', {
bubbles: true,
}),
);
});
expect(submits).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;
await act(async () => {
suspend = false;
resolve();
await promise;
});

Scheduler.unstable_flushAll();
jest.runAllTimers();
expect(submits).toBe(1);
expect(container.textContent).toBe('Hello');
document.body.removeChild(container);
Expand Down
81 changes: 45 additions & 36 deletions packages/react-dom/src/__tests__/ReactDOMServerSelectiveHydration-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,22 +255,25 @@ describe('ReactDOMServerSelectiveHydration', () => {
expect(Scheduler).toHaveYielded([]);

// This click target cannot be hydrated yet because it's suspended.
const result = dispatchClickEvent(spanD);

expect(Scheduler).toHaveYielded(['App']);

expect(result).toBe(true);

// Continuing rendering will render B next.
expect(Scheduler).toFlushAndYield(['B', 'C']);

suspend = false;
resolve();
await promise;
await act(async () => {
const result = dispatchClickEvent(spanD);
expect(result).toBe(true);
});
expect(Scheduler).toHaveYielded([
'App',
// Continuing rendering will render B next.
'B',
'C',
]);

await act(async () => {
suspend = false;
resolve();
await promise;
});
// After the click, we should prioritize D and the Click first,
// and only after that render A and C.
expect(Scheduler).toFlushAndYield(['D', 'Clicked D', 'A']);
expect(Scheduler).toHaveYielded(['D', 'Clicked D', 'A']);

document.body.removeChild(container);
});
Expand Down Expand Up @@ -348,13 +351,15 @@ describe('ReactDOMServerSelectiveHydration', () => {

expect(Scheduler).toHaveYielded(['App']);

suspend = false;
resolve();
await promise;
await act(async () => {
suspend = false;
resolve();
await promise;
});

// We should prioritize hydrating A, C and D first since we clicked in
// them. Only after they're done will we hydrate B.
expect(Scheduler).toFlushAndYield([
expect(Scheduler).toHaveYielded([
'A',
'Clicked A',
'C',
Expand Down Expand Up @@ -506,21 +511,21 @@ describe('ReactDOMServerSelectiveHydration', () => {
// Nothing has been hydrated so far.
expect(Scheduler).toHaveYielded([]);

const target = createEventTarget(spanD);
target.virtualclick();

expect(Scheduler).toHaveYielded(['App']);

// Continuing rendering will render B next.
expect(Scheduler).toFlushAndYield(['B', 'C']);

suspend = false;
resolve();
await promise;
await act(async () => {
const target = createEventTarget(spanD);
target.virtualclick();
});
expect(Scheduler).toHaveYielded(['App', 'B', 'C']);

// After the click, we should prioritize D and the Click first,
// and only after that render A and C.
expect(Scheduler).toFlushAndYield(['D', 'Clicked D', 'A']);
await act(async () => {
suspend = false;
resolve();
await promise;
});
expect(Scheduler).toHaveYielded(['D', 'Clicked D', 'A']);

document.body.removeChild(container);
});
Expand Down Expand Up @@ -602,13 +607,15 @@ describe('ReactDOMServerSelectiveHydration', () => {

expect(Scheduler).toHaveYielded(['App']);

suspend = false;
resolve();
await promise;
await act(async () => {
suspend = false;
resolve();
await promise;
});

// We should prioritize hydrating A, C and D first since we clicked in
// them. Only after they're done will we hydrate B.
expect(Scheduler).toFlushAndYield([
expect(Scheduler).toHaveYielded([
'A',
'Clicked A',
'C',
Expand Down Expand Up @@ -701,17 +708,19 @@ describe('ReactDOMServerSelectiveHydration', () => {

expect(Scheduler).toHaveYielded(['App']);

suspend = false;
resolve();
await promise;
await act(async () => {
suspend = false;
resolve();
await promise;
});

// We should prioritize hydrating D first because we clicked it.
// Next we should hydrate C since that's the current hover target.
// To simplify implementation details we hydrate both B and C at
// the same time since B was already scheduled.
// This is ok because it will at least not continue for nested
// boundary. See the next test below.
expect(Scheduler).toFlushAndYield([
expect(Scheduler).toHaveYielded([
'D',
'Clicked D',
'B', // Ideally this should be later.
Expand Down
16 changes: 9 additions & 7 deletions packages/react-dom/src/events/__tests__/DOMPluginEventSystem-test.internal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ describe('DOMPluginEventSystem', () => {
ReactDOM = require('react-dom');
Scheduler = require('scheduler');
ReactDOMServer = require('react-dom/server');
act = require('react-dom/test-utils').unstable_concurrentAct;
container = document.createElement('div');
document.body.appendChild(container);
startNativeEventListenerClearDown();
Expand Down Expand Up @@ -636,16 +637,17 @@ describe('DOMPluginEventSystem', () => {
Scheduler.unstable_flushAll();

// The Suspense boundary is not yet hydrated.
a.click();
await act(async () => {
a.click();
});
expect(clicks).toBe(0);

// Resolving the promise so that rendering can complete.
suspend = false;
resolve();
await promise;

Scheduler.unstable_flushAll();
jest.runAllTimers();
await act(async () => {
suspend = false;
resolve();
await promise;
});

// We're now full hydrated.

Expand Down
5 changes: 2 additions & 3 deletions packages/react-reconciler/src/ReactFiberReconciler.new.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ import {
import {StrictLegacyMode} from './ReactTypeOfMode';
import {
SyncLane,
InputDiscreteHydrationLane,
SelectiveHydrationLane,
NoTimestamp,
getHighestPriorityPendingLanes,
Expand Down Expand Up @@ -388,7 +387,7 @@ export function attemptSynchronousHydration(fiber: Fiber): void {
// If we're still blocked after this, we need to increase
// the priority of any promises resolving within this
// boundary so that they next attempt also has higher pri.
const retryLane = InputDiscreteHydrationLane;
const retryLane = SyncLane;
markRetryLaneIfNotHydrated(fiber, retryLane);
break;
}
Expand Down Expand Up @@ -422,7 +421,7 @@ export function attemptDiscreteHydration(fiber: Fiber): void {
return;
}
const eventTime = requestEventTime();
const lane = InputDiscreteHydrationLane;
const lane = SyncLane;
scheduleUpdateOnFiber(fiber, lane, eventTime);
markRetryLaneIfNotHydrated(fiber, lane);
}
Expand Down
Loading