dgram: add source-specific multicast support #15735

LPardue · 2017-10-02T14:13:17Z

This adds RFC 4607 support for IPv4 and IPv6. I'm opening this PR to start a discussion, it is not fully realised yet.

This changeset depends on libuv PR 964 and preempts that change being merged into node deps (i.e. it won't compile against master at the time of writing).

In approaching this change I considered modify the existing addMembership/dropMembership functions with a new sourceAddress parameter vs. adding addSourceSpecificMembership/dropSourceSpecificMembership. Both have merits but I picked the latter, I'm not stuck on it though. It comes does to opinion on which looks worse: socket.addMembership(232.1.1.1, null, 123.45.67.89) or socket.addSourceSpecificMembership(123.45.67.89, 232.1.1.1).

I've tested this manually on a local network but don't currently have any tests defined. I'm not sure what node is looking for in that respect, testing source-specific multicast is hairy.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

dgram

doc/api/dgram.md

lib/dgram.js

jasnell · 2017-10-02T15:34:39Z

Good to see this and thank you for the PR! First scan through looks good!

cjihrig

Looking mostly good. Left some comments.

doc/api/dgram.md

lib/dgram.js

src/udp_wrap.cc

LPardue · 2017-10-03T22:54:29Z

Thanks for the comments. I'll address them soon. One observation is that this is pretty much a copy/paste job based on the existing functions. I.e. the existing code probably also suffers from the issues raised. Would you like me to reflect back changes to the existing functions?

mcollina · 2017-10-07T16:10:35Z

I'm a bit uncomfortable in landing this without tests, I know very well that testing multicast is complicated.

mcollina

LGTM

LPardue · 2017-10-07T16:42:09Z

Thanks for the feedback. Are there any resources for designing tests like this in node? How much of libuv tests (or methodology and test infrastructure) could be reused. This area is all a bit new to me but I completely understand the importance of testing before landing. (edited to fix spelling mistakes)

cjihrig

Left a comment, but otherwise LGTM. Getting through the rest of the libuv PR is one of my plans for the week.

Are there any resources designing tests like this in node?

I'd look in the test subdirectories. The files that start with test-dgram- are a good place to look. You can also take a look at https://github.com/nodejs/node/blob/master/doc/guides/writing-tests.md.

How much of libuv tests (or methodology and test infrastructure) could be reused.

The test machines are the same, and you'll likely be able to take the same approach to both. However, the libuv tests are all C and Node's are JS, so you'll have to port them between languages.

lib/dgram.js

LPardue · 2017-10-10T15:50:34Z

Thanks Colin, I hope to follow this up later in the week.

LPardue · 2017-10-18T18:05:49Z

@cjihrig I've addressed your final review comment about type checking.

@mcollina I've added two tests for source-specific multicast (IPv4 and IPv6). These are near identical to the existing test test-dgram-multicast-multi-process.js test and so provide the same amount of test coverage. The main difference is that they discover a source address to use for the test., localhost doesn't work and will cause the receiver to fail.

test/internet/test-dgram-multicast-ssm-multi-process.js

cjihrig · 2017-10-18T18:18:59Z

@LPardue I went through the libuv PR. It needs updates from the author. I'd like another libuv collaborator to review it as well.

LPardue · 2017-10-18T18:25:05Z

@LPardue I went through the libuv PR. It needs updates from the author. I'd like another libuv collaborator to review it as well.

Indeed, the PR doesn't work on Windows without fixes I suggested there.

test/internet/test-dgram-multicast-ssmv6-multi-process..js

src/udp_wrap.cc

addaleax

Thanks, looks good to me!

doc/api/dgram.md

LPardue · 2017-11-22T15:35:54Z

I think I've addressed review comments. The conflicting file relates to libuv and probably shouldn't be in the PR, I'll try to fix this soon.

This is really stalled on libuv/libuv#964 which is awaiting changes in response to review.

This adds RFC 4607 support for IPv4 and IPv6.

addaleax · 2019-10-16T18:36:38Z

@LPardue I’ve pushed a fix for my comment, included the commit you referenced, and a small fixup to make documentation linting pass (due to relatively new changes to the doc markdown format). I think after that this only requires us to get CI to pass.

nodejs-github-bot · 2019-10-16T18:43:23Z

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

LPardue · 2019-10-16T19:01:51Z

@addaleax thank you! You deserve a 🥇

n-thumann · 2019-10-16T20:36:14Z

I noticed two deprecation warnings, caused by this._healthCheck()and this._handle. I fixed both of them in n-thumann@d265295. Would you mind merging this commit too? :)

`this._healthCheck()`& `this._handle` caused deprecation warnings.

addaleax · 2019-10-16T21:41:42Z

@n-thumann Done! (with linting issues fixed)

nodejs-github-bot · 2019-10-16T21:42:34Z

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

addaleax · 2019-10-17T01:14:09Z

Landed in 1784b7f 🎉 Thanks for the PR, and sorry for all the delays! ✨

This adds RFC 4607 support for IPv4 and IPv6. Co-Authored-By: Nicolas Thumann <[email protected]> Co-Authored-By: Rich Trott <[email protected]> PR-URL: #15735 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>

Notable changes: * cli: * Added a new flag (`--trace-uncaught`) that makes Node.js print the stack trace at the time of throwing uncaught exceptions, rather than at the creation of the `Error` object, if there is any. This is disabled by default because it affects GC behavior. #30025 * crypto * Added `Hash.prototype.copy()` method. It returns a new `Hash` object with its internal state cloned from the original one. #29910 * dgram * Added source-specific multicast support. This adds methods to Datagram sockets to support RFC 4607 (https://tools.ietf.org/html/rfc4607) for IPv4 and IPv6. #15735 * fs * Added a `bufferSize` option to `fs.opendir()`. It allows to control the number of entries that are buffered internally when reading from the directory. #30114 * meta * Added Chengzhong Wu (https://github.com/legendecas) to collaborators. #30115 PR-URL: #30262

