@webex/plugin-meetings 3.4.0 → 3.5.0

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

@@ -79,6 +79,7 @@ describe('plugin-meetings', () => {
   let locusInfo;
   let services;
   let catalog;
+  let startReachabilityStub;
 
   describe('meetings index', () => {
     beforeEach(() => {
@@ -129,9 +130,7 @@ describe('plugin-meetings', () => {
         logger,
       });
 
-      Object.assign(webex.meetings, {
-        startReachability: sinon.stub().returns(Promise.resolve()),
-      });
+      startReachabilityStub = sinon.stub(webex.meetings, 'startReachability').resolves();
 
       Object.assign(webex.internal, {
         llm: {on: sinon.stub()},
@@ -197,6 +196,34 @@ describe('plugin-meetings', () => {
       assert.calledOnce(MeetingsUtil.checkH264Support);
     });
 
+    describe('#startReachability', () => {
+      let gatherReachabilitySpy;
+      let fakeResult = {id: 'fake-result'};
+
+      beforeEach(() => {
+        startReachabilityStub.restore();
+        gatherReachabilitySpy = sinon
+          .stub(webex.meetings.getReachability(), 'gatherReachability')
+          .resolves(fakeResult);
+      });
+
+      it('should gather reachability with default trigger value', async () => {
+        const result = await webex.meetings.startReachability();
+
+        assert.calledOnceWithExactly(gatherReachabilitySpy, 'client');
+        assert.equal(result, fakeResult);
+      });
+
+      it('should gather reachability and pass custom trigger value', async () => {
+        const trigger = 'custom-trigger';
+
+        const result = await webex.meetings.startReachability(trigger);
+
+        assert.calledOnceWithExactly(gatherReachabilitySpy, trigger);
+        assert.equal(result, fakeResult);
+      });
+    });
+
     describe('#_toggleUnifiedMeetings', () => {
       it('should have toggleUnifiedMeetings', () => {
         assert.equal(typeof webex.meetings._toggleUnifiedMeetings, 'function');

package/test/unit/spec/members/request.js

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import sinon from 'sinon';
 import chai from 'chai';
 import uuid from 'uuid';
@@ -131,7 +132,7 @@ describe('plugin-meetings', () => {
           locusUrl: url1,
           memberIds: ['1', '2'],
         };
-  
+
         await membersRequest.admitMember(options)
 
         checkRequest({

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

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import {MediaRequestManager} from '@webex/plugin-meetings/src/multistream/mediaRequestManager';
 import {ReceiveSlot} from '@webex/plugin-meetings/src/multistream/receiveSlot';
 import sinon from 'sinon';

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

@@ -1,4 +1,5 @@
 /* eslint-disable require-jsdoc */
+import 'jsdom-global/register';
 import EventEmitter from 'events';
 
 import {MediaType, ReceiveSlotEvents as WcmeReceiveSlotEvents} from '@webex/internal-media-core';

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

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import {MediaType} from '@webex/internal-media-core';

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

@@ -1,4 +1,5 @@
 /* eslint-disable require-jsdoc */
+import 'jsdom-global/register';
 import EventEmitter from 'events';
 
 import {MediaType} from '@webex/internal-media-core';

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

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import EventEmitter from 'events';
 
 import {MediaType} from '@webex/internal-media-core';

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

@@ -1,4 +1,5 @@
 /* eslint-disable require-jsdoc */
+import 'jsdom-global/register';
 import EventEmitter from 'events';
 
 import {MediaType} from '@webex/internal-media-core';

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

@@ -1,3 +1,4 @@
+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';

package/test/unit/spec/personal-meeting-room/personal-meeting-room.js

@@ -1,7 +1,6 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-
 import 'jsdom-global/register';
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';

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

@@ -4,10 +4,9 @@ import sinon from 'sinon';
 import EventEmitter from 'events';
 import testUtils from '../../../utils/testUtils';
 import Reachability, {
-  ReachabilityResults,
   ReachabilityResultsForBackend,
 } from '@webex/plugin-meetings/src/reachability/';
-import { ClusterNode } from '../../../../src/reachability/request';
+import {ClusterNode} from '../../../../src/reachability/request';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 import * as ClusterReachabilityModule from '@webex/plugin-meetings/src/reachability/clusterReachability';
 import Metrics from '@webex/plugin-meetings/src/metrics';
@@ -145,7 +144,6 @@ describe('isAnyPublicClusterReachable', () => {
   });
 });
 
-
 describe('isWebexMediaBackendUnreachable', () => {
   let webex;
 
@@ -486,6 +484,16 @@ describe('gatherReachability', () => {
       JSON.stringify({old: 'joinCookie'})
     );
 
+    webex.internal.device.ipNetworkDetector = {
+      supportsIpV4: false,
+      supportsIpV6: false,
+      firstIpV4: -1,
+      firstIpV6: -1,
+      firstMdns: -1,
+      totalTime: -1,
+      detect: sinon.stub().resolves(),
+    };
+
     clock = sinon.useFakeTimers();
 
     mockClusterReachabilityInstances = {};
@@ -498,6 +506,11 @@ describe('gatherReachability', () => {
         mockClusterReachabilityInstances[id] = mockInstance;
         return mockInstance;
       });
+
+    webex.config.meetings.experimental = {
+      enableTcpReachability: false,
+      enableTlsReachability: false,
+    };
   });
 
   afterEach(() => {
@@ -1035,6 +1048,16 @@ describe('gatherReachability', () => {
           enableTlsReachability: true,
         };
 
+        // the metrics related to ipver and trigger are not tested in these tests and are all the same, so setting them up here
+        const expectedMetricsFull = {
+          ...expectedMetrics,
+          ipver_firstIpV4: -1,
+          ipver_firstIpV6: -1,
+          ipver_firstMdns: -1,
+          ipver_totalTime: -1,
+          trigger: 'test',
+        };
+
         const receivedEvents = {
           done: 0,
           firstResultAvailable: {
@@ -1064,7 +1087,7 @@ describe('gatherReachability', () => {
 
         reachability.reachabilityRequest.getClusters = sinon.stub().returns(mockGetClustersResult);
 
-        const resultPromise = reachability.gatherReachability();
+        const resultPromise = reachability.gatherReachability('test');
 
         await testUtils.flushPromises();
 
@@ -1119,11 +1142,122 @@ describe('gatherReachability', () => {
         assert.calledWith(
           Metrics.sendBehavioralMetric,
           'js_sdk_reachability_completed',
-          expectedMetrics
+          expectedMetricsFull
         );
       })
   );
 
+  it('sends the trigger parameter in the metrics', async () => {
+    const reachability = new TestReachability(webex);
+
+    const mockGetClustersResult = {
+      clusters: {
+        clusterA: {
+          udp: ['udp-url'],
+          tcp: [],
+          xtls: [],
+          isVideoMesh: false,
+        },
+      },
+      joinCookie: {id: 'id'},
+    };
+
+    reachability.reachabilityRequest.getClusters = sinon.stub().returns(mockGetClustersResult);
+
+    const resultPromise = reachability.gatherReachability('some trigger');
+
+    // let it time out
+    await testUtils.flushPromises();
+    clock.tick(15000);
+    await resultPromise;
+
+    // check the metric contains the right trigger value
+    assert.calledWith(
+      Metrics.sendBehavioralMetric,
+      'js_sdk_reachability_completed',
+      sinon.match({trigger: 'some trigger'})
+    );
+  });
+
+  it(`starts ip network version detection and includes the results in the metrics`, async () => {
+    webex.config.meetings.experimental = {
+      enableTcpReachability: true,
+      enableTlsReachability: true,
+    };
+    webex.internal.device.ipNetworkDetector = {
+      supportsIpV4: true,
+      supportsIpV6: true,
+      firstIpV4: 10,
+      firstIpV6: 20,
+      firstMdns: 30,
+      totalTime: 40,
+      detect: sinon.stub().resolves(),
+    };
+
+    const receivedEvents = {
+      done: 0,
+    };
+
+    const reachability = new Reachability(webex);
+
+    reachability.on('reachability:done', () => {
+      receivedEvents.done += 1;
+    });
+
+    // simulate having just 1 cluster, we don't need more for this test
+    reachability.reachabilityRequest.getClusters = sinon.stub().returns({
+      clusters: {
+        publicCluster: {
+          udp: ['udp-url'],
+          tcp: [],
+          xtls: [],
+          isVideoMesh: false,
+        },
+      },
+      joinCookie: {id: 'id'},
+    });
+
+    const resultPromise = reachability.gatherReachability('test');
+
+    await testUtils.flushPromises();
+
+    // trigger mock result events from ClusterReachability instance
+    mockClusterReachabilityInstances['publicCluster'].emitFakeResult('udp', {
+      result: 'reachable',
+      clientMediaIPs: ['1.2.3.4'],
+      latencyInMilliseconds: 100,
+    });
+
+    await resultPromise;
+
+    // check events emitted by Reachability class
+    assert.equal(receivedEvents['done'], 1);
+
+    // and that ip network detection was started
+    assert.calledOnceWithExactly(webex.internal.device.ipNetworkDetector.detect);
+
+    // finally, check the metrics - they should contain values from ipNetworkDetector
+    assert.calledWith(Metrics.sendBehavioralMetric, 'js_sdk_reachability_completed', {
+      vmn_udp_min: -1,
+      vmn_udp_max: -1,
+      vmn_udp_average: -1,
+      public_udp_min: 100,
+      public_udp_max: 100,
+      public_udp_average: 100,
+      public_tcp_min: -1,
+      public_tcp_max: -1,
+      public_tcp_average: -1,
+      public_xtls_min: -1,
+      public_xtls_max: -1,
+      public_xtls_average: -1,
+      ipver_firstIpV4: webex.internal.device.ipNetworkDetector.firstIpV4,
+      ipver_firstIpV6: webex.internal.device.ipNetworkDetector.firstIpV6,
+      ipver_firstMdns: webex.internal.device.ipNetworkDetector.firstMdns,
+      ipver_totalTime: webex.internal.device.ipNetworkDetector.totalTime,
+      trigger: 'test',
+    });
+  });
+
   it('keeps updating reachability results after the 3s public cloud timeout expires', async () => {
     webex.config.meetings.experimental = {
       enableTcpReachability: true,
@@ -1152,7 +1286,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(mockGetClustersResult);
 
-    const resultPromise = reachability.gatherReachability();
+    const resultPromise = reachability.gatherReachability('test');
 
     await testUtils.flushPromises();
 
@@ -1245,7 +1379,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(mockGetClustersResult);
 
-    const resultPromise = reachability.gatherReachability();
+    const resultPromise = reachability.gatherReachability('test');
 
     await testUtils.flushPromises();
 
@@ -1286,7 +1420,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().throws();
 
-    const result = await reachability.gatherReachability();
+    const result = await reachability.gatherReachability('test');
 
     assert.empty(result);
 
@@ -1304,7 +1438,7 @@ describe('gatherReachability', () => {
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
     (reachability as any).performReachabilityChecks = sinon.stub().throws();
 
-    const result = await reachability.gatherReachability();
+    const result = await reachability.gatherReachability('test');
 
     assert.empty(result);
 
@@ -1339,7 +1473,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
 
-    const promise = reachability.gatherReachability();
+    const promise = reachability.gatherReachability('test');
 
     await simulateTimeout();
     await promise;
@@ -1385,7 +1519,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
 
-    const promise = reachability.gatherReachability();
+    const promise = reachability.gatherReachability('test');
     await simulateTimeout();
     await promise;
 
@@ -1419,7 +1553,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
 
-    const promise = reachability.gatherReachability();
+    const promise = reachability.gatherReachability('test');
 
     await simulateTimeout();
     await promise;
@@ -1454,7 +1588,7 @@ describe('gatherReachability', () => {
 
     reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
 
-    const promise = reachability.gatherReachability();
+    const promise = reachability.gatherReachability('test');
 
     await simulateTimeout();
     await promise;
@@ -1466,6 +1600,70 @@ describe('gatherReachability', () => {
       xtls: [], // empty list because TLS is disabled in config
     });
   });
+
+  it('retry of getClusters is succesfull', async () => {
+    webex.config.meetings.experimental = {
+      enableTcpReachability: true,
+      enableTlsReachability: false,
+    };
+
+    const getClustersResult = {
+      clusters: {
+        'cluster name': {
+          udp: ['testUDP1', 'testUDP2'],
+          tcp: ['testTCP1', 'testTCP2'],
+          xtls: ['testXTLS1', 'testXTLS2'],
+          isVideoMesh: false,
+        },
+      },
+      joinCookie: {id: 'id'},
+    };
+
+    const reachability = new Reachability(webex);
+
+    let getClustersCallCount = 0;
+    
+    reachability.reachabilityRequest.getClusters = sinon.stub().callsFake(() => {
+      getClustersCallCount++;
+
+      if (getClustersCallCount == 1) {
+        throw new Error('fake error');
+      }
+      
+      return getClustersResult;
+    });
+
+    const promise = reachability.gatherReachability('test');
+
+    await simulateTimeout();
+    await promise;
+    
+    assert.equal(getClustersCallCount, 2);
+
+    assert.calledOnce(clusterReachabilityCtorStub);
+  });
+
+  it('two failed calls to getClusters', async () => {
+    const reachability = new Reachability(webex);
+
+    let getClustersCallCount = 0;
+    
+    reachability.reachabilityRequest.getClusters = sinon.stub().callsFake(() => {
+      getClustersCallCount++;
+
+      throw new Error('fake error');
+    });
+
+    const promise = reachability.gatherReachability('test');
+
+    await simulateTimeout();
+    
+    await promise;
+    
+    assert.equal(getClustersCallCount, 2);
+
+    assert.neverCalledWith(clusterReachabilityCtorStub);
+  });
 });
 
 describe('getReachabilityResults', () => {

package/test/unit/spec/reachability/request.js

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';

package/test/unit/spec/roap/request.ts

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';

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

@@ -120,4 +120,35 @@ describe('RtcMetrics', () => {
     metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
     assert.calledOnce(anonymizeIpSpy);
   })
+
+  it('should send metrics on first stats-report', () => {
+    assert.callCount(webex.request, 0);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should send metrics on first stats-report after a new connection', () => {
+    assert.callCount(webex.request, 0);
+
+    // first stats-report should trigger a call to webex.request
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // subsequent stats-report doesn't trigger it
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 1);
+
+    // now, simulate a failure - that triggers a new connection and upload of the metrics
+    metrics.addMetrics(FAILURE_METRICS_ITEM);
+    assert.callCount(webex.request, 2);
+
+    // and another stats-report should trigger another upload of the metrics
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.callCount(webex.request, 3);
+  });
 });