refactor: Breaking changes to outputs & pkg.json by rschristian · Pull Request #4652 · preactjs/preact

rschristian · 2025-02-11T12:36:32Z

Lands a few breaking changes at once, happy to revert any part or all of this if we feel anything's a problem.

Drop .module.js for .mjs

Obviously this is where the ecosystem is going and it already has pretty good support: Webpack started to adopt back in late 2018 and Node has supported it since v12.16 onward. This moves our effective back compat date up to about 5-6 years ago.

Perhaps too soon, but thought I'd at least suggest it.

Switch package.json#exports.browser to package.json#exports.module

This comes up fairly often, usually due to test runners trying to load modules meant for the browser in Node and then crashing as our browser build does not adhere to Node's ESM semantics. See #4406, preactjs/jest-preset-preact#13 (comment), #3634. While I'd tend to call that ecosystem error, it's not going away any time soon and we don't even use this output; it's just a standard ESM build, nothing browser-specific.

Instead of dropping this entirely though we can switch to module which some bundlers use to guarantee the package isn't instantiated twice (Webpack's docs on the subject). We had this change in the v11 branch and I think it's good to carry over. Might also reduce some of the __H reports we have to deal with.

Drop the .min builds

These largely appear to be broken as-is (preact.min.module.js is not ESM, there's no CJS build as the IIFE output overwrites it immediately, preact.min.umd.js doesn't appear to be valid UMD either); the only thing maybe of value is the IIFE output preact.min.js. It's 30b lighter than preact.umd.js, but I don't know who's actually using it (if anyone at all).

Users are almost certainly better off with the plain UMD build and we'd be better off dropping it to reduce some confusion as it's unclear when this is meant to be used.

…, & use `.mjs` exclusively

github-actions · 2025-02-11T12:37:03Z

📊 Tachometer Benchmark Results

Summary

duration

create10k: unsure 🔍 -0% - +1% (-2.05ms - +6.13ms)
^{preact-local vs preact-main}
filter-list: unsure 🔍 -1% - +0% (-0.22ms - +0.00ms)
^{preact-local vs preact-main}
hydrate1k: unsure 🔍 -1% - +2% (-0.78ms - +1.55ms)
^{preact-local vs preact-main}
many-updates: unsure 🔍 -0% - +4% (-0.02ms - +0.74ms)
^{preact-local vs preact-main}
replace1k: unsure 🔍 -0% - +1% (-0.29ms - +0.88ms)
^{preact-local vs preact-main}
text-update: unsure 🔍 -4% - +5% (-0.08ms - +0.10ms)
^{preact-local vs preact-main}
todo: unsure 🔍 -1% - +1% (-0.30ms - +0.46ms)
^{preact-local vs preact-main}
update10th1k: unsure 🔍 -5% - +4% (-1.56ms - +1.15ms)
^{preact-local vs preact-main}

usedJSHeapSize

create10k: unsure 🔍 -0% - +0% (-0.01ms - +0.01ms)
^{preact-local vs preact-main}
filter-list: unsure 🔍 -2% - +2% (-0.03ms - +0.03ms)
^{preact-local vs preact-main}
hydrate1k: unsure 🔍 -2% - +1% (-0.22ms - +0.15ms)
^{preact-local vs preact-main}
many-updates: unsure 🔍 -1% - +0% (-0.02ms - +0.02ms)
^{preact-local vs preact-main}
replace1k: unsure 🔍 -0% - +0% (-0.01ms - +0.01ms)
^{preact-local vs preact-main}
text-update: unsure 🔍 -0% - +0% (-0.00ms - +0.00ms)
^{preact-local vs preact-main}
todo: unsure 🔍 -3% - +0% (-0.04ms - +0.00ms)
^{preact-local vs preact-main}
update10th1k: unsure 🔍 -0% - +2% (-0.01ms - +0.05ms)
^{preact-local vs preact-main}

Results

