wingbot 3.43.0 → 3.44.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.43.0",
+  "version": "3.44.0-alpha.1",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "scripts": {

package/src/Ai.js

@@ -49,6 +49,8 @@ let uq = 1;
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').EntityDetector} EntityDetector */
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').DetectorOptions} DetectorOptions */
 
+/** @typedef {[string,EntityDetector|RegExp,DetectorOptions]} DetectorArgs */
+
 /**
  * @class Ai
  */
@@ -63,7 +65,7 @@ class Ai {
 
         /**
          * @private
-         * @type {Map<string,[string,EntityDetector|RegExp,DetectorOptions]>}
+         * @type {Map<string,DetectorArgs>}
          */
         this._detectors = new Map(
             systemEntities.map((a) => [a[0], a])

package/src/Processor.js

@@ -4,12 +4,13 @@
 'use strict';
 
 const EventEmitter = require('events');
+const crypto = require('crypto');
 const { MemoryStateStorage } = require('./tools');
 const Responder = require('./Responder');
 const Request = require('./Request');
 const Ai = require('./Ai');
 const ReturnSender = require('./ReturnSender');
-const { mergeState } = require('./utils/stateVariables');
+const { mergeState, isUserInteraction } = require('./utils/stateVariables');
 
 /** @typedef {import('./wingbot/CustomEntityDetectionModel').Intent} Intent */
 /** @typedef {import('./ReducerWrapper')} ReducerWrapper */
@@ -84,6 +85,7 @@ const { mergeState } = require('./utils/stateVariables');
  * @prop {string} [secret] - Secret for calling orchestrator API
  * @prop {string} [apiUrl] - Url for calling orchestrator API
  * @prop {Function} [fetch] - Fetch function for calling orchestrator API
+ * @prop {number} [sessionDuration] - Session duration for analytic purposes
  */
 
 /**
@@ -111,6 +113,8 @@ function NAME_FROM_STATE (state) {
     return null;
 }
 
+const MAX_TS = 9999999999999;
+
 /**
  * Messaging event processor
  *
@@ -144,7 +148,8 @@ class Processor extends EventEmitter {
             autoTyping: false,
             autoSeen: false,
             redirectLimit: 20,
-            nameFromState: NAME_FROM_STATE
+            nameFromState: NAME_FROM_STATE,
+            sessionDuration: 1800000 // 30 minutes
         };
 
         Object.assign(this.options, options);
@@ -483,9 +488,10 @@ class Processor extends EventEmitter {
 
         try {
             // ensure the request was not processed
+            const timestamp = message.timestamp || Date.now();
             if (fromEvent
                     && stateObject.lastTimestamps && message.timestamp
-                    && stateObject.lastTimestamps.indexOf(message.timestamp) !== -1) {
+                    && stateObject.lastTimestamps.indexOf(timestamp) !== -1) {
                 throw Object.assign(new Error('Message has been already processed'), { code: 204 });
             }
 
@@ -523,6 +529,40 @@ class Processor extends EventEmitter {
                 configuration
             );
 
+            // process session
+            if (fromEvent) {
+                let {
+                    _sct: sessionCount = 0,
+                    _sid: sessionId = null,
+                    _segStamp: ts = 0,
+                    _snew: sessionCreated
+                } = state;
+
+                if ((isUserInteraction(req)
+                    && (ts + this.options.sessionDuration) < Date.now())
+                        || !sessionId) {
+
+                    sessionId = Processor._createSessionId(req.pageId, req.senderId, timestamp);
+                    sessionCount++;
+                    sessionCreated = true;
+                } else {
+                    sessionCreated = false;
+                }
+
+                ts = timestamp;
+
+                Object.assign(state, {
+                    _sct: sessionCount,
+                    _sid: sessionId,
+                    _segStamp: ts,
+                    _snew: sessionCreated
+                });
+            } else {
+                Object.assign(state, {
+                    _snew: false
+                });
+            }
+
             const features = [
                 ...(this.options.features || []),
                 ...req.features
@@ -650,7 +690,7 @@ class Processor extends EventEmitter {
             let lastTimestamps = stateObject.lastTimestamps || [];
             if (message.timestamp) {
                 lastTimestamps = lastTimestamps.slice(-9);
-                lastTimestamps.push(message.timestamp);
+                lastTimestamps.push(timestamp);
             }
 
             Object.assign(stateObject, {
@@ -698,6 +738,27 @@ class Processor extends EventEmitter {
         }
     }
 
+    static _createSessionId (pageId, senderId, timestamp = Date.now()) {
+        const senderHash = crypto.createHash('shake256', { outputLength: 6 })
+            .update(`${senderId}|${pageId}`)
+            .digest('hex');
+
+        const senderShort = parseInt(senderHash, 16).toString(36);
+
+        const rand = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER)
+            .toString(36);
+
+        const randTS = Math.floor(Date.now() % 1000)
+            .toString(36);
+
+        const ts = Math.floor(MAX_TS - timestamp)
+            .toString(36);
+
+        return `${ts}.${senderShort}`
+            .padEnd(21, randTS)
+            .padEnd(28, rand);
+    }
+
     /**
      *
      * @private
@@ -840,4 +901,6 @@ class Processor extends EventEmitter {
 
 }
 
+Processor._createSessionId('p', 's');
+
 module.exports = Processor;

package/src/resolvers/message.js

@@ -40,6 +40,13 @@ function getVoiceControlFromParams (params, lang = null) {
         }
     });
 
+    // remove empty values ("")
+    Object.keys(voiceControl).forEach((key) => {
+        if (voiceControl[key] === '') {
+            delete voiceControl[key];
+        }
+    });
+
     // if voiceControl is empty, return null
     return Object.keys(voiceControl).length > 0 ? voiceControl : null;
 }

package/src/utils/stateVariables.js

@@ -102,6 +102,17 @@ function checkSetState (setState, newState) {
     }
 }
 
+/**
+ *
+ * @param {Request} req
+ * @returns {boolean}
+ */
+function isUserInteraction (req) {
+    return req.isMessage() || req.isPostBack()
+        || req.isReferral() || req.isAttachment()
+        || req.isTextOrIntent();
+}
+
 /**
  *
  * @private
@@ -115,9 +126,7 @@ function checkSetState (setState, newState) {
 function mergeState (previousState, req, res, senderStateUpdate, firstInTurnover, lastInTurnover) {
     const state = { ...previousState, ...res.newState };
 
-    const isUserEvent = req.isMessage() || req.isPostBack()
-        || req.isReferral() || req.isAttachment()
-        || req.isTextOrIntent();
+    const isUserEvent = isUserInteraction(req);
 
     // reset expectations
     if (isUserEvent && !res.newState._expected) {
@@ -224,5 +233,6 @@ module.exports = {
     VAR_TYPES,
     mergeState,
     vars,
-    checkSetState
+    checkSetState,
+    isUserInteraction
 };