Skip to content
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.

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

fix: explicitly check for null props in serializeSignals #11930

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/long-lemons-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/preact': patch
---

Preact components no longer throw an error if a property is null.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { h } from 'preact';

export default ({ nullProp }) => {
return <div id="preact-component-with-null-prop">
<p>I have a null prop: {nullProp}</p>
</div>
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { signal } from '@preact/signals';
import Signals from '../components/Signals';
import SignalsInArray from '../components/SignalsInArray';
import SignalsInObject from '../components/SignalsInObject';
import ComponentWithNullProp from '../components/ComponentWithNullProp';
const count = signal(1);
const secondCount = signal(2);
---
Expand All @@ -14,6 +15,7 @@ const secondCount = signal(2);
<Signals client:load count={count} />
<Signals client:load count={count} />
<SignalsInArray client:load signalsArray={["I'm not a signal", count, count, 12345, secondCount]} />
<SignalsInObject client:load signalsObject={{title:'I am a title', counter: count}} />
<SignalsInObject client:load signalsObject={{title:'I am a title', counter: count}}, />
<ComponentWithNullProp client:load nullProp={null} />
</body>
</html>
7 changes: 7 additions & 0 deletions packages/astro/test/preact-component.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,11 @@ describe('Preact component', () => {
assert.equal(element.find('h1').text(), 'I am a title');
assert.equal(element.find('p').text(), '1');
});

it('Can use null props', async () => {
const html = await fixture.readFile('/signals/index.html');
const $ = cheerio.load(html);

assert.equal($('#preact-component-with-null-prop').length, 1);
});
});
3 changes: 2 additions & 1 deletion packages/integrations/preact/src/signals.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ export function serializeSignals(
const signals: Signals = {};
for (const [key, value] of Object.entries(props)) {
const isPropArray = Array.isArray(value);
const isPropObject = !isSignal(value) && typeof props[key] === 'object' && !isPropArray;
// `typeof null` is 'object' in JS, so we need to check for `null` specifically
const isPropObject = !isSignal(value) && typeof props[key] === 'object' && props[key] !== null && !isPropArray;

if (isPropObject || isPropArray) {
const values = isPropObject ? Object.keys(props[key]) : value;
Expand Down
Loading