@miso.ai/client-sdk-dev-tool 1.13.2-beta.1 → 1.14.0-beta.3

package/dist/cjs/debug.js

@@ -8,6 +8,12 @@ var _logs = require("./logs.js");
 const _excluded = ["groupName", "apiName", "url", "bulk"];
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 const ID = 'std:debug';
+
+// the item subworkflow contexts emit per item (one workflow per thread of
+// the list, per message of the conversation), which floods the console.
+// Muted paths stay out of the console only: they are still preserved for
+// the log dump. Configurable via the `mute` option (`mute: []` shows all)
+const DEFAULT_MUTE = Object.freeze(['workflow/thread-items', 'workflow/message-items']);
 class DebugPlugin {
   constructor(options = {}) {
     this._options = options;
@@ -56,6 +62,10 @@ class DebugPlugin {
             }));
             return;
         }
+        if (path.length === 1 && (name === 'workflow' || name === 'postworkflow')) {
+          this._handleClientWorkflowEvent(name, data);
+          return;
+        }
         break;
       case 'plugins':
         if (path.length === 1) {
@@ -80,7 +90,12 @@ class DebugPlugin {
     const pathname = new URL(url).pathname;
     const args = ['api', eventName];
     bulk && args.push(`(bulk ${bulk.bulkId})`);
-    args.push(`POST ${pathname}`);
+
+    // the api helpers' fetch defaults to POST when no method is specified
+    const {
+      method = 'POST'
+    } = data.options || {};
+    args.push(`${method} ${pathname}`);
     if (groupName === 'interactions') {
       // TODO: handle multiple interactions
       const record = data.payload.data[0];
@@ -109,8 +124,18 @@ class DebugPlugin {
     }
     this._log('plugins', eventName, `${plugin.id || '(anonymous)'}`, [plugin, ...data]);
   }
+
+  // a workflow's creation events on the client follow its context: the
+  // workflows of a muted context (the item subworkflows) are muted as well
+  _handleClientWorkflowEvent(name, workflow) {
+    const context = workflow && workflow._context;
+    const silent = !!context && this._isMuted(_joinPath(_pluginComponentPath(context.meta.path)));
+    this._logw('client', name, workflow, {
+      silent
+    });
+  }
   _handlePluginSpecificEvent(pluginId, path, name, data) {
-    this._logw([pluginId, path.join('.')], name, data);
+    this._logw(_pluginComponentPath([pluginId, ...path]), name, data);
   }
   _getPath(component) {
     const path = [];
@@ -119,25 +144,48 @@ class DebugPlugin {
     }
     return path.reverse();
   }
-  _logw(path, name, data) {
+  _logw(path, name, data, options) {
     if (data === undefined) {
-      this._log(path, name);
+      data = [];
     } else if (Array.isArray(data)) {
-      this._log(path, name, ...data.map(_wrapObj));
+      data = data.map(_wrapObj);
     } else {
-      this._log(path, name, _wrapObj(data));
+      data = [_wrapObj(data)];
     }
+    this._logp(path, name, data, options);
   }
   _log(path, name, ...data) {
-    this._logr(_path(path), _name(name), ...data);
+    this._logp(path, name, data);
+  }
+  _logp(path, name, data, {
+    silent = false
+  } = {}) {
+    path = _joinPath(path);
+    this._write([_path(path), _name(name), ...data], {
+      silent: silent || this._isMuted(path)
+    });
   }
   _logr(...data) {
+    this._write(data);
+  }
+  _write(data, {
+    silent = false
+  } = {}) {
     const options = this._options.console || {};
     if (this._options.preserveLog) {
       this._logs._logs.push(data);
     }
+    if (silent) {
+      return;
+    }
     console.log(_tag(options), _style(options), ...data);
   }
+  _isMuted(path) {
+    const {
+      mute = DEFAULT_MUTE
+    } = this._options;
+    return mute.includes(path);
+  }
 }
 exports.default = DebugPlugin;
 function _tag({
@@ -154,7 +202,17 @@ function _style({
 
 // format path
 function _path(path) {
-  return `<${typeof path === 'string' ? path : path.filter(v => v).join('/')}>`;
+  return `<${path}>`;
+}
+
+// the log path of a component under a plugin, off its meta path — which
+// starts at the plugin ([pluginId, ...rest]): the plugins root reaches the
+// plugins as subtrees, not as parents
+function _pluginComponentPath(path) {
+  return [path[0], path.slice(1).join('.')];
+}
+function _joinPath(path) {
+  return typeof path === 'string' ? path : path.filter(v => v).join('/');
 }
 
 // format event name

package/dist/cjs/dry-run.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _commons = require("@miso.ai/commons");
+const {
+  GROUP,
+  NAME
+} = _commons.API;
 const ID = 'std:dry-run';
 class DryRunPlugin {
   constructor(options = {}) {
@@ -19,9 +23,11 @@ class DryRunPlugin {
   // TODO: config({ active })
 
   install(_, {
-    addUrlPass
+    addUrlPass,
+    addPayloadPass
   }) {
     addUrlPass(this._modifyUrl.bind(this));
+    addPayloadPass(this._modifyPayload.bind(this));
   }
   _modifyUrl({
     apiGroup,
@@ -30,5 +36,21 @@ class DryRunPlugin {
   }) {
     return apiGroup === 'interactions' && apiName === 'upload' ? (0, _commons.addUrlParameter)(url, 'dry_run', '1') : url;
   }
+  _modifyPayload({
+    apiGroup,
+    apiName,
+    payload
+  }) {
+    if (!payload) {
+      return payload; // the GET request
+    }
+    // questions (ask) and search (hybrid search) only, for now
+    if (apiGroup === GROUP.ASK && (apiName === NAME.QUESTIONS || apiName === NAME.SEARCH)) {
+      return Object.assign({}, payload, {
+        with_request_history: false
+      });
+    }
+    return payload;
+  }
 }
 exports.default = DryRunPlugin;

package/dist/cjs/lorem.js

@@ -8,7 +8,8 @@ var _commons = require("@miso.ai/commons");
 var _lorem = require("@miso.ai/lorem");
 var _api = _interopRequireDefault(require("@miso.ai/doggoganger/src/api.js"));
 var _fetch = _interopRequireDefault(require("@miso.ai/doggoganger/src/fetch.js"));
-const _excluded = ["seed"];
+var _utils = require("@miso.ai/doggoganger/src/utils.js");
+const _excluded = ["seed", "latency"];
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
 const PLUGIN_ID = 'std:lorem';
@@ -20,14 +21,22 @@ class LoremPlugin {
     this._lorem = (0, _lorem.lorem)();
     this._api = (0, _api.default)();
   }
+
+  /**
+   * `latency` adds a mock request latency to every api call, in the manner
+   * of the doggoganger server's latency middleware: a number of milliseconds
+   * (e.g. 500), or `{ min, max }` for a randomized roll.
+   */
   config(_ref = {}) {
     let {
-        seed
+        seed,
+        latency
       } = _ref,
       options = _objectWithoutPropertiesLoose(_ref, _excluded);
     this._lorem = (0, _lorem.lorem)({
       seed
     });
+    this._latency = latency;
     this._api = (0, _api.default)(options);
   }
   get api() {
@@ -56,8 +65,14 @@ class LoremPlugin {
       }));
     };
   }
-  _fetch(url, options) {
+  async _fetch(url, options) {
+    // the seed is captured before the delay, so the generated content stays
+    // tied to the request order, not the completion order
     const seed = this._lorem.prng.seed();
+    const latency = this._latency;
+    if (latency) {
+      await (0, _utils.delay)(typeof latency === 'number' ? latency : (0, _utils.rollLatency)(latency.min || 0, latency.max || 0));
+    }
     return (0, _fetch.default)(this._api, url, Object.assign({
       seed
     }, options));

package/package.json

@@ -12,8 +12,8 @@
     "access": "public"
   },
   "scripts": {
-    "build:clean": "npx rimraf dist",
-    "build:cjs": "BABEL_ENV=cjs npx babel src --root-mode upward --out-dir dist/cjs",
+    "build:clean": "rimraf dist",
+    "build:cjs": "BABEL_ENV=cjs babel src --root-mode upward --out-dir dist/cjs",
     "build": "npm run build:clean && npm run build:cjs"
   },
   "repository": {
@@ -30,9 +30,9 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.13.2-beta.1",
-    "@miso.ai/doggoganger": "^0.10.0-beta.2",
-    "@miso.ai/lorem": "^0.10.0-beta.2"
+    "@miso.ai/commons": "1.14.0-beta.3",
+    "@miso.ai/doggoganger": "^0.10.0-beta.17",
+    "@miso.ai/lorem": "^0.10.0-beta.17"
   },
-  "version": "1.13.2-beta.1"
+  "version": "1.14.0-beta.3"
 }

package/src/debug.js

@@ -2,6 +2,12 @@ import { Logs } from './logs.js';
 
 const ID = 'std:debug';
 
+// the item subworkflow contexts emit per item (one workflow per thread of
+// the list, per message of the conversation), which floods the console.
+// Muted paths stay out of the console only: they are still preserved for
+// the log dump. Configurable via the `mute` option (`mute: []` shows all)
+const DEFAULT_MUTE = Object.freeze(['workflow/thread-items', 'workflow/message-items']);
+
 export default class DebugPlugin {
 
   constructor(options = {}) {
@@ -55,6 +61,10 @@ export default class DebugPlugin {
             this._handleApiEvent(name, { ...data, groupName: path[2] });
             return;
         }
+        if (path.length === 1 && (name === 'workflow' || name === 'postworkflow')) {
+          this._handleClientWorkflowEvent(name, data);
+          return;
+        }
         break;
       case 'plugins':
         if (path.length === 1) {
@@ -77,7 +87,9 @@ export default class DebugPlugin {
 
     bulk && args.push(`(bulk ${bulk.bulkId})`);
 
-    args.push(`POST ${pathname}`);
+    // the api helpers' fetch defaults to POST when no method is specified
+    const { method = 'POST' } = data.options || {};
+    args.push(`${method} ${pathname}`);
 
     if (groupName === 'interactions') {
       // TODO: handle multiple interactions
@@ -101,8 +113,16 @@ export default class DebugPlugin {
     this._log('plugins', eventName, `${plugin.id || '(anonymous)'}`, [plugin, ...data]);
   }
 
+  // a workflow's creation events on the client follow its context: the
+  // workflows of a muted context (the item subworkflows) are muted as well
+  _handleClientWorkflowEvent(name, workflow) {
+    const context = workflow && workflow._context;
+    const silent = !!context && this._isMuted(_joinPath(_pluginComponentPath(context.meta.path)));
+    this._logw('client', name, workflow, { silent });
+  }
+
   _handlePluginSpecificEvent(pluginId, path, name, data) {
-    this._logw([pluginId, path.join('.')], name, data);
+    this._logw(_pluginComponentPath([pluginId, ...path]), name, data);
   }
 
   _getPath(component) {
@@ -113,28 +133,46 @@ export default class DebugPlugin {
     return path.reverse();
   }
 
-  _logw(path, name, data) {
+  _logw(path, name, data, options) {
     if (data === undefined) {
-      this._log(path, name);
+      data = [];
     } else if (Array.isArray(data)) {
-      this._log(path, name, ...data.map(_wrapObj));
+      data = data.map(_wrapObj);
     } else {
-      this._log(path, name, _wrapObj(data));
+      data = [_wrapObj(data)];
     }
+    this._logp(path, name, data, options);
   }
 
   _log(path, name, ...data) {
-    this._logr(_path(path), _name(name), ...data);
+    this._logp(path, name, data);
+  }
+
+  _logp(path, name, data, { silent = false } = {}) {
+    path = _joinPath(path);
+    this._write([_path(path), _name(name), ...data], { silent: silent || this._isMuted(path) });
   }
 
   _logr(...data) {
+    this._write(data);
+  }
+
+  _write(data, { silent = false } = {}) {
     const options = this._options.console || {};
     if (this._options.preserveLog) {
       this._logs._logs.push(data);
     }
+    if (silent) {
+      return;
+    }
     console.log(_tag(options), _style(options), ...data);
   }
 
+  _isMuted(path) {
+    const { mute = DEFAULT_MUTE } = this._options;
+    return mute.includes(path);
+  }
+
 }
 
 function _tag({ text = 'Miso' } = {}) {
@@ -147,7 +185,18 @@ function _style({ color = '#fff', background = '#334cbb' } = {}) {
 
 // format path
 function _path(path) {
-  return `<${typeof path === 'string' ? path : path.filter(v => v).join('/')}>`;
+  return `<${path}>`;
+}
+
+// the log path of a component under a plugin, off its meta path — which
+// starts at the plugin ([pluginId, ...rest]): the plugins root reaches the
+// plugins as subtrees, not as parents
+function _pluginComponentPath(path) {
+  return [path[0], path.slice(1).join('.')];
+}
+
+function _joinPath(path) {
+  return typeof path === 'string' ? path : path.filter(v => v).join('/');
 }
 
 // format event name

package/src/dry-run.js

@@ -1,4 +1,6 @@
-import { addUrlParameter } from '@miso.ai/commons';
+import { API, addUrlParameter } from '@miso.ai/commons';
+
+const { GROUP, NAME } = API;
 
 const ID = 'std:dry-run';
 
@@ -16,12 +18,24 @@ export default class DryRunPlugin {
 
   // TODO: config({ active })
 
-  install(_, { addUrlPass }) {
+  install(_, { addUrlPass, addPayloadPass }) {
     addUrlPass(this._modifyUrl.bind(this));
+    addPayloadPass(this._modifyPayload.bind(this));
   }
 
   _modifyUrl({ apiGroup, apiName, url }) {
     return apiGroup === 'interactions' && apiName === 'upload' ? addUrlParameter(url, 'dry_run', '1') : url;
   }
 
+  _modifyPayload({ apiGroup, apiName, payload }) {
+    if (!payload) {
+      return payload; // the GET request
+    }
+    // questions (ask) and search (hybrid search) only, for now
+    if (apiGroup === GROUP.ASK && (apiName === NAME.QUESTIONS || apiName === NAME.SEARCH)) {
+      return { ...payload, with_request_history: false };
+    }
+    return payload;
+  }
+
 }

package/src/lorem.js

@@ -2,6 +2,7 @@ import { isInBrowser } from '@miso.ai/commons';
 import { lorem } from '@miso.ai/lorem';
 import buildApi from '@miso.ai/doggoganger/src/api.js';
 import fetch from '@miso.ai/doggoganger/src/fetch.js';
+import { delay, rollLatency } from '@miso.ai/doggoganger/src/utils.js';
 
 const PLUGIN_ID = 'std:lorem';
 
@@ -16,8 +17,14 @@ export default class LoremPlugin {
     this._api = buildApi();
   }
 
-  config({ seed, ...options } = {}) {
+  /**
+   * `latency` adds a mock request latency to every api call, in the manner
+   * of the doggoganger server's latency middleware: a number of milliseconds
+   * (e.g. 500), or `{ min, max }` for a randomized roll.
+   */
+  config({ seed, latency, ...options } = {}) {
     this._lorem = lorem({ seed });
+    this._latency = latency;
     this._api = buildApi(options);
   }
 
@@ -45,8 +52,14 @@ export default class LoremPlugin {
     };
   }
 
-  _fetch(url, options) {
+  async _fetch(url, options) {
+    // the seed is captured before the delay, so the generated content stays
+    // tied to the request order, not the completion order
     const seed = this._lorem.prng.seed();
+    const latency = this._latency;
+    if (latency) {
+      await delay(typeof latency === 'number' ? latency : rollLatency(latency.min || 0, latency.max || 0));
+    }
     return fetch(this._api, url, { seed, ...options });
   }