Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

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

Offen
  • Stimmt etwas nicht?
#562 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
48/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
react, typescript
Bereich
backend, frontend

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
402
Forks
32
Ø Merge
8 Std. 32 Min.
Gemergte PRs (30 T.)
111

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus voidzero-dev/void

Alle Issues in voidzero-dev/void

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.