Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

dgram: make .send cb act as an "error" event handler. #7738

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/api/dgram.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,9 @@ assigned a random port number and is bound to the "all interfaces" address
An optional callback may be specified to detect DNS errors or for determining
when it's safe to reuse the `buf` object. Note that DNS lookups delay the time
to send for at least one tick. The only way to know for sure that the datagram
has been sent is by using a callback.
has been sent is by using a callback. If an error occurs and a callback is given,
the error will be the first argument to the callback. If a callback is not given,
the error is emitted as an `'error'` event on the `socket` object.

With consideration for multi-byte characters, `offset` and `length` will
be calculated with respect to
Expand Down
10 changes: 9 additions & 1 deletion lib/dgram.js
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,15 @@ Socket.prototype.send = function(buffer,

self._handle.lookup(address, function(ex, ip) {
if (ex) {
if (callback) callback(ex);
if (callback) {
callback(ex);

if (self.listeners('error').length)
self.emit('error', ex);

Choose a reason for hiding this comment

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

Isn't this redundant, can't we just rely upon the return value from self.emit to determine if this was handled?

Copy link
Author

Choose a reason for hiding this comment

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

If we emit and there's no error listener, the error will be thrown. This check explicitly prevents that if there's a callback.

Choose a reason for hiding this comment

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

right -- that part of the api -- sigh sorry


return;
}

self.emit('error', ex);
}
else if (self._handle) {
Expand Down
54 changes: 54 additions & 0 deletions test/simple/test-dgram-send-cb-quelches-error.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var common = require('../common');
Copy link
Member

Choose a reason for hiding this comment

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

Missing license boilerplate.

var assert = require('assert');
var dgram = require('dgram');
var dns = require('dns');

var socket = dgram.createSocket('udp4');
var buffer = new Buffer('gary busey');
var times = 0;

dns.setServers([]);

// assert that:
// * callbacks act as "error" listeners if given.
// * callbacks and error events are emitted in a certain order.
socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', callbackOnly);
Copy link
Member

Choose a reason for hiding this comment

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

Is the assumption that the DNS lookup will fail? It's kind of difficult to do that portably, some people are on networks where domain names always resolve to something. Grep through the logs for test/, we've repeatedly had to fix tests that made similar assumptions.

Copy link
Author

Choose a reason for hiding this comment

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

Hm, yes -- the lookup for dne.example.com is expected to fail. Would adding dns.setServers([]); before the lookup accomplish that reliably?


function callbackOnly(err) {
assert.ok(err);
socket.once('error', onEvent);
socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', onCallback);
}
Copy link
Member

Choose a reason for hiding this comment

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

Minor style issue: gratuitous blank lines.. Core tends to prefer dense code.


function onEvent(err) {
assert.ok(err);
assert.equal(times, 0);
times++;
}

function onCallback(err) {
assert.ok(err);
assert.equal(times, 1);
socket.close();
}
Copy link
Member

Choose a reason for hiding this comment

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

The eventOrder and callbackOrder state machine-y approach looks like it could be simplified somewhat. You're expecting one to come before the other, right? Just check in-place that order === whatever the expected value is at that time.

Copy link
Member

Choose a reason for hiding this comment

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

I think you can drop this function and just call socket.close() from onCallback?

Copy link
Author

Choose a reason for hiding this comment

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

Yep! Fixed.