support compression

Author: nkzawa

Readme.md

@@ -341,6 +341,18 @@ server.listen(3000);
   });
   ```
 
+### Socket#compress(v:Boolean):Socket
+
+  Sets a modifier for a subsequent event emission that the event data will
+  only be _compressed_ if the value is `true`. Defaults to `true` when you don't call the method.
+
+  ```js
+  var io = require('socket.io')();
+  io.on('connection', function(socket){
+    socket.compress(false).emit('an event', { some: 'data' });
+  });
+  ```
+
 ### Client
 
   The `Client` class represents an incoming transport (engine.io)

lib/client.js

@@ -61,7 +61,7 @@ Client.prototype.setup = function(){
 Client.prototype.connect = function(name){
   debug('connecting to namespace %s', name);
   if (!this.server.nsps[name]) {
-    this.packet({ type: parser.ERROR, nsp: name, data : 'Invalid namespace'});
+    this.packet({ type: parser.ERROR, nsp: name, data : 'Invalid namespace'}, false, false, true);
     return;
   }
   var nsp = this.server.of(name);
@@ -135,17 +135,18 @@ Client.prototype.close = function(){
  * @param {Object} packet object
  * @param {Boolean} whether packet is already encoded
  * @param {Boolean} whether packet is volatile
+ * @param {Boolean} whether packet should be compressed
  * @api private
  */
 
-Client.prototype.packet = function(packet, preEncoded, volatile){
+Client.prototype.packet = function(packet, preEncoded, volatile, compress){
   var self = this;
 
   // this writes to the actual connection
   function writeToEngine(encodedPackets) {
     if (volatile && !self.conn.transport.writable) return;
     for (var i = 0; i < encodedPackets.length; i++) {
-      self.conn.write(encodedPackets[i]);
+      self.conn.write(encodedPackets[i], { compress: compress });
     }
   }
 

lib/socket.js

@@ -202,7 +202,8 @@ Socket.prototype.write = function(){
 Socket.prototype.packet = function(packet, preEncoded){
   packet.nsp = this.nsp.name;
   var volatile = this.flags && this.flags.volatile;
-  this.client.packet(packet, preEncoded, volatile);
+  var compress = !this.flags || false !== this.flags.compress;
+  this.client.packet(packet, preEncoded, volatile, compress);
 };
 
 /**
@@ -442,3 +443,17 @@ Socket.prototype.disconnect = function(close){
   }
   return this;
 };
+
+/**
+ * Sets the compress flag.
+ *
+ * @param {Boolean} if `true`, compresses the sending data
+ * @return {Socket} self
+ * @api public
+ */
+
+Socket.prototype.compress = function(compress){
+  this.flags = this.flags || {};
+  this.flags.compress = compress;
+  return this;
+};

package.json

@@ -19,7 +19,7 @@
     "test": "mocha --reporter dot --slow 200ms --bail"
   },
   "dependencies": {
-    "engine.io": "1.5.1",
+    "engine.io": "Automattic/engine.io",
     "socket.io-parser": "2.2.2",
     "socket.io-client": "1.3.2",
     "socket.io-adapter": "0.3.1",

test/socket.io.js

@@ -1329,6 +1329,36 @@ describe('socket.io', function(){
         });
       });
     });
+
+    it('should enable compression by default', function(done){
+      var srv = http();
+      var sio = io(srv);
+      srv.listen(function(){
+        var socket = client(srv);
+        sio.on('connection', function(s){
+          s.conn.once('packetCreate', function(packet) {
+            expect(packet.options.compress).to.be(true);
+            done();
+          });
+          s.emit('woot', 'hi');
+        });
+      });
+    });
+
+    it('should disable compression', function(done){
+      var srv = http();
+      var sio = io(srv);
+      srv.listen(function(){
+        var socket = client(srv);
+        sio.on('connection', function(s){
+          s.conn.once('packetCreate', function(packet) {
+            expect(packet.options.compress).to.be(false);
+            done();
+          });
+          s.compress(false).emit('woot', 'hi');
+        });
+      });
+    });
   });
 
   describe('messaging many', function(){