fix(store): improve performance by ~4x (#236)

* refactor(store): improve __flush_internals performance by pre-sorting derived deps

* ci: apply automated fixes and generate docs

* check unicity of deps

* ci: apply automated fixes and generate docs

* registerOnGraph only sort when pushing in array

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: Sheraff

docs/reference/classes/derived.md

@@ -93,7 +93,7 @@ Defined in: [derived.ts:68](https://github.com/TanStack/store/blob/main/packages
 checkIfRecalculationNeededDeeply(): void
 ```
 
-Defined in: [derived.ts:162](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L162)
+Defined in: [derived.ts:178](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L178)
 
 #### Returns
 
@@ -139,7 +139,7 @@ prevVal: undefined | NonNullable<TState>;
 mount(): () => void
 ```
 
-Defined in: [derived.ts:183](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L183)
+Defined in: [derived.ts:199](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L199)
 
 #### Returns
 
@@ -157,7 +157,7 @@ Defined in: [derived.ts:183](https://github.com/TanStack/store/blob/main/package
 recompute(): void
 ```
 
-Defined in: [derived.ts:154](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L154)
+Defined in: [derived.ts:170](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L170)
 
 #### Returns
 
@@ -193,7 +193,7 @@ readonly (
 subscribe(listener): () => void
 ```
 
-Defined in: [derived.ts:195](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L195)
+Defined in: [derived.ts:211](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L211)
 
 #### Parameters
 
@@ -217,7 +217,7 @@ Defined in: [derived.ts:195](https://github.com/TanStack/store/blob/main/package
 unregisterFromGraph(deps): void
 ```
 
-Defined in: [derived.ts:134](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L134)
+Defined in: [derived.ts:147](https://github.com/TanStack/store/blob/main/packages/store/src/derived.ts#L147)
 
 #### Parameters
 

docs/reference/functions/batch.md

@@ -11,7 +11,7 @@ title: batch
 function batch(fn): void
 ```
 
-Defined in: [scheduler.ts:142](https://github.com/TanStack/store/blob/main/packages/store/src/scheduler.ts#L142)
+Defined in: [scheduler.ts:133](https://github.com/TanStack/store/blob/main/packages/store/src/scheduler.ts#L133)
 
 ## Parameters
 

docs/reference/variables/storetoderived.md

@@ -8,7 +8,7 @@ title: __storeToDerived
 # Variable: \_\_storeToDerived
 
 ```ts
-const __storeToDerived: WeakMap<Store<unknown, (cb) => unknown>, Set<Derived<unknown, readonly any[]>>>;
+const __storeToDerived: WeakMap<Store<unknown, (cb) => unknown>, Derived<unknown, readonly any[]>[]>;
 ```
 
 Defined in: [scheduler.ts:19](https://github.com/TanStack/store/blob/main/packages/store/src/scheduler.ts#L19)

packages/store/src/derived.ts

@@ -105,6 +105,7 @@ export class Derived<
   registerOnGraph(
     deps: ReadonlyArray<Derived<any> | Store<any>> = this.options.deps,
   ) {
+    const toSort = new Set<Array<Derived<unknown>>>()
     for (const dep of deps) {
       if (dep instanceof Derived) {
         // First register the intermediate derived value if it's not already registered
@@ -115,10 +116,12 @@ export class Derived<
         // Register the derived as related derived to the store
         let relatedLinkedDerivedVals = __storeToDerived.get(dep)
         if (!relatedLinkedDerivedVals) {
-          relatedLinkedDerivedVals = new Set()
+          relatedLinkedDerivedVals = [this as never]
           __storeToDerived.set(dep, relatedLinkedDerivedVals)
+        } else if (!relatedLinkedDerivedVals.includes(this as never)) {
+          relatedLinkedDerivedVals.push(this as never)
+          toSort.add(relatedLinkedDerivedVals)
         }
-        relatedLinkedDerivedVals.add(this as never)
 
         // Register the store as a related store to this derived
         let relatedStores = __derivedToStore.get(this as never)
@@ -129,6 +132,16 @@ export class Derived<
         relatedStores.add(dep)
       }
     }
+    for (const arr of toSort) {
+      // First sort deriveds by dependency order
+      arr.sort((a, b) => {
+        // If a depends on b, b should go first
+        if (a instanceof Derived && a.options.deps.includes(b)) return 1
+        // If b depends on a, a should go first
+        if (b instanceof Derived && b.options.deps.includes(a)) return -1
+        return 0
+      })
+    }
   }
 
   unregisterFromGraph(
@@ -140,7 +153,10 @@ export class Derived<
       } else if (dep instanceof Store) {
         const relatedLinkedDerivedVals = __storeToDerived.get(dep)
         if (relatedLinkedDerivedVals) {
-          relatedLinkedDerivedVals.delete(this as never)
+          relatedLinkedDerivedVals.splice(
+            relatedLinkedDerivedVals.indexOf(this as never),
+            1,
+          )
         }
 
         const relatedStores = __derivedToStore.get(this as never)

packages/store/src/scheduler.ts

@@ -1,4 +1,4 @@
-import { Derived } from './derived'
+import type { Derived } from './derived'
 import type { Store } from './store'
 
 /**
@@ -18,7 +18,7 @@ import type { Store } from './store'
  */
 export const __storeToDerived = new WeakMap<
   Store<unknown>,
-  Set<Derived<unknown>>
+  Array<Derived<unknown>>
 >()
 export const __derivedToStore = new WeakMap<
   Derived<unknown>,
@@ -35,17 +35,8 @@ const __pendingUpdates = new Set<Store<unknown>>()
 // Add a map to store initial values before batch
 const __initialBatchValues = new Map<Store<unknown>, unknown>()
 
-function __flush_internals(relatedVals: Set<Derived<unknown>>) {
-  // First sort deriveds by dependency order
-  const sorted = Array.from(relatedVals).sort((a, b) => {
-    // If a depends on b, b should go first
-    if (a instanceof Derived && a.options.deps.includes(b)) return 1
-    // If b depends on a, a should go first
-    if (b instanceof Derived && b.options.deps.includes(a)) return -1
-    return 0
-  })
-
-  for (const derived of sorted) {
+function __flush_internals(relatedVals: ReadonlyArray<Derived<unknown>>) {
+  for (const derived of relatedVals) {
     if (__depsThatHaveWrittenThisTick.current.includes(derived)) {
       continue
     }
@@ -57,7 +48,7 @@ function __flush_internals(relatedVals: Set<Derived<unknown>>) {
     if (stores) {
       for (const store of stores) {
         const relatedLinkedDerivedVals = __storeToDerived.get(store)
-        if (!relatedLinkedDerivedVals) continue
+        if (!relatedLinkedDerivedVals?.length) continue
         __flush_internals(relatedLinkedDerivedVals)
       }
     }