worker: add `markAsUncloneable` api #55234

jazelly · 2024-10-02T07:02:16Z

External modules need a way to decorate their objects so that node can
recognize it as a host object for serialization process. Exposing a way
for turning off instead of turning on is much safer.

Refs: #55178

jazelly · 2024-10-02T07:09:36Z

doc/api/worker_threads.md

+a [`port.postMessage()`][] call, an error is thrown. This is a no-op if `object` is a
+primitive value.
+
+Note, this does not take effect on `ArrayBuffer`, or any `Buffer` like objects.


My understanding is Buffer like objects are from v8 and they don't follow the BaseObject way in node, which requires CloneForMessaging, which honors the TransferMode::kCloneable flag. So modifying or marking that flag will take no effect to Buffer.

jazelly · 2024-10-02T07:12:04Z

cc @legendecas

codecov · 2024-10-02T08:34:04Z

Codecov Report

Attention: Patch coverage is 83.33333% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.39%. Comparing base (89a2f56) to head (622ca5e).
Report is 26 commits behind head on main.

Files with missing lines	Patch %	Lines
lib/internal/worker/io.js	81.25%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #55234   +/-   ##
=======================================
  Coverage   88.39%   88.39%           
=======================================
  Files         652      652           
  Lines      186565   186591   +26     
  Branches    36046    36046           
=======================================
+ Hits       164916   164941   +25     
- Misses      14908    14915    +7     
+ Partials     6741     6735    -6

Files with missing lines	Coverage Δ
lib/worker_threads.js	`100.00% <100.00%> (ø)`
lib/internal/worker/io.js	`99.17% <81.25%> (-0.62%)`	⬇️

... and 32 files with indirect coverage changes

doc/api/worker_threads.md

lib/internal/worker/io.js

jakecastelli

small nit: expose sounds like this function exists internally and now we are trying to expose to the user land, instead, I would suggest add and also the subsystem worker_thread (for PR title, commit message)

nodejs-github-bot · 2024-10-03T09:28:49Z

CI: https://ci.nodejs.org/job/node-test-pull-request/62901/

External modules need a way to decorate their objects so that node can recognize it as a host object for serialization process. Exposing a way for turning off instead of turning on is much safer.

nodejs-github-bot · 2024-10-03T15:12:42Z

CI: https://ci.nodejs.org/job/node-test-pull-request/62906/

nodejs-github-bot · 2024-10-04T07:09:39Z

Landed in d2ad9b4

External modules need a way to decorate their objects so that node can recognize it as a host object for serialization process. Exposing a way for turning off instead of turning on is much safer. PR-URL: #55234 Refs: #55178 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Daeyeon Jeong <[email protected]> Reviewed-By: Matthew Aitken <[email protected]>

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) #55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) #54159 doc: * add abmusse to collaborators (Abdirahim Musse) #55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) #54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) #54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) #54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) #54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) #54971 src: * mark node `--run` as stable (Yagiz Nizipli) #53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) #55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) #54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) #53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) #55234 PR-URL: TODO

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) #55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) #54159 doc: * add abmusse to collaborators (Abdirahim Musse) #55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) #54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) #54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) #54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) #54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) #54971 src: * mark node `--run` as stable (Yagiz Nizipli) #53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) #55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) #54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) #53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) #55234 PR-URL: #55343

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) #55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) #54159 doc: * add abmusse to collaborators (Abdirahim Musse) #55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) #54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) #54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) #54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) #54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) #54971 src: * mark `node --run` as stable (Yagiz Nizipli) #53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) #55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) #54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) #53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) #55234 PR-URL: #55343

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) #55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) #54159 doc: * add abmusse to collaborators (Abdirahim Musse) #55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) #54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) #54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) #54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) #54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) #54971 process: * (SEMVER-MINOR) add `process.features.require_module` (Joyee Cheung) #55241 src: * mark `node --run` as stable (Yagiz Nizipli) #53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) #55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) #54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) #53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) #55234 PR-URL: #55343

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) #55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) #54159 doc: * add abmusse to collaborators (Abdirahim Musse) #55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) #54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) #54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) #54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) #54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) #54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) #54971 process: * (SEMVER-MINOR) add `process.features.require_module` (Joyee Cheung) #55241 * (SEMVER-MINOR) add `process.features.typescript` (Aviv Keller) #54295 src: * mark `node --run` as stable (Yagiz Nizipli) #53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) #55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) #54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) #53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) #55234 PR-URL: #55343

External modules need a way to decorate their objects so that node can recognize it as a host object for serialization process. Exposing a way for turning off instead of turning on is much safer. PR-URL: nodejs#55234 Refs: nodejs#55178 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Daeyeon Jeong <[email protected]> Reviewed-By: Matthew Aitken <[email protected]>

