Merge pull request #103 from Filsh/master

scottinet · web-flow · commit 7a285b38b90e · 2016-09-05T14:29:06.000+02:00
Support secure connection
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 *__note:__ the # at the end of lines are the pull request numbers on GitHub*
 
+# 2.0.2
+
+* https://github.com/kuzzleio/sdk-javascript/releases/tag/2.0.2
+
 # 2.0.0
 
 * https://github.com/kuzzleio/sdk-javascript/releases/tag/2.0.0
diff --git a/dist/kuzzle.js b/dist/kuzzle.js
diff --git a/dist/kuzzle.js.map b/dist/kuzzle.js.map
diff --git a/dist/kuzzle.min.js b/dist/kuzzle.min.js
diff --git a/dist/kuzzle.min.map b/dist/kuzzle.min.map
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {
diff --git a/src/kuzzle.js b/src/kuzzle.js
@@ -119,6 +119,10 @@ module.exports = Kuzzle = function (host, options, cb) {
       value: (options && typeof options.ioPort === 'number') ? options.ioPort : 7512,
       enumerable: true
     },
+    sslConnection: {
+      value: (options && typeof options.sslConnection === 'boolean') ? options.sslConnection : false,
+      enumerable: true
+    },
     autoQueue: {
       value: false,
       enumerable: true,
@@ -311,7 +315,7 @@ Kuzzle.prototype.connect = function () {
   var self = this;
 
   if (!self.network) {
-    self.network = networkWrapper(self.host, self.wsPort, self.ioPort);
+    self.network = networkWrapper(self.host, self.wsPort, self.ioPort, self.sslConnection);
   }
 
   if (['initializing', 'ready', 'disconnected', 'error', 'offline'].indexOf(this.state) === -1) {
@@ -1451,5 +1455,3 @@ Kuzzle.prototype.stopQueuing = function () {
 
   return this;
 };
-
-
diff --git a/src/networkWrapper/index.js b/src/networkWrapper/index.js
@@ -6,22 +6,22 @@
  * @returns {Object} tnstantiated WebSocket/Socket.IO object
  */
 
-function network(host, wsPort, ioPort) {
+function network(host, wsPort, ioPort, sslConnection) {
   // Web browser / NodeJS websocket handling
   if (typeof window !== 'undefined') {
     // use native websockets if the browser supports it
     if (typeof WebSocket !== 'undefined') {
-      return new (require('./wrappers/wsbrowsers'))(host, wsPort);
+      return new (require('./wrappers/wsbrowsers'))(host, wsPort, sslConnection);
     }
     // otherwise fallback to socket.io, if available
     else if (window.io) {
-      return new (require('./wrappers/socketio'))(host, ioPort);
+      return new (require('./wrappers/socketio'))(host, ioPort, sslConnection);
     }
 
     throw new Error('Aborting: no websocket support detected and no socket.io library loaded either.');
   }
 
-  return new (require('./wrappers/wsnode'))(host, wsPort);
+  return new (require('./wrappers/wsnode'))(host, wsPort, sslConnection);
 }
 
 module.exports = network;
diff --git a/src/networkWrapper/wrappers/socketio.js b/src/networkWrapper/wrappers/socketio.js
@@ -1,6 +1,7 @@
-function SocketIO(host, port) {
+function SocketIO(host, port, ssl) {
   this.host = host;
   this.port = port;
+  this.ssl = ssl;
   this.socket = null;
 
   /**
@@ -11,7 +12,7 @@ function SocketIO(host, port) {
    * @param {int} reconnectionDelay
    */
   this.connect = function (autoReconnect, reconnectionDelay) {
-    this.socket = window.io('http://' + this.host + ':' + this.port, {
+    this.socket = window.io((this.ssl ? 'https://' : 'http://') + this.host + ':' + this.port, {
       reconnection: autoReconnect,
       reconnectionDelay: reconnectionDelay,
       forceNew: true
diff --git a/src/networkWrapper/wrappers/wsbrowsers.js b/src/networkWrapper/wrappers/wsbrowsers.js
@@ -1,7 +1,8 @@
-function WSBrowsers(host, port) {
+function WSBrowsers(host, port, ssl) {
   var self = this;
   this.host = host;
   this.port = port;
+  this.ssl = ssl;
   this.client = null;
   this.retrying = false;
 
@@ -28,7 +29,7 @@ function WSBrowsers(host, port) {
    * @returns {Object} Socket
    */
   this.connect = function (autoReconnect, reconnectionDelay) {
-    this.client = new WebSocket('ws://' + this.host + ':' + this.port);
+    this.client = new WebSocket((this.ssl ? 'wss://' : 'ws://') + this.host + ':' + this.port);
 
     this.client.onopen = function () {
       if (self.retrying) {
diff --git a/src/networkWrapper/wrappers/wsnode.js b/src/networkWrapper/wrappers/wsnode.js
@@ -1,10 +1,11 @@
 var
   WebSocket = require('ws');
 
-function WSNode(host, port) {
+function WSNode(host, port, ssl) {
   var self = this;
   this.host = host;
   this.port = port;
+  this.ssl = ssl;
   this.client = null;
   this.retrying = false;
 
@@ -31,7 +32,7 @@ function WSNode(host, port) {
    * @returns {Object} Socket
    */
   this.connect = function (autoReconnect, reconnectionDelay) {
-    this.client = new WebSocket('ws://' + this.host + ':' + this.port, {perMessageDeflate: false});
+    this.client = new WebSocket((this.ssl ? 'wss://' : 'ws://') + this.host + ':' + this.port, {perMessageDeflate: false});
 
     this.client.on('open', function () {
       if (self.retrying) {
diff --git a/test/kuzzle/constructor.test.js b/test/kuzzle/constructor.test.js
@@ -13,7 +13,7 @@ describe('Kuzzle constructor', () => {
     networkStub;
 
   beforeEach(function () {
-    networkStub = sinon.stub(new NetworkWrapper('address', 'port'));
+    networkStub = sinon.stub(new NetworkWrapper('address', 'port', false));
   });
 
   describe('#constructor', function () {
@@ -71,6 +71,7 @@ describe('Kuzzle constructor', () => {
       should(kuzzle).have.propertyWithDescriptor('offlineQueueLoader', { enumerable: true, writable: true, configurable: false });
       should(kuzzle).have.propertyWithDescriptor('wsPort', { enumerable: true, writable: false, configurable: false });
       should(kuzzle).have.propertyWithDescriptor('ioPort', { enumerable: true, writable: false, configurable: false });
+      should(kuzzle).have.propertyWithDescriptor('sslConnection', { enumerable: true, writable: false, configurable: false });
     });
 
     it('should have properties with the documented default values', () => {
@@ -89,6 +90,7 @@ describe('Kuzzle constructor', () => {
       should(kuzzle.defaultIndex).be.undefined();
       should(kuzzle.wsPort).be.exactly(7513);
       should(kuzzle.ioPort).be.exactly(7512);
+      should(kuzzle.sslConnection).be.false();
     });
 
     it('should initialize correctly properties using the "options" argument', () => {
@@ -106,7 +108,8 @@ describe('Kuzzle constructor', () => {
           reconnectionDelay: 666,
           defaultIndex: 'foobar',
           wsPort: 1234,
-          ioPort: 4567
+          ioPort: 4567,
+          sslConnection: true
         },
         kuzzle = new Kuzzle('nowhere', options);
 
@@ -123,6 +126,7 @@ describe('Kuzzle constructor', () => {
       should(kuzzle.reconnectionDelay).be.exactly(options.reconnectionDelay);
       should(kuzzle.wsPort).be.exactly(options.wsPort);
       should(kuzzle.ioPort).be.exactly(options.ioPort);
+      should(kuzzle.sslConnection).be.exactly(options.sslConnection);
     });
 
     it('should handle the offlineMode option properly', () => {
@@ -999,7 +1003,7 @@ describe('Kuzzle constructor', () => {
         kuzzle.query({collection: 'collection', controller: 'controller', action: 'action', index: 'index'}, {});
 
         should(kuzzle.offlineQueue.length).be.exactly(1);
-        should(kuzzle.offlineQueue[0].ts).not.be.undefined().and.be.approximately(now, 100);
+        should(kuzzle.offlineQueue[0].ts).not.be.undefined().and.be.approximately(now, 200);
         should(kuzzle.offlineQueue[0].query.action).be.exactly('action');
         should(kuzzle.offlineQueue[0].query.controller).be.exactly('controller');
         should(kuzzle.offlineQueue[0].query.index).be.exactly('index');
diff --git a/test/network/socketio.test.js b/test/network/socketio.test.js
@@ -17,7 +17,7 @@ describe('SocketIO networking module', () => {
       close: sinon.stub()
     };
 
-    socketIO = new SocketIO('address', 'port');
+    socketIO = new SocketIO('address', 'port', false);
     socketIO.socket = socketStub;
   });
 
@@ -34,6 +34,19 @@ describe('SocketIO networking module', () => {
     window = undefined;
   });
 
+  it('should connect with the secure connection', () => {
+    window = {io: sinon.stub()};
+    socketIO.ssl = true;
+    socketIO.connect('autoReconnectValue', 'reconnectionDelayValue');
+    should(window.io.calledWithMatch('https://address:port', {
+      reconnection: 'autoReconnectValue',
+      reconnectionDelay: 'reconnectionDelayValue',
+      forceNew: true
+    })).be.true();
+
+    window = undefined;
+  });
+
   it('should plug onConnect callbacks to the right event', () => {
     var cb = () => {};
     socketIO.onConnect(cb);
diff --git a/test/network/wsbrowsers.test.js b/test/network/wsbrowsers.test.js
@@ -20,7 +20,7 @@ describe('WebSocket Browsers networking module', () => {
       return clientStub;
     };
 
-    wsbrowsers = new WSBrowsers('address', 'port');
+    wsbrowsers = new WSBrowsers('address', 'port', false);
   });
 
   afterEach(() => {
@@ -37,6 +37,13 @@ describe('WebSocket Browsers networking module', () => {
     should(clientStub.onmessage).not.be.undefined();
   });
 
+  it('should initialize a WS secure connection', () => {
+    clientStub.on = sinon.stub();
+    wsbrowsers.ssl = true;
+    wsbrowsers.connect('autoReconnect', 'reconnectionDelay');
+    should(wsargs).match(['wss://address:port']);
+  });
+
   it('should call listeners on a "open" event', () => {
     var cb = sinon.stub();
 
diff --git a/test/network/wsnode.test.js b/test/network/wsnode.test.js
@@ -37,6 +37,13 @@ describe('WebSocket NodeJS networking module', () => {
     should(clientStub.on.calledWithMatch('message', sinon.match.func)).be.true();
   });
 
+  it('should initialize a WS secure connection', () => {
+    clientStub.on = sinon.stub();
+    wsnode.ssl = true;
+    wsnode.connect('autoReconnect', 'reconnectionDelay');
+    should(wsargs).match(['wss://address:port', {perMessageDeflate: false}]);
+  });
+
   it('should call listeners on a "open" event', () => {
     var cb = sinon.stub();
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "kuzzle-sdk",`
`3`		`- "version": "2.0.1",`
	`3`	`+ "version": "2.0.2",`
`4`	`4`	`"description": "Official Javascript SDK for Kuzzle",`
`5`	`5`	`"author": "The Kuzzle Team <support@kuzzle.io>",`
`6`	`6`	`"repository": {`
Original file line number	Diff line number	Diff line change
`@@ -6,22 +6,22 @@`
`6`	`6`	`* @returns {Object} tnstantiated WebSocket/Socket.IO object`
`7`	`7`	`*/`
`8`	`8`
`9`		`-function network(host, wsPort, ioPort) {`
	`9`	`+function network(host, wsPort, ioPort, sslConnection) {`
`10`	`10`	`// Web browser / NodeJS websocket handling`
`11`	`11`	`if (typeof window !== 'undefined') {`
`12`	`12`	`// use native websockets if the browser supports it`
`13`	`13`	`if (typeof WebSocket !== 'undefined') {`
`14`		`- return new (require('./wrappers/wsbrowsers'))(host, wsPort);`
	`14`	`+ return new (require('./wrappers/wsbrowsers'))(host, wsPort, sslConnection);`
`15`	`15`	`}`
`16`	`16`	`// otherwise fallback to socket.io, if available`
`17`	`17`	`else if (window.io) {`
`18`		`- return new (require('./wrappers/socketio'))(host, ioPort);`
	`18`	`+ return new (require('./wrappers/socketio'))(host, ioPort, sslConnection);`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`throw new Error('Aborting: no websocket support detected and no socket.io library loaded either.');`
`22`	`22`	`}`
`23`	`23`
`24`		`- return new (require('./wrappers/wsnode'))(host, wsPort);`
	`24`	`+ return new (require('./wrappers/wsnode'))(host, wsPort, sslConnection);`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`module.exports = network;`