createBrowserHistory: one throwing pushState freezes the address bar for the rest of the session

未关闭
#8,786 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@tuanphungcz 已经在做这个了。

开始于 2026年10月22日。

  • #8787 来自 @tuanphungcz —— 未关闭

评估

难度
3/5
预计耗时
1-2 天
新手友好度
76/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
react, typescript
领域
frontend, web-dev

调研方向

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
  1. Open https://tanstack.com/router/latest.
  2. In the console, make the next pushState throw once, just as an extension's wrapper might, then put the router's own pushState back 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'))
  1. The page now shows "Router API", but all three logs print /router/latest and the address bar stays there. Every later navigation is affected too, although pushState has 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

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TanStack/router 的其他 Issue

查看 TanStack/router 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。