Using extend for default options.

Closes #39.
moscajs · Jul 16, 2013 · 2c5efdd · 2c5efdd
1 parent 628581d
commit 2c5efdd
Show file tree

Hide file tree

Showing 10 changed files with 97 additions and 79 deletions.
diff --git a/.jshintrc b/.jshintrc
@@ -11,6 +11,7 @@
     "mosca": false,
     "expect": false,
     "before": false,
-    "moscaSettings": false
+    "moscaSettings": false,
+    "globalLogger": false
   }
 }
diff --git a/lib/persistence/levelup.js b/lib/persistence/levelup.js
@@ -8,6 +8,19 @@ var range = require('level-range');
 var ttl = require('level-ttl');
 var Qlobber = require("qlobber").Qlobber;
 var async = require("async");
+var extend = require("extend");
+var defaults = {
+  ttl: {
+    // TTL for subscriptions is 1 hour
+    subscriptions: 60 * 60 * 1000,
+
+    // TTL for packets is 1 hour
+    packets: 60 * 60 * 1000,
+
+    // the checkFrequency is 1 minute
+    checkFrequency: 60 * 1000
+  }
+};
 
 /**
  * A LevelUp-based persistance.
@@ -32,21 +45,11 @@ function LevelUpPersistence(options, callback) {
   if (!(this instanceof LevelUpPersistence)) {
     return new LevelUpPersistence(options, callback);
   }
-  options = options || {};
-  options.valueEncoding = "json";
-  options.ttl = options.ttl || {};
-
-  // TTL for subscriptions is 1 hour
-  options.ttl.subscriptions = options.ttl.subscriptions || 60 * 60 * 1000;
-
-  // TTL for packets is 1 hour
-  options.ttl.packets = options.ttl.packets || 60 * 60 * 1000;
 
-  // the checkFrequency is 1 minute
-  options.ttl.checkFrequency = options.ttl.checkFrequency || 60 * 1000;
+  this.options = extend(true, {}, defaults, options);
+  this.options.valueEncoding = "json";
 
-  this.options = options;
-  this.db = ttl(levelup(options.path, options), options.ttl);
+  this.db = ttl(levelup(this.options.path, this.options), options.ttl);
   this._retained = this.db.sublevel("retained");
   this._clientSubscriptions = this.db.sublevel("clientSubscriptions");
   this._subscriptions = this.db.sublevel("subscriptions");

diff --git a/lib/persistence/mongo.js b/lib/persistence/mongo.js
@@ -6,6 +6,17 @@ var util = require("util");
 var async = require("async");
 var Qlobber = require("qlobber").Qlobber;
 var topicPatterns = require("./utils").topicPatterns;
+var extend = require("extend");
+var defaults = {
+  ttl: {
+    // TTL for subscriptions is 1 hour
+    subscriptions: 60 * 60 * 1000,
+
+    // TTL for packets is 1 hour
+    packets: 60 * 60 * 1000,
+  },
+  mongo: {}
+};
 
 /**
  * A persistance based on MongoDB.
@@ -31,19 +42,9 @@ function MongoPersistence(options, done) {
     return new MongoPersistence(options);
   }
 
-  options.ttl = options.ttl || {};
-
-  // TTL for subscriptions is 1 hour
-  options.ttl.subscriptions = options.ttl.subscriptions || 60 * 60 * 1000;
-
-  // TTL for packets is 1 hour
-  options.ttl.packets = options.ttl.packets || 60 * 60 * 1000;
-
-  options.mongo = options.mongo || {};
-
-  options.mongo.safe = true;
 
-  this.options = options;
+  this.options = extend(true, {}, defaults, options);
+  this.options.mongo.safe = true;
 
   var that = this;
 
@@ -63,7 +64,7 @@ function MongoPersistence(options, done) {
           that._subscriptions = coll;
           async.parallel([
             that._subscriptions.ensureIndex.bind(that._subscriptions, "client"),
-            that._subscriptions.ensureIndex.bind(that._subscriptions, { "added": 1 }, { expireAfterSeconds: Math.round(options.ttl.subscriptions / 1000 )} )
+            that._subscriptions.ensureIndex.bind(that._subscriptions, { "added": 1 }, { expireAfterSeconds: Math.round(that.options.ttl.subscriptions / 1000 )} )
           ], cb);
         });
       },
@@ -88,9 +89,9 @@ function MongoPersistence(options, done) {
 
   // Connect to the db
   if (options.connection) {
-    connected(null, options.connection);
+    connected(null, this.options.connection);
   } else {
-    MongoClient.connect(options.url, options.mongo, connected);
+    MongoClient.connect(this.options.url, this.options.mongo, connected);
   }
 }
 

diff --git a/lib/persistence/redis.js b/lib/persistence/redis.js
@@ -5,6 +5,20 @@ var redis = require("redis");
 var util = require("util");
 var Qlobber = require("qlobber").Qlobber;
 var async = require("async");
+var extend = require("extend");
+var defaults = {
+  channel: "moscaSync",
+  ttl: {
+    // TTL for subscriptions is 1 hour
+    subscriptions: 60 * 60 * 1000,
+
+    // TTL for packets is 1 hour
+    packets: 60 * 60 * 1000,
+
+    // the checkFrequency is 1 minute
+    checkFrequency: 60 * 1000
+  }
+};
 
 /**
  * A Redis-based persistance.
@@ -31,17 +45,7 @@ function RedisPersistence(options, callback) {
     return new RedisPersistence(options, callback);
   }
 
-  options.ttl = options.ttl || {};
-
-  // TTL for subscriptions is 1 hour
-  options.ttl.subscriptions = options.ttl.subscriptions || 60 * 60 * 1000;
-
-  // TTL for packets is 1 hour
-  options.ttl.packets = options.ttl.packets || 60 * 60 * 1000;
-
-  options.channel = options.channel || "moscaSync";
-
-  this.options = options;
+  this.options = extend(true, {}, defaults, options);
 
   this._subLobber = new Qlobber({ separator: "/" });
 
@@ -81,7 +85,7 @@ function RedisPersistence(options, callback) {
 
   var that = this;
 
-  this._pubSubClient.subscribe(options.channel);
+  this._pubSubClient.subscribe(this.options.channel);
   this._pubSubClient.on("message", function(channel, message) {
     var parsed = JSON.parse(message);
     if (parsed.process !== that._uuid) {

diff --git a/lib/server.js b/lib/server.js
@@ -5,7 +5,23 @@ var async = require("async");
 var ascoltatori = require("ascoltatori");
 var EventEmitter = require("events").EventEmitter;
 var bunyan = require("bunyan");
+var extend = require("extend");
 var Client = require("./client");
+var defaults = {
+  port: 1883,
+  backend: {
+    json: false
+  },
+  baseRetryTimeout: 1000,
+  logger: {
+    name: "mosca",
+    level: 40,
+    serializers: {
+      client: clientSerializer,
+      packet: packetSerializer
+    }
+  }
+};
 
 /**
  * The Mosca Server is a very simple MQTT server that
@@ -44,17 +60,7 @@ var Client = require("./client");
 function Server(opts, callback) {
   EventEmitter.call(this);
 
-  this.opts = opts || {};
-  this.opts.port = this.opts.port || 1883;
-  this.opts.backend = this.opts.backend || {};
-  this.opts.baseRetryTimeout = this.opts.baseRetryTimeout || 1000;
-  this.opts.logger = this.opts.logger || {};
-  this.opts.logger.name = this.opts.logger.name || "mosca";
-  this.opts.logger.level = this.opts.logger.level || 40;
-  this.opts.logger.serializers = {
-    client: clientSerializer,
-    packet: packetSerializer
-  };
+  this.opts = extend(true, {}, defaults, opts);
 
   if (this.opts.persistence && this.opts.persistence.factory) {
     this.opts.persistence.factory(this.opts.persistence).wire(this);
@@ -73,10 +79,6 @@ function Server(opts, callback) {
     new Client(connection, that);
   };
 
-  if (this.opts.backend.json === undefined) {
-    this.opts.backend.json = false;
-  }
-
   this.ascoltatore = ascoltatori.build(this.opts.backend);
   this.ascoltatore.on("error", this.emit.bind(this));
 

diff --git a/package.json b/package.json
@@ -60,7 +60,8 @@
     "level-ttl": "~0.2.0",
     "qlobber": "~0.3.0",
     "lru-cache": "~2.3.0",
-    "node-uuid": "~1.4.0"
+    "node-uuid": "~1.4.0",
+    "extend": "~1.1.3"
   },
   "optionalDependencies": {
     "leveldown": "~0.6.1",

diff --git a/test/cli_spec.js b/test/cli_spec.js
@@ -135,7 +135,8 @@ describe("mosca.cli", function() {
     args.push("--config");
     args.push("test/sample_config.js");
     startServer(done, function(server) {
-      expect(server.opts).to.eql(require("./sample_config"));
+      expect(server.opts).to.have.property("port", 2883);
+      expect(server.opts).to.have.deep.property("backend.port", 3833);
     });
   });
 

diff --git a/test/common.js b/test/common.js
@@ -28,16 +28,19 @@ global.rabbitSettings = function() {
 };
 
 var bunyan = require("bunyan");
-global.moscaSettings = function() {
-  var logger = bunyan.createLogger({
-    name: "moscaTests"
-  });
 
-  logger.level(60);
+global.globalLogger = bunyan.createLogger({
+  name: "moscaTests",
+  level: 60
+});
 
+global.moscaSettings = function() {
   return {
     port: nextPort(),
-    logger: logger
+    logger: {
+      name: "moscaTests",
+      level: 60
+    }
   };
 };
 

diff --git a/test/persistence/abstract.js b/test/persistence/abstract.js
@@ -137,7 +137,7 @@ module.exports = function(create) {
       };
 
       var client = { 
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         forward: function(topic, payload, options, pattern) {
           expect(topic).to.eql(packet1.topic);
           expect(payload).to.eql(packet1.payload);
@@ -161,7 +161,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -175,7 +175,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -193,7 +193,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -214,7 +214,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: true,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -236,7 +236,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -258,7 +258,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -285,7 +285,7 @@ module.exports = function(create) {
       var client = { 
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -313,7 +313,7 @@ module.exports = function(create) {
       var client = { 
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -336,7 +336,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 1
@@ -359,7 +359,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: {
             qos: 0
@@ -380,7 +380,7 @@ module.exports = function(create) {
     var client = { 
       id: "my client id - 42",
       clean: false,
-      logger: moscaSettings().logger,
+      logger: globalLogger,
       subscriptions: {
         hello: {
           qos: 1
@@ -462,7 +462,7 @@ module.exports = function(create) {
       var client = {
         id: "my client id - 42",
         clean: false,
-        logger: moscaSettings().logger,
+        logger: globalLogger,
         subscriptions: {
           hello: 1
         }
@@ -541,7 +541,7 @@ module.exports = function(create) {
     var client = { 
       id: "my client id - 42",
       clean: false,
-      logger: moscaSettings().logger,
+      logger: globalLogger,
       subscriptions: {
         "hello/#": {
           qos: 1
@@ -581,7 +581,7 @@ module.exports = function(create) {
     var client = { 
       id: "my client id - 42",
       clean: false,
-      logger: moscaSettings().logger,
+      logger: globalLogger,
       subscriptions: {
         hello: {
           qos: 1