chat-platform 1.2.1 → 1.3.1

package/chat-platform.js

@@ -44,6 +44,7 @@ const ChatExpress = function(options) {
     transportDescription: null,
     chatIdKey: null,
     userIdKey: null,
+    messageIdKey: null,
     tsKey: null,
     debug: true,
     onStart: null,
@@ -84,7 +85,7 @@ const ChatExpress = function(options) {
   }
 
   function evaluateParam(payload, newKey, optionKey, chatServer) {
-    var options = _this.options;
+    const options = _this.options;
     if (options[optionKey] != null) {
       if (_.isString(options[optionKey]) && newKey != options[optionKey]) {
         payload[newKey] = payload[options[optionKey]];
@@ -111,6 +112,7 @@ const ChatExpress = function(options) {
 
     evaluateParam(payload, 'chatId', 'chatIdKey', chatServer);
     evaluateParam(payload, 'userId', 'userIdKey', chatServer);
+    evaluateParam(payload, 'messageId', 'messageIdKey', chatServer);
     evaluateParam(payload, 'ts', 'tsKey', chatServer);
     evaluateParam(payload, 'type', 'type', chatServer);
     evaluateParam(payload, 'language', 'language', chatServer);
@@ -118,7 +120,7 @@ const ChatExpress = function(options) {
     // on removing this constraint (some chat context may be lost)
     payload.userId = !_.isEmpty(payload.userId) ? payload.userId : payload.chatId;
     // evaluate callbacks
-    var callbacks = chatServer.getCallbacks();
+    const callbacks = chatServer.getCallbacks();
     _(['chatId', 'userId', 'ts', 'type', 'language', 'messageId']).each(function(callbackName) {
       if (_.isFunction(callbacks[callbackName])) {
         payload[callbackName] = callbacks[callbackName].call(chatServer, payload)
@@ -213,7 +215,8 @@ const ChatExpress = function(options) {
   }
 
   function inboundMessage(payload, chatServer) {
-    var contextProvider = chatServer.getOptions().contextProvider;
+    const options = chatServer.getOptions();
+    const contextProvider = options.contextProvider;
     if (chatServer.isDebug()) {
       // eslint-disable-next-line no-console
       console.log(orange('-- INBOUND MESSAGE --'));
@@ -243,7 +246,8 @@ const ChatExpress = function(options) {
         messageId: parsedMessage.messageId,
         transport: parsedMessage.transport,
         language: parsedMessage.language,
-        ts: parsedMessage.ts
+        ts: parsedMessage.ts,
+        chatbotId: options.chatbotId
       }),
       payload: {
         type: parsedMessage.type,
@@ -257,7 +261,12 @@ const ChatExpress = function(options) {
         return contextProvider.get(
           parsedMessage.chatId,
           parsedMessage.userId,
-          { userId: this.originalMessage.userId, transport: this.originalMessage.transport, chatId: this.originalMessage.chatId }
+          {
+            userId: this.originalMessage.userId,
+            transport: this.originalMessage.transport,
+            chatId: this.originalMessage.chatId,
+            chatbotId: this.originalMessage.chatbotId
+          }
         );
       },
       api: function() {
@@ -280,7 +289,12 @@ const ChatExpress = function(options) {
         .then(() => when(contextProvider.getOrCreate(
           parsedMessage.chatId,
           parsedMessage.userId,
-          { userId: parsedMessage.userId, transport: parsedMessage.transport, chatId: parsedMessage.chatId }
+          {
+            userId: parsedMessage.userId,
+            transport: parsedMessage.transport,
+            chatId: parsedMessage.chatId,
+            chatbotId: options.chatbotId
+          }
         )))
         .then(chatContext => when(chatContext.set({ language: parsedMessage.language, authorized: false, pending: false })))
         .then(function() {
@@ -424,9 +438,7 @@ const ChatExpress = function(options) {
     }
 
     // create empty promise
-    let stack = new Promise(function(resolve) {
-      resolve(message);
-    });
+    let stack = new Promise(resolve => resolve(message));
     // check for chatId, if not present check for userId-chatId translator, otherwise fail
     stack = stack.then(message => {
       const { transport } = instanceOptions;
@@ -533,15 +545,21 @@ const ChatExpress = function(options) {
     });
     // finally
     return stack
+      .then(function(message) {
+        // move the sent payload to the conventional key "sentMessage", it's up to middleware to
+        // update there the messageId
+        message.sentMessage = message.payload;
+        delete message.payload;
+        return message;
+      })
       .catch(function(error) {
         // eslint-disable-next-line no-console
         console.log(red(error));
         if (chatServer != null) {
           chatServer.emit('error', error);
         }
-      })
-      .then(function(message) {
-        return message;
+        // rethrow error so it can be caught by the sender node
+        throw error;
       });
   }
 
@@ -590,7 +608,7 @@ const ChatExpress = function(options) {
         }
         if (RED.httpNode._router.stack.length >= routesCount) {
           // eslint-disable-next-line no-console
-          chatServer.error('improperly removed some routes, this will cause unexpected results and tricky bugs');
+          chatServer.warning('Improperly removed some routes from Express. This is normal when multiple bots are running in the same server.');
         }
       }
     }
@@ -783,6 +801,12 @@ const ChatExpress = function(options) {
           console.log(red(text));
           this.emit('error', text);
         };
+        this.warning = function(msg) {
+          var text = '[' + options.transport.toUpperCase() + '] ' + msg;
+          // eslint-disable-next-line no-console
+          console.log(red(text));
+          this.emit('warning', text);
+        };
         this.log = function(obj) {
           // eslint-disable-next-line no-console
           console.log(prettyjson.render(obj));

package/index.js

@@ -1,30 +1,6 @@
-const fs = require('fs');
-const clc = require('cli-color');
-const orange = clc.xterm(214);
-const grey = clc.blackBright;
-const green = clc.greenBright;
-const red = clc.red;
-
 const ChatExpress = require('./chat-platform');
 const ContextProviders = require('./chat-context-factory');
 const ChatLog = require('./chat-log');
 const UniversalPlatform = require('./universal');
 
-const jsonPackage = fs.readFileSync(`${__dirname}/package.json`);
-let version;
-try {
-  const pack= JSON.parse(jsonPackage);
-  version = pack.version;
-} catch(e) {
-  // eslint-disable-next-line no-console
-  console.log(red('Unable to open node-red-contrib-chatbot/package.json'));
-}
-
-// eslint-disable-next-line no-console
-console.log(orange('Initializing chat-platform lib, you should see this only once'));
-// eslint-disable-next-line no-console
-console.log(grey('Running at: ' + __dirname) + ' Version: ' + green(version));
-// eslint-disable-next-line no-console
-console.log('');
-
 module.exports = { ChatExpress, ContextProviders, ChatLog, UniversalPlatform };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chat-platform",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Universal Chat Platform",
   "main": "index.js",
   "scripts": {

package/providers/memory.js

@@ -4,12 +4,12 @@ const _storeUserIds = {};
 
 const isEmpty = value => value == null || value === '';
 
-function MemoryStore(chatId, userId, statics = {}) {
+function MemoryStore(chatId, userId, statics = {}, warnings = false) {
   this.chatId = chatId != null ? String(chatId) : null;
   this.userId = userId != null ? String(userId) : null;
   // make sure userId is always a string
   this.statics = Object.assign({}, statics, { userId: statics.userId != null ? String(statics.userId) : undefined  });
-  if (_.isEmpty(statics)) {
+  if (warnings && _.isEmpty(statics)) {
     console.trace('Warning: empty statics vars')
   }
   return this;

package/providers/plain-file.js

@@ -171,13 +171,13 @@ _.extend(FileFactory.prototype, {
 });
 
 //function FileStore(defaults, file, statics = {}) {
-function FileStore(chatId, userId, statics = {}, params) {
+function FileStore(chatId, userId, statics = {}, params, warnings = false) {
   this.userId = userId;
   this.chatId = chatId;
   this.params = params;
   // make sure userId is always a string
   this.statics = Object.assign({}, statics, { userId: statics.userId != null ? String(statics.userId) : undefined });
-  if (_.isEmpty(statics)) {
+  if (warnings && _.isEmpty(statics)) {
     console.trace('Warning: empty statics vars')
   }
   return this;

package/providers/sqlite.js

@@ -13,12 +13,12 @@ const isEmpty = value => value == null || value === '';
 
 
 
-function SQLiteStore(chatId, userId, statics = {}) {
+function SQLiteStore(chatId, userId, statics = {}, warnings = false) {
   this.chatId = chatId != null ? String(chatId) : null;
   this.userId = userId != null ? String(userId) : null;
   // make sure userId is always a string
   this.statics = Object.assign({}, statics, { userId: statics.userId != null ? String(statics.userId) : undefined  });
-  if (_.isEmpty(statics)) {
+  if (warnings && _.isEmpty(statics)) {
     console.trace('Warning: empty statics vars')
   }
   return this;