worker: add typechecking for postMessage transfer list #28033
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If the transfer list argument is present, it should be an array. This commit adds typechecking to that effect. This aligns behaviour with browsers.
Trott
reviewed
Jun 2, 2019
lpinca
approved these changes
Jun 2, 2019
cjihrig
approved these changes
Jun 2, 2019
TimothyGu
reviewed
Jun 3, 2019
src/node_messaging.cc
Outdated
| if (!args[1]->IsNullOrUndefined() && !args[1]->IsObject()) { | ||
| // Browsers also do not throw on `null` or objects, although it really | ||
| // should be an array or undefined, thus the mismatch between the checks | ||
| // above and the actual error message. |
There was a problem hiding this comment.
The reason for this is due to the fact that browsers have an overload that accepts an option bag in addition to just a transfer list. See https://html.spec.whatwg.org/multipage/web-messaging.html#messageport. How browsers resolve the overloading is roughly something like this
- If second arg is undefined or null then ignore.
- If second arg is not an object (i.e., also not a function), then throw.
- Try to get the Symbol.iterator property of the second arg.
- If that throws, then rethrow the exception.
- If that returns anything other than undefined or function, also throw an exception.
- If it returns a function, then treat this as an iterable and use the equivalent of Array.from to convert it to a list.
- Otherwise (it returns undefined), then treat the second arg as an option bag. Try to get the transferList property and then convert it to a list through something like Array.from if present.
There was a problem hiding this comment.
@TimothyGu I’m adding a TODO comment in this PR and merge this with the current state, if that’s okay with you
There was a problem hiding this comment.
Yeah sure. You might encounter it as we try to pass more WPTs, so hope it'd be helpful.
BridgeAR
approved these changes
Jun 4, 2019
|
Landed in 269c1d6 |
addaleax
added a commit
that referenced
this pull request
Jun 10, 2019
If the transfer list argument is present, it should be an array. This commit adds typechecking to that effect. This aligns behaviour with browsers. PR-URL: #28033 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
BridgeAR
pushed a commit
that referenced
this pull request
Jun 17, 2019
If the transfer list argument is present, it should be an array. This commit adds typechecking to that effect. This aligns behaviour with browsers. PR-URL: #28033 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Merged
3 tasks
addaleax
added a commit
to addaleax/node
that referenced
this pull request
Aug 25, 2019
Allow generic iterables as transfer list arguments, as well as an options object with a `transfer` option, for web compatibility. Refs: nodejs#28033 (comment)
danbev
pushed a commit
that referenced
this pull request
Sep 6, 2019
Allow generic iterables as transfer list arguments, as well as an options object with a `transfer` option, for web compatibility. PR-URL: #29319 Refs: #28033 (comment) Reviewed-By: James M Snell <[email protected]>
targos
pushed a commit
that referenced
this pull request
Sep 20, 2019
Allow generic iterables as transfer list arguments, as well as an options object with a `transfer` option, for web compatibility. PR-URL: #29319 Refs: #28033 (comment) Reviewed-By: James M Snell <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If the transfer list argument is present, it should be an array.
This commit adds typechecking to that effect. This aligns behaviour
with browsers.
I’m also more than happy to label this semver-major.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes