From c2b540a85c6984286c343a0be5ff20c2da872164 Mon Sep 17 00:00:00 2001 From: Chris Dickinson Date: Thu, 5 Jun 2014 12:42:41 -0700 Subject: [PATCH 1/3] dgram: make send cb act as "error" event handler. This allows users to provide a callback that handles potential errors resulting from a `socket.send` call. The original behavior of emitting the error event on the socket is preserved. Fixes joyent/node#4846. --- lib/dgram.js | 10 +++- .../test-dgram-send-cb-quelches-error.js | 54 +++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 test/simple/test-dgram-send-cb-quelches-error.js diff --git a/lib/dgram.js b/lib/dgram.js index 6ff8cf251386c7..61132efb68d139 100644 --- a/lib/dgram.js +++ b/lib/dgram.js @@ -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); + + return; + } + self.emit('error', ex); } else if (self._handle) { diff --git a/test/simple/test-dgram-send-cb-quelches-error.js b/test/simple/test-dgram-send-cb-quelches-error.js new file mode 100644 index 00000000000000..d5f29f9dafa39f --- /dev/null +++ b/test/simple/test-dgram-send-cb-quelches-error.js @@ -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'); +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); + +function callbackOnly(err) { + assert.ok(err); + socket.once('error', onEvent); + socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', onCallback); +} + +function onEvent(err) { + assert.ok(err); + assert.equal(times, 0); + times++; +} + +function onCallback(err) { + assert.ok(err); + assert.equal(times, 1); + socket.close(); +} From 7794c137227b7be750b15bb4038fa62ffd68a40c Mon Sep 17 00:00:00 2001 From: Chris Dickinson Date: Tue, 24 Jun 2014 14:45:34 -0700 Subject: [PATCH 2/3] docs: document dgram.send callback behavior --- doc/api/dgram.markdown | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/dgram.markdown b/doc/api/dgram.markdown index b659e6b1a97a04..bff0490a29adca 100644 --- a/doc/api/dgram.markdown +++ b/doc/api/dgram.markdown @@ -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 From f9f841810840716fa01b1e3cd890f58dbc362f7b Mon Sep 17 00:00:00 2001 From: Matteo Collina Date: Tue, 26 May 2015 09:17:00 +0200 Subject: [PATCH 3/3] dgram: do not emit error for failed DNS lookups in send() Modifies the dgram send() method to not emit errors when a DNS lookup fails if there is no callback. Given that the same UDP socket can be used to send messages to different hosts, the socket can be reused even if one of those send() fails. This slightly changes the behavior of a stable API, so that it behaves as users would expect to. This is based of @chrisdickinson https://github.com/joyent/node/pull/7738. Discussion in https://github.com/joyent/node/issues/4846. --- lib/dgram.js | 6 +-- .../test-dgram-send-cb-quelches-error.js | 37 +++++++++++++ .../test-dgram-send-cb-quelches-error.js | 54 ------------------- 3 files changed, 38 insertions(+), 59 deletions(-) create mode 100644 test/internet/test-dgram-send-cb-quelches-error.js delete mode 100644 test/simple/test-dgram-send-cb-quelches-error.js diff --git a/lib/dgram.js b/lib/dgram.js index c3a2c004b86867..681de91d4e04b9 100644 --- a/lib/dgram.js +++ b/lib/dgram.js @@ -299,12 +299,8 @@ Socket.prototype.send = function(buffer, self._handle.lookup(address, function(ex, ip) { if (ex) { - if (callback) { + if (typeof callback === 'function') { callback(ex); - - if (self.listeners('error').length) - self.emit('error', ex); - return; } diff --git a/test/internet/test-dgram-send-cb-quelches-error.js b/test/internet/test-dgram-send-cb-quelches-error.js new file mode 100644 index 00000000000000..e89306b2c29aa2 --- /dev/null +++ b/test/internet/test-dgram-send-cb-quelches-error.js @@ -0,0 +1,37 @@ +'use strict'; +var common = require('../common'); +var mustCall = common.mustCall; +var assert = require('assert'); +var dgram = require('dgram'); +var dns = require('dns'); + +var socket = dgram.createSocket('udp4'); +var buffer = new Buffer('gary busey'); + +dns.setServers([]); + +socket.once('error', onEvent); + +// assert that: +// * callbacks act as "error" listeners if given. +// * error is never emitter for missing dns entries +// if a callback that handles error is present +// * error is emitted if a callback with no argument is passed +socket.send(buffer, 0, buffer.length, 100, + 'dne.example.com', mustCall(callbackOnly)); + +function callbackOnly(err) { + assert.ok(err); + socket.removeListener('error', onEvent); + socket.on('error', mustCall(onError)); + socket.send(buffer, 0, buffer.length, 100, 'dne.example.com'); +} + +function onEvent(err) { + assert.fail('Error should not be emitted if there is callback'); +} + +function onError(err) { + assert.ok(err); + socket.close(); +} diff --git a/test/simple/test-dgram-send-cb-quelches-error.js b/test/simple/test-dgram-send-cb-quelches-error.js deleted file mode 100644 index d5f29f9dafa39f..00000000000000 --- a/test/simple/test-dgram-send-cb-quelches-error.js +++ /dev/null @@ -1,54 +0,0 @@ -// 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'); -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); - -function callbackOnly(err) { - assert.ok(err); - socket.once('error', onEvent); - socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', onCallback); -} - -function onEvent(err) { - assert.ok(err); - assert.equal(times, 0); - times++; -} - -function onCallback(err) { - assert.ok(err); - assert.equal(times, 1); - socket.close(); -}