Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: popstate navigation wasn't cancelling ongoing navigation() calls when landing on the same page #10727

Merged
merged 4 commits into from Oct 9, 2023

Conversation

JakeBeaver
Copy link
Contributor

@JakeBeaver JakeBeaver commented Sep 14, 2023

Fixes #10512
Maybe also this? #10700

Bug description

When navigating with popstate , there is an early return if only # part of the url changed.

This ignores the edgecase where quick navigation ends on the same page, e.g. A -> B -> A

In this case:

  1. popstate to B calls navigate()
  2. popstate back to A returns early doing nothing
  3. The first navigate() starts rendering
  4. We end up with B rendered, but A in the address bar

Proposed fix

popstate event handler should update the navigation token before anything else happens


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@changeset-bot
Copy link

changeset-bot bot commented Sep 14, 2023

🦋 Changeset detected

Latest commit: 8c323bd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@JakeBeaver JakeBeaver changed the title Fix quick navigation fix: quick navigation Sep 14, 2023
@JakeBeaver JakeBeaver changed the title fix: quick navigation fix: popstate navigation wasn't cancelling ongoing navigation() calls when landing on the same page Sep 14, 2023
@JakeBeaver JakeBeaver changed the title fix: popstate navigation wasn't cancelling ongoing navigation() calls when landing on the same page fix: popstate navigation wasn't cancelling ongoing navigation() calls when landing on the same page Sep 14, 2023
@benmccann benmccann merged commit 9bc6e62 into sveltejs:master Oct 9, 2023
11 of 13 checks passed
@github-actions github-actions bot mentioned this pull request Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Race condition in client side navigation
2 participants