Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Navigation commit failure leaves the loading state active and causes inconsistent internal state

未关闭
#562 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

Read packages/react/src/runtime/pages-client.ts around finishNavigation() and packages/void/src/pages/navigation-engine.ts around makeCommit(). Trace how pending visits, reducer failure actions, internal committed state, and scrollRestoration.writeHistory() interact when history writing throws. Reproduce with the provided component and verify the error propagates, navigation returns to idle, state stays consistent, and an older failure cannot reset a newer navigation.

由索引模型根据 Issue 内容生成。

描述

Problem

When history.pushState() or history.replaceState() throws during navigation, router.visit() rejects, but useNavigation().state remains loading.

Additionally, Void updates its internal committed state before writing browser history. If the history update fails, the browser URL and internal navigation state become inconsistent.

Reproduction

  1. Configure a valid Void page at /b.
  2. Render the following React component:
import { useNavigation, useRouter } from '@void/react';

export default function Example() {
  const router = useRouter();
  const navigation = useNavigation();

  async function navigate() {
    const original = history.pushState;

    history.pushState = () => {
      throw new DOMException(
        'History update failed',
        'SecurityError',
      );
    };

    try {
      await router.visit('/b');
    } catch {
      // Inspect the navigation state after failure.
    } finally {
      history.pushState = original;
    }
  }

  return (
    <>
      <p>Navigation: {navigation.state}</p>
      <button onClick={navigate}>Navigate</button>
    </>
  );
}
  1. Click the button and inspect the navigation state and browser URL after the failed navigation.

Actual behavior

  • router.visit() rejects.
  • useNavigation().state remains loading.
  • The browser URL remains unchanged.
  • Void's internal current URL and committed resource have already been updated.
  • Restoring normal history behavior and navigating to another page clears the stuck navigation state.

Expected behavior

A failed history update should terminate the navigation cleanly and preserve state consistency.

  • The navigation state returns to idle.
  • The original error propagates to the router.visit() caller.
  • The browser URL, rendered page, and internal navigation state remain consistent.
  • Subsequent navigations continue to work normally.

Root cause

In packages/react/src/runtime/pages-client.ts, finishNavigation() rejects the visit promise when resource.commit() fails, but does not clear the active pending navigation or dispatch a failure action.

resource.commit()
  .then((committed) => {
    // Successful navigation cleanup.
  })
  .catch((error) => {
    const visitSettler = pendingVisitSettlers.get(resource.id);

    if (visitSettler) {
      pendingVisitSettlers.delete(resource.id);
      visitSettler.reject(error);
    }
  });

The reducer already supports fail and abandon actions that reset the navigation state, but neither is dispatched in this failure path.

Additionally, in packages/void/src/pages/navigation-engine.ts, makeCommit() modifies internal navigation state before updating browser history.

_urlNavigationId = resourceId;

// Update committed resource and deferred registry ownership.

applyClientHead(result.pageData.head as HeadDescriptor | undefined);
_currentFetchUrl = commitTarget.fetchUrl;

if (!options._popstate) {
  const historyUrl = commitTarget.fetchUrl + commitTarget.hash;
  scrollRestoration.writeHistory(historyUrl, !!options.replace);
}

If scrollRestoration.writeHistory() throws, the earlier internal state mutations are not rolled back, leaving the commit partially applied.

Suggested fix

  • Ensure the React adapter clears the active pending navigation and dispatches the appropriate failure or rollback action when resource.commit() rejects.
  • Make makeCommit() failure-safe so that a failed history update cannot leave internal committed state inconsistent with browser history.
  • Ensure cleanup for a failed navigation does not overwrite or reset a newer navigation.
  • Preserve existing resource lifecycle management, deferred registry ownership, and navigation ordering guarantees.

Acceptance criteria

  • A failed history.pushState() or history.replaceState() does not leave navigation in loading or submitting.
  • router.visit() rejects with the original error.
  • The browser URL, rendered page, and internal navigation state remain consistent after failure.
  • Subsequent navigations work normally.
  • Cleanup from an older failed navigation does not modify the state of a newer navigation.

Related issues

Unlike these issues, this report concerns error handling and state consistency when a browser history update throws during navigation commit.

主要语言
TypeScript
星标
402
派生
32
平均合并
8 小时 32 分钟
30 天内合并 PR
111

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

voidzero-dev/void 的其他 Issue

查看 voidzero-dev/void 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

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