@webex/internal-plugin-dss 3.0.0-beta.136 → 3.0.0-beta.137

package/src/config.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+
+export default {
+  dss: {
+    /**
+     * Debounce wait (ms) before sending a dss request (gap between lookups that will trigger a request)
+     * @type {Number}
+     */
+    batcherWait: 50,
+
+    /**
+     * Maximum queue size before sending a dss request
+     * @type {Number}
+     */
+    batcherMaxCalls: 50,
+
+    /**
+     * Debounce max wait (ms) before sending a dss request (time from first lookup that will trigger a request)
+     * @type {Number}
+     */
+    batcherMaxWait: 150,
+  },
+};

package/src/constants.ts

@@ -12,3 +12,8 @@ export const SEARCH_TYPES = {
   ROOM: 'ROOM',
   ROBOT: 'ROBOT',
 };
+export const LOOKUP_DATA_PATH = 'lookupResult.entities';
+export const LOOKUP_FOUND_PATH = 'lookupResult.entitiesFound';
+export const LOOKUP_NOT_FOUND_PATH = 'lookupResult.entitiesNotFound';
+export const LOOKUP_REQUEST_KEY = 'lookupValues';
+export const SEARCH_DATA_PATH = 'directoryEntities';

package/src/dss-batcher.ts

@@ -0,0 +1,129 @@
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+/* eslint-disable no-underscore-dangle */
+
+import {Batcher} from '@webex/webex-core';
+
+/**
+ * @class
+ */
+const DssBatcher = Batcher.extend({
+  namespace: 'DSS',
+
+  props: {
+    resource: {
+      type: 'string',
+      required: true,
+      setOnce: true,
+      allowNull: false,
+    },
+    dataPath: {
+      type: 'string',
+      required: true,
+      setOnce: true,
+      allowNull: false,
+    },
+    entitiesFoundPath: {
+      type: 'string',
+      required: true,
+      setOnce: true,
+      allowNull: false,
+    },
+    entitiesNotFoundPath: {
+      type: 'string',
+      required: true,
+      setOnce: true,
+      allowNull: false,
+    },
+    requestKey: {
+      type: 'string',
+      required: true,
+      setOnce: true,
+      allowNull: false,
+    },
+  },
+
+  /**
+   * Submits the DSS request
+   * @param {Object} payload
+   * @returns {Promise<Array>}
+   */
+  submitHttpRequest(payload) {
+    return this.parent._request({
+      dataPath: this.dataPath,
+      foundPath: this.entitiesFoundPath,
+      notFoundPath: this.entitiesNotFoundPath,
+      resource: this.resource,
+      params: {
+        lookupValues: payload,
+      },
+    });
+  },
+
+  /**
+   * Actions taken when the http request returns a success
+   * @param {Promise<Array>} res
+   * @returns {Promise<undefined>}
+   */
+  handleHttpSuccess(res) {
+    const successItems = res.foundArray.map((requestValue, index) => ({
+      requestValue,
+      entity: res.resultArray[index],
+    }));
+    const failureItems = res.notFoundArray.map((requestValue) => ({requestValue, entity: null}));
+
+    return Promise.all(successItems.concat(failureItems).map((item) => this.acceptItem(item)));
+  },
+
+  /**
+   * Checks if the item was found
+   * @param {Object} item
+   * @returns {Promise<Boolean>}
+   */
+  didItemFail(item) {
+    return Promise.resolve(item.entity === null);
+  },
+
+  /**
+   * Finds the Defer for the specified item and resolves its promise with null
+   * @param {Object} item
+   * @returns {Promise<undefined>}
+   */
+  handleItemFailure(item) {
+    return this.getDeferredForResponse(item).then((defer) => {
+      defer.resolve(null);
+    });
+  },
+
+  /**
+   * Finds the Defer for the specified item and resolves its promise
+   * @param {Object} item
+   * @returns {Promise<undefined>}
+   */
+  handleItemSuccess(item) {
+    return this.getDeferredForResponse(item).then((defer) => {
+      defer.resolve(item.entity);
+    });
+  },
+
+  /**
+   * Returns a promise with the unique key for the item
+   * @param {Object} item
+   * @returns {Promise}
+   */
+  fingerprintRequest(item) {
+    return Promise.resolve(item);
+  },
+
+  /**
+   * Returns a promise with the unique key for the item
+   * @param {Object} item
+   * @returns {Promise}
+   */
+  fingerprintResponse(item) {
+    return Promise.resolve(item.requestValue);
+  },
+});
+
+export default DssBatcher;

package/src/dss.ts

@@ -22,7 +22,13 @@ import {
   DSS_SERVICE_NAME,
   DSS_SEARCH_MERCURY_EVENT,
   DSS_RESULT,
+  LOOKUP_DATA_PATH,
+  LOOKUP_FOUND_PATH,
+  LOOKUP_NOT_FOUND_PATH,
+  LOOKUP_REQUEST_KEY,
+  SEARCH_DATA_PATH,
 } from './constants';
