bippy 0.7.2 → 0.7.3-dev.0c7e504

package/src/core.ts

@@ -10,19 +10,20 @@ import type {
 } from "./react-internals/index.js";
 
 import {
-  _onActiveListeners,
   BIPPY_INSTRUMENTATION_STRING,
   createUnsubscribe,
   getRDTHook,
   hasRDTHook,
+  isFiberRootUnmounted,
   isReactRefresh,
   isRealReactDevtools,
   onRDTHookReplace,
+  removeActiveListener,
 } from "./rdt-hook.js";
-import type { Unsubscribe } from "./rdt-hook.js";
+import type { ReactDevToolsTarget, Unsubscribe } from "./rdt-hook.js";
+import { getCurrentFiberFromRoot } from "./react-internals/current-fiber.js";
 import {
   getReactWorkTagsForFiber,
-  MutationMask,
   ReactBuildType,
   ReactFiberFlags,
   ReactSymbols,
@@ -64,8 +65,8 @@ export const isValidElement = (element: unknown): element is React.ReactElement
   typeof element === "object" &&
   element !== null &&
   "$$typeof" in element &&
-  (String(element.$$typeof) === ReactSymbols.LEGACY_ELEMENT_SYMBOL_STRING ||
-    String(element.$$typeof) === ReactSymbols.ELEMENT_SYMBOL_STRING);
+  (element.$$typeof === Symbol.for("react.element") ||
+    element.$$typeof === Symbol.for("react.transitional.element"));
 
 /**
  * Returns `true` if object is a React Fiber.
@@ -78,7 +79,7 @@ export const isFiber = (fiber: unknown): fiber is Fiber =>
   "return" in fiber &&
   "child" in fiber &&
   "sibling" in fiber &&
-  "flags" in fiber;
+  ("flags" in fiber || "effectTag" in fiber);
 
 const isFiberRoot = (fiberRoot: unknown): fiberRoot is FiberRoot =>
   typeof fiberRoot === "object" &&
@@ -128,7 +129,7 @@ export const isCompositeFiber = (fiber: Fiber): boolean => {
  */
 export const didFiberRender = (fiber: Fiber): boolean => {
   const nextProps = fiber.memoizedProps;
-  const prevProps = fiber.alternate?.memoizedProps || {};
+  const prevProps = fiber.alternate?.memoizedProps;
   const flags = fiber.flags ?? fiber.effectTag ?? 0;
   const workTags = getReactWorkTagsForFiber(fiber);
 
@@ -152,16 +153,6 @@ export const didFiberRender = (fiber: Fiber): boolean => {
   }
 };
 
-/**
- * Returns `true` if the {@link Fiber} has committed. Note that this does not mean the fiber has committed in the current commit, just that it has committed in the past.
- */
-export const didFiberCommit = (fiber: Fiber): boolean => {
-  return Boolean(
-    (fiber.flags & (MutationMask | ReactFiberFlags.Cloned)) !== 0 ||
-    (fiber.subtreeFlags & (MutationMask | ReactFiberFlags.Cloned)) !== 0,
-  );
-};
-
 /**
  * Returns `true` if the {@link Fiber} should be filtered out during reconciliation.
  */
@@ -210,41 +201,57 @@ const shouldFilterFiber = (fiber: Fiber): boolean => {
   }
 };
 
+interface TraverseFiber {
+  (
+    fiber: Fiber | null,
+    selector: (node: Fiber) => boolean | void,
+    ascending?: boolean,
+  ): Fiber | null;
+  (
+    fiber: Fiber | null,
+    selector: (node: Fiber) => Promise<boolean | void>,
+    ascending?: boolean,
+  ): Promise<Fiber | null>;
+  (
+    fiber: Fiber | null,
+    selector: FiberSelector,
+    ascending?: boolean,
+  ): Fiber | null | Promise<Fiber | null>;
+}
+
 /**
  * Traverses up or down a {@link Fiber}, return `true` to stop and select a node.
  */
