Skip to content

Commit 3f51616

Browse files
committed
Preserve unchanged Solid route params.
1 parent e3c8a15 commit 3f51616

2 files changed

Lines changed: 54 additions & 13 deletions

File tree

‎packages/solid/src/plugin-pages.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,12 @@ const [navigation, setNavigation] = createSignal(idleNavigationState());
162162
// Pages and layouts keep the objects returned by useShared() and useParams()
163163
// across navigations, so update them in place.
164164
function replaceInPlace(target, next) {
165-
for (const key of Object.keys(target)) delete target[key];
166-
Object.assign(target, next || {});
165+
const values = next || {};
166+
// Keep unchanged keys so their reactive subscribers stay idle.
167+
for (const key of Object.keys(target)) {
168+
if (!Object.hasOwn(values, key)) delete target[key];
169+
}
170+
Object.assign(target, values);
167171
}
168172
169173
function sameParams(a, b) {

‎packages/solid/test/integration/use-params-navigation.test.ts‎

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,59 @@ export default function Post(props) {
1313
<h1 id="title">{props.title}</h1>
1414
<p id="slug">{params.slug}</p>
1515
<Link href="/posts/b">Post b</Link>
16+
<Link href="/about">About</Link>
1617
</main>;
1718
}`;
1819

19-
const LAYOUT = `import { useParams } from "@void/solid";
20+
const LAYOUT = `import { useParams, useRouter } from "@void/solid";
21+
import { createEffect, createSignal } from "solid-js";
2022
export default function Layout(props) {
2123
const params = useParams();
22-
return <div><p id="layout-slug">{params.slug}</p>{props.children}</div>;
24+
const router = useRouter();
25+
const [observed, setObserved] = createSignal([]);
26+
const [refreshes, setRefreshes] = createSignal(0);
27+
createEffect(() => {
28+
const slug = params.slug;
29+
setObserved(values => [...values, slug ?? null]);
30+
});
31+
return <div>
32+
<p id="layout-slug">{params.slug}</p>
33+
<output id="observed-slugs">{JSON.stringify(observed())}</output>
34+
<button onClick={async () => {
35+
await router.refresh();
36+
setRefreshes(count => count + 1);
37+
}}>Refresh page</button>
38+
<output id="refreshes">{refreshes()}</output>
39+
{props.children}
40+
</div>;
2341
}`;
2442

25-
function pageData(slug: string) {
43+
function pageData(slug: string | null) {
2644
return {
27-
component: 'posts/[slug]',
28-
props: { title: `Post ${slug}` },
29-
params: { slug },
45+
component: slug === null ? 'about' : 'posts/[slug]',
46+
props: { title: slug === null ? 'About' : `Post ${slug}` },
47+
params: slug === null ? {} : { slug },
3048
shared: {},
31-
url: `/posts/${slug}`,
49+
url: slug === null ? '/about' : `/posts/${slug}`,
3250
};
3351
}
3452

3553
// The document a Void Worker sends for a client-rendered page. It boots the real
3654
// generated pages client, which then fetches pageData() as JSON on a Link navigation.
37-
function clientDocument(slug: string): string {
55+
function clientDocument(slug: string | null): string {
3856
return `<!doctype html>
3957
<script id="__VOID_PAGE_DATA__" type="application/json">${JSON.stringify(pageData(slug))}</script>
4058
<div id="app" data-void-ssr="false"></div>
4159
<script type="module" src="/@id/__x00__virtual:void-pages-client"></script>`;
4260
}
4361

44-
it('useParams() follows navigation between two params of the same page', async () => {
62+
it('keeps useParams reactive without notifying unchanged values', async () => {
4563
const root = mkdtempSync(join(import.meta.dirname, '.tmp-use-params-'));
4664
const pages = join(root, 'pages');
4765
mkdirSync(join(pages, 'posts'), { recursive: true });
4866
writeFileSync(join(pages, 'layout.tsx'), LAYOUT);
4967
writeFileSync(join(pages, 'posts', '[slug].tsx'), PAGE);
68+
writeFileSync(join(pages, 'about.tsx'), PAGE);
5069

5170
const browser = await chromium.launch();
5271
const server = await createServer({
@@ -64,8 +83,8 @@ it('useParams() follows navigation between two params of the same page', async (
6483
name: 'test:void-page-responses',
6584
configureServer(viteServer) {
6685
viteServer.middlewares.use((req, res, next) => {
67-
const slug = /^\/posts\/(\w+)$/.exec(req.url ?? '')?.[1];
68-
if (!slug) {
86+
const slug = /^\/posts\/(\w+)$/.exec(req.url ?? '')?.[1] ?? null;
87+
if (slug === null && req.url !== '/about') {
6988
next();
7089
return;
7190
}
@@ -98,6 +117,24 @@ it('useParams() follows navigation between two params of the same page', async (
98117
await page.waitForFunction(() => document.getElementById('title')?.textContent === 'Post b');
99118
expect(await page.textContent('#slug')).toBe('b');
100119
expect(await page.textContent('#layout-slug')).toBe('b');
120+
expect(await page.textContent('#observed-slugs')).toBe('["a","b"]');
121+
122+
// A refresh commits a new page response, but unchanged params must not
123+
// rerun effects in persistent layouts (which could trigger more refreshes).
124+
await page.getByRole('button', { name: 'Refresh page' }).click();
125+
await page.waitForFunction(() => document.getElementById('refreshes')?.textContent === '1');
126+
expect(await page.textContent('#observed-slugs')).toBe('["a","b"]');
127+
128+
await page.click('a[href="/about"]');
129+
await page.waitForFunction(() => document.getElementById('title')?.textContent === 'About');
130+
expect(await page.textContent('#layout-slug')).toBe('');
131+
expect(await page.textContent('#observed-slugs')).toBe('["a","b",null]');
132+
133+
await page.goBack();
134+
await page.waitForFunction(() => document.getElementById('title')?.textContent === 'Post b');
135+
expect(await page.textContent('#slug')).toBe('b');
136+
expect(await page.textContent('#layout-slug')).toBe('b');
137+
expect(await page.textContent('#observed-slugs')).toBe('["a","b",null,"b"]');
101138
expect(await page.getAttribute('html', 'data-same-document')).toBe('true');
102139
} finally {
103140
await server.close();

0 commit comments

Comments
 (0)