feat: support ref cleanup functions #4436

marvinhagemeister · 2024-07-06T22:32:36Z

Fixes #4435

github-actions · 2024-07-06T22:32:50Z

📊 Tachometer Benchmark Results

Summary

duration

create10k: unsure 🔍 -1% - +2% (-7.91ms - +14.32ms)
^{preact-local vs preact-main}
filter-list: unsure 🔍 -3% - +2% (-0.45ms - +0.37ms)
^{preact-local vs preact-main}
hydrate1k: unsure 🔍 -3% - +1% (-1.88ms - +0.82ms)
^{preact-local vs preact-main}
many-updates: unsure 🔍 -2% - +2% (-0.34ms - +0.29ms)
^{preact-local vs preact-main}
replace1k: unsure 🔍 -1% - +3% (-1.15ms - +2.44ms)
^{preact-local vs preact-main}
text-update: unsure 🔍 -5% - +5% (-0.10ms - +0.10ms)
^{preact-local vs preact-main}
todo: unsure 🔍 -2% - +0% (-0.54ms - +0.01ms)
^{preact-local vs preact-main}
update10th1k: unsure 🔍 -1% - +2% (-0.27ms - +0.47ms)
^{preact-local vs preact-main}

usedJSHeapSize

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

Results

create10k

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	878.32ms - 894.04ms	-	unsure 🔍 -1% - +2% -7.91ms - +14.32ms
preact-main	875.12ms - 890.84ms	unsure 🔍 -2% - +1% -14.32ms - +7.91ms	-

usedJSHeapSize

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

filter-list

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	16.62ms - 17.20ms	-	unsure 🔍 -3% - +2% -0.45ms - +0.37ms
preact-main	16.65ms - 17.24ms	unsure 🔍 -2% - +3% -0.37ms - +0.45ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	1.69ms - 1.70ms	-	unsure 🔍 -0% - +0% -0.00ms - +0.00ms
preact-main	1.69ms - 1.70ms	unsure 🔍 -0% - +0% -0.00ms - +0.00ms	-

hydrate1k

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	68.29ms - 69.09ms	-	unsure 🔍 -3% - +1% -1.88ms - +0.82ms
preact-main	67.93ms - 70.51ms	unsure 🔍 -1% - +3% -0.82ms - +1.88ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	13.05ms - 13.38ms	-	unsure 🔍 -2% - +1% -0.33ms - +0.14ms
preact-main	13.15ms - 13.47ms	unsure 🔍 -1% - +3% -0.14ms - +0.33ms	-

many-updates

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	16.34ms - 16.86ms	-	unsure 🔍 -2% - +2% -0.34ms - +0.29ms
preact-main	16.44ms - 16.81ms	unsure 🔍 -2% - +2% -0.29ms - +0.34ms	-

usedJSHeapSize

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

replace1k

Browser: chrome-headless
Sample size: 100
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	77.18ms - 79.76ms	-	unsure 🔍 -1% - +3% -1.15ms - +2.44ms
preact-main	76.58ms - 79.07ms	unsure 🔍 -3% - +1% -2.44ms - +1.15ms	-

usedJSHeapSize

Version	Avg time	vs preact-local	vs preact-main
preact-local	3.52ms - 3.55ms	-	unsure 🔍 -1% - +0% -0.03ms - +0.02ms
preact-main	3.53ms - 3.56ms	unsure 🔍 -0% - +1% -0.02ms - +0.03ms	-

run-warmup-0

Version	Avg time	vs preact-local	vs preact-main
preact-local	29.07ms - 29.71ms	-	unsure 🔍 -2% - +1% -0.47ms - +0.43ms
preact-main	29.10ms - 29.73ms	unsure 🔍 -1% - +2% -0.43ms - +0.47ms	-

run-warmup-1

Version	Avg time	vs preact-local	vs preact-main
preact-local	34.82ms - 36.70ms	-	unsure 🔍 -1% - +7% -0.24ms - +2.48ms
preact-main	33.66ms - 35.63ms	unsure 🔍 -7% - +1% -2.48ms - +0.24ms	-

run-warmup-2