-export function traverseFiber(
-  fiber: Fiber | null,
-  selector: (node: Fiber) => boolean | void,
-  ascending?: boolean,
-): Fiber | null;
-export function traverseFiber(
-  fiber: Fiber | null,
-  selector: (node: Fiber) => Promise<boolean | void>,
-  ascending?: boolean,
-): Promise<Fiber | null>;
-export function traverseFiber(
-  fiber: Fiber | null,
-  selector: FiberSelector,
-  ascending?: boolean,
-): Fiber | null | Promise<Fiber | null>;
-export function traverseFiber(
+export const traverseFiber = ((
   fiber: Fiber | null,
   selector: FiberSelector,
   ascending = false,
-): Fiber | null | Promise<Fiber | null> {
-  if (!fiber) return null;
-
-  const selection = selector(fiber);
-  if (isPromiseLike<boolean | void>(selection)) {
-    return Promise.resolve(selection).then((didSelectFiber) =>
-      didSelectFiber === true ? fiber : traverseFiberChildren(fiber, selector, ascending),
-    );
-  }
-  if (selection === true) return fiber;
-
-  return traverseFiberChildren(fiber, selector, ascending);
-}
+): Fiber | null | Promise<Fiber | null> => {
+  const pendingSiblings: Fiber[] = [];
+  const getNextFiber = (currentFiber: Fiber): Fiber | null => {
+    if (ascending) return currentFiber.return;
+    if (currentFiber !== fiber && currentFiber.sibling) {
+      pendingSiblings.push(currentFiber.sibling);
+    }
+    return currentFiber.child ?? pendingSiblings.pop() ?? null;
+  };
+  const visit = (firstFiber: Fiber | null): Fiber | null | Promise<Fiber | null> => {
+    let currentFiber = firstFiber;
+    while (currentFiber) {
+      const selectedFiber = currentFiber;
+      const selection = selector(selectedFiber);
+      if (isPromiseLike<boolean | void>(selection)) {
+        return Promise.resolve(selection).then((didSelectFiber) =>
+          didSelectFiber === true ? selectedFiber : visit(getNextFiber(selectedFiber)),
+        );
+      }
+      if (selection === true) return selectedFiber;
+      currentFiber = getNextFiber(selectedFiber);
+    }
+    return null;
+  };
+  return visit(fiber);
+}) as TraverseFiber;
 
 const isPromiseLike = <Result>(value: unknown): value is PromiseLike<Result> =>
   (typeof value === "object" || typeof value === "function") &&
@@ -252,32 +259,6 @@ const isPromiseLike = <Result>(value: unknown): value is PromiseLike<Result> =>
   "then" in value &&
   typeof value.then === "function";
 
-const traverseFiberChildren = (
-  fiber: Fiber,
-  selector: FiberSelector,
-  ascending: boolean,
-): Fiber | null | Promise<Fiber | null> => {
-  const firstChild = ascending ? fiber.return : fiber.child;
-  return traverseFiberSiblings(firstChild, selector, ascending);
-};
-
-const traverseFiberSiblings = (
-  fiber: Fiber | null,
-  selector: FiberSelector,
-  ascending: boolean,
-): Fiber | null | Promise<Fiber | null> => {
-  if (!fiber) return null;
-
-  const nextSibling = ascending ? null : fiber.sibling;
-  const match = traverseFiber(fiber, selector, ascending);
-  if (isPromiseLike<Fiber | null>(match)) {
-    return Promise.resolve(match).then(
-      (resolvedMatch) => resolvedMatch ?? traverseFiberSiblings(nextSibling, selector, ascending),
-    );
-  }
-  return match ?? traverseFiberSiblings(nextSibling, selector, ascending);
-};
-
 /**
  * Returns `true` if the {@link Fiber} uses React Compiler's memo cache.
  */
