@tiledesk/tiledesk-whatsapp-connector 0.1.53 → 0.1.55

package/index.js

@@ -11,6 +11,7 @@ const { v4: uuidv4 } = require('uuid');
 const cors = require('cors');
 var winston = require('./winston');
 const url = require('url');
+const mongoose = require('mongoose');
 
 //const ext = require('./routes/ext')
 //const extRoute = ext.router;
@@ -27,6 +28,7 @@ const { TiledeskAppsClient } = require('./tiledesk/TiledeskAppsClient');
 const { MessageHandler } = require('./tiledesk/MessageHandler');
 const { TiledeskBotTester } = require('./tiledesk/TiledeskBotTester');
 const { TemplateManager } = require('./tiledesk/TemplateManager');
+const { WhatsappLogger } = require('./tiledesk/WhatsappLogger');
 
 // mongo
 const { KVBaseMongo } = require('./tiledesk/KVBaseMongo');
@@ -58,6 +60,9 @@ let REDIS_HOST = null;
 let REDIS_PORT = null;
 let REDIS_PASSWORD = null;
 let BASE_FILE_URL = null;
+let AMQP_MANAGER_URL = null;
+let JOB_TOPIC_EXCHANGE = null;
+
 
 // Handlebars register helpers
 handlebars.registerHelper('isEqual', (a, b) => {
@@ -779,13 +784,13 @@ router.post('/tiledesk', async (req, res) => {
       twClient.sendMessage(phone_number_id, whatsappJsonMessage).then((response) => {
         winston.verbose("(wab) Message sent to WhatsApp! " + response.status + " " + response.statusText);
       }).catch((err) => {
-        res.status(400).send({ success: false, error: "il template non esiste" });
         winston.error("(wab) error send message: ", err);
+        res.status(400).send({ success: false, error: "Template not existing" });
       })
 
     } else {
-      res.status(400).send({ success: false, error: "il template non esiste" });
       winston.error("(wab) Whatsapp Json Message is undefined!")
+      res.status(400).send({ success: false, error: "An error occurred during message translation" });
     }
 
   } else {
@@ -1038,6 +1043,29 @@ router.post("/webhook/:project_id", async (req, res) => {
 
       }
     }
+
+    if (req.body.entry &&
+        req.body.entry[0].changes &&
+        req.body.entry[0].changes[0] &&
+        req.body.entry[0].changes[0].value.statuses &&
+        req.body.entry[0].changes[0].value.statuses[0]
+    ) {
+      let whatsappStatusMessage = req.body.entry[0].changes[0].value.statuses[0];
+      winston.verbose("(wab) whatsappStatusMessage: ", whatsappStatusMessage);
+
+      let message_id = whatsappStatusMessage.id;
+      let status = whatsappStatusMessage.status;
+      let error = null;
+      if (whatsappStatusMessage.errors) {
+        error = whatsappStatusMessage.errors[0].title;
+      }
+      winston.verbose("(wab) update status in " + status+ " for message_id " + message_id);
+
+      const wl = new WhatsappLogger();
+      wl.updateMessageStatus(message_id, status, error);
+
+    }
+    
     res.sendStatus(200);
 
   } else {
@@ -1324,6 +1352,26 @@ async function startApp(settings, callback) {
     winston.info("(wab) Missing redis parameters --> Test it out on WhatsApp disabled");
   }
 
+  if (!settings.AMQP_MANAGER_URL) {
+    winston.error("(wab) AMQP_MANAGER_URL is mandatory (?). Exit...");
+  } else {
+    AMQP_MANAGER_URL = settings.AMQP_MANAGER_URL;
+    winston.info("(wab) AMQP_MANAGER_URL is present");
+  }
+
+  if (!settings.JOB_TOPIC_EXCHANGE) {
+    winston.warning("(wab) JOB_TOPIC_EXCHANGE should be present. Using default value");
+    JOB_TOPIC_EXCHANGE = "tiledesk-whatsapp";
+  } else {
+    JOB_TOPIC_EXCHANGE = settings.JOB_TOPIC_EXCHANGE;
+    winston.info("(wab) JOB_TOPIC_EXCHANGE is present");
+  }
+  
+  mongoose.connect(process.env.MONGODB_URL)
+          .then(() => { winston.info("Mongoose DB Connected") })
+          .catch((err) => { winston.error("(Mongoose) Unable to connect with MongoDB ", err)
+  })
+
   db.connect(settings.MONGODB_URL, () => {
     winston.info("(wab) KVBaseMongo successfully connected.");
 
@@ -1336,7 +1384,9 @@ async function startApp(settings, callback) {
     DB: db,
     API_URL: API_URL,
     GRAPH_URL: GRAPH_URL,
-    BASE_FILE_URL: BASE_FILE_URL
+    BASE_FILE_URL: BASE_FILE_URL,
+    AMQP_MANAGER_URL: AMQP_MANAGER_URL,
+    JOB_TOPIC_EXCHANGE: JOB_TOPIC_EXCHANGE,
   }, (err) => {
     if (!err) {
       winston.info("(wab) API route successfully started.")

package/models/WhatsappLog.js

@@ -0,0 +1,36 @@
+const mongoose = require('mongoose');
+
+const MessageLogSchema = mongoose.Schema({
+  json_message: {
+    type: Object,
+    required: true
+  },
+  transaction_id: {
+    type: String,
+    required: true
+  },
+  message_id: {
+    type: String,
+    required: false
+  },
+  status: {
+    type: String,
+    required: true
+  },
+  status_code: {
+    type: Number,
+    required: true
+  },
+  error: {
+    type: String
+  },
+  timestamp: {
+    type: Date,
+    default: Date.now
+  }
+})
+
+
+const MessageLog = mongoose.model("MessageLog", MessageLogSchema);  
+
+module.exports = { MessageLog };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-whatsapp-connector",
-  "version": "0.1.53",
+  "version": "0.1.55",
   "description": "Tiledesk Whatsapp connector",
   "main": "index.js",
   "scripts": {
@@ -19,6 +19,7 @@
     "express": "^4.18.1",
     "form-data": "^4.0.0",
     "handlebars": "^4.7.7",
+    "jobs-worker-queued": "^0.0.5",
     "jsonwebtoken": "^8.5.1",
     "mongoose": "^6.5.0",
     "mongodb": "^3.5.5",

package/routes/api.js

@@ -6,11 +6,13 @@ const router = express.Router({ mergeParams: true });
 const { TemplateManager } = require('../tiledesk/TemplateManager');
 const { TiledeskWhatsappTranslator } = require('../tiledesk/TiledeskWhatsappTranslator');
 const { TiledeskWhatsapp } = require('../tiledesk/TiledeskWhatsapp');
+const { Scheduler } = require('../tiledesk/Scheduler');
 
 let db = null;
 let API_URL = null;
 let GRAPH_URL = null;
 let BASE_FILE_URL = null;
+let AMQP_MANAGER_URL = null;
 
 router.get('/', async (req, res) => {
   res.status(200).send({ message: "API route works"})
@@ -125,14 +127,19 @@ router.get("/templates/:project_id", async (req, res) => {
 
 router.post('/tiledesk/broadcast', async (req, res) => {
   winston.verbose("(wab) Action received from Tiledesk (Broadcast)");
-  winston.debug("Body (broadcast): ",JSON.stringify(req.body, null, 2));
+  winston.debug("Body (broadcast): ", JSON.stringify(req.body, null, 2));
 
   let body = req.body;
 
   let project_id = body.id_project;
   let receiver_list = body.receiver_list;
-  let phone_number_id = body. phone_number_id;
+  let phone_number_id = body.phone_number_id;
   let template = body.template;
+  let transaction_id = body.transaction_id;
+
+  if (!transaction_id) {
+    transaction_id = "tiledesk-broadcast-" + Date.now();
+  }
 
   let CONTENT_KEY = "whatsapp-" + project_id;
   let settings = await db.get(CONTENT_KEY);
@@ -145,51 +152,22 @@ router.post('/tiledesk/broadcast', async (req, res) => {
     return res.status(400).send({ success: false, error: "Missing parameter 'WhatsApp Business Account ID'. Please update your app."})
   }
 
-  const tm = new TemplateManager({ token: settings.wab_token, business_account_id: settings.business_account_id, GRAPH_URL: GRAPH_URL })
-  const tlr = new TiledeskWhatsappTranslator();
-  const twClient = new TiledeskWhatsapp({ token: settings.wab_token, GRAPH_URL: GRAPH_URL, API_URL: API_URL, BASE_FILE_URL: BASE_FILE_URL });
-  
-  let response = await tm.getTemplates();
-  let templates = response.data;
+  let scheduler = new Scheduler({ AMQP_MANAGER_URL: AMQP_MANAGER_URL, JOB_TOPIC_EXCHANGE: JOB_TOPIC_EXCHANGE });
+  let data_To_scheduler = { 
+    project_id: project_id, 
+    receiver_list: receiver_list, 
+    phone_number_id: phone_number_id, 
+    transaction_id: transaction_id,
+    template: template, 
+    settings: settings 
+  };
 
-  let selected_template = templates.find(t => t.name === template.name);
-  let params_object = await tm.generateParamsObject(selected_template);
+  winston.debug('(wab) data_To_scheduler: ', data_To_scheduler);
 
-  // Send messages
-  let messages_sent = 0;
-  let errors = [];
-  let error_count = 0;
+  let schedulerResult = await scheduler.goSchedule(data_To_scheduler);
+  winston.verbose('(wab) schedulerResult: ', schedulerResult);
 
-  if (receiver_list) {
-    let i = 0;
-    async function execute(receiver) {
-      let whatsappJsonMessage = await tlr.createTemplateMessage(selected_template, receiver, params_object);
-      winston.debug("(wab) whatsappJsonMessage: ", JSON.stringify(whatsappJsonMessage, null, 2));
-
-      await twClient.sendMessage(phone_number_id, whatsappJsonMessage).then((response) => {
-        winston.verbose("(wab) Message sent to WhatsApp! " + response.status + " " + response.statusText);
-        messages_sent += 1;
-        i += 1;
-        if (i < receiver_list.length) {
-            execute(receiver_list[i])
-        } else {
-          winston.debug("(wab) End of list")
-          return res.status(200).send({ success: true, message: "Broadcast terminated", messages_sent: messages_sent, errors: errors });
-        }
-      }).catch((err) => {
-        winston.error("(wab) error send message: " + err.response.data.error.message);
-        errors.push({ receiver: receiver.phone_number, error: err.response.data.error.message });
-        i += 1;
-        if (i < receiver_list.length) {
-            execute(receiver_list[i])
-        } else {
-          winston.debug("(wab) End of list")
-          return res.status(200).send({ success: true, message: "Broadcast terminated", messages_sent: messages_sent, errors: errors });
-        }
-      })
-    }
-    execute(receiver_list[0]);
-  }
+  res.status(200).send({ success: true, message: "Job started. Send messages in queue." })
   
 })
 
@@ -230,7 +208,19 @@ async function startRoute(settings, callback) {
     winston.info("(wab api) BASE_FILE_URL: " + BASE_FILE_URL);
   }
 
-  
+  if (!settings.AMQP_MANAGER_URL) {
+    winston.error("(wab api) AMQP_MANAGER_URL is mandatory (?). Exit...");
+  } else {
+    AMQP_MANAGER_URL = settings.AMQP_MANAGER_URL;
+    winston.info("(wab api) AMQP_MANAGER_URL is present");
+  }
+
+  if (!settings.JOB_TOPIC_EXCHANGE) {
+    winston.error("(wab api) JOB_TOPIC_EXCHANGE is mandatory (?). Exit...");
+  } else {
+    JOB_TOPIC_EXCHANGE = settings.JOB_TOPIC_EXCHANGE;
+    winston.info("(wab api) JOB_TOPIC_EXCHANGE is present");
+  }
   
 }
 

package/template/detail.html

@@ -216,35 +216,36 @@
 
     <div style="width: 100%; display: flex; flex-direction: row; justify-content: space-between; margin-bottom: 15px;">
       <div>
+        <p>Added Messages Logs for WhatsApp broadcast</p>
+        <p>Added Queue Manager for Whatsapp broadcast</p>
         <p>Bug fixes and performance improvements</p>
       </div>
-      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.53</b></p>
+      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.55</b></p>
     </div>
-
+    
     <div style="width: 100%; display: flex; flex-direction: row; justify-content: space-between; margin-bottom: 15px;">
       <div>
         <p>Bug fixes and performance improvements</p>
       </div>
-      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.52</b></p>
+      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.53</b></p>
     </div>
 
     <div style="width: 100%; display: flex; flex-direction: row; justify-content: space-between; margin-bottom: 15px;">
       <div>
-        <p style="margin-bottom: 0px">Bug fixes</p>
-        <!--<p>Bug fixes and performance improvements</p>-->
+        <p>Bug fixes and performance improvements</p>
       </div>
-      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.50</b></p>
+      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.52</b></p>
     </div>
 
     <div style="width: 100%; display: flex; flex-direction: row; justify-content: space-between; margin-bottom: 15px;">
       <div>
-        <p style="margin-bottom: 0px">Added support for WhatsApp voice messages</p>
-        <p style="margin-bottom: 0px">Bug fixes and minor improvements</p>
+        <p style="margin-bottom: 0px">Bug fixes</p>
         <!--<p>Bug fixes and performance improvements</p>-->
       </div>
-      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.49</b></p>
+      <p style="font-size: 12px; color: #676767; margin-bottom: 0px;">Version <b>0.1.50</b></p>
     </div>
 
+    
     <hr style="margin-top: 50px; margin-bottom: 20px">
 
   <script>   

package/tiledesk/Scheduler.js

@@ -0,0 +1,48 @@
+var JobManager = require("jobs-worker-queued");
+var winston = require('../winston');
+var jobManager;
+
+class Scheduler {
+
+  constructor(config) {
+    if (!config) {
+      throw new Error('config is mandatory');
+    }
+
+    if (!config.AMQP_MANAGER_URL) {
+      throw new Error('config.AMQP_MANAGER_URL is mandatory');
+    }
+
+    if (!config.JOB_TOPIC_EXCHANGE) {
+      throw new Error('config.JOB_TOPIC_EXCHANGE is mandatory');
+    }
+
+    this.AMQP_MANAGER_URL = config.AMQP_MANAGER_URL;
+    this.JOB_TOPIC_EXCHANGE = config.JOB_TOPIC_EXCHANGE;
+    
+    this.log = false;
+    if (config.log) {
+      this.log = config.log;
+    }
+
+    jobManager = new JobManager(this.AMQP_MANAGER_URL, {
+      debug: false,
+      topic: this.JOB_TOPIC_EXCHANGE,
+      exchange: this.JOB_TOPIC_EXCHANGE
+    });
+  }
+
+  async goSchedule(mydata) {
+    mydata.date = new Date();
+    try {
+      winston.debug("(wab) Data arrived to scheduler: ", mydata);
+      jobManager.publish(mydata);
+      return { success: true, msg: 'scheduling success!' };
+    } catch (err) {
+      winston.error('(wab) scheduling error ', err);
+      return { success: false, msg: 'Error in scheduling' };
+    }
+  }
+}
+
+module.exports = { Scheduler };

package/tiledesk/WhatsappLogger.js

@@ -0,0 +1,48 @@
+const winston = require("../winston");
+const { MessageLog } = require("../models/WhatsappLog");
+
+class WhatsappLogger {
+
+  constructor() {}
+
+  async updateMessageStatus(message_id, status, error) {
+    let status_code = this.getCodeFromStatus(status);
+    winston.debug("(wab) getCodeFromStatus result " + status_code);
+
+    MessageLog.findOneAndUpdate({ message_id: message_id }, { $set: {status: status, status_code: status_code, error: error }}, { new: true }).then((messageLog) => {
+      winston.verbose("(wab) status of message_id " + message_id + " updated to " + status);
+      winston.debug("(wab) messageLog updated ", messageLog);
+    }).catch((err) => {
+      winston.error("(wab) findOneAndUpdate error: ", err);
+    })
+
+  }
+
+  getCodeFromStatus(status) {
+    let code = null;
+    switch (status) {
+      case "rejected":
+        code = -1;
+        break;
+      case "accepted":
+        code = 0;
+        break;
+      case "sent":
+        code = 1;
+        break;
+      case "delivered":
+        code = 2;
+        break;
+      case "read":
+        code = 3;
+        break;
+      default:
+        code = -2;
+        break;
+    }
+    return code;
+  }
+
+}
+
+module.exports = { WhatsappLogger };