Version	Avg time	vs preact-local	vs preact-main
preact-local	25.72ms - 26.08ms	-	unsure 🔍 -2% - +1% -0.56ms - +0.16ms
preact-main	25.80ms - 26.41ms	unsure 🔍 -1% - +2% -0.16ms - +0.56ms	-

run-warmup-3

Version	Avg time	vs preact-local	vs preact-main
preact-local	31.10ms - 32.58ms	-	unsure 🔍 -1% - +5% -0.44ms - +1.59ms
preact-main	30.57ms - 31.96ms	unsure 🔍 -5% - +1% -1.59ms - +0.44ms	-

run-warmup-4

Version	Avg time	vs preact-local	vs preact-main
preact-local	22.04ms - 23.57ms	-	unsure 🔍 -6% - +3% -1.46ms - +0.67ms
preact-main	22.45ms - 23.94ms	unsure 🔍 -3% - +6% -0.67ms - +1.46ms	-

run-final

Version	Avg time	vs preact-local	vs preact-main
preact-local	23.61ms - 24.71ms	-	unsure 🔍 -1% - +6% -0.12ms - +1.32ms
preact-main	23.10ms - 24.02ms	unsure 🔍 -5% - +0% -1.32ms - +0.12ms	-

text-update

Browser: chrome-headless
Sample size: 60
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	1.90ms - 2.03ms	-	unsure 🔍 -5% - +5% -0.10ms - +0.10ms
preact-main	1.90ms - 2.03ms	unsure 🔍 -5% - +5% -0.10ms - +0.10ms	-

usedJSHeapSize

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

todo

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	26.03ms - 26.21ms	-	unsure 🔍 -2% - +0% -0.54ms - +0.01ms
preact-main	26.12ms - 26.65ms	unsure 🔍 -0% - +2% -0.01ms - +0.54ms	-

usedJSHeapSize

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

update10th1k

Browser: chrome-headless
Sample size: 50
Built by: Benchmarks #1566
Commit: 7bb245a

duration

Version	Avg time	vs preact-local	vs preact-main
preact-local	29.17ms - 29.83ms	-	unsure 🔍 -1% - +2% -0.27ms - +0.47ms
preact-main	29.24ms - 29.56ms	unsure 🔍 -2% - +1% -0.47ms - +0.27ms	-

usedJSHeapSize

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

_{tachometer-reporter-action v2 for Benchmarks}

github-actions · 2024-07-06T22:33:41Z

Size Change: +145 B (+0.23%)

Total Size: 61.9 kB

Filename	Size	Change
`dist/preact.js`	4.7 kB	+23 B (+0.49%)
`dist/preact.min.js`	4.74 kB	+25 B (+0.53%)
`dist/preact.min.module.js`	4.73 kB	+24 B (+0.51%)
`dist/preact.min.umd.js`	4.76 kB	+24 B (+0.51%)
`dist/preact.module.js`	4.73 kB	+22 B (+0.47%)
`dist/preact.umd.js`	4.78 kB	+27 B (+0.57%)

ℹ️ View Unchanged

Filename	Size
`compat/dist/compat.js`	4.1 kB
`compat/dist/compat.module.js`	4.03 kB
`compat/dist/compat.umd.js`	4.17 kB
`debug/dist/debug.js`	3.7 kB
`debug/dist/debug.module.js`	3.71 kB
`debug/dist/debug.umd.js`	3.78 kB
`devtools/dist/devtools.js`	259 B
`devtools/dist/devtools.module.js`	273 B
`devtools/dist/devtools.umd.js`	345 B
`hooks/dist/hooks.js`	1.53 kB
`hooks/dist/hooks.module.js`	1.56 kB
`hooks/dist/hooks.umd.js`	1.6 kB
`jsx-runtime/dist/jsxRuntime.js`	981 B
`jsx-runtime/dist/jsxRuntime.module.js`	956 B
`jsx-runtime/dist/jsxRuntime.umd.js`	1.06 kB
`test-utils/dist/testUtils.js`	451 B
`test-utils/dist/testUtils.module.js`	456 B
`test-utils/dist/testUtils.umd.js`	536 B

_{compressed-size-action}

