@webex/plugin-meetings 3.0.0-stream-classes.4 → 3.0.0

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

@@ -0,0 +1,13 @@
+import {assert} from '@webex/test-helper-chai';
+import WebinarCollection from '@webex/plugin-meetings/src/webinar/collection';
+
+describe('plugin-meetings', () => {
+    describe('WebinarCollection', () => {
+        it('the webinar collection is as expected', () => {
+            const collection = new WebinarCollection();
+
+            assert.equal(collection.namespace, 'Meetings');
+            assert.equal(collection.mainIndex, 'sessionId');
+        });
+    });
+});

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

@@ -0,0 +1,60 @@
+import {assert, expect} from '@webex/test-helper-chai';
+import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
+import Webinar from '@webex/plugin-meetings/src/webinar';
+import MockWebex from '@webex/test-helper-mock-webex';
+import sinon from 'sinon';
+
+describe('plugin-meetings', () => {
+    describe('Webinar', () => {
+
+        let webex;
+        let webinar;
+
+        beforeEach(() => {
+            // @ts-ignore
+            webex = new MockWebex({});
+            webex.internal.mercury.on = sinon.stub();
+            webinar = new Webinar({}, {parent: webex});
+            webinar.locusUrl = 'locusUrl';
+            webex.request = sinon.stub().returns(Promise.resolve('REQUEST_RETURN_VALUE'));
+            webex.meetings = {};
+            webex.meetings.getMeetingByType = sinon.stub();
+        });
+
+        describe('#locusUrlUpdate', () => {
+            it('sets the locus url', () => {
+                webinar.locusUrlUpdate('newUrl');
+
+                assert.equal(webinar.locusUrl, 'newUrl');
+            });
+        });
+
+        describe('#webcastUrlUpdate', () => {
+            it('sets the webcast url', () => {
+                webinar.webcastUrlUpdate('newUrl');
+
+                assert.equal(webinar.webcastUrl, 'newUrl');
+            });
+        });
+
+        describe('#webinarAttendeesSearchingUrlUpdate', () => {
+            it('sets the webinarAttendeesSearching url', () => {
+                webinar.webinarAttendeesSearchingUrlUpdate('newUrl');
+
+                assert.equal(webinar.webinarAttendeesSearchingUrl, 'newUrl');
+            });
+        });
+
+        describe('#updateCanManageWebcast', () => {
+          it('update canManageWebcast', () => {
+            webinar.updateCanManageWebcast(true);
+
+            assert.equal(webinar.canManageWebcast, true);
+
+            webinar.updateCanManageWebcast(false);
+
+            assert.equal(webinar.canManageWebcast, false);
+          });
+        });
+    })
+})

package/test/utils/integrationTestUtils.js

