Add callbacks to messagint for assertions

Author: raman-nbg

src/messaging.js

@@ -11,6 +11,7 @@ var Queue = require('./queue').Queue;
 
 function MockMessaging() {
   this.results = {};
+  this.callbacks = {};
   this.queue = new Queue();
   this.flushDelay = false;
 }
@@ -20,7 +21,6 @@ MockMessaging.prototype.send = function(message, dryRun) {
   assert(!_.isUndefined(message), 'message must not be undefined');
   return this._send(_.toArray(arguments), 'send', function() {
     var messageId = autoId(new Date().getTime());
-    console.log(typeof(result));
     return messageId;
   });
 };
@@ -70,11 +70,18 @@ MockMessaging.prototype.nextResult = function(methodName, result) {
   this.results[methodName] = result;
 };
 
+MockMessaging.prototype.on = function(methodName, callback) {
+  assert(_.isFunction(callback), 'callback must be a function');
+  this.callbacks[methodName] = callback;
+};
+
 MockMessaging.prototype._send = function(args, methodName, defaultResultFn) {
   var result = this._nextResult(methodName);
   var self = this;
   return new Promise(function (resolve, reject) {
     self._defer(methodName, args, function () {
+      self._invokeOn(methodName, args);
+
       if (result === null) {
         resolve(defaultResultFn());
       } else if (result instanceof Error) {
@@ -85,6 +92,13 @@ MockMessaging.prototype._send = function(args, methodName, defaultResultFn) {
     });
   });
 };
+
+MockMessaging.prototype._invokeOn = function(methodName, args) {
+  var callback = this.callbacks[methodName];
+  if (callback) {
+    callback(args);
+  }
+};
 
 MockMessaging.prototype._nextResult = function(type) {
   var err = this.results[type];

test/unit/messaging.js

@@ -41,6 +41,20 @@ describe('MockMessaging', function() {
     });
   });
 
+  describe('#on', function() {
+    it('throws if callback is not a function', function() {
+      expect(function() {
+        messaging.on('send', 'not a function');
+      }).to.throw();
+    });
+
+    it('registers a callback', function() {
+      var callback = function() {};
+      messaging.on('send', callback);
+      expect(messaging.callbacks.send).to.be.eql(callback);
+    });
+  });
+
   describe('#send', function() {
     it('should check that message is not undefined', function() {
       expect(function() {
@@ -84,6 +98,19 @@ describe('MockMessaging', function() {
         done(err);
       });
     });
+
+    it('invokes callback with args', function(done) {
+      var message = {
+        message: 'foo'
+      };
+      messaging.on('send', function(args) {
+        expect(args).to.have.lengthOf(1);
+        expect(args[0]).to.be.eql(message);
+        done();
+      });
+      messaging.send(message);
+      messaging.flush();
+    });
   });
 
   describe('#sendAll', function() {
@@ -135,6 +162,17 @@ describe('MockMessaging', function() {
         done(err);
       });
     });
+
+    it('invokes callback with args', function(done) {
+      var message = [{message: 'foobar'}];
+      messaging.on('sendAll', function(args) {
+        expect(args).to.have.lengthOf(1);
+        expect(args[0]).to.be.eql(message);
+        done();
+      });
+      messaging.sendAll(message);
+      messaging.flush();
+    });
   });
 
   describe('#sendMulticast', function() {
@@ -195,5 +233,16 @@ describe('MockMessaging', function() {
         done(err);
       });
     });
+
+    it('invokes callback with args', function(done) {
+      var message = {message: 'foobar', tokens: ['t1']};
+      messaging.on('sendMulticast', function(args) {
+        expect(args).to.have.lengthOf(1);
+        expect(args[0]).to.be.eql(message);
+        done();
+      });
+      messaging.sendMulticast(message);
+      messaging.flush();
+    });
   });
 });

tutorials/admin/messaging.md

@@ -89,4 +89,39 @@ result.then(function (res) {
   console.assert(res.failureCount === 1, '1 message failed');
   console.assert(res.successCount === 1, '1 message succeeded');
 });
+```
+
+## Assert arguments
+If you want to assert the arguments that were passed to any of the send-functions you can register a callback.
+
+##### Source
+
+```js
+var ref;
+var messageService = {
+  messaging: function () {
+    if (!ref) ref = firebase.messaging();
+    return ref;
+  },
+  send: function () {
+    var message = {
+      data: {
+        foo: 'bar'
+      },
+      ...
+    };
+    messageService.ref().send();
+  },
+}
+```
+
+##### Test
+
+```js
+MockFirebase.override();
+messageService.ref().on('send', function(args) {
+  console.assert(args.data.foo === 'bar', 'message is coorect');
+});
+messageService.send();
+messageService.messaging().flush();
 ```