fs: port SonicBoom module to fs module as FastUtf8Stream #58897

jasnell · 2025-06-30T02:49:17Z

As a first step to porting portions of the pino structured logger into the runtime, this commit ports the SonicBoom module to the fs module as FastUtf8Stream. Sonicboom is a dependency of pino.

This is a faithful port of the SonicBoom module with some modern updates, such as converting to a Class and using Symbol.dispose. The bulk of the implementation is unchanged from the original.

Refs: #49296 (comment)

/cc @mcollina @ronag @kibertoad @jsumners @mmarchini @feugy

nodejs-github-bot · 2025-06-30T02:49:23Z

Review requested:

@nodejs/security-wg
@nodejs/streams

codecov · 2025-06-30T03:39:53Z

Codecov Report

❌ Patch coverage is 74.48870% with 237 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.96%. Comparing base (cd1a90d) to head (a5d35b0).
⚠️ Report is 209 commits behind head on main.

Files with missing lines	Patch %	Lines
lib/internal/streams/fast-utf8-stream.js	74.21%	235 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #58897      +/-   ##
==========================================
- Coverage   90.06%   89.96%   -0.11%     
==========================================
  Files         648      649       +1     
  Lines      191078   192007     +929     
  Branches    37454    37631     +177     
==========================================
+ Hits       172101   172742     +641     
- Misses      11598    11885     +287     
- Partials     7379     7380       +1

Files with missing lines	Coverage Δ
lib/fs.js	`98.18% <100.00%> (+<0.01%)`	⬆️
lib/internal/streams/fast-utf8-stream.js	`74.21% <74.21%> (ø)`

... and 30 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mcollina

huge +1. This would be beneficial for other loggers too.

doc/api/fs.md

lib/internal/streams/fast-utf8-stream.js

jasnell · 2025-06-30T13:13:11Z

Tests updated. @mcollina ... So far I have not ported any of the tests that require proxyquire. I'm not sure what's the best way to port that behavior yet. I think, however, that I'd like to get this landed as experimental first and then incrementally improve the test coverage.

mcollina

Some of the worst bugs we fixed are being tests by the proxyquire-based tests (those are error conditions that are impossible to replicate without mocking). They are the battle scars, and they are important to keep around / being ported.

I'm ok for landing this as-is, but can you create a tracking issue for all the tests that you skipped so that they can be ported around?

jasnell · 2025-06-30T13:54:34Z

Absolutely. It's really all of the tests that use proxyquire. We can port those by monkey patching the fs APIs. Not as clean but doable. Will just take time

mcollina

lgtm

jasnell · 2025-07-05T23:02:47Z

@mertcanaltin ... looks like the tests here are hanging and failing consistently. Looks like switching away from using node:test and restructuring the tests helps clear it. Will need to work through refactoring a bit more.

mertcanaltin · 2025-07-06T08:28:24Z

@mertcanaltin ... looks like the tests here are hanging and failing consistently. Looks like switching away from using node:test and restructuring the tests helps clear it. Will need to work through refactoring a bit more.

I would love to help you with this, I'll try an arrangement

TheOneTheOnlyJJ · 2025-07-29T11:57:06Z

@megahertz, you might want to keep an eye on this for electron-log.

As a first step to porting portions of the pino structured logger into the runtime, this commit ports the SonicBoom module to the fs module as Utf8Stream. This is a faithful port of the SonicBoom module with some modern updates, such as converting to a Class and using Symbol.dispose. The bulk of the implementation is unchanged from the original. PR-URL: nodejs#58897 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>

lpinca · 2025-08-04T19:10:46Z

I think that for consistency, the word "fast" should also be removed from the file names.

As a first step to porting portions of the pino structured logger into the runtime, this commit ports the SonicBoom module to the fs module as Utf8Stream. This is a faithful port of the SonicBoom module with some modern updates, such as converting to a Class and using Symbol.dispose. The bulk of the implementation is unchanged from the original. PR-URL: #58897 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>

Notable changes: cli: * (SEMVER-MINOR) add NODE_USE_SYSTEM_CA=1 (Joyee Cheung) #59276 crypto: * (SEMVER-MINOR) support ML-DSA KeyObject, sign, and verify (Filip Skokan) #59259 fs: * (SEMVER-MINOR) port SonicBoom module to fs module as Utf8Stream (James M Snell) #58897 http: * (SEMVER-MINOR) add server.keepAliveTimeoutBuffer option (Haram Jeong) #59243 lib: * docs deprecate _http_* (Sebastian Beltran) #59293 zlib: * (SEMVER-MINOR) add dictionary support to zstdCompress and zstdDecompress (lluisemper) #59240 PR-URL: #59449

Notable changes: cli: * (SEMVER-MINOR) add NODE_USE_SYSTEM_CA=1 (Joyee Cheung) #59276 * (SEMVER-MINOR) add --use-env-proxy (Joyee Cheung) #59151 * (SEMVER-MINOR) support `${pid}` placeholder in --cpu-prof-name (Haram Jeong) #59072 crypto: * (SEMVER-MINOR) support ML-DSA KeyObject, sign, and verify (Filip Skokan) #59259 * (SEMVER-MINOR) add tls.setDefaultCACertificates() (Joyee Cheung) #58822 deps: * update archs files for openssl-3.5.1 (Node.js GitHub Bot) #59234 * upgrade openssl sources to openssl-3.5.1 (Node.js GitHub Bot) #59234 dns: * (SEMVER-MINOR) support max timeout (theanarkh) #58440 doc: * update the instruction on how to verify releases (Antoine du Hamel) #59113 esm: * (SEMVER-MINOR) unflag --experimental-wasm-modules (Guy Bedford) #57038 fs: * (SEMVER-MINOR) port SonicBoom module to fs module as Utf8Stream (James M Snell) #58897 http: * (SEMVER-MINOR) add server.keepAliveTimeoutBuffer option (Haram Jeong) #59243 http,https: * (SEMVER-MINOR) add built-in proxy support in http/https.request and Agent (Joyee Cheung) #58980 lib: * docs deprecate _http_* (Sebastian Beltran) #59293 net: * (SEMVER-MINOR) update net.blocklist to allow file save and file management (alphaleadership) #58087 test: * (SEMVER-MINOR) move http proxy tests to test/client-proxy (Joyee Cheung) #58980 worker: * (SEMVER-MINOR) add web locks api (ishabi) #58666 zlib: * (SEMVER-MINOR) add dictionary support to zstdCompress and zstdDecompress (lluisemper) #59240 PR-URL: #59449 Signed-off-by: RafaelGSS <[email protected]>