create10k

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	940.14ms - 945.88ms	-	unsure 🔍 -0% - +1% -2.05ms - +6.13ms
preact-main	938.06ms - 943.88ms	unsure 🔍 -1% - +0% -6.13ms - +2.05ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	19.20ms - 19.21ms	-	unsure 🔍 -0% - +0% -0.01ms - +0.01ms
preact-main	19.20ms - 19.22ms	unsure 🔍 -0% - +0% -0.01ms - +0.01ms	-

filter-list

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	16.55ms - 16.62ms	-	unsure 🔍 -1% - +0% -0.22ms - +0.00ms
preact-main	16.59ms - 16.80ms	unsure 🔍 -0% - +1% -0.00ms - +0.22ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	1.54ms - 1.58ms	-	unsure 🔍 -2% - +2% -0.03ms - +0.03ms
preact-main	1.53ms - 1.58ms	unsure 🔍 -2% - +2% -0.03ms - +0.03ms	-

hydrate1k

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	79.01ms - 81.04ms	-	unsure 🔍 -1% - +2% -0.78ms - +1.55ms
preact-main	79.06ms - 80.22ms	unsure 🔍 -2% - +1% -1.55ms - +0.78ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	13.59ms - 13.87ms	-	unsure 🔍 -2% - +1% -0.22ms - +0.15ms
preact-main	13.65ms - 13.89ms	unsure 🔍 -1% - +2% -0.15ms - +0.22ms	-

many-updates

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	16.42ms - 17.08ms	-	unsure 🔍 -0% - +4% -0.02ms - +0.74ms
preact-main	16.21ms - 16.58ms	unsure 🔍 -4% - +0% -0.74ms - +0.02ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	3.76ms - 3.78ms	-	unsure 🔍 -1% - +0% -0.02ms - +0.02ms
preact-main	3.76ms - 3.79ms	unsure 🔍 -0% - +1% -0.02ms - +0.02ms	-

replace1k

Browser: chrome-headless
Sample size: 100
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	64.72ms - 65.74ms	-	unsure 🔍 -0% - +1% -0.29ms - +0.88ms
preact-main	64.65ms - 65.22ms	unsure 🔍 -1% - +0% -0.88ms - +0.29ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	2.97ms - 2.99ms	-	unsure 🔍 -0% - +0% -0.01ms - +0.01ms
preact-main	2.97ms - 2.98ms	unsure 🔍 -0% - +0% -0.01ms - +0.01ms	-

run-warmup-0

Version	Avg time	vs preact-local	vs preact-main
preact-local	29.26ms - 29.77ms	-	unsure 🔍 -1% - +1% -0.26ms - +0.43ms
preact-main	29.19ms - 29.66ms	unsure 🔍 -1% - +1% -0.43ms - +0.26ms	-

run-warmup-1

Version	Avg time	vs preact-local	vs preact-main
preact-local	32.75ms - 33.62ms	-	unsure 🔍 -2% - +1% -0.81ms - +0.41ms
preact-main	32.96ms - 33.81ms	unsure 🔍 -1% - +2% -0.41ms - +0.81ms	-

run-warmup-2

Version	Avg time	vs preact-local	vs preact-main
preact-local	24.95ms - 25.29ms	-	unsure 🔍 -1% - +1% -0.21ms - +0.30ms
preact-main	24.89ms - 25.26ms	unsure 🔍 -1% - +1% -0.30ms - +0.21ms	-

run-warmup-3

Version	Avg time	vs preact-local	vs preact-main
preact-local	24.00ms - 25.10ms	-	unsure 🔍 -3% - +3% -0.82ms - +0.80ms
preact-main	23.97ms - 25.15ms	unsure 🔍 -3% - +3% -0.80ms - +0.82ms	-

run-warmup-4

Version	Avg time	vs preact-local	vs preact-main
preact-local	23.71ms - 24.76ms	-	unsure 🔍 -2% - +4% -0.43ms - +1.06ms
preact-main	23.39ms - 24.44ms	unsure 🔍 -4% - +2% -1.06ms - +0.43ms	-

