wingbot 3.44.0 → 3.44.2

package/package.json

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

package/src/BotApp.js

@@ -28,6 +28,8 @@ const DEFAULT_API_URL = 'https://orchestrator-api.wingbot.ai';
 
 /** @typedef {import('./analytics/onInteractionHandler').IAnalyticsStorage} IAnalyticsStorage */
 /** @typedef {import('./analytics/onInteractionHandler').HandlerConfig} HandlerConfig */
+/** @typedef {import('./analytics/onInteractionHandler').OnEventHandler} OnEventHandler */
+/** @typedef {import('./analytics/onInteractionHandler').Event} Event */
 
 /**
  * @typedef {object} BotAppOptions
@@ -123,6 +125,9 @@ class BotApp {
 
         this._processor.plugin(BotApp.plugin());
         this._preferSynchronousResponse = preferSynchronousResponse;
+
+        /** @type {OnEventHandler[]} */
+        this._eventHandlers = [];
     }
 
     /**
@@ -195,16 +200,43 @@ class BotApp {
 
         analyticsStorage.setDefaultLogger(log);
 
-        const handler = onInteractionHandler({
+        const { onInteraction, onEvent } = onInteractionHandler({
             log,
             anonymize: this._textFilter,
             ...options
         }, analyticsStorage);
 
-        this.processor.on('interaction', handler);
+        this._eventHandlers.push(onEvent);
+        this.processor.on('interaction', onInteraction);
         return this;
     }
 
+    /**
+     * Method for tracking special events
+     *
+     * @param {string} pageId
+     * @param {string} senderId
+     * @param {Event} event
+     * @param {number} [ts]
+     * @param {boolean} [nonInteractive]
+     */
+    async trackEvent (pageId, senderId, event, ts = Date.now(), nonInteractive = false) {
+        const state = this._processor.stateStorage.getState(senderId, pageId);
+
+        if (!state) {
+            throw new Error(`State ${pageId}:${senderId} not found. Ensure the #trackEvent() method was called after the conversation has started`);
+        }
+
+        await Promise.all(this._eventHandlers.map((handler) => handler(
+            pageId,
+            senderId,
+            state.state,
+            event,
+            ts,
+            nonInteractive
+        )));
+    }
+
     _errorResponse (message, status) {
         return {
             statusCode: status,

package/src/analytics/onInteractionHandler.js

@@ -11,7 +11,7 @@ const Ai = require('../Ai');
 
 /**
  * @typedef {object} GAUser
- * @prop {string} id
+ * @prop {string} [id]
  */
 
 /**
@@ -55,6 +55,8 @@ const Ai = require('../Ai');
  * @param {Event[]} events
  * @param {GAUser} [user]
  * @param {number} [ts]
+ * @param {boolean} [nonInteractive]
+ * @param {boolean} [sessionStarted]
  * @returns {Promise}
  */
 
@@ -72,9 +74,9 @@ const Ai = require('../Ai');
  */
 
 /**
- * @callback MetadataExtractor
- * @param {Request} req
- * @returns {object}
+ * @callback UserExtractor
+ * @param {object} state
+ * @returns {object & GAUser}
  */
 
 /**
@@ -99,7 +101,7 @@ const Ai = require('../Ai');
  * @prop {boolean} [throwException] - default false
  * @prop {IGALogger} [log] - console like logger
  * @prop {Anonymizer} [anonymize] - text anonymization function
- * @prop {MetadataExtractor} [extractMetadata] - text anonymization function
+ * @prop {UserExtractor} [userExtractor] - text anonymization function
  */
 
 /**
@@ -108,12 +110,29 @@ const Ai = require('../Ai');
  * @returns {Promise}
  */
 
+/**
+ * @typedef {object} Handlers
+ * @prop {IInteractionHandler} onInteraction
+ * @prop {OnEventHandler} onEvent
+ */
+
+/**
+ * @callback OnEventHandler
+ * @param {string} pageId
+ * @param {string} senderId
+ * @param {object} state
+ * @param {Event} event
+ * @param {number} [timestamp]
+ * @param {boolean} [nonInteractive]
+ * @returns {Promise}
+ */
+
 /**
  *
  * @param {HandlerConfig} config
  * @param {IAnalyticsStorage} analyticsStorage
  * @param {IConfidenceProvider} [ai]
- * @returns {IInteractionHandler}
+ * @returns {Handlers}
  */
 function onInteractionHandler (
     {
@@ -121,7 +140,7 @@ function onInteractionHandler (
         throwException = false,
         log = console,
         anonymize = (x) => x,
-        extractMetadata = (req) => ({}) // eslint-disable-line no-unused-vars
+        userExtractor = (state) => null // eslint-disable-line no-unused-vars
     },
     analyticsStorage,
     ai = Ai.ai
@@ -163,9 +182,7 @@ function onInteractionHandler (
                 const metadata = {
                     sessionCount,
                     lang,
-                    action,
-                    cd1: (req.state.user && req.state.user.department) || 'unknown',
-                    ...extractMetadata(req)
+                    action
                 };
 
                 await analyticsStorage.createUserSession(
@@ -366,7 +383,7 @@ function onInteractionHandler (
                 });
             }
 
-            const user = null;
+            const user = userExtractor(req.state);
 
             await analyticsStorage.storeEvents(
                 pageId,
@@ -375,7 +392,9 @@ function onInteractionHandler (
                 // @ts-ignore
                 events,
                 user,
-                timestamp
+                timestamp,
+                nonInteractive,
+                createSession
             );
         } catch (e) {
             if (throwException) {
@@ -385,7 +404,61 @@ function onInteractionHandler (
         }
     }
 
-    return onInteraction;
+    /**
+     *
+     * @param {string} pageId
+     * @param {string} senderId
+     * @param {object} state
+     * @param {Event} event
+     * @param {number} [timestamp]
+     * @param {boolean} [nonInteractive]
+     */
+    const onEvent = async (
+        pageId,
+        senderId,
+        state,
+        event,
+        timestamp = Date.now(),
+        nonInteractive = false
+    ) => {
+        try {
+            const {
+                _sid: sessionId,
+                lang,
+                lastAction
+            } = state;
+
+            const user = userExtractor(state);
+
+            await analyticsStorage.storeEvents(
+                pageId,
+                senderId,
+                sessionId,
+                [{
+                    // @ts-ignore
+                    lastAction,
+                    ...(analyticsStorage.hasExtendedEvents
+                        ? { lang }
+                        : { cd1: lang }),
+                    ...event
+                }],
+                user,
+                timestamp,
+                nonInteractive,
+                false
+            );
+        } catch (e) {
+            if (throwException) {
+                throw e;
+            }
+            log.error('failed sending logs', e);
+        }
+    };
+
+    return {
+        onInteraction,
+        onEvent
+    };
 }
 
 module.exports = onInteractionHandler;