@alloy-js/core 0.23.0-dev.8 → 0.23.0

package/src/reactivity.ts

@@ -9,54 +9,17 @@ import {
   computed as vueComputed,
   effect as vueEffect,
   ref as vueRef,
+  shallowReactive as vueShallowReactive,
   shallowRef as vueShallowRef,
   toRef as vueToRef,
   toRefs as vueToRefs,
 } from "@vue/reactivity";
-import {
-  captureSourceLocation,
-  debug,
-  isDevtoolsEnabled,
-} from "./debug/index.js";
+import { captureSourceLocation, debug, isDebugEnabled } from "./debug/index.js";
 import { RenderedTextTree } from "./render.js";
 import { Children, ComponentCreator } from "./runtime/component.js";
-import { scheduler } from "./scheduler.js";
+import { scheduler, setLastTriggerRef } from "./scheduler.js";
 import type { OutputSymbol } from "./symbols/output-symbol.js";
 
-function attachEffectWriteDebug(refValue: Ref<unknown>, kind: string) {
-  if (!isDevtoolsEnabled()) return;
-  const descriptor =
-    Object.getOwnPropertyDescriptor(refValue, "value") ??
-    Object.getOwnPropertyDescriptor(Object.getPrototypeOf(refValue), "value");
-  if (!descriptor?.get || !descriptor?.set) return;
-  if ((refValue as any).__alloyDebugWrapped) return;
-  Object.defineProperty(refValue, "value", {
-    get: descriptor.get,
-    set(value: unknown) {
-      descriptor.set!.call(this, value);
-      const effectId = globalContext?.meta?.effectId;
-      if (effectId !== undefined && effectId !== -1) {
-        const id = refId(refValue);
-        debug.effect.ensureRef({ id, kind });
-        debug.effect.trigger({
-          effectId,
-          target: refValue,
-          refId: id,
-          location: captureSourceLocation(),
-          kind: "trigger",
-        });
-      }
-    },
-    enumerable: descriptor.enumerable ?? true,
-    configurable: true,
-  });
-  Object.defineProperty(refValue, "__alloyDebugWrapped", {
-    value: true,
-    enumerable: false,
-    configurable: false,
-  });
-}
-
 if ((globalThis as any).__ALLOY__) {
   throw new Error(
     "Multiple versions of Alloy are loaded for this project. This will likely cause undesirable behavior.",
@@ -65,7 +28,8 @@ if ((globalThis as any).__ALLOY__) {
 (globalThis as any).__ALLOY__ = true;
 
 export function getElementCache() {
-  return getContext()!.elementCache;
+  const ctx = getContext()!;
+  return (ctx.elementCache ??= new Map());
 }
 
 export type ElementCacheKey =
@@ -79,8 +43,12 @@ export interface Disposable {
   (): void;
 }
 
+let contextIdCounter = 0;
+
 export interface Context {
-  disposables: Disposable[];
+  /** Monotonic numeric ID for trace/debug correlation. */
+  id: number;
+  disposables?: Disposable[];
   owner: Context | null;
 
   // context providers
@@ -93,7 +61,7 @@ export interface Context {
    * A cache of RenderTextTree nodes created within this context,
    * indexed by the component or function which created them.
    */
-  elementCache: ElementCache;
+  elementCache?: ElementCache;
   /**
    * When this context was created by a component, this will
    * be the component that created it.
@@ -118,9 +86,17 @@ export interface Context {
 
   /**
    * A ref that indicates whether the component is empty.
+   * Only allocated when reactively observed (ContentSlot, mapJoin).
    */
   isEmpty?: Ref<boolean>;
 
+  /**
+   * Cheap boolean tracking the last propagated empty state.
+   * Used by notifyContentState() for early-return optimization
+   * without requiring a reactive ref on every context.
+   */
+  _lastEmpty: boolean;
+
   /**
    * Whether this context is a root context
    */
@@ -132,21 +108,48 @@ export function getContext() {
   return globalContext;
 }
 
+/**
+ * Walk up the owner chain to find the nearest ancestor context that
+ * corresponds to an effect (has meta.effectId). This bridges non-effect
+ * scopes (like createRoot iterations in For) so the owner chain always
+ * connects effect-to-effect.
+ */
+function resolveOwnerEffectContextId(context: Context): number | null {
+  let owner = context.owner;
+  while (owner) {
+    if (owner.meta?.effectId !== undefined) {
+      return owner.id;
+    }
+    owner = owner.owner;
+  }
+  return context.owner?.id ?? null;
+}
+
+/**
+ * Ensure that a context has an isEmpty ref, creating one if needed.
+ * Only call this when you need to reactively observe isEmpty (e.g.,
+ * ContentSlot, mapJoin). Most contexts don't need an isEmpty ref.
+ */
+export function ensureIsEmpty(context: Context): Ref<boolean> {
+  context.isEmpty ??= ref(context.childrenWithContent === 0, {
+    isInfrastructure: true,
+  });
+  return context.isEmpty;
+}
+
 export interface RootOptions {
   componentOwner?: ComponentCreator<any>;
 }
 
 export function root<T>(fn: (d: Disposable) => T, options?: RootOptions): T {
   const context: Context = {
+    id: contextIdCounter++,
     componentOwner: options?.componentOwner,
-    disposables: [],
     owner: globalContext,
-    context: {},
-    elementCache: new Map(),
     takesSymbols: false,
     takenSymbols: undefined,
     childrenWithContent: 0,
-    isEmpty: ref(true),
+    _lastEmpty: true,
     isRoot: true,
   };
 
@@ -155,7 +158,7 @@ export function root<T>(fn: (d: Disposable) => T, options?: RootOptions): T {
   try {
     ret = untrack(() =>
       fn(() => {
-        for (const d of context!.disposables) {
+        for (const d of context!.disposables ?? []) {
           untrack(d);
         }
       }),
@@ -183,8 +186,40 @@ export function untrack<T>(fn: () => T): T {
   return v;
 }
 
-export function memo<T>(fn: () => T, equal?: boolean): () => T {
-  const o = shallowRef<T>();
+/**
+ * Walk up the context owner chain to find the nearest effect ID.
+ * Used to attribute reactive mutations to the effect that caused them.
+ */
+export function findCurrentEffectId(): number | undefined {
+  let ctx = globalContext;
+  while (ctx) {
+    const id = ctx.meta?.effectId;
+    if (id !== undefined && id !== -1) return id;
+    ctx = ctx.owner;
+  }
+  return undefined;
+}
+
+/**
+ * Returns a getter caching the result of `fn`. Re-evaluates when reactive
+ * dependencies change. See the [Reactivity docs](../../reactivity.md) for details.
+ *
+ * @param fn - Function to memoize.
+ * @param equal - Skip updates when value is unchanged.
+ * @param name - Debug label for traces.
+ * @returns A zero-argument getter returning the cached value.
+ *
+ * @example
+ * ```ts
+ * const fullName = memo(() => `${first.value} ${last.value}`);
+ * fullName(); // cached; re-evaluates when first or last changes
+ * ```
+ */
+export function memo<T>(fn: () => T, equal?: boolean, name?: string): () => T {
+  const memoLabel = name ? `memo:${name}` : "memo";
+  const o = shallowRef<T>(undefined as T, {
+    label: memoLabel,
+  });
   effect(
     (prev) => {
       const res = fn();
@@ -194,10 +229,14 @@ export function memo<T>(fn: () => T, equal?: boolean): () => T {
     },
     undefined as T,
     {
-      debug: { name: "memo" },
+      debug: { name: name ? `memo:${name}` : "memo" },
     },
   );
-  return () => o.value as T;
+  const getter = (() => o.value as T) as () => T;
+  if (name) {
+    Object.defineProperty(getter, "name", { value: name, configurable: true });
+  }
+  return getter;
 }
 
 export function effect<T>(
@@ -206,109 +245,160 @@ export function effect<T>(
   options?: EffectOptions,
 ) {
   const context: Context = {
-    context: {},
-    disposables: [] as (() => void)[],
+    id: contextIdCounter++,
     owner: globalContext,
-    elementCache: new Map(),
     takesSymbols: false,
     takenSymbols: undefined,
     childrenWithContent: 0,
+    _lastEmpty: true,
     isRoot: false,
   };
 
   const debugInfo = options?.debug;
-  const effectId = debug.effect.register({
-    name: debugInfo?.name ?? fn.name,
-    type: debugInfo?.type,
-    createdAt: captureSourceLocation(),
-  });
+  const effectId =
+    isDebugEnabled() ?
+      debug.effect.register({
+        name: debugInfo?.name ?? fn.name,
+        type: debugInfo?.type,
+        createdAt: captureSourceLocation(),
+        contextId: context.id,
+        ownerContextId: resolveOwnerEffectContextId(context),
+      })
+    : -1;
 
-  context.meta ??= {};
   if (effectId !== -1) {
+    context.meta ??= {};
     context.meta.effectId = effectId;
   }
 
   const cleanupFn = (final: boolean) => {
     const d = context.disposables;
-    context.disposables = [];
-    for (let k = 0, len = d.length; k < len; k++) untrack(d[k]);
+    context.disposables = undefined;
+    if (d) {
+      for (let k = 0, len = d.length; k < len; k++) untrack(d[k]);
+    }
 
     // eslint-disable-next-line @typescript-eslint/no-unused-expressions
     final && stop(runner);
   };
 
   onCleanup(() => cleanupFn(true));
-  const runner: ReactiveEffectRunner<void> = vueEffect(
-    () => {
-      cleanupFn(false);
-
-      const oldContext = globalContext;
-      globalContext = context;
-      try {
-        current = fn(current);
-      } finally {
-        globalContext = oldContext;
+  const effectOpts: Record<string, unknown> = {
+    // allow recursive effects with 32, 1 and 4 are default flags
+    flags: 1 | 4 | 32,
+    scheduler: scheduler(),
+  };
+
+  if (effectId !== -1) {
+    effectOpts.onTrack = (event: any) => {
+      const targetKey =
+        typeof event.key === "symbol" ? event.key.toString() : event.key;
+      if (isRef(event.target)) {
+        const id = refId(event.target);
+        debug.effect.ensureRef({ id, kind: "ref" });
+        debug.effect.track({
+          effectId,
+          target: event.target,
+          refId: id,
+          targetKey,
+        });
+      } else if (
+        typeof event.target === "object" &&
+        event.target !== null &&
+        targetKey !== undefined
+      ) {
+        const id = reactivePropertyRefId(event.target, targetKey);
+        debug.effect.ensureReactivePropertyRef({
+          id,
+          target: event.target,
+          key: targetKey,
+        });
+        debug.effect.track({
+          effectId,
+          target: event.target,
+          refId: id,
+          targetKey,
+        });
+      } else {
+        debug.effect.track({
+          effectId,
+          target: event.target,
+          targetKey,
+        });
       }
-    },
-    {
-      // allow recursive effects with 32, 1 and 4 are default flags
-      // @ts-expect-error flags is a vue internal thing
-      flags: 1 | 4 | 32,
-      scheduler: scheduler(),
-      onTrack(event) {
-        if (effectId !== -1) {
-          const targetKey =
-            typeof event.key === "symbol" ? event.key.toString() : event.key;
-          if (isRef(event.target)) {
-            const id = refId(event.target);
-            debug.effect.ensureRef({ id, kind: "ref" });
-            debug.effect.track({
-              effectId,
-              target: event.target,
-              refId: id,
-              targetKey,
-              location: captureSourceLocation(),
-            });
-          } else {
-            debug.effect.track({
-              effectId,
-              target: event.target,
-              targetKey,
-              location: captureSourceLocation(),
-            });
-          }
-        }
-        // track edge emitted via recordEffectTrack
-      },
-      onTrigger(event) {
-        if (effectId !== -1) {
-          const targetKey =
-            typeof event.key === "symbol" ? event.key.toString() : event.key;
-          if (isRef(event.target)) {
-            const id = refId(event.target);
-            debug.effect.ensureRef({ id, kind: "ref" });
-            debug.effect.trigger({
-              effectId,
-              target: event.target,
-              refId: id,
-              targetKey,
-              location: captureSourceLocation(),
-              kind: "triggered-by",
-            });
-          } else {
-            debug.effect.trigger({
-              effectId,
-              target: event.target,
-              targetKey,
-              location: captureSourceLocation(),
-              kind: "triggered-by",
-            });
-          }
-        }
-        // trigger edge emitted via recordEffectTrigger
-      },
-    },
-  );
+    };
+    effectOpts.onTrigger = (event: any) => {
+      if (!("target" in event)) {
+        // Vue Dep.notify() chain propagation — no actual reactive target.
+        // Skip recording: these are computed→subscriber notifications without
+        // a meaningful target reference.
+        return;
+      }
+      const targetKey =
+        typeof event.key === "symbol" ? event.key.toString() : event.key;
+      // findCurrentEffectId() works because onTrigger fires synchronously
+      // during the mutation, so globalContext still points to the producer.
+      const producerEffectId = findCurrentEffectId();
+      const causedBy =
+        producerEffectId !== undefined && producerEffectId !== effectId ?
+          producerEffectId
+        : undefined;
+      if (isRef(event.target)) {
+        const id = refId(event.target);
+        debug.effect.ensureRef({ id, kind: "ref" });
+        debug.effect.trigger({
+          effectId,
+          target: event.target,
+          refId: id,
+          targetKey,
+          causedBy,
+        });
+        setLastTriggerRef(effectId, id);
+      } else if (
+        typeof event.target === "object" &&
+        event.target !== null &&
+        targetKey !== undefined
+      ) {
+        const id = reactivePropertyRefId(event.target, targetKey);
+        debug.effect.ensureReactivePropertyRef({
+          id,
+          target: event.target,
+          key: targetKey,
+        });
+        debug.effect.trigger({
+          effectId,
+          target: event.target,
+          refId: id,
+          targetKey,
+          causedBy,
+        });
+        setLastTriggerRef(effectId, id);
+      } else {
+        debug.effect.trigger({
+          effectId,
+          target: event.target,
+          targetKey,
+          causedBy,
+        });
+      }
+    };
+  }
+
+  const runner: ReactiveEffectRunner<void> = vueEffect(() => {
+    cleanupFn(false);
+
+    const oldContext = globalContext;
+    globalContext = context;
+    try {
+      current = fn(current);
+    } finally {
+      globalContext = oldContext;
+    }
+  }, effectOpts as any);
+
+  if (effectId !== -1) {
+    effectIdMap.set(runner.effect, effectId);
+  }
 }
 
 /**
@@ -331,7 +421,7 @@ export function effect<T>(
  */
 export function onCleanup(fn: Disposable) {
   if (globalContext != null) {
-    globalContext.disposables.push(fn);
+    (globalContext.disposables ??= []).push(fn);
   }
 }
 
@@ -366,38 +456,69 @@ export function isCustomContext(child: Children): child is CustomContext {
   );
 }
 
-export function ref<T>(value?: T): Ref<T> {
+export function ref<T>(
+  value?: T,
+  options?: { isInfrastructure?: boolean },
+): Ref<T> {
   const result = vueRef(value) as Ref<T>;
-  attachEffectWriteDebug(result, "ref");
-  debug.effect.registerRef({
-    id: refId(result),
-    kind: "ref",
-    createdAt: captureSourceLocation(),
-    createdByEffectId: globalContext?.meta?.effectId,
-  });
+  if (isDebugEnabled()) {
+    debug.effect.registerRef({
+      id: refId(result),
+      kind: "ref",
+      createdAt: captureSourceLocation(),
+      createdByEffectId: globalContext?.meta?.effectId,
+      isInfrastructure: options?.isInfrastructure,
+    });
+  }
+  return result;
+}
+
+// Stores creation location for shallowReactive objects so registerNonRefTarget
+// can look it up later (since targets are lazily registered on first track/trigger).
+const reactiveCreationLocations = new WeakMap<
+  object,
+  ReturnType<typeof captureSourceLocation>
+>();
+
+export function getReactiveCreationLocation(target: object) {
+  return reactiveCreationLocations.get(target);
+}
+
+export function shallowReactive<T extends object>(
+  target: T,
+): ShallowReactive<T> {
+  const result = vueShallowReactive(target);
+  if (isDebugEnabled()) {
+    // Store by raw target — Vue's onTrack/onTrigger events pass the raw object, not the proxy.
+    reactiveCreationLocations.set(target, captureSourceLocation());
+  }
   return result;
 }
 
-export function shallowRef<T>(value?: T): Ref<T> {
+export function shallowRef<T>(value?: T, options?: { label?: string }): Ref<T> {
   const result = vueShallowRef(value) as Ref<T>;
-  attachEffectWriteDebug(result, "shallowRef");
-  debug.effect.registerRef({
-    id: refId(result),
-    kind: "shallowRef",
-    createdAt: captureSourceLocation(),
-    createdByEffectId: globalContext?.meta?.effectId,
-  });
+  if (isDebugEnabled()) {
+    debug.effect.registerRef({
+      id: refId(result),
+      kind: "shallowRef",
+      label: options?.label,
+      createdAt: captureSourceLocation(),
+      createdByEffectId: globalContext?.meta?.effectId,
+    });
+  }
   return result;
 }
 
 export function computed<T>(getter: () => T): Ref<T> {
   const result = vueComputed(getter) as Ref<T>;
-  debug.effect.registerRef({
-    id: refId(result),
-    kind: "computed",
-    createdAt: captureSourceLocation(),
-    createdByEffectId: globalContext?.meta?.effectId,
-  });
+  if (isDebugEnabled()) {
+    debug.effect.registerRef({
+      id: refId(result),
+      kind: "computed",
+      createdAt: captureSourceLocation(),
+      createdByEffectId: globalContext?.meta?.effectId,
+    });
+  }
   return result;
 }
 
@@ -410,13 +531,14 @@ export function toRef<T extends object, K extends keyof T>(
     defaultValue === undefined ?
       (vueToRef(object, key) as Ref<T[K]>)
     : (vueToRef(object, key, defaultValue) as Ref<T[K]>);
-  attachEffectWriteDebug(result, "toRef");
-  debug.effect.registerRef({
-    id: refId(result),
-    kind: "toRef",
-    createdAt: captureSourceLocation(),
-    createdByEffectId: globalContext?.meta?.effectId,
-  });
+  if (isDebugEnabled()) {
+    debug.effect.registerRef({
+      id: refId(result),
+      kind: "toRef",
+      createdAt: captureSourceLocation(),
+      createdByEffectId: globalContext?.meta?.effectId,
+    });
+  }
   return result;
 }
 
@@ -424,20 +546,25 @@ export function toRefs<T extends object>(
   object: T,
 ): { [K in keyof T]: Ref<T[K]> } {
   const result = vueToRefs(object) as { [K in keyof T]: Ref<T[K]> };
-  for (const refValue of Object.values(result) as Ref<unknown>[]) {
-    attachEffectWriteDebug(refValue, "toRef");
-    debug.effect.registerRef({
-      id: refId(refValue),
-      kind: "toRef",
-      createdAt: captureSourceLocation(),
-      createdByEffectId: globalContext?.meta?.effectId,
-    });
+  if (isDebugEnabled()) {
+    for (const refValue of Object.values(result) as Ref<unknown>[]) {
+      debug.effect.registerRef({
+        id: refId(refValue),
+        kind: "toRef",
+        createdAt: captureSourceLocation(),
+        createdByEffectId: globalContext?.meta?.effectId,
+      });
+    }
   }
   return result;
 }
 
 const seenRefs = new WeakMap<Ref<unknown>, number>();
 let refIdCounter = 1;
+const effectIdMap = new WeakMap<object, number>();
+
+// Stable ID mapping for (reactive, key) pairs — each property acts as a virtual ref.
+const reactivePropertyIds = new WeakMap<object, Map<string | number, number>>();
 
 export function refId(ref: Ref<unknown>): number {
   let id = seenRefs.get(ref);
@@ -447,3 +574,59 @@ export function refId(ref: Ref<unknown>): number {
   }
   return id;
 }
+
+/**
+ * Get a stable ref ID for a property of a reactive object.
+ * Each (target, key) pair gets a unique positive ID from the same counter as refs.
+ */
+export function reactivePropertyRefId(
+  target: object,
+  key: string | number,
+): number {
+  let keys = reactivePropertyIds.get(target);
+  if (!keys) {
+    keys = new Map();
+    reactivePropertyIds.set(target, keys);
+  }
+  let id = keys.get(key);
+  if (id === undefined) {
+    id = refIdCounter++;
+    keys.set(key, id);
+  }
+  return id;
+}
+
+/**
+ * Build a human-readable label for a reactive property like `symbolName.prop`.
+ */
+export function formatReactivePropertyLabel(
+  target: object,
+  key: string | number,
+): string {
+  let ownerLabel: string;
+  try {
+    const str = String(target);
+    // OutputSymbol toString() returns something like: TSOutputSymbol "MyInterface"[42]
+    // Trim to just the meaningful part
+    ownerLabel = str.length > 60 ? str.slice(0, 57) + "..." : str;
+  } catch {
+    ownerLabel = "reactive";
+  }
+  if (Array.isArray(target)) {
+    ownerLabel = "[]";
+  }
+  return `${ownerLabel}.${key}`;
+}
+
+/** Allocate a unique reactive target ID from the same counter space as ref IDs. */
+export function nextReactiveId(): number {
+  return refIdCounter++;
+}
+
+export function resetRefIdCounter(): void {
+  refIdCounter = 1;
+}
+
+export function getEffectDebugId(effect: object): number | undefined {
+  return effectIdMap.get(effect);
+}