wingbot 3.67.27 → 3.67.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot",
-  "version": "3.67.27",
+  "version": "3.67.29",
   "description": "Enterprise Messaging Bot Conversation Engine",
   "main": "index.js",
   "type": "commonjs",

package/src/ConversationTester.js

@@ -115,7 +115,7 @@ class ConversationTester {
      * @param {boolean} [options.disableAssertTexts]
      * @param {boolean} [options.disableAssertQuickReplies]
      * @param {boolean} [options.useConversationForTextTestCases]
-     * @param {boolean} [options.textThreshold]
+     * @param {number} [options.textThreshold]
      * @param {number} [options.stepCasesPerStep]
      * @param {number} [options.textCasesPerStep]
      * @param {number} [options.textCaseParallel]
@@ -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,21 +415,29 @@ class ConversationTester {
      * @param {TestsGroup} testsGroup
      * @param {object} [botconfig]
      * @param {string} [lang]
-     * @returns {Tester}
+     * @param {string} [snapshot]
+     * @returns {Promise<Tester>}
      */
-    _createTester (testsGroup, botconfig = null, lang = null) {
-        if (!this._cachedBot) {
-            this._cachedBot = this._botFactory(true);
-            if (botconfig) {
-                this._cachedBot.buildWithSnapshot(botconfig.blocks, Number.MAX_SAFE_INTEGER);
-            }
+    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);
+                    }
+                    return cb;
+                })
+                .catch((e) => { this._cachedBot = null; throw e; });
         }
 
+        const cachedBot = await this._cachedBot;
+
         let t;
         if (typeof this._options.testerFactory === 'function') {
-            t = this._options.testerFactory(this._cachedBot, testsGroup);
+            t = this._options.testerFactory(cachedBot, testsGroup);
         } else {
-            t = new Tester(this._cachedBot);
+            t = new Tester(cachedBot);
             t.allowEmptyResponse = !!this._options.allowEmptyResponse;
         }
 
@@ -434,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 = 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;
@@ -451,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);
@@ -494,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 = this._createTester(testsGroup, botconfig, lang);
+            const t = await this._createTester(testsGroup, botconfig, lang, snapshot);
             let o = '';
             let fail = null;
             // @ts-ignore
@@ -532,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 = 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/conversationTestApi.js

@@ -23,7 +23,7 @@ const ConversationTester = require('../ConversationTester');
  * @param {boolean} [options.disableAssertTexts]
  * @param {boolean} [options.disableAssertQuickReplies]
  * @param {boolean} [options.useConversationForTextTestCases]
- * @param {boolean} [options.textThreshold]
+ * @param {number} [options.textThreshold]
  * @param {number} [options.stepCasesPerStep]
  * @param {number} [options.textCasesPerStep]
  * @param {number} [options.textCaseParallel]

package/src/graphApi/validateBotApi.js

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