Derived Stores

docs/framework/solid/reference/useStore.md

@@ -3,4 +3,4 @@ title: Use Store
 id: useStore
 ---
 
-Please see [/packages/solid-store/src/index.ts](https://github.com/tanstack/store/tree/main/packages/solid-store/src/index.ts)
+Please see [/packages/solid-store/src/store.ts](https://github.com/tanstack/store/tree/main/packages/solid-store/src/index.ts)

docs/framework/vue/reference/useStore.md

@@ -3,4 +3,4 @@ title: Use Store
 id: useStore
 ---
 
-Please see [/packages/vue-store/src/index.ts](https://github.com/tanstack/store/tree/main/packages/vue-store/src/index.ts)
+Please see [/packages/vue-store/src/store.ts](https://github.com/tanstack/store/tree/main/packages/vue-store/src/index.ts)

knip.json

@@ -1,6 +1,18 @@
 {
   "$schema": "https://unpkg.com/knip@5/schema.json",
   "workspaces": {
+    "packages/angular-store": {
+      "ignoreDependencies": ["@angular/compiler-cli"]
+    },
+    "packages/store": {
+      "ignore": ["src/tests/derived.bench.ts"],
+      "ignoreDependencies": [
+        "@angular/core",
+        "@preact/signals",
+        "solid-js",
+        "vue"
+      ]
+    },
     "packages/vue-store": {
       "ignoreDependencies": ["vue2", "vue2.7"]
     }

package.json

@@ -55,16 +55,16 @@
     "publint": "^0.2.9",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rimraf": "^5.0.10",
-    "sherif": "^0.11.0",
+    "rimraf": "^5.0.5",
+    "sherif": "^0.7.0",
     "solid-js": "^1.8.20",
     "typescript": "5.4.2",
     "typescript49": "npm:[email protected]",
     "typescript50": "npm:[email protected]",
     "typescript51": "npm:[email protected]",
     "typescript52": "npm:[email protected]",
     "typescript53": "npm:[email protected]",
-    "vite": "^5.4.0",
+    "vite": "^5.1.0",
     "vitest": "^2.0.5",
     "vue": "^3.4.37"
   }

packages/store/package.json

@@ -29,6 +29,7 @@
     "test:types:ts53": "node ../../node_modules/typescript53/lib/tsc.js",
     "test:types:ts54": "tsc",
     "test:lib": "vitest",
+    "test:bench": "vitest bench",
     "test:lib:dev": "pnpm run test:lib --watch",
     "test:build": "publint --strict",
     "build": "vite build"
@@ -54,5 +55,11 @@
   "files": [
     "dist",
     "src"
-  ]
+  ],
+  "devDependencies": {
+    "@angular/core": "^17.3.12",
+    "solid-js": "^1.8.20",
+    "@preact/signals": "^1.3.0",
+    "vue": "^3.4.37"
+  }
 }

packages/store/src/derived.ts

@@ -0,0 +1,115 @@
+import { Store } from './store'
+import type { Listener } from './types'
+
+interface DerivedOptions<TState> {
+  onSubscribe?: (listener: Listener, derived: Derived<TState>) => () => void
+  onUpdate?: () => void
+}
+
+export type Deps = Array<Derived<any> | Store<any>>
+
+export class Derived<TState> {
+  _store!: Store<TState>
+  rootStores = new Set<Store<unknown>>()
+  deps: Deps
+
+  // Functions representing the subscriptions. Call a function to cleanup
+  _subscriptions: Array<() => void> = []
+
+  // What store called the current update, if any
+  _whatStoreIsCurrentlyInUse: Store<unknown> | null = null
+
+  constructor(deps: Deps, fn: () => TState, options?: DerivedOptions<TState>) {
+    this.deps = deps
+    this._store = new Store(fn(), {
+      onSubscribe: options?.onSubscribe?.bind(this) as never,
+      onUpdate: options?.onUpdate,
+    })
+    /**
+     * This is here to solve the pyramid dependency problem where:
+     *       A
+     *      / \
+     *     B   C
+     *      \ /
+     *       D
+     *
+     * Where we deeply traverse this tree, how do we avoid D being recomputed twice; once when B is updated, once when C is.
+     *
+     * To solve this, we create linkedDeps that allows us to sync avoid writes to the state until all of the deps have been
+     * resolved.
+     *
+     * This is a record of stores, because derived stores are not able to write values to, but stores are
+     */
+    const storeToDerived = new Map<Store<unknown>, Set<Derived<unknown>>>()
+    const derivedToStore = new Map<Derived<unknown>, Set<Store<unknown>>>()
+
+    const updateStoreToDerived = (
+      store: Store<unknown>,
+      dep: Derived<unknown>,
+    ) => {
+      const prevDerivesForStore = storeToDerived.get(store) || new Set()
+      prevDerivesForStore.add(dep)
+      storeToDerived.set(store, prevDerivesForStore)
+    }
+    for (const dep of deps) {
+      if (dep instanceof Derived) {
+        derivedToStore.set(dep, dep.rootStores)
+        for (const store of dep.rootStores) {
+          this.rootStores.add(store)
+          updateStoreToDerived(store, dep)
+        }
+      } else if (dep instanceof Store) {
+        this.rootStores.add(dep)
+        updateStoreToDerived(dep, this as Derived<unknown>)
+      }
+    }
+
+    let __depsThatHaveWrittenThisTick: Deps = []
+
+    for (const dep of deps) {
+      const isDepAStore = dep instanceof Store
+      let relatedLinkedDerivedVals: null | Set<Derived<unknown>> = null
+
+      const unsub = dep.subscribe(() => {
+        const store = isDepAStore ? dep : dep._whatStoreIsCurrentlyInUse
+        this._whatStoreIsCurrentlyInUse = store
+        if (store) {
+          relatedLinkedDerivedVals = storeToDerived.get(store) ?? null
+        }
+
+        __depsThatHaveWrittenThisTick.push(dep)
+        if (
+          !relatedLinkedDerivedVals ||
+          __depsThatHaveWrittenThisTick.length === relatedLinkedDerivedVals.size
+        ) {
+          // Yay! All deps are resolved - write the value of this derived
+          this._store.setState(fn)
+          // Cleanup the deps that have written this tick
+          __depsThatHaveWrittenThisTick = []
+          this._whatStoreIsCurrentlyInUse = null
+          return
+        }
+      })
+
+      this._subscriptions.push(unsub)
+    }
+  }
+
+  get state() {
+    return this._store.state
+  }
+
+  cleanup = () => {
+    for (const cleanup of this._subscriptions) {
+      cleanup()
+    }
+  };
+
+  [(Symbol as never as { readonly dispose: unique symbol }).dispose]() {
+    this.cleanup()
+  }
+
+  subscribe = (listener: Listener) => {
+    return this._store.subscribe(listener)
+  }
+}

packages/store/src/effect.ts

@@ -0,0 +1,22 @@
+import { Derived } from './derived'
+import type { Deps } from './derived'
+
+export class Effect {
+  _derived: Derived<void>
+
+  constructor(items: Deps, effectFn: () => void) {
+    this._derived = new Derived(items, () => {}, {
+      onUpdate() {
+        effectFn()
+      },
+    })
+  }
+
+  cleanup() {
+    this._derived.cleanup()
+  }
+
+  [(Symbol as never as { readonly dispose: unique symbol }).dispose]() {
+    this.cleanup()
+  }
+}

packages/store/src/index.ts

@@ -1,70 +1,4 @@
-export type AnyUpdater = (...args: Array<any>) => any
-
-export type Listener = () => void
-
-export interface StoreOptions<
-  TState,
-  TUpdater extends AnyUpdater = (cb: TState) => TState,
-> {
-  updateFn?: (previous: TState) => (updater: TUpdater) => TState
-  onSubscribe?: (
-    listener: Listener,
-    store: Store<TState, TUpdater>,
-  ) => () => void
-  onUpdate?: () => void
-}
-
-export class Store<
-  TState,
-  TUpdater extends AnyUpdater = (cb: TState) => TState,
-> {
-  listeners = new Set<Listener>()
-  state: TState
-  options?: StoreOptions<TState, TUpdater>
-  _batching = false
-  _flushing = 0
-
-  constructor(initialState: TState, options?: StoreOptions<TState, TUpdater>) {
-    this.state = initialState
-    this.options = options
-  }
-
-  subscribe = (listener: Listener) => {
-    this.listeners.add(listener)
-    const unsub = this.options?.onSubscribe?.(listener, this)
-    return () => {
-      this.listeners.delete(listener)
-      unsub?.()
-    }
-  }
-
-  setState = (updater: TUpdater) => {
-    const previous = this.state
-    this.state = this.options?.updateFn
-      ? this.options.updateFn(previous)(updater)
-      : (updater as any)(previous)
-
-    // Always run onUpdate, regardless of batching
-    this.options?.onUpdate?.()
-
-    // Attempt to flush
-    this._flush()
-  }
-
-  _flush = () => {
-    if (this._batching) return
-    const flushId = ++this._flushing
-    this.listeners.forEach((listener) => {
-      if (this._flushing !== flushId) return
-      listener()
-    })
-  }
-
-  batch = (cb: () => void) => {
-    if (this._batching) return cb()
-    this._batching = true
-    cb()
-    this._batching = false
-    this._flush()
-  }
-}
+export * from './derived'
+export * from './effect'
+export * from './store'
+export * from './types'

packages/store/src/store.ts

@@ -0,0 +1,68 @@
+import type { AnyUpdater, Listener } from './types'
+
+interface StoreOptions<
+  TState,
+  TUpdater extends AnyUpdater = (cb: TState) => TState,
+> {
+  updateFn?: (previous: TState) => (updater: TUpdater) => TState
+  onSubscribe?: (
+    listener: Listener,
+    store: Store<TState, TUpdater>,
+  ) => () => void
+  onUpdate?: () => void
+}
+
+export class Store<
+  TState,
+  TUpdater extends AnyUpdater = (cb: TState) => TState,
+> {
+  listeners = new Set<Listener>()
+  state: TState
+  options?: StoreOptions<TState, TUpdater>
+  _batching = false
+  _flushing = 0
+
+  constructor(initialState: TState, options?: StoreOptions<TState, TUpdater>) {
+    this.state = initialState
+    this.options = options
+  }
+
+  subscribe = (listener: Listener) => {
+    this.listeners.add(listener)
+    const unsub = this.options?.onSubscribe?.(listener, this)
+    return () => {
+      this.listeners.delete(listener)
+      unsub?.()
+    }
+  }
+
+  setState = (updater: TUpdater) => {
+    const previous = this.state
+    this.state = this.options?.updateFn
+      ? this.options.updateFn(previous)(updater)
+      : (updater as any)(previous)
+
+    // Always run onUpdate, regardless of batching
+    this.options?.onUpdate?.()
+
+    // Attempt to flush
+    this._flush()
+  }
+
+  _flush = () => {
+    if (this._batching) return
+    const flushId = ++this._flushing
+    for (const listener of this.listeners) {
+      if (this._flushing !== flushId) continue
+      listener()
+    }
+  }
+
+  batch = (cb: () => void) => {
+    if (this._batching) return cb()
+    this._batching = true
+    cb()
+    this._batching = false
+    this._flush()
+  }
+}

packages/store/src/types.ts

@@ -0,0 +1,3 @@
+export type AnyUpdater = (...args: Array<any>) => any
+
+export type Listener = () => void