run-final

Version	Avg time	vs preact-local	vs preact-main
preact-local	19.84ms - 20.67ms	-	unsure 🔍 -1% - +3% -0.28ms - +0.66ms
preact-main	19.84ms - 20.28ms	unsure 🔍 -3% - +1% -0.66ms - +0.28ms	-

text-update

Browser: chrome-headless
Sample size: 110
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	2.06ms - 2.18ms	-	unsure 🔍 -4% - +5% -0.08ms - +0.10ms
preact-main	2.04ms - 2.18ms	unsure 🔍 -5% - +4% -0.10ms - +0.08ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	1.12ms - 1.12ms	-	unsure 🔍 -0% - +0% -0.00ms - +0.00ms
preact-main	1.11ms - 1.12ms	unsure 🔍 -0% - +0% -0.00ms - +0.00ms	-

todo

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	33.63ms - 34.36ms	-	unsure 🔍 -1% - +1% -0.30ms - +0.46ms
preact-main	33.80ms - 34.04ms	unsure 🔍 -1% - +1% -0.46ms - +0.30ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	1.22ms - 1.25ms	-	unsure 🔍 -3% - +0% -0.04ms - +0.00ms
preact-main	1.23ms - 1.27ms	unsure 🔍 -0% - +3% -0.00ms - +0.04ms	-

update10th1k

Browser: chrome-headless
Sample size: 50
Built by: CI #4382
Commit: 133776c

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	31.05ms - 32.41ms	-	unsure 🔍 -5% - +4% -1.56ms - +1.15ms
preact-main	30.76ms - 33.11ms	unsure 🔍 -4% - +5% -1.15ms - +1.56ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	2.94ms - 2.98ms	-	unsure 🔍 -0% - +2% -0.01ms - +0.05ms
preact-main	2.93ms - 2.96ms	unsure 🔍 -2% - +0% -0.05ms - +0.01ms	-

_{tachometer-reporter-action v2 for CI}

github-actions · 2025-02-11T12:37:48Z

Size Change: -29.6 kB (-38.72%) 🎉

Total Size: 46.8 kB

Filename	Size	Change
`compat/dist/compat.mjs`	3.59 kB	-4 B (-0.11%)
`compat/dist/compat.module.js`	0 B	-3.59 kB (removed)	🏆
`debug/dist/debug.mjs`	3.87 kB	-4 B (-0.1%)
`debug/dist/debug.module.js`	0 B	-3.87 kB (removed)	🏆
`devtools/dist/devtools.mjs`	270 B	-4 B (-1.46%)
`devtools/dist/devtools.module.js`	0 B	-274 B (removed)	🏆
`dist/preact.min.js`	0 B	-4.71 kB (removed)	🏆
`dist/preact.min.module.js`	0 B	-4.7 kB (removed)	🏆
`dist/preact.min.umd.js`	0 B	-4.74 kB (removed)	🏆
`dist/preact.mjs`	4.69 kB	-4 B (-0.09%)
`dist/preact.module.js`	0 B	-4.7 kB (removed)	🏆
`hooks/dist/hooks.mjs`	1.58 kB	-5 B (-0.32%)
`hooks/dist/hooks.module.js`	0 B	-1.58 kB (removed)	🏆
`jsx-runtime/dist/jsxRuntime.mjs`	922 B	-4 B (-0.43%)
`jsx-runtime/dist/jsxRuntime.module.js`	0 B	-926 B (removed)	🏆
`test-utils/dist/testUtils.mjs`	473 B	-4 B (-0.84%)
`test-utils/dist/testUtils.module.js`	0 B	-477 B (removed)	🏆

ℹ️ View Unchanged

