AI & Agent Dev Bug Sandbox Back to Radar

Router.Refresh() Scrolls To Top After History.ReplaceState Changed The Search Params (Tree-Mismatch Retry Uses ScrollBehavior.Default)

router.refresh() unexpectedly scrolls the page to the top after a history.replaceState call changes the search params. The root cause is a hard-coded ScrollBehavior.Default in the tree-mismatch retry path (serverPatchReducer) and in the non-redirect server action path (serverActionReducer), which overrides the NoScroll intent of the original refresh.

highConfidence 95%Next.js Affected V16.2.3 Affected V16.3.4 Affected V16.4.0-Canary.19

Origin Analysis

After history.replaceState, the canonicalUrl changes but renderedSearch and tree remain old. router.refresh() fetches with the new canonicalUrl, causing a tree mismatch. The retry in serverPatchReducer hard-codes ScrollBehavior.Default, which creates a new CacheNode with a live ScrollRef, leading layout-router's handlePotentialScroll to scroll the document to top. The same hard-coded Default exists in serverActionReducer for actions without a redirect.

1. Install dependencies and start the Next.js app (production or dev). 2. Open the app and scroll down a few screens. 3. Click a button that calls window.history.replaceState(null, '', '?open=1') (documented native History API pattern). The URL updates and useSearchParams updates, but the page stays in place. 4. Click a button that calls router.refresh(). 5. Observe the page jumps to the top, documentElement.scrollTop becomes 0.

Fixing Code Block

0x7F 45 4C 46 02 01 01 000x90 12 AB 04 C1 7E 33 08
0xA4 1C 90 3E 77 0B D2 580x11 F6 6A 2C 80 19 DE 44
0x00 00 00 00 03 00 3E 000x01 00 B7 4D 55 90 0C 61
0x6C 69 62 63 2E 73 6F 2E0x36 00 8E 17 42 AA 05 F3
0xDE C0 DE 01 8B 45 FC 890xC7 5D 20 6F 91 03 E4 78
0x13 37 00 4F 9A 2D E1 700x08 B4 5C 22 71 D0 4A 16
0x48 8D 3D 22 01 00 00 E80x91 FF 0A 63 2E 57 B8 04
0x5A 91 C3 0E 44 70 1B 880x02 6F 39 C4 15 80 ED 27
0xFF 15 40 20 60 00 48 890xC3 90 7A 01 4C 28 B1 56
0x0F 1F 44 00 00 55 48 890xE5 C3 18 6D 92 0B 33 A7

Edge Case Audit

This hotfix may suppress scrolling in rare cases where a tree-mismatch retry legitimately should scroll (e.g., after a client-side navigation that triggers a retry). It could alter scroll behavior for server actions that previously scrolled to top by default. Thorough testing of navigation scroll behavior (including back/forward and server action flows) is required. Rollback: revert to hard-coded ScrollBehavior.Default in both reducers if regressions occur.