transition tracing delete tracing marker

Author: lunaruan

packages/react-reconciler/src/ReactFiber.new.js

@@ -772,6 +772,9 @@ export function createFiberFromTracingMarker(
   const tracingMarkerInstance: TracingMarkerInstance = {
     transitions: null,
     pendingBoundaries: null,
+    deletions: null,
+    parents: null,
+    name: pendingProps.name,
   };
   fiber.stateNode = tracingMarkerInstance;
   return fiber;

packages/react-reconciler/src/ReactFiberBeginWork.new.js

@@ -974,11 +974,15 @@ function updateTracingMarkerComponent(
   // or updated it, so we can create a new set of transitions each time
   if (current === null) {
     const currentTransitions = getPendingTransitions();
+    // TODO: What if the parent markers change?
+    const parents = getMarkerInstances();
     if (currentTransitions !== null) {
       const markerInstance: TracingMarkerInstance = {
         transitions: new Set(currentTransitions),
         pendingBoundaries: new Map(),
         name: workInProgress.pendingProps.name,
+        parents,
+        deletions: null,
       };
       workInProgress.stateNode = markerInstance;
     }

packages/react-reconciler/src/ReactFiberCommitWork.new.js

@@ -30,7 +30,10 @@ import type {
 import type {HookFlags} from './ReactHookEffectTags';
 import type {Cache} from './ReactFiberCacheComponent.new';
 import type {RootState} from './ReactFiberRoot.new';
-import type {Transition} from './ReactFiberTracingMarkerComponent.new';
+import type {
+  Transition,
+  TracingMarkerInstance,
+} from './ReactFiberTracingMarkerComponent.new';
 
 import {
   enableCreateEventHandleAPI,
@@ -146,6 +149,7 @@ import {
   addTransitionProgressCallbackToPendingTransition,
   addTransitionCompleteCallbackToPendingTransition,
   addMarkerProgressCallbackToPendingTransition,
+  addMarkerIncompleteCallbackToPendingTransition,
   addMarkerCompleteCallbackToPendingTransition,
   setIsRunningInsertionEffect,
 } from './ReactFiberWorkLoop.new';
@@ -1987,6 +1991,20 @@ function commitDeletionEffectsOnFiber(
         const prevOffscreenSubtreeWasHidden = offscreenSubtreeWasHidden;
         offscreenSubtreeWasHidden =
           prevOffscreenSubtreeWasHidden || deletedFiber.memoizedState !== null;
+
+        if (enableTransitionTracing) {
+          // We need to mark this fiber's parents as deleted
+          const instance: OffscreenInstance = deletedFiber.stateNode;
+          const markers = instance.pendingMarkers;
+          if (markers !== null) {
+            markers.forEach(marker => {
+              if (marker.pendingBoundaries.has(instance)) {
+                marker.pendingBoundaries.delete(instance);
+              }
+            });
+          }
+        }
+
         recursivelyTraverseDeletionEffects(
           finishedRoot,
           nearestMountedAncestor,
@@ -2002,6 +2020,58 @@ function commitDeletionEffectsOnFiber(
       }
       break;
     }
+    case TracingMarkerComponent: {
+      if (enableTransitionTracing) {
+        // We need to mark this fiber's parents as deleted
+        const instance: TracingMarkerInstance = deletedFiber.stateNode;
+        const markers = instance.parents;
+        if (instance.transitions !== null) {
+          if (instance.deletions === null) {
+            instance.deletions = [];
+          }
+          instance.deletions.push({
+            type: 'marker',
+            name: deletedFiber.memoizedProps.name,
+            transitions: instance.transitions,
+          });
+
+          addMarkerIncompleteCallbackToPendingTransition(
+            instance.name,
+            instance.transitions,
+            instance.deletions,
+          );
+
+          if (markers !== null) {
+            markers.forEach(marker => {
+              if (marker.deletions === null) {
+                marker.deletions = [];
+
+                if (marker.name !== null) {
+                  addMarkerIncompleteCallbackToPendingTransition(
+                    marker.name,
+                    instance.transitions,
+                    marker.deletions,
+                  );
+                }
+              }
+
+              marker.deletions.push({
+                type: 'marker',
+                name: deletedFiber.memoizedProps.name,
+                transitions: instance.transitions,
+              });
+            });
+          }
+        }
+      }
+
+      recursivelyTraverseDeletionEffects(
+        finishedRoot,
+        nearestMountedAncestor,
+        deletedFiber,
+      );
+      return;
+    }
     default: {
       recursivelyTraverseDeletionEffects(
         finishedRoot,
@@ -3023,14 +3093,17 @@ function commitTracingMarkerPassiveMountEffect(finishedWork: Fiber) {
     (instance.pendingBoundaries === null ||
       instance.pendingBoundaries.size === 0)
   ) {
-    instance.transitions.forEach(transition => {
+    if (instance.deletions === null) {
       addMarkerCompleteCallbackToPendingTransition(
         finishedWork.memoizedProps.name,
         instance.transitions,
       );
-    });
+    }
     instance.transitions = null;
     instance.pendingBoundaries = null;
+    instance.deletions = null;
+    instance.parents = null;
+    instance.name = null;
   }
 }
 
@@ -3146,7 +3219,9 @@ function commitPassiveMountOnFiber(
           incompleteTransitions.forEach((markerInstance, transition) => {
             const pendingBoundaries = markerInstance.pendingBoundaries;
             if (pendingBoundaries === null || pendingBoundaries.size === 0) {
-              addTransitionCompleteCallbackToPendingTransition(transition);
+              if (markerInstance.deletions === null) {
+                addTransitionCompleteCallbackToPendingTransition(transition);
+              }
               incompleteTransitions.delete(transition);
             }
           });

packages/react-reconciler/src/ReactFiberTracingMarkerComponent.new.js

@@ -21,7 +21,14 @@ export type PendingTransitionCallbacks = {
   transitionStart: Array<Transition> | null,
   transitionProgress: Map<Transition, PendingBoundaries> | null,
   transitionComplete: Array<Transition> | null,
-  markerProgress: Map<string, TracingMarkerInstance> | null,
+  markerProgress: Map<
+    string,
+    {pendingBoundaries: PendingBoundaries, transitions: Set<Transition>},
+  > | null,
+  markerIncomplete: Map<
+    string,
+    {deletions: Array<TransitionDeletion>, transitions: Set<Transition>},
+  > | null,
   markerComplete: Map<string, Set<Transition>> | null,
 };
 
@@ -39,7 +46,16 @@ export type BatchConfigTransition = {
 export type TracingMarkerInstance = {|
   pendingBoundaries: PendingBoundaries | null,
   transitions: Set<Transition> | null,
+  deletions: Array<TransitionDeletion> | null,
+  parents: Array<TracingMarkerInstance> | null,
+  name: string | null,
+|};
+
+export type TransitionDeletion = {|
+  type: 'error' | 'unknown' | 'marker' | 'suspense',
   name?: string,
+  endTime: number,
+  transitions: Set<Transition>,
 |};
 
 export type PendingBoundaries = Map<OffscreenInstance, SuspenseInfo>;
@@ -64,6 +80,7 @@ export function processTransitionCallbacks(
       if (onMarkerProgress != null && markerProgress !== null) {
         markerProgress.forEach((markerInstance, markerName) => {
           if (markerInstance.transitions !== null) {
+            // TODO: Clone the suspense object so users can't modify it
             const pending =
               markerInstance.pendingBoundaries !== null
                 ? Array.from(markerInstance.pendingBoundaries.values())
@@ -96,6 +113,30 @@ export function processTransitionCallbacks(
         });
       }
 
+      const markerIncomplete = pendingTransitions.markerIncomplete;
+      const onMarkerIncomplete = callbacks.onMarkerIncomplete;
+      if (onMarkerIncomplete != null && markerIncomplete !== null) {
+        markerIncomplete.forEach(({transitions, deletions}, markerName) => {
+          transitions.forEach(transition => {
+            const filteredDeletions = [];
+            deletions.forEach(deletion => {
+              if (deletion.transitions.has(transition)) {
+                const filteredDeletion = getFilteredDeletion(deletion, endTime);
+                if (filteredDeletion !== null) {
+                  filteredDeletions.push(filteredDeletion);
+                }
+              }
+            });
+            onMarkerIncomplete(
+              transition.name,
+              markerName,
+              transition.startTime,
+              filteredDeletions,
+            );
+          });
+        });
+      }
+
       const transitionProgress = pendingTransitions.transitionProgress;
       const onTransitionProgress = callbacks.onTransitionProgress;
       if (onTransitionProgress != null && transitionProgress !== null) {
@@ -120,6 +161,21 @@ export function processTransitionCallbacks(
   }
 }
 
+function getFilteredDeletion(deletion: TransitionDeletion, endTime: number) {
+  switch (deletion.type) {
+    case 'marker': {
+      return {
+        type: deletion.type,
+        name: deletion.name,
+        endTime,
+      };
+    }
+    default: {
+      return null;
+    }
+  }
+}
+
 // For every tracing marker, store a pointer to it. We will later access it
 // to get the set of suspense boundaries that need to resolve before the
 // tracing marker can be logged as complete
@@ -148,6 +204,9 @@ export function pushRootMarkerInstance(workInProgress: Fiber): void {
           const markerInstance: TracingMarkerInstance = {
             transitions: new Set([transition]),
             pendingBoundaries: null,
+            deletions: null,
+            parents: null,
+            name: null,
           };
           root.incompleteTransitions.set(transition, markerInstance);
         }

packages/react-reconciler/src/ReactFiberWorkLoop.new.js

@@ -18,6 +18,7 @@ import type {
   PendingTransitionCallbacks,
   PendingBoundaries,
   Transition,
+  TransitionDeletion,
 } from './ReactFiberTracingMarkerComponent.new';
 import type {OffscreenInstance} from './ReactFiberOffscreenComponent';
 
@@ -342,6 +343,7 @@ export function addTransitionStartCallbackToPendingTransition(
         transitionProgress: null,
         transitionComplete: null,
         markerProgress: null,
+        markerIncomplete: null,
         markerComplete: null,
       };
     }
@@ -357,7 +359,7 @@ export function addTransitionStartCallbackToPendingTransition(
 export function addMarkerProgressCallbackToPendingTransition(
   markerName: string,
   transitions: Set<Transition>,
-  pendingBoundaries: PendingBoundaries | null,
+  pendingBoundaries: PendingBoundaries,
 ) {
   if (enableTransitionTracing) {
     if (currentPendingTransitionCallbacks === null) {
@@ -366,6 +368,7 @@ export function addMarkerProgressCallbackToPendingTransition(
         transitionProgress: null,
         transitionComplete: null,
         markerProgress: new Map(),
+        markerIncomplete: null,
         markerComplete: null,
       };
     }
@@ -381,6 +384,34 @@ export function addMarkerProgressCallbackToPendingTransition(
   }
 }
 
+export function addMarkerIncompleteCallbackToPendingTransition(
+  markerName: string,
+  transitions: Set<Transition>,
+  deletions: Array<TransitionDeletion>,
+) {
+  if (enableTransitionTracing) {
+    if (currentPendingTransitionCallbacks === null) {
+      currentPendingTransitionCallbacks = {
+        transitionStart: null,
+        transitionProgress: null,
+        transitionComplete: null,
+        markerProgress: null,
+        markerIncomplete: new Map(),
+        markerComplete: null,
+      };
+    }
+
+    if (currentPendingTransitionCallbacks.markerIncomplete === null) {
+      currentPendingTransitionCallbacks.markerIncomplete = new Map();
+    }
+
+    currentPendingTransitionCallbacks.markerIncomplete.set(markerName, {
+      transitions,
+      deletions,
+    });
+  }
+}
+
 export function addMarkerCompleteCallbackToPendingTransition(
   markerName: string,
   transitions: Set<Transition>,
@@ -392,6 +423,7 @@ export function addMarkerCompleteCallbackToPendingTransition(
         transitionProgress: null,
         transitionComplete: null,
         markerProgress: null,
+        markerIncomplete: null,
         markerComplete: new Map(),
       };
     }
@@ -418,6 +450,7 @@ export function addTransitionProgressCallbackToPendingTransition(
         transitionProgress: new Map(),
         transitionComplete: null,
         markerProgress: null,
+        markerIncomplete: null,
         markerComplete: null,
       };
     }
@@ -443,6 +476,7 @@ export function addTransitionCompleteCallbackToPendingTransition(
         transitionProgress: null,
         transitionComplete: [],
         markerProgress: null,
+        markerIncomplete: null,
         markerComplete: null,
       };
     }

packages/react-reconciler/src/ReactInternalTypes.js

@@ -292,7 +292,6 @@ export type TransitionTracingCallbacks = {
     deletions: Array<{
       type: string,
       name?: string,
-      newName?: string,
       endTime: number,
     }>,
   ) => void,
@@ -315,7 +314,6 @@ export type TransitionTracingCallbacks = {
     deletions: Array<{
       type: string,
       name?: string,
-      newName?: string,
       endTime: number,
     }>,
   ) => void,