{"commit":{"authorName":"Sebastian Markbåge","authorEmail":"sema@fb.com","subject":"Rename SuspendedWork to Task (#21105)","revision":"8b741437b12a3faad1b742274af8fcc456e71958","authoredAt":"2021-03-25T21:39:59-04:00","shortRevision":"8b741437b1"},"body":"","patch":"diff --git a\/packages\/react-server\/src\/ReactFizzServer.js b\/packages\/react-server\/src\/ReactFizzServer.js\nindex 92ff01c99a..71821638f0 100644\n--- a\/packages\/react-server\/src\/ReactFizzServer.js\n+++ b\/packages\/react-server\/src\/ReactFizzServer.js\n@@ -59,18 +59,18 @@ type SuspenseBoundary = {\n rootSegmentID: number,\n forceClientRender: boolean, \/\/ if it errors or infinitely suspends\n parentFlushed: boolean,\n- pendingWork: number, \/\/ when it reaches zero we can show this boundary's content\n+ pendingTasks: number, \/\/ when it reaches zero we can show this boundary's content\n completedSegments: Array, \/\/ completed but not yet flushed segments.\n byteSize: number, \/\/ used to determine whether to inline children boundaries.\n- fallbackAbortableWork: Set, \/\/ used to cancel work on the fallback if the boundary completes or gets canceled.\n+ fallbackAbortableTask: Set, \/\/ used to cancel task on the fallback if the boundary completes or gets canceled.\n };\n \n-type SuspendedWork = {\n+type Task = {\n node: ReactNodeList,\n ping: () => void,\n blockedBoundary: Root | SuspenseBoundary,\n blockedSegment: Segment, \/\/ the segment we'll write to\n- abortSet: Set, \/\/ the abortable set that this work belongs to\n+ abortSet: Set, \/\/ the abortable set that this task belongs to\n formatContext: FormatContext,\n assignID: null | SuspenseBoundaryID, \/\/ id to assign to the content\n };\n@@ -104,18 +104,18 @@ type Request = {\n +progressiveChunkSize: number,\n status: 0 | 1 | 2,\n nextSegmentId: number,\n- allPendingWork: number, \/\/ when it reaches zero, we can close the connection.\n- pendingRootWork: number, \/\/ when this reaches zero, we've finished at least the root boundary.\n+ allPendingTasks: number, \/\/ when it reaches zero, we can close the connection.\n+ pendingRootTasks: number, \/\/ when this reaches zero, we've finished at least the root boundary.\n completedRootSegment: null | Segment, \/\/ Completed but not yet flushed root segments.\n- abortableWork: Set,\n- pingedWork: Array,\n+ abortableTask: Set,\n+ pingedTask: Array,\n \/\/ Queues to flush in order of priority\n clientRenderedBoundaries: Array, \/\/ Errored or client rendered but not yet flushed.\n completedBoundaries: Array, \/\/ Completed but not yet fully flushed boundaries to show.\n partialBoundaries: Array, \/\/ Partially completed boundaries that can flush its segments early.\n \/\/ onError is called when an error happens anywhere in the tree. It might recover.\n onError: (error: mixed) => void,\n- \/\/ onCompleteAll is called when all pending work is done but it may not have flushed yet.\n+ \/\/ onCompleteAll is called when all pending task is done but it may not have flushed yet.\n \/\/ This is a good time to start writing if you want only HTML and no intermediate steps.\n onCompleteAll: () => void,\n \/\/ onReadyToStream is called when there is at least a root fallback ready to show.\n@@ -151,19 +151,19 @@ export function createRequest(\n onCompleteAll: () => void = noop,\n onReadyToStream: () => void = noop,\n ): Request {\n- const pingedWork = [];\n- const abortSet: Set = new Set();\n+ const pingedTask = [];\n+ const abortSet: Set = new Set();\n const request = {\n destination,\n responseState,\n progressiveChunkSize,\n status: BUFFERING,\n nextSegmentId: 0,\n- allPendingWork: 0,\n- pendingRootWork: 0,\n+ allPendingTasks: 0,\n+ pendingRootTasks: 0,\n completedRootSegment: null,\n- abortableWork: abortSet,\n- pingedWork: pingedWork,\n+ abortableTask: abortSet,\n+ pingedTask: pingedTask,\n clientRenderedBoundaries: [],\n completedBoundaries: [],\n partialBoundaries: [],\n@@ -175,7 +175,7 @@ export function createRequest(\n const rootSegment = createPendingSegment(request, 0, null);\n \/\/ There is no parent so conceptually, we're unblocked to flush this segment.\n rootSegment.parentFlushed = true;\n- const rootWork = createSuspendedWork(\n+ const rootTask = createTask(\n request,\n children,\n null,\n@@ -184,60 +184,60 @@ export function createRequest(\n rootContext,\n null,\n );\n- pingedWork.push(rootWork);\n+ pingedTask.push(rootTask);\n return request;\n }\n \n-function pingSuspendedWork(request: Request, work: SuspendedWork): void {\n- const pingedWork = request.pingedWork;\n- pingedWork.push(work);\n- if (pingedWork.length === 1) {\n+function pingTask(request: Request, task: Task): void {\n+ const pingedTask = request.pingedTask;\n+ pingedTask.push(task);\n+ if (pingedTask.length === 1) {\n scheduleWork(() => performWork(request));\n }\n }\n \n function createSuspenseBoundary(\n request: Request,\n- fallbackAbortableWork: Set,\n+ fallbackAbortableTask: Set,\n ): SuspenseBoundary {\n return {\n id: createSuspenseBoundaryID(request.responseState),\n rootSegmentID: -1,\n parentFlushed: false,\n- pendingWork: 0,\n+ pendingTasks: 0,\n forceClientRender: false,\n completedSegments: [],\n byteSize: 0,\n- fallbackAbortableWork,\n+ fallbackAbortableTask,\n };\n }\n \n-function createSuspendedWork(\n+function createTask(\n request: Request,\n node: ReactNodeList,\n blockedBoundary: Root | SuspenseBoundary,\n blockedSegment: Segment,\n- abortSet: Set,\n+ abortSet: Set,\n formatContext: FormatContext,\n assignID: null | SuspenseBoundaryID,\n-): SuspendedWork {\n- request.allPendingWork++;\n+): Task {\n+ request.allPendingTasks++;\n if (blockedBoundary === null) {\n- request.pendingRootWork++;\n+ request.pendingRootTasks++;\n } else {\n- blockedBoundary.pendingWork++;\n+ blockedBoundary.pendingTasks++;\n }\n- const work = {\n+ const task = {\n node,\n- ping: () => pingSuspendedWork(request, work),\n+ ping: () => pingTask(request, task),\n blockedBoundary,\n blockedSegment,\n abortSet,\n formatContext,\n assignID,\n };\n- abortSet.add(work);\n- return work;\n+ abortSet.add(task);\n+ return task;\n }\n \n function createPendingSegment(\n@@ -270,34 +270,30 @@ function fatalError(request: Request, error: mixed): void {\n closeWithError(request.destination, error);\n }\n \n-function renderNode(\n- request: Request,\n- work: SuspendedWork,\n- node: ReactNodeList,\n-): void {\n+function renderNode(request: Request, task: Task, node: ReactNodeList): void {\n if (typeof node === 'string') {\n pushTextInstance(\n- work.blockedSegment.chunks,\n+ task.blockedSegment.chunks,\n node,\n request.responseState,\n- work.assignID,\n+ task.assignID,\n );\n- work.assignID = null;\n+ task.assignID = null;\n return;\n }\n \n if (Array.isArray(node)) {\n if (node.length > 0) {\n for (let i = 0; i < node.length; i++) {\n- renderNode(request, work, node[i]);\n+ renderNode(request, task, node[i]);\n }\n } else {\n pushEmpty(\n- work.blockedSegment.chunks,\n+ task.blockedSegment.chunks,\n request.responseState,\n- work.assignID,\n+ task.assignID,\n );\n- work.assignID = null;\n+ task.assignID = null;\n }\n return;\n }\n@@ -315,26 +311,26 @@ function renderNode(\n if (typeof type === 'function') {\n try {\n const result = type(props);\n- renderNode(request, work, result);\n+ renderNode(request, task, result);\n } catch (x) {\n if (typeof x === 'object' && x !== null && typeof x.then === 'function') {\n \/\/ Something suspended, we'll need to create a new segment and resolve it later.\n- const segment = work.blockedSegment;\n+ const segment = task.blockedSegment;\n const insertionIndex = segment.chunks.length;\n const newSegment = createPendingSegment(request, insertionIndex, null);\n segment.children.push(newSegment);\n- const suspendedWork = createSuspendedWork(\n+ const newTask = createTask(\n request,\n node,\n- work.blockedBoundary,\n+ task.blockedBoundary,\n newSegment,\n- work.abortSet,\n- work.formatContext,\n- work.assignID,\n+ task.abortSet,\n+ task.formatContext,\n+ task.assignID,\n );\n \/\/ We've delegated the assignment.\n- work.assignID = null;\n- const ping = suspendedWork.ping;\n+ task.assignID = null;\n+ const ping = newTask.ping;\n x.then(ping, ping);\n } else {\n \/\/ We can rethrow to terminate the rest of this tree.\n@@ -343,28 +339,28 @@ function renderNode(\n }\n } else if (typeof type === 'string') {\n pushStartInstance(\n- work.blockedSegment.chunks,\n+ task.blockedSegment.chunks,\n type,\n props,\n request.responseState,\n- work.assignID,\n+ task.assignID,\n );\n \/\/ We must have assigned it already above so we don't need this anymore.\n- work.assignID = null;\n- const prevContext = work.formatContext;\n- work.formatContext = getChildFormatContext(prevContext, type, props);\n- renderNode(request, work, props.children);\n- \/\/ We expect that errors will fatal the whole work and that we don't need\n+ task.assignID = null;\n+ const prevContext = task.formatContext;\n+ task.formatContext = getChildFormatContext(prevContext, type, props);\n+ renderNode(request, task, props.children);\n+ \/\/ We expect that errors will fatal the whole task and that we don't need\n \/\/ the correct context. Therefore this is not in a finally.\n- work.formatContext = prevContext;\n- pushEndInstance(work.blockedSegment.chunks, type, props);\n+ task.formatContext = prevContext;\n+ pushEndInstance(task.blockedSegment.chunks, type, props);\n } else if (type === REACT_SUSPENSE_TYPE) {\n- const parentBoundary = work.blockedBoundary;\n- const parentSegment = work.blockedSegment;\n+ const parentBoundary = task.blockedBoundary;\n+ const parentSegment = task.blockedSegment;\n \n \/\/ We need to push an \"empty\" thing here to identify the parent suspense boundary.\n- pushEmpty(parentSegment.chunks, request.responseState, work.assignID);\n- work.assignID = null;\n+ pushEmpty(parentSegment.chunks, request.responseState, task.assignID);\n+ task.assignID = null;\n \/\/ Each time we enter a suspense boundary, we split out into a new segment for\n \/\/ the fallback so that we can later replace that segment with the content.\n \/\/ This also lets us split out the main content even if it doesn't suspend,\n@@ -372,7 +368,7 @@ function renderNode(\n const fallback: ReactNodeList = props.fallback;\n const content: ReactNodeList = props.children;\n \n- const fallbackAbortSet: Set = new Set();\n+ const fallbackAbortSet: Set = new Set();\n const newBoundary = createSuspenseBoundary(request, fallbackAbortSet);\n const insertionIndex = parentSegment.chunks.length;\n \/\/ The children of the boundary segment is actually the fallback.\n@@ -389,21 +385,21 @@ function renderNode(\n \/\/ no parent segment so there's nothing to wait on.\n contentRootSegment.parentFlushed = true;\n \n- \/\/ Currently this is running synchronously. We could instead schedule this to pingedWork.\n- \/\/ I suspect that there might be some efficiency benefits from not creating the suspended work\n+ \/\/ Currently this is running synchronously. We could instead schedule this to pingedTask.\n+ \/\/ I suspect that there might be some efficiency benefits from not creating the suspended task\n \/\/ and instead just using the stack if possible.\n \/\/ TODO: Call this directly instead of messing with saving and restoring contexts.\n \n- \/\/ We can reuse the current context and work to render the content immediately without\n+ \/\/ We can reuse the current context and task to render the content immediately without\n \/\/ context switching. We just need to temporarily switch which boundary and which segment\n- \/\/ we're writing to. If something suspends, it'll spawn new suspended work with that context.\n- work.blockedBoundary = newBoundary;\n- work.blockedSegment = contentRootSegment;\n+ \/\/ we're writing to. If something suspends, it'll spawn new suspended task with that context.\n+ task.blockedBoundary = newBoundary;\n+ task.blockedSegment = contentRootSegment;\n try {\n- renderNode(request, work, content);\n+ renderNode(request, task, content);\n contentRootSegment.status = COMPLETED;\n newBoundary.completedSegments.push(contentRootSegment);\n- if (newBoundary.pendingWork === 0) {\n+ if (newBoundary.pendingTasks === 0) {\n \/\/ This must have been the last segment we were waiting on. This boundary is now complete.\n \/\/ Therefore we won't need the fallback. We early return so that we don't have to create\n \/\/ the fallback.\n@@ -413,34 +409,34 @@ function renderNode(\n contentRootSegment.status = ERRORED;\n reportError(request, error);\n newBoundary.forceClientRender = true;\n- \/\/ We don't need to decrement any work numbers because we didn't spawn any new work.\n- \/\/ We don't need to schedule any work because we know the parent has written yet.\n+ \/\/ We don't need to decrement any task numbers because we didn't spawn any new task.\n+ \/\/ We don't need to schedule any task because we know the parent has written yet.\n \/\/ We do need to fallthrough to create the fallback though.\n } finally {\n- work.blockedBoundary = parentBoundary;\n- work.blockedSegment = parentSegment;\n+ task.blockedBoundary = parentBoundary;\n+ task.blockedSegment = parentSegment;\n }\n \n- \/\/ We create suspended work for the fallback because we don't want to actually work\n+ \/\/ We create suspended task for the fallback because we don't want to actually task\n \/\/ on it yet in case we finish the main content, so we queue for later.\n- const suspendedFallbackWork = createSuspendedWork(\n+ const suspendedFallbackTask = createTask(\n request,\n fallback,\n parentBoundary,\n boundarySegment,\n fallbackAbortSet,\n- work.formatContext,\n+ task.formatContext,\n newBoundary.id, \/\/ This is the ID we want to give this fallback so we can replace it later.\n );\n- \/\/ TODO: This should be queued at a separate lower priority queue so that we only work\n- \/\/ on preparing fallbacks if we don't have any more main content to work on.\n- request.pingedWork.push(suspendedFallbackWork);\n+ \/\/ TODO: This should be queued at a separate lower priority queue so that we only task\n+ \/\/ on preparing fallbacks if we don't have any more main content to task on.\n+ request.pingedTask.push(suspendedFallbackTask);\n } else {\n throw new Error('Not yet implemented element type.');\n }\n }\n \n-function erroredWork(\n+function erroredTask(\n request: Request,\n boundary: Root | SuspenseBoundary,\n segment: Segment,\n@@ -451,7 +447,7 @@ function erroredWork(\n if (boundary === null) {\n fatalError(request, error);\n } else {\n- boundary.pendingWork--;\n+ boundary.pendingTasks--;\n if (!boundary.forceClientRender) {\n boundary.forceClientRender = true;\n \n@@ -467,32 +463,32 @@ function erroredWork(\n }\n }\n \n- request.allPendingWork--;\n- if (request.allPendingWork === 0) {\n+ request.allPendingTasks--;\n+ if (request.allPendingTasks === 0) {\n request.onCompleteAll();\n }\n }\n \n-function abortWorkSoft(suspendedWork: SuspendedWork): void {\n- \/\/ This aborts work without aborting the parent boundary that it blocks.\n- \/\/ It's used for when we didn't need this work to complete the tree.\n- \/\/ If work was needed, then it should use abortWork instead.\n+function abortTaskSoft(task: Task): void {\n+ \/\/ This aborts task without aborting the parent boundary that it blocks.\n+ \/\/ It's used for when we didn't need this task to complete the tree.\n+ \/\/ If task was needed, then it should use abortTask instead.\n const request: Request = this;\n- const boundary = suspendedWork.blockedBoundary;\n- const segment = suspendedWork.blockedSegment;\n+ const boundary = task.blockedBoundary;\n+ const segment = task.blockedSegment;\n segment.status = ABORTED;\n- finishedWork(request, boundary, segment);\n+ finishedTask(request, boundary, segment);\n }\n \n-function abortWork(suspendedWork: SuspendedWork): void {\n- \/\/ This aborts the work and aborts the parent that it blocks, putting it into\n+function abortTask(task: Task): void {\n+ \/\/ This aborts the task and aborts the parent that it blocks, putting it into\n \/\/ client rendered mode.\n const request: Request = this;\n- const boundary = suspendedWork.blockedBoundary;\n- const segment = suspendedWork.blockedSegment;\n+ const boundary = task.blockedBoundary;\n+ const segment = task.blockedSegment;\n segment.status = ABORTED;\n \n- request.allPendingWork--;\n+ request.allPendingTasks--;\n if (boundary === null) {\n \/\/ We didn't complete the root so we have nothing to show. We can close\n \/\/ the request;\n@@ -501,12 +497,12 @@ function abortWork(suspendedWork: SuspendedWork): void {\n close(request.destination);\n }\n } else {\n- boundary.pendingWork--;\n+ boundary.pendingTasks--;\n \n \/\/ If this boundary was still pending then we haven't already cancelled its fallbacks.\n \/\/ We'll need to abort the fallbacks, which will also error that parent boundary.\n- boundary.fallbackAbortableWork.forEach(abortWork, request);\n- boundary.fallbackAbortableWork.clear();\n+ boundary.fallbackAbortableTask.forEach(abortTask, request);\n+ boundary.fallbackAbortableTask.clear();\n \n if (!boundary.forceClientRender) {\n boundary.forceClientRender = true;\n@@ -515,13 +511,13 @@ function abortWork(suspendedWork: SuspendedWork): void {\n }\n }\n \n- if (request.allPendingWork === 0) {\n+ if (request.allPendingTasks === 0) {\n request.onCompleteAll();\n }\n }\n }\n \n-function finishedWork(\n+function finishedTask(\n request: Request,\n boundary: Root | SuspenseBoundary,\n segment: Segment,\n@@ -534,19 +530,19 @@ function finishedWork(\n );\n request.completedRootSegment = segment;\n }\n- request.pendingRootWork--;\n- if (request.pendingRootWork === 0) {\n+ request.pendingRootTasks--;\n+ if (request.pendingRootTasks === 0) {\n request.onReadyToStream();\n }\n } else {\n- boundary.pendingWork--;\n+ boundary.pendingTasks--;\n if (boundary.forceClientRender) {\n \/\/ This already errored.\n- } else if (boundary.pendingWork === 0) {\n+ } else if (boundary.pendingTasks === 0) {\n \/\/ This must have been the last segment we were waiting on. This boundary is now complete.\n- \/\/ We can now cancel any pending work on the fallback since we won't need to show it anymore.\n- boundary.fallbackAbortableWork.forEach(abortWorkSoft, request);\n- boundary.fallbackAbortableWork.clear();\n+ \/\/ We can now cancel any pending task on the fallback since we won't need to show it anymore.\n+ boundary.fallbackAbortableTask.forEach(abortTaskSoft, request);\n+ boundary.fallbackAbortableTask.clear();\n if (segment.parentFlushed) {\n \/\/ Our parent segment already flushed, so we need to schedule this segment to be emitted.\n boundary.completedSegments.push(segment);\n@@ -573,22 +569,22 @@ function finishedWork(\n }\n }\n \n- request.allPendingWork--;\n- if (request.allPendingWork === 0) {\n+ request.allPendingTasks--;\n+ if (request.allPendingTasks === 0) {\n \/\/ This needs to be called at the very end so that we can synchronously write the result\n \/\/ in the callback if needed.\n request.onCompleteAll();\n }\n }\n \n-function retryWork(request: Request, work: SuspendedWork): void {\n- const segment = work.blockedSegment;\n+function retryTask(request: Request, task: Task): void {\n+ const segment = task.blockedSegment;\n if (segment.status !== PENDING) {\n \/\/ We completed this by other means before we had a chance to retry it.\n return;\n }\n try {\n- let node = work.node;\n+ let node = task.node;\n while (\n typeof node === 'object' &&\n node !== null &&\n@@ -598,25 +594,25 @@ function retryWork(request: Request, work: SuspendedWork): void {\n \/\/ Doing this here lets us reuse this same Segment if the next component\n \/\/ also suspends.\n const element: React$Element = (node: any);\n- work.node = node;\n+ task.node = node;\n \/\/ TODO: Classes and legacy context etc.\n node = element.type(element.props);\n }\n \n- renderNode(request, work, node);\n+ renderNode(request, task, node);\n \n- work.abortSet.delete(work);\n+ task.abortSet.delete(task);\n segment.status = COMPLETED;\n- finishedWork(request, work.blockedBoundary, segment);\n+ finishedTask(request, task.blockedBoundary, segment);\n } catch (x) {\n if (typeof x === 'object' && x !== null && typeof x.then === 'function') {\n \/\/ Something suspended again, let's pick it back up later.\n- const ping = work.ping;\n+ const ping = task.ping;\n x.then(ping, ping);\n } else {\n- work.abortSet.delete(work);\n+ task.abortSet.delete(task);\n segment.status = ERRORED;\n- erroredWork(request, work.blockedBoundary, segment, x);\n+ erroredTask(request, task.blockedBoundary, segment, x);\n }\n }\n }\n@@ -629,13 +625,13 @@ function performWork(request: Request): void {\n ReactCurrentDispatcher.current = Dispatcher;\n \n try {\n- const pingedWork = request.pingedWork;\n+ const pingedTask = request.pingedTask;\n let i;\n- for (i = 0; i < pingedWork.length; i++) {\n- const work = pingedWork[i];\n- retryWork(request, work);\n+ for (i = 0; i < pingedTask.length; i++) {\n+ const task = pingedTask[i];\n+ retryTask(request, task);\n }\n- pingedWork.splice(0, i);\n+ pingedTask.splice(0, i);\n if (request.status === FLOWING) {\n flushCompletedQueues(request);\n }\n@@ -712,7 +708,7 @@ function flushSegment(\n flushSubtree(request, destination, segment);\n \n return writeEndSuspenseBoundary(destination);\n- } else if (boundary.pendingWork > 0) {\n+ } else if (boundary.pendingTasks > 0) {\n \/\/ This boundary is still loading. Emit a pending suspense boundary wrapper.\n \n \/\/ Assign an ID to refer to the future content by.\n@@ -880,7 +876,7 @@ function flushCompletedQueues(request: Request): void {\n \/\/ TODO: It's kind of unfortunate to keep checking this array after we've already\n \/\/ emitted the root.\n const completedRootSegment = request.completedRootSegment;\n- if (completedRootSegment !== null && request.pendingRootWork === 0) {\n+ if (completedRootSegment !== null && request.pendingRootTasks === 0) {\n flushSegment(request, destination, completedRootSegment);\n request.completedRootSegment = null;\n }\n@@ -956,17 +952,17 @@ function flushCompletedQueues(request: Request): void {\n completeWriting(destination);\n flushBuffered(destination);\n if (\n- request.allPendingWork === 0 &&\n- request.pingedWork.length === 0 &&\n+ request.allPendingTasks === 0 &&\n+ request.pingedTask.length === 0 &&\n request.clientRenderedBoundaries.length === 0 &&\n request.completedBoundaries.length === 0\n \/\/ We don't need to check any partially completed segments because\n- \/\/ either they have pending work or they're complete.\n+ \/\/ either they have pending task or they're complete.\n ) {\n if (__DEV__) {\n- if (request.abortableWork.size !== 0) {\n+ if (request.abortableTask.size !== 0) {\n console.error(\n- 'There was still abortable work at the root when we closed. This is a bug in React.',\n+ 'There was still abortable task at the root when we closed. This is a bug in React.',\n );\n }\n }\n@@ -996,9 +992,9 @@ export function startFlowing(request: Request): void {\n \/\/ This is called to early terminate a request. It puts all pending boundaries in client rendered state.\n export function abort(request: Request): void {\n try {\n- const abortableWork = request.abortableWork;\n- abortableWork.forEach(abortWork, request);\n- abortableWork.clear();\n+ const abortableTask = request.abortableTask;\n+ abortableTask.forEach(abortTask, request);\n+ abortableTask.clear();\n if (request.status === FLOWING) {\n flushCompletedQueues(request);\n }\n","parents":["38a1aedb4987142ff2cfca57593b91571a39d394"],"files":[{"status":"M","path":"packages\/react-server\/src\/ReactFizzServer.js"}]}

dillon1000/react

Files changed