Skip to content

Commit b1533b0

Browse files
lubieowocelubieowoce
authored
[Flight] Allow overriding request.timeOrigin via options.startTime (#35598)
Currently, IO that finished before the request started is not considered IO: https://github.com/facebook/react/blob/6a0ab4d2dd62dfdf8881ba1c3443c6d5acedc871/packages/react-server/src/ReactFlightServer.js#L5338-L5343 This leads to loss of debug info when a flight stream is deserialized and serialized again. We can solve this by allowing "when the the request started" to be set to a point in the past, when the original stream started by doing ```js const startTime = performance.now() + performance.timeOrigin // ... stuff happens and time passes... ReactServer.renderToReadableStream(..., { startTime }) ```
1 parent 5dad2b4 commit b1533b0

File tree

15 files changed

+356
-2
lines changed

15 files changed

+356
-2
lines changed

‎packages/react-markup/src/ReactMarkupServer.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ export function experimental_renderToHTML(
184184
handleFlightError,
185185
options ? options.identifierPrefix : undefined,
186186
undefined,
187+
undefined,
187188
'Markup',
188189
undefined,
189190
false,

‎packages/react-noop-renderer/src/ReactNoopFlightServer.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ type Options = {
7373
signal?: AbortSignal,
7474
debugChannel?: {onMessage?: (message: string) => void},
7575
onError?: (error: mixed) => void,
76+
startTime?: number,
7677
};
7778

7879
function render(model: ReactClientValue, options?: Options): Destination {
@@ -84,6 +85,7 @@ function render(model: ReactClientValue, options?: Options): Destination {
8485
options ? options.onError : undefined,
8586
options ? options.identifierPrefix : undefined,
8687
undefined,
88+
options ? options.startTime : undefined,
8789
__DEV__ && options ? options.environmentName : undefined,
8890
__DEV__ && options ? options.filterStackFrame : undefined,
8991
__DEV__ && options && options.debugChannel !== undefined,

‎packages/react-server-dom-esm/src/server/ReactFlightDOMServerNode.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ type Options = {
146146
onError?: (error: mixed) => void,
147147
identifierPrefix?: string,
148148
temporaryReferences?: TemporaryReferenceSet,
149+
startTime?: number,
149150
};
150151

151152
type PipeableStream = {
@@ -183,6 +184,7 @@ function renderToPipeableStream(
183184
options ? options.onError : undefined,
184185
options ? options.identifierPrefix : undefined,
185186
options ? options.temporaryReferences : undefined,
187+
options ? options.startTime : undefined,
186188
__DEV__ && options ? options.environmentName : undefined,
187189
__DEV__ && options ? options.filterStackFrame : undefined,
188190
debugChannel !== undefined,
@@ -272,6 +274,7 @@ type PrerenderOptions = {
272274
identifierPrefix?: string,
273275
temporaryReferences?: TemporaryReferenceSet,
274276
signal?: AbortSignal,
277+
startTime?: number,
275278
};
276279

277280
type StaticResult = {
@@ -303,6 +306,7 @@ function prerenderToNodeStream(
303306
options ? options.onError : undefined,
304307
options ? options.identifierPrefix : undefined,
305308
options ? options.temporaryReferences : undefined,
309+
options ? options.startTime : undefined,
306310
__DEV__ && options ? options.environmentName : undefined,
307311
__DEV__ && options ? options.filterStackFrame : undefined,
308312
false,

‎packages/react-server-dom-parcel/src/server/ReactFlightDOMServerBrowser.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import type {
1212
ReactClientValue,
1313
} from 'react-server/src/ReactFlightServer';
1414
import type {ReactFormState, Thenable} from 'shared/ReactTypes';
15+
1516
import {
1617
preloadModule,
1718
requireModule,
@@ -67,6 +68,7 @@ type Options = {
6768
signal?: AbortSignal,
6869
temporaryReferences?: TemporaryReferenceSet,
6970
onError?: (error: mixed) => void,
71+
startTime?: number,
7072
};
7173

7274
function startReadingFromDebugChannelReadableStream(
@@ -128,6 +130,7 @@ export function renderToReadableStream(
128130
options ? options.onError : undefined,
129131
options ? options.identifierPrefix : undefined,
130132
options ? options.temporaryReferences : undefined,
133+
options ? options.startTime : undefined,
131134
__DEV__ && options ? options.environmentName : undefined,
132135
__DEV__ && options ? options.filterStackFrame : undefined,
133136
debugChannelReadable !== undefined,
@@ -215,6 +218,7 @@ export function prerender(
215218
options ? options.onError : undefined,
216219
options ? options.identifierPrefix : undefined,
217220
options ? options.temporaryReferences : undefined,
221+
options ? options.startTime : undefined,
218222
__DEV__ && options ? options.environmentName : undefined,
219223
__DEV__ && options ? options.filterStackFrame : undefined,
220224
false,

‎packages/react-server-dom-parcel/src/server/ReactFlightDOMServerEdge.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import type {
1212
ReactClientValue,
1313
} from 'react-server/src/ReactFlightServer';
1414
import type {ReactFormState, Thenable} from 'shared/ReactTypes';
15+
1516
import {
1617
preloadModule,
1718
requireModule,
@@ -72,6 +73,7 @@ type Options = {
7273
signal?: AbortSignal,
7374
temporaryReferences?: TemporaryReferenceSet,
7475
onError?: (error: mixed) => void,
76+
startTime?: number,
7577
};
7678

7779
function startReadingFromDebugChannelReadableStream(
@@ -133,6 +135,7 @@ export function renderToReadableStream(
133135
options ? options.onError : undefined,
134136
options ? options.identifierPrefix : undefined,
135137
options ? options.temporaryReferences : undefined,
138+
options ? options.startTime : undefined,
136139
__DEV__ && options ? options.environmentName : undefined,
137140
__DEV__ && options ? options.filterStackFrame : undefined,
138141
debugChannelReadable !== undefined,
@@ -220,6 +223,7 @@ export function prerender(
220223
options ? options.onError : undefined,
221224
options ? options.identifierPrefix : undefined,
222225
options ? options.temporaryReferences : undefined,
226+
options ? options.startTime : undefined,
223227
__DEV__ && options ? options.environmentName : undefined,
224228
__DEV__ && options ? options.filterStackFrame : undefined,
225229
false,

‎packages/react-server-dom-parcel/src/server/ReactFlightDOMServerNode.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ type Options = {
159159
onError?: (error: mixed) => void,
160160
identifierPrefix?: string,
161161
temporaryReferences?: TemporaryReferenceSet,
162+
startTime?: number,
162163
};
163164

164165
type PipeableStream = {
@@ -195,6 +196,7 @@ export function renderToPipeableStream(
195196
options ? options.onError : undefined,
196197
options ? options.identifierPrefix : undefined,
197198
options ? options.temporaryReferences : undefined,
199+
options ? options.startTime : undefined,
198200
__DEV__ && options ? options.environmentName : undefined,
199201
__DEV__ && options ? options.filterStackFrame : undefined,
200202
debugChannel !== undefined,
@@ -352,6 +354,7 @@ export function renderToReadableStream(
352354
options ? options.onError : undefined,
353355
options ? options.identifierPrefix : undefined,
354356
options ? options.temporaryReferences : undefined,
357+
options ? options.startTime : undefined,
355358
__DEV__ && options ? options.environmentName : undefined,
356359
__DEV__ && options ? options.filterStackFrame : undefined,
357360
debugChannelReadable !== undefined,
@@ -434,6 +437,7 @@ type PrerenderOptions = {
434437
identifierPrefix?: string,
435438
temporaryReferences?: TemporaryReferenceSet,
436439
signal?: AbortSignal,
440+
startTime?: number,
437441
};
438442

439443
type StaticResult = {
@@ -464,6 +468,7 @@ export function prerenderToNodeStream(
464468
options ? options.onError : undefined,
465469
options ? options.identifierPrefix : undefined,
466470
options ? options.temporaryReferences : undefined,
471+
options ? options.startTime : undefined,
467472
__DEV__ && options ? options.environmentName : undefined,
468473
__DEV__ && options ? options.filterStackFrame : undefined,
469474
false,
@@ -526,6 +531,7 @@ export function prerender(
526531
options ? options.onError : undefined,
527532
options ? options.identifierPrefix : undefined,
528533
options ? options.temporaryReferences : undefined,
534+
options ? options.startTime : undefined,
529535
__DEV__ && options ? options.environmentName : undefined,
530536
__DEV__ && options ? options.filterStackFrame : undefined,
531537
false,

‎packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerBrowser.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ type Options = {
6464
signal?: AbortSignal,
6565
temporaryReferences?: TemporaryReferenceSet,
6666
onError?: (error: mixed) => void,
67+
startTime?: number,
6768
};
6869

6970
function startReadingFromDebugChannelReadableStream(
@@ -126,6 +127,7 @@ function renderToReadableStream(
126127
options ? options.onError : undefined,
127128
options ? options.identifierPrefix : undefined,
128129
options ? options.temporaryReferences : undefined,
130+
options ? options.startTime : undefined,
129131
__DEV__ && options ? options.environmentName : undefined,
130132
__DEV__ && options ? options.filterStackFrame : undefined,
131133
debugChannelReadable !== undefined,
@@ -214,6 +216,7 @@ function prerender(
214216
options ? options.onError : undefined,
215217
options ? options.identifierPrefix : undefined,
216218
options ? options.temporaryReferences : undefined,
219+
options ? options.startTime : undefined,
217220
__DEV__ && options ? options.environmentName : undefined,
218221
__DEV__ && options ? options.filterStackFrame : undefined,
219222
false,

‎packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerEdge.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ type Options = {
6969
signal?: AbortSignal,
7070
temporaryReferences?: TemporaryReferenceSet,
7171
onError?: (error: mixed) => void,
72+
startTime?: number,
7273
};
7374

7475
function startReadingFromDebugChannelReadableStream(
@@ -131,6 +132,7 @@ function renderToReadableStream(
131132
options ? options.onError : undefined,
132133
options ? options.identifierPrefix : undefined,
133134
options ? options.temporaryReferences : undefined,
135+
options ? options.startTime : undefined,
134136
__DEV__ && options ? options.environmentName : undefined,
135137
__DEV__ && options ? options.filterStackFrame : undefined,
136138
debugChannelReadable !== undefined,
@@ -219,6 +221,7 @@ function prerender(
219221
options ? options.onError : undefined,
220222
options ? options.identifierPrefix : undefined,
221223
options ? options.temporaryReferences : undefined,
224+
options ? options.startTime : undefined,
222225
__DEV__ && options ? options.environmentName : undefined,
223226
__DEV__ && options ? options.filterStackFrame : undefined,
224227
false,

‎packages/react-server-dom-turbopack/src/server/ReactFlightDOMServerNode.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ type Options = {
152152
onError?: (error: mixed) => void,
153153
identifierPrefix?: string,
154154
temporaryReferences?: TemporaryReferenceSet,
155+
startTime?: number,
155156
};
156157

157158
type PipeableStream = {
@@ -189,6 +190,7 @@ function renderToPipeableStream(
189190
options ? options.onError : undefined,
190191
options ? options.identifierPrefix : undefined,
191192
options ? options.temporaryReferences : undefined,
193+
options ? options.startTime : undefined,
192194
__DEV__ && options ? options.environmentName : undefined,
193195
__DEV__ && options ? options.filterStackFrame : undefined,
194196
debugChannel !== undefined,
@@ -347,6 +349,7 @@ function renderToReadableStream(
347349
options ? options.onError : undefined,
348350
options ? options.identifierPrefix : undefined,
349351
options ? options.temporaryReferences : undefined,
352+
options ? options.startTime : undefined,
350353
__DEV__ && options ? options.environmentName : undefined,
351354
__DEV__ && options ? options.filterStackFrame : undefined,
352355
debugChannelReadable !== undefined,
@@ -429,6 +432,7 @@ type PrerenderOptions = {
429432
identifierPrefix?: string,
430433
temporaryReferences?: TemporaryReferenceSet,
431434
signal?: AbortSignal,
435+
startTime?: number,
432436
};
433437

434438
type StaticResult = {
@@ -460,6 +464,7 @@ function prerenderToNodeStream(
460464
options ? options.onError : undefined,
461465
options ? options.identifierPrefix : undefined,
462466
options ? options.temporaryReferences : undefined,
467+
options ? options.startTime : undefined,
463468
__DEV__ && options ? options.environmentName : undefined,
464469
__DEV__ && options ? options.filterStackFrame : undefined,
465470
false,
@@ -523,6 +528,7 @@ function prerender(
523528
options ? options.onError : undefined,
524529
options ? options.identifierPrefix : undefined,
525530
options ? options.temporaryReferences : undefined,
531+
options ? options.startTime : undefined,
526532
__DEV__ && options ? options.environmentName : undefined,
527533
__DEV__ && options ? options.filterStackFrame : undefined,
528534
false,

‎packages/react-server-dom-unbundled/src/server/ReactFlightDOMServerNode.js‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ type Options = {
152152
onError?: (error: mixed) => void,
153153
identifierPrefix?: string,
154154
temporaryReferences?: TemporaryReferenceSet,
155+
startTime?: number,
155156
};
156157

157158
type PipeableStream = {
@@ -189,6 +190,7 @@ function renderToPipeableStream(
189190
options ? options.onError : undefined,
190191
options ? options.identifierPrefix : undefined,
191192
options ? options.temporaryReferences : undefined,
193+
options ? options.startTime : undefined,
192194
__DEV__ && options ? options.environmentName : undefined,
193195
__DEV__ && options ? options.filterStackFrame : undefined,
194196
debugChannelReadable !== undefined,
@@ -347,6 +349,7 @@ function renderToReadableStream(
347349
options ? options.onError : undefined,
348350
options ? options.identifierPrefix : undefined,
349351
options ? options.temporaryReferences : undefined,
352+
options ? options.startTime : undefined,
350353
__DEV__ && options ? options.environmentName : undefined,
351354
__DEV__ && options ? options.filterStackFrame : undefined,
352355
debugChannelReadable !== undefined,
@@ -429,6 +432,7 @@ type PrerenderOptions = {
429432
identifierPrefix?: string,
430433
temporaryReferences?: TemporaryReferenceSet,
431434
signal?: AbortSignal,
435+
startTime?: number,
432436
};
433437

434438
type StaticResult = {
@@ -460,6 +464,7 @@ function prerenderToNodeStream(
460464
options ? options.onError : undefined,
461465
options ? options.identifierPrefix : undefined,
462466
options ? options.temporaryReferences : undefined,
467+
options ? options.startTime : undefined,
463468
__DEV__ && options ? options.environmentName : undefined,
464469
__DEV__ && options ? options.filterStackFrame : undefined,
465470
false,
@@ -523,6 +528,7 @@ function prerender(
523528
options ? options.onError : undefined,
524529
options ? options.identifierPrefix : undefined,
525530
options ? options.temporaryReferences : undefined,
531+
options ? options.startTime : undefined,
526532
__DEV__ && options ? options.environmentName : undefined,
527533
__DEV__ && options ? options.filterStackFrame : undefined,
528534
false,

0 commit comments

Comments
 (0)