dgram,test: add tests for setBroadcast() #6750

Trott · 2016-05-13T23:00:42Z

Checklist

tests and code linting passes
a test and/or benchmark is included
documentation is changed or added
the commit message follows commit guidelines

Affected core subsystem(s)

dgram test

Description of change

The only tests for setBroadcast() (from the dgram module) were in
test/internet which means they almost never get run. This adds a
minimal test that can check JS-land functionality in test/parallel.

Since I was doing the necessary git spelunking anyway, I took the time
to add the YAML information into the docs about when setBroadcast()
first appeared in its current form.

I also expanded a comment and did some minor formatting on the existing
test/internet test. If there were an easy and reliable way to check
for the BROADCAST flag on an interface, it's possible that a version of
the test could be moved to test/sequential or test/parallel once it
was modified to only use internal networks.

bnoordhuis · 2016-05-16T06:23:44Z

doc/api/dgram.md

@@ -283,6 +283,9 @@ not work because the packet will get silently dropped without informing the
 source that the data did not reach its intended recipient.

 ### socket.setBroadcast(flag)
+<!-- YAML
+added: v0.6.9


I'm fairly sure it goes all the way back to v0.2.0. It was certainly in v0.4.x because I wrote the libuv replacement during the v0.5.x development cycle.

@bnoordhuis I got v0.6.9 from f749338.

In v0.6.8, the function existed, but this was the implementation:

Socket.prototype.setBroadcast = function(arg) { throw new Error('not yet implemented'); };

My interpretation was that the function existed in earlier releases, but went away for a while, and then came back in 0.6.9. Am I mistaken? Was that function never really run and there was a version in dgram_legacy.js or something that was actually the implementation for 0.6.8?

Hm, I suppose it's possible I wrote the libuv code but forgot to hook it up in node... let's pretend this conversation never happened.

bnoordhuis · 2016-05-16T06:24:17Z

LGTM with a comment.

jasnell · 2016-05-16T14:57:51Z

Would prefer the doc change to be in a separate commit. Otherwise LGTM with @bnoordhuis' nit addressed.

Since I was doing the necessary git spelunking anyway, I took the time to add the YAML information into the docs about when `setBroadcast()` first appeared in its current form.

The only tests for `setBroadcast()` (from the `dgram` module) were in `test/internet` which means they almost never get run. This adds a minimal test that can check JS-land functionality in `test/parallel`. I also expanded a comment and did some minor formatting on the existing `test/internet` test. If there were an easy and reliable way to check for the BROADCAST flag on an interface, it's possible that a version of the test could be moved to `test/sequential` or `test/parallel` once it was modified to only use internal networks.

Trott · 2016-05-16T20:35:07Z

Moved the doc change into its own commit per @jasnell.

Trott · 2016-05-16T20:36:42Z

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

jasnell · 2016-05-16T20:53:48Z

Thank you @Trott !

Trott · 2016-05-16T21:29:27Z

Only failure in CI is a Windows build failure. Will wait a short time to land to see if we can get consensus on the YAML comment. If not, I'll remove that commit before landing.

Trott · 2016-05-16T21:49:15Z

Just compiled Node.js v0.6.8 and did this:

$ node -v
v0.6.8
$ node
> var dgram = require('dgram');
undefined
> var foo = dgram.createSocket('udp4');
undefined
> foo.bind();
undefined
> foo.setBroadcast(true);
Error: not yet implemented
    at Socket.setBroadcast (dgram.js:226:9)
    at repl:1:5
    at REPLServer.eval (repl.js:80:21)
    at repl.js:190:20
    at REPLServer.eval (repl.js:87:5)
    at Interface.<anonymous> (repl.js:182:12)
    at Interface.emit (events.js:67:17)
    at Interface._onLine (readline.js:162:10)
    at Interface._line (readline.js:426:8)
    at Interface._ttyWrite (readline.js:603:14)
>

