Skip to content

Commit

Permalink
[Flight Reply] Reject any new Chunks not yet discovered at the time o…
Browse files Browse the repository at this point in the history
…f reportGlobalError (facebook#31840)

We might have already resolved models that are not pending and so are
not rejected by aborting the stream. When those later get parsed they
might discover new chunks which end up as pending. These should be
errored since they will never be able to resolve later.

This avoids infinitely hanging the stream.

This same fix needs to be ported to ReactFlightClient that has the same
issue.
  • Loading branch information
sebmarkbage authored and gnoff committed Dec 20, 2024
1 parent d900fad commit 6d6f6d8
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions packages/react-server/src/ReactFlightReplyServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ export type Response = {
_formData: FormData,
_chunks: Map<number, SomeChunk<any>>,
_fromJSON: (key: string, value: JSONValue) => any,
_closed: boolean,
_closedReason: mixed,
};

export function getRoot<T>(response: Response): Thenable<T> {
Expand Down Expand Up @@ -198,6 +200,14 @@ function createResolvedModelChunk<T>(
return new Chunk(RESOLVED_MODEL, value, null, response);
}

function createErroredChunk<T>(
response: Response,
reason: mixed,
): ErroredChunk<T> {
// $FlowFixMe[invalid-constructor] Flow doesn't support functions as constructors
return new Chunk(ERRORED, null, reason, response);
}

function resolveModelChunk<T>(chunk: SomeChunk<T>, value: string): void {
if (chunk.status !== PENDING) {
// We already resolved. We didn't expect to see this.
Expand Down Expand Up @@ -297,6 +307,8 @@ function initializeModelChunk<T>(chunk: ResolvedModelChunk<T>): void {
// Report that any missing chunks in the model is now going to throw this
// error upon read. Also notify any pending promises.
export function reportGlobalError(response: Response, error: Error): void {
response._closed = true;
response._closedReason = error;
response._chunks.forEach(chunk => {
// If this chunk was already resolved or errored, it won't
// trigger an error but if it wasn't then we need to
Expand All @@ -318,6 +330,10 @@ function getChunk(response: Response, id: number): SomeChunk<any> {
if (backingEntry != null) {
// We assume that this is a string entry for now.
chunk = createResolvedModelChunk(response, (backingEntry: any));
} else if (response._closed) {
// We have already errored the response and we're not going to get
// anything more streaming in so this will immediately error.
chunk = createErroredChunk(response, response._closedReason);
} else {
// We're still waiting on this entry to stream in.
chunk = createPendingChunk(response);
Expand Down Expand Up @@ -519,6 +535,8 @@ export function createResponse(
}
return value;
},
_closed: false,
_closedReason: null,
};
return response;
}
Expand Down

0 comments on commit 6d6f6d8

Please sign in to comment.