@webex/plugin-meetings 3.12.0-next.2 → 3.12.0-next.21

package/test/unit/spec/meeting/utils.js

@@ -60,6 +60,7 @@ describe('plugin-meetings', () => {
       meeting.annotaion = {cleanUp: sinon.stub()};
       meeting.getWebexObject = sinon.stub().returns(webex);
       meeting.simultaneousInterpretation = {cleanUp: sinon.stub()};
+      meeting.locusInfo = {cleanUp: sinon.stub()};
       meeting.trigger = sinon.stub();
       meeting.webex = webex;
       meeting.webex.internal.newMetrics.callDiagnosticMetrics =
@@ -89,6 +90,7 @@ describe('plugin-meetings', () => {
         assert.calledOnceWithExactly(meeting.cleanupLLMConneciton, {throwOnError: false});
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
+        assert.calledOnce(meeting.locusInfo.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
         assert.calledOnceWithExactly(
           meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,
@@ -110,6 +112,7 @@ describe('plugin-meetings', () => {
         assert.notCalled(meeting.cleanupLLMConneciton);
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
+        assert.calledOnce(meeting.locusInfo.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
         assert.calledOnceWithExactly(
           meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,
@@ -130,6 +133,7 @@ describe('plugin-meetings', () => {
         assert.notCalled(meeting.cleanupLLMConneciton);
         assert.calledOnce(meeting.breakouts.cleanUp);
         assert.calledOnce(meeting.simultaneousInterpretation.cleanUp);
+        assert.calledOnce(meeting.locusInfo.cleanUp);
         assert.calledOnce(webex.internal.device.meetingEnded);
         assert.calledOnceWithExactly(
           meeting.webex.internal.newMetrics.callDiagnosticMetrics.clearEventLimitsForCorrelationId,

package/test/unit/spec/meetings/index.js

@@ -1285,10 +1285,10 @@ describe('plugin-meetings', () => {
           assert.exists(result.dispose);
         });
 
-        it('creates noise reduction effect with ST model', async () => {
+        it('creates noise reduction effect with OFMV model', async () => {
           const result = await webex.meetings.createNoiseReductionEffect({
             audioContext: {},
-            model: 'st',
+            model: 'ofmv',
           });
 
           assert.exists(result);
@@ -1300,7 +1300,7 @@ describe('plugin-meetings', () => {
             authToken: 'fake_token',
             mode: 'WORKLET',
             avoidSimd: false,
-            model: 'st',
+            model: 'ofmv',
           });
           assert.exists(result.enable);
           assert.exists(result.disable);
@@ -2833,6 +2833,39 @@ describe('plugin-meetings', () => {
             checkCreateMeetingWithNoMeetingInfo(true, true);
           });
 
+          it('does not emit meeting:added when meeting is destroyed due to missing meeting info', async () => {
+            // Make destroy actually remove the meeting from the collection
+            // so that getMeetingByType returns null in the finally block
+            webex.meetings.destroy = sinon.stub().callsFake((meeting) => {
+              webex.meetings.meetingCollection.delete(meeting.id);
+            });
+
+            try {
+              await webex.meetings.createMeeting(
+                'test destination',
+                'test type',
+                undefined,
+                undefined,
+                undefined,
+                true
+              );
+              assert.fail('should have thrown NoMeetingInfoError');
+            } catch (err) {
+              assert.instanceOf(err, NoMeetingInfoError);
+            }
+
+            assert.calledOnce(webex.meetings.destroy);
+
+            // meeting:added should NOT have been triggered since the meeting was destroyed
+            assert.neverCalledWith(
+              TriggerProxy.trigger,
+              sinon.match.any,
+              sinon.match({function: 'createMeeting'}),
+              'meeting:added',
+              sinon.match.any
+            );
+          });
+
           it('creates the meeting avoiding meeting info fetch by passing type as DESTINATION_TYPE.ONE_ON_ONE_CALL', async () => {
             const meeting = await webex.meetings.createMeeting(
               'test destination',

package/test/unit/spec/meetings/utils.js

@@ -128,6 +128,114 @@ describe('plugin-meetings', () => {
         };
         assert.equal(MeetingsUtil.isBreakoutLocusDTO(newLocus), false);
       });
+
+      it('returns true if newLocus.info.isBreakout is true', () => {
+        const newLocus = {
+          info: {
+            isBreakout: true,
+          },
+        };
+        assert.equal(MeetingsUtil.isBreakoutLocusDTO(newLocus), true);
+      });
+
+      it('returns false if newLocus.info.isBreakout is false', () => {
+        const newLocus = {
+          info: {
+            isBreakout: false,
+          },
+        };
+        assert.equal(MeetingsUtil.isBreakoutLocusDTO(newLocus), false);
+      });
+
+      it('returns true if both sessionType is BREAKOUT and info.isBreakout is true', () => {
+        const newLocus = {
+          controls: {
+            breakout: {
+              sessionType: 'BREAKOUT',
+            },
+          },
+          info: {
+            isBreakout: true,
+          },
+        };
+        assert.equal(MeetingsUtil.isBreakoutLocusDTO(newLocus), true);
+      });
+    });
+
+    describe('#isMainAssociatedWithBreakout', () => {
+      it('returns true when breakout control url matches main locus breakout url', () => {
+        const mainLocus = {
+          url: 'main-locus-url',
+          controls: {
+            breakout: {
+              url: 'breakout-control-url',
+            },
+          },
+        };
+        const breakoutLocus = {
+          controls: {
+            breakout: {
+              url: 'breakout-control-url',
+            },
+          },
+        };
+
+        assert.equal(MeetingsUtil.isMainAssociatedWithBreakout(mainLocus, breakoutLocus), true);
+      });
+
+      it('returns true when breakout self device replaces the main locus url', () => {
+        const mainLocus = {
+          url: 'main-locus-url',
+          controls: {},
+        };
+        const breakoutLocus = {
+          controls: {
+            breakout: {
+              url: 'other-breakout-url',
+            },
+          },
+          self: {
+            deviceUrl: 'device-url-1',
+            devices: [
+              {
+                url: 'device-url-1',
+                replaces: [{locusUrl: 'main-locus-url'}],
+              },
+            ],
+          },
+        };
+
+        assert.equal(MeetingsUtil.isMainAssociatedWithBreakout(mainLocus, breakoutLocus), true);
+      });
+
+      it('returns false when breakout locus is not associated with the main locus', () => {
+        const mainLocus = {
+          url: 'main-locus-url',
+          controls: {
+            breakout: {
+              url: 'breakout-control-url',
+            },
+          },
+        };
+        const breakoutLocus = {
+          controls: {
+            breakout: {
+              url: 'different-breakout-url',
+            },
+          },
+          self: {
+            deviceUrl: 'device-url-1',
+            devices: [
+              {
+                url: 'device-url-1',
+                replaces: [{locusUrl: 'another-main-locus-url'}],
+              },
+            ],
+          },
+        };
+
+        assert.equal(MeetingsUtil.isMainAssociatedWithBreakout(mainLocus, breakoutLocus), false);
+      });
     });
 
     describe('#joinedOnThisDevice', () => {

package/test/unit/spec/multistream/sendSlotManager.ts

@@ -1,19 +1,28 @@
 import 'jsdom-global/register';
 import SendSlotManager from '@webex/plugin-meetings/src/multistream/sendSlotManager';
-import { LocalStream, MediaType, MultistreamRoapMediaConnection } from "@webex/internal-media-core";
-import {expect} from '@webex/test-helper-chai';
+import { LocalStream, MediaType, MultistreamRoapMediaConnection, MediaCodecMimeType } from "@webex/internal-media-core";
+import {assert, expect} from '@webex/test-helper-chai';
 import sinon from 'sinon';
+import Metrics from '@webex/plugin-meetings/src/metrics';
+import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
 
 describe('SendSlotsManager', () => {
     let sendSlotsManager: SendSlotManager;
     const LoggerProxy = {
         logger: {
             info: sinon.stub(),
+            warn: sinon.stub(),
+            error: sinon.stub(),
         },
     };
 
     beforeEach(() => {
         sendSlotsManager = new SendSlotManager(LoggerProxy);
+        sinon.stub(Metrics, 'sendBehavioralMetric');
+    });
+
+    afterEach(() => {
+        sinon.restore();
     });
 
     describe('createSlot', () => {
@@ -29,13 +38,13 @@ describe('SendSlotsManager', () => {
         it('should create a slot for the given mediaType', () => {
             sendSlotsManager.createSlot(mediaConnection, mediaType);
 
-            expect(mediaConnection.createSendSlot.calledWith(mediaType, true));
+            assert.calledWith(mediaConnection.createSendSlot, mediaType, true);
         });
 
         it('should create a slot for the given mediaType & active state', () => {
             sendSlotsManager.createSlot(mediaConnection, mediaType, false);
 
-            expect(mediaConnection.createSendSlot.calledWith(mediaType, false));
+            assert.calledWith(mediaConnection.createSendSlot, mediaType, false);
         });
 
         it('should throw an error if a slot for the given mediaType already exists', () => {
@@ -86,14 +95,12 @@ describe('SendSlotsManager', () => {
 
             await sendSlotsManager.publishStream(mediaType, stream);
 
-            expect(slot.publishStream.calledWith(stream));
+            assert.calledWith(slot.publishStream, stream);
         });
 
-        it('should throw an error if a slot for the given mediaType does not exist', (done) => {
-            sendSlotsManager.publishStream(mediaType, stream).catch((error) => {
-                expect(error.message).to.equal(`Slot for ${mediaType} does not exist`);
-                done();
-            });
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.publishStream(mediaType, stream))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
         });
     });
 
@@ -116,14 +123,12 @@ describe('SendSlotsManager', () => {
 
             await sendSlotsManager.unpublishStream(mediaType);
 
-            expect(slot.unpublishStream.called);
+            assert.called(slot.unpublishStream);
         });
 
-        it('should throw an error if a slot for the given mediaType does not exist',(done) => {
-            sendSlotsManager.unpublishStream(mediaType).catch((error) => {
-                expect(error.message).to.equal(`Slot for ${mediaType} does not exist`);
-                done();
-            });
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.unpublishStream(mediaType))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
         });
     });
 
@@ -147,7 +152,7 @@ describe('SendSlotsManager', () => {
 
       await sendSlotsManager.setNamedMediaGroups(mediaType, groups);
 
-      expect(slot.setNamedMediaGroups.calledWith(groups));
+      assert.calledWith(slot.setNamedMediaGroups, groups);
     });
 
     it('should throw an error if the given mediaType is not audio', () => {
@@ -169,16 +174,16 @@ describe('SendSlotsManager', () => {
             } as MultistreamRoapMediaConnection;
         });
 
-        it('should set the active state of the sendSlot for the given mediaType', async () => {
+        it('should set the active state of the sendSlot for the given mediaType', () => {
             const slot = {
-                setActive: sinon.stub().resolves(),
+                active: false,
             };
             mediaConnection.createSendSlot.returns(slot);
             sendSlotsManager.createSlot(mediaConnection, mediaType);
 
-            await sendSlotsManager.setActive(mediaType,true);
+            sendSlotsManager.setActive(mediaType, true);
 
-            expect(slot.setActive.called);
+            expect(slot.active).to.be.true;
         });
 
         it('should throw an error if a slot for the given mediaType does not exist', () => {
@@ -197,7 +202,7 @@ describe('SendSlotsManager', () => {
             } as MultistreamRoapMediaConnection;
         });
 
-        it('should set the codec parameters of the sendSlot for the given mediaType', async () => {
+        it('should delegate to slot.setCodecParameters, log deprecation warning and send deprecation metric', async () => {
             const slot = {
                 setCodecParameters: sinon.stub().resolves(),
             };
@@ -206,14 +211,17 @@ describe('SendSlotsManager', () => {
 
             await sendSlotsManager.setCodecParameters(mediaType, codecParameters);
 
-            expect(slot.setCodecParameters.calledWith(codecParameters));
+            assert.calledWith(slot.setCodecParameters, codecParameters);
+            assert.called(LoggerProxy.logger.warn);
+            assert.calledWith(Metrics.sendBehavioralMetric as sinon.SinonStub,
+                BEHAVIORAL_METRICS.DEPRECATED_SET_CODEC_PARAMETERS_USED,
+                { mediaType, codecParameters }
+            );
         });
 
-        it('should throw an error if a slot for the given mediaType does not exist', (done) => {
-            sendSlotsManager.setCodecParameters(mediaType, codecParameters).catch((error) => {
-                expect(error.message).to.equal(`Slot for ${mediaType} does not exist`);
-                done();
-            });
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.setCodecParameters(mediaType, codecParameters))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
         });
     });
 
@@ -227,23 +235,114 @@ describe('SendSlotsManager', () => {
             } as MultistreamRoapMediaConnection;
         });
 
-        it('should delete the codec parameters of the sendSlot for the given mediaType', async () => {
+        it('should delegate to slot.deleteCodecParameters, log deprecation warning and send deprecation metric', async () => {
             const slot = {
                 deleteCodecParameters: sinon.stub().resolves(),
             };
             mediaConnection.createSendSlot.returns(slot);
             sendSlotsManager.createSlot(mediaConnection, mediaType);
 
-            await sendSlotsManager.deleteCodecParameters(mediaType,[]);
+            await sendSlotsManager.deleteCodecParameters(mediaType, []);
+
+            assert.calledWith(slot.deleteCodecParameters, []);
+            assert.called(LoggerProxy.logger.warn);
+            assert.calledWith(Metrics.sendBehavioralMetric as sinon.SinonStub,
+                BEHAVIORAL_METRICS.DEPRECATED_DELETE_CODEC_PARAMETERS_USED,
+                { mediaType, parameters: [] }
+            );
+        });
+
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.deleteCodecParameters(mediaType, []))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
+        });
+    });
+
+    describe('setCustomCodecParameters', () => {
+        let mediaConnection;
+        const mediaType = MediaType.AudioMain;
+        const codecMimeType = MediaCodecMimeType.OPUS;
+        const parameters = { maxaveragebitrate: '64000' };
+
+        beforeEach(() => {
+            mediaConnection = {
+                createSendSlot: sinon.stub(),
+            } as MultistreamRoapMediaConnection;
+        });
+
+        it('should set custom codec parameters on the sendSlot for the given mediaType and codec, log info and send metric', async () => {
+            const slot = {
+                setCustomCodecParameters: sinon.stub().resolves(),
+            };
+            mediaConnection.createSendSlot.returns(slot);
+            sendSlotsManager.createSlot(mediaConnection, mediaType);
+
+            await sendSlotsManager.setCustomCodecParameters(mediaType, codecMimeType, parameters);
+
+            assert.calledWith(slot.setCustomCodecParameters, codecMimeType, parameters);
+            assert.called(LoggerProxy.logger.info);
+            assert.calledWith(Metrics.sendBehavioralMetric as sinon.SinonStub,
+                BEHAVIORAL_METRICS.SET_CUSTOM_CODEC_PARAMETERS_USED,
+                { mediaType, codecMimeType, parameters }
+            );
+        });
+
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.setCustomCodecParameters(mediaType, codecMimeType, parameters))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
+        });
+
+        it('should throw and log error when setCustomCodecParameters fails', async () => {
+            const error = new Error('codec parameter failure');
+            const slot = {
+                setCustomCodecParameters: sinon.stub().rejects(error),
+            };
+            mediaConnection.createSendSlot.returns(slot);
+            sendSlotsManager.createSlot(mediaConnection, mediaType);
+
+            await expect(sendSlotsManager.setCustomCodecParameters(mediaType, codecMimeType, parameters))
+                .to.be.rejectedWith('codec parameter failure');
+
+            assert.called(LoggerProxy.logger.error);
+            assert.calledWith(Metrics.sendBehavioralMetric as sinon.SinonStub,
+                BEHAVIORAL_METRICS.SET_CUSTOM_CODEC_PARAMETERS_USED,
+                { mediaType, codecMimeType, parameters }
+            );
+        });
+    });
+
+    describe('markCustomCodecParametersForDeletion', () => {
+        let mediaConnection;
+        const mediaType = MediaType.AudioMain;
+        const codecMimeType = MediaCodecMimeType.OPUS;
+        const parameters = ['maxaveragebitrate', 'maxplaybackrate'];
+
+        beforeEach(() => {
+            mediaConnection = {
+                createSendSlot: sinon.stub(),
+            } as MultistreamRoapMediaConnection;
+        });
+
+        it('should mark custom codec parameters for deletion on the sendSlot for the given mediaType and codec, log info and send metric', async () => {
+            const slot = {
+                markCustomCodecParametersForDeletion: sinon.stub().resolves(),
+            };
+            mediaConnection.createSendSlot.returns(slot);
+            sendSlotsManager.createSlot(mediaConnection, mediaType);
+
+            await sendSlotsManager.markCustomCodecParametersForDeletion(mediaType, codecMimeType, parameters);
 
-            expect(slot.deleteCodecParameters.called);
+            assert.calledWith(slot.markCustomCodecParametersForDeletion, codecMimeType, parameters);
+            assert.called(LoggerProxy.logger.info);
+            assert.calledWith(Metrics.sendBehavioralMetric as sinon.SinonStub,
+                BEHAVIORAL_METRICS.MARK_CUSTOM_CODEC_PARAMETERS_FOR_DELETION_USED,
+                { mediaType, codecMimeType, parameters }
+            );
         });
 
-        it('should throw an error if a slot for the given mediaType does not exist', (done) => {
-            sendSlotsManager.deleteCodecParameters(mediaType,[]).catch((error) => {
-                expect(error.message).to.equal(`Slot for ${mediaType} does not exist`);
-                done();
-            });
+        it('should throw an error if a slot for the given mediaType does not exist', async () => {
+            await expect(sendSlotsManager.markCustomCodecParametersForDeletion(mediaType, codecMimeType, parameters))
+                .to.be.rejectedWith(`Slot for ${mediaType} does not exist`);
         });
     });
 

package/test/unit/spec/webinar/index.ts

@@ -33,6 +33,7 @@ describe('plugin-meetings', () => {
       webex.internal.llm = {
         getDatachannelToken: sinon.stub().returns(undefined),
         setDatachannelToken: sinon.stub(),
+        isDataChannelTokenEnabled: sinon.stub().resolves(false),
         isConnected: sinon.stub().returns(false),
         disconnectLLM: sinon.stub().resolves(),
         off: sinon.stub(),
@@ -267,6 +268,65 @@ describe('plugin-meetings', () => {
         webex.internal.voicea.updateSubchannelSubscriptions = sinon.stub();
       });
 
+      it('refreshes practice-session token before register when cached token is missing', async () => {
+        webex.internal.llm.isDataChannelTokenEnabled.resolves(true);
+        webex.internal.llm.getDatachannelToken = sinon.stub().callsFake((tokenType) => {
+          if (tokenType === DataChannelTokenType.PracticeSession) return undefined;
+
+          return undefined;
+        });
+        meeting.refreshDataChannelToken = sinon.stub().resolves({
+          body: {
+            datachannelToken: 'ps-token-from-refresh',
+            dataChannelTokenType: DataChannelTokenType.PracticeSession,
+          },
+        });
+
+        await webinar.updatePSDataChannel();
+
+        assert.calledOnceWithExactly(meeting.refreshDataChannelToken);
+        assert.calledWithExactly(
+          webex.internal.llm.setDatachannelToken,
+          'ps-token-from-refresh',
+          DataChannelTokenType.PracticeSession
+        );
+        assert.calledWith(
+          webex.internal.llm.registerAndConnect,
+          'locus-url',
+          'dc-url',
+          'ps-token-from-refresh',
+          LLM_PRACTICE_SESSION
+        );
+      });
+
+      it('does not reconnect if practice-session eligibility changes during async token refresh', async () => {
+        webex.internal.llm.isDataChannelTokenEnabled.resolves(true);
+        webex.internal.llm.getDatachannelToken = sinon.stub().returns(undefined);
+
+        let resolveRefresh;
+        meeting.refreshDataChannelToken = sinon.stub().returns(
+          new Promise((resolve) => {
+            resolveRefresh = resolve;
+          })
+        );
+
+        const updatePromise = webinar.updatePSDataChannel();
+
+        webinar.practiceSessionEnabled = false;
+
+        resolveRefresh({
+          body: {
+            datachannelToken: 'stale-ps-token',
+            dataChannelTokenType: DataChannelTokenType.PracticeSession,
+          },
+        });
+
+        const result = await updatePromise;
+
+        assert.isUndefined(result);
+        assert.notCalled(webex.internal.llm.registerAndConnect);
+      });
+
       it('no-ops when practice session join eligibility is false', async () => {
         webinar.practiceSessionEnabled = false;
         const cleanupPSDataChannelStub = sinon.stub(webinar, 'cleanupPSDataChannel').resolves();