Then did the same with Node.js 0.6.9:

$ node -v
v0.6.9
$ node
> var dgram = require('dgram');
undefined
> var foo = dgram.createSocket('udp4');
undefined
> foo.bind();
undefined
> foo.setBroadcast(true);
undefined
>

This makes me feel comfortable enough to land this with 0.6.9 as the version specified in the YAML comment. So I'm going to go do that now...

Since I was doing the necessary git spelunking anyway, I took the time to add the YAML information into the docs about when `setBroadcast()` first appeared in its current form. PR-URL: nodejs#6750 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>

The only tests for `setBroadcast()` (from the `dgram` module) were in `test/internet` which means they almost never get run. This adds a minimal test that can check JS-land functionality in `test/parallel`. I also expanded a comment and did some minor formatting on the existing `test/internet` test. If there were an easy and reliable way to check for the BROADCAST flag on an interface, it's possible that a version of the test could be moved to `test/sequential` or `test/parallel` once it was modified to only use internal networks. PR-URL: nodejs#6750 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>

Trott · 2016-05-16T21:53:08Z

Landed in 5f31b7e and 78520fa

The only tests for `setBroadcast()` (from the `dgram` module) were in `test/internet` which means they almost never get run. This adds a minimal test that can check JS-land functionality in `test/parallel`. I also expanded a comment and did some minor formatting on the existing `test/internet` test. If there were an easy and reliable way to check for the BROADCAST flag on an interface, it's possible that a version of the test could be moved to `test/sequential` or `test/parallel` once it was modified to only use internal networks. PR-URL: #6750 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>

Since I was doing the necessary git spelunking anyway, I took the time to add the YAML information into the docs about when `setBroadcast()` first appeared in its current form. PR-URL: #6750 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>

Trott added dgram Issues and PRs related to the dgram subsystem / UDP. test Issues and PRs related to the tests. labels May 13, 2016

bnoordhuis reviewed May 16, 2016
View reviewed changes

Trott added 2 commits May 16, 2016 13:22

doc: add added info for dgram.setBroadcast()

799da24

Since I was doing the necessary git spelunking anyway, I took the time to add the YAML information into the docs about when `setBroadcast()` first appeared in its current form.

Trott force-pushed the larry branch from 7f6f728 to 0f5960b Compare May 16, 2016 20:34

Trott closed this May 16, 2016

evanlucas mentioned this pull request May 17, 2016

2016-05-17, Version 6.2.0 (Stable) #6810

Merged

MylesBorins added the dont-land-on-v4.x label Jun 2, 2016

Trott deleted the larry branch January 13, 2022 22:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dgram,test: add tests for setBroadcast() #6750

dgram,test: add tests for setBroadcast() #6750

Trott commented May 13, 2016

bnoordhuis May 16, 2016

Trott May 16, 2016

bnoordhuis May 18, 2016

bnoordhuis commented May 16, 2016

jasnell commented May 16, 2016

Trott commented May 16, 2016

Trott commented May 16, 2016

jasnell commented May 16, 2016

Trott commented May 16, 2016

Trott commented May 16, 2016 •

edited

Loading

Trott commented May 16, 2016

dgram,test: add tests for setBroadcast() #6750

dgram,test: add tests for setBroadcast() #6750

Conversation

Trott commented May 13, 2016

Checklist

Affected core subsystem(s)

Description of change

bnoordhuis May 16, 2016

Choose a reason for hiding this comment

Trott May 16, 2016

Choose a reason for hiding this comment

bnoordhuis May 18, 2016

Choose a reason for hiding this comment

bnoordhuis commented May 16, 2016

jasnell commented May 16, 2016

Trott commented May 16, 2016

Trott commented May 16, 2016

jasnell commented May 16, 2016

Trott commented May 16, 2016

Trott commented May 16, 2016 • edited Loading

Trott commented May 16, 2016

Trott commented May 16, 2016 •

edited

Loading