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: only call afterNavigate once on start when SSR is disabled #13593

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

eltigerchino
Copy link
Member

fixes #13573

This PR changes the unexpected behaviour of afterNavigate being called twice when SSR is disabled to only once (same as when SSR is enabled). It was being called twice: once with type 'enter' and again with type 'goto' because we initialised the app and used goto under the hood to render the page client-side. Now, it should only be called once with type 'enter'. This also adjusts the docs to state that a navigation with type 'enter' is when the app starts and not just when it's hydrated.


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:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Mar 17, 2025

🦋 Changeset detected

Latest commit: 1a183bf

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

@svelte-docs-bot
Copy link

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, once you've answered my question on the code you can self-merge 👍

@@ -1423,7 +1430,7 @@ async function navigate({

is_navigating = true;

if (started) {
if (started && nav.navigation.type !== 'enter') {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this necessary? When could started be true but the type enter?

Copy link
Member Author

@eltigerchino eltigerchino Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was only added for type narrowing. TypeScript doesn’t know that we won’t use navigate with the “enter” navigation type after the app has started. Meanwhile, navigating.current has been typed to never have the “enter” navigation type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

afterNavigate fires twice when SSR is turned off
2 participants