@solidjs/signals 2.0.0-rc.4 → 2.0.0-rc.6

package/dist/prod/signals.js

@@ -1,10 +1,12 @@
-import { computed, optimisticComputed, setSignal, optimisticSignal, runWithOwner, setMemo, signal, read, untrack } from "./core/core.js";
+import { TimeoutError } from "./core/error.js";
 
-import { cleanup, createRoot, getOwner, dispose } from "./core/owner.js";
+import { computed, optimisticComputed, setSignal, optimisticSignal, runWithOwner, setMemo, signal, markRefresh, installAuthoritativeRead, read, untrack } from "./core/core.js";
 
-import { globalQueue, Queue } from "./core/scheduler.js";
+import { cleanup, createRoot, getOwner, dispose, getObserver } from "./core/owner.js";
 
-import { CONFIG_AUTO_DISPOSE, CONFIG_CHILDREN_FORBIDDEN, EFFECT_USER, $REFRESH } from "./core/constants.js";
+import { globalQueue, Queue, entangleConfirmingTransitions, activeTransition } from "./core/scheduler.js";
+
+import { CONFIG_AUTO_DISPOSE, CONFIG_CHILDREN_FORBIDDEN, EFFECT_USER, $REFRESH, CONFIG_DIRECT_COMMIT, CONFIG_AUTHORITATIVE_READ, CONFIG_FRESH_READ } from "./core/constants.js";
 
 import "./core/invariants.js";
 
@@ -76,7 +78,74 @@ function createMemo(e, t) {
     return accessor(computed(e, t));
 }
 
-function createEffect(e, t, n) {
+/**
+ * Creates a reactive effect with **separate compute and effect phases**.
+ *
+ * - `compute(prev)` runs reactively — *put all reactive reads here*. The
+ *   returned value is passed to `effect` and is also the new "previous" value
+ *   for the next run.
+ * - `effect(next, prev?)` runs imperatively (untracked) after the queue
+ *   flushes. *Put DOM writes / fetch / logging / subscriptions here.* It may
+ *   return a cleanup function which runs before the next effect or on
+ *   disposal.
+ *
+ * Reactive reads inside `effect` will *not* re-trigger this effect — that's
+ * intentional. If you need a single-phase tracked effect, use
+ * `createTrackedEffect` (with the tradeoffs noted there).
+ *
+ * Pass an `EffectBundle` (`{ effect, error }`) instead of a plain function to
+ * intercept **compute-phase** errors — errors thrown by `compute` or arriving
+ * from upstream reactive sources (including async rejections), which your own
+ * code has no frame to `try/catch`. The `error` handler is the error arm of
+ * the effect phase: it runs on the same schedule and in the same imperative,
+ * writable scope as `effect` (setting error state via signals is fine), and
+ * only for *settled* errors — a transient error that recovers before the
+ * effect phase runs `effect` with the recovered value instead, and a held
+ * transition defers it exactly as it defers `effect`. Without an `error`
+ * handler a compute-phase error is logged and the effect simply skips that
+ * run — a non-render effect's reactivity failing does not crash the app.
+ * Rethrowing from `error` escalates it to the nearest error boundary
+ * (halting the system if none exists).
+ *
+ * The **effect phase is different**: it is your own imperative code, so handle
+ * failures with `try/catch` where they occur. An uncaught effect-phase throw
+ * is treated as an unhandled application error — caught by the nearest
+ * `createErrorBoundary`/`<Errored>`, and permanently halting the reactive
+ * system if there is none. It is *not* routed to the bundle's `error` handler.
+ *
+ * ```typescript
+ * createEffect<T>(compute, effectFn | { effect, error }, options?: EffectOptions);
+ * ```
+ * @param compute a function that receives its previous value and returns a new value used to react on a computation
+ * @param effectFn a function that receives the new value and is used to perform side effects (return a cleanup function), or an `EffectBundle` with `effect` and `error` handlers
+ * @param options `EffectOptions` -- name, defer, schedule, transparent
+ *
+ * @example
+ * ```ts
+ * const [count, setCount] = createSignal(0);
+ *
+ * createEffect(
+ *   () => count(),                  // compute: tracks `count`
+ *   value => console.log(value)     // effect: side effect
+ * );
+ *
+ * setCount(1); // logs 1 after the next flush
+ * ```
+ *
+ * @example
+ * ```ts
+ * createEffect(
+ *   () => userId(),
+ *   id => {
+ *     const ctrl = new AbortController();
+ *     fetch(`/users/${id}`, { signal: ctrl.signal });
+ *     return () => ctrl.abort(); // cleanup before next run / disposal
+ *   }
+ * );
+ * ```
+ *
+ * @description https://docs.solidjs.com/reference/basic-reactivity/create-effect
+ */ function createEffect(e, t, n) {
     effect(e, t.effect || t, t.error, {
         user: true,
         ...n
@@ -181,25 +250,25 @@ function createEffect(e, t, n) {
  */ function createReaction(e, t) {
     let n = undefined;
     cleanup(() => n?.());
-    const c = getOwner();
+    const r = getOwner();
     // The currently armed effect node. `track()` replaces the previous
     // subscription (1.x semantics): without disposing the superseded arm, its
     // sources stayed live (firing the callback for replaced dependencies), each
     // accumulated arm delivered its own fire, and un-fired arms leaked as live
     // effect nodes until the owner disposed (#2861).
-        let r;
-    return o => {
-        if (r) {
-            dispose(r);
-            r = undefined;
+        let o;
+    return i => {
+        if (o) {
+            dispose(o);
+            o = undefined;
         }
-        runWithOwner(c, () => {
-            effect(() => (o(), r = getOwner()), t => {
-                r = undefined;
+        runWithOwner(r, () => {
+            effect(() => (i(), o = getOwner()), t => {
+                o = undefined;
                 n?.();
-                const c = (e.effect || e)?.();
-                if (false && c !== undefined && typeof c !== "function") ;
-                n = c;
+                const r = (e.effect || e)?.();
+                if (false && r !== undefined && typeof r !== "function") ;
+                n = r;
                 dispose(t);
             }, e.error, {
                 ...false ? {
@@ -241,7 +310,7 @@ function createEffect(e, t, n) {
  * @param fn a reactive expression to resolve
  */ function resolve(e) {
     return new Promise((t, n) => {
-        createRoot(c => {
+        createRoot(r => {
             // Deliver effect applies on a microtask instead of the owner queue: an
             // incomplete transition stashes its effect queues until it settles, but
             // an action yielding this promise is itself what keeps the transition
@@ -249,26 +318,252 @@ function createEffect(e, t, n) {
             // still runs in place (under the transaction's view when created inside
             // an action step), and status/boundary notifications keep their normal
             // route through the inherited queue.
-            const r = getOwner();
-            const o = new MicrotaskQueue;
-            o.ke = r.C;
+            const o = getOwner();
+            const i = new MicrotaskQueue;
+            i.ke = o.C;
  // notify() forwards up the normal chain
-                        r.C = o;
+                        o.C = i;
             // A user effect rather than a bare computed: computeds are pull-based and
             // are only re-enqueued when a pending source *resolves* — a rejection just
             // marks them errored, so nothing would re-run and the promise would never
             // settle (#2842). The effect's error channel is notified on rejection.
                         effect(e, e => {
                 t(e);
-                c();
+                r();
             }, e => {
                 // The error arm already unwraps StatusError (#2840) — `err` is the
                 // user's original error, matching what error boundaries expose.
                 n(e);
-                c();
+                r();
+            }, 
+            // DIRECT_COMMIT: a source settling INTO the held transaction (e.g. a
+            // refresh this action issued) stages its landing; the effect's own
+            // recompute must not stage too, or the microtask apply reads the
+            // stale mainline value and resolves with old data.
+            {
+                user: true,
+                dt: CONFIG_DIRECT_COMMIT
+            });
+        });
+    });
+}
+
+/**
+ * Invalidates one reactive source, forcing it to re-execute even if its inputs
+ * haven't changed, and returns a promise for the target's NEXT QUIESCENT
+ * STATE — the re-ask (and anything that supersedes it) has settled.
+ *
+ * Pass either a Solid-created accessor or a projected store created from
+ * `createStore(fn, ...)` / `createProjection(...)`. `refresh()` is a
+ * write-like invalidation operation: it does not read the target's value, and
+ * refreshing a plain signal accessor is a no-op that resolves immediately.
+ *
+ * The returned promise is safe to ignore (fire-and-forget refresh is
+ * unchanged, and a failed refetch will not surface an unhandled rejection).
+ * Awaiting it gives imperative flows the settle point without a reactive
+ * read:
+ * - Accessor targets resolve with the settled value; store targets resolve
+ *   with the store node passed (reads through it are fresh after the await).
+ * - A failed re-ask rejects with the error (inside an action's generator,
+ *   `yield refresh(x)` throws back at the yield point and the action reverts
+ *   like any other failure).
+ * - Semantics are quiescence, not flight identity: if another refresh (or
+ *   any invalidation) supersedes this one mid-flight, the promise waits for
+ *   — and delivers — whatever finally lands.
+ * - Inside an action, truth landing into the held transaction is STAGED;
+ *   the promise still settles then (matching `resolve()`/`until()`, #2930)
+ *   and delivers the staged value — the caller's own optimistic override is
+ *   never the delivered value.
+ * - The re-ask itself stays verdict-quiet exactly as before: `isPending`
+ *   does not flip for a bare refresh (pair with `affects()` for a visible
+ *   pending window).
+ *
+ * @example
+ * ```ts
+ * const user = createMemo(async () => fetch(`/users/${id()}`).then(r => r.json()));
+ *
+ * // Fire-and-forget re-fetch
+ * <button onClick={() => refresh(user)}>Reload</button>;
+ *
+ * // Imperative settle point
+ * const fresh = await refresh(user);
+ * ```
+ */ function refresh(e) {
+    const t = e?.[$REFRESH];
+    if (!t) {
+        return Promise.resolve(undefined);
+    }
+    // Mark now, watch on a microtask. The waiter is resolve()'s machinery with
+    // two extra reader bits, but it must NOT compute at call time (effects
+    // recompute eagerly on creation): same-tick refreshes coalesce into ONE
+    // re-ask only because every mark lands before anything pulls, and eager
+    // per-call pulls turned three refreshes into three fetches. Deferred, the
+    // waiter's first read sees the coalesced state: FRESH_READ pulls the node
+    // through recompute if it is still dirty (self-deduping — a clean node
+    // no-ops, so N waiters cost one pull; this also closes the race where a
+    // waiter reads the PRE-re-ask value as settled and delivers stale), after
+    // which the read either parks on the re-ask's pending window (async — the
+    // settle walk re-runs it on every landing, equal-value and
+    // staged-under-hold included, and a rejection arrives through the effect's
+    // error channel) or serves the sync answer. AUTHORITATIVE_READ keeps an
+    // action's own optimistic override out of the delivered value. resolve()'s
+    // own eager compute is untouched: created after a refresh it still settles
+    // stale-while-revalidate (#2930) — its contract is "first settled value",
+    // not "next quiescent state".
+        markRefresh(t);
+    const n = new Promise((n, r) => {
+        queueMicrotask(() => {
+            // No createRoot: the microtask has no ambient owner, so the effect is
+            // naturally detached, and settle disposes the node directly — the root
+            // added ~560B of otherwise-shakeable machinery for nothing but the
+            // dev-mode NO_OWNER_EFFECT warning, so dev keeps a root husk purely to
+            // stay quiet. The waiter swaps in its microtask queue during its own
+            // first compute (before the initial apply enqueue), replacing the
+            // root-owner plumbing.
+            // Typed as the effect node, not Owner: the capture runs inside the
+            // effect's own compute, where the ambient owner IS the effect —
+            // exactly what dispose() takes.
+            let o = null;
+            const make = () => effect(() => {
+                if (o === null) {
+                    o = getOwner();
+                    const e = new MicrotaskQueue;
+                    e.ke = o.C;
+                    o.C = e;
+                }
+                return read(t);
+            }, t => {
+                n(typeof e === "function" ? t : e);
+                dispose(o);
+            }, e => {
+                r(e);
+                dispose(o);
             }, {
-                user: true
+                user: true,
+                dt: CONFIG_DIRECT_COMMIT | CONFIG_AUTHORITATIVE_READ | CONFIG_FRESH_READ
+            });
+            make();
+        });
+    });
+    // Fire-and-forget refresh must not turn a failed refetch into an unhandled
+    // rejection; awaiting callers attach their own handlers to `promise`.
+        n.catch(() => {});
+    return n;
+}
+
+/**
+ * Awaits a reactive predicate and resolves the first time it settles *truthy*,
+ * with that (narrowed) value. Falsy results and pending async reads both mean
+ * "not yet": the subscription stays live and re-evaluates as sources change.
+ * If the predicate settles with an error — a throw, or an async source that
+ * rejects — the promise rejects with it, as do timeout and abort.
+ *
+ * Where {@link resolve} answers "what is this value" (first settled value,
+ * whatever it is), `until` answers "when does the world confirm this
+ * condition". The difference matters inside an `action()`: `yield until(...)`
+ * holds the action's transaction — and any optimistic state riding it — open
+ * until the condition is independently true.
+ *
+ * To make that sound, `until`'s predicate reads the AUTHORITATIVE view — and
+ * this is the one read-semantics difference from `resolve`, which reads the
+ * normal (transaction's own) view where overrides are visible:
+ *
+ * - **Optimistic overrides are invisible** to the predicate. Your own
+ *   tentative write can never satisfy your own ack, even on the
+ *   single-primitive shape where the optimistic store IS the live-fed store.
+ *   (Derived computeds serve their normal cached values — express the
+ *   condition over sources of truth, not derived views of the overlay.)
+ * - **Everything else reads normally, including uncommitted transition-staged
+ *   data.** Real data is real wherever it currently lives. This is
+ *   load-bearing, not a loophole: truth that arrives *into* the open
+ *   transaction (a `refresh()` this action issued, an entangled landing)
+ *   stages and cannot commit until the hold releases — a predicate that
+ *   refused staged reads would deadlock on the very data it is waiting for.
+ *
+ * This is the acknowledgment mechanism for mutations confirmed on a live data
+ * channel (sockets, subscriptions, live queries) rather than by the mutation's
+ * own response: correlate by a client-generated id or version in the predicate,
+ * and let truth arrive however it arrives — push, refetch, or another tab.
+ *
+ * Failure composes with action semantics: a rejection is thrown back into the
+ * generator at the `yield` point — catchable there, or the action fails and
+ * its optimistic state reverts.
+ *
+ * Must be called *outside* a tracking scope.
+ *
+ * @example
+ * ```ts
+ * const send = action(async function* (text: string) {
+ *   const clientId = crypto.randomUUID();
+ *   setMessages(m => { m.push({ clientId, text, pending: true }); }); // optimistic
+ *   await socket.send({ clientId, text }); // fire-and-forget transport
+ *   // Hold until the live source echoes the write (authoritative view —
+ *   // the optimistic row above cannot satisfy this):
+ *   yield until(() => messages.some(m => m.clientId === clientId), { timeout: 10_000 });
+ * });
+ * ```
+ *
+ * @param fn a reactive predicate over authoritative state
+ * @param options optional `timeout` (ms) and abort `signal`
+ */ function until(e, t) {
+    // Late-bind the wakeup hook for the A17-silent ack paths (pay-for-use:
+    // apps that never call until() never retain it).
+    installAuthoritativeRead();
+    // Flip-entanglement (#3164 follow-up): the transaction this until() holds
+    // open (the action's, when yielded from one). The predicate is the user's
+    // declaration of what confirms it — when a foreign transition's staged
+    // write flips it truthy, that transition merges here and reveals at the
+    // joint settle instead of painting the confirmation under live optimism.
+        const n = activeTransition;
+    return new Promise((r, o) => {
+        const i = t?.signal;
+        if (i?.aborted) return o(i.reason);
+        createRoot(c => {
+            // Same delivery contract as resolve() (#2930): effect applies ride a
+            // microtask so the promise can settle while the transaction the caller
+            // yielded it into is still open — that transaction being open is the
+            // entire point of the hold.
+            const s = getOwner();
+            const u = new MicrotaskQueue;
+            u.ke = s.C;
+            s.C = u;
+            let f;
+            let a;
+            const settle = e => {
+                if (f !== undefined) clearTimeout(f);
+                if (a !== undefined) i.removeEventListener("abort", a);
+                e();
+                c();
+            };
+            effect(n === null ? e : () => {
+                const t = e();
+                // Runs inside the compute (pure phase): the confirming
+                // transition's stamps are live and its commit hasn't run, so
+                // the merge lands before any reveal. Falsy evaluations skip —
+                // non-flipping updates were never named as the confirmation.
+                                if (t) entangleConfirmingTransitions(getObserver(), n);
+                return t;
+            }, e => {
+                // Falsy is "not yet": keep the subscription live and wait for the
+                // next evaluation. Only a truthy settled value resolves.
+                if (e) settle(() => r(e));
+            }, e => settle(() => o(e)), 
+            // AUTHORITATIVE_READ: overrides invisible to the predicate.
+            // DIRECT_COMMIT: truth that stages into the held transaction (a
+            // refresh the action issued) must flow through to the microtask
+            // apply — a staged effect value would deadlock the hold on data
+            // the hold itself is keeping uncommitted.
+            {
+                user: true,
+                dt: CONFIG_AUTHORITATIVE_READ | CONFIG_DIRECT_COMMIT
             });
+            if (t?.timeout !== undefined) f = setTimeout(() => settle(() => o(new TimeoutError)), t.timeout);
+            if (i !== undefined) {
+                a = () => settle(() => o(i.reason));
+                i.addEventListener("abort", a, {
+                    once: true
+                });
+            }
         });
     });
 }
@@ -391,4 +686,4 @@ function createOptimistic(e, t) {
     });
 }
 
-export { accessor, createEffect, createMemo, createOptimistic, createReaction, createRenderEffect, createSignal, createTrackedEffect, onCleanup, onSettled, resolve };
+export { accessor, createEffect, createMemo, createOptimistic, createReaction, createRenderEffect, createSignal, createTrackedEffect, onCleanup, onSettled, refresh, resolve, until };