chore: migrate to @tanstack/store 0.9.1 (#6691)

Author: Sheraff

packages/react-router/package.json

@@ -97,7 +97,7 @@
   },
   "dependencies": {
     "@tanstack/history": "workspace:*",
-    "@tanstack/react-store": "^0.8.0",
+    "@tanstack/react-store": "^0.9.1",
     "@tanstack/router-core": "workspace:*",
     "isbot": "^5.1.22",
     "tiny-invariant": "^1.3.3",

packages/router-core/package.json

@@ -160,7 +160,7 @@
   },
   "dependencies": {
     "@tanstack/history": "workspace:*",
-    "@tanstack/store": "^0.8.0",
+    "@tanstack/store": "^0.9.1",
     "cookie-es": "^2.0.0",
     "seroval": "^1.4.2",
     "seroval-plugins": "^1.4.2",

packages/router-core/src/router.ts

@@ -871,6 +871,13 @@ export function getLocationChangeInfo(routerState: {
   return { fromLocation, toLocation, pathChanged, hrefChanged, hashChanged }
 }
 
+function filterRedirectedCachedMatches<T extends { status: string }>(
+  matches: Array<T>,
+): Array<T> {
+  const filtered = matches.filter((d) => d.status !== 'redirected')
+  return filtered.length === matches.length ? matches : filtered
+}
+
 export type CreateRouterFn = <
   TRouteTree extends AnyRoute,
   TTrailingSlashOption extends TrailingSlashOption = 'never',
@@ -1123,16 +1130,7 @@ export class RouterCore<
           getInitialRouterState(this.latestLocation),
         ) as unknown as Store<any>
       } else {
-        this.__store = new Store(getInitialRouterState(this.latestLocation), {
-          onUpdate: () => {
-            this.__store.state = {
-              ...this.state,
-              cachedMatches: this.state.cachedMatches.filter(
-                (d) => !['redirected'].includes(d.status),
-              ),
-            }
-          },
-        })
+        this.__store = new Store(getInitialRouterState(this.latestLocation))
 
         setupScrollRestoration(this)
       }
@@ -1175,10 +1173,10 @@ export class RouterCore<
     }
 
     if (needsLocationUpdate && this.__store) {
-      this.__store.state = {
-        ...this.state,
+      this.__store.setState((s) => ({
+        ...s,
         location: this.latestLocation,
-      }
+      }))
     }
 
     if (
@@ -2445,7 +2443,9 @@ export class RouterCore<
                           ...s.cachedMatches,
                           ...exitingMatches.filter(
                             (d) =>
-                              d.status !== 'error' && d.status !== 'notFound',
+                              d.status !== 'error' &&
+                              d.status !== 'notFound' &&
+                              d.status !== 'redirected',
                           ),
                         ],
                       }
@@ -2600,12 +2600,21 @@ export class RouterCore<
             : ''
 
       if (matchesKey) {
-        this.__store.setState((s) => ({
-          ...s,
-          [matchesKey]: s[matchesKey]?.map((d) =>
-            d.id === id ? updater(d) : d,
-          ),
-        }))
+        if (matchesKey === 'cachedMatches') {
+          this.__store.setState((s) => ({
+            ...s,
+            cachedMatches: filterRedirectedCachedMatches(
+              s.cachedMatches.map((d) => (d.id === id ? updater(d) : d)),
+            ),
+          }))
+        } else {
+          this.__store.setState((s) => ({
+            ...s,
+            [matchesKey]: s[matchesKey]?.map((d) =>
+              d.id === id ? updater(d) : d,
+            ),
+          }))
+        }
       }
     })
   }

packages/router-core/tests/load.test.ts

@@ -167,10 +167,16 @@ describe('beforeLoad skip or exec', () => {
       beforeLoad,
     })
     await router.preloadRoute({ to: '/foo' })
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     await sleep(10)
     await router.navigate({ to: '/foo' })
 
     expect(router.state.location.pathname).toBe('/foo')
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     expect(beforeLoad).toHaveBeenCalledTimes(2)
   })
 
@@ -184,9 +190,15 @@ describe('beforeLoad skip or exec', () => {
     })
     router.preloadRoute({ to: '/foo' })
     await Promise.resolve()
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     await router.navigate({ to: '/foo' })
 
     expect(router.state.location.pathname).toBe('/foo')
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     expect(beforeLoad).toHaveBeenCalledTimes(2)
   })
 
@@ -362,10 +374,16 @@ describe('loader skip or exec', () => {
       loader,
     })
     await router.preloadRoute({ to: '/foo' })
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     await sleep(10)
     await router.navigate({ to: '/foo' })
 
     expect(router.state.location.pathname).toBe('/foo')
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     expect(loader).toHaveBeenCalledTimes(2)
   })
 
@@ -379,12 +397,40 @@ describe('loader skip or exec', () => {
     })
     router.preloadRoute({ to: '/foo' })
     await Promise.resolve()
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     await router.navigate({ to: '/foo' })
 
     expect(router.state.location.pathname).toBe('/bar')
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
     expect(loader).toHaveBeenCalledTimes(1)
   })
 
+  test('updateMatch removes redirected matches from cachedMatches', async () => {
+    const loader = vi.fn()
+    const router = setup({ loader })
+
+    await router.preloadRoute({ to: '/foo' })
+    expect(router.state.cachedMatches).toEqual(
+      expect.arrayContaining([expect.objectContaining({ id: '/foo/foo' })]),
+    )
+
+    router.updateMatch('/foo/foo', (prev) => ({
+      ...prev,
+      status: 'redirected',
+    }))
+
+    expect(router.state.cachedMatches.some((d) => d.id === '/foo/foo')).toBe(
+      false,
+    )
+    expect(
+      router.state.cachedMatches.some((d) => d.status === 'redirected'),
+    ).toBe(false)
+  })
+
   test('exec if rejected preload (error)', async () => {
     const loader = vi.fn<Loader>(async ({ preload }) => {
       if (preload) throw new Error('error')

packages/solid-router/package.json

@@ -106,7 +106,7 @@
     "@solidjs/meta": "^0.29.4",
     "@tanstack/history": "workspace:*",
     "@tanstack/router-core": "workspace:*",
-    "@tanstack/solid-store": "^0.8.0",
+    "@tanstack/solid-store": "^0.9.1",
     "isbot": "^5.1.22",
     "tiny-invariant": "^1.3.3",
     "tiny-warning": "^1.0.3"

packages/vue-router/package.json

@@ -72,7 +72,7 @@
   "dependencies": {
     "@tanstack/history": "workspace:*",
     "@tanstack/router-core": "workspace:*",
-    "@tanstack/vue-store": "^0.8.0",
+    "@tanstack/vue-store": "^0.9.1",
     "@vue/runtime-dom": "^3.5.25",
     "isbot": "^5.1.22",
     "jsesc": "^3.0.2",