From dbe140c1173cbb55b77aa959aca39b64cee3738a Mon Sep 17 00:00:00 2001
From: Tony Kovanen <tonykovanen@hotmail.com>
Date: Mon, 20 Jan 2014 10:49:20 +0200
Subject: [PATCH] Binary support

---
 README.md                       |  11 +-
 lib/server.js                   |   1 +
 lib/transports/flashsocket.js   |   6 ++
 lib/transports/polling-jsonp.js |   8 ++
 lib/transports/polling-xhr.js   |  18 +++-
 lib/transports/polling.js       |  21 ++--
 lib/transports/websocket.js     |   6 ++
 test/jsonp.js                   |  21 ++++
 test/server.js                  | 180 +++++++++++++++++++++++++++++++-
 9 files changed, 258 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 3b3d3ae47..43f7b1875 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ var engine = require('engine.io')
 
 server.on('connection', function (socket) {
   socket.send('utf 8 string');
+  socket.send(new Buffer([0, 1, 2, 3, 4, 5])); // binary data
 });
 ```
 
@@ -60,7 +61,10 @@ httpServer.on('request', function (req, res) {
 <script src="/path/to/engine.io.js"></script>
 <script>
   var socket = new eio.Socket('ws://localhost/');
+  // by default binary type is: socket.binaryType = 'arraybuffer'
+  socket.binaryType = 'blob';
   socket.on('open', function () {
+    socket.send(new Int8Array(15));
     socket.on('message', function (data) { });
     socket.on('close', function () { });
   });
@@ -220,7 +224,7 @@ A representation of a client. _Inherits from EventEmitter_.
 - `message`
     - Fired when the client sends a message.
     - **Arguments**
-      - `String`: Unicode string
+      - `String` or `Buffer`: Unicode string or Buffer with binary contents
 - `error`
     - Fired when an error occurs.
     - **Arguments**
@@ -253,9 +257,10 @@ A representation of a client. _Inherits from EventEmitter_.
 ##### Methods
 
 - `send`:
-    - Sends a message, performing `message = toString(arguments[0])`.
+    - Sends a message, performing `message = toString(arguments[0])` unless
+      sending binary data, which is sent as is.
     - **Parameters**
-      - `String`: a string or any object implementing `toString()`, with outgoing data
+      - `String` | `Buffer` | `ArrayBuffer` | `ArrayBufferView`: a string or any object implementing `toString()`, with outgoing data, or a Buffer or ArrayBuffer with binary data. Also any ArrayBufferView can be sent as is.
       - `Function`: optional, a callback executed when the message gets flushed out by the transport
     - **Returns** `Socket` for chaining
 - `close`
diff --git a/lib/server.js b/lib/server.js
index 82511e2b5..5b669ad9f 100644
--- a/lib/server.js
+++ b/lib/server.js
@@ -205,6 +205,7 @@ Server.prototype.handshake = function(transport, req){
 
   try {
     var transport = new transports[transport](req);
+    if (req.query && req.query.b64) transport.supportsBinary = false;
   }
   catch (e) {
     sendErrorMessage(req.res, Server.errors.BAD_REQUEST);
diff --git a/lib/transports/flashsocket.js b/lib/transports/flashsocket.js
index 794bb29fa..87f6d0e21 100644
--- a/lib/transports/flashsocket.js
+++ b/lib/transports/flashsocket.js
@@ -44,6 +44,12 @@ FlashSocket.prototype.name = 'flashsocket';
 
 FlashSocket.prototype.supportsFraming = true;
 
+/**
+ * Supports sending binary data.
+ * @api public
+ */
+FlashSocket.prototype.supportsBinary = false;
+
 /**
  * Listens for new configuration changes of the Manager
  * this way we can enable and disable the flash server.
diff --git a/lib/transports/polling-jsonp.js b/lib/transports/polling-jsonp.js
index b42b755e4..4608708b7 100644
--- a/lib/transports/polling-jsonp.js
+++ b/lib/transports/polling-jsonp.js
@@ -31,6 +31,14 @@ function JSONP (req) {
 
 JSONP.prototype.__proto__ = Polling.prototype;
 
+/**
+ * Supports sending binary data.
+ * @api public
+ */
+
+JSONP.prototype.supportsBinary = false;
+
+
 /**
  * Handles incoming data.
  * Due to a bug in \n handling by browsers, we expect a escaped string.
diff --git a/lib/transports/polling-xhr.js b/lib/transports/polling-xhr.js
index dde63aa98..676512a66 100644
--- a/lib/transports/polling-xhr.js
+++ b/lib/transports/polling-xhr.js
@@ -5,6 +5,7 @@
 
 var Polling = require('./polling');
 var Transport = require('../transport');
+var debug = require('debug')('engine:polling-xhr');
 
 /**
  * Module exports.
@@ -28,6 +29,13 @@ function XHR(req){
 
 XHR.prototype.__proto__ = Polling.prototype;
 
+/**
+ * Supports sending binary data.
+ * @api public
+ */
+
+XHR.prototype.supportsBinary = true;
+
 /**
  * Frames data prior to write.
  *
@@ -36,9 +44,15 @@ XHR.prototype.__proto__ = Polling.prototype;
 
 XHR.prototype.doWrite = function(data){
   // explicit UTF-8 is required for pages not served under utf
+  var isString = typeof data === 'string' || data === undefined;
+  var contentType = (isString)
+    ? 'text/plain; charset=UTF-8'
+    : 'application/octet-stream';
+  var contentLength = '' + ((isString) ? Buffer.byteLength(data) : data.length);
+
   var headers = {
-    'Content-Type': 'text/plain; charset=UTF-8',
-    'Content-Length': Buffer.byteLength(data)
+    'Content-Type': contentType,
+    'Content-Length': contentLength
   };
 
   // prevent XSS warnings on IE
diff --git a/lib/transports/polling.js b/lib/transports/polling.js
index 7b40bb9bc..881ef622b 100644
--- a/lib/transports/polling.js
+++ b/lib/transports/polling.js
@@ -118,14 +118,16 @@ Polling.prototype.onDataRequest = function (req, res) {
     this.onError('data request overlap from client');
     res.writeHead(500);
   } else {
+    var isBinary = req.headers['content-type'] === 'application/octet-stream';
+
     this.dataReq = req;
     this.dataRes = res;
 
-    var chunks = ''
+    var chunks = (isBinary) ? new Buffer(0) : ''
       , self = this
 
     function cleanup () {
-      chunks = '';
+      chunks = (isBinary) ? new Buffer(0) : '';
       req.removeListener('data', onData);
       req.removeListener('end', onEnd);
       req.removeListener('close', onClose);
@@ -138,7 +140,8 @@ Polling.prototype.onDataRequest = function (req, res) {
     };
 
     function onData (data) {
-      chunks += data;
+      if (typeof data === 'string') chunks += data;
+      else chunks = Buffer.concat([chunks, data]);
     };
 
     function onEnd () {
@@ -157,7 +160,7 @@ Polling.prototype.onDataRequest = function (req, res) {
     req.on('close', onClose);
     req.on('data', onData);
     req.on('end', onEnd);
-    req.setEncoding('utf8');
+    if (!isBinary) req.setEncoding('utf8');
   }
 };
 
@@ -171,7 +174,7 @@ Polling.prototype.onDataRequest = function (req, res) {
 Polling.prototype.onData = function (data) {
   debug('received "%s"', data);
   var self = this;
-  parser.decodePayload(data, function(packet){
+  var callback = function(packet) {
     if ('close' == packet.type) {
       debug('got xhr close packet');
       self.onClose();
@@ -179,7 +182,10 @@ Polling.prototype.onData = function (data) {
     }
 
     self.onPacket(packet);
-  });
+  };
+
+  if (typeof data === 'string') parser.decodePayload(data, callback);
+  else parser.decodePayloadAsBinary(data, callback);
 };
 
 /**
@@ -197,7 +203,8 @@ Polling.prototype.send = function (packets) {
     this.shouldClose = null;
   }
 
-  this.write(parser.encodePayload(packets));
+  if (!this.supportsBinary) this.write(parser.encodePayload(packets));
+  else this.write(parser.encodePayloadAsBinary(packets));
 };
 
 /**
diff --git a/lib/transports/websocket.js b/lib/transports/websocket.js
index 5582c58fc..a07759a35 100644
--- a/lib/transports/websocket.js
+++ b/lib/transports/websocket.js
@@ -63,6 +63,12 @@ WebSocket.prototype.handlesUpgrades = true;
 
 WebSocket.prototype.supportsFraming = true;
 
+/**
+ * Supports sending binary data.
+ * @api public
+ */
+WebSocket.prototype.supportsBinary = true;
+
 /**
  * Processes the incoming data.
  *
diff --git a/test/jsonp.js b/test/jsonp.js
index 28ef65364..42e3935b7 100644
--- a/test/jsonp.js
+++ b/test/jsonp.js
@@ -115,6 +115,27 @@ describe('JSONP', function () {
         });
       });
     }); 
+
+    it('should arrive from server to client and back with binary data (pollingJSONP)', function(done) {
+      var binaryData = new Buffer(5);
+      for (var i = 0; i < 5; i++) binaryData[i] = i;
+      var engine = listen( { allowUpgrades: false, transports: ['polling'] }, function (port) {
+        var socket = new eioc.Socket('ws://localhost:' + port, { transports: ['polling'], forceJSONP: true, upgrade: false});
+        engine.on('connection', function (conn) {
+          conn.on('message', function (msg) {
+            conn.send(msg);
+          });
+        });
+
+        socket.on('open', function() {
+          socket.send(binaryData);
+          socket.on('message', function (msg) {
+            for (var i = 0; i < msg.length; i++) expect(msg[i]).to.be(i);
+            done();
+          });
+        });
+      });
+    });
   });
   
   describe('close', function () {
diff --git a/test/server.js b/test/server.js
index f5b81b247..6a379bb3b 100644
--- a/test/server.js
+++ b/test/server.js
@@ -63,7 +63,7 @@ describe('server', function () {
     it('should send the io cookie', function (done) {
       var engine = listen(function (port) {
         request.get('http://localhost:%d/engine.io/default/'.s(port))
-          .query({ transport: 'polling' })
+          .query({ transport: 'polling', b64: 1 })
           .end(function (res) {
             // hack-obtain sid
             var sid = res.text.match(/"sid":"([^"]+)"/)[1];
@@ -76,7 +76,7 @@ describe('server', function () {
     it('should send the io cookie custom name', function (done) {
       var engine = listen({ cookie: 'woot' }, function (port) {
         request.get('http://localhost:%d/engine.io/default/'.s(port))
-          .query({ transport: 'polling' })
+          .query({ transport: 'polling', b64: 1 })
           .end(function (res) {
             var sid = res.text.match(/"sid":"([^"]+)"/)[1];
             expect(res.headers['set-cookie'][0]).to.be('woot=' + sid);
@@ -833,6 +833,182 @@ describe('server', function () {
       });
     });
 
+    it('should arrive when binary data is sent as Int8Array (ws)', function (done) {
+      var binaryData = new Int8Array(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData[i] = i;
+      
+      var opts = { allowUpgrades: false, transports: ['websocket'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['websocket'] })
+        
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function () {
+          socket.on('message', function(msg) {
+            for (var i = 0; i < msg.length; i++) {
+              var num = msg.readInt8(i);
+              expect(num).to.be(i);
+            }
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive when binary data is sent as Int32Array (ws)', function (done) {
+      var binaryData = new Int32Array(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData[i] = (i + 100) * 9823;
+      
+      var opts = { allowUpgrades: false, transports: ['websocket'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['websocket'] })
+        
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function () {
+          socket.on('message', function(msg) {
+            for (var i = 0, ii = 0; i < msg.length; i += 4, ii++) {
+              var num = msg.readInt32LE(i);
+              expect(num).to.be((ii + 100) * 9823);
+            }
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive when binary data is sent as Int32Array, given as ArrayBuffer(ws)', function (done) {
+      var binaryData = new Int32Array(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData[i] = (i + 100) * 9823;
+      
+      var opts = { allowUpgrades: false, transports: ['websocket'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['websocket'] })
+        
+        engine.on('connection', function (conn) {
+          conn.send(binaryData.buffer);
+        });
+
+        socket.on('open', function () {
+          socket.on('message', function(msg) {
+            for (var i = 0, ii = 0; i < msg.length; i += 4, ii++) {
+              var num = msg.readInt32LE(i);
+              expect(num).to.be((ii + 100) * 9823);
+            }
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive when binary data is sent as Buffer (ws)', function (done) {
+      var binaryData = Buffer(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData.writeInt8(i, i);
+
+      var opts = { allowUpgrades: false, transports: ['websocket'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['websocket'] });
+        
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function () {
+          socket.on('message', function(msg) {
+            for (var i = 0; i < msg.length; i++) {
+              var num = msg.readInt8(i);
+              expect(num).to.be(i);
+            }
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive when binary data sent as Buffer (polling)', function (done) {
+      var binaryData = Buffer(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData.writeInt8(i, i);
+
+      var opts = { allowUpgrades: false, transports: ['polling'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['polling'] });
+
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function() {
+          socket.on('message', function(msg) {
+            for (var i = 0; i < msg.length; i++) {
+              var num = msg.readInt8(i);
+              expect(num).to.be(i);
+            }
+
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive as ArrayBuffer if requested when binary data sent as Buffer (ws)', function (done) {
+      var binaryData = Buffer(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData.writeInt8(i, i);
+
+      var opts = { allowUpgrades: false, transports: ['websocket'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['websocket'] });
+        socket.binaryType = 'arraybuffer';
+
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function() {
+          socket.on('message', function(msg) {
+            expect(msg instanceof ArrayBuffer).to.be(true);
+            var intArray = new Int8Array(msg);
+            for (var i = 0; i < intArray.length; i++) {
+              expect(intArray[i]).to.be(i);
+            }
+
+            done();
+          });
+        });
+      });
+    });
+
+    it('should arrive as ArrayBuffer if requested when binary data sent as Buffer (polling)', function (done) {
+      var binaryData = Buffer(5);
+      for (var i = 0; i < binaryData.length; i++) binaryData.writeInt8(i, i);
+
+      var opts = { allowUpgrades: false, transports: ['polling'] };
+      var engine = listen(opts, function(port) {
+        var socket = new eioc.Socket('ws://localhost:%d'.s(port), { transports: ['polling'] });
+        socket.binaryType = 'arraybuffer';
+
+        engine.on('connection', function (conn) {
+          conn.send(binaryData);
+        });
+
+        socket.on('open', function() {
+          socket.on('message', function(msg) {
+            expect(msg instanceof ArrayBuffer).to.be(true);
+            var intArray = new Int8Array(msg);
+            for (var i = 0; i < intArray.length; i++) {
+              expect(intArray[i]).to.be(i);
+            }
+
+            done();
+          });
+        });
+      });
+    });
+
+
     it('should trigger a flush/drain event', function(done){
       var engine = listen({ allowUpgrades: false }, function(port){
         engine.on('connection', function(socket){