fix(solid-router): setting search params with 2 parallel navigate calls (#5797)

Author: birkskyum

packages/router-core/src/router.ts

@@ -896,6 +896,7 @@ export class RouterCore<
   rewrite?: LocationRewrite
   origin?: string
   latestLocation!: ParsedLocation<FullSearchSchema<TRouteTree>>
+  pendingBuiltLocation?: ParsedLocation<FullSearchSchema<TRouteTree>>
   basepath!: string
   routeTree!: TRouteTree
   routesById!: RoutesById<TRouteTree>
@@ -1593,7 +1594,8 @@ export class RouterCore<
       } = {},
     ): ParsedLocation => {
       // We allow the caller to override the current location
-      const currentLocation = dest._fromLocation || this.latestLocation
+      const currentLocation =
+        dest._fromLocation || this.pendingBuiltLocation || this.latestLocation
 
       const allCurrentLocationMatches = this.matchRoutes(currentLocation, {
         _buildLocation: true,
@@ -1956,14 +1958,28 @@ export class RouterCore<
       _includeValidateSearch: true,
     })
 
-    return this.commitLocation({
+    this.pendingBuiltLocation = location as ParsedLocation<
+      FullSearchSchema<TRouteTree>
+    >
+
+    const commitPromise = this.commitLocation({
       ...location,
       viewTransition,
       replace,
       resetScroll,
       hashScrollIntoView,
       ignoreBlocker,
     })
+
+    // Clear pending location after commit starts
+    // We do this on next microtask to allow synchronous navigate calls to chain
+    Promise.resolve().then(() => {
+      if (this.pendingBuiltLocation === location) {
+        this.pendingBuiltLocation = undefined
+      }
+    })
+
+    return commitPromise
   }
 
   /**

packages/solid-router/tests/useNavigate.test.tsx

@@ -1253,7 +1253,7 @@ test('when navigating to /posts/$postId/info which is imperatively masked as /po
   expect(window.location.pathname).toEqual('/posts/id1')
 })
 
-test.skip('when setting search params with 2 parallel navigate calls', async () => {
+test('when setting search params with 2 parallel navigate calls', async () => {
   const rootRoute = createRootRoute()
 
   const IndexComponent = () => {
@@ -1301,6 +1301,9 @@ test.skip('when setting search params with 2 parallel navigate calls', async ()
 
   render(() => <RouterProvider router={router} />)
 
+  // Wait for router to initialize with defaults
+  await screen.findByTestId('param1')
+
   // console.log(router.state.location)
   expect(router.state.location.search).toEqual({
     param1: 'param1-default',