OSSForks/react
1
0
Fork 0
mirror of https://github.com/zebrajr/react.git synced 2025-12-06 00:20:04 +01:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

[Flight] Keep a separate ref count for debug chunks (#33717)

Browse Source 
Same as #33716 but without the separate close signal.

We'll need the ref count for separate debug channel anyway but I'm not
sure we'll need the separate close signal.
This commit is contained in:
Sebastian Markbåge 2025-07-07 11:42:20 -04:00 committed by GitHub
parent 7cafeff340
commit 8a6c589be7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 47 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
packages/react-server/src/ReactFlightServer.js vendored
View File

@ -278,7 +278,7 @@ function patchConsole(consoleInst: typeof console, methodName: string) {
request,
parseStackTrace(new Error('react-stack-top-frame'), 1),
);
request.pendingChunks++;
request.pendingDebugChunks++;
const owner: null | ReactComponentInfo = resolveOwner();
const args = Array.from(arguments);
// Extract the env if this is a console log that was replayed from another env.
@ -468,6 +468,7 @@ export type Request = {
timeOrigin: number,
abortTime: number,
// DEV-only
pendingDebugChunks: number,
completedDebugChunks: Array<Chunk | BinaryChunk>,
environmentName: () => string,
filterStackFrame: (
@ -587,6 +588,7 @@ function RequestInstance(
this.onFatalError = onFatalError;
if (__DEV__) {
this.pendingDebugChunks = 0;
this.completedDebugChunks = ([]: Array<Chunk>);
this.environmentName =
environmentName === undefined
@ -725,7 +727,7 @@ function serializeDebugThenable(
thenable: Thenable<any>,
): string {
// Like serializeThenable but for renderDebugModel
request.pendingChunks++;
request.pendingDebugChunks++;
const id = request.nextChunkId++;
const ref = serializePromiseID(id);
request.writtenDebugObjects.set(thenable, ref);
@ -737,20 +739,9 @@ function serializeDebugThenable(
}
case 'rejected': {
const x = thenable.reason;
if (
enablePostpone &&
typeof x === 'object' &&
x !== null &&
(x: any).$$typeof === REACT_POSTPONE_TYPE
) {
const postponeInstance: Postpone = (x: any);
// We don't log this postpone.
emitPostponeChunk(request, id, postponeInstance);
} else {
// We don't log these errors since they didn't actually throw into Flight.
const digest = '';
emitErrorChunk(request, id, digest, x, true);
}
// We don't log these errors since they didn't actually throw into Flight.
const digest = '';
emitErrorChunk(request, id, digest, x, true);
return ref;
}
}
@ -787,20 +778,9 @@ function serializeDebugThenable(
enqueueFlush(request);
return;
}
if (
enablePostpone &&
typeof reason === 'object' &&
reason !== null &&
(reason: any).$$typeof === REACT_POSTPONE_TYPE
) {
const postponeInstance: Postpone = (reason: any);
// We don't log this postpone.
emitPostponeChunk(request, id, postponeInstance);
} else {
// We don't log these errors since they didn't actually throw into Flight.
const digest = '';
emitErrorChunk(request, id, digest, reason, true);
}
// We don't log these errors since they didn't actually throw into Flight.
const digest = '';
emitErrorChunk(request, id, digest, reason, true);
enqueueFlush(request);
},
);
@ -1445,7 +1425,7 @@ function renderFunctionComponent<Props>(
const componentName =
(Component: any).displayName || Component.name || '';
const componentEnv = (0, request.environmentName)();
request.pendingChunks++;
request.pendingDebugChunks++;
componentDebugInfo = ({
name: componentName,
env: componentEnv,
@ -2219,7 +2199,7 @@ function visitAsyncNode(
const env = (0, request.environmentName)();
advanceTaskTime(request, task, startTime);
// Then emit a reference to us awaiting it in the current task.
request.pendingChunks++;
request.pendingDebugChunks++;
emitDebugChunk(request, task.id, {
awaited: ((ioNode: any): ReactIOInfo), // This is deduped by this reference.
env: env,
@ -2276,7 +2256,7 @@ function emitAsyncSequence(
} else if (awaitedNode !== null) {
// Nothing in user space (unfiltered stack) awaited this.
serializeIONode(request, awaitedNode, awaitedNode.promise);
request.pendingChunks++;
request.pendingDebugChunks++;
// We log the environment at the time when we ping which may be later than what the
// environment was when we actually started awaiting.
const env = (0, request.environmentName)();
@ -2457,7 +2437,7 @@ function serializeDeferredObject(
// This client supports a long lived connection. We can assign this object
// an ID to be lazy loaded later.
// This keeps the connection alive until we ask for it or release it.
request.pendingChunks++;
request.pendingDebugChunks++;
const id = request.nextChunkId++;
deferredDebugObjects.existing.set(value, id);
deferredDebugObjects.retained.set(id, value);
@ -2594,7 +2574,7 @@ function serializeDebugClientReference(
try {
const clientReferenceMetadata: ClientReferenceMetadata =
resolveClientReferenceMetadata(request.bundlerConfig, clientReference);
request.pendingChunks++;
request.pendingDebugChunks++;
const importId = request.nextChunkId++;
emitImportChunk(request, importId, clientReferenceMetadata, true);
if (parent[0] === REACT_ELEMENT_TYPE && parentPropertyName === '1') {
@ -2607,7 +2587,7 @@ function serializeDebugClientReference(
}
return serializeByValueID(importId);
} catch (x) {
request.pendingChunks++;
request.pendingDebugChunks++;
const errorId = request.nextChunkId++;
const digest = logRecoverableError(request, x, null);
emitErrorChunk(request, errorId, digest, x, true);
@ -2710,7 +2690,7 @@ function serializeLargeTextString(request: Request, text: string): string {
}
function serializeDebugLargeTextString(request: Request, text: string): string {
request.pendingChunks++;
request.pendingDebugChunks++;
const textId = request.nextChunkId++;
emitTextChunk(request, textId, text, true);
return serializeByValueID(textId);
@ -2819,7 +2799,7 @@ function serializeDebugTypedArray(
tag: string,
typedArray: $ArrayBufferView,
): string {
request.pendingChunks++;
request.pendingDebugChunks++;
const bufferId = request.nextChunkId++;
emitTypedArrayChunk(request, bufferId, tag, typedArray, true);
return serializeByValueID(bufferId);
@ -2828,6 +2808,7 @@ function serializeDebugTypedArray(
function serializeDebugBlob(request: Request, blob: Blob): string {
const model: Array<string | Uint8Array> = [blob.type];
const reader = blob.stream().getReader();
request.pendingDebugChunks++;
const id = request.nextChunkId++;
function progress(
entry: {done: false, value: Uint8Array} | {done: true, value: void},
@ -4095,7 +4076,7 @@ function outlineIOInfo(request: Request, ioInfo: ReactIOInfo): void {
return;
}
// We can't serialize the ConsoleTask/Error objects so we need to omit them before serializing.
request.pendingChunks++;
request.pendingDebugChunks++;
const id = request.nextChunkId++;
const owner = ioInfo.owner;
// Ensure the owner is already outlined.
@ -4173,7 +4154,7 @@ function serializeIONode(
request.abortTime
: ioNode.end;
request.pendingChunks++;
request.pendingDebugChunks++;
const id = request.nextChunkId++;
emitIOInfoChunk(
request,
@ -4210,7 +4191,11 @@ function emitTypedArrayChunk(
}
}
}
request.pendingChunks++; // Extra chunk for the header.
if (debug) {
request.pendingDebugChunks++;
} else {
request.pendingChunks++; // Extra chunk for the header.
}
// TODO: Convert to little endian if that's not the server default.
const binaryChunk = typedArrayToBinaryChunk(typedArray);
const binaryLength = byteLengthOfBinaryChunk(binaryChunk);
@ -4235,7 +4220,11 @@ function emitTextChunk(
'Existence of byteLengthOfChunk should have already been checked. This is a bug in React.',
);
}
request.pendingChunks++; // Extra chunk for the header.
if (debug) {
request.pendingDebugChunks++;
} else {
request.pendingChunks++; // Extra chunk for the header.
}
const textChunk = stringToChunk(text);
const binaryLength = byteLengthOfChunk(textChunk);
const row = id.toString(16) + ':T' + binaryLength.toString(16) + ',';
@ -4620,7 +4609,7 @@ function renderDebugModel(
// $FlowFixMe[method-unbinding]
'(' + Function.prototype.toString.call(value) + ')',
);
request.pendingChunks++;
request.pendingDebugChunks++;
const id = request.nextChunkId++;
const processedChunk = encodeReferenceChunk(request, id, serializedValue);
request.completedDebugChunks.push(processedChunk);
@ -4778,7 +4767,7 @@ function outlineDebugModel(
}
const id = request.nextChunkId++;
request.pendingChunks++;
request.pendingDebugChunks++;
emitOutlinedDebugModelChunk(request, id, counter, model);
return id;
}
@ -4827,7 +4816,7 @@ function emitTimeOriginChunk(request: Request, timeOrigin: number): void {
// We emit the time origin once. All ReactTimeInfo timestamps later in the stream
// are relative to this time origin. This allows for more compact number encoding
// and lower precision loss.
request.pendingChunks++;
request.pendingDebugChunks++;
const row = ':N' + timeOrigin + '\n';
const processedChunk = stringToChunk(row);
// TODO: Move to its own priority queue.
@ -4854,7 +4843,7 @@ function forwardDebugInfo(
// being no references to this as an owner.
outlineComponentInfo(request, (info: any));
// Emit a reference to the outlined one.
request.pendingChunks++;
request.pendingDebugChunks++;
emitDebugChunk(request, id, info);
} else if (info.awaited) {
const ioInfo = info.awaited;
@ -4895,11 +4884,11 @@ function forwardDebugInfo(
// $FlowFixMe[cannot-write]
debugAsyncInfo.stack = debugStack;
}
request.pendingChunks++;
request.pendingDebugChunks++;
emitDebugChunk(request, id, debugAsyncInfo);
}
} else {
request.pendingChunks++;
request.pendingDebugChunks++;
emitDebugChunk(request, id, info);
}
}
@ -5001,7 +4990,7 @@ function forwardDebugInfoFromAbortedTask(request: Request, task: Task): void {
// complete in time before aborting.
// The best we can do is try to emit the stack of where this Promise was created.
serializeIONode(request, node, null);
request.pendingChunks++;
request.pendingDebugChunks++;
const env = (0, request.environmentName)();
const asyncInfo: ReactAsyncInfo = {
awaited: ((node: any): ReactIOInfo), // This is deduped by this reference.
@ -5030,7 +5019,7 @@ function emitTimingChunk(
if (!enableProfilerTimer || !enableComponentPerformanceTrack) {
return;
}
request.pendingChunks++;
request.pendingDebugChunks++;
const relativeTimestamp = timestamp - request.timeOrigin;
const row =
serializeRowHeader('D', id) + '{"time":' + relativeTimestamp + '}\n';
@ -5242,7 +5231,7 @@ function retryTask(request: Request, task: Task): void {
if (__DEV__) {
const currentEnv = (0, request.environmentName)();
if (currentEnv !== task.environmentName) {
request.pendingChunks++;
request.pendingDebugChunks++;
// The environment changed since we last emitted any debug information for this
// task. We emit an entry that just includes the environment name change.
emitDebugChunk(request, task.id, {env: currentEnv});
@ -5462,7 +5451,7 @@ function flushCompletedChunks(
const debugChunks = request.completedDebugChunks;
i = 0;
for (; i < debugChunks.length; i++) {
request.pendingChunks--;
request.pendingDebugChunks--;
const chunk = debugChunks[i];
const keepWriting: boolean = writeChunkAndReturn(destination, chunk);
if (!keepWriting) {
@ -5510,7 +5499,10 @@ function flushCompletedChunks(
completeWriting(destination);
}
flushBuffered(destination);
if (request.pendingChunks === 0) {
if (
request.pendingChunks === 0 &&
(!__DEV__ || request.pendingDebugChunks === 0)
) {
// We're done.
if (enableTaint) {
cleanupTaintQueue(request);
@ -5729,7 +5721,7 @@ export function resolveDebugMessage(request: Request, message: string): void {
const retainedValue = deferredDebugObjects.retained.get(id);
if (retainedValue !== undefined) {
// We're no longer blocked on this. We won't emit it.
request.pendingChunks--;
request.pendingDebugChunks--;
deferredDebugObjects.retained.delete(id);
deferredDebugObjects.existing.delete(retainedValue);
enqueueFlush(request);
@ -5772,7 +5764,7 @@ export function closeDebugChannel(request: Request): void {
);
}
deferredDebugObjects.retained.forEach((value, id) => {
request.pendingChunks--;
request.pendingDebugChunks--;
deferredDebugObjects.retained.delete(id);
deferredDebugObjects.existing.delete(value);
});