@solidjs/signals 2.0.0-rc.1 → 2.0.0-rc.10

package/dist/observe/core/owner.js

@@ -0,0 +1,353 @@
+import { REACTIVE_DISPOSED, CONFIG_CHILD_COMPANIONS, STATUS_PENDING, CONFIG_AUTO_DISPOSE, REACTIVE_ZOMBIE, REACTIVE_IN_HEAP, REACTIVE_IN_HEAP_HEIGHT, CONFIG_TRANSPARENT, defaultContext } from "./constants.js";
+
+import { context, runWithOwner, pendingCheckActive, latestReadActive, tracking } from "./core.js";
+
+import { unregisterRoot, registerRoot } from "./dev.js";
+
+import { clearDeps, unobserved } from "./graph.js";
+
+import { deleteFromHeap, queueFor, insertIntoHeap, insertIntoHeapHeight } from "./heap.js";
+
+import { GlobalQueue, wokenTransitions, schedule, zombieQueue, dirtyQueue, globalQueue } from "./scheduler.js";
+
+const PENDING_OWNER = {};
+
+ // Dummy owner to trigger store's read() path
+function markDisposal(e) {
+    let n = e._n;
+    while (n) {
+        const e = n.oe;
+        n.oe = e | REACTIVE_ZOMBIE;
+        // migrate height-adjust entries too, not just recompute entries: every
+        // `deleteFromHeap` call site picks the queue from the zombie flag, so a
+        // node left physically linked in `dirtyQueue` after being zombified gets
+        // unlinked from the wrong queue on dispose, corrupting the bucket and
+        // livelocking the next `runHeap` that reaches it (#2759)
+                if (e & (REACTIVE_IN_HEAP | REACTIVE_IN_HEAP_HEIGHT)) {
+            deleteFromHeap(n, e & REACTIVE_ZOMBIE ? zombieQueue : dirtyQueue);
+            if (e & REACTIVE_IN_HEAP) insertIntoHeap(n, zombieQueue); else insertIntoHeapHeight(n, zombieQueue);
+        }
+        markDisposal(n);
+        n = n.Fn;
+    }
+}
+
+function dispose(e) {
+    // Direct disposal is death, not dormancy: strip the observation lifecycle
+    // so a later read freezes at the last committed value instead of
+    // reawakening the node (#3024). The teardown itself (heap removal — a node
+    // left queued would be recomputed and resurrected by the next flush (#2983)
+    // — dep unlinking, child disposal) is exactly unobserved()'s body; only
+    // this flag distinguishes death from dormancy.
+    e.C &= ~CONFIG_AUTO_DISPOSE;
+    unobserved(e);
+}
+
+function disposeChildren(e, n = false, t) {
+    const i = e.oe;
+    if (i & REACTIVE_DISPOSED) return;
+    // A previous frame parked as zombies (#3404) dies with its owner (#3024):
+    // the commit that would retire it returns on the DISPOSED flag set below,
+    // so it drains here or its cleanups never run and the zombies stay
+    // subscribed, to rerun in a torn-down tree (#3561). Death only (`self`):
+    // a rerun's `disposeChildren(el)` leaves the frame rendering until commit.
+        if (n && !t && e.o !== null && (e.o.dt !== null || e.o.Et !== null)) disposeChildren(e, false, true);
+    if (n) {
+        e.oe = i | REACTIVE_DISPOSED;
+        if (e._parent === null && e.Zt) unregisterRoot(e);
+        // Companions are created detached and outlive their owner, but a verdict
+        // must not: a disposed source can never settle, so an isPending companion
+        // latched `true` here would hold a spinner forever (INV-9, the PR #2845
+        // edge). Snap runs after the DISPOSED flag is set so the oracle reads
+        // false, and notifies subscribers still watching the companion.
+                const n = e;
+        if (n.o?.xe || n.o?.Me) GlobalQueue.Qn(n);
+        // A firewall's leaves have no lifecycle of their own, so a companion on
+        // one of them outlives its source the same way (INV-9's rationale). The
+        // firewall knows which leaves carry companions (CONFIG_CHILD_COMPANIONS,
+        // #3038): snap them with it — the snap retires a shadow whose firewall is
+        // disposed (spec O5).
+                if (n.C & CONFIG_CHILD_COMPANIONS) n.o.xt.forEach(GlobalQueue.Qn);
+        // A pending reader parked in a transaction may be the only thing holding
+        // it (#3372): its death is a completion event the transaction must be
+        // re-judged for, and nothing else re-enters a parked transaction.
+                const t = n.me;
+        if (t && n.S & STATUS_PENDING && !wokenTransitions.includes(t)) wokenTransitions.push(t), 
+        schedule();
+    }
+    if (n && e.Se && e.o !== null) e.o.pe = null;
+    let o = t ? e.o?.dt ?? null : e._n;
+    if (!t) e._n = null;
+    while (o) {
+        const e = o;
+        // Owner teardown is death regardless of the child's own lifecycle
+        // (#3024): strip AUTO_DISPOSE so a post-disposal read freezes at the
+        // last committed value instead of reawakening in a torn-down tree.
+        // Runs before the recursion so already-dormant children (whose
+        // disposeChildren call early-returns on REACTIVE_DISPOSED) die too.
+        // Only unobserved()'s own node keeps its dormancy — it is never in
+        // this loop; its children are rebuilt fresh on reawaken.
+                e.C &= ~CONFIG_AUTO_DISPOSE;
+        // Heap removal must not be gated on `_deps`: a dependency-free
+        // computation queued by refresh() has a null dep list but still sits in
+        // the dirty heap, and left there the post-disposal flush recomputes it —
+        // recompute() rewriting `_flags` clears REACTIVE_DISPOSED and the node
+        // comes back to life (post-unmount runs, leaked cleanups, #2983).
+        // deleteFromHeap self-guards on the in-heap flags (and tolerates plain
+        // Owners, whose _flags is undefined), so no gate here.
+                deleteFromHeap(e, queueFor(e));
+        clearDeps(e);
+        // The chain is detached above so a node a cleanup links mid-drain lands
+        // on the fresh head and survives. Pointing each drained child's prev at
+        // itself routes its later splice onto the detached chain, never the head,
+        // and keeps the dev owner-chain-head invariant honest for those children.
+                o.kt = o;
+        disposeChildren(o, true);
+        // Read after, not before: a sibling this disposal made dormant spliced
+        // itself out of the detached chain, and a cleanup may then have linked
+        // it at the fresh head, which rewrote the `_nextSibling` a pre-read
+        // would still be holding.
+                o = o.Fn;
+    }
+    if (t) {
+        if (e.o !== null) e.o.dt = null;
+    } else e.Nt = 0;
+    // O(1) splice out of parent's chain on individual dispose. Skipped during
+    // batch dispose (parent already disposed) and zombie disposal (node sits on
+    // parent's _pendingFirstChild). We leave node._nextSibling intact so outer
+    // walks that already advanced past us still reach later siblings.
+        if (n && !t && !(i & REACTIVE_ZOMBIE) && e._parent !== null && !(e._parent.oe & REACTIVE_DISPOSED)) {
+        const n = e.kt;
+        const t = e.Fn;
+        if (n !== null) n.Fn = t; else e._parent._n = t;
+        if (t !== null) t.kt = n;
+        e.kt = null;
+    }
+    runDisposal(e, t);
+    // Final effect-returned cleanup fires at true disposal, after `_disposal`
+    // to mirror rerun ordering (compute-phase teardown first, cleanup last).
+        if (n && e.qt) {
+        const n = e.qt;
+        e.qt = undefined;
+        n();
+    }
+}
+
+function linkChild(e, n) {
+    const t = e._n;
+    n.kt = null;
+    n.Fn = t;
+    if (t !== null) t.kt = n;
+    e._n = n;
+}
+
+function runDisposal(e, n) {
+    // Detach the list BEFORE running it (#3601), as `_cleanup` is (#2813). A
+    // cleanup that disposes an ancestor re-enters this node through the death
+    // walk while the loop is still running; with the list still attached, that
+    // walk ran every entry a second time. Detached, the re-entrant drain finds
+    // nothing. The same shape latched a throwing cleanup: the list survived the
+    // throw and every later drain re-ran and re-threw it.
+    const t = n ? e.o?.Et : e.Ve;
+    if (!t) return;
+    if (n) e.o.Et = null; else e.Ve = null;
+    if (Array.isArray(t)) {
+        // Unwind order (#3572, restores 1.x #1562): later registrations run
+        // before earlier ones. Children have already been disposed by the caller,
+        // so with LIFO a body that registers cleanup before creating its children
+        // tears down after them — the same order a per-component owner gives.
+        for (let e = t.length - 1; e >= 0; e--) {
+            const n = t[e];
+            n.call(n);
+        }
+    } else {
+        t.call(t);
+    }
+}
+
+function childId(e, n) {
+    let t = e;
+    while (t.C & CONFIG_TRANSPARENT && t._parent) t = t._parent;
+    if (t.id != null) return formatId(t.id, n ? t.Nt++ : t.Nt);
+    throw new Error("");
+}
+
+/**
+ * Allocates and returns the next stable child id for `owner`. Used by
+ * hydration plumbing and `createUniqueId`. Not part of the user-facing API.
+ *
+ * @internal
+ */ function getNextChildId(e) {
+    return childId(e, true);
+}
+
+/**
+ * The id a freshly-created node inherits: an explicit `options.id` wins;
+ * transparent nodes share their parent's id; otherwise the parent's next
+ * child id is consumed (or `undefined` outside an id-carrying tree).
+ */ function inheritId(e, n, t) {
+    return e?.id ?? (n ? t?.id : t?.id != null ? getNextChildId(t) : undefined);
+}
+
+/**
+ * Returns the *next* child id for `owner` without consuming it. Used by
+ * hydration plumbing to peek at the id a future child will receive.
+ *
+ * @internal
+ */ function peekNextChildId(e) {
+    return childId(e, false);
+}
+
+function formatId(e, n) {
+    const t = n.toString(36), i = t.length - 1;
+    return e + (i ? String.fromCharCode(64 + i) : "") + t;
+}
+
+/**
+ * Returns the currently-tracking observer (the computation that subscribes to
+ * reactive reads at this point), or `null` if reads here would be untracked.
+ * Used by reactive primitives that need to know whether they're inside a
+ * tracking scope. App code rarely needs this — see `getOwner()` for the
+ * lifecycle owner instead.
+ *
+ * @example
+ * ```ts
+ * // Library predicate: only register a hot-path subscription when the
+ * // caller is inside a tracking scope (memo / effect compute / JSX).
+ * function trackIfTracked(source: () => unknown) {
+ *   if (getObserver()) source();
+ * }
+ * ```
+ */ function getObserver() {
+    if (pendingCheckActive || latestReadActive) return PENDING_OWNER;
+    return tracking ? context : null;
+}
+
+/**
+ * Returns the current reactive **owner** — the lifecycle node that the next
+ * `cleanup()` / `onCleanup()` / `createSignal()` etc. will be attached to.
+ *
+ * Returns `null` if called outside any owner. Capture the owner with
+ * `getOwner()` and re-enter it later with `runWithOwner(owner, fn)` to attach
+ * disposables created from a callback (event handler, async resolution, etc.)
+ * back to a component's lifecycle.
+ *
+ * @example
+ * ```ts
+ * function defer<T>(fn: () => T) {
+ *   const owner = getOwner();
+ *   queueMicrotask(() => runWithOwner(owner, fn));
+ * }
+ * ```
+ */ function getOwner() {
+    return context;
+}
+
+/**
+ * Low-level: registers `fn` as a disposal callback on the current owner.
+ * Most code should use `onCleanup()` from `solid-js`, which adds dev-mode
+ * checks. `cleanup()` is the unchecked primitive used by internals.
+ */ function cleanup(e) {
+    if (!context) return e;
+    if (!context.Ve) context.Ve = e; else if (Array.isArray(context.Ve)) context.Ve.push(e); else context.Ve = [ context.Ve, e ];
+    return e;
+}
+
+/**
+ * Returns `true` if the owner has been disposed (or marked zombie pending
+ * disposal). Pair with a captured owner to bail out of late callbacks whose
+ * surrounding component already unmounted.
+ *
+ * @example
+ * ```ts
+ * function onSettleSafe(fn: () => void) {
+ *   const owner = getOwner();
+ *   queueMicrotask(() => {
+ *     if (owner && isDisposed(owner)) return; // component unmounted; skip
+ *     runWithOwner(owner, fn);
+ *   });
+ * }
+ * ```
+ */ function isDisposed(e) {
+    return !!(e.oe & (REACTIVE_DISPOSED | REACTIVE_ZOMBIE));
+}
+
+function disposeRootSelf(e = true) {
+    disposeChildren(this, e);
+}
+
+/**
+ * Creates a fresh owner attached as a child of the current owner (or as a
+ * detached root if there is none). Used by framework internals to group
+ * cleanups; app code should use `createRoot()` (host a reactive scope outside
+ * a component) or `runWithOwner()` (re-enter a captured owner).
+ *
+ * @internal
+ */ function createOwner(e) {
+    const n = context;
+    const t = e?.transparent ?? false;
+    // Prod and observe boilerplates (see core.ts computed()). The observe
+    // literal carries the `_name` slot the rendering layer fills with the
+    // component label (`owner._name = "<App>"`) — a slot, so labelling a root
+    // is a plain store rather than a shape fork between labelled and plain roots.
+        const i = {
+        id: inheritId(e, t, n),
+        C: t ? CONFIG_TRANSPARENT : 0,
+        Zt: true,
+        Yt: n?.Zt ? n.Yt : n,
+        _n: null,
+        Fn: null,
+        kt: null,
+        Ve: null,
+        T: n?.T ?? globalQueue,
+        rt: n?.rt || defaultContext,
+        Nt: 0,
+        o: null,
+        _parent: n,
+        dispose: disposeRootSelf,
+        _name: undefined
+    };
+    if (n) linkChild(n, i); else registerRoot(i);
+    return i;
+}
+
+/**
+ * Creates a reactive root — an owner scope with its own `dispose()`. A root
+ * created inside an existing owner is owned by it and is disposed when the
+ * parent is disposed; call `dispose()` to tear it down earlier. To create a
+ * root that outlives its creator, detach explicitly:
+ * `runWithOwner(null, () => createRoot(...))`. Pass `id` to seed hydration
+ * ids for the tree it owns.
+ *
+ * `dispose()` tears down every signal, memo, effect, and `onCleanup`
+ * registered inside the root.
+ *
+ * Use this to host long-lived reactive scopes outside of a component (custom
+ * controllers, app bootstrapping, tests). Inside a component, prefer
+ * letting Solid's component lifecycle own things.
+ *
+ * @example
+ * ```ts
+ * // At module level there is no owner, so this root lives until disposed.
+ * const dispose = createRoot(dispose => {
+ *   const [n, setN] = createSignal(0);
+ *   createEffect(() => n(), value => console.log(value));
+ *   setInterval(() => setN(x => x + 1), 1000);
+ *   return dispose;
+ * });
+ *
+ * // Later, to tear everything down:
+ * dispose();
+ *
+ * // Inside an owner (component, effect, another root), detach explicitly
+ * // if the root must outlive its creator:
+ * const detached = runWithOwner(null, () => createRoot(d => d));
+ * ```
+ *
+ * @description https://docs.solidjs.com/reference/reactive-utilities/create-root
+ */ function createRoot(e, n) {
+    const t = createOwner(n);
+    return runWithOwner(t, () => e(() => t.dispose()));
+}
+
+export { cleanup, createOwner, createRoot, dispose, disposeChildren, getNextChildId, getObserver, getOwner, inheritId, isDisposed, linkChild, markDisposal, peekNextChildId };