Skip to content

Add a progressiveChunkSize option for Flight rendering #35089

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+58 −5
Open

Add a progressiveChunkSize option for Flight rendering #35089

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
1 change: 1 addition & 0 deletions packages/react-markup/src/ReactMarkupServer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ export function experimental_renderToHTML(
handleFlightError,
options ? options.identifierPrefix : undefined,
undefined,
undefined,
'Markup',
undefined,
false,
Expand Down
2 changes: 2 additions & 0 deletions packages/react-noop-renderer/src/ReactNoopFlightServer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ type Options = {
environmentName?: string | (() => string),
filterStackFrame?: (url: string, functionName: string) => boolean,
identifierPrefix?: string,
progressiveChunkSize?: number,
signal?: AbortSignal,
debugChannel?: {onMessage?: (message: string) => void},
onError?: (error: mixed) => void,
Expand All @@ -84,6 +85,7 @@ function render(model: ReactClientValue, options?: Options): Destination {
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
__DEV__ && options && options.debugChannel !== undefined,
Expand Down
4 changes: 4 additions & 0 deletions packages/react-server-dom-esm/src/server/ReactFlightDOMServerNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ type Options = {
onError?: (error: mixed) => void,
identifierPrefix?: string,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
};

type PipeableStream = {
Expand Down Expand Up @@ -183,6 +184,7 @@ function renderToPipeableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannel !== undefined,
Expand Down Expand Up @@ -271,6 +273,7 @@ type PrerenderOptions = {
onError?: (error: mixed) => void,
identifierPrefix?: string,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
signal?: AbortSignal,
};

Expand Down Expand Up @@ -303,6 +306,7 @@ function prerenderToNodeStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-parcel/src/server/ReactFlightDOMServerBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -128,6 +129,7 @@ export function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -215,6 +217,7 @@ export function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-parcel/src/server/ReactFlightDOMServerEdge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -133,6 +134,7 @@ export function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -220,6 +222,7 @@ export function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
5 changes: 5 additions & 0 deletions packages/react-server-dom-parcel/src/server/ReactFlightDOMServerNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ type Options = {
onError?: (error: mixed) => void,
identifierPrefix?: string,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
};

type PipeableStream = {
Expand Down Expand Up @@ -195,6 +196,7 @@ export function renderToPipeableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannel !== undefined,
Expand Down Expand Up @@ -352,6 +354,7 @@ export function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -464,6 +467,7 @@ export function prerenderToNodeStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down Expand Up @@ -526,6 +530,7 @@ export function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -126,6 +127,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -214,6 +216,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerEdge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -131,6 +132,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -219,6 +221,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
5 changes: 5 additions & 0 deletions packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ type Options = {
onError?: (error: mixed) => void,
identifierPrefix?: string,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
};

type PipeableStream = {
Expand Down Expand Up @@ -189,6 +190,7 @@ function renderToPipeableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannel !== undefined,
Expand Down Expand Up @@ -347,6 +349,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -460,6 +463,7 @@ function prerenderToNodeStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down Expand Up @@ -523,6 +527,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
4 changes: 2 additions & 2 deletions packages/react-server-dom-webpack/src/__tests__/ReactFlightDOMEdge-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ describe('ReactFlightDOMEdge', () => {
const [stream2, drip] = dripStream(stream);

// Allow some of the content through.
drip(__DEV__ ? 7500 : 5000);
drip(__DEV__ ? 17500 : 15000);

const result = await ReactServerDOMClient.createFromReadableStream(
stream2,
Expand Down Expand Up @@ -728,7 +728,7 @@ describe('ReactFlightDOMEdge', () => {
});

it('regression: should not leak serialized size', async () => {
const MAX_ROW_SIZE = 3200;
const MAX_ROW_SIZE = 12800;
// This test case is a bit convoluted and may no longer trigger the original bug.
// Originally, the size of `promisedText` was not cleaned up so the sync portion
// ended up being deferred immediately when we called `renderToReadableStream` again
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-webpack/src/server/ReactFlightDOMServerBrowser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -126,6 +127,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -214,6 +216,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
3 changes: 3 additions & 0 deletions packages/react-server-dom-webpack/src/server/ReactFlightDOMServerEdge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ type Options = {
identifierPrefix?: string,
signal?: AbortSignal,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
onError?: (error: mixed) => void,
};

Expand Down Expand Up @@ -131,6 +132,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -219,6 +221,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
5 changes: 5 additions & 0 deletions packages/react-server-dom-webpack/src/server/ReactFlightDOMServerNode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ type Options = {
onError?: (error: mixed) => void,
identifierPrefix?: string,
temporaryReferences?: TemporaryReferenceSet,
progressiveChunkSize?: number,
};

type PipeableStream = {
Expand Down Expand Up @@ -189,6 +190,7 @@ function renderToPipeableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -347,6 +349,7 @@ function renderToReadableStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
debugChannelReadable !== undefined,
Expand Down Expand Up @@ -460,6 +463,7 @@ function prerenderToNodeStream(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down Expand Up @@ -523,6 +527,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
false,
Expand Down
2 changes: 2 additions & 0 deletions packages/react-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ function render(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
);
Expand Down Expand Up @@ -214,6 +215,7 @@ function prerender(
options ? options.onError : undefined,
options ? options.identifierPrefix : undefined,
options ? options.temporaryReferences : undefined,
options ? options.progressiveChunkSize : undefined,
__DEV__ && options ? options.environmentName : undefined,
__DEV__ && options ? options.filterStackFrame : undefined,
);
Expand Down
Loading