Skip to content

Commit

Permalink
[Flight] Start initial work immediately
Browse files Browse the repository at this point in the history
In a past update we made render and prerender have different work scheduling behavior because these methods are meant to be used in differeent environments with different performance tradeoffs in mind. For instance to prioritize streaming we want to allow as much IO to complete before triggering a round of work because we want to flush as few intermediate UI states. With Prerendering there will never be any intermediate UI states so we can more aggressively render tasks as they complete.

One thing we've found is that even during render we should ideally kick off work immediately. This update normalizes the intitial work for render and prerender to start in a microtask. Choosing microtask over sync is somewhat arbitrary but there really isn't a reason to make them different between render/prerender so for now we'll unify them and keep it as a microtask for now.

This change also updates pinging behavior. If the request is still in the initial task that spawned it then pings will schedule on the microtask queue. This allows immediately available async APIs to resolve right away. The concern with doing this for normal pings is that it might crowd out IO events but since this is the initial task there would be IO to already be scheduled.
  • Loading branch information
gnoff committed Sep 13, 2024
1 parent 6774caa commit ec9a2f8
Showing 1 changed file with 24 additions and 25 deletions.
49 changes: 24 additions & 25 deletions packages/react-server/src/ReactFlightServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,17 @@ type Task = {

interface Reference {}

const OPENING = 10;
const OPEN = 11;
const ABORTING = 12;
const CLOSING = 13;
const CLOSED = 14;

const RENDER = 20;
const PRERENDER = 21;

export type Request = {
status: 10 | 11 | 12 | 13,
status: 10 | 11 | 12 | 13 | 14,
type: 20 | 21,
flushScheduled: boolean,
fatalError: mixed,
Expand Down Expand Up @@ -426,14 +435,6 @@ function defaultPostponeHandler(reason: string) {
// Noop
}

const OPEN = 10;
const ABORTING = 11;
const CLOSING = 12;
const CLOSED = 13;

const RENDER = 20;
const PRERENDER = 21;

function RequestInstance(
this: $FlowFixMe,
type: 20 | 21,
Expand Down Expand Up @@ -472,7 +473,7 @@ function RequestInstance(
}
const hints = createHints();
this.type = type;
this.status = OPEN;
this.status = OPENING;
this.flushScheduled = false;
this.fatalError = null;
this.destination = null;
Expand Down Expand Up @@ -1794,7 +1795,7 @@ function pingTask(request: Request, task: Task): void {
pingedTasks.push(task);
if (pingedTasks.length === 1) {
request.flushScheduled = request.destination !== null;
if (request.type === PRERENDER) {
if (request.type === PRERENDER || request.status === OPENING) {
scheduleMicrotask(() => performWork(request));
} else {
scheduleWork(() => performWork(request));
Expand Down Expand Up @@ -4062,21 +4063,18 @@ function flushCompletedChunks(

export function startWork(request: Request): void {
request.flushScheduled = request.destination !== null;
if (request.type === PRERENDER) {
if (supportsRequestStorage) {
scheduleMicrotask(() => {
requestStorage.run(request, performWork, request);
});
} else {
scheduleMicrotask(() => performWork(request));
}
if (supportsRequestStorage) {
scheduleMicrotask(() => {
requestStorage.run(request, performWork, request);
});
} else {
if (supportsRequestStorage) {
scheduleWork(() => requestStorage.run(request, performWork, request));
} else {
scheduleWork(() => performWork(request));
}
scheduleMicrotask(() => performWork(request));
}
scheduleWork(() => {
if (request.status === OPENING) {
request.status = OPEN;
}
});
}

function enqueueFlush(request: Request): void {
Expand Down Expand Up @@ -4129,7 +4127,8 @@ export function stopFlowing(request: Request): void {

export function abort(request: Request, reason: mixed): void {
try {
if (request.status === OPEN) {
// We define any status below OPEN as OPEN equivalent
if (request.status <= OPEN) {
request.status = ABORTING;
}
const abortableTasks = request.abortableTasks;
Expand Down

0 comments on commit ec9a2f8

Please sign in to comment.