Filename	Size
`compat/dist/compat.js`	3.67 kB
`compat/dist/compat.umd.js`	3.73 kB
`debug/dist/debug.js`	3.87 kB
`debug/dist/debug.umd.js`	3.95 kB
`devtools/dist/devtools.js`	260 B
`devtools/dist/devtools.umd.js`	346 B
`dist/preact.js`	4.67 kB
`dist/preact.umd.js`	4.77 kB
`hooks/dist/hooks.js`	1.55 kB
`hooks/dist/hooks.umd.js`	1.62 kB
`jsx-runtime/dist/jsxRuntime.js`	957 B
`jsx-runtime/dist/jsxRuntime.umd.js`	1.03 kB
`test-utils/dist/testUtils.js`	473 B
`test-utils/dist/testUtils.umd.js`	555 B

_{compressed-size-action}

marvinhagemeister

LGTM, sounds reasonable to me. I'm kinda wondering if it's worth it to move to type: "module" at some point or if that would be too much of a breaking change.

rschristian · 2025-02-11T12:55:51Z

Not sure why coveralls is breaking, weird.

I don't think we'd gain much from "type": "module" and it does move up the minimum a fair bit, .mjs saw way earlier support than .cjs after all.

marvinhagemeister · 2025-02-11T13:17:10Z

fair point!

* refactor: Switch to `package.json#exports.module`, drop `.min` builds, & use `.mjs` exclusively * chore: Remove leftover CJS shell * test: Fix export for karma * fix: coverage not generated in minify tests --------- Co-authored-by: Marvin Hagemeister <hello@marvinh.dev>

rschristian added 2 commits February 11, 2025 06:04

refactor: Switch to package.json#exports.module, drop .min builds…

dcaa8ea

…, & use `.mjs` exclusively

chore: Remove leftover CJS shell

e71c8d0

rschristian requested review from JoviDeCroock, developit and marvinhagemeister February 11, 2025 12:36

test: Fix export for karma

5cdf897

marvinhagemeister approved these changes Feb 11, 2025

View reviewed changes

rschristian force-pushed the refactor/pkg-exports branch from 18935a3 to ad213f4 Compare February 12, 2025 09:39

marvinhagemeister mentioned this pull request Feb 12, 2025

"Nothing to report" error coverallsapp/github-action#241

Open

fix: coverage not generated in minify tests

133776c

JoviDeCroock approved these changes Feb 12, 2025

View reviewed changes

JoviDeCroock mentioned this pull request Feb 12, 2025

(major) - Tracking PR for v11 #4549

Merged

1 task

JoviDeCroock reviewed Feb 13, 2025

View reviewed changes

Comment thread karma.conf.js

JoviDeCroock force-pushed the v11-2 branch from c4ed4f4 to 593b951 Compare February 13, 2025 16:19

rschristian force-pushed the refactor/pkg-exports branch 2 times, most recently from a33b56f to 133776c Compare February 14, 2025 06:23

rschristian mentioned this pull request Feb 14, 2025

fix: Filter defaults not working as intended preactjs/compressed-size-action#114

Merged

rschristian merged commit d1c4581 into v11-2 Feb 14, 2025

rschristian deleted the refactor/pkg-exports branch February 14, 2025 09:08

JoviDeCroock mentioned this pull request Aug 19, 2025

v11.0.0-beta.0 #4893

Merged

Uh oh!

Conversation

rschristian commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Tachometer Benchmark Results

Summary

duration

usedJSHeapSize

Results

duration

usedJSHeapSize

duration

usedJSHeapSize

duration

usedJSHeapSize

duration

usedJSHeapSize

duration

usedJSHeapSize

run-warmup-0

run-warmup-1

run-warmup-2

run-warmup-3

run-warmup-4

run-final

duration

usedJSHeapSize

duration

usedJSHeapSize

duration

usedJSHeapSize

Uh oh!

github-actions bot commented Feb 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marvinhagemeister left a comment

Choose a reason for hiding this comment

Uh oh!

rschristian commented Feb 11, 2025

Uh oh!

marvinhagemeister commented Feb 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rschristian commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading

github-actions bot commented Feb 11, 2025 •

edited

Loading