Merge pull request #10 from NGPVAN/devops/DO-5053-allow-additional-pr…

…operties-on-connection

DO-5053 allow additional properties on connection

README.md

@@ -118,6 +118,21 @@ if (sent.ok) {
 }
 ```
 
+#### Expanded options
+
+amqp.channel supports two parameters meant to modify connection options passed on to amqplib.
+
+The first is an object called `socketOptions` is the equivalent to the same named property on the 
+[channel#connect method](http://www.squaremobius.net/amqp.node/channel_api.html#connect). 
+
+The second is called `defaultServernameToHostname`. This property is meant to signal that the servername property on the
+socketoptions should be defaulted to the hostname from the url passed in. This is meant to simplify correctly configuring
+connections over TLS for SNI. See the following for more details:
+
+https://github.com/nodejs/node/issues/28167#issuecomment-500779815
+https://github.com/squaremo/amqp.node/issues/331
+
+
 ## Real World Example
 
 Say you wanted to listen to the `'foo'` exchange and send a different message to the `'bar'` queue every time the message's `baz` property contained the word `'qux'`.

channel.js

@@ -2,13 +2,24 @@ var noop = function(){},
     util = require('util'),
     amqp = require('amqplib'),
     Promise = require('bluebird'),
-    simplify = require('./simplify');
+    simplify = require('./simplify'),
+    uriJs = require('uri-js');
 
-module.exports = function createChannel(url, assertions, log){
+module.exports = function createChannel(url, assertions, log, socketOptions, defaultServernameToHostname){
   assertions = assertions || {};
   log = log || { info: noop, warn: noop, error: noop };
+  socketOptions = socketOptions || {};
 
-  return amqp.connect(url).then(openChannel);
+  //SNI for TLS requires the servername be specified, see:
+  //https://github.com/nodejs/node/issues/28167#issuecomment-500779815
+  //https://github.com/squaremo/amqp.node/issues/331
+  //This implements the default parsing everyone expects without breaking the api
+  if (defaultServernameToHostname) {
+    var host = uriJs.parse(url).host;
+    socketOptions.servername = host;
+  }
+
+  return amqp.connect(url, socketOptions).then(openChannel);
 
   function openChannel(connection) {
     var amqp = require('url').parse(url);

package.json

@@ -5,7 +5,8 @@
   "main": "channel.js",
   "dependencies": {
     "amqplib": "^0.3.2",
-    "bluebird": "^2.9.24"
+    "bluebird": "^2.9.24",
+    "uri-js": "^4.2.2"
   },
   "devDependencies": {
     "chai": "^2.2.0",
@@ -21,7 +22,7 @@
     "sinon-chai": "^2.7.0"
   },
   "scripts": {
-    "test": "mocha test",
+    "test": "node ./node_modules/mocha/bin/mocha test",
     "test-cov": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
     "coverage": "istanbul cover _mocha test --recursive -- -u exports -R spec && open coverage/lcov-report/amqp.channel/index.html"
   },

test/test.channel.js

@@ -73,7 +73,7 @@ describe('Channel', function() {
 
     it('should connect to the correct RabbitMQ URL', function(){
       expect(connect).to.have.been.calledOnce
-        .and.to.have.been.calledWithExactly(amqpUrl);
+        .and.to.have.been.calledWithExactly(amqpUrl, {});
     });
 
     it('should create a Channel on the Connection', function(){
@@ -112,7 +112,7 @@ describe('Channel', function() {
 
     it('should connect to the correct RabbitMQ URL', function(){
       expect(connect).to.have.been.calledOnce
-        .and.to.have.been.calledWithExactly(amqpUrl);
+        .and.to.have.been.calledWithExactly(amqpUrl, {});
     });
 
     it('should create a Channel on the Connection', function(){