@webex/plugin-meetings 3.10.0-next.24 → 3.10.0-next.26

package/dist/types/hashTree/types.d.ts

@@ -7,6 +7,7 @@ export declare const ObjectType: {
     readonly info: "info";
     readonly fullState: "fullstate";
     readonly links: "links";
+    readonly control: "controlentry";
 };
 export type ObjectType = Enum<typeof ObjectType>;
 export declare const ObjectTypeToLocusKeyMap: {
@@ -16,6 +17,7 @@ export declare const ObjectTypeToLocusKeyMap: {
     self: string;
     participant: string;
     mediashare: string;
+    controlentry: string;
 };
 export interface HtMeta {
     elementId: {

package/dist/types/interceptors/locusRouteToken.d.ts

@@ -11,6 +11,7 @@ export default class LocusRouteTokenInterceptor extends Interceptor {
      */
     static create(): LocusRouteTokenInterceptor;
     getLocusIdByRequestUrl(url: string): string;
+    getHeader(headers: Record<string, string>, name: string): string;
     /**
      * @param {Object} options
      * @param {HttpResponse} response

package/dist/webinar/index.js

@@ -448,7 +448,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.10.0-next.24"
+  version: "3.10.0-next.26"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.10.0-next.24"
+  "version": "3.10.0-next.26"
 }

package/src/hashTree/types.ts

@@ -1,6 +1,6 @@
 import {Enum} from '../constants';
 
-// todo: Locus docs have now more types like CONTROL_ENTRY, EMBEDDED_APP - need to add support for them once Locus implements them
+// todo: Locus docs have now more types like EMBEDDED_APP - need to add support for them once Locus implements them
 export const ObjectType = {
   participant: 'participant',
   self: 'self',
@@ -9,6 +9,7 @@ export const ObjectType = {
   info: 'info',
   fullState: 'fullstate',
   links: 'links',
+  control: 'controlentry',
 } as const;
 
 export type ObjectType = Enum<typeof ObjectType>;
@@ -21,6 +22,7 @@ export const ObjectTypeToLocusKeyMap = {
   [ObjectType.self]: 'self',
   [ObjectType.participant]: 'participants', // note: each object is a single participant in participants array
   [ObjectType.mediaShare]: 'mediaShares', // note: each object is a single mediaShare in mediaShares array
+  [ObjectType.control]: 'controls', // note: each object is a single control entry in controls object
 };
 export interface HtMeta {
   elementId: {

package/src/interceptors/locusRouteToken.ts

@@ -3,7 +3,6 @@
  */
 
 import {Interceptor} from '@webex/http-core';
-import {has} from 'lodash';
 
 const LOCUS_ID_REGEX = /\/locus\/api\/v1\/loci\/([a-f0-9-]{36})/i;
 const X_CISCO_PART_ROUTE_TOKEN = 'X-Cisco-Part-Route-Token';
@@ -25,6 +24,13 @@ export default class LocusRouteTokenInterceptor extends Interceptor {
     return url?.match(LOCUS_ID_REGEX)?.[1];
   }
 
+  // Helper function to get header value case insensitively
+  getHeader(headers: Record<string, string>, name: string) {
+    const key = Object.keys(headers).find((k) => k.toLowerCase() === name.toLowerCase());
+
+    return key ? headers[key] : undefined;
+  }
+
   /**
    * @param {Object} options
    * @param {HttpResponse} response
@@ -33,8 +39,10 @@ export default class LocusRouteTokenInterceptor extends Interceptor {
   onResponse(options, response) {
     const locusId = this.getLocusIdByRequestUrl(options.uri);
     if (locusId) {
-      const hasRouteToken = has(response.headers, X_CISCO_PART_ROUTE_TOKEN);
-      const token = response.headers[X_CISCO_PART_ROUTE_TOKEN];
+      const hasRouteToken = Object.keys(response.headers).some(
+        (key) => key.toLowerCase() === X_CISCO_PART_ROUTE_TOKEN.toLowerCase()
+      );
+      const token = this.getHeader(response.headers, X_CISCO_PART_ROUTE_TOKEN);
       if (hasRouteToken) {
         this.updateToken(locusId, token);
       }
@@ -66,7 +74,11 @@ export default class LocusRouteTokenInterceptor extends Interceptor {
    * @returns {void}
    */
   updateToken(locusId, token) {
-    ROUTE_TOKEN[locusId] = token;
+    if (token === 'null' || token === null) {
+      delete ROUTE_TOKEN[locusId];
+    } else {
+      ROUTE_TOKEN[locusId] = token;
+    }
   }
 
   /**

package/src/locus-info/index.ts

@@ -590,6 +590,24 @@ export default class LocusInfo extends EventsScope {
           this.hashTreeObjectId2ParticipantId.delete(object.htMeta.elementId.id);
         }
         break;
+      case ObjectType.control:
+        if (object.data) {
+          Object.keys(object.data).forEach((controlKey) => {
+            LoggerProxy.logger.info(
+              `Locus-info:index#updateLocusFromHashTreeObject --> control ${controlKey} updated:`,
+              object.data[controlKey]
+            );
+            if (!locus.controls) {
+              locus.controls = {};
+            }
+            locus.controls[controlKey] = object.data[controlKey];
+          });
+        } else {
+          LoggerProxy.logger.warn(
+            `Locus-info:index#updateLocusFromHashTreeObject --> control object update without data - this is not expected!`
+          );
+        }
+        break;
       case ObjectType.links:
       case ObjectType.info:
       case ObjectType.fullState:

package/test/unit/spec/interceptors/locusRouteToken.ts

@@ -54,6 +54,23 @@ describe('LocusRouteTokenInterceptor', () => {
     assert.equal(interceptor.getToken(TEST_LOCUS_ID), 'test-token');
   });
 
+  it('get route token case insensitively ', async () => {
+    const response = {
+      headers: {
+        ['x-cisco-part-route-token']: 'test-token',
+      },
+    };
+
+    const result = await interceptor.onResponse(
+      {
+        uri: `https://locus-test.webex.com/locus/api/v1/loci/${TEST_LOCUS_ID}/foo`,
+      },
+      response
+    );
+    assert.equal(result, response);
+    assert.equal(interceptor.getToken(TEST_LOCUS_ID), 'test-token');
+  });
+
   it('onResponse should not store token when header missing', async () => {
     interceptor.updateToken(TEST_LOCUS_ID);
     const response = {headers: {}};
@@ -84,4 +101,14 @@ describe('LocusRouteTokenInterceptor', () => {
     interceptor.updateToken(TEST_LOCUS_ID, 'abc456');
     assert.equal(interceptor.getToken(TEST_LOCUS_ID), 'abc456');
   });
+
+  it('should delete token when updateToken called with "null"', () => {
+    interceptor.updateToken(TEST_LOCUS_ID, 'null');
+    assert.isUndefined(interceptor.getToken(TEST_LOCUS_ID));
+  });
+
+  it('should delete token when updateToken called with null', () => {
+    interceptor.updateToken(TEST_LOCUS_ID, null);
+    assert.isUndefined(interceptor.getToken(TEST_LOCUS_ID));
+  });
 });

package/test/unit/spec/locus-info/index.js

@@ -486,7 +486,6 @@ describe('plugin-meetings', () => {
           // setup new updated locus that has many things missing
           const newLocusHtMeta = {elementId: {type: 'locus', version: 42}};
           const newLocus = {
-            controls: 'new-controls',
             host: 'new-host',
             htMeta: newLocusHtMeta,
           };
@@ -499,10 +498,11 @@ describe('plugin-meetings', () => {
           // check onDeltaLocus() was called with correctly updated locus info
           assert.calledOnceWithExactly(onDeltaLocusStub, {
             // these fields are not part of Locus object, so should keep their old values:
+            controls: {id: 'fake-controls'},
             info: {id: 'fake-info'},
             fullState: {id: 'fake-full-state'},
             self: {id: 'fake-self'},
-            links: { id: 'fake-links' },
+            links: {id: 'fake-links'},
             mediaShares: expectedLocusInfo.mediaShares,
             // and now the new fields
             ...newLocus,
@@ -518,7 +518,6 @@ describe('plugin-meetings', () => {
           // setup new updated locus that has many things missing
           const newLocusHtMeta = {elementId: {type: 'locus', version: 42}};
           const newLocus = {
-            controls: 'new-controls',
             host: 'new-host',
             htMeta: newLocusHtMeta,
           };
@@ -531,6 +530,7 @@ describe('plugin-meetings', () => {
                 data: {
                   ...newLocus,
                   // all these fields below should be ignored and not override the existing ones in our "old" Locus
+                  controls: {id: 'new-controls'},
                   info: 'new-info',
                   fullState: 'new-fullState',
                   self: 'new-self',
@@ -545,10 +545,11 @@ describe('plugin-meetings', () => {
           // with old values for the fields that should be ignored (like "info" or "fullState")
           assert.calledOnceWithExactly(onDeltaLocusStub, {
             // these fields have the "old" values:
+            controls: {id: 'fake-controls'},
             info: {id: 'fake-info'},
             fullState: {id: 'fake-full-state'},
             self: {id: 'fake-self'},
-            links: { id: 'fake-links' },
+            links: {id: 'fake-links'},
             mediaShares: expectedLocusInfo.mediaShares,
             participants: [], // empty means there were no participant updates
             jsSdkMeta: {removedParticipantIds: []}, // no participants were removed
@@ -579,6 +580,7 @@ describe('plugin-meetings', () => {
           // check onDeltaLocus() was called with correctly updated locus info
           assert.calledOnceWithExactly(onDeltaLocusStub, {
             // these fields are not part of Locus object, so should keep their old values:
+            controls: {id: 'fake-controls'},
             info: {id: 'fake-info'},
             fullState: {id: 'fake-full-state'},
             self: {id: 'fake-self'},
@@ -768,6 +770,60 @@ describe('plugin-meetings', () => {
           });
         });
 
+        it('should process locus update correctly when called with multiple CONTROL object updates', () => {
+          const firstControl = {
+            muteOnEntry: {enabled: true},
+            lock: {locked: true, meta: {lastModified: 'YESTERDAY', modifiedBy: 'John Doe'}},
+          };
+          const secondControl = {
+            reactions: {enabled: true},
+          };
+
+          // simulate an update from the HashTreeParser (normally this would be triggered by incoming locus messages)
+          locusInfoUpdateCallback(OBJECTS_UPDATED, {
+            updatedObjects: [
+              {
+                htMeta: {elementId: {type: 'controlentry', id: 'control-1'}},
+                data: firstControl,
+              },
+              {
+                htMeta: {elementId: {type: 'controlentry', id: 'control-2'}},
+                data: secondControl,
+              },
+            ],
+          });
+
+          // check onDeltaLocus() was called with correctly updated locus info
+          // all keys from both controls should be merged into the controls object
+          assert.calledOnceWithExactly(onDeltaLocusStub, {
+            ...expectedLocusInfo,
+            controls: {
+              id: 'fake-controls',
+              muteOnEntry: {enabled: true},
+              lock: {locked: true, meta: {lastModified: 'YESTERDAY', modifiedBy: 'John Doe'}},
+              reactions: {enabled: true},
+            },
+          });
+        });
+
+        it('should process locus update correctly when CONTROL object is received with no data', () => {
+          // simulate an update from the HashTreeParser (normally this would be triggered by incoming locus messages)
+          locusInfoUpdateCallback(OBJECTS_UPDATED, {
+            updatedObjects: [
+              {
+                htMeta: {elementId: {type: 'controlentry', id: 'some-control-id'}},
+                data: null,
+              },
+            ],
+          });
+
+          // check onDeltaLocus() was called with correctly updated locus info
+          // when data is null, it should be ignored and not change the controls
+          assert.calledOnceWithExactly(onDeltaLocusStub, {
+            ...expectedLocusInfo,
+          });
+        });
+
         it('should handle MEETING_ENDED correctly', () => {
           const fakeMeeting = {id: 'fake-meeting-from-collection'};
           const collectionGetStub = sinon