createBrowserHistory: one throwing pushState freezes the address bar for the rest of the session
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 76/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- react, typescript
调研方向
Read packages/history/src/index.ts at the flush implementation identified in the issue, then inspect tests/createBrowserHistory.test.ts for related coverage. Reproduce a one-time throwing pushState and check how queued actions and subscriber notifications are reset. Done when a failed write affects only that navigation and a later navigation updates the URL; add a regression test for that behavior.
由索引模型根据 Issue 内容生成。
描述
Which project does this relate to?
Router
Describe the bug
If the browser's history.pushState / replaceState throws a single time inside createBrowserHistory's flush, the address bar stops updating until a full reload (the router never calls history.flush() itself). The router keeps navigating (content and router.latestLocation change), but the URL stays on the old one.
The cause is in flush (packages/history/src/index.ts#L368-L389). next is cleared only after the browser call. When that call throws, next stays set. From then on every queueHistoryAction sees hasPendingAction === true and never queues flush again, so no later navigation reaches the browser. _ignoreSubscribers also stays true, so pushState / replaceState calls made by other code no longer notify the router.
The throw usually comes from outside the router: a browser extension or a third-party script that wraps history.pushState, or the browser refusing the update. That is how #6286 (URL doesn't update after the tab is idle, closed as caused by an extension) and #4239 (Illegal invocation from a script proxying history) were closed. Those triggers are external, but the router shouldn't stay broken for the whole session after one failed write.
Complete minimal reproducer
https://tanstack.com/router/latest (the docs site runs on TanStack Router). Run the snippet below in its DevTools console.
Steps to Reproduce the Bug
- Open https://tanstack.com/router/latest.
- In the console, make the next
pushStatethrow once, just as an extension's wrapper might, then put the router's ownpushStateback and click three docs links:
const wait = (ms) => new Promise((r) => setTimeout(r, ms))
const go = async (href) => {
document.querySelector(`a[href="${href}"]`).click()
await wait(1500)
return location.pathname
}
const routerPushState = history.pushState // the wrapper installed by createBrowserHistory
let once = true
history.pushState = function (...args) {
if (once) {
once = false
throw new Error('simulated failure')
}
return routerPushState.apply(history, args)
}
console.log(await go('/router/latest/docs/overview'))
history.pushState = routerPushState // pushState works normally again
console.log(await go('/router/latest/docs/routing/routing-concepts'))
console.log(await go('/router/latest/docs/api/router'))
- The page now shows "Router API", but all three logs print
/router/latestand the address bar stays there. Every later navigation is affected too, althoughpushStatehas been working again since the second click.
Expected behavior
A single failed history write affects only that navigation. The next navigation writes its URL as usual.
Screenshots or Videos
No response
Platform
- Router Version: @tanstack/react-router 1.170.45, @tanstack/history 1.162.5; same code on
main(08a419c) - OS: Linux, macOS
- Browser: Chrome, Brave
- Browser Version: current
- Bundler: Vite+ (Vite)
- Bundler Version: Vite+ 1.3.0
Additional context
A possible fix: clear the queued action before the browser call and always reset _ignoreSubscribers. Passing an explicit receiver also covers the case where win.history.pushState is the native method again (e.g. a script restored it), since native methods check this ("Illegal invocation").
const flush = () => {
if (!next) return
const [href, state, isPush] = next
next = undefined
rollbackLocation = undefined
history._ignoreSubscribers = true
try {
;(isPush ? win.history.pushState : win.history.replaceState).call(win.history, state, '', href)
} finally {
history._ignoreSubscribers = false
}
}
We run this as a pnpm patch (plus an optional retry one second later). With it, the snippet above leaves only the first navigation's URL unwritten (or retried), and every later navigation updates the address bar. Happy to open a PR with a regression test in tests/createBrowserHistory.test.ts if this direction is fine.
- 主要语言
- TypeScript
- 星标
- 15.3k
- 派生
- 1.9k
- 平均合并
- 1 天 5 小时
- 30 天内合并 PR
- 46
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
TanStack/router 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
Masked navigation drops the first character of the hash each time (__tempLocation hash missing '#')可能已有人在做 @hassanabrar202 于 8 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
router-generator: lazy-load Prettier (costs ~300–450ms per build even when formatting is off)可能已有人在做 @Sheraff 于 27 天前认领。 未关闭package: router-generator performance
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
router-generator: sibling `physical()` subtrees in a virtual route config generate duplicate identifiers可能已有人在做 @Sheraff 于 27 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
docs(router): clarify static title fallback in SPA mode可能已有人在做 @Rohan-Dedhia 于 18 天前认领。 未关闭
难度 1/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
相似的 Issue
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not exist可能已有人在做 @franpts2 今天认领。 未关闭docs
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 3 天内回复
-
ready-for-agent
难度 2/5 半天 新手友好度 70/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
cloudflare/nimbus#423 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
-
[BUG]: Shared links drop the configured basePath on GitHub Pages可能已有人在做 @anshulchikhale30-p 今天认领。 未关闭bug
难度 1/5 1 小时以内 新手友好度 88/100
StabilityNexus/IdentityTokens-EVM-Frontend#182 · 1 条评论 ·
维护者通常 1 天内回复