Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

net: check and throw on error for getsockname #12871

Closed
wants to merge 4 commits into from

Conversation

danbev
Copy link
Contributor

@danbev danbev commented May 6, 2017

This commit attempts fix a TODO in net.js:
TODO(bnoordhuis) Check err and throw?

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

lib

@nodejs-github-bot nodejs-github-bot added the net Issues and PRs related to the net subsystem. label May 6, 2017
@danbev
Copy link
Contributor Author

danbev commented May 6, 2017

@refack
Copy link
Contributor

refack commented May 6, 2017

Does this have semver significance? It was a "safe" method, now it might throw?

// TODO(bnoordhuis) Check err and throw?
var err = this._handle.getsockname(out);
if (err) {
throw errnoException(err, 'address');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe

if (err) {
  self.emit('error', errnoException(err, 'address'));
  return;
}

Copy link
Contributor

@refack refack May 6, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@addaleax won't throwing make this semver-major?
Ohh just saw you marked it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that’s why I’ve labelled it as a major. ;) But emitting an error event a) would be semver-major too and b) doesn’t really make sense here, it’s a fully synchronous call.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I agree.

Copy link
Contributor

@refack refack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway need to add a test for this.

@danbev
Copy link
Contributor Author

danbev commented May 6, 2017

@addaleax addaleax added the semver-major PRs that contain breaking changes and should be released in the next major version. label May 6, 2017
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but I am afraid you might need to tweak the error regexp in the test a bit more to work cross-platform ;)

@danbev
Copy link
Contributor Author

danbev commented May 6, 2017

Looks good, but I am afraid you might need to tweak the error regexp in the test a bit more to work cross-platform ;)

I guess I'll find out shortly about that 😄

@refack
Copy link
Contributor

refack commented May 6, 2017

@refack
Copy link
Contributor

refack commented May 6, 2017

@danbev Windows error is Error: address Unknown system error -1 so you need /^Error: address ([\w \-\d]+)$/
or do an if (common.isWindows) {

Copy link
Contributor

@evanlucas evanlucas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the benefits outweigh the cons on this one. I feel like this is a subtle change that could take down processes. I'm leaning towards -1 on this.

@addaleax
Copy link
Member

addaleax commented May 6, 2017

@evanlucas Going through the errors that getsockname(2) can return according to my manpage copy:

EBADF The argument sockfd is not a valid file descriptor.
ENOTSOCK The file descriptor sockfd does not refer to a socket.

These would point to a bug in Node, I say throwing an error is okay.

EFAULT The addr argument points to memory not in a valid part of the process address space.
EINVAL addrlen is invalid (e.g., is negative).

These won’t happen/also would point to a serious bug in Node. Should definitely make some noise.

ENOBUFS Insufficient resources were available in the system to perform the operation.

Again, this probably never happens. Also, throwing seems better than returning invalid data here.

→ I think it’s safe to do this.

@mscdex
Copy link
Contributor

mscdex commented May 6, 2017

The subsystem in the commit message should be net: instead of lib:

@danbev
Copy link
Contributor Author

danbev commented May 7, 2017

@danbev Windows error is Error: address Unknown system error -1 so you need /^Error: address ([\w -\d]+)$/
or do an if (common.isWindows) {

Thanks, updated now and I'll give CI another go.

@danbev
Copy link
Contributor Author

danbev commented May 7, 2017

The subsystem in the commit message should be net: instead of lib:

Ah, let me fix that. thanks

@danbev danbev changed the title lib: check and throw on error for getsockname net: check and throw on error for getsockname May 7, 2017
@danbev danbev force-pushed the handle-error-net.js branch from 4a17e17 to 1d1bd12 Compare May 7, 2017 08:03
@danbev
Copy link
Contributor Author

danbev commented May 7, 2017

@danbev
Copy link
Contributor Author

danbev commented May 8, 2017

@evanlucas Just wanted to ask if you are still leaning towards a -1 on this?

@evanlucas
Copy link
Contributor

@addaleax thanks for the info. No objections from me :] Thanks!

@danbev nope

@danbev
Copy link
Contributor Author

danbev commented May 9, 2017

@evanlucas Great, thanks!

danbev added a commit to danbev/node that referenced this pull request May 9, 2017
This commit attempts fix a TODO in net.js:
TODO(bnoordhuis) Check err and throw?

PR-URL: nodejs#12871
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@danbev
Copy link
Contributor Author

danbev commented May 9, 2017

Landed in cf980b0

@danbev danbev closed this May 9, 2017
@danbev danbev deleted the handle-error-net.js branch May 9, 2017 10:40
anchnk pushed a commit to anchnk/node that referenced this pull request May 19, 2017
This commit attempts fix a TODO in net.js:
TODO(bnoordhuis) Check err and throw?

PR-URL: nodejs#12871
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@jasnell jasnell mentioned this pull request May 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
net Issues and PRs related to the net subsystem. semver-major PRs that contain breaking changes and should be released in the next major version.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants