@alloy-js/core 0.23.0-dev.1 → 0.23.0-dev.10

package/src/reactivity.ts

@@ -2,21 +2,28 @@ import {
   isRef,
   pauseTracking,
   ReactiveEffectRunner,
-  ref,
   Ref,
   resetTracking,
   ShallowReactive,
-  shallowRef,
   stop,
+  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 type { RenderedTextTree } from "./render.js";
-import type { Children, ComponentCreator } from "./runtime/component.js";
+import {
+  captureSourceLocation,
+  debug,
+  isDevtoolsEnabled,
+} from "./debug/index.js";
+import { RenderedTextTree } from "./render.js";
+import { Children, ComponentCreator } from "./runtime/component.js";
 import { scheduler } from "./scheduler.js";
 import type { OutputSymbol } from "./symbols/output-symbol.js";
-import { trace, TracePhase } from "./tracer.js";
 
-// check for multiple versions of alloy here.
 if ((globalThis as any).__ALLOY__) {
   throw new Error(
     "Multiple versions of Alloy are loaded for this project. This will likely cause undesirable behavior.",
@@ -25,7 +32,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 =
@@ -39,8 +47,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
@@ -53,7 +65,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.
@@ -78,9 +90,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
    */
@@ -92,21 +112,46 @@ 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);
+  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,
   };
 
@@ -115,8 +160,8 @@ export function root<T>(fn: (d: Disposable) => T, options?: RootOptions): T {
   try {
     ret = untrack(() =>
       fn(() => {
-        for (const d of context!.disposables) {
-          d();
+        for (const d of context!.disposables ?? []) {
+          untrack(d);
         }
       }),
     );
@@ -127,6 +172,15 @@ export function root<T>(fn: (d: Disposable) => T, options?: RootOptions): T {
   return ret;
 }
 
+export interface EffectDebugOptions {
+  name?: string;
+  type?: string;
+}
+
+export interface EffectOptions {
+  debug?: EffectDebugOptions;
+}
+
 export function untrack<T>(fn: () => T): T {
   pauseTracking();
   const v = fn();
@@ -134,68 +188,148 @@ export function untrack<T>(fn: () => T): T {
   return v;
 }
 
-export function memo<T>(fn: () => T, equal?: boolean): () => T {
-  const o = shallowRef();
-  effect((prev) => {
-    const res = fn();
-    // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-    (!equal || prev !== res) && (o.value = res);
-    return res;
-  }, undefined as T);
-  return () => o.value;
+/**
+ * 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;
 }
 
-export function effect<T>(fn: (prev?: T) => T, current?: T) {
+export function memo<T>(fn: () => T, equal?: boolean, name?: string): () => T {
+  const o = shallowRef<T>();
+  effect(
+    (prev) => {
+      const res = fn();
+      // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+      (!equal || prev !== res) && (o.value = res);
+      return res;
+    },
+    undefined as T,
+    {
+      debug: { name: name ? `memo:${name}` : "memo" },
+    },
+  );
+  const getter = (() => o.value as T) as () => T;
+  if (name) {
+    Object.defineProperty(getter, "name", { value: name, configurable: true });
+  }
+  return getter;
+}
+
+export function effect<T>(
+  fn: (prev?: T) => T,
+  current?: 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(),
+    contextId: context.id,
+    ownerContextId: resolveOwnerEffectContextId(context),
+  });
+
+  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++) 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 {
+        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) {
-        trace(TracePhase.effect.track, () => {
-          return `tracking ${isRef(event.target) ? `Ref:${refId(event.target)}` : event.target}, ${String(event.key)}`;
+    };
+    effectOpts.onTrigger = (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.trigger({
+          effectId,
+          target: event.target,
+          refId: id,
+          targetKey,
+          kind: "triggered-by",
         });
-      },
-      onTrigger(event) {
-        trace(TracePhase.effect.trigger, () => {
-          return `triggering ${isRef(event.target) ? `Ref:${refId(event.target)}` : event.target}, ${String(event.key)}`;
+      } else {
+        debug.effect.trigger({
+          effectId,
+          target: event.target,
+          targetKey,
+          kind: "triggered-by",
         });
-      },
-    },
-  );
+      }
+    };
+  }
+
+  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);
+  }
 }
 
 /**
@@ -218,7 +352,7 @@ export function effect<T>(fn: (prev?: T) => T, current?: T) {
  */
 export function onCleanup(fn: Disposable) {
   if (globalContext != null) {
-    globalContext.disposables.push(fn);
+    (globalContext.disposables ??= []).push(fn);
   }
 }
 
@@ -253,14 +387,122 @@ export function isCustomContext(child: Children): child is CustomContext {
   );
 }
 
+export function ref<T>(
+  value?: T,
+  options?: { isInfrastructure?: boolean },
+): Ref<T> {
+  const result = vueRef(value) as Ref<T>;
+  debug.effect.registerRef({
+    id: refId(result, options?.isInfrastructure),
+    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 (isDevtoolsEnabled()) {
+    // 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> {
+  const result = vueShallowRef(value) as Ref<T>;
+  debug.effect.registerRef({
+    id: refId(result),
+    kind: "shallowRef",
+    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,
+  });
+  return result;
+}
+
+export function toRef<T extends object, K extends keyof T>(
+  object: T,
+  key: K,
+  defaultValue?: T[K],
+): Ref<T[K]> {
+  const result =
+    defaultValue === undefined ?
+      (vueToRef(object, key) as Ref<T[K]>)
+    : (vueToRef(object, key, defaultValue) as Ref<T[K]>);
+  debug.effect.registerRef({
+    id: refId(result),
+    kind: "toRef",
+    createdAt: captureSourceLocation(),
+    createdByEffectId: globalContext?.meta?.effectId,
+  });
+  return result;
+}
+
+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>[]) {
+    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;
+let infraRefIdCounter = -1;
+const effectIdMap = new WeakMap<object, number>();
 
-export function refId(ref: Ref<unknown>): number {
+export function refId(ref: Ref<unknown>, isInfrastructure?: boolean): number {
   let id = seenRefs.get(ref);
   if (id === undefined) {
-    id = refIdCounter++;
+    id = isInfrastructure ? infraRefIdCounter-- : refIdCounter++;
     seenRefs.set(ref, id);
   }
   return id;
 }
+
+/** 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;
+  infraRefIdCounter = -1;
+}
+
+export function getEffectDebugId(effect: object): number | undefined {
+  return effectIdMap.get(effect);
+}

package/src/render-stack.ts

@@ -13,6 +13,14 @@ const renderStack: Array<{
   source?: SourceLocation;
 }> = [];
 
+export interface RenderStackSnapshotEntry {
+  component: Component<any>;
+  props: Props;
+  context: Context | null;
+  source?: SourceLocation;
+  displayName: string;
+}
+
 export function pushStack(
   component: Component<any>,
   props: Props,
@@ -25,10 +33,51 @@ export function popStack() {
   renderStack.pop();
 }
 
+export function currentComponentName(): string | undefined {
+  const entry = renderStack[renderStack.length - 1];
+  return entry?.component.name || undefined;
+}
+
 export function clearRenderStack() {
   renderStack.length = 0;
 }
 
+/**
+ * Get the current rendering path from the render stack context.
+ * Prefers SourceFileContext over SourceDirectoryContext.
+ */
+export function getCurrentRenderPath(): string | undefined {
+  let currentPath: string | undefined;
+  for (let i = renderStack.length - 1; i >= 0; i--) {
+    const { context } = renderStack[i];
+    // Prefer SourceFileContext over SourceDirectoryContext
+    if (context?.context?.[SourceFileContext.id]) {
+      const fileContext = context.context[
+        SourceFileContext.id
+      ] as SourceFileContext;
+      return fileContext.path;
+    }
+    if (!currentPath && context?.context?.[SourceDirectoryContext.id]) {
+      const dirContext = context.context[
+        SourceDirectoryContext.id
+      ] as SourceDirectoryContext;
+      currentPath = dirContext.path;
+      // Don't break - keep looking for a SourceFileContext
+    }
+  }
+  return currentPath;
+}
+
+export function getRenderStackSnapshot(): RenderStackSnapshotEntry[] {
+  return renderStack.map((entry) => ({
+    component: entry.component,
+    props: entry.props,
+    context: entry.context,
+    source: entry.source,
+    displayName: getComponentDisplayName(entry.component, entry.props),
+  }));
+}
+
 // Helper functions
 function getComponentDisplayName(
   component: Component<any>,
@@ -93,8 +142,10 @@ function formatSourceLocation(source: SourceLocation): string {
  * This differs from debug.component.stack in that this uses a purpose-built
  * stack rather than walking the context chain. When this is called, the context
  * chain has been restored. In the future this can probably be unified nicely.
+ *
+ * @param error - Optional error to print the stack trace from
  */
-export function printRenderStack() {
+export function printRenderStack(error?: unknown) {
   // Find the nearest SourceFileContext or SourceDirectoryContext from the render stack
   let currentPath: string | undefined;
   for (let i = renderStack.length - 1; i >= 0; i--) {
@@ -124,6 +175,27 @@ export function printRenderStack() {
     console.error(pc.red("Error rendering:"));
   }
 
+  // Print the error message and stack if provided
+  if (error) {
+    if (error instanceof Error) {
+      // eslint-disable-next-line no-console
+      console.error(pc.red(`  ${error.message}`));
+      if (error.stack) {
+        // Print stack lines (skip the first line which is the error message)
+        const stackLines = error.stack.split("\n").slice(1);
+        for (const line of stackLines) {
+          // eslint-disable-next-line no-console
+          console.error(pc.gray(line));
+        }
+      }
+    } else {
+      // eslint-disable-next-line no-console
+      console.error(pc.red(`  ${String(error)}`));
+    }
+    // eslint-disable-next-line no-console
+    console.error(); // Empty line before component stack
+  }
+
   // First pass: determine which providers should be nested vs standalone
   // A provider should be nested under its parent if it's from a different file
   // (i.e., it's part of the component's implementation, not user-provided)