Notable changes: cli: * (SEMVER-MINOR) add NODE_USE_SYSTEM_CA=1 (Joyee Cheung) #59276 crypto: * (SEMVER-MINOR) support ML-DSA KeyObject, sign, and verify (Filip Skokan) #59259 fs: * (SEMVER-MINOR) port SonicBoom module to fs module as Utf8Stream (James M Snell) #58897 http: * (SEMVER-MINOR) add server.keepAliveTimeoutBuffer option (Haram Jeong) #59243 lib: * docs deprecate _http_* (Sebastian Beltran) #59293 zlib: * (SEMVER-MINOR) add dictionary support to zstdCompress and zstdDecompress (lluisemper) #59240 PR-URL: #59449 Signed-off-by: RafaelGSS <[email protected]>

Notable changes: cli: * (SEMVER-MINOR) add NODE_USE_SYSTEM_CA=1 (Joyee Cheung) nodejs#59276 crypto: * (SEMVER-MINOR) support ML-DSA KeyObject, sign, and verify (Filip Skokan) nodejs#59259 fs: * (SEMVER-MINOR) port SonicBoom module to fs module as Utf8Stream (James M Snell) nodejs#58897 http: * (SEMVER-MINOR) add server.keepAliveTimeoutBuffer option (Haram Jeong) nodejs#59243 lib: * docs deprecate _http_* (Sebastian Beltran) nodejs#59293 zlib: * (SEMVER-MINOR) add dictionary support to zstdCompress and zstdDecompress (lluisemper) nodejs#59240 PR-URL: nodejs#59449 Signed-off-by: RafaelGSS <[email protected]>

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [node](https://nodejs.org) ([source](https://github.com/nodejs/node)) | minor | `24.5.0` -> `24.6.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>nodejs/node (node)</summary> ### [`v24.6.0`](https://github.com/nodejs/node/releases/tag/v24.6.0): 2025-08-14, Version 24.6.0 (Current), @RafaelGSS [Compare Source](nodejs/node@v24.5.0...v24.6.0) ##### Notable Changes - \[[`471fe712b3`](nodejs/node@471fe712b3)] - **(SEMVER-MINOR)** **cli**: add NODE\_USE\_SYSTEM\_CA=1 (Joyee Cheung) [#59276](nodejs/node#59276) - \[[`38aedfbf73`](nodejs/node@38aedfbf73)] - **(SEMVER-MINOR)** **crypto**: support ML-DSA KeyObject, sign, and verify (Filip Skokan) [#59259](nodejs/node#59259) - \[[`201304537e`](nodejs/node@201304537e)] - **(SEMVER-MINOR)** **zlib**: add dictionary support to zstdCompress and zstdDecompress (lluisemper) [#59240](nodejs/node#59240) - \[[`e79c93a5d0`](nodejs/node@e79c93a5d0)] - **(SEMVER-MINOR)** **http**: add server.keepAliveTimeoutBuffer option (Haram Jeong) [#59243](nodejs/node#59243) - \[[`c144d69efc`](nodejs/node@c144d69efc)] - **lib**: docs deprecate \_http\_\* (Sebastian Beltran) [#59293](nodejs/node#59293) - \[[`aeb4de55a7`](nodejs/node@aeb4de55a7)] - **(SEMVER-MINOR)** **fs**: port SonicBoom module to fs module as Utf8Stream (James M Snell) [#58897](nodejs/node#58897) ##### Commits - \[[`f7484575ff`](nodejs/node@f7484575ff)] - **assert**: change utils to use index instead of for...of (방진혁) [#59278](nodejs/node#59278) - \[[`269cd16185`](nodejs/node@269cd16185)] - **benchmark**: remove deprecated \_extend from benchmark (Rafael Gonzaga) [#59228](nodejs/node#59228) - \[[`848e49c20b`](nodejs/node@848e49c20b)] - **benchmark**: add fs warmup to writefile-promises (Bruno Rodrigues) [#59215](nodejs/node#59215) - \[[`8c609be1b1`](nodejs/node@8c609be1b1)] - **benchmark**: add calibrate-n script (Rafael Gonzaga) [#59186](nodejs/node#59186) - \[[`6a3bf772d8`](nodejs/node@6a3bf772d8)] - **build**: fix node\_use\_sqlite for GN builds (Shelley Vohr) [#59017](nodejs/node#59017) - \[[`471fe712b3`](nodejs/node@471fe712b3)] - **(SEMVER-MINOR)** **cli**: add NODE\_USE\_SYSTEM\_CA=1 (Joyee Cheung) [#59276](nodejs/node#59276) - \[[`38aedfbf73`](nodejs/node@38aedfbf73)] - **(SEMVER-MINOR)** **crypto**: support ML-DSA KeyObject, sign, and verify (Filip Skokan) [#59259](nodejs/node#59259) - \[[`a312e706cf`](nodejs/node@a312e706cf)] - **crypto**: prepare webcrypto key import/export for modern algorithms (Filip Skokan) [#59284](nodejs/node#59284) - \[[`3a7c2c3a47`](nodejs/node@3a7c2c3a47)] - **deps**: update ada to 3.2.7 (Node.js GitHub Bot) [#59336](nodejs/node#59336) - \[[`8d9ceeaf6a`](nodejs/node@8d9ceeaf6a)] - **deps**: update archs files for openssl-3.5.2 (Node.js GitHub Bot) [#59371](nodejs/node#59371) - \[[`33b06df354`](nodejs/node@33b06df354)] - **deps**: upgrade openssl sources to openssl-3.5.2 (Node.js GitHub Bot) [#59371](nodejs/node#59371) - \[[`fa70f1af77`](nodejs/node@fa70f1af77)] - **deps**: support madvise(3C) across ALL illumos revisions (Dan McDonald) [#58237](nodejs/node#58237) - \[[`f834a6be59`](nodejs/node@f834a6be59)] - **deps**: update undici to 7.13.0 (Node.js GitHub Bot) [#59338](nodejs/node#59338) - \[[`db2417487e`](nodejs/node@db2417487e)] - **deps**: update sqlite to 3.50.4 (Node.js GitHub Bot) [#59337](nodejs/node#59337) - \[[`41978adb08`](nodejs/node@41978adb08)] - **deps**: V8: backport [`493cb53`](nodejs/node@493cb53691be) (Chengzhong Wu) [#59238](nodejs/node#59238) - \[[`05667991ca`](nodejs/node@05667991ca)] - **deps**: V8: backport [`1c3e018`](nodejs/node@1c3e018e7d48) (Renegade334) [#58818](nodejs/node#58818) - \[[`fd61588bb4`](nodejs/node@fd61588bb4)] - **doc**: rename x509.extKeyUsage to x509.keyUsage (Filip Skokan) [#59332](nodejs/node#59332) - \[[`a271ae4360`](nodejs/node@a271ae4360)] - **doc**: fix Pbkdf2Params hash attribute heading (Filip Skokan) [#59395](nodejs/node#59395) - \[[`72cfff165b`](nodejs/node@72cfff165b)] - **doc**: fix missing reference links for server.keepAliveTimeoutBuffer (Lee Jiho) [#59356](nodejs/node#59356) - \[[`8341916772`](nodejs/node@8341916772)] - **doc**: fix grammar in global dispatcher usage (Eng Zer Jun) [#59344](nodejs/node#59344) - \[[`e3e489706b`](nodejs/node@e3e489706b)] - **doc**: run license-builder (github-actions\[bot]) [#59343](nodejs/node#59343) - \[[`46527e8cea`](nodejs/node@46527e8cea)] - **doc**: correct orthography `eg.` → `e.g.` (Jacob Smith) [#59329](nodejs/node#59329) - \[[`d140c3713e`](nodejs/node@d140c3713e)] - **doc**: clarify the need of compiler compatible with c++20 (Rafael Gonzaga) [#59297](nodejs/node#59297) - \[[`95e9cabf9d`](nodejs/node@95e9cabf9d)] - **doc**: clarify release candidate stability index (Filip Skokan) [#59295](nodejs/node#59295) - \[[`a056dd36d2`](nodejs/node@a056dd36d2)] - **doc**: add WDYT to glossary (btea) [#59280](nodejs/node#59280) - \[[`1e2c52f5c4`](nodejs/node@1e2c52f5c4)] - **doc**: add manpage entry for --use-system-ca (Joyee Cheung) [#59273](nodejs/node#59273) - \[[`31a46fdeb4`](nodejs/node@31a46fdeb4)] - **doc**: add path.join and path.normalize clarification (Rafael Gonzaga) [#59262](nodejs/node#59262) - \[[`cff3725ff9`](nodejs/node@cff3725ff9)] - **doc**: fix typo in `test/common/README.md` (Yoo) [#59180](nodejs/node#59180) - \[[`31a9283591`](nodejs/node@31a9283591)] - **doc**: add note on process memoryUsage (fengmk2) [#59026](nodejs/node#59026) - \[[`5a98bff6b8`](nodejs/node@5a98bff6b8)] - **doc**: format safely for `doc-kit` (Aviv Keller) [#59229](nodejs/node#59229) - \[[`95b8b7ea5c`](nodejs/node@95b8b7ea5c)] - **domain**: remove deprecated API call (Alex Yang) [#59339](nodejs/node#59339) - \[[`2990f178bd`](nodejs/node@2990f178bd)] - **fs**: fix glob TypeError on restricted dirs (Sylphy-0xd3ac) [#58674](nodejs/node#58674) - \[[`e2fb4caf9c`](nodejs/node@e2fb4caf9c)] - **fs**: correct error message when FileHandle is transferred (Alex Yang) [#59156](nodejs/node#59156) - \[[`aeb4de55a7`](nodejs/node@aeb4de55a7)] - **(SEMVER-MINOR)** **fs**: port SonicBoom module to fs module as Utf8Stream (James M Snell) [#58897](nodejs/node#58897) - \[[`e79c93a5d0`](nodejs/node@e79c93a5d0)] - **(SEMVER-MINOR)** **http**: add server.keepAliveTimeoutBuffer option (Haram Jeong) [#59243](nodejs/node#59243) - \[[`0fb005a53f`](nodejs/node@0fb005a53f)] - **http2**: set Http2Stream#sentHeaders for raw headers (Darshan Sen) [#59244](nodejs/node#59244) - \[[`e055539604`](nodejs/node@e055539604)] - **lib**: add trace-sigint APIs (theanarkh) [#59040](nodejs/node#59040) - \[[`d2183d860a`](nodejs/node@d2183d860a)] - **lib**: optimize writable stream buffer clearing (Yoo) [#59406](nodejs/node#59406) - \[[`47543a7e17`](nodejs/node@47543a7e17)] - **lib**: handle windows reserved device names on UNC (Rafael Gonzaga) [#59286](nodejs/node#59286) - \[[`c6911f0717`](nodejs/node@c6911f0717)] - **lib**: do not modify prototype deprecated asyncResource (RafaelGSS) [#59195](nodejs/node#59195) - \[[`3c88b769bb`](nodejs/node@3c88b769bb)] - **lib**: restructure assert to become a class (Miguel Marcondes Filho) [#58253](nodejs/node#58253) - \[[`e91b54df59`](nodejs/node@e91b54df59)] - **lib**: handle superscript variants on windows device (Rafael Gonzaga) [#59261](nodejs/node#59261) - \[[`4ee467905d`](nodejs/node@4ee467905d)] - **lib**: use validateString (hotpineapple) [#59296](nodejs/node#59296) - \[[`c144d69efc`](nodejs/node@c144d69efc)] - **lib**: docs deprecate \_http\_\* (Sebastian Beltran) [#59293](nodejs/node#59293) - \[[`c89b67e681`](nodejs/node@c89b67e681)] - **lib**: add type names in source mapped stack traces (Chengzhong Wu) [#58976](nodejs/node#58976) - \[[`5b2363be8d`](nodejs/node@5b2363be8d)] - **lib**: prefer AsyncIteratorPrototype primordial (René) [#59097](nodejs/node#59097) - \[[`41b4f4d694`](nodejs/node@41b4f4d694)] - **meta**: clarify pr objection process further (James M Snell) [#59096](nodejs/node#59096) - \[[`0eb5962f1e`](nodejs/node@0eb5962f1e)] - **meta**: add mailmap entry for aditi-1400 (Aditi) [#59316](nodejs/node#59316) - \[[`a2b72c2304`](nodejs/node@a2b72c2304)] - **meta**: add tsc and build team as codeowners building.md (Rafael Gonzaga) [#59298](nodejs/node#59298) - \[[`d69f3ee1e0`](nodejs/node@d69f3ee1e0)] - **meta**: add nodejs/path to path files (Rafael Gonzaga) [#59289](nodejs/node#59289) - \[[`1e37eab865`](nodejs/node@1e37eab865)] - **node-api**: reword "implementation in an alternative VM" as implementable (Chengzhong Wu) [#59036](nodejs/node#59036) - \[[`64add6302a`](nodejs/node@64add6302a)] - **src**: use simdjson to parse SEA configuration (Joyee Cheung) [#59323](nodejs/node#59323) - \[[`e9c6636585`](nodejs/node@e9c6636585)] - **src**: mark realm leaf classes final (Anna Henningsen) [#59355](nodejs/node#59355) - \[[`42ef8147d1`](nodejs/node@42ef8147d1)] - **src**: warn about FastOneByteString invalidation (James M Snell) [#59275](nodejs/node#59275) - \[[`8686b8037a`](nodejs/node@8686b8037a)] - **src**: remove unused DSAKeyExportJob (Filip Skokan) [#59291](nodejs/node#59291) - \[[`1e5f632666`](nodejs/node@1e5f632666)] - **src**: use C++20 `contains()` method (iknoom) [#59304](nodejs/node#59304) - \[[`22d4683cfe`](nodejs/node@22d4683cfe)] - **src**: added CHECK\_NOT\_NULL check for multiple eq\_wrap\_async (F3lixTheCat) [#59267](nodejs/node#59267) - \[[`6a47ff4943`](nodejs/node@6a47ff4943)] - **src**: clear all linked module caches once instantiated (Chengzhong Wu) [#59117](nodejs/node#59117) - \[[`33728cb4ca`](nodejs/node@33728cb4ca)] - **src**: add nullptr checks in `StreamPipe::New` (Burkov Egor) [#57613](nodejs/node#57613) - \[[`4a907bdad1`](nodejs/node@4a907bdad1)] - **src**: add percentage support to --max-old-space-size (Asaf Federman) [#59082](nodejs/node#59082) - \[[`7c189d4f55`](nodejs/node@7c189d4f55)] - **test**: deflake sequential/test-tls-session-timeout (Joyee Cheung) [#59423](nodejs/node#59423) - \[[`fb0a6fb57f`](nodejs/node@fb0a6fb57f)] - **test**: exclude mock from coverage (Shima Ryuhei) [#59348](nodejs/node#59348) - \[[`7e10f95f13`](nodejs/node@7e10f95f13)] - **test**: split test-fs-cp.js (Joyee Cheung) [#59408](nodejs/node#59408) - \[[`41bcf5f659`](nodejs/node@41bcf5f659)] - **test**: update WPT resources,WebCryptoAPI,webstorage (Filip Skokan) [#59311](nodejs/node#59311) - \[[`f9f3dc94cb`](nodejs/node@f9f3dc94cb)] - **test**: add known issue test for fs.cpSync dereference bug (James M Snell) [#58941](nodejs/node#58941) - \[[`244d0c38a8`](nodejs/node@244d0c38a8)] - **test**: deflake stream-readable-to-web test (Ethan Arrowood) [#58948](nodejs/node#58948) - \[[`564e604a1a`](nodejs/node@564e604a1a)] - **test**: make test-inspector-network-resource sequential (Shima Ryuhei) [#59104](nodejs/node#59104) - \[[`7ab13b7477`](nodejs/node@7ab13b7477)] - **test**: don't use expose internals in test-http-outgoing-buffer.js (Meghan Denny) [#59219](nodejs/node#59219) - \[[`319df3859a`](nodejs/node@319df3859a)] - **test,crypto**: skip unsupported ciphers (Shelley Vohr) [#59388](nodejs/node#59388) - \[[`713c70c32a`](nodejs/node@713c70c32a)] - **test\_runner**: remove unused callee convertion (Alex Yang) [#59221](nodejs/node#59221) - \[[`e4ca30e115`](nodejs/node@e4ca30e115)] - **tools**: disable nullability-completeness warnings (Michaël Zasso) [#59392](nodejs/node#59392) - \[[`dab7f6b542`](nodejs/node@dab7f6b542)] - **tools**: check for std::vector\<v8::Local> in lint (Aditi) [#58497](nodejs/node#58497) - \[[`7b94982eb0`](nodejs/node@7b94982eb0)] - **tools**: allow selecting test subsystems with numbers in their names (Darshan Sen) [#59242](nodejs/node#59242) - \[[`16bbcd8881`](nodejs/node@16bbcd8881)] - **typings**: improve internal binding types (Nam Yooseong) [#59351](nodejs/node#59351) - \[[`76bc4d659b`](nodejs/node@76bc4d659b)] - **typings**: improve internal binding types (Michaël Zasso) [#59176](nodejs/node#59176) - \[[`eecd3272a6`](nodejs/node@eecd3272a6)] - **worker**: add name for worker (theanarkh) [#59213](nodejs/node#59213) - \[[`84c3513ce2`](nodejs/node@84c3513ce2)] - **worker**: implements nits in Web Locks code (Antoine du Hamel) [#59270](nodejs/node#59270) - \[[`bd68fbd753`](nodejs/node@bd68fbd753)] - **worker**: add cpuUsage for worker (theanarkh) [#59177](nodejs/node#59177) - \[[`201304537e`](nodejs/node@201304537e)] - **(SEMVER-MINOR)** **zlib**: add dictionary support to zstdCompress and zstdDecompress (lluisemper) [#59240](nodejs/node#59240) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Notable changes: cli: * (SEMVER-MINOR) add NODE_USE_SYSTEM_CA=1 (Joyee Cheung) nodejs#59276 crypto: * (SEMVER-MINOR) support ML-DSA KeyObject, sign, and verify (Filip Skokan) nodejs#59259 fs: * (SEMVER-MINOR) port SonicBoom module to fs module as Utf8Stream (James M Snell) nodejs#58897 http: * (SEMVER-MINOR) add server.keepAliveTimeoutBuffer option (Haram Jeong) nodejs#59243 lib: * docs deprecate _http_* (Sebastian Beltran) nodejs#59293 zlib: * (SEMVER-MINOR) add dictionary support to zstdCompress and zstdDecompress (lluisemper) nodejs#59240 PR-URL: nodejs#59449 Signed-off-by: RafaelGSS <[email protected]>

As a first step to porting portions of the pino structured logger into the runtime, this commit ports the SonicBoom module to the fs module as Utf8Stream. This is a faithful port of the SonicBoom module with some modern updates, such as converting to a Class and using Symbol.dispose. The bulk of the implementation is unchanged from the original. PR-URL: #58897 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Vinícius Lourenço Claro Cardoso <[email protected]>

aduh95 · 2025-08-26T09:21:34Z

Tests are failing on Windows with this change on v22.x-staging, we would need a manual backport

joyeecheung · 2025-08-26T19:58:04Z

parallel/test-fastutf8stream-flush-mocks and parallel/test-fastutf8stream-sync have recently failed 14 PRs out of the recent 100 CI runs: #59638

nodejs/node#58897

* chore: upgrade Node.js to v24.10.0 * chore: fixup crypto patch * chore: fixup crypto test patch * src: prepare for v8 sandboxing nodejs/node#58376 * esm: fix module.exports export on CJS modules nodejs/node#57366 * chore: fixup lazyload fs patch * esm: Source Phase Imports for WebAssembly nodejs/node#56919 * module: remove --experimental-default-type nodejs/node#56092 * lib,src: refactor assert to load error source from memory nodejs/node#59751 * src: add source location to v8::TaskRunner nodejs/node#54077 * src: remove dependency on wrapper-descriptor-based CppHeap nodejs/node#54077 * src: do not use soon-to-be-deprecated V8 API nodejs/node#53174 * src: stop using deprecated fields of v8::FastApiCallbackOptions nodejs/node#54077 * test: update v8-stats test for V8 12.6 nodejs/node#54077 * esm: unflag --experimental-wasm-modules nodejs/node#57038 * test: adapt assert tests to stack trace changes nodejs/node#58070 * src,test: unregister the isolate after disposal and before freeing nodejs/node#58070 * src: use cppgc to manage ContextifyContext nodejs/node#56522 * src: replace uses of FastApiTypedArray nodejs/node#58070 * module: integrate TypeScript into compile cache nodejs/node#56629 * deps: update ada to 3.2.7 nodejs/node#59336 * src: make minor cleanups in encoding_binding.cc nodejs/node#57448 * src: switch from `Get/SetPrototype` to `Get/SetPrototypeV2` nodejs/node#55453 * src: use non-deprecated Get/SetPrototype methods nodejs/node#59671 * src: simplify string_bytes with views nodejs/node#54876 * src: improve utf8 string generation performance nodejs/node#54873 * src: use non-deprecated Utf8LengthV2() method nodejs/node#58070 * src: use non-deprecated WriteUtf8V2() method nodejs/node#58070 * src: refactor WriteUCS2 and remove flags argument nodejs/node#58163 * src: use String::WriteV2() in TwoByteValue nodejs/node#58164 * node-api: use WriteV2 in napi_get_value_string_utf16 nodejs/node#58165 * node-api: use WriteOneByteV2 in napi_get_value_string_latin1 nodejs/node#58325 * src: migrate WriteOneByte to WriteOneByteV2 nodejs/node#59634 * fs: introduce dirent\.parentPath nodejs/node#50976 * src: avoid copy by using std::views::keys nodejs/node#56080 * chore: fixup patch indices * fix: errant use of context->GetIsolate() * fix: tweak BoringSSL compat patch for new changes * fix: add back missing isolate dtor declaration * fixup! esm: fix module.exports export on CJS modules * cli: remove --no-experimental-fetch flag https://github.com/nodejs/node/pull/52611/files * esm: Source Phase Imports for WebAssembly nodejs/node#56919 * fixup! src: prepare for v8 sandboxing * chore: bump @types/node to v24 * chore: fix const assignment in crypto test * fix: sandbox pointer patch issues * chore: rework source phase import patch * src: add percentage support to --max-old-space-size nodejs/node#59082 * chore: fixup crypto tests * chore: HostImportModuleWithPhaseDynamically todo * fix: cjs esm failures * fix: v8::Object::Wrappable issues - v8/node@b72a615 - v8/node@490bac2 - v8/node@4896a0d * chore: remove deleted specs * src: use v8::ExternalMemoryAccounter nodejs/node#58070 * fs: port SonicBoom module to fs module as FastUtf8Stream nodejs/node#58897 * chore: tweak sandboxed pr patch * test: disable parallel/test-os-checked-function * test: use WHATWG URL instead of url.parse * fix: OPENSSL_secure_zalloc doesn't work in BoringSSL * chore: fix accidental extra line * 7017517: [defer-import-eval] Parse import defer syntax https://chromium-review.googlesource.com/c/v8/v8/+/7017517

nodejs/node#58897 Co-authored-by: Shelley Vohr <[email protected]>

* chore: upgrade Node.js to v24.10.0 * chore: fixup crypto patch * chore: fixup crypto test patch * src: prepare for v8 sandboxing nodejs/node#58376 * esm: fix module.exports export on CJS modules nodejs/node#57366 * chore: fixup lazyload fs patch * esm: Source Phase Imports for WebAssembly nodejs/node#56919 * module: remove --experimental-default-type nodejs/node#56092 * lib,src: refactor assert to load error source from memory nodejs/node#59751 * src: add source location to v8::TaskRunner nodejs/node#54077 * src: remove dependency on wrapper-descriptor-based CppHeap nodejs/node#54077 * src: do not use soon-to-be-deprecated V8 API nodejs/node#53174 * src: stop using deprecated fields of v8::FastApiCallbackOptions nodejs/node#54077 * test: update v8-stats test for V8 12.6 nodejs/node#54077 * esm: unflag --experimental-wasm-modules nodejs/node#57038 * test: adapt assert tests to stack trace changes nodejs/node#58070 * src,test: unregister the isolate after disposal and before freeing nodejs/node#58070 * src: use cppgc to manage ContextifyContext nodejs/node#56522 * src: replace uses of FastApiTypedArray nodejs/node#58070 * module: integrate TypeScript into compile cache nodejs/node#56629 * deps: update ada to 3.2.7 nodejs/node#59336 * src: make minor cleanups in encoding_binding.cc nodejs/node#57448 * src: switch from `Get/SetPrototype` to `Get/SetPrototypeV2` nodejs/node#55453 * src: use non-deprecated Get/SetPrototype methods nodejs/node#59671 * src: simplify string_bytes with views nodejs/node#54876 * src: improve utf8 string generation performance nodejs/node#54873 * src: use non-deprecated Utf8LengthV2() method nodejs/node#58070 * src: use non-deprecated WriteUtf8V2() method nodejs/node#58070 * src: refactor WriteUCS2 and remove flags argument nodejs/node#58163 * src: use String::WriteV2() in TwoByteValue nodejs/node#58164 * node-api: use WriteV2 in napi_get_value_string_utf16 nodejs/node#58165 * node-api: use WriteOneByteV2 in napi_get_value_string_latin1 nodejs/node#58325 * src: migrate WriteOneByte to WriteOneByteV2 nodejs/node#59634 * fs: introduce dirent\.parentPath nodejs/node#50976 * src: avoid copy by using std::views::keys nodejs/node#56080 * chore: fixup patch indices * fix: errant use of context->GetIsolate() * fix: tweak BoringSSL compat patch for new changes * fix: add back missing isolate dtor declaration * fixup! esm: fix module.exports export on CJS modules * cli: remove --no-experimental-fetch flag https://github.com/nodejs/node/pull/52611/files * esm: Source Phase Imports for WebAssembly nodejs/node#56919 * fixup! src: prepare for v8 sandboxing * chore: bump @types/node to v24 * chore: fix const assignment in crypto test * fix: sandbox pointer patch issues * chore: rework source phase import patch * src: add percentage support to --max-old-space-size nodejs/node#59082 * chore: fixup crypto tests * chore: HostImportModuleWithPhaseDynamically todo * fix: cjs esm failures * fix: v8::Object::Wrappable issues - v8/node@b72a615 - v8/node@490bac2 - v8/node@4896a0d * chore: remove deleted specs * src: use v8::ExternalMemoryAccounter nodejs/node#58070 * fs: port SonicBoom module to fs module as FastUtf8Stream nodejs/node#58897 * chore: tweak sandboxed pr patch * test: disable parallel/test-os-checked-function * test: use WHATWG URL instead of url.parse * fix: OPENSSL_secure_zalloc doesn't work in BoringSSL * chore: fix accidental extra line * 7017517: [defer-import-eval] Parse import defer syntax https://chromium-review.googlesource.com/c/v8/v8/+/7017517

* chore: upgrade Node.js to v24.10.0 Co-authored-by: Shelley Vohr <[email protected]> * chore: fixup crypto patch Co-authored-by: Shelley Vohr <[email protected]> * chore: fixup crypto test patch Co-authored-by: Shelley Vohr <[email protected]> * src: prepare for v8 sandboxing nodejs/node#58376 Co-authored-by: Shelley Vohr <[email protected]> * esm: fix module.exports export on CJS modules nodejs/node#57366 Co-authored-by: Shelley Vohr <[email protected]> * chore: fixup lazyload fs patch Co-authored-by: Shelley Vohr <[email protected]> * esm: Source Phase Imports for WebAssembly nodejs/node#56919 Co-authored-by: Shelley Vohr <[email protected]> * module: remove --experimental-default-type nodejs/node#56092 Co-authored-by: Shelley Vohr <[email protected]> * lib,src: refactor assert to load error source from memory nodejs/node#59751 Co-authored-by: Shelley Vohr <[email protected]> * src: add source location to v8::TaskRunner nodejs/node#54077 Co-authored-by: Shelley Vohr <[email protected]> * src: remove dependency on wrapper-descriptor-based CppHeap nodejs/node#54077 Co-authored-by: Shelley Vohr <[email protected]> * src: do not use soon-to-be-deprecated V8 API nodejs/node#53174 Co-authored-by: Shelley Vohr <[email protected]> * src: stop using deprecated fields of v8::FastApiCallbackOptions nodejs/node#54077 Co-authored-by: Shelley Vohr <[email protected]> * test: update v8-stats test for V8 12.6 nodejs/node#54077 Co-authored-by: Shelley Vohr <[email protected]> * esm: unflag --experimental-wasm-modules nodejs/node#57038 Co-authored-by: Shelley Vohr <[email protected]> * test: adapt assert tests to stack trace changes nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * src,test: unregister the isolate after disposal and before freeing nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * src: use cppgc to manage ContextifyContext nodejs/node#56522 Co-authored-by: Shelley Vohr <[email protected]> * src: replace uses of FastApiTypedArray nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * module: integrate TypeScript into compile cache nodejs/node#56629 Co-authored-by: Shelley Vohr <[email protected]> * deps: update ada to 3.2.7 nodejs/node#59336 Co-authored-by: Shelley Vohr <[email protected]> * src: make minor cleanups in encoding_binding.cc nodejs/node#57448 Co-authored-by: Shelley Vohr <[email protected]> * src: switch from `Get/SetPrototype` to `Get/SetPrototypeV2` nodejs/node#55453 Co-authored-by: Shelley Vohr <[email protected]> * src: use non-deprecated Get/SetPrototype methods nodejs/node#59671 Co-authored-by: Shelley Vohr <[email protected]> * src: simplify string_bytes with views nodejs/node#54876 Co-authored-by: Shelley Vohr <[email protected]> * src: improve utf8 string generation performance nodejs/node#54873 Co-authored-by: Shelley Vohr <[email protected]> * src: use non-deprecated Utf8LengthV2() method nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * src: use non-deprecated WriteUtf8V2() method nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * src: refactor WriteUCS2 and remove flags argument nodejs/node#58163 Co-authored-by: Shelley Vohr <[email protected]> * src: use String::WriteV2() in TwoByteValue nodejs/node#58164 Co-authored-by: Shelley Vohr <[email protected]> * node-api: use WriteV2 in napi_get_value_string_utf16 nodejs/node#58165 Co-authored-by: Shelley Vohr <[email protected]> * node-api: use WriteOneByteV2 in napi_get_value_string_latin1 nodejs/node#58325 Co-authored-by: Shelley Vohr <[email protected]> * src: migrate WriteOneByte to WriteOneByteV2 nodejs/node#59634 Co-authored-by: Shelley Vohr <[email protected]> * fs: introduce dirent\.parentPath nodejs/node#50976 Co-authored-by: Shelley Vohr <[email protected]> * src: avoid copy by using std::views::keys nodejs/node#56080 Co-authored-by: Shelley Vohr <[email protected]> * chore: fixup patch indices Co-authored-by: Shelley Vohr <[email protected]> * fix: errant use of context->GetIsolate() Co-authored-by: Shelley Vohr <[email protected]> * fix: tweak BoringSSL compat patch for new changes Co-authored-by: Shelley Vohr <[email protected]> * fix: add back missing isolate dtor declaration Co-authored-by: Shelley Vohr <[email protected]> * fixup! esm: fix module.exports export on CJS modules Co-authored-by: Shelley Vohr <[email protected]> * cli: remove --no-experimental-fetch flag https://github.com/nodejs/node/pull/52611/files Co-authored-by: Shelley Vohr <[email protected]> * esm: Source Phase Imports for WebAssembly nodejs/node#56919 Co-authored-by: Shelley Vohr <[email protected]> * fixup! src: prepare for v8 sandboxing Co-authored-by: Shelley Vohr <[email protected]> * chore: bump @types/node to v24 Co-authored-by: Shelley Vohr <[email protected]> * chore: fix const assignment in crypto test Co-authored-by: Shelley Vohr <[email protected]> * fix: sandbox pointer patch issues Co-authored-by: Shelley Vohr <[email protected]> * chore: rework source phase import patch Co-authored-by: Shelley Vohr <[email protected]> * src: add percentage support to --max-old-space-size nodejs/node#59082 Co-authored-by: Shelley Vohr <[email protected]> * chore: fixup crypto tests Co-authored-by: Shelley Vohr <[email protected]> * chore: HostImportModuleWithPhaseDynamically todo Co-authored-by: Shelley Vohr <[email protected]> * fix: cjs esm failures Co-authored-by: Shelley Vohr <[email protected]> * fix: v8::Object::Wrappable issues - v8/node@b72a615 - v8/node@490bac2 - v8/node@4896a0d Co-authored-by: Shelley Vohr <[email protected]> * chore: remove deleted specs Co-authored-by: Shelley Vohr <[email protected]> * src: use v8::ExternalMemoryAccounter nodejs/node#58070 Co-authored-by: Shelley Vohr <[email protected]> * fs: port SonicBoom module to fs module as FastUtf8Stream nodejs/node#58897 Co-authored-by: Shelley Vohr <[email protected]> * chore: tweak sandboxed pr patch Co-authored-by: Shelley Vohr <[email protected]> * test: disable parallel/test-os-checked-function Co-authored-by: Shelley Vohr <[email protected]> * test: use WHATWG URL instead of url.parse Co-authored-by: Shelley Vohr <[email protected]> * fix: OPENSSL_secure_zalloc doesn't work in BoringSSL Co-authored-by: Shelley Vohr <[email protected]> * chore: fix accidental extra line Co-authored-by: Shelley Vohr <[email protected]> * 7017517: [defer-import-eval] Parse import defer syntax https://chromium-review.googlesource.com/c/v8/v8/+/7017517 Co-authored-by: Shelley Vohr <[email protected]> --------- Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <[email protected]>

jasnell requested a review from mcollina June 30, 2025 02:49

jasnell marked this pull request as draft June 30, 2025 02:49

nodejs-github-bot added fs Issues and PRs related to the fs subsystem / file system. needs-ci PRs that need a full CI run. stream Issues and PRs related to the stream subsystem. tools Issues and PRs related to the tools directory. labels Jun 30, 2025

jasnell added the semver-minor PRs that contain new features and should be released in the next minor version. label Jun 30, 2025

mcollina reviewed Jun 30, 2025

View reviewed changes

doc/api/fs.md Outdated Show resolved Hide resolved

jsumners reviewed Jun 30, 2025

View reviewed changes

doc/api/fs.md Outdated Show resolved Hide resolved

lib/internal/streams/fast-utf8-stream.js Outdated Show resolved Hide resolved

lib/internal/streams/fast-utf8-stream.js Show resolved Hide resolved

jasnell force-pushed the jasnell/port-sonicboom branch from 41f2c92 to 5631e21 Compare June 30, 2025 13:12

mcollina reviewed Jun 30, 2025

View reviewed changes

jasnell force-pushed the jasnell/port-sonicboom branch 3 times, most recently from bb11c97 to e03efc9 Compare July 4, 2025 16:37

jasnell marked this pull request as ready for review July 4, 2025 16:37

jasnell mentioned this pull request Jul 4, 2025

Tracking Issue: Port all SonicBoom tests for FastUtf8Stream #58955

Open

This comment was marked as outdated.

Sign in to view

mcollina approved these changes Jul 4, 2025

View reviewed changes

jasnell force-pushed the jasnell/port-sonicboom branch from e03efc9 to da471d7 Compare July 4, 2025 18:25

mertcanaltin mentioned this pull request Jul 5, 2025

test: add FastUtf8Stream tests #58964

Closed

jasnell force-pushed the jasnell/port-sonicboom branch from da471d7 to f5136bd Compare July 5, 2025 19:40

This comment was marked as outdated.

Sign in to view

jasnell force-pushed the jasnell/port-sonicboom branch from f5136bd to 583dcfb Compare July 5, 2025 23:01

jasnell marked this pull request as draft July 5, 2025 23:02

github-actions bot mentioned this pull request Aug 11, 2025

2025-08-12, Version 24.6.0 (Current) #59449

Merged

aduh95 added the backport-requested-v22.x PRs awaiting manual backport to the v22.x-staging branch. label Aug 26, 2025

joyeecheung mentioned this pull request Aug 26, 2025

parallel/test-fastutf8stream-flush-mocks and parallel/test-fastutf8stream-sync are flaky on Windows #59638

Closed

codebytere added a commit to electron/electron that referenced this pull request Oct 27, 2025

fs: port SonicBoom module to fs module as FastUtf8Stream

a789d0c

nodejs/node#58897

codebytere added a commit to electron/electron that referenced this pull request Oct 27, 2025

fs: port SonicBoom module to fs module as FastUtf8Stream

d3c2a59

nodejs/node#58897

codebytere mentioned this pull request Oct 28, 2025

lib: check SharedArrayBuffer existence in fast-utf8-stream #60453

Closed

codebytere added a commit to electron/electron that referenced this pull request Oct 28, 2025

fs: port SonicBoom module to fs module as FastUtf8Stream

fb19ddc

nodejs/node#58897

codebytere added a commit to electron/electron that referenced this pull request Oct 30, 2025

fs: port SonicBoom module to fs module as FastUtf8Stream

fdaa466

nodejs/node#58897

trop bot added a commit to electron/electron that referenced this pull request Oct 30, 2025

fs: port SonicBoom module to fs module as FastUtf8Stream

1006151

nodejs/node#58897 Co-authored-by: Shelley Vohr <[email protected]>

Uh oh!

fs: port SonicBoom module to fs module as FastUtf8Stream #58897

fs: port SonicBoom module to fs module as FastUtf8Stream #58897

Uh oh!

Conversation

jasnell commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Jun 30, 2025

Uh oh!

codecov bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jasnell commented Jun 30, 2025

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

jasnell commented Jun 30, 2025

Uh oh!

This comment was marked as outdated.

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

jasnell commented Jul 5, 2025

Uh oh!

mertcanaltin commented Jul 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheOneTheOnlyJJ commented Jul 29, 2025

Uh oh!

lpinca commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aduh95 commented Aug 26, 2025

Uh oh!

joyeecheung commented Aug 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

jasnell commented Jun 30, 2025 •

edited

Loading

codecov bot commented Jun 30, 2025 •

edited

Loading

mertcanaltin commented Jul 6, 2025 •

edited

Loading

lpinca commented Aug 4, 2025 •

edited

Loading