Notable changes: crypto: * (SEMVER-MINOR) add `KeyObject.prototype.toCryptoKey` (Filip Skokan) nodejs#55262 * (SEMVER-MINOR) add Date fields for `validTo` and `validFrom` (Andrew Moon) nodejs#54159 doc: * add abmusse to collaborators (Abdirahim Musse) nodejs#55086 http2: * (SEMVER-MINOR) expose `nghttp2_option_set_stream_reset_rate_limit` as an option (Maël Nison) nodejs#54875 lib: * (SEMVER-MINOR) propagate aborted state to dependent signals before firing events (jazelly) nodejs#54826 module: * (SEMVER-MINOR) support loading entrypoint as url (RedYetiDev) nodejs#54933 * (SEMVER-MINOR) implement the `"module-sync"` exports condition (Joyee Cheung) nodejs#54648 * (SEMVER-MINOR) implement `flushCompileCache()` (Joyee Cheung) nodejs#54971 * (SEMVER-MINOR) throw when invalid argument is passed to `enableCompileCache()` (Joyee Cheung) nodejs#54971 * (SEMVER-MINOR) write compile cache to temporary file and then rename it (Joyee Cheung) nodejs#54971 process: * (SEMVER-MINOR) add `process.features.require_module` (Joyee Cheung) nodejs#55241 * (SEMVER-MINOR) add `process.features.typescript` (Aviv Keller) nodejs#54295 src: * mark `node --run` as stable (Yagiz Nizipli) nodejs#53763 test_runner: * (SEMVER-MINOR) support custom arguments in `run()` (Aviv Keller) nodejs#55126 * (SEMVER-MINOR) add `'test:summary'` event (Colin Ihrig) nodejs#54851 * (SEMVER-MINOR) add support for coverage via `run()` (Chemi Atlow) nodejs#53937 worker: * (SEMVER-MINOR) add `markAsUncloneable` api (Jason Zhang) nodejs#55234 PR-URL: nodejs#55343

nodejs-github-bot added needs-ci PRs that need a full CI run. worker Issues and PRs related to Worker support. labels Oct 2, 2024

jazelly changed the title ~~expose uncloneable api~~ worker: expose markAsUncloneable api Oct 2, 2024

jazelly force-pushed the expose-uncloneable-api branch 2 times, most recently from f5c09ee to c4fbe5d Compare October 2, 2024 07:09

jazelly commented Oct 2, 2024

View reviewed changes

jazelly force-pushed the expose-uncloneable-api branch from c4fbe5d to fddddad Compare October 2, 2024 07:11

RedYetiDev added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 2, 2024

RedYetiDev reviewed Oct 2, 2024

View reviewed changes

jakecastelli reviewed Oct 2, 2024

View reviewed changes

legendecas approved these changes Oct 3, 2024

View reviewed changes

legendecas added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 3, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 3, 2024

worker: add markAsUncloneable api

622ca5e

External modules need a way to decorate their objects so that node can recognize it as a host object for serialization process. Exposing a way for turning off instead of turning on is much safer.

jazelly force-pushed the expose-uncloneable-api branch from 7787af4 to 622ca5e Compare October 3, 2024 11:46

jazelly changed the title ~~worker: expose markAsUncloneable api~~ worker: add markAsUncloneable api Oct 3, 2024

jakecastelli added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 3, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 3, 2024

daeyeon approved these changes Oct 3, 2024

View reviewed changes

daeyeon added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 3, 2024

KhafraDev approved these changes Oct 3, 2024

View reviewed changes

KhafraDev added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 3, 2024

jazelly mentioned this pull request Oct 4, 2024

structuredClone Serializing a non-serializable platform object succeeds #55120

Closed

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 4, 2024

nodejs-github-bot merged commit d2ad9b4 into nodejs:main Oct 4, 2024
63 checks passed

jazelly deleted the expose-uncloneable-api branch October 4, 2024 08:10

aduh95 mentioned this pull request Oct 9, 2024

V22.10.0 proposal #55343

Merged

jazelly mentioned this pull request Oct 10, 2024

web: mark as uncloneable when possible nodejs/undici#3709

Merged

7 tasks

RafaelGSS mentioned this pull request Oct 11, 2024

2024-10-16, Version 23.0.0 (Current) #55338

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

worker: add `markAsUncloneable` api #55234

worker: add `markAsUncloneable` api #55234

jazelly commented Oct 2, 2024 •

edited

Loading

jazelly Oct 2, 2024 •

edited

Loading

jazelly commented Oct 2, 2024

codecov bot commented Oct 2, 2024 •

edited

Loading

jakecastelli left a comment

nodejs-github-bot commented Oct 3, 2024

nodejs-github-bot commented Oct 3, 2024

nodejs-github-bot commented Oct 4, 2024

worker: add markAsUncloneable api #55234

worker: add markAsUncloneable api #55234

Conversation

jazelly commented Oct 2, 2024 • edited Loading

jazelly Oct 2, 2024 • edited Loading

Choose a reason for hiding this comment

jazelly commented Oct 2, 2024

codecov bot commented Oct 2, 2024 • edited Loading

Codecov Report

jakecastelli left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Oct 3, 2024

nodejs-github-bot commented Oct 3, 2024

nodejs-github-bot commented Oct 4, 2024

worker: add `markAsUncloneable` api #55234

worker: add `markAsUncloneable` api #55234

jazelly commented Oct 2, 2024 •

edited

Loading

jazelly Oct 2, 2024 •

edited

Loading

codecov bot commented Oct 2, 2024 •

edited

Loading