coveralls · 2024-07-06T22:37:49Z

coverage: 99.612% (+0.002%) from 99.61%
when pulling 7bb245a on ref-cleanup
into db0f4f2 on main.

coveralls · 2024-07-06T22:37:55Z

coverage: 99.612% (+0.002%) from 99.61%
when pulling 7bb245a on ref-cleanup
into db0f4f2 on main.

JoviDeCroock · 2024-07-07T09:50:47Z

src/diff/index.js

+				ref._unmount();
+			}
+
+			if (!hasRefUnmount || value != null) {


Why do we need !hasRefUnmount here? Wouldn't it be safe to always invoke this and inline typeof ref._unmount == 'function' above?

EDIT: seems needed when I tested it out

Maybe inverting the check makes it more clear. When a cleanup function is returned, then the ref function should never be invoked with null. But when no cleanup function is there it should be invoked with null.

JoviDeCroock · 2024-07-07T09:51:09Z

src/diff/index.js

-		if (typeof ref == 'function') ref(value);
-		else ref.current = value;
+		if (typeof ref == 'function') {
+			let hasRefUnmount = typeof ref._unmount == 'function';


We'll need to add _unmount to mangle to be safe I reckon

It's already there as we use that for options._unmount too.

JoviDeCroock

Looks great!

feat: support ref cleanup functions

4e53438

marvinhagemeister requested review from JoviDeCroock, andrewiggins and developit July 6, 2024 22:33

chore: work around TS complaining

7bb245a

JoviDeCroock reviewed Jul 7, 2024

View reviewed changes

JoviDeCroock approved these changes Jul 7, 2024

View reviewed changes

marvinhagemeister merged commit 212b1f6 into main Jul 7, 2024
13 checks passed

marvinhagemeister deleted the ref-cleanup branch July 7, 2024 12:34

JoviDeCroock mentioned this pull request Jul 20, 2024

10.23.0 #4450

Merged

This was referenced Aug 14, 2024

[Snyk] Upgrade preact from 10.11.3 to 10.23.0 X-oss-byte/next-auth#109

Open

[Snyk] Upgrade preact from 10.11.3 to 10.23.1 X-oss-byte/next-auth#110

Open

ramzimalhas mentioned this pull request Aug 22, 2024

[Snyk] Upgrade preact from 10.11.3 to 10.23.1 ramzimalhas/chatgpt-advanced#2

Open

This was referenced Sep 3, 2024

[Snyk] Upgrade preact from 10.11.3 to 10.23.2 X-oss-byte/next-auth#113

Open

[Snyk] Upgrade: cookie, preact, preact-render-to-string X-oss-byte/next-auth#115

Open

arkid15r mentioned this pull request Sep 11, 2024

[Snyk] Upgrade: , dayjs, marked-emoji, preact, qs, react-router-dom, sass VictoriaMetrics/VictoriaMetrics#6982

Closed

ntavassoli-dot mentioned this pull request Sep 13, 2024

[Snyk] Upgrade preact from 10.13.2 to 10.23.2 ntavassoli-dot/InstagramUnfollowers#1

Open

organich mentioned this pull request Sep 24, 2024

[Snyk] Upgrade preact from 10.19.3 to 10.23.2 organich/vscode-js-debug#3

Open

feat: support ref cleanup functions #4436

feat: support ref cleanup functions #4436

Conversation

marvinhagemeister commented Jul 6, 2024

github-actions bot commented Jul 6, 2024 • edited Loading

📊 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

github-actions bot commented Jul 6, 2024 • edited Loading

coveralls commented Jul 6, 2024

coveralls commented Jul 6, 2024

JoviDeCroock Jul 7, 2024 • edited Loading

Choose a reason for hiding this comment

marvinhagemeister Jul 7, 2024

Choose a reason for hiding this comment

JoviDeCroock Jul 7, 2024

Choose a reason for hiding this comment

marvinhagemeister Jul 7, 2024

Choose a reason for hiding this comment

JoviDeCroock left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 6, 2024 •

edited

Loading

github-actions bot commented Jul 6, 2024 •

edited

Loading

JoviDeCroock Jul 7, 2024 •

edited

Loading