Add comments and push actual marker instance in pushMarkerInstance

facebook · Jun 27, 2022 · 23cb59a · 23cb59a
1 parent ce0193e
commit 23cb59a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 14 deletions.
diff --git a/packages/react-reconciler/src/ReactFiberBeginWork.new.js b/packages/react-reconciler/src/ReactFiberBeginWork.new.js
@@ -912,11 +912,7 @@ function updateTracingMarkerComponent(
 
   const instance = workInProgress.stateNode;
   if (instance !== null) {
-    pushMarkerInstance(
-      workInProgress,
-      instance.transitions,
-      instance.pendingSuspenseBoundaries,
-    );
+    pushMarkerInstance(workInProgress, instance);
   }
   const nextChildren = workInProgress.pendingProps.children;
   reconcileChildren(current, workInProgress, nextChildren, renderLanes);
@@ -3720,11 +3716,7 @@ function attemptEarlyBailoutIfNoScheduledUpdate(
       if (enableTransitionTracing) {
         const instance: TracingMarkerInstance = workInProgress.stateNode;
         if (instance !== null) {
-          pushMarkerInstance(
-            workInProgress,
-            instance.transitions,
-            instance.pendingSuspenseBoundaries,
-          );
+          pushMarkerInstance(workInProgress, instance);
         }
       }
     }

diff --git a/packages/react-reconciler/src/ReactFiberTracingMarkerComponent.new.js b/packages/react-reconciler/src/ReactFiberTracingMarkerComponent.new.js
@@ -107,15 +107,27 @@ const markerInstanceStack: StackCursor<Array<TracingMarkerInstance> | null> = cr
 
 export function pushRootMarkerInstance(workInProgress: Fiber): void {
   if (enableTransitionTracing) {
+    // On the root, every transition gets mapped to it's own map of
+    // suspense boundaries. The transition is marked as complete when
+    // the suspense boundaries map is empty. We do this because every
+    // transition completes at different times and depends on different
+    // suspense boundaries to complete. We store all the transitions
+    // along with its map of suspense boundaries in the root incomplete
+    // transitions map. Each entry in this map functions like a tracing
+    // marker does, so we can push it onto the marker instance stack
     const transitions = getWorkInProgressTransitions();
     const root = workInProgress.stateNode;
     let incompleteTransitions = root.incompleteTransitions;
     if (transitions !== null) {
+      // Create a mapping from transition to suspense boundaries
+      // We instantiate this lazily, only if transitions exist
       if (incompleteTransitions === null) {
         root.incompleteTransitions = incompleteTransitions = new Map();
       }
 
       transitions.forEach(transition => {
+        // We need to create a new map here because we only have access to the
+        // object instance in the commit phase
         incompleteTransitions.set(transition, new Map());
       });
     }
@@ -124,6 +136,9 @@ export function pushRootMarkerInstance(workInProgress: Fiber): void {
       push(markerInstanceStack, null, workInProgress);
     } else {
       const markerInstances = [];
+      // For ever transition on the suspense boundary, we push the transition
+      // along with its map of pending suspense boundaries onto the marker
+      // instance stack.
       incompleteTransitions.forEach((pendingSuspenseBoundaries, transition) => {
         markerInstances.push({
           transitions: new Set([transition]),
@@ -143,12 +158,9 @@ export function popRootMarkerInstance(workInProgress: Fiber) {
 
 export function pushMarkerInstance(
   workInProgress: Fiber,
-  transitions: Set<Transition> | null,
-  pendingSuspenseBoundaries: PendingSuspenseBoundaries | null,
+  markerInstance: TracingMarkerInstance,
 ): void {
   if (enableTransitionTracing) {
-    const markerInstance = {transitions, pendingSuspenseBoundaries};
-
     if (markerInstanceStack.current === null) {
       push(markerInstanceStack, [markerInstance], workInProgress);
     } else {