lib: replace MessageEvent with undici's #52370

KhafraDev · 2024-04-04T15:52:25Z

undici's MessageEvent is better tested and has a complete WebIDL
implementation for validation. Not only this, but it's also used in
Node's current WebSocket implementation. There are a large number of
webidl-related issues in the current MessageEvent, such as not
implementing MessageEvent.prototype.initMessageEvent, not validating
arguments passed to its constructor
(#51771), not validating the values
passed to the constructor (such as not validating that ports is a
sequence, not converting origin to a USVString, etc.), and other issues.

nodejs-github-bot · 2024-04-04T15:52:31Z

Review requested:

@nodejs/startup
@nodejs/web-standards

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (nodejs#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup

lpinca · 2024-04-04T19:07:51Z

Have you considered the other way around? Fixing it in Node.js and reusing it in undici? Is it harder to port tests here?

KhafraDev · 2024-04-04T21:11:46Z

It is significantly harder to implement here without a real webidl implementation.

anonrig · 2024-04-05T15:40:21Z

test/parallel/test-worker-message-event.js

  });
  assert.throws(() => {
    new MessageEvent('message', { source: {} });
  }, {
-    code: 'ERR_INVALID_ARG_TYPE',
-    message: /The "init\.source" property must be an instance of MessagePort/,
+    name: 'TypeError',


Since we are changing error code this becomes a semver-major

@KhafraDev it would be better if this PR wouldn't be semver-major, so we can land it in v22.

benjamingr

I recall @addaleax did a lot of work optimizing Node's message event for workers, so pleasae run the MessageEvent benchmarks before landing this.

KhafraDev · 2024-04-06T15:26:19Z

MessageEvent should be compatible with the spec if it's marked as a compliant version of MessageEvent.

KhafraDev · 2024-04-26T00:32:52Z

I'd like to move this forward if possible, especially now that WebSocket is a global in node. I have no intention on supporting Node's current "MessageEvent" in WebSocket so it seems like we're in a standstill here.

I would be willing to expose a utility function to create an undici MessageEvent that skips webidl validations, which should yield the same performance as it is currently. Is that an acceptable solution here? Inevitably, as it is right now, undici cannot beat the current MessageEvent's performance, because node's MessageEvent does nothing correct, spec-wise.

KhafraDev · 2024-04-26T00:51:00Z

@benjamingr I experimented with this and I was able to make instantiating an undici MessageEvent over 3x faster than the current node one.

https://github.com/nodejs/undici/compare/main...KhafraDev:undici:fast-messageevent?expand=1

cpu: Intel(R) Core(TM) i7-9700K CPU @ 3.60GHz
runtime: node v22.0.0 (x64-win32)

benchmark                            time (avg)             (min … max)       p75       p99      p999
----------------------------------------------------------------------- -----------------------------
• MessageEvent instantiation
----------------------------------------------------------------------- -----------------------------
undici - fast MessageEvent init   68.87 ns/iter     (57.23 ns … 493 ns)   81.1 ns    108 ns    228 ns
undici - MessageEvent init          824 ns/iter     (770 ns … 1'274 ns)    829 ns  1'090 ns  1'274 ns
global - MessageEvent init          222 ns/iter       (203 ns … 631 ns)    234 ns    268 ns    493 ns

summary for MessageEvent instantiation
  undici - fast MessageEvent init
   3.23x faster than global - MessageEvent init
   11.97x faster than undici - MessageEvent init

mcollina

lgtm

mcollina · 2024-04-26T13:13:26Z

The only concern I have is that undici can be not always available, therefore blocking something else entirely.

benjamingr · 2024-04-26T15:31:48Z

I pinged @addaleax 3 weeks ago, that seems plenty of time to respond and worst case we can always revisit things.

responsiveness

benjamingr · 2024-04-26T15:34:26Z

For future reference @KhafraDev our process allows people to dismiss requests for feedback/changes after 7 days of unresponsiveness. I wanted Anna to be able to say her piece but that's not an excuse for me blocking a PR and neither was it my intention.

KhafraDev · 2024-04-26T15:43:09Z

You brought up a valid point and it'll lead to faster MessageEvent creation in node core and undici. I don't think that outright dismissing a valid review without further discussion would be a good idea, especially since I am not familiar with node workers.

benjamingr · 2024-04-26T17:07:39Z

@KhafraDev absolutely, feedback is important - that's why we wait a week (or more if people ask nicely and explain why) :) In this case it was not my intention to block the change just to try and get feedback.

I recall there is a good reason for the current design but it has been around 4-5 years since and we have tests and benchmarks. Anyway, just wanted to apologize and to make sure you know in the future you're free to dismiss these sort of reviews after a week of no response.

mcollina · 2024-04-27T20:34:59Z

@KhafraDev can you make this non-semver-major?

KhafraDev · 2024-04-28T05:13:09Z

I'll try

KhafraDev · 2024-04-29T05:31:04Z

I don't think it's viable. Errors are all handled uniformly in undici's webidl, so if we change the message in one place every other message will similarly get changed. It makes for much better, more consistent, errors, but doesn't give us much room to use custom messages.

I did add error codes for brand checks and I am gradually improving the existing errors, but I don't think we'll be able to match the current ones.

nodejs-github-bot · 2024-04-29T11:05:59Z

Landed in 3136fb0

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup PR-URL: #52370 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (nodejs#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup PR-URL: nodejs#52370 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup PR-URL: #52370 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: TODO

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 * add Marco Ippolito to TSC (Rafael Gonzaga) #53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: #53379

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) #53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) #53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) #53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) #53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) #52762 * add StefanStojanovic to collaborators (StefanStojanovic) #53118 * add Marco Ippolito to TSC (Rafael Gonzaga) #53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) #53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) #51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) #52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) #52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) #53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) #52762 src: * (SEMVER-MINOR) traverse parent folders while running `--run` (Yagiz Nizipli) #53154 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) #53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) #53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) #53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) #52848 PR-URL: #53379

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (nodejs#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup PR-URL: nodejs#52370 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) nodejs#53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) nodejs#53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) nodejs#53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) nodejs#52762 * add StefanStojanovic to collaborators (StefanStojanovic) nodejs#53118 * add Marco Ippolito to TSC (Rafael Gonzaga) nodejs#53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) nodejs#53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) nodejs#51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) nodejs#52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) nodejs#52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) nodejs#53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) nodejs#52762 src: * (SEMVER-MINOR) traverse parent folders while running `--run` (Yagiz Nizipli) nodejs#53154 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) nodejs#53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) nodejs#52848 PR-URL: nodejs#53379

undici's MessageEvent is better tested and has a complete WebIDL implementation for validation. Not only this, but it's also used in Node's current WebSocket implementation. There are a large number of webidl-related issues in the current MessageEvent, such as not implementing `MessageEvent.prototype.initMessageEvent`, not validating arguments passed to its constructor (nodejs#51771), not validating the values passed to the constructor (such as not validating that `ports` is a sequence, not converting origin to a USVString, etc.), and other issues. fixup PR-URL: nodejs#52370 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>

Notable changes: buffer: * (SEMVER-MINOR) add .bytes() method to Blob (Matthew Aitken) nodejs#53221 cli: * (SEMVER-MINOR) add `NODE_RUN_PACKAGE_JSON_PATH` env (Yagiz Nizipli) nodejs#53058 * (SEMVER-MINOR) add `NODE_RUN_SCRIPT_NAME` env to `node --run` (Yagiz Nizipli) nodejs#53032 doc: * (SEMVER-MINOR) add context.assert docs (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) improve explanation about built-in modules (Joyee Cheung) nodejs#52762 * add StefanStojanovic to collaborators (StefanStojanovic) nodejs#53118 * add Marco Ippolito to TSC (Rafael Gonzaga) nodejs#53008 fs: * mark recursive cp methods as stable (Théo LUDWIG) nodejs#53127 lib: * (SEMVER-MINOR) add EventSource Client (Aras Abbasi) nodejs#51575 * (SEMVER-MINOR) replace MessageEvent with undici's (Matthew Aitken) nodejs#52370 module: * (SEMVER-MINOR) print amount of load time of a cjs module (Vinicius Lourenço) nodejs#52213 net: * (SEMVER-MINOR) add new net.server.listen tracing channel (Paolo Insogna) nodejs#53136 process: * (SEMVER-MINOR) add process.getBuiltinModule(id) (Joyee Cheung) nodejs#52762 src: * (SEMVER-MINOR) traverse parent folders while running `--run` (Yagiz Nizipli) nodejs#53154 src,permission: * (SEMVER-MINOR) --allow-wasi & prevent WASI exec (Rafael Gonzaga) nodejs#53124 test_runner: * (SEMVER-MINOR) add snapshot testing (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) add context.fullName (Colin Ihrig) nodejs#53169 * (SEMVER-MINOR) support module mocking (Colin Ihrig) nodejs#52848 PR-URL: nodejs#53379

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. worker Issues and PRs related to Worker support. labels Apr 4, 2024

KhafraDev force-pushed the replace-messageevent branch from b4ed037 to f126982 Compare April 4, 2024 15:57

anonrig approved these changes Apr 5, 2024

View reviewed changes

anonrig added the semver-major PRs that contain breaking changes and should be released in the next major version. label Apr 5, 2024

benjamingr previously requested changes Apr 6, 2024

View reviewed changes

anonrig added the needs-benchmark-ci PR that need a benchmark CI run. label Apr 10, 2024

mcollina approved these changes Apr 26, 2024

View reviewed changes

mcollina added the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Apr 26, 2024

KhafraDev mentioned this pull request Apr 26, 2024

create fast MessageEvent nodejs/undici#3170

Merged

jasnell approved these changes Apr 27, 2024

View reviewed changes

mcollina added tsc-agenda Issues and PRs to discuss during the meetings of the TSC. and removed tsc-agenda Issues and PRs to discuss during the meetings of the TSC. labels Apr 29, 2024

ronag approved these changes Apr 29, 2024

View reviewed changes

mcollina added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 29, 2024

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

nodejs-github-bot merged commit 3136fb0 into nodejs:main Apr 29, 2024
68 checks passed

KhafraDev deleted the replace-messageevent branch April 29, 2024 13:45

targos added semver-major PRs that contain breaking changes and should be released in the next major version. and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels May 8, 2024

KhafraDev mentioned this pull request May 12, 2024

lib: speed up MessageEvent creation internally #52951

Merged

This was referenced May 14, 2024

v22.2.0 release proposal #52971

Merged

Node.js Technical Steering Committee (TSC) Meeting 2024-05-15 nodejs/TSC#1555

Closed

mcollina mentioned this pull request May 15, 2024

Backport undici MessageEvent to v20. #53009

Closed

targos removed the semver-major PRs that contain breaking changes and should be released in the next major version. label Jun 1, 2024

RafaelGSS mentioned this pull request Jun 7, 2024

v22.3.0 proposal #53379

Merged

appurva21 mentioned this pull request Aug 20, 2024

Switch to node style listener to avoid using undici's (node dep) MessageEvent class postmanlabs/uvm#704

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: replace MessageEvent with undici's #52370

lib: replace MessageEvent with undici's #52370

KhafraDev commented Apr 4, 2024

nodejs-github-bot commented Apr 4, 2024

lpinca commented Apr 4, 2024

KhafraDev commented Apr 4, 2024 •

edited

Loading

anonrig Apr 5, 2024

mcollina Apr 26, 2024

benjamingr left a comment

KhafraDev commented Apr 6, 2024

KhafraDev commented Apr 26, 2024 •

edited

Loading

KhafraDev commented Apr 26, 2024

mcollina left a comment

mcollina commented Apr 26, 2024

benjamingr commented Apr 26, 2024

benjamingr commented Apr 26, 2024

KhafraDev commented Apr 26, 2024

benjamingr commented Apr 26, 2024

mcollina commented Apr 27, 2024

KhafraDev commented Apr 28, 2024

KhafraDev commented Apr 29, 2024 •

edited

Loading

nodejs-github-bot commented Apr 29, 2024

lib: replace MessageEvent with undici's #52370

lib: replace MessageEvent with undici's #52370

Conversation

KhafraDev commented Apr 4, 2024

nodejs-github-bot commented Apr 4, 2024

lpinca commented Apr 4, 2024

KhafraDev commented Apr 4, 2024 • edited Loading

anonrig Apr 5, 2024

Choose a reason for hiding this comment

mcollina Apr 26, 2024

Choose a reason for hiding this comment

benjamingr left a comment

Choose a reason for hiding this comment

KhafraDev commented Apr 6, 2024

KhafraDev commented Apr 26, 2024 • edited Loading

KhafraDev commented Apr 26, 2024

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented Apr 26, 2024

benjamingr commented Apr 26, 2024

benjamingr commented Apr 26, 2024

KhafraDev commented Apr 26, 2024

benjamingr commented Apr 26, 2024

mcollina commented Apr 27, 2024

KhafraDev commented Apr 28, 2024

KhafraDev commented Apr 29, 2024 • edited Loading

nodejs-github-bot commented Apr 29, 2024

KhafraDev commented Apr 4, 2024 •

edited

Loading

KhafraDev commented Apr 26, 2024 •

edited

Loading

KhafraDev commented Apr 29, 2024 •

edited

Loading