Skip to content

chore: improve error message for prefetching invalid url #7314

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.

Sign up for GitHub

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

Merged
Rich-Harris merged 4 commits into from
Oct 20, 2022
Merged

chore: improve error message for prefetching invalid url #7314

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e435df4
docs: improve error message for external prefetching
dominikg Oct 19, 2022
052932e
add changeset
dominikg Oct 19, 2022
81e50b4
fix: changeset message
dominikg Oct 19, 2022
c3d9c27
fix: remove invalid extra information from prefetch error message
dominikg Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/twenty-monkeys-glow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': patch
---

Improve error message when prefetching fails
4 changes: 3 additions & 1 deletion packages/kit/src/runtime/client/client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,9 @@ export function create_client({ target, base, trailing_slash }) {
const intent = get_navigation_intent(url, false);

if (!intent) {
throw new Error('Attempted to prefetch a URL that does not belong to this app');
throw new Error(
`Attempted to prefetch "${url}", a URL that does not belong to this app. To disable prefetching add data-sveltekit-prefetch="off" to a parent. See https://kit.svelte.dev/docs/link-options#data-sveltekit-prefetch for more information.`

@Rich-Harris Rich-Harris Oct 19, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IIUC the error shouldn't happen if prefetching happened as a result of the user stopping over a link, but only if the app calls prefetch(bad_url). If that's not currently the case then I'd argue it's a bug, and we should fix that instead

@dominikg dominikg Oct 19, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In my case it was a newly added href="/some/new/route" . The error happened during dev after the href was added but before +page.svelte was created. So bad url. Maybe skip and warn instead during dev and error only in build? But adding the url to the message seems helpful.

@Rich-Harris Rich-Harris Oct 19, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

right, but what i'm saying is that data-sveltekit-prefetch shouldn't cause that error, it should be reserved for when you do prefetch('/some/new/route')

@dummdidumm dummdidumm Oct 20, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

So .. we have a bug hiding somewhere?

@dominikg dominikg Oct 20, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ahh. But adding the url value to the error message helps that case as well. The stacktrace isn't helping because it's internal to kit, so you have to start debugging to get a clue.

I have removed the extra information to avoid confusion.

);
}

load_cache = { id: intent.id, promise: load_route(intent) };
Expand Down