@solidjs/signals 2.0.0-rc.7 → 2.0.0-rc.8

package/dist/observe/core/graph.js

@@ -0,0 +1,155 @@
+import { CONFIG_AUTO_DISPOSE, STATUS_PENDING, REACTIVE_DISPOSED, REACTIVE_ZOMBIE, CONFIG_SLOT_NODE, REACTIVE_RECOMPUTING_DEPS } from "./constants.js";
+
+import { slotUnobservedHook } from "./core.js";
+
+import { deleteFromHeap, queueFor } from "./heap.js";
+
+import { disposeChildren } from "./owner.js";
+
+import { bumpNotifyEpoch } from "./scheduler.js";
+
+// https://github.com/stackblitz/alien-signals/blob/v2.0.3/src/system.ts#L100
+function unlinkSubs(e) {
+    const n = e.oe;
+    const l = e.ne;
+    const o = e.se;
+    const s = e.mn;
+    if (o !== null) o.mn = s; else n.Wt = s;
+    if (s !== null) s.se = o; else {
+        n.u = o;
+        if (o === null) {
+            // Slot nodes (store leaves) dispatch to the ONE shared hook — no
+            // per-node unobserved closure, no NodeExtension to hold it.
+            if (n.T & CONFIG_SLOT_NODE) slotUnobservedHook(n); else n.o?.qt?.();
+            // No more subscribers; only tear down if CONFIG_AUTO_DISPOSE is set.
+            // A pending node is exempt: its in-flight async work (or the
+            // transition holding it) is an observer — tearing down would orphan
+            // the work and re-execute it on the next read. The settle path runs
+            // this same last-one-out check when that observer releases (the
+            // untracked-read dormancy sweep guards on pending identically).
+                        const e = n;
+            e.ot && e.T & CONFIG_AUTO_DISPOSE && !(e.it & REACTIVE_ZOMBIE) && !(e.S & STATUS_PENDING) && unobserved(e);
+        }
+    }
+    return l;
+}
+
+function trimStaleDeps(e) {
+    const n = e.Dt;
+    let l = n !== null ? n.ne : e.te;
+    if (l !== null) {
+        do {
+            l = unlinkSubs(l);
+        } while (l !== null);
+        if (n !== null) n.ne = null; else e.te = null;
+    }
+}
+
+// Shared by unobserved() and the disposeChildren child loop. The truthy guard
+// (not `!== null`) matters: plain Owners in a child chain have no _deps field,
+// and skipping early also avoids adding one (hidden-class churn) via the
+// null-out below.
+function clearDeps(e) {
+    let n = e.te;
+    if (!n) return;
+    do {
+        n = unlinkSubs(n);
+    } while (n !== null);
+    e.te = null;
+    e.Dt = null;
+}
+
+function unobserved(e) {
+    deleteFromHeap(e, queueFor(e));
+    clearDeps(e);
+    disposeChildren(e, true);
+}
+
+/**
+ * Deferred dormancy for never-observed auto-dispose computeds (#3078).
+ *
+ * An untracked top-level read of a subscriber-less observation-lifecycle memo
+ * used to call unobserved() inline at the end of read(). That kept the leak
+ * closed (the compute links the memo into its deps' sub lists — without a
+ * teardown point a never-observed memo is retained by its sources forever;
+ * upstream alien-signals has exactly this retention), but it made reads
+ * destructive: each read disposed the node, the next read revived it with a
+ * full recompute in whatever ambient transition/lane context happened to be
+ * current, so consecutive reads could return different answers with no write
+ * in between.
+ *
+ * Instead, reads queue the node here and the scheduler sweeps at the top of
+ * the next flush (before runHeap, so a same-tick dirtying is reclaimed
+ * instead of recomputed). Reads become idempotent within a tick (the node
+ * stays alive and serves its cache, uniform with observed memos) while
+ * reclamation still happens within one microtask — the enqueue site arms
+ * schedule(), so a flush is guaranteed even when no other work is queued.
+ */ const dormantNodes = new Set;
+
+function sweepDormant() {
+    if (dormantNodes.size === 0) return;
+    for (const e of dormantNodes) {
+        // Re-validate at sweep time: the node may have gained a subscriber (its
+        // lifecycle is the unlinkSubs cascade now), gone pending (in-flight async
+        // is an observer; the settle path re-runs last-one-out), lost its
+        // AUTO_DISPOSE bit (owner teardown strips it, #3024), or already been
+        // torn down.
+        if (!e.u && e.T & CONFIG_AUTO_DISPOSE && !(e.S & STATUS_PENDING) && !(e.it & (REACTIVE_DISPOSED | REACTIVE_ZOMBIE))) {
+            unobserved(e);
+        }
+    }
+    dormantNodes.clear();
+}
+
+// https://github.com/stackblitz/alien-signals/blob/v2.0.3/src/system.ts#L52
+function link(e, n, l = false) {
+    // Repeat touches within one pass AND-combine `_pendingObserver`: a probe
+    // read (`isPending(() => x())`) beside a value read of the same dep must
+    // not relabel the value dependency as probe-only — the value read is what
+    // real-error propagation and affects() coverage key off, regardless of
+    // read order within the computation.
+    const o = n.Dt;
+    if (o !== null && o.oe === e) {
+        o.ye &&= l;
+        return;
+    }
+    let s = null;
+    const t = n.it & REACTIVE_RECOMPUTING_DEPS;
+    if (t) {
+        s = o !== null ? o.ne : n.te;
+        if (s !== null && s.oe === e) {
+            s.fn = n.Pt;
+            n.Dt = s;
+            // First touch of this pass: the previous pass's label is stale.
+                        s.ye = l;
+            return;
+        }
+    }
+    // A link stamped with the current pass generation was created or reused
+    // in-order during this recompute, i.e. it already sits in the validated
+    // [deps.._depsTail] prefix — the O(1) equivalent of scanning the dep list
+    // (the old alien-signals `isValidLink` walk, O(n²) when a computation
+    // re-reads earlier deps non-consecutively, e.g. store leaf reads).
+        const r = e.Wt;
+    if (r !== null && r.le === n && (!t || r.fn === n.Pt)) {
+        // Gen-matched during a recompute = repeat touch this pass (AND); outside
+        // a recompute there is no pass boundary, so the latest read labels it.
+        if (t) r.ye &&= l; else r.ye = l;
+        return;
+    }
+    const u = n.Dt = e.Wt = {
+        oe: e,
+        le: n,
+        ne: s,
+        mn: r,
+        se: null,
+        fn: n.Pt,
+        ye: l
+    };
+    if (o !== null) o.ne = u; else n.te = u;
+    if (r !== null) r.se = u; else e.u = u;
+    // New subscriber edge: staged-rewrite skips (§12d) must not miss it.
+        bumpNotifyEpoch();
+}
+
+export { clearDeps, dormantNodes, link, sweepDormant, trimStaleDeps, unlinkSubs, unobserved };

