Permalink
Browse files

lib, test: fix server.listen error message

Previously the error messages are mostly `[object Object]`
after the options get normalized. Use util.inspect to make
it more useful.

Refactor the listen option test, add precise
error message validation and a few more test cases.

PR-URL: #11693
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
  • Loading branch information...
joyeecheung authored and fhinkel committed Mar 4, 2017
1 parent a9e64a8 commit 47759429578952672ef9d1079412ed56aad77c4d
Showing with 82 additions and 46 deletions.
  1. +1 −1 lib/net.js
  2. +0 −45 test/parallel/test-net-listen-port-option.js
  3. +81 −0 test/parallel/test-net-server-listen-options.js
View
@@ -1416,7 +1416,7 @@ Server.prototype.listen = function() {
return this;
}
throw new Error('Invalid listen argument: ' + options);
throw new Error('Invalid listen argument: ' + util.inspect(options));
};
function lookupAndListen(self, port, address, backlog, exclusive) {

This file was deleted.

Oops, something went wrong.
@@ -0,0 +1,81 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const net = require('net');
const util = require('util');
function close() { this.close(); }
function listenError(literals, ...values) {
let result = literals[0];
for (const [i, value] of values.entries()) {
const str = util.inspect(value);
// Need to escape special characters.
result += str.replace(/[\\^$.*+?()[\]{}|=!<>:-]/g, '\\$&');
result += literals[i + 1];
}
return new RegExp(`Error: Invalid listen argument: ${result}`);
}
{
// Test listen()
net.createServer().listen().on('listening', common.mustCall(close));
// Test listen(cb)
net.createServer().listen(common.mustCall(close));
}
// Test listen(port, cb) and listen({port: port}, cb) combinations
const listenOnPort = [
(port, cb) => net.createServer().listen({port}, cb),
(port, cb) => net.createServer().listen(port, cb)
];
{
const portError = /^RangeError: "port" argument must be >= 0 and < 65536$/;
for (const listen of listenOnPort) {
// Arbitrary unused ports
listen('0', common.mustCall(close));
listen(0, common.mustCall(close));
listen(undefined, common.mustCall(close));
// Test invalid ports
assert.throws(() => listen(-1, common.mustNotCall()), portError);
assert.throws(() => listen(NaN, common.mustNotCall()), portError);
assert.throws(() => listen(123.456, common.mustNotCall()), portError);
assert.throws(() => listen(65536, common.mustNotCall()), portError);
assert.throws(() => listen(1 / 0, common.mustNotCall()), portError);
assert.throws(() => listen(-1 / 0, common.mustNotCall()), portError);
}
// In listen(options, cb), port takes precedence over path
assert.throws(() => {
net.createServer().listen({ port: -1, path: common.PIPE },
common.mustNotCall());
}, portError);
}
{
function shouldFailToListen(options, optionsInMessage) {
// Plain arguments get normalized into an object before
// formatted in message, options objects don't.
if (arguments.length === 1) {
optionsInMessage = options;
}
const block = () => {
net.createServer().listen(options, common.mustNotCall());
};
assert.throws(block, listenError`${optionsInMessage}`,
`expect listen(${util.inspect(options)}) to throw`);
}
shouldFailToListen(null, { port: null });
shouldFailToListen({ port: null });
shouldFailToListen(false, { port: false });
shouldFailToListen({ port: false });
shouldFailToListen(true, { port: true });
shouldFailToListen({ port: true });
// Invalid fd as listen(handle)
shouldFailToListen({ fd: -1 });
// Invalid path in listen(options)
shouldFailToListen({ path: -1 });
// Host without port
shouldFailToListen({ host: 'localhost' });
}

0 comments on commit 4775942

Please sign in to comment.