+import DssBatcher from './dss-batcher';
 
 const DSS = WebexPlugin.extend({
   namespace: 'DSS',
@@ -35,6 +41,18 @@ const DSS = WebexPlugin.extend({
    */
   registered: false,
 
+  /**
+   * Initializer
+   * @private
+   * @param {Object} attrs
+   * @param {Object} options
+   * @returns {undefined}
+   */
+  initialize(...args) {
+    Reflect.apply(WebexPlugin.prototype.initialize, this, args);
+    this.batchers = {};
+  },
+
   /**
    * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.
    * @returns {Promise}
@@ -114,6 +132,7 @@ const DSS = WebexPlugin.extend({
   },
 
   /**
+   * constructs the event name based on request id
    * @param {UUID} requestId the id of the request
    * @returns {string}
    */
@@ -122,6 +141,7 @@ const DSS = WebexPlugin.extend({
   },
 
   /**
+   * Takes incoming data and triggers correct events
    * @param {Object} data the event data
    * @returns {undefined}
    */
@@ -135,39 +155,67 @@ const DSS = WebexPlugin.extend({
    * @param {Object} options
    * @param {string} options.resource the URL to query
    * @param {string} options.params additional params for the body of the request
-   * @param {string} options.dataPath to path to get the data in the result object
-   * @returns {Promise} Resolves with an array of entities found
+   * @param {string} options.dataPath the path to get the data in the result object
+   * @param {string} options.foundPath the path to get the lookups of the found data (optional)
+   * @param {string} options.notFoundPath the path to get the lookups of the not found data (optional)
+   * @returns {Promise<Object>} result Resolves with an object
+   * @returns {Array} result.resultArray an array of entities found
+   * @returns {Array} result.foundArray an array of the lookups of the found entities (if foundPath provided)
+   * @returns {Array} result.notFoundArray an array of the lookups of the not found entities (if notFoundPath provided)
    */
   _request(options) {
-    const {resource, params, dataPath} = options;
+    const {resource, params, dataPath, foundPath, notFoundPath} = options;
 
     const requestId = uuid.v4();
     const eventName = this._getResultEventName(requestId);
     const result = {};
     let expectedSeqNums;
+    let notFoundArray;
 
     return new Promise((resolve) => {
       this.listenTo(this, eventName, (data) => {
-        const resultData = get(data, dataPath);
+        const resultData = get(data, dataPath, []);
+        let found;
 
-        result[data.sequence] = resultData;
+        if (foundPath) {
+          found = get(data, foundPath, []);
+        }
+        result[data.sequence] = foundPath ? {resultData, found} : {resultData};
 
         if (data.finished) {
           expectedSeqNums = range(data.sequence + 1).map(String);
+          if (notFoundPath) {
+            notFoundArray = get(data, notFoundPath, []);
+          }
         }
 
         const done = isEqual(expectedSeqNums, Object.keys(result));
 
         if (done) {
-          const resultArray = [];
+          const resultArray: any[] = [];
+          const foundArray: any[] = [];
+
           expectedSeqNums.forEach((index) => {
             const seqResult = result[index];
+
             if (seqResult) {
-              resultArray.push(...seqResult);
+              resultArray.push(...seqResult.resultData);
+              if (foundPath) {
+                foundArray.push(...seqResult.found);
+              }
             }
           });
-
-          resolve(resultArray);
+          const resolveValue: {resultArray: any[]; foundArray?: any[]; notFoundArray?: any[]} = {
+            resultArray,
+          };
+
+          if (foundPath) {
+            resolveValue.foundArray = foundArray;
+          }
+          if (notFoundPath) {
+            resolveValue.notFoundArray = notFoundArray;
+          }
+          resolve(resolveValue);
           this.stopListening(this, eventName);
         }
       });
@@ -181,59 +229,120 @@ const DSS = WebexPlugin.extend({
     });
   },
 
+  /**
+   * Uses a batcher to make the request to the directory service
+   * @param {Object} options
+   * @param {string} options.resource the URL to query
+   * @param {string} options.value the id or email to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  _batchedLookup(options) {
+    const {resource, lookupValue} = options;
+    const dataPath = LOOKUP_DATA_PATH;
+    const entitiesFoundPath = LOOKUP_FOUND_PATH;
+    const entitiesNotFoundPath = LOOKUP_NOT_FOUND_PATH;
+    const requestKey = LOOKUP_REQUEST_KEY;
+
+    this.batchers[resource] =
+      this.batchers[resource] ||
+      new DssBatcher({
+        resource,
+        dataPath,
+        entitiesFoundPath,
+        entitiesNotFoundPath,
+        requestKey,
+        parent: this,
+      });
+
+    return this.batchers[resource].request(lookupValue);
+  },
+
   /**
    * Retrieves detailed information about an entity
    * @param {Object} options
    * @param {UUID} options.id the id of the entity to lookup
-   * @returns {Promise} Resolves with an array of entities found
+   * @returns {Promise} Resolves with the entity found or null if not found
    */
   lookupDetail(options: LookupDetailOptions) {
     const {id} = options;
 
+    const resource = `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`;
+
     return this._request({
-      dataPath: 'lookupResult.entities',
-      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`,
+      dataPath: LOOKUP_DATA_PATH,
+      foundPath: LOOKUP_FOUND_PATH,
+      resource,
+    }).then(({resultArray, foundArray}) => {
+      // TODO: find out what is actually returned!
+      if (foundArray[0] === id) {
+        return resultArray[0];
+      }
+
+      return null;
     });
   },
 
   /**
-   * Retrieves basic information about a list entities within an organization
+   * Retrieves basic information about an entity within an organization
    * @param {Object} options
-   * @param {UUID} options.ids the id of the entity to lookup
+   * @param {UUID} options.id the id of the entity to lookup
    * @param {UUID} options.entityProviderType the provider to query (optional)
-   * @returns {Promise} Resolves with an array of entities found
+   * @param {Boolean} options.shouldBatch whether to batch the query, set to false for single immediate result (defaults to true)
+   * @returns {Promise} Resolves with the entity found or null if not found
    */
   lookup(options: LookupOptions) {
-    const {ids, entityProviderType} = options;
+    const {id, entityProviderType, shouldBatch = true} = options;
 
     const resource = entityProviderType
       ? `/lookup/orgid/${this.webex.internal.device.orgId}/entityprovidertype/${entityProviderType}`
       : `/lookup/orgid/${this.webex.internal.device.orgId}/identities`;
 
+    if (shouldBatch) {
+      return this._batchedLookup({
+        resource,
+        lookupValue: id,
+      });
+    }
+
     return this._request({
-      dataPath: 'lookupResult.entities',
+      dataPath: LOOKUP_DATA_PATH,
+      foundPath: LOOKUP_FOUND_PATH,
       resource,
       params: {
-        lookupValues: ids,
+        [LOOKUP_REQUEST_KEY]: [id],
       },
+    }).then(({resultArray, foundArray}) => {
+      if (foundArray[0] === id) {
+        return resultArray[0];
+      }
+
+      return null;
     });
   },
 
   /**
-   * Retrieves basic information about a list entities within an organization
+   * Retrieves basic information about an enitity within an organization
    * @param {Object} options
-   * @param {UUID} options.emails the emails of the entities to lookup
-   * @returns {Promise} Resolves with an array of entities found
+   * @param {UUID} options.email the email of the entity to lookup
+   * @returns {Promise} Resolves with the entity found or rejects if not found
    */
   lookupByEmail(options: LookupByEmailOptions) {
-    const {emails} = options;
+    const {email} = options;
+    const resource = `/lookup/orgid/${this.webex.internal.device.orgId}/emails`;
 
     return this._request({
-      dataPath: 'lookupResult.entities',
-      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/emails`,
+      dataPath: LOOKUP_DATA_PATH,
+      foundPath: LOOKUP_FOUND_PATH,
+      resource,
       params: {
-        lookupValues: emails,
+        [LOOKUP_REQUEST_KEY]: [email],
       },
+    }).then(({resultArray, foundArray}) => {
+      if (foundArray[0] === email) {
+        return resultArray[0];
+      }
+
+      return null;
     });
   },
 
@@ -249,14 +358,14 @@ const DSS = WebexPlugin.extend({
     const {requestedTypes, resultSize, queryString} = options;
 
     return this._request({
-      dataPath: 'directoryEntities',
+      dataPath: SEARCH_DATA_PATH,
       resource: `/search/orgid/${this.webex.internal.device.orgId}/entities`,
       params: {
         queryString,
         resultSize,
         requestedTypes,
       },
-    });
+    }).then(({resultArray}) => resultArray);
   },
 });
 

package/src/index.ts

@@ -1,7 +1,8 @@
 import {registerInternalPlugin} from '@webex/webex-core';
 
 import DSS from './dss';
+import config from './config';
 
-registerInternalPlugin('dss', DSS);
+registerInternalPlugin('dss', DSS, {config});
 
 export {default} from './dss';

package/src/types.ts

@@ -11,12 +11,13 @@ export enum EntityProviderType {
 }
 
 export interface LookupOptions {
-  ids: string[];
+  id: string;
   entityProviderType?: EntityProviderType;
+  shouldBatch?: boolean;
 }
 
 export interface LookupByEmailOptions {
-  emails: string[];
+  email: string;
 }
 
 // eslint-disable-next-line no-shadow

package/test/unit/spec/dss-batcher.ts

@@ -0,0 +1,146 @@
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+/* eslint-disable no-underscore-dangle */
+
+import {expect} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+import DSS from '@webex/internal-plugin-dss';
+import DssBatcher from '@webex/internal-plugin-dss/src/dss-batcher';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {Defer} from '@webex/common';
+
+describe('plugin-dss', () => {
+  describe('DssBatcher', () => {
+    let batcher;
+    let webex;
+
+    beforeEach(() => {
+      webex = MockWebex({
+        canAuthorize: false,
+        children: {
+          dss: DSS,
+        },
+      });
+      batcher = new DssBatcher({
+        resource: 'fakeResource',
+        dataPath: 'fakeDataPath',
+        entitiesFoundPath: 'fakeEntitiesFoundPath',
+        entitiesNotFoundPath: 'fakeEntitiesNotFoundPath',
+        requestKey: 'fakeRequestKey',
+        parent: webex.internal.dss,
+      });
+      webex.internal.dss.batchers.fakeResource = batcher;
+    });
+
+    describe('#submitHttpRequest', () => {
+      it('calls dss._request with expected params', async () => {
+        webex.internal.dss._request = sinon.stub().returns(
+          Promise.resolve('some return value')
+        );
+
+        const result = await batcher.submitHttpRequest(['id1']);
+
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: 'fakeDataPath',
+            foundPath: 'fakeEntitiesFoundPath',
+            notFoundPath: 'fakeEntitiesNotFoundPath',
+            resource: 'fakeResource',
+            params: {
+              lookupValues: ['id1'],
+            },
+          },
+        ]);
+        expect(result).to.equal('some return value');
+      });
+    });
+
+    describe('#handleHttpSuccess', () => {
+      it('calls acceptItem on each found or not found entity', async () => {
+        batcher.acceptItem = sinon.stub().returns(Promise.resolve(undefined));
+        const res = {
+          resultArray: [
+            'item1',
+            'item2',
+          ],
+          foundArray: [
+            'id1',
+            'id2',
+          ],
+          notFoundArray: [
+            'id3',
+            'id4',
+          ],
+        };
+        const result = await batcher.handleHttpSuccess(res);
+
+        expect(batcher.acceptItem.getCalls().map((call) => call.args)).to.deep.equal([
+          [{requestValue: 'id1', entity: 'item1'}],
+          [{requestValue: 'id2', entity: 'item2'}],
+          [{requestValue: 'id3', entity: null}],
+          [{requestValue: 'id4', entity: null}],
+        ]);
+        expect(result).to.deep.equal([undefined, undefined, undefined, undefined]);
+      });
+    });
+
+    describe('#didItemFail', () => {
+      it('returns true if item.entity is null', async () => {
+        const result = await batcher.didItemFail({entity: null});
+
+        expect(result).to.be.true;
+      });
+
+      it('returns true if item.entity is not null', async () => {
+        const result = await batcher.didItemFail({entity: 'something'});
+
+        expect(result).to.be.false;
+      });
+    });
+
+    describe('#handleItemFailure', () => {
+      it('resolves defer for item with null', async () => {
+        const defer = new Defer();
+
+        batcher.getDeferredForResponse = sinon.stub().returns(Promise.resolve(defer));
+        const result = await batcher.handleItemFailure({requestValue: 'some request'});
+        const deferValue = await defer.promise;
+
+        expect(batcher.getDeferredForResponse.getCall(0).args).to.deep.equal([{requestValue: 'some request'}]);
+        expect(result).to.be.undefined;
+        expect(deferValue).to.be.null;
+      });
+    });
+
+    describe('#handleItemSuccess', () => {
+      it('resolves defer for item with item.entity', async () => {
+        const defer = new Defer();
+
+        batcher.getDeferredForResponse = sinon.stub().returns(Promise.resolve(defer));
+        const result = await batcher.handleItemSuccess({entity: 'some entity'});
+        const deferValue = await defer.promise;
+
+        expect(batcher.getDeferredForResponse.getCall(0).args).to.deep.equal([{entity: 'some entity'}]);
+        expect(result).to.be.undefined;
+        expect(deferValue).to.equal('some entity');
+      });
+    });
+
+    describe('#fingerprintRequest', () => {
+      it('returns request', async () => {
+        const result = await batcher.fingerprintRequest('some request');
+
+        expect(result).to.equal('some request');
+      });
+    });
+
+    describe('#fingerprintResponse', () => {
+      it('returns response requestValue', async () => {
+        const result = await batcher.fingerprintResponse({requestValue: 'some request'});
+
+        expect(result).to.equal('some request');
+      });
+    });
+  });
+});