@@ -291,7 +272,14 @@ export const hasMemoCache = (fiber: Fiber): boolean => {
 export const getType = (type: unknown): null | React.ComponentType<unknown> => {
   if (isComponentType(type)) return type;
   if (typeof type !== "object" || type === null) return null;
-  return getType(Reflect.get(type, "type") ?? Reflect.get(type, "render"));
+  const visitedTypes = new Set<object>();
+  let currentType: unknown = type;
+  while (typeof currentType === "object" && currentType !== null) {
+    if (visitedTypes.has(currentType)) return null;
+    visitedTypes.add(currentType);
+    currentType = Reflect.get(currentType, "type") ?? Reflect.get(currentType, "render");
+  }
+  return isComponentType(currentType) ? currentType : null;
 };
 
 /**
@@ -312,10 +300,7 @@ export const getDisplayName = (type: unknown): null | string => {
  */
 export const detectReactBuildType = (renderer: ReactRenderer): "development" | "production" => {
   try {
-    if (
-      typeof renderer.version === "string" &&
-      renderer.bundleType === ReactBuildType.Development
-    ) {
+    if (typeof renderer.version === "string" && renderer.bundleType > ReactBuildType.Production) {
       return "development";
     }
   } catch {}
@@ -325,8 +310,8 @@ export const detectReactBuildType = (renderer: ReactRenderer): "development" | "
 /**
  * Returns `true` if bippy's instrumentation is active.
  */
-export const isInstrumentationActive = (): boolean => {
-  const rdtHook = globalThis.__REACT_DEVTOOLS_GLOBAL_HOOK__;
+export const isInstrumentationActive = (target: ReactDevToolsTarget = globalThis): boolean => {
+  const rdtHook = target.__REACT_DEVTOOLS_GLOBAL_HOOK__;
   return (
     Boolean(rdtHook?._instrumentationIsActive) ||
     isRealReactDevtools(rdtHook) ||
@@ -336,6 +321,7 @@ export const isInstrumentationActive = (): boolean => {
 
 export const _fiberRoots = new Set<FiberRoot>();
 const rootRendererIds = new WeakMap<FiberRoot, number>();
+const rootHooks = new WeakMap<FiberRoot, ReactDevToolsGlobalHook>();
 
 /**
  * Returns the latest fiber (since it may be double-buffered).
@@ -343,6 +329,8 @@ const rootRendererIds = new WeakMap<FiberRoot, number>();
 export const getLatestFiber = (fiber: Fiber): Fiber => {
   const alternate = fiber.alternate;
   if (!alternate) return fiber;
+  const currentFiber = getCurrentFiberFromRoot(fiber);
+  if (currentFiber) return currentFiber;
 
   let rootFiber = fiber;
   while (rootFiber.return) {
@@ -370,29 +358,61 @@ export const getLatestFiber = (fiber: Fiber): Fiber => {
 /**
  * Returns the renderer that owns the {@link Fiber}.
  */
-export const getRenderer = (fiber: Fiber): ReactRenderer | null => {
-  if (!hasRDTHook()) return null;
-
+export const getRenderer = (
+  fiber: Fiber,
+  target: ReactDevToolsTarget = globalThis,
+): ReactRenderer | null => {
   let rootFiber = fiber;
-  while (rootFiber.return) {
-    rootFiber = rootFiber.return;
-  }
-
+  while (rootFiber.return) rootFiber = rootFiber.return;
   const fiberRoot = rootFiber.stateNode;
   if (!isFiberRoot(fiberRoot)) return null;
 
-  const rendererID = rootRendererIds.get(fiberRoot);
-  if (rendererID === undefined) return null;
-  return getRDTHook().renderers.get(rendererID) ?? null;
+  const trackedRendererId = rootRendererIds.get(fiberRoot);
+  const trackedHook = rootHooks.get(fiberRoot);
+  if (trackedRendererId !== undefined && trackedHook) {
+    return trackedHook.renderers.get(trackedRendererId) ?? null;
+  }
+
+  const rdtHook = target.__REACT_DEVTOOLS_GLOBAL_HOOK__;
+  if (!rdtHook?.getFiberRoots) return null;
+  for (const [rendererId, renderer] of rdtHook.renderers) {
+    if (!rdtHook.getFiberRoots(rendererId).has(fiberRoot)) continue;
+    _fiberRoots.add(fiberRoot);
+    rootRendererIds.set(fiberRoot, rendererId);
+    rootHooks.set(fiberRoot, rdtHook);
+    setReactWorkTagsForFiber(fiberRoot.current, renderer);
+    return renderer;
+  }
+  return null;
 };
 
 export type RenderPhase = "mount" | "unmount" | "update";
 
+interface FiberReference {
+  deref: () => Fiber | undefined;
+}
+
 let nextFiberId = 0;
 const fiberIdMap = new WeakMap<Fiber, number>();
+const fiberByIdMap = new Map<number, FiberReference>();
+const fiberIdFinalizationRegistry =
+  typeof FinalizationRegistry === "function"
+    ? new FinalizationRegistry<number>((fiberId) => {
+        if (!fiberByIdMap.get(fiberId)?.deref()) fiberByIdMap.delete(fiberId);
+      })
+    : null;
+
+const createFiberReference = (fiber: Fiber): FiberReference =>
+  typeof WeakRef === "function" ? new WeakRef(fiber) : { deref: () => fiber };
 
 export const setFiberId = (fiber: Fiber, fiberId: number = nextFiberId++): void => {
+  const previousFiberId = fiberIdMap.get(fiber);
+  if (previousFiberId !== undefined && previousFiberId !== fiberId) {
+    fiberByIdMap.delete(previousFiberId);
+  }
   fiberIdMap.set(fiber, fiberId);
+  fiberByIdMap.set(fiberId, createFiberReference(fiber));
+  fiberIdFinalizationRegistry?.register(fiber, fiberId);
   if (Number.isSafeInteger(fiberId) && fiberId >= nextFiberId) {
     nextFiberId = fiberId + 1;
   }
@@ -402,6 +422,7 @@ export const getFiberId = (fiber: Fiber): number => {
   let currentFiberId = fiberIdMap.get(fiber);
   if (currentFiberId === undefined && fiber.alternate) {
     currentFiberId = fiberIdMap.get(fiber.alternate);
+    if (currentFiberId !== undefined) setFiberId(fiber, currentFiberId);
   }
   if (currentFiberId === undefined) {
     currentFiberId = nextFiberId++;
@@ -410,6 +431,33 @@ export const getFiberId = (fiber: Fiber): number => {
   return currentFiberId;
 };
 
+export const getFiberById = (fiberId: number): Fiber | null => {
+  const fiber = fiberByIdMap.get(fiberId)?.deref();
+  if (!fiber) {
+    fiberByIdMap.delete(fiberId);
+    return null;
+  }
+  return getLatestFiber(fiber);
+};
+
+const releaseFiberId = (fiber: Fiber): void => {
+  const relatedFibers = fiber.alternate ? [fiber, fiber.alternate] : [fiber];
+  const fiberIds = new Set<number>();
+
+  for (const relatedFiber of relatedFibers) {
+    const fiberId = fiberIdMap.get(relatedFiber);
+    if (fiberId !== undefined) fiberIds.add(fiberId);
+    fiberIdMap.delete(relatedFiber);
+  }
+
+  for (const fiberId of fiberIds) {
+    const assignedFiber = fiberByIdMap.get(fiberId)?.deref();
+    if (!assignedFiber || relatedFibers.includes(assignedFiber)) {
+      fiberByIdMap.delete(fiberId);
+    }
+  }
+};
+
 const mountFiberRecursively = (
   onRender: RenderHandler,
   firstChild: Fiber,
@@ -435,13 +483,13 @@ const mountFiberRecursively = (
         if (fallbackChildFragment) {
           const fallbackChild = fallbackChildFragment.child;
           if (fallbackChild !== null) {
-            mountFiberRecursively(onRender, fallbackChild, false);
+            mountFiberRecursively(onRender, fallbackChild, true);
           }
         }
       } else {
         const primaryChild = fiber.child?.child ?? null;
         if (primaryChild !== null) {
-          mountFiberRecursively(onRender, primaryChild, false);
+          mountFiberRecursively(onRender, primaryChild, true);
         }
       }
     } else if (fiber.child !== null) {
@@ -635,6 +683,7 @@ export const traverseRenderedFibers = (root: Fiber | FiberRoot, onRender: Render
 
 export interface InstrumentationOptions {
   name?: string;
+  target?: ReactDevToolsTarget;
   onActive?: () => unknown;
   onCommitFiberRoot?: (
     rendererID: number,
@@ -649,6 +698,7 @@ export interface InstrumentationOptions {
 
 interface InstrumentationSubscription {
   options: InstrumentationOptions;
+  target: ReactDevToolsTarget;
 }
 
 const instrumentationSubscriptions = new Set<InstrumentationSubscription>();
@@ -661,6 +711,7 @@ interface HookDispatchers {
 }
 
 const hookDispatchers = new WeakMap<ReactDevToolsGlobalHook, Partial<HookDispatchers>>();
+const hookTargets = new WeakMap<ReactDevToolsGlobalHook, ReactDevToolsTarget>();
 let didSubscribeToHookReplacements = false;
 
 // each hook event is dispatched from a single re-installable wrapper. If
@@ -690,20 +741,17 @@ const setHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
       setReactWorkTagsForFiber(root.current, rdtHook.renderers.get(rendererID));
       // Custom renderers and test harnesses commit roots without a memoizedState;
       // those must stay tracked, so only explicit unmount evidence removes a root.
-      const rootMemoizedState = root.current.memoizedState;
-      const isUnmounting =
-        rootMemoizedState === null ||
-        (rootMemoizedState !== undefined &&
-          (rootMemoizedState.element === null || rootMemoizedState.element === undefined));
-      if (isUnmounting) {
+      if (isFiberRootUnmounted(root)) {
         _fiberRoots.delete(root);
         rootRendererIds.delete(root);
+        rootHooks.delete(root);
       } else {
         _fiberRoots.add(root);
         rootRendererIds.set(root, rendererID);
+        rootHooks.set(root, rdtHook);
       }
-      for (const { options } of instrumentationSubscriptions) {
-        if (options.onCommitFiberRoot) {
+      for (const { options, target } of instrumentationSubscriptions) {
+        if (target === hookTargets.get(rdtHook) && options.onCommitFiberRoot) {
           options.onCommitFiberRoot(rendererID, root, priority, didError);
         }
       }
@@ -728,10 +776,14 @@ const setHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
       if (hookDispatchers.get(rdtHook)?.onCommitFiberUnmount !== dispatchCommitFiberUnmount) {
         return;
       }
-      for (const { options } of instrumentationSubscriptions) {
-        if (options.onCommitFiberUnmount) {
-          options.onCommitFiberUnmount(rendererID, fiber);
+      try {
+        for (const { options, target } of instrumentationSubscriptions) {
+          if (target === hookTargets.get(rdtHook) && options.onCommitFiberUnmount) {
+            options.onCommitFiberUnmount(rendererID, fiber);
+          }
         }
+      } finally {
+        releaseFiberId(fiber);
       }
     };
     dispatchers.onCommitFiberUnmount = dispatchCommitFiberUnmount;
@@ -753,8 +805,8 @@ const setHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
       if (hookDispatchers.get(rdtHook)?.onPostCommitFiberRoot !== dispatchPostCommitFiberRoot) {
         return;
       }
-      for (const { options } of instrumentationSubscriptions) {
-        if (options.onPostCommitFiberRoot) {
+      for (const { options, target } of instrumentationSubscriptions) {
+        if (target === hookTargets.get(rdtHook) && options.onPostCommitFiberRoot) {
           options.onPostCommitFiberRoot(rendererID, root);
         }
       }
@@ -777,8 +829,8 @@ const setHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
         prevOnScheduleFiberRoot.call(rdtHook, rendererID, root, children);
       }
       if (hookDispatchers.get(rdtHook)?.onScheduleFiberRoot !== dispatchScheduleFiberRoot) return;
-      for (const { options } of instrumentationSubscriptions) {
-        if (options.onScheduleFiberRoot) {
+      for (const { options, target } of instrumentationSubscriptions) {
+        if (target === hookTargets.get(rdtHook) && options.onScheduleFiberRoot) {
           options.onScheduleFiberRoot(rendererID, root, children);
         }
       }
@@ -788,11 +840,23 @@ const setHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
   }
 };
 
-const wireHookEventDispatchers = (rdtHook: ReactDevToolsGlobalHook): void => {
+const handleHookReplacement = (
+  rdtHook: ReactDevToolsGlobalHook,
+  target: ReactDevToolsTarget,
+): void => {
+  hookTargets.set(rdtHook, target);
+  setHookEventDispatchers(rdtHook);
+};
+
+const wireHookEventDispatchers = (
+  rdtHook: ReactDevToolsGlobalHook,
+  target: ReactDevToolsTarget = globalThis,
+): void => {
   if (!didSubscribeToHookReplacements) {
-    onRDTHookReplace(setHookEventDispatchers);
+    onRDTHookReplace(handleHookReplacement);
     didSubscribeToHookReplacements = true;
   }
+  hookTargets.set(rdtHook, target);
   setHookEventDispatchers(rdtHook);
 };
 
@@ -822,15 +886,16 @@ try {
  * unsubscribe();
  */
 export const instrument = (options: InstrumentationOptions): Unsubscribe => {
-  const rdtHook = getRDTHook(options.onActive);
+  const target = options.target ?? globalThis;
+  const rdtHook = getRDTHook(options.onActive, target);
   rdtHook._instrumentationSource = options.name ?? BIPPY_INSTRUMENTATION_STRING;
 
-  wireHookEventDispatchers(rdtHook);
-  const subscription: InstrumentationSubscription = { options };
+  wireHookEventDispatchers(rdtHook, target);
+  const subscription: InstrumentationSubscription = { options, target };
   instrumentationSubscriptions.add(subscription);
 
   return createUnsubscribe(() => {
-    if (options.onActive) _onActiveListeners.delete(options.onActive);
+    if (options.onActive) removeActiveListener(options.onActive, target);
     instrumentationSubscriptions.delete(subscription);
   });
 };
@@ -874,9 +939,12 @@ const getPublicHostInstance = (stateNode: unknown): unknown => {
   return typeof nativeTag === "number" ? nativeTag : stateNode;
 };
 
-export const getFiber = <T>(hostInstance: T): Fiber | null => {
-  const rdtHook = globalThis.__REACT_DEVTOOLS_GLOBAL_HOOK__;
-  if (rdtHook?.renderers) {
+export const getFiber = <HostInstance>(
+  hostInstance: HostInstance,
+  target: ReactDevToolsTarget = globalThis,
+): Fiber | null => {
+  const rdtHook = target.__REACT_DEVTOOLS_GLOBAL_HOOK__;
+  if (rdtHook) {
     for (const renderer of rdtHook.renderers.values()) {
       try {
         const fiber = renderer.findFiberByHostInstance?.(hostInstance);
@@ -899,19 +967,31 @@ export const getFiber = <T>(hostInstance: T): Fiber | null => {
 
     for (const key of Object.keys(hostInstance)) {
       if (isFiberPropertyKey(key)) {
-        knownFiberPropertyKeys.add(key);
         const fiber = Reflect.get(hostInstance, key);
-        if (isFiber(fiber)) return fiber;
+        if (isFiber(fiber)) {
+          knownFiberPropertyKeys.add(key);
+          return fiber;
+        }
       }
     }
   }
 
   if (
     hostInstance !== null &&
-    hostInstance !== undefined &&
     (typeof hostInstance === "object" || typeof hostInstance === "number")
   ) {
+    const targetFiberRoots = new Set<FiberRoot>();
+    if (rdtHook?.getFiberRoots) {
+      for (const rendererId of rdtHook.renderers.keys()) {
+        for (const fiberRoot of rdtHook.getFiberRoots(rendererId)) {
+          targetFiberRoots.add(fiberRoot);
+        }
+      }
+    }
     for (const fiberRoot of _fiberRoots) {
+      if (rootHooks.get(fiberRoot) === rdtHook) targetFiberRoots.add(fiberRoot);
+    }
+    for (const fiberRoot of targetFiberRoots) {
       const fiber = traverseFiber(
         fiberRoot.current,
         (candidateFiber) =>
@@ -928,16 +1008,16 @@ export const getFiberFromHostInstance = getFiber;
 
 export {
   BIPPY_INSTRUMENTATION_STRING,
-  _onActiveListeners,
   _renderers,
   getRDTHook,
   hasRDTHook,
   installRDTHook,
+  isFiberRootUnmounted,
   isReactRefresh,
   isRealReactDevtools,
   onRendererInject,
   patchRDTHook,
   version,
 } from "./rdt-hook.js";
-export type { Unsubscribe } from "./rdt-hook.js";
+export type { ReactDevToolsTarget, Unsubscribe } from "./rdt-hook.js";
 export * from "./react-internals/index.js";