Skip to content

fix: only decode URL hash instead of entire URL #13332

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 2 commits into from
Jan 17, 2025
Merged

fix: only decode URL hash instead of entire URL #13332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efee7f7
only decode hash
eltigerchino Jan 17, 2025
21f76a9
Update packages/kit/src/runtime/client/client.js
dummdidumm Jan 17, 2025
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
17 changes: 15 additions & 2 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 @@ -306,7 +306,9 @@ export async function start(_app, _target, hydrate) {
if (hydrate) {
await _hydrate(target, hydrate);
} else {
goto(app.hash ? decodeURIComponent(location.href) : location.href, { replaceState: true });
goto(app.hash ? decode_hash(new URL(location.href)) : location.href, {
replaceState: true
});
}

_start_router();
Expand Down Expand Up @@ -2407,7 +2409,7 @@ function _start_router() {
// (surprisingly!) mutates `current.url`, allowing us to
// detect it and trigger a navigation
if (current.url.hash === location.hash) {
navigate({ type: 'goto', url: new URL(decodeURIComponent(current.url.href)) });
navigate({ type: 'goto', url: decode_hash(current.url) });
}
}
});
Expand Down Expand Up @@ -2801,6 +2803,17 @@ function clone_page(page) {
};
}

/**
* @param {URL} url
* @returns {URL}
*/
function decode_hash(url) {
const new_url = new URL(url);
// Safari, for some reason, does change # to %23, when entered through the address bar
new_url.hash = decodeURIComponent(url.hash);
return new_url;
}

if (DEV) {
// Nasty hack to silence harmless warnings the user can do nothing about
const console_warn = console.warn;
Expand Down
4 changes: 2 additions & 2 deletions packages/kit/test/apps/hash-based-routing/test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ test.describe('hash based navigation', () => {
});

test('navigation works with URL encoded characters', async ({ page }) => {
await page.goto('/#/%23test');
await page.goto('/?query=%23abc#/%23test');
await expect(page.locator('p')).toHaveText('home');
// hashchange event
await page.goto('/#/a%23test');
await page.goto('/?query=%23abc#/a%23test');
await expect(page.locator('p')).toHaveText('a');
});

Expand Down
Loading