@webex/plugin-meetings 3.0.0-beta.25 → 3.0.0-beta.251

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

@@ -1,13 +1,22 @@
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
 import sinon from 'sinon';
-import Reachability from '@webex/plugin-meetings/src/reachability/';
+import Reachability, {ICECandidateResult} from '@webex/plugin-meetings/src/reachability/';
+import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
+
+import { IP_VERSION } from '@webex/plugin-meetings/src/constants';
 
 describe('isAnyClusterReachable', () => {
   let webex;
 
   beforeEach(() => {
     webex = new MockWebex();
+
+    sinon.stub(MeetingUtil, 'getIpVersion').returns(IP_VERSION.unknown);
+  });
+
+  afterEach(() => {
+    sinon.restore();
   });
 
   const checkIsClusterReachable = async (mockStorage: any, expectedValue: boolean) => {
@@ -66,19 +75,188 @@ describe('gatherReachability', () => {
   it('stores the reachability', async () => {
     const reachability = new Reachability(webex);
 
-    const clusters = {some: 'clusters'};
-    const reachabilityResults = {some: 'results'};
+    const reachabilityResults = {
+      clusters: {
+        clusterId: {
+          udp: 'testUDP',
+        },
+      },
+    };
+    const getClustersResult = {
+      clusters: {clusterId: 'cluster'},
+      joinCookie: {id: 'id'},
+    };
 
-    reachability.reachabilityRequest.getClusters = sinon.stub().returns(clusters);
-    (reachability as any).performReachabilityCheck = sinon.stub().returns(reachabilityResults)
+    reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
+    (reachability as any).performReachabilityCheck = sinon.stub().returns(reachabilityResults);
 
     const result = await reachability.gatherReachability();
 
     assert.equal(result, reachabilityResults);
 
-    const storedResult = await webex.boundedStorage.get('Reachability', 'reachability.result');
+    const storedResultForReachabilityResult = await webex.boundedStorage.get(
+      'Reachability',
+      'reachability.result'
+    );
+    const storedResultForJoinCookie = await webex.boundedStorage.get(
+      'Reachability',
+      'reachability.joinCookie'
+    );
+
+    assert.equal(JSON.stringify(result), storedResultForReachabilityResult);
+    assert.equal(JSON.stringify(getClustersResult.joinCookie), storedResultForJoinCookie);
+  });
+
+  it('does reachability only on udp', async () => {
+    const reachability = new Reachability(webex);
+
+    const getClustersResult = {
+      clusters: {clusterId: {
+        tcp: [
+          'stun:170.72.164.1:5004',
+          'stun:170.72.165.2:5004'
+        ],
+        udp: [
+            'stun:170.72.164.3:5004',
+            'stun:170.72.164.3:9000',
+        ],
+        xtls: [
+            'stun:external-media101.public.wjfkm-a-4.prod.infra.webex.com:443',
+            'stun:external-media94.public.wjfkm-a-8.prod.infra.webex.com:443'
+        ]
+      }},
+      joinCookie: {id: 'id'},
+    };
+
+    sinon.stub(reachability.reachabilityRequest, 'getClusters').returns(getClustersResult);
+
+    const createPeerConnectionStub = sinon.stub(reachability, 'createPeerConnection');
 
-    assert.equal(JSON.stringify(result), storedResult);
+    await reachability.gatherReachability();
+
+    // check that a peer connection was created with only the udp urls 
+    assert.calledOnceWithExactly(createPeerConnectionStub, {
+      key: 'clusterId',
+      config: {
+        iceServers: [
+          {
+            username: '',
+            credential: '',
+            urls: ['stun:170.72.164.3:5004'],
+          },
+          {
+            username: '',
+            credential: '',
+            urls: ['stun:170.72.164.3:9000'],
+          }
+        ],
+        iceCandidatePoolSize: '0',
+        iceTransportPolicy: 'all'
+      }
+    })
   });
 
+  describe('clientMediaIPs', () => {
+    let testingClass: TestReachability;
+
+    class TestReachability extends Reachability {
+      public testParseIceResultsToReachabilityResults(iceResults: Array<ICECandidateResult>) {
+        return this.parseIceResultsToReachabilityResults(iceResults);
+      }
+      public testAddPublicIP(peerConnection: RTCPeerConnection, publicIP?: string | null) {
+        return this.addPublicIP(peerConnection, publicIP);
+      }
+    }
+    beforeEach(() => {
+      testingClass = new TestReachability({webex});
+    });
+
+    it('calls parseIceResultsToReachabilityResults correctly', () => {
+      const res = testingClass.testParseIceResultsToReachabilityResults([
+        {
+          clusterId: 'id1',
+          elapsed: '12312',
+          publicIPs: ['1.1.1.1'],
+        },
+        {
+          clusterId: 'id2',
+          elapsed: null,
+          publicIPs: ['1.1.1.1'],
+        },
+        {
+          clusterId: 'id2',
+          elapsed: '14123',
+          publicIPs: undefined,
+        },
+      ]);
+
+      assert.deepEqual(res, {
+        id1: {
+          tcp: {
+            untested: 'true',
+          },
+          xtls: {
+            untested: 'true',
+          },
+          udp: {
+            clientMediaIPs: ['1.1.1.1'],
+            latencyInMilliseconds: '12312',
+            reachable: 'true',
+          },
+        },
+        id2: {
+          xtls: {
+            untested: 'true',
+          },
+          tcp: {
+            untested: 'true',
+          },
+          udp: {
+            latencyInMilliseconds: '14123',
+            reachable: 'true',
+          },
+        },
+      });
+    });
+
+    it('calls addPublicIP correctly with no existing public APIs', () => {
+      const peerConnection = {
+        connectionState: 'not_closed',
+      };
+
+      testingClass.testAddPublicIP(peerConnection as RTCPeerConnection, '1.1.1.1');
+
+      assert.deepEqual(peerConnection, {
+        connectionState: 'not_closed',
+        publicIPs: ['1.1.1.1'],
+      });
+    });
+
+    it('calls addPublicIP correctly with existing public APIs', () => {
+      const peerConnection = {
+        connectionState: 'not_closed',
+        publicIPs: ['2.2.2.2'],
+      };
+
+      testingClass.testAddPublicIP(peerConnection as any, '1.1.1.1');
+
+      assert.deepEqual(peerConnection, {
+        connectionState: 'not_closed',
+        publicIPs: ['2.2.2.2', '1.1.1.1'],
+      });
+    });
+
+    it('calls addPublicIP correctly null publicAPI', () => {
+      const peerConnection = {
+        connectionState: 'not_closed',
+      };
+
+      testingClass.testAddPublicIP(peerConnection as RTCPeerConnection, null);
+
+      assert.deepEqual(peerConnection, {
+        connectionState: 'not_closed',
+        publicIPs: null,
+      });
+    });
+  });
 });

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

@@ -0,0 +1,68 @@
+import sinon from 'sinon';
+import {assert} from '@webex/test-helper-chai';
+import MockWebex from '@webex/test-helper-mock-webex';
+import Meetings from '@webex/plugin-meetings';
+import ReachabilityRequest from '@webex/plugin-meetings/src/reachability/request';
+import {IP_VERSION} from '@webex/plugin-meetings/src/constants';
+
+
+describe('plugin-meetings/reachability', () => {
+  let reachabilityRequest;
+  let webex;
+
+  beforeEach(() => {
+    webex = new MockWebex({
+      children: {
+        meetings: Meetings,
+      },
+    });
+
+    webex.meetings.clientRegion = {
+      countryCode: 'US',
+      regionCode: 'WEST-COAST',
+    };
+
+    webex.internal = {
+      services: {
+        get: sinon.mock().returns('locusUrl'),
+        waitForCatalog: sinon.mock().returns(Promise.resolve({})),
+      },
+    };
+
+
+    reachabilityRequest = new ReachabilityRequest(webex);
+
+  });
+
+  describe('#getClusters', () => {
+    it('sends a GET request with the correct params', async () => {
+      webex.request = sinon.mock().returns(Promise.resolve({
+        body: {
+          clusterClasses: {
+            hybridMedia: ["clusterId"]
+          },
+          clusters: {"clusterId": {
+            udp: "testUDP"
+          }},
+          joinCookie: {anycastEntryPoint: "aws-eu-west-1"}
+        }
+      }));
+
+      const res = await reachabilityRequest.getClusters(IP_VERSION.only_ipv4);
+
+      const requestParams = webex.request.getCall(0).args[0];
+
+      assert.equal(requestParams.method, 'GET');
+      assert.equal(requestParams.resource, `clusters`);
+      assert.equal(requestParams.api, 'calliopeDiscovery');
+      assert.equal(requestParams.shouldRefreshAccessToken, false);
+
+      assert.deepEqual(requestParams.qs, {
+        JCSupport: 1,
+        ipver: 4,
+      });
+      assert.deepEqual(res.clusters.clusterId, {udp: "testUDP", isVideoMesh: true})
+      assert.deepEqual(res.joinCookie, {anycastEntryPoint: "aws-eu-west-1"})
+    });
+  });
+});

package/test/unit/spec/reconnection-manager/index.js

@@ -3,7 +3,6 @@ import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import sinon from 'sinon';
 import ReconnectionManager from '@webex/plugin-meetings/src/reconnection-manager';
-import Metrics from '@webex/plugin-meetings/src/metrics';
 
 const {assert} = chai;
 
@@ -16,7 +15,6 @@ describe('plugin-meetings', () => {
     let fakeMeeting;
 
     beforeEach(() => {
-      Metrics.postEvent = sinon.stub();
       fakeMediaConnection = {
         initiateOffer: sinon.stub().resolves({}),
         reconnect: sinon.stub().resolves({}),
@@ -43,8 +41,8 @@ describe('plugin-meetings', () => {
           webrtcMediaConnection: fakeMediaConnection,
         },
         mediaRequestManagers: {
-          audio: {commit: sinon.stub()},
-          video: {commit: sinon.stub()},
+          audio: {commit: sinon.stub(), clearPreviousRequests: sinon.stub()},
+          video: {commit: sinon.stub(), clearPreviousRequests: sinon.stub()},
         },
         roap: {
           doTurnDiscovery: sinon.stub().resolves({
@@ -60,14 +58,40 @@ describe('plugin-meetings', () => {
           updateMediaConnection: sinon.stub(),
         },
         webex: {
+          credentials: {
+            isUnverifiedGuest: false,
+          },
           meetings: {
             getMeetingByType: sinon.stub().returns(true),
             syncMeetings: sinon.stub().resolves({}),
           },
+          internal: {
+            newMetrics: {
+              submitClientEvent: sinon.stub()
+            }
+          }
         },
       };
     });
 
+    it('syncs meetings if it is not an unverified guest', async () => {
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      await rm.reconnect();
+
+      assert.calledOnce(rm.webex.meetings.syncMeetings);
+    });
+
+    it('does not sync meetings if it is an unverified guest', async () => {
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      rm.webex.credentials.isUnverifiedGuest = true;
+
+      await rm.reconnect();
+
+      assert.notCalled(rm.webex.meetings.syncMeetings);
+    });
+
     it('uses correct TURN TLS information on the reconnection', async () => {
       const rm = new ReconnectionManager(fakeMeeting);
 
@@ -82,27 +106,77 @@ describe('plugin-meetings', () => {
           credential: 'fake_turn_password',
         },
       ]);
+
+      assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.media.reconnecting',
+        options: {
+          meetingId: rm.meeting.id,
+        },
+      });
+
+      assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.media.recovered',
+        payload: {
+          recoveredBy: 'new',
+        },
+        options: {
+          meetingId: rm.meeting.id,
+        },
+      });
     });
 
-    it('does not re-request media for non-multistream meetings', async () => {
+    it('does not clear previous requests and re-request media for non-multistream meetings', async () => {
       fakeMeeting.isMultistream = false;
       const rm = new ReconnectionManager(fakeMeeting);
 
       await rm.reconnect();
 
+      assert.notCalled(fakeMeeting.mediaRequestManagers.audio.clearPreviousRequests);
+      assert.notCalled(fakeMeeting.mediaRequestManagers.video.clearPreviousRequests);
       assert.notCalled(fakeMeeting.mediaRequestManagers.audio.commit);
       assert.notCalled(fakeMeeting.mediaRequestManagers.video.commit);
     });
 
-    it('does re-request media for multistream meetings', async () => {
+    it('does clear previous requests and re-request media for multistream meetings', async () => {
       fakeMeeting.isMultistream = true;
       const rm = new ReconnectionManager(fakeMeeting);
 
       await rm.reconnect();
 
+      assert.calledOnce(fakeMeeting.mediaRequestManagers.audio.clearPreviousRequests);
+      assert.calledOnce(fakeMeeting.mediaRequestManagers.video.clearPreviousRequests);
       assert.calledOnce(fakeMeeting.mediaRequestManagers.audio.commit);
       assert.calledOnce(fakeMeeting.mediaRequestManagers.video.commit);
     });
+
+
+    it('sends the correct client event when reconnection fails', async () => {
+      sinon.stub(ReconnectionManager.prototype, 'executeReconnection').rejects();
+      fakeMeeting.isMultistream = true;
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      try {
+        await rm.reconnect();
+      } catch (err) {
+        assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+          name: 'client.call.aborted',
+          payload: {
+            errors: [
+              {
+                category: 'expected',
+                errorCode: 2008,
+                fatal: true,
+                name: 'media-engine',
+                shownToUser: false,
+              },
+            ],
+          },
+          options: {
+            meetingId: rm.meeting.id,
+          },
+        });
+      }
+    });
   });
 
   /**
@@ -110,7 +184,7 @@ describe('plugin-meetings', () => {
    * level causes testing errors in CI based around related files. Skipping this here until a solution
    * to this problem is generated.
    */
-  describe.skip('ReconnectionManager', () => {
+  describe('ReconnectionManager', () => {
     let reconnectionManager;
 
     beforeEach(() => {
@@ -203,10 +277,11 @@ describe('plugin-meetings', () => {
           assert.isTrue(reconnectionManager.iceState.disconnected);
         });
 
-        it('should return a promise that rejects after a duration', () => {
+        it('should return a promise that rejects after a duration', (done) => {
           reconnectionManager.iceState.timeoutDuration = 100;
 
-          return assert.isRejected(reconnectionManager.waitForIceReconnect());
+          assert.isRejected(reconnectionManager.waitForIceReconnect());
+          done();
         });
 
         it('should resolve return a resolved promise when triggered', () => {