@@ -6,7 +6,7 @@ const addMedia = async (user, options = {}) => {
   const {microphone, camera} = options;
 
   if (options.multistream) {
-    await user.meeting.addMedia({localTracks: {microphone, camera}});
+    await user.meeting.addMedia({localStreams: {microphone, camera}});
   } else {
     const mediaReadyPromises = Array.isArray(options.expectedMediaReadyTypes)
       ? options.expectedMediaReadyTypes.reduce((output, expectedMediaReadyType) => {
@@ -31,13 +31,13 @@ const addMedia = async (user, options = {}) => {
 
     user.meeting.on('media:ready', mediaReady);
 
-    await user.meeting.addMedia({localTracks: {microphone, camera}});
+    await user.meeting.addMedia({localStreams: {microphone, camera}});
     await Promise.all(Object.values(mediaReadyPromises).map((defer) => defer.promise));
  };
 
 
-  assert.exists(user.meeting.mediaProperties.audioTrack, 'audioTrack not present');
-  assert.exists(user.meeting.mediaProperties.videoTrack, 'videoTrack not present');
+  assert.exists(user.meeting.mediaProperties.audioStream, 'audioStream not present');
+  assert.exists(user.meeting.mediaProperties.videoStream, 'videoStream not present');
 
 };
 

package/test/utils/webex-test-users.js

@@ -17,7 +17,7 @@ require('@webex/plugin-people');
 require('@webex/plugin-rooms');
 require('@webex/plugin-meetings');
 
-const generateTestUsers = (options = {}) => {
+const generateTestUsers = async (options = {}) => {
   options.config = options.config || {};
   options.config.orgId = options.config.orgId || process.env.WEBEX_CONVERGED_ORG_ID;
 
@@ -30,7 +30,8 @@ const generateTestUsers = (options = {}) => {
       // Pause for 5 seconds for CI
       await new Promise((done) => setTimeout(done, 5000));
 
-      const userRegisterPromises = [];
+      const webexRegisterPromises = [];
+      const userWebexMeetings = [];
 
       userSet.forEach((user) => {
         // eslint-disable-next-line no-param-reassign
@@ -44,12 +45,19 @@ const generateTestUsers = (options = {}) => {
           },
         });
 
+        webexRegisterPromises.push(new Promise((resolve) => {
+          user.webex.on('ready', resolve);
+        }));
+
         user.webex.internal.support.submitLogs = sinon.stub().returns(Promise.resolve());
 
-        userRegisterPromises.push(user.webex.meetings.register());
+        userWebexMeetings.push(user.webex.meetings);
       });
 
-      return Promise.all(userRegisterPromises).then(() => userSet);
+      // wait for webex to be ready before registering meetings
+      return Promise.all(webexRegisterPromises).then(() => {
+        return Promise.all(userWebexMeetings.map(m => m.register())).then(() => userSet);
+      })
     })
     .catch((error) => {
       console.error('#generateTestUsers=>ERROR', error);

package/dist/types/mediaQualityMetrics/config.d.ts

@@ -1,365 +0,0 @@
-export declare const emptyMqaInterval: {
-    audioReceive: any[];
-    audioTransmit: any[];
-    intervalMetadata: {
-        peerReflexiveIP: string;
-        peripherals: any[];
-        processAverageCPU: number;
-        processMaximumCPU: number;
-        systemAverageCPU: number;
-        systemMaximumCPU: number;
-    };
-    networkType: string;
-    intervalNumber: number;
-    videoReceive: any[];
-    videoTransmit: any[];
-};
-export declare const emptyAudioReceive: {
-    common: {
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        mediaHopByHopLost: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpHopByHopLost: number;
-        rtpPackets: number;
-        rtpRecovered: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        srtcpUnprotectErrors: number;
-        srtpUnprotectErrors: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            concealedFrames: number;
-            csi: any[];
-            maxConcealRunLength: number;
-            optimalBitrate: number;
-            optimalFrameRate: number;
-            receivedBitrate: number;
-            receivedFrameRate: number;
-            renderedFrameRate: number;
-            requestedBitrate: number;
-            requestedFrameRate: number;
-            rtpEndToEndLost: number;
-            maxRtpJitter: number;
-            meanRtpJitter: number;
-            rtpPackets: number;
-            ssci: number;
-        };
-    }[];
-};
-export declare const emptyAudioTransmit: {
-    common: {
-        availableBitrate: number;
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        queueDelay: number;
-        remoteJitter: number;
-        remoteLossRate: number;
-        remoteReceiveRate: number;
-        roundTripTime: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpPackets: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            csi: any[];
-            requestedBitrate: number;
-            requestedFrames: number;
-            rtpPackets: number;
-            ssci: number;
-            transmittedBitrate: number;
-            transmittedFrameRate: number;
-        };
-    }[];
-};
-export declare const emptyVideoReceive: {
-    common: {
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        mediaHopByHopLost: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpHopByHopLost: number;
-        rtpPackets: number;
-        rtpRecovered: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        srtcpUnprotectErrors: number;
-        srtpUnprotectErrors: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            concealedFrames: number;
-            csi: any[];
-            maxConcealRunLength: number;
-            optimalBitrate: number;
-            optimalFrameRate: number;
-            receivedBitrate: number;
-            receivedFrameRate: number;
-            renderedFrameRate: number;
-            requestedBitrate: number;
-            requestedFrameRate: number;
-            rtpEndToEndLost: number;
-            rtpJitter: number;
-            rtpPackets: number;
-            ssci: number;
-        };
-        h264CodecProfile: string;
-        isActiveSpeaker: boolean;
-        optimalFrameSize: number;
-        receivedFrameSize: number;
-        receivedHeight: number;
-        receivedKeyFrames: number;
-        receivedKeyFramesForRequest: number;
-        receivedKeyFramesSourceChange: number;
-        receivedKeyFramesUnknown: number;
-        receivedWidth: number;
-        requestedFrameSize: number;
-        requestedKeyFrames: number;
-    }[];
-};
-export declare const emptyVideoTransmit: {
-    common: {
-        availableBitrate: number;
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        queueDelay: number;
-        remoteJitter: number;
-        remoteLossRate: number;
-        remoteReceiveRate: number;
-        roundTripTime: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpPackets: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            csi: any[];
-            duplicateSsci: number;
-            requestedBitrate: number;
-            requestedFrames: number;
-            rtpPackets: number;
-            ssci: number;
-            transmittedBitrate: number;
-            transmittedFrameRate: number;
-        };
-        h264CodecProfile: string;
-        isAvatar: boolean;
-        isHardwareEncoded: boolean;
-        localConfigurationChanges: number;
-        maxFrameQp: number;
-        maxNoiseLevel: number;
-        minRegionQp: number;
-        remoteConfigurationChanges: number;
-        requestedFrameSize: number;
-        requestedKeyFrames: number;
-        transmittedFrameSize: number;
-        transmittedHeight: number;
-        transmittedKeyFrames: number;
-        transmittedKeyFramesClient: number;
-        transmittedKeyFramesConfigurationChange: number;
-        transmittedKeyFramesFeedback: number;
-        transmittedKeyFramesLocalDrop: number;
-        transmittedKeyFramesOtherLayer: number;
-        transmittedKeyFramesPeriodic: number;
-        transmittedKeyFramesSceneChange: number;
-        transmittedKeyFramesStartup: number;
-        transmittedKeyFramesUnknown: number;
-        transmittedWidth: number;
-    }[];
-};
-export declare const emptyVideoShareReceive: {
-    common: {
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        mediaHopByHopLost: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpHopByHopLost: number;
-        rtpPackets: number;
-        rtpRecovered: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        srtcpUnprotectErrors: number;
-        srtpUnprotectErrors: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            concealedFrames: number;
-            csi: any[];
-            maxConcealRunLength: number;
-            optimalBitrate: number;
-            optimalFrameRate: number;
-            receivedBitrate: number;
-            receivedFrameRate: number;
-            renderedFrameRate: number;
-            requestedBitrate: number;
-            requestedFrameRate: number;
-            rtpEndToEndLost: number;
-            rtpJitter: number;
-            rtpPackets: number;
-            ssci: number;
-        };
-        h264CodecProfile: string;
-        isActiveSpeaker: boolean;
-        optimalFrameSize: number;
-        receivedFrameSize: number;
-        receivedHeight: number;
-        receivedKeyFrames: number;
-        receivedKeyFramesForRequest: number;
-        receivedKeyFramesSourceChange: number;
-        receivedKeyFramesUnknown: number;
-        receivedWidth: number;
-        requestedFrameSize: number;
-        requestedKeyFrames: number;
-    }[];
-};
-export declare const emptyVideoShareTransmit: {
-    common: {
-        availableBitrate: number;
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        queueDelay: number;
-        remoteJitter: number;
-        remoteLossRate: number;
-        remoteReceiveRate: number;
-        roundTripTime: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpPackets: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: {
-        common: {
-            codec: string;
-            csi: any[];
-            duplicateSsci: number;
-            requestedBitrate: number;
-            requestedFrames: number;
-            rtpPackets: number;
-            ssci: number;
-            transmittedBitrate: number;
-            transmittedFrameRate: number;
-        };
-        h264CodecProfile: string;
-        isAvatar: boolean;
-        isHardwareEncoded: boolean;
-        localConfigurationChanges: number;
-        maxFrameQp: number;
-        maxNoiseLevel: number;
-        minRegionQp: number;
-        remoteConfigurationChanges: number;
-        requestedFrameSize: number;
-        requestedKeyFrames: number;
-        transmittedFrameSize: number;
-        transmittedHeight: number;
-        transmittedKeyFrames: number;
-        transmittedKeyFramesClient: number;
-        transmittedKeyFramesConfigurationChange: number;
-        transmittedKeyFramesFeedback: number;
-        transmittedKeyFramesLocalDrop: number;
-        transmittedKeyFramesOtherLayer: number;
-        transmittedKeyFramesPeriodic: number;
-        transmittedKeyFramesSceneChange: number;
-        transmittedKeyFramesStartup: number;
-        transmittedKeyFramesUnknown: number;
-        transmittedWidth: number;
-    }[];
-};

package/dist/types/reachability/index.d.ts

@@ -1,158 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-import { IP_VERSION } from '../constants';
-export type ICECandidateResult = {
-    clusterId: string;
-    elapsed?: string | null;
-    publicIPs?: string[];
-};
-/**
- * @class Reachability
- * @export
- */
-export default class Reachability {
-    namespace: string;
-    webex: object;
-    reachabilityRequest: any;
-    clusterLatencyResults: any;
-    /**
-     * Creates an instance of Reachability.
-     * @param {object} webex
-     * @memberof Reachability
-     */
-    constructor(webex: object);
-    /**
-     * fetches reachability data
-     * @returns {Object} reachability data
-     * @public
-     * @async
-     * @memberof Reachability
-     */
-    gatherReachability(): Promise<unknown>;
-    /**
-     * fetches reachability data and checks for cluster reachability
-     * @returns {boolean}
-     * @public
-     * @memberof Reachability
-     */
-    isAnyClusterReachable(): Promise<boolean>;
-    /**
-     * Returns what we know about the IP version of the networks we're connected to.
-     * @returns {IP_VERSION}
-     */
-    getIpVersion(): IP_VERSION;
-    /**
-     * Generate peerConnection config settings
-     * @param {object} cluster
-     * @returns {object} peerConnectionConfig
-     * @private
-     * @memberof Reachability
-     */
-    private buildPeerConnectionConfig;
-    /**
-     * Creates an RTCPeerConnection
-     * @param {object} cluster
-     * @returns {RTCPeerConnection} peerConnection
-     * @private
-     * @memberof Reachability
-     */
-    private createPeerConnection;
-    /**
-     * Gets total elapsed time
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {Number} Milliseconds
-     * @private
-     * @memberof Reachability
-     */
-    private getElapsedTime;
-    /**
-     * creates offer and generates localSDP
-     * @param {object} clusterList cluster List
-     * @returns {Promise} Reachability latency results
-     * @private
-     * @memberof Reachability
-     */
-    private getLocalSDPForClusters;
-    /**
-     * Get list of all unreachable clusters
-     * @returns {array} Unreachable clusters
-     * @private
-     * @memberof Reachability
-     */
-    private getUnreachablClusters;
-    /**
-     * Attach an event handler for the icegatheringstatechange
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleIceGatheringStateChange;
-    /**
-     * Attach an event handler for the icecandidate
-     * event and measure latency.
-     * @param {RTCPeerConnection} peerConnection
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private handleOnIceCandidate;
-    /**
-     * An event handler on an RTCPeerConnection when the state of the ICE
-     * candidate gathering process changes. Used to measure connection
-     * speed.
-     * @private
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} timeout
-     * @returns {Promise}
-     */
-    private iceGatheringState;
-    /**
-     * Make a log of unreachable clusters.
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private logUnreachableClusters;
-    /**
-     * Calculates time to establish connection
-     * @param {Array<ICECandidateResult>} iceResults iceResults
-     * @returns {object} reachabilityMap
-     * @protected
-     * @memberof Reachability
-     */
-    protected parseIceResultsToReachabilityResults(iceResults: Array<ICECandidateResult>): {};
-    /**
-     * fetches reachability data
-     * @param {object} clusterList
-     * @returns {Promise<localSDPData>} reachability check results
-     * @private
-     * @memberof Reachability
-     */
-    private performReachabilityCheck;
-    /**
-     * Adds public IP (client media IPs)
-     * @param {RTCPeerConnection} peerConnection
-     * @param {string} publicIP
-     * @returns {void}
-     */
-    protected addPublicIP(peerConnection: RTCPeerConnection, publicIP?: string | null): void;
-    /**
-     * Records latency and closes the peerConnection
-     * @param {RTCPeerConnection} peerConnection
-     * @param {number} elapsed Latency in milliseconds
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private setLatencyAndClose;
-    /**
-     * utility function
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private setup;
-}

package/dist/types/statsAnalyzer/mqaUtil.d.ts

@@ -1,24 +0,0 @@
-export declare const getAudioReceiverMqa: ({ audioReceiver, statsResults, lastMqaDataSent, mediaType }: {
-    audioReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getAudioSenderMqa: ({ audioSender, statsResults, lastMqaDataSent, mediaType }: {
-    audioSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoReceiverMqa: ({ videoReceiver, statsResults, lastMqaDataSent, mediaType }: {
-    videoReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoSenderMqa: ({ videoSender, statsResults, lastMqaDataSent, mediaType }: {
-    videoSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;