This adds RFC 4607 support for IPv4 and IPv6. Co-Authored-By: Nicolas Thumann <[email protected]> Co-Authored-By: Rich Trott <[email protected]> PR-URL: #15735 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Oct 2, 2017

jasnell requested review from mscdex and cjihrig October 2, 2017 15:31

jasnell added wip Issues and PRs that are still a work in progress. semver-minor PRs that contain new features and should be released in the next minor version. labels Oct 2, 2017

jasnell reviewed Oct 2, 2017

View reviewed changes

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

jasnell reviewed Oct 2, 2017

View reviewed changes

lib/dgram.js Outdated Show resolved Hide resolved

jasnell requested a review from mcollina October 2, 2017 15:34

cjihrig reviewed Oct 3, 2017

View reviewed changes

mcollina approved these changes Oct 7, 2017

View reviewed changes

cjihrig reviewed Oct 7, 2017

View reviewed changes

lib/dgram.js Outdated Show resolved Hide resolved

cjihrig reviewed Oct 18, 2017

View reviewed changes

test/internet/test-dgram-multicast-ssm-multi-process.js Outdated Show resolved Hide resolved

jasnell reviewed Oct 18, 2017

View reviewed changes

test/internet/test-dgram-multicast-ssmv6-multi-process..js Outdated Show resolved Hide resolved

jasnell reviewed Oct 18, 2017

View reviewed changes

test/internet/test-dgram-multicast-ssmv6-multi-process..js Outdated Show resolved Hide resolved

LPardue mentioned this pull request Oct 20, 2017

udp: add source-specific multicast support libuv/libuv#964

Closed

addaleax requested changes Oct 22, 2017

View reviewed changes

src/udp_wrap.cc Outdated Show resolved Hide resolved

src/udp_wrap.cc Outdated Show resolved Hide resolved

addaleax approved these changes Oct 25, 2017

View reviewed changes

doc/api/dgram.md Show resolved Hide resolved

jasnell reviewed Oct 25, 2017

View reviewed changes

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

jasnell approved these changes Oct 25, 2017

View reviewed changes

LPardue force-pushed the ssm branch from 7f4a711 to 87f327a Compare December 1, 2017 15:11

Lucas Pardue and others added 8 commits October 16, 2019 20:15

dgram: add source-specific multicast support

2b6b1ac

This adds RFC 4607 support for IPv4 and IPv6.

Update dgram.md

b36f53c

Update test-dgram-multicast-ssm-multi-process.js

6ea4a7b

Update test-dgram-multicast-ssmv6-multi-process.js

94f7449

Update test-dgram-multicast-ssmv6-multi-process.js

f75fd45

Check iface for null, not group_address

f271357

Check iface against nullptr

4392ebf

Fix optional argument format in docs

b049b3a

addaleax force-pushed the ssm branch from 1c51999 to b049b3a Compare October 16, 2019 18:36

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

Fixes two deprecation warnings

888dc05

`this._healthCheck()`& `this._handle` caused deprecation warnings.

addaleax closed this Oct 17, 2019

targos mentioned this pull request Nov 5, 2019

v13.1.0 release proposal #30262

Merged

targos mentioned this pull request Jan 15, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dgram: add source-specific multicast support #15735

dgram: add source-specific multicast support #15735

LPardue commented Oct 2, 2017 •

edited

Loading

jasnell commented Oct 2, 2017

cjihrig left a comment

LPardue commented Oct 3, 2017

mcollina commented Oct 7, 2017

mcollina left a comment

LPardue commented Oct 7, 2017 •

edited

Loading

cjihrig left a comment

LPardue commented Oct 10, 2017

LPardue commented Oct 18, 2017

cjihrig commented Oct 18, 2017

LPardue commented Oct 18, 2017

addaleax left a comment

LPardue commented Nov 22, 2017

addaleax commented Oct 16, 2019

nodejs-github-bot commented Oct 16, 2019

LPardue commented Oct 16, 2019

n-thumann commented Oct 16, 2019

addaleax commented Oct 16, 2019

nodejs-github-bot commented Oct 16, 2019

addaleax commented Oct 17, 2019

dgram: add source-specific multicast support #15735

dgram: add source-specific multicast support #15735

Conversation

LPardue commented Oct 2, 2017 • edited Loading

Checklist

Affected core subsystem(s)

jasnell commented Oct 2, 2017

cjihrig left a comment

Choose a reason for hiding this comment

LPardue commented Oct 3, 2017

mcollina commented Oct 7, 2017

mcollina left a comment

Choose a reason for hiding this comment

LPardue commented Oct 7, 2017 • edited Loading

cjihrig left a comment

Choose a reason for hiding this comment

LPardue commented Oct 10, 2017

LPardue commented Oct 18, 2017

cjihrig commented Oct 18, 2017

LPardue commented Oct 18, 2017

addaleax left a comment

Choose a reason for hiding this comment

LPardue commented Nov 22, 2017

addaleax commented Oct 16, 2019

nodejs-github-bot commented Oct 16, 2019

LPardue commented Oct 16, 2019

n-thumann commented Oct 16, 2019

addaleax commented Oct 16, 2019

nodejs-github-bot commented Oct 16, 2019

addaleax commented Oct 17, 2019

LPardue commented Oct 2, 2017 •

edited

Loading

LPardue commented Oct 7, 2017 •

edited

Loading