package/dist/observe/core/heap.js

@@ -0,0 +1,147 @@
+import "./core.js";
+
+import { REACTIVE_IN_HEAP, REACTIVE_IN_HEAP_HEIGHT, REACTIVE_ZOMBIE, REACTIVE_RECOMPUTING_DEPS, REACTIVE_MANUAL_WRITE, REACTIVE_CHECK, REACTIVE_DIRTY, CONFIG_FW_CHILDREN } from "./constants.js";
+
+import { zombieQueue, dirtyQueue } from "./scheduler.js";
+
+/** The queue a node belongs to, picked from its own zombie flag. */ function queueFor(e) {
+    return e.it & REACTIVE_ZOMBIE ? zombieQueue : dirtyQueue;
+}
+
+/**
+ * Schedule one subscriber to re-run on the next flush: inserted into its own
+ * (zombie-flag-routed) heap with the `_min` cursor pulled down. Tracked
+ * effects ride the heap too — the heap visit is their (empty) compute phase,
+ * which hands the callback to the user queue once the pass has committed
+ * (see GlobalQueue._update, #3291).
+ */ function enqueueSub(e) {
+    const E = queueFor(e);
+    if (E.St > e.At) E.St = e.At;
+    insertIntoHeap(e, E);
+}
+
+function actualInsertIntoHeap(e, E) {
+    const t = (e.Nt?.$t ? e.Nt.ln?.At : e.Nt?.At) ?? -1;
+    if (t >= e.At) e.At = t + 1;
+    const n = e.At;
+    const I = E.eE[n];
+    if (I === undefined) E.eE[n] = e; else {
+        const E = I.Qt;
+        E.yt = e;
+        e.Qt = E;
+        I.Qt = e;
+    }
+    if (n > E.EE) E.EE = n;
+}
+
+function insertIntoHeap(e, E) {
+    let t = e.it;
+    // RECOMPUTING refusals are not always losses: a genuinely missed wake (a
+    // write to a link this pass already validated) is latched link-side in
+    // insertSubs as REACTIVE_MISSED_WAKE for recompute's tail (#3037).
+        if (t & (REACTIVE_IN_HEAP | REACTIVE_RECOMPUTING_DEPS | REACTIVE_MANUAL_WRITE)) return;
+    if (t & REACTIVE_CHECK) {
+        e.it = t & -4 | REACTIVE_DIRTY | REACTIVE_IN_HEAP;
+    } else {
+        e.it = t | REACTIVE_IN_HEAP;
+        // An unmarked node entering an already-marked heap is marked on the
+        // spot, keeping the markHeap memo valid. `_marked` is only reset by
+        // runHeap, so a write between two mid-tick pulls (read-time markHeap +
+        // updateIfNecessary) would otherwise leave this node unmarked and every
+        // downstream pull stale until the next flush (#2922: the second
+        // `latest()` returned the first write's value). Invalidating the memo
+        // instead re-walked the WHOLE heap on the next pull — with N effects
+        // parked in the heap for a synchronous mount (each row writing a ref
+        // signal its effect subscribes to), mounting N rows was O(N²) (#3350).
+        // markNode's own guard skips an already-DIRTY node.
+                if (E.tE) markNode(e);
+    }
+    if (!(t & REACTIVE_IN_HEAP_HEIGHT)) actualInsertIntoHeap(e, E);
+}
+
+function insertIntoHeapHeight(e, E) {
+    let t = e.it;
+    if (t & (REACTIVE_IN_HEAP | REACTIVE_RECOMPUTING_DEPS | REACTIVE_IN_HEAP_HEIGHT | REACTIVE_MANUAL_WRITE)) return;
+    e.it = t | REACTIVE_IN_HEAP_HEIGHT;
+    actualInsertIntoHeap(e, E);
+}
+
+function deleteFromHeap(e, E) {
+    const t = e.it;
+    if (!(t & (REACTIVE_IN_HEAP | REACTIVE_IN_HEAP_HEIGHT))) return;
+    e.it = t & -25;
+    const n = e.At;
+    if (e.Qt === e) E.eE[n] = undefined; else {
+        const t = e.yt;
+        const I = E.eE[n];
+        const o = t ?? I;
+        if (e === I) E.eE[n] = t; else e.Qt.yt = t;
+        o.Qt = e.Qt;
+    }
+    e.Qt = e;
+    e.yt = undefined;
+}
+
+function markHeap(e) {
+    if (e.tE) return;
+    e.tE = true;
+    for (let E = 0; E <= e.EE; E++) {
+        for (let t = e.eE[E]; t !== undefined; t = t.yt) {
+            if (t.it & REACTIVE_IN_HEAP) markNode(t);
+        }
+    }
+}
+
+function markNode(e, E = REACTIVE_DIRTY) {
+    const t = e.it;
+    if ((t & (REACTIVE_CHECK | REACTIVE_DIRTY)) >= E) return;
+    e.it = t & -4 | E;
+    for (let E = e.u; E !== null; E = E.se) {
+        markNode(E.le, REACTIVE_CHECK);
+    }
+    // Firewall children (projection machinery only): gate the cold-extension
+    // deref on the config bit — markNode runs per sub edge per write, and an
+    // unconditional _x chase here taxed every propagation (diamond -22%).
+        if (e.T & CONFIG_FW_CHILDREN) {
+        for (let E = e.o.i; E !== null; E = E.ue) {
+            for (let e = E.u; e !== null; e = e.se) {
+                markNode(e.le, REACTIVE_CHECK);
+            }
+        }
+    }
+}
+
+function runHeap(e, E) {
+    e.tE = false;
+    for (e.St = 0; e.St <= e.EE; e.St++) {
+        let t = e.eE[e.St];
+        while (t !== undefined) {
+            if (t.it & REACTIVE_IN_HEAP) E(t); else adjustHeight(t, e);
+            t = e.eE[e.St];
+        }
+    }
+    e.EE = 0;
+}
+
+function adjustHeight(e, E) {
+    deleteFromHeap(e, E);
+    let t = e.At;
+    for (let E = e.te; E; E = E.ne) {
+        const e = E.oe;
+        const n = e.re || e;
+        if (n.ot && n.At >= t) t = n.At + 1;
+    }
+    if (e.At !== t) {
+        e.At = t;
+        for (let E = e.u; E !== null; E = E.se) {
+            // Route each subscriber by its own zombie flag, mirroring the
+            // post-recompute height-adjust path. Inserting into the running `heap`
+            // unconditionally can park a zombie in `dirtyQueue` (or a live node in
+            // `zombieQueue`), breaking the flag/queue invariant `deleteFromHeap`
+            // relies on — the same corruption class as #2759.
+            insertIntoHeapHeight(E.le, queueFor(E.le));
+        }
+    }
+}
+
+export { deleteFromHeap, enqueueSub, insertIntoHeap, insertIntoHeapHeight, markHeap, markNode, queueFor, runHeap };

package/dist/observe/core/invariants.js

@@ -0,0 +1,43 @@
+import "./core.js";
+
+/**
+ * INV-2: a node with an *active* override must be registered for reversion in
+ * the queue's or a transition's `_optimisticNodes`. An unregistered active
+ * override would survive transition completion forever. Runs at the end of
+ * every flush (not just quiescence — the invariant holds mid-transition).
+ * (There is no revert-target requirement: authoritative values commit
+ * silently into `_value` under the override mask — A17 — so reverting is
+ * just dropping the override.)
+ */ function devCheckActiveOverrides(e) {
+    return;
+}
+
+/** INV-1: an isPending() probe must never leak past its own call. */ function devCheckFlushStart() {
+    return;
+}
+
+/**
+ * Companion-vs-oracle census (#2838 pre-work). A NON-ASSERTING diff logger:
+ * at the end of every flush it compares each live companion's cached state
+ * against a fresh oracle and logs every distinct divergence fingerprint once
+ * (console, `[census]` prefix). Legit lane-scoped windows will show up too —
+ * the census exists to enumerate the full taxonomy of mid-flight divergence
+ * so the write-driven redesign knows every case it must produce, not to
+ * judge them. Enabled only when the COMPANION_CENSUS env var is set (in
+ * addition to `false`), so normal test runs pay one boolean check.
+ */ typeof globalThis !== "undefined" && !!globalThis.process?.env?.COMPANION_CENSUS;
+
+function devCensusCompanions(e) {
+    return;
+}
+
+/**
+ * Quiescence checks. Run only when the system is fully drained: nothing
+ * scheduled, no active/stashed transitions, no live lanes. At that point no
+ * transition-scoped state may survive, and the lazily-created companions must
+ * agree with a fresh computation of their owner's state.
+ */ function devCheckQuiescent(e) {
+    return;
+}
+
+export { devCensusCompanions, devCheckActiveOverrides, devCheckFlushStart, devCheckQuiescent };

