ddp - npm Package Compare versions

Comparing version 0.3.3 to 0.3.4

CHANGELOG.md

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

examples/example.js

 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) {
@@ -33,3 +34,3 @@ console.log('DDP connection error!');
 ddpclient.on('message', function(msg) {
-	console.log("ddp message: " + msg);
+  console.log("ddp message: " + msg);
 });
@@ -45,4 +46,5 @@
 });
+
 ddpclient.on('socket-error', function(error) {
   console.log("Error: %j", error);
-});
+});

lib/ddp-client.js

 var WebSocket = require('ws'),
     _ = require('underscore'),
     util = require('util'),
-    events = require('events');
+    events = require('events'),
+    EJSON = require('meteor-ejson');
 
@@ -18,2 +19,5 @@ DDPClient = function(opts) {
 
+  // 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}])
@@ -44,3 +48,3 @@ self.collections = {};
     // 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 
@@ -77,3 +81,3 @@
   }
-}
+};
 
@@ -83,6 +87,15 @@ ///////////////////////////////////////////////////////////////////////////
 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.
   });
+
 };
@@ -94,4 +107,7 @@
 
-  // TODO: EJSON parsing
-  var data = JSON.parse(data);
+  if (self.use_ejson) {
+    data = EJSON.parse(data);
+  } else {
+    data = JSON.parse(data);
+  }
 
@@ -105,6 +121,6 @@ // TODO: 'error'
     return;
-  
+
   } else if (data.msg === 'failed') {
     self.emit('failed', data);
-    
+
   } else if (data.msg === 'connected') {
@@ -218,6 +234,6 @@ self.session = data.session;
       self._connectionFailed = true;
-      connected(error)
+      connected(error);
     });
   }
-  
+
   // websocket
@@ -224,0 +240,0 @@ var protocol = self.use_ssl ? 'wss://' : 'ws://';

package.json

 {
-    "name": "ddp",
-    "version": "0.3.3",
-    "description": "Node.js module to connect to servers using DDP protocol.",
-    "author": "Tom Coleman <[e-mail]> (http://tom.thesnail.org), Mike Bannister <[e-mail]> (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 <[e-mail]> (http://tom.thesnail.org)",
+  "contributors": [
+    "Thomas Sarlandie <[e-mail]> (http://www.sarfata.org)",
+    "Mason Gravitt <[e-mail]>",
+    "Mike Bannister <[e-mail]> (http://po.ssibiliti.es)",
+    "Chris Mather <[e-mail]> (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

 var assert = require('assert'),
-    sinon = require('sinon'),
+    sinon  = require('sinon'),
     rewire = require('rewire'),
-    events = require('events');
+    events = require('events'),
+    EJSON  = require('meteor-ejson');
 
@@ -29,3 +30,3 @@ var DDPClient = rewire("../lib/ddp-client");
     assert(wsConstructor.calledWithNew());
-    assert(wsConstructor.call)
+    assert(wsConstructor.call);
     assert.deepEqual(wsConstructor.args, [['ws://localhost:3000/websocket']]);
@@ -76,3 +77,3 @@ });
     prepareMocks();
-  })
+  });
 
@@ -111,1 +112,76 @@ // For some weird reasons (hard to reproduce) it happens that we try to send a message and
 });
+
+
+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();
+  });
+
+});
+

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17705

increased by21.72%

Lines of code

393

increased by19.45%

Number of lines in readme file

94

increased by1.08%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

4

increased by33.33%

Dependency changes

• + Addedmeteor-ejson@>=0.6.3

• + Addedmeteor-ejson@0.6.3(transitive)

• + Addedunderscore@1.4.4(transitive)