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: better error message when calling push/replaceState before router is initialized #11968

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

Conversation

PatrickG
Copy link
Contributor

@PatrickG PatrickG commented Mar 11, 2024

"fixes" #11466 and #11492

Not sure if this needs a test.
IMO, this error should be thrown in production as well. Any opinions?


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 11, 2024

🦋 Changeset detected

Latest commit: 38ed511

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

@kevinflint
Copy link

IMO, this error should be thrown in production as well. Any opinions?

It may not be possible to know whether the router is initialized when calling pushState.
It would be nice for there to be a way to tell if it was safe to call, e.g. when writing utility code.

Write now I'm doing something like this in an app codebase:

// Bug: Handle 'undefined' root if pushState is called during on mount.
// See https://github.com/sveltejs/kit/issues/11466 for details.
try {
    pushState(...);
} catch (error) {
    // Log the error as a warning, but don't re-throw it.
    log.warn('Ignoring failed call to `pushState`', error);
}

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.

None yet

2 participants