Merge pull request #23 from oortcloud/ejson

EJSON support

Author: emgee3

CHANGELOG.md

@@ -1,3 +1,6 @@
+0.3.4 - 2013-08-28
+ - added EJSON support (default is off) with a couple tests
+
 0.3.3 - 2013-05-29
  - fixed bug where an exception could be thrown when sending a message on a socket that is not opened anymore (issue #18)
  - added some tests (work in progress)

README.markdown

@@ -5,7 +5,7 @@ A callback style DDP ([Meteor](http://meteor.com/)'s Distributed Data Protocol)
 
 Based _heavily_ on alansikora's [node-js_ddp-client](https://github.com/alansikora/node-js_ddp-client), and meteor's python client. Uses a more callback style approach.
 
-The client implements the pre1 version of DDP. It is unfinished at this point, but should do most of what you want it to do.
+The client implements the pre1 version of DDP, with optional [EJSON](http://docs.meteor.com/#ejson) support. It is unfinished at this point, but should do most of what you want it to do.
 
 Installation
 ============
@@ -23,12 +23,13 @@ Please see the example in `examples/example.js`. Or here for reference:
 var DDPClient = require("ddp");
 
 var ddpclient = new DDPClient({
-    host: "localhost", 
-    port: 3000,
-    /* optional: */
-    auto_reconnect: true,
-    auto_reconnect_timer: 500
-  });
+  host: "localhost", 
+  port: 3000,
+  /* optional: */
+  auto_reconnect: true,
+  auto_reconnect_timer: 500,
+  use_ejson: true  // default is false
+});
 
 ddpclient.connect(function(error) {
   if (error) {
@@ -52,17 +53,18 @@ ddpclient.connect(function(error) {
  * Useful for debugging and learning the ddp protocol
  */
 ddpclient.on('message', function(msg) {
-	console.log("ddp message: " + msg);
-});	
+  console.log("ddp message: " + msg);
+});
 
 /* 
  * If you need to do something specific on close or errors.
  * (You can also disable auto_reconnect and call ddpclient.connect()
- *  when you are ready to re-connect.)
+ * when you are ready to re-connect.)
 */
 ddpclient.on('socket-close', function(code, message) {
   console.log("Close: %s %s", code, message);
 });
+
 ddpclient.on('socket-error', function(error) {
   console.log("Error: %j", error);
 });
@@ -75,7 +77,6 @@ Unimplemented Features
   * 'movedBefore'
   * 'error'
   * 'updated'
-* EJSON support
 
 
 

examples/example.js

@@ -1,16 +1,17 @@
 var DDPClient = require("../lib/ddp-client");
 
 var ddpclient = new DDPClient({
-    host: "localhost",
-    port: 3000,
-    /* optional: */
-    auto_reconnect: true,
-    auto_reconnect_timer: 500
-  });
+  host: "localhost",
+  port: 3000,
+  /* optional: */
+  auto_reconnect: true,
+  auto_reconnect_timer: 500,
+  use_ejson: true  // default is false
+});
 
 ddpclient.connect(function(error) {
   console.log('connected!');
-  
+
   if (error) {
     console.log('DDP connection error!');
     return;
@@ -30,7 +31,7 @@ ddpclient.connect(function(error) {
  * Useful for debugging and learning the ddp protocol
  */
 ddpclient.on('message', function(msg) {
-	console.log("ddp message: " + msg);
+  console.log("ddp message: " + msg);
 });
 
 /* 
@@ -41,6 +42,7 @@ ddpclient.on('message', function(msg) {
 ddpclient.on('socket-close', function(code, message) {
   console.log("Close: %s %s", code, message);
 });
+
 ddpclient.on('socket-error', function(error) {
   console.log("Error: %j", error);
-});
+});

lib/ddp-client.js

@@ -1,7 +1,8 @@
 var WebSocket = require('ws'),
     _ = require('underscore'),
     util = require('util'),
-    events = require('events');
+    events = require('events'),
+    EJSON = require('meteor-ejson');
 
 DDPClient = function(opts) {
   var self = this;
@@ -15,6 +16,9 @@ DDPClient = function(opts) {
   self.auto_reconnect = ('auto_reconnect' in opts) ? opts.auto_reconnect : true;
   self.auto_reconnect_timer = ('auto_reconnect_timer' in opts) ? opts.auto_reconnect_timer : 500;
 
+  // add support for EJSON, off by default to avoid breaking change
+  self.use_ejson = opts.use_ejson || false;
+
   // very very simple collections (name -> [{id -> document}])
   self.collections = {};
 
@@ -40,7 +44,7 @@ DDPClient.prototype._prepareHandlers = function() {
     };
 
     // if reconnecting, try existing DDP session  
-    // removed for now, per conversatino with sixolet on IRC,
+    // removed for now, per conversation with sixolet on IRC,
     // reconnect on server side still needs work 
 
     /*
@@ -72,23 +76,35 @@ DDPClient.prototype._recoverNetworkError = function() {
   if (self.auto_reconnect && ! self._connectionFailed && ! self._isClosing) {
     setTimeout(function() { self.connect(); }, self.auto_reconnect_timer);
   }
-}
+};
 
 ///////////////////////////////////////////////////////////////////////////
 // RAW, low level functions
 DDPClient.prototype._send = function(data) {
-  this.socket.send(JSON.stringify(data), function(error) {
+  var self = this;
+
+  if (self.use_ejson) {
+    data = EJSON.stringify(data);
+  } else {
+    data = JSON.stringify(data);
+  }
+
+  this.socket.send(data, function(error) {
     // This callback to avoid an exception being thrown.
     // if an error happened, the socket will throw an event and we will recover.
   });
+
 };
 
 // handle a message from the server
 DDPClient.prototype._message = function(data, flags) {
   var self = this;
 
-  // TODO: EJSON parsing
-  var data = JSON.parse(data);
+  if (self.use_ejson) {
+    data = EJSON.parse(data);
+  } else {
+    data = JSON.parse(data);
+  }
 
   // TODO: 'error'
   // TODO: 'updated'     -- not sure exactly what the point is here
@@ -97,10 +113,10 @@ DDPClient.prototype._message = function(data, flags) {
 
   if (!data.msg) {
     return;
-  
+
   } else if (data.msg === 'failed') {
     self.emit('failed', data);
-    
+
   } else if (data.msg === 'connected') {
     self.session = data.session;
     self.emit('connected');
@@ -209,10 +225,10 @@ DDPClient.prototype.connect = function(connected) {
     self.addListener("connected", connected);
     self.addListener("failed", function(error) {
       self._connectionFailed = true;
-      connected(error)
+      connected(error);
     });
   }
-  
+
   // websocket
   var protocol = self.use_ssl ? 'wss://' : 'ws://';
   self.socket = new WebSocket(protocol + self.host + ':' + self.port + '/' + self.path);

package.json

@@ -1,25 +1,40 @@
 {
-    "name": "ddp",
-    "version": "0.3.3",
-    "description": "Node.js module to connect to servers using DDP protocol.",
-    "author": "Tom Coleman <[email protected]> (http://tom.thesnail.org), Mike Bannister <[email protected]> (http://po.ssibiliti.es)",
-    "main": "lib/ddp-client",
-    "keywords": ["ddp", "meteor", "protocol"],
-    "repository" : {
-        "type": "git",
-        "url": "https://github.com/oortcloud/node-ddp-client.git"
-    },
-    "dependencies": {
-        "ws": ">=0.4.23",
-        "underscore": ">=1.3.3"
-    },
-    "devDependencies": {
-        "mocha": "1.9.x",
-        "sinon": "1.7.x",
-        "rewire": "1.1.x"
-    },
-    "scripts": {
-      "test": "./node_modules/mocha/bin/mocha test"
-    },
-    "engines": { "node": "*" }
-}
+  "name": "ddp",
+  "version": "0.3.4",
+  "description": "Node.js module to connect to servers using DDP protocol.",
+  "author": "Tom Coleman <[email protected]> (http://tom.thesnail.org)",
+  "contributors": [
+    "Thomas Sarlandie <[email protected]> (http://www.sarfata.org)",
+    "Mason Gravitt <[email protected]>",
+    "Mike Bannister <[email protected]> (http://po.ssibiliti.es)",
+    "Chris Mather <[email protected]> (http://eventedmind.com)"
+  ],
+  "main": "lib/ddp-client",
+  "keywords": [
+    "ddp",
+    "meteor",
+    "protocol"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/oortcloud/node-ddp-client.git"
+  },
+  "dependencies": {
+    "ws": ">=0.4.23",
+    "underscore": ">=1.3.3",
+    "meteor-ejson": ">=0.6.3"
+  },
+  "devDependencies": {
+    "mocha": "1.9.x",
+    "sinon": "1.7.x",
+    "rewire": "1.1.x",
+    "meteor-ejson": ">=0.6.3"
+  },
+  "scripts": {
+    "test": "./node_modules/mocha/bin/mocha test"
+  },
+  "engines": {
+    "node": "*"
+  },
+  "bugs": "https://github.com/oortcloud/node-ddp-client/issues"
+}

test/ddp-client.js

@@ -1,7 +1,8 @@
 var assert = require('assert'),
-    sinon = require('sinon'),
+    sinon  = require('sinon'),
     rewire = require('rewire'),
-    events = require('events');
+    events = require('events'),
+    EJSON  = require('meteor-ejson');
 
 var DDPClient = rewire("../lib/ddp-client");
 
@@ -26,7 +27,7 @@ describe("Connect to remote server", function() {
 
     assert(wsConstructor.calledOnce);
     assert(wsConstructor.calledWithNew());
-    assert(wsConstructor.call)
+    assert(wsConstructor.call);
     assert.deepEqual(wsConstructor.args, [['ws://localhost:3000/websocket']]);
   });
   it('should connect to the provided host', function() {
@@ -72,7 +73,7 @@ describe('Automatic reconnection', function() {
 describe("Network errors", function() {
   beforeEach(function() {
     prepareMocks();
-  })
+  });
 
   // For some weird reasons (hard to reproduce) it happens that we try to send a message and
   // get an exception throws at us because the connection is not opened anymore.
@@ -106,3 +107,78 @@ describe("Network errors", function() {
     assert(!errorCB.calledOnce);
   });
 });
+
+
+describe('EJSON', function() {
+
+  var DDPMessage = '{"msg":"added","collection":"posts","id":"2trpvcQ4pn32ZYXco","fields":{"date":{"$date":1371591394454},"bindata":{"$binary":"QUJDRA=="}}}';
+  var EJSONObject = EJSON.parse(DDPMessage);
+
+  it('should not be enabled by default', function(done) {
+    var ddpclient = new DDPClient();
+
+    assert(!ddpclient.use_ejson);
+
+    done();
+  });
+
+  it('should not be used when disabled', function(done) {
+    var ddpclient = new DDPClient({ use_ejson : false });
+
+    assert(!ddpclient.use_ejson);
+
+    ddpclient._message(DDPMessage);
+
+    // ensure received dates not decoded from EJSON
+    assert.deepEqual(ddpclient.collections.posts['2trpvcQ4pn32ZYXco'].date, {"$date":1371591394454});
+
+    // ensure received binary data not decoded from EJSON date
+    assert.deepEqual(ddpclient.collections.posts['2trpvcQ4pn32ZYXco'].bindata, {"$binary":"QUJDRA=="});
+
+    ddpclient.socket = {};
+    ddpclient.socket.send = function (opts) {
+      // ensure sent dates not encoded into EJSON
+      assert(opts.indexOf("date")          !== -1);
+      assert(opts.indexOf("$date")         === -1);
+      assert(opts.indexOf("1371591394454") === -1);
+
+      // ensure sent binary data not encoded into EJSON
+      assert(opts.indexOf("bindata")       !== -1);
+      assert(opts.indexOf("$binary")       === -1);
+      assert(opts.indexOf("QUJDRA==")      === -1);
+    };
+
+    ddpclient._send(EJSONObject.fields);
+
+    done();
+  });
+
+  it('should be used if specifically enabled', function(done) {
+    var ddpclient = new DDPClient({ use_ejson : true });
+
+    assert(ddpclient.use_ejson);
+
+    ddpclient._message(DDPMessage);
+
+    assert.deepEqual(ddpclient.collections.posts['2trpvcQ4pn32ZYXco'].date, new Date(1371591394454));
+
+    assert.deepEqual(ddpclient.collections.posts['2trpvcQ4pn32ZYXco'].bindata, new Uint8Array([65, 66, 67, 68]));
+
+    ddpclient.socket = {};
+    ddpclient.socket.send = function (opts) {
+      assert(opts.indexOf("date")          !== -1);
+      assert(opts.indexOf("$date")         !== -1);
+      assert(opts.indexOf("1371591394454") !== -1);
+
+      assert(opts.indexOf("bindata")       !== -1);
+      assert(opts.indexOf("$binary")       !== -1);
+      assert(opts.indexOf("QUJDRA==")      !== -1);
+    };
+
+    ddpclient._send(EJSONObject.fields);
+
+    done();
+  });
+
+});
+