package/dist/observe/core/lanes.js

@@ -0,0 +1,168 @@
+import { CONFIG_HAS_LANE, NOT_PENDING } from "./constants.js";
+
+import { ext } from "./core.js";
+
+import { currentTransition, waitingTransition, activeTransition } from "./scheduler.js";
+
+// Map from optimistic signal to its lane (reused for multiple writes to same signal)
+const signalLanes = new WeakMap;
+
+// All active lanes (for cleanup on transition completion)
+const activeLanes = new Set;
+
+/**
+ * Get an existing lane for a signal or create a new one.
+ * Reuses lane for multiple writes to the same signal.
+ */ function getOrCreateLane(n) {
+    let e = signalLanes.get(n);
+    if (e) {
+        return findLane(e);
+    }
+    // Detect parent lane: _parentSource chains from pendingSignal → pendingValueComputed → original.
+    // The child lane should not merge with the parent lane.
+        const i = n.o?.Qe;
+    const t = i?.o?.Te;
+    const r = t ? findLane(t) : null;
+    e = {
+        Ln: n,
+        _e: new Set,
+        vn: [ [], [] ],
+        gn: null,
+        Ee: activeTransition,
+        hn: r
+    };
+    signalLanes.set(n, e);
+    activeLanes.add(e);
+    // A companion may have written before the owner's first optimistic write
+    // (affects() as an action's first statement pokes the verdict companion of a
+    // still lane-less node, #2887), leaving its lane parentless. Adopt it now:
+    // parent-child is a property of the nodes, not of write order — otherwise
+    // the owner's write merges the companion's subscribers into this lane and
+    // their effects wait on its async instead of flushing immediately.
+        adoptCompanionLane(n.o?.be, e);
+    adoptCompanionLane(n.o?.pe, e);
+    return e;
+}
+
+function adoptCompanionLane(n, e) {
+    if (!n) return;
+    const i = signalLanes.get(n);
+    if (!i) return;
+    const t = findLane(i);
+    // Only the companion's own unmerged root is safely re-parentable: a root
+    // that absorbed other lanes carries work that is not a child of this owner.
+        if (t !== e && t.Ln === n && !t.hn) t.hn = e;
+}
+
+/**
+ * Union-find: find the root lane.
+ */ function findLane(n) {
+    while (n.gn) n = n.gn;
+    return n;
+}
+
+/**
+ * Is the lane held? `_pendingAsync` records the async the lane OWNS (derived
+ * under it); a transaction's reporter map records the async a render effect
+ * OBSERVED pending with no boundary taking it (INV-3, the one registration
+ * site). A hold needs both — the same rule the transaction itself uses, so a
+ * memo nobody renders, or one a fallback-showing boundary caught, cannot tear
+ * a frame and holds nothing (#3289). An orphan lane has no observation record
+ * and never holds.
+ *
+ * The observation is looked up per NODE, in whichever live transaction
+ * recorded it — not in this lane's transaction. Lanes merge across
+ * transactions (#2912: ownership never travels through lanes), so after a
+ * merge the root's transaction holds the observations of only one member;
+ * the async the other member's transaction observed must hold the merged
+ * reveal just the same (A15 for lanes, #3335).
+ */ function laneHeld(n) {
+    if (!n.Ee) return false;
+    for (const e of n._e) if (waitingTransition(e) !== null) return true;
+    return false;
+}
+
+/**
+ * Merge two lanes when their dependency graphs overlap.
+ */ function mergeLanes(n, e) {
+    n = findLane(n);
+    e = findLane(e);
+    if (n === e) return n;
+    e.gn = n;
+    // Move (not copy) the merged lane's work: after the merge all routing goes
+    // through findLane() to the root, so anything left behind here is dead —
+    // and anything *added* here later is a routing bug (INV-5).
+        for (const i of e._e) n._e.add(i);
+    e._e.clear();
+    n.vn[0].push(...e.vn[0]);
+    n.vn[1].push(...e.vn[1]);
+    e.vn[0].length = 0;
+    e.vn[1].length = 0;
+    return n;
+}
+
+/**
+ * Resolve a node's lane: follow union-find chain, verify active, clear if stale.
+ */ function resolveLane(n) {
+    const e = n.o?.Te;
+    if (!e) return undefined;
+    const i = findLane(e);
+    if (activeLanes.has(i)) return i;
+    if (n.o !== null) n.o.Te = undefined;
+    return undefined;
+}
+
+function resolveTransition(n) {
+    // An active override answers with its owner, not its lane: lanes are
+    // scheduling affinity and a shared subscriber merges them across
+    // transactions (#2912) — the merged root's _transition would hand this
+    // node's override to whichever action wrote last through the shared
+    // reader. Chase merge chains; a dead owner settled through another path.
+    if (hasActiveOverride(n) && n.o?.Yt) {
+        const e = ext(n).Yt = currentTransition(n.o?.Yt);
+        if (e.Ut !== true) return e;
+        if (n.o !== null) n.o.Yt = null;
+    }
+    return resolveLane(n)?.Ee ?? n.Ee;
+}
+
+/**
+ * Check if a node has an active optimistic override.
+ */ function hasActiveOverride(n) {
+    const e = n.o;
+    return e !== null && e.De !== undefined && e.De !== NOT_PENDING;
+}
+
+/**
+ * Assign or merge a lane onto a node. At convergence points (node already has
+ * a different active lane), merge unless the node has an active override.
+ */ function assignOrMergeLane(n, e) {
+    const i = findLane(e);
+    const t = n.o?.Te;
+    if (t) {
+        // If the subscriber's lane was merged into another lane, it's stale —
+        // replace it with the new source lane instead of following the merge chain
+        // (which would incorrectly merge the new lane into the old group)
+        if (t.gn) {
+            ext(n).Te = e;
+            n.T |= CONFIG_HAS_LANE;
+            return;
+        }
+        const r = findLane(t);
+        if (activeLanes.has(r)) {
+            if (r !== i && !hasActiveOverride(n)) {
+                // Parent-child lanes stay independent so isPending resolves without
+                // waiting for the parent's async. The child keeps ownership.
+                if (i.hn && findLane(i.hn) === r) {
+                    ext(n).Te = e;
+                    n.T |= CONFIG_HAS_LANE;
+                } else if (r.hn && findLane(r.hn) === i) ; else mergeLanes(i, r);
+            }
+            return;
+        }
+    }
+    ext(n).Te = e;
+    n.T |= CONFIG_HAS_LANE;
+}
+
+export { activeLanes, assignOrMergeLane, findLane, getOrCreateLane, hasActiveOverride, laneHeld, mergeLanes, resolveLane, resolveTransition, signalLanes };