fix: prevent false positive history.pushState warnings

[eltigerchino]

fixes #11671

The warning currently incorrectly fires when we use history.pushState() internally such as clicking on a link. You can test this in a stackblitz starter project. This is because one of the early exit conditions in the warning method is failing incorrectly.

import.meta.url returns the client.js file with a query parameter when loading it from node_modules. This causes the substring search for the module filename in the error stack to always return false (because of the query params that are not present in the error stack)

kit/packages/kit/src/runtime/client/client.js

Line 79 in 53412fd

if (stack[0].includes(import.meta.url)) return;

The solution is to simply return the URL without the query parameters if any.

No test because so far it's only reproducible when Vite is loading SvelteKit from node_modules rather than being linked through the workspace (how it's currently setup in the kit repository).

Aside

This addresses the original issue of:

I'm not using history as suggested by the warning. I'm using goto in a couple of places, from $app/navigation. I haven't changed anything. The warning is not present with v2.3.3.

From a quick test, commenting out all the goto calls still resulted in the warning.

but it does not address the possibility that warn checks the wrong stack entry. This can happen when other scripts also monkey patch history.pushState causing our client.js to appear earlier or later in the call stack.

I think we're safe from third-party scripts monkey patching and upsetting the call stack order. I've tested monkey patching it in:

• the <script> of a svelte file
• the html template
• the svelte:head of a svelte file

and they get called in that order, but warn is always first in the call stack, followed by the client.js monkey patch.

---

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.

[changeset-bot]

🦋 Changeset detected

Latest commit: f6d7017

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

[dummdidumm]

Thanks for testing all the different cases!

[ebeloded]

I'm still getting the warning when using Sentry integration. As soon as Sentry.init is called, the warning shows up.

Not sure whether it should be reported here or in Sentry repo.

[eltigerchino]

I'm still getting the warning when using Sentry integration. As soon as Sentry.init is called, the warning shows up.

Not sure whether it should be reported here or in Sentry repo.

Thanks for reporting this. Can you open a new issue with a minimal reproduction?

[linsen]

I'm experiencing the same warning when using Sentry integration. The warning appears on the first navigation after a hard page load (but not on subsequent client-side navigation between pages).

Here's a minimal repo reproducing the issue: https://github.com/linsen/sveltekit-sentry-warning

Should I open a new issue for this? I don't see one that's currently open.

[eltigerchino]

I'm experiencing the same warning when using Sentry integration. The warning appears on the first navigation after a hard page load (but not on subsequent client-side navigation between pages).

Here's a minimal repo reproducing the issue: linsen/sveltekit-sentry-warning

Should I open a new issue for this? I don't see one that's currently open.

Hi Linsen. Thanks for reporting this. Yes, you’re encouraged to open a new issue for this.

[evdama]

I'm not using Sentry nor do I use history.pushState() or history.replaceState() anywhere in my app. As mentioned above, The warning appears on the first navigation after a hard page load (but not on subsequent client-side navigation between pages).

My svelte/kit versions:

sa@Mac: ~/0/edm  |development ✓| gr @svelte package.json
package.json:25:    "@sveltejs/adapter-vercel": "^5.5.2",
package.json:26:    "@sveltejs/kit": "^2.12.1",
package.json:27:    "@sveltejs/vite-plugin-svelte": "^5.0.3",
sa@Mac: ~/0/edm  |development ✓|

[eltigerchino]

I'm not using Sentry nor do I use history.pushState() or history.replaceState() anywhere in my app. As mentioned above, The warning appears on the first navigation after a hard page load (but not on subsequent client-side navigation between pages).

My svelte/kit versions:

sa@Mac: ~/0/edm  |development ✓| gr @svelte package.json
package.json:25:    "@sveltejs/adapter-vercel": "^5.5.2",
package.json:26:    "@sveltejs/kit": "^2.12.1",
package.json:27:    "@sveltejs/vite-plugin-svelte": "^5.0.3",
sa@Mac: ~/0/edm  |development ✓|

Please open a new issue with a minimal reproduction