feat: add is_room field to messages

Also add TS definitions for `time` and `time_iso`.

Author: dwickr

lib/bot.js

@@ -41,7 +41,7 @@ class WickrBot extends EventEmitter {
     let splitArgs = (s) => s.trim().split(/\s+/)
 
     if (match === null) {
-      return { command: undefined, args: splitArgs(message)}
+      return { command: undefined, args: splitArgs(message) }
     }
 
     let command = match[1]
@@ -51,7 +51,7 @@ class WickrBot extends EventEmitter {
       args = splitArgs(match[2])
     }
 
-    return {command: command, args: args}
+    return { command, args }
   }
 
   _getUsername() {
@@ -94,6 +94,10 @@ class WickrBot extends EventEmitter {
       let handlerName = 'default'
       let args
 
+      // Set the `is_room` value for convenience
+      // The `receiver` field is not present for room messages
+      data.is_room = typeof data.receiver === 'undefined'
+
       if (data.msgtype === MESSAGE_TYPE.FILE && this.fileHandler) {
         handler = this.fileHandler
         handlerName = 'file'
@@ -111,6 +115,7 @@ class WickrBot extends EventEmitter {
 
       if (handler) {
         try {
+          // TODO: we should await this handler to avoid unhandled rejections
           handler(data, args)
         } catch (error) {
           console.warn(`Error executing ${handlerName} handler:`, error)

test/test-wickr-bot.js

@@ -31,7 +31,7 @@ describe('WickrBot', function() {
     bot.listen('foo', spyFn)
     bot.handleMessage()(fakeMsg)
 
-    sinon.assert.calledOnceWithExactly(spyFn, JSON.parse(fakeMsg), ['bar', 'baz'])
+    sinon.assert.calledOnceWithMatch(spyFn, JSON.parse(fakeMsg), ['bar', 'baz'])
   })
 
   describe('#handleMessage', function() {
@@ -53,6 +53,26 @@ describe('WickrBot', function() {
       bot.handleMessage()(fakeMsg)
     })
 
+    it('sets the `is_room` field to `true` on messages sent to a room', function() {
+      let fakeMsg = '{"msgtype": 1000, "message": "/foo@fake-bot bar baz"}'
+      let spyFn = sinon.spy()
+      let bot = new WickrBot(this.wickr, 'foo')
+
+      bot.listen('foo', spyFn)
+      bot.handleMessage()(fakeMsg)
+      sinon.assert.calledOnceWithExactly(spyFn, { is_room: true, ...JSON.parse(fakeMsg) }, ['bar', 'baz'])
+    })
+
+    it('sets the `is_room` field to `false` on messages sent in a 1:1', function() {
+      let fakeMsg = '{"msgtype": 1000, "receiver": "bob", "message": "/foo@fake-bot bar baz"}'
+      let spyFn = sinon.spy()
+      let bot = new WickrBot(this.wickr, 'foo')
+
+      bot.listen('foo', spyFn)
+      bot.handleMessage()(fakeMsg)
+      sinon.assert.calledOnceWithExactly(spyFn, { is_room: false, ...JSON.parse(fakeMsg) }, ['bar', 'baz'])
+    })
+
     it('calls the default listener for non-slash command messages', function() {
       let fakeMsg = '{"msgtype": 1000, "message": "hey what\'s up?"}'
       let spyFn = sinon.spy()
@@ -61,7 +81,7 @@ describe('WickrBot', function() {
       bot.setDefaultHandler(spyFn)
       bot.handleMessage()(fakeMsg)
 
-      sinon.assert.calledOnceWithExactly(spyFn, JSON.parse(fakeMsg), ['hey', 'what\'s', 'up?'])
+      sinon.assert.calledOnceWithMatch(spyFn, JSON.parse(fakeMsg), ['hey', 'what\'s', 'up?'])
     })
 
     it('calls the file handler for files', function() {
@@ -72,7 +92,7 @@ describe('WickrBot', function() {
       bot.setFileHandler(spyFn)
       bot.handleMessage()(fakeMsg)
 
-      sinon.assert.calledOnceWithExactly(spyFn, JSON.parse(fakeMsg), undefined)
+      sinon.assert.calledOnceWithMatch(spyFn, JSON.parse(fakeMsg), undefined)
     })
 
     it('calls the default handler for any message type', function() {
@@ -83,7 +103,7 @@ describe('WickrBot', function() {
       bot.setDefaultHandler(spyFn)
       bot.handleMessage()(fakeMsg)
 
-      sinon.assert.calledOnceWithExactly(spyFn, JSON.parse(fakeMsg), undefined)
+      sinon.assert.calledOnceWithMatch(spyFn, JSON.parse(fakeMsg), undefined)
     })
 
     it('prefers the file handler over the default handler for file type messages', function() {
@@ -95,7 +115,7 @@ describe('WickrBot', function() {
       bot.setDefaultHandler(spyFnDefault)
       bot.handleMessage()(fakeMsg)
 
-      sinon.assert.calledOnceWithExactly(spyFn, JSON.parse(fakeMsg), undefined)
+      sinon.assert.calledOnceWithMatch(spyFn, JSON.parse(fakeMsg), undefined)
       sinon.assert.notCalled(spyFnDefault)
     })
   })

types/bot.d.ts

@@ -27,6 +27,11 @@ export interface WickrMessage {
    */
   message_id: string
 
+  /**
+   * Indicates if the message is a part of a room (true) or a direct message (false)
+   */
+  is_room: boolean
+
   /**
    * Wickr ID of the user who sent the message
    */
@@ -47,6 +52,16 @@ export interface WickrMessage {
    */
   msg_ts: string
 
+  /**
+   * Displayable time message was sent.
+   */
+  time: string
+
+  /**
+   * The time the message was sent in ISO format (YYYY-MM-DD hh:mm:ss.xxx)
+   */
+  time_iso: string
+
   /**
    * For file message types, this contains details about the file
    */