Skip to content

Fix runtime error when onNavigate returns a function #11678

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
merged 3 commits into from
Jan 19, 2024
Merged

Fix runtime error when onNavigate returns a function #11678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0f53d9
Fix runtime error when `onNavigate` returns a function
f-elix Jan 19, 2024
1a524a3
Add changeset
f-elix Jan 19, 2024
5591cae
cleanup + test
dummdidumm Jan 19, 2024
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/tiny-news-clap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@sveltejs/kit": patch
---

fix: handle `onNavigate` callbacks correctly
6 changes: 2 additions & 4 deletions packages/kit/src/runtime/client/client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1330,7 +1330,7 @@ async function navigate({
fn(/** @type {import('@sveltejs/kit').OnNavigate} */ (nav.navigation))
)
)
).filter((value) => typeof value === 'function');
).filter(/** @returns {value is () => void} */ (value) => typeof value === 'function');

if (after_navigate.length > 0) {
function cleanup() {
Expand All @@ -1341,9 +1341,7 @@ async function navigate({
}

after_navigate.push(cleanup);

// @ts-ignore
callbacks.after_navigate.push(...after_navigate);
after_navigate_callbacks.push(...after_navigate);
}

root.$set(navigation_result.props);
Expand Down
10 changes: 9 additions & 1 deletion packages/kit/test/apps/basics/src/routes/navigation-lifecycle/on-navigate/[x]/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@
/** @type {Omit<import('@sveltejs/kit').NavigationType, 'enter' | 'leave'>} */
let type;

let called_return = false;

onNavigate((navigation) => {
from = navigation.from;
to = navigation.to;
type = navigation.type;
});

onNavigate(() => {
return () => {
called_return = true;
};
});
</script>

<h1>{from?.url.pathname} -> {to?.url.pathname} ({type ?? '...'})</h1>
<h1>{from?.url.pathname} -> {to?.url.pathname} ({type ?? '...'}) {called_return}</h1>
<a href="/navigation-lifecycle/on-navigate/b">/b</a>
4 changes: 2 additions & 2 deletions packages/kit/test/apps/basics/test/cross-platform/client.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,11 @@ test.describe('Navigation lifecycle functions', () => {

test('onNavigate calls callback', async ({ page, clicknav }) => {
await page.goto('/navigation-lifecycle/on-navigate/a');
expect(await page.textContent('h1')).toBe('undefined -> undefined (...)');
expect(await page.textContent('h1')).toBe('undefined -> undefined (...) false');

await clicknav('[href="/navigation-lifecycle/on-navigate/b"]');
expect(await page.textContent('h1')).toBe(
'/navigation-lifecycle/on-navigate/a -> /navigation-lifecycle/on-navigate/b (link)'
'/navigation-lifecycle/on-navigate/a -> /navigation-lifecycle/on-navigate/b (link) true'
);
});
});
Expand Down