wingbot 3.67.28 → 3.67.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.67.28",
+  "version": "3.67.30",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",
@@ -10,7 +10,7 @@
     "doc": "npm run doc:gql && node ./bin/makeApiDoc.js && cpy ./CHANGELOG.md ./doc && gitbook install ./doc && gitbook build ./doc && rimraf -rf ./docs && rimraf --rf ./doc/CHANGELOG.md && move-cli ./doc/_book ./docs",
     "test": "npm run test:lint && npm run test:coverage && npm run test:coverage:threshold",
     "test:coverage": "nyc --reporter=html mocha ./test && nyc report",
-    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 89 --branches 80",
+    "test:coverage:threshold": "nyc check-coverage --lines 89 --functions 88 --branches 80",
     "test:backend": "mocha ./test",
     "test:lint": "eslint --ext .js src test *.js plugins"
   },

package/src/ConversationTester.js

@@ -134,6 +134,7 @@ class ConversationTester {
         };
         this._output = '';
         this._cachedBot = null;
+        this._cachedBotSnapshot = null;
         this._log = options.log || console;
     }
 
@@ -165,9 +166,10 @@ class ConversationTester {
      * @param {object} validationRequestBody
      * @param {number} [step]
      * @param {string} [lang]
+     * @param {string} [snapshot]
      * @returns {Promise<TestsOutput>}
      */
-    async test (validationRequestBody = null, step = null, lang = null) {
+    async test (validationRequestBody = null, step = null, lang = null, snapshot = null) {
         if (step <= 1) {
             this._cachedBot = null;
         }
@@ -191,10 +193,20 @@ class ConversationTester {
             for (const testsGroup of testsGroups) {
                 let stepResult;
                 if (testsGroup.type === 'texts') {
-                    stepResult = await this._runTextCaseTests(testsGroup, botconfig, lang);
+                    stepResult = await this._runTextCaseTests(
+                        testsGroup,
+                        botconfig,
+                        lang,
+                        snapshot
+                    );
                 }
                 if (testsGroup.type === 'steps') {
-                    stepResult = await this._runStepCaseTests(testsGroup, botconfig, lang);
+                    stepResult = await this._runStepCaseTests(
+                        testsGroup,
+                        botconfig,
+                        lang,
+                        snapshot
+                    );
                 }
                 results.push(stepResult);
             }
@@ -403,11 +415,13 @@ class ConversationTester {
      * @param {TestsGroup} testsGroup
      * @param {object} [botconfig]
      * @param {string} [lang]
+     * @param {string} [snapshot]
      * @returns {Promise<Tester>}
      */
-    async _createTester (testsGroup, botconfig = null, lang = null) {
-        if (!this._cachedBot) {
-            this._cachedBot = Promise.resolve(this._botFactory(true))
+    async _createTester (testsGroup, botconfig = null, lang = null, snapshot = null) {
+        if (!this._cachedBot || this._cachedBotSnapshot !== snapshot) {
+            this._cachedBotSnapshot = snapshot;
+            this._cachedBot = Promise.resolve(this._botFactory(true, snapshot))
                 .then((cb) => {
                     if (botconfig) {
                         cb.buildWithSnapshot(botconfig.blocks, Number.MAX_SAFE_INTEGER);
@@ -440,9 +454,10 @@ class ConversationTester {
      * @param {TestsGroup} testsGroup
      * @param {object} botconfig
      * @param {string} [lang]
+     * @param {string} [snapshot]
      */
-    async _runTextCaseTests (testsGroup, botconfig = null, lang = null) {
-        const t = await this._createTester(testsGroup, botconfig, lang);
+    async _runTextCaseTests (testsGroup, botconfig = null, lang = null, snapshot = null) {
+        const t = await this._createTester(testsGroup, botconfig, lang, snapshot);
         let out = '';
         let passing = 0;
         let longestText = 0;
@@ -457,7 +472,7 @@ class ConversationTester {
 
         const { textCaseParallel } = this._options;
         const runTestCase = (textCase) => this
-            .executeTextCase(testsGroup, t, textCase, botconfig, longestText, lang);
+            .executeTextCase(testsGroup, t, textCase, botconfig, longestText, lang, snapshot);
 
         while (iterate.length > 0) {
             const cases = iterate.splice(0, textCaseParallel);
@@ -500,12 +515,13 @@ class ConversationTester {
      * @param {TestsGroup} testsGroup
      * @param {object} botconfig
      * @param {string} [lang]
+     * @param {string} [snapshot]
      */
-    async _runStepCaseTests (testsGroup, botconfig = null, lang = null) {
+    async _runStepCaseTests (testsGroup, botconfig = null, lang = null, snapshot = null) {
         const out = [];
 
         for (const testCase of testsGroup.testCases) {
-            const t = await this._createTester(testsGroup, botconfig, lang);
+            const t = await this._createTester(testsGroup, botconfig, lang, snapshot);
             let o = '';
             let fail = null;
             // @ts-ignore
@@ -538,10 +554,19 @@ class ConversationTester {
      * @param {*} botconfig
      * @param {number} longestText
      * @param {string} [lang]
+     * @param {string} [snapshot]
      */
-    async executeTextCase (testsGroup, t, textCase, botconfig, longestText, lang = null) {
+    async executeTextCase (
+        testsGroup,
+        t,
+        textCase,
+        botconfig,
+        longestText,
+        lang = null,
+        snapshot = null
+    ) {
         if (this._options.useConversationForTextTestCases) {
-            const tester = await this._createTester(testsGroup, botconfig, lang);
+            const tester = await this._createTester(testsGroup, botconfig, lang, snapshot);
 
             try {
                 await tester.text(textCase.text);

package/src/graphApi/GraphApi.js

@@ -19,6 +19,11 @@ const DEFAULT_CACHE = 86400000; // 24 hours
  * @param {object[]} [errors]
  */
 
+/**
+ * @typedef {object} RequestParams
+ * @param {string} [snapshot]
+ */
+
 /** @typedef {import('../CallbackAuditLog')} AuditLog */
 /** @typedef {import('graphql')} GqlLib */
 
@@ -110,9 +115,10 @@ class GraphApi {
      * @param {string} [headers.Referer]
      * @param {string} [headers.referer]
      * @param {string} [wingbotToken]
+     * @param {RequestParams} [params]
      * @returns {Promise<GraphQlResponse>}
      */
-    async request (body, headers, wingbotToken = undefined) {
+    async request (body, headers, wingbotToken = undefined, params = {}) {
         assert.ok(body && typeof body === 'object', 'GraphQL request should be an object with a request property');
         assert.equal(typeof body.query, 'string', 'GraphQL request should contain a query property');
 
@@ -149,7 +155,8 @@ class GraphApi {
         const ctx = {
             token,
             groups: this._defaultGroups,
-            audit
+            audit,
+            params
         };
 
         const response = await this._gql.graphql({

package/src/graphApi/conversationsApi.js

@@ -4,7 +4,9 @@
 'use strict';
 
 const apiAuthorizer = require('./apiAuthorizer');
-const { apiTextOutputFilter } = require('../utils/deepMapTools');
+const { apiTextOutputFilter, mapObject, defaultMapperFactory } = require('../utils/deepMapTools');
+
+/** @typedef {import('../utils/deepMapTools').Mapper} Mapper */
 
 /**
  * @typedef {object} ConversationsAPI
@@ -47,6 +49,7 @@ const { apiTextOutputFilter } = require('../utils/deepMapTools');
  * @param {string[]|Function} [acl] - limit api to array of groups or use auth function
  * @param {object} options
  * @param {textFilter} [options.stateTextFilter] - optional funcion for filtering data in states
+ * @param {Mapper} [options.mapper] - mapper for state values
  * @returns {ConversationsAPI}
  * @example
  * const { GraphApi, conversationsApi } = require('wingbot');
@@ -106,6 +109,13 @@ function conversationsApi (
             history,
             subscribtions
         });
+    } else if (options.mapper) {
+        mapState = (d) => mapObject({
+            ...d,
+            lastInteraction: d.lastInteraction || (new Date(0)),
+            history,
+            subscribtions
+        }, defaultMapperFactory(options.mapper));
     } else {
         mapState = (d) => ({
             ...d,

package/src/graphApi/validateBotApi.js

@@ -102,7 +102,7 @@ function validateBotApi (botFactory, postBackTest = null, textTest = null, acl =
                 validationRequestBody = decompress(validationRequestBody);
             }
 
-            const bot = await Promise.resolve(botFactory());
+            const bot = await Promise.resolve(botFactory(true, ctx.snapshot));
 
             await ctx.audit('validateBot');
             return validate(bot, validationRequestBody, postBackTest, textTest);

package/src/utils/deepMapTools.js

@@ -23,6 +23,58 @@ function deepEqual (left, right) {
     }
 }
 
+/**
+ * @callback Mapper
+ * @param {string} key
+ * @param {any} val
+ * @param {object} lastObj
+ * @param {string|null} lastKey
+ * @returns {any}
+ */
+
+/**
+ *
+ * @param {Mapper} [otherMapper]
+ * @returns {Mapper}
+ */
+function defaultMapperFactory (otherMapper = null) {
+    return (k, v, o, lk) => {
+        const useV = otherMapper
+            ? otherMapper(k, v, o, lk)
+            : v;
+
+        if (useV instanceof Date) {
+            return v.toISOString();
+        }
+        return useV;
+    };
+}
+
+/**
+ *
+ * @template T
+ * @param {T} obj
+ * @param {Mapper} mapFn
+ * @returns {T}
+ */
+function mapObject (obj, mapFn) {
+    let lastKey = null;
+    let lastObj = obj;
+
+    const str = JSON.stringify(obj, (key, val) => {
+        const ret = mapFn(key, val, lastObj, lastKey);
+
+        if (val && typeof val === 'object') {
+            lastObj = val;
+            lastKey = key || null;
+        }
+
+        return ret;
+    });
+
+    return JSON.parse(str);
+}
+
 function apiTextOutputFilter (obj, callback, prevKey = '') {
     let useKey;
     if (Array.isArray(obj)) {
@@ -59,4 +111,6 @@ function apiTextOutputFilter (obj, callback, prevKey = '') {
     return obj;
 }
 
-module.exports = { apiTextOutputFilter, deepEqual };
+module.exports = {
+    apiTextOutputFilter, deepEqual, mapObject, defaultMapperFactory
+};