@webex/plugin-meetings 3.12.0-next.9 → 3.12.0-next.90

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

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
 import { CapabilityState, WebCapabilities } from '@webex/web-capabilities';
@@ -63,6 +64,13 @@ describe('isAnyPublicClusterReachable', () => {
     );
   });
 
+  it('returns false when only xtls is reachable', async () => {
+    await checkIsClusterReachable(
+      {x: {udp: {result: 'unreachable'}, tcp: {result: 'unreachable'}, xtls: {result: 'reachable'}}},
+      false
+    );
+  });
+
   it('returns false when both tcp and udp are unreachable', async () => {
     await checkIsClusterReachable(
       {x: {udp: {result: 'unreachable'}, tcp: {result: 'unreachable'}}},
@@ -70,6 +78,13 @@ describe('isAnyPublicClusterReachable', () => {
     );
   });
 
+  it('returns false when udp, tcp and xtls are all unreachable', async () => {
+    await checkIsClusterReachable(
+      {x: {udp: {result: 'unreachable'}, tcp: {result: 'unreachable'}, xtls: {result: 'unreachable'}}},
+      false
+    );
+  });
+
   it('returns false when reachability result is empty', async () => {
     await checkIsClusterReachable({x: {}}, false);
   });
@@ -510,10 +525,7 @@ describe('gatherReachability', () => {
         return mockInstance;
       });
 
-    webex.config.meetings.experimental = {
-      enableTcpReachability: false,
-      enableTlsReachability: false,
-    };
+    webex.config.meetings.enableReachabilityChecks = {tcp: false, tls: false};
   });
 
   afterEach(() => {
@@ -1229,10 +1241,7 @@ describe('gatherReachability', () => {
       expectedMetrics,
     }) =>
       it(`works correctly for the case: ${title}`, async () => {
-        webex.config.meetings.experimental = {
-          enableTcpReachability: true,
-          enableTlsReachability: true,
-        };
+        webex.config.meetings.enableReachabilityChecks = 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 = {
@@ -1367,10 +1376,7 @@ describe('gatherReachability', () => {
   });
 
   it(`starts ip network version detection and includes the results in the metrics`, async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: true,
-    };
+    webex.config.meetings.enableReachabilityChecks = true;
     webex.internal.device.ipNetworkDetector = {
       supportsIpV4: true,
       supportsIpV6: true,
@@ -1447,10 +1453,7 @@ describe('gatherReachability', () => {
   });
 
   it('keeps updating reachability results after the 3s public cloud timeout expires', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: true,
-    };
+    webex.config.meetings.enableReachabilityChecks = true;
 
     const reachability = new Reachability(webex);
 
@@ -1546,10 +1549,7 @@ describe('gatherReachability', () => {
   });
 
   it('handles clientMediaIpsUpdated event by updating clientMediaIps in results', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: true,
-    };
+    webex.config.meetings.enableReachabilityChecks = true;
 
     const reachability = new Reachability(webex);
 
@@ -1634,10 +1634,7 @@ describe('gatherReachability', () => {
   });
 
   it('starts ClusterReachability on each media cluster', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: true,
-    };
+    webex.config.meetings.enableReachabilityChecks = true;
 
     const getClustersResult = {
       clusters: {
@@ -1686,10 +1683,7 @@ describe('gatherReachability', () => {
   });
 
   it('does not do TCP reachability if it is disabled in config', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: false,
-      enableTlsReachability: true,
-    };
+    webex.config.meetings.enableReachabilityChecks = {tcp: false, tls: true};
 
     const getClustersResult = {
       clusters: {
@@ -1720,10 +1714,7 @@ describe('gatherReachability', () => {
   });
 
   it('does not do TLS reachability if it is disabled in config', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: false,
-    };
+    webex.config.meetings.enableReachabilityChecks = {tcp: true, tls: false};
 
     const getClustersResult = {
       clusters: {
@@ -1755,10 +1746,7 @@ describe('gatherReachability', () => {
   });
 
   it('does not do TCP or TLS reachability if it is disabled in config', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: false,
-      enableTlsReachability: false,
-    };
+    webex.config.meetings.enableReachabilityChecks = {tcp: false, tls: false};
 
     const getClustersResult = {
       clusters: {
@@ -1789,12 +1777,40 @@ describe('gatherReachability', () => {
     }, undefined);
   });
 
-  it('retry of getClusters is succesfull', async () => {
-    webex.config.meetings.experimental = {
-      enableTcpReachability: true,
-      enableTlsReachability: false,
+  it('does UDP, TCP and TLS reachability by default (enableReachabilityChecks=true)', async () => {
+    webex.config.meetings.enableReachabilityChecks = true;
+
+    const getClustersResult = {
+      clusters: {
+        'cluster name': {
+          udp: ['testUDP1', 'testUDP2'],
+          tcp: ['testTCP1', 'testTCP2'],
+          xtls: ['testXTLS1', 'testXTLS2'],
+          isVideoMesh: false,
+        },
+      },
+      joinCookie: {id: 'id'},
     };
 
+    const reachability = new Reachability(webex);
+
+    reachability.reachabilityRequest.getClusters = sinon.stub().returns(getClustersResult);
+
+    const promise = reachability.gatherReachability('test');
+    await simulateTimeout();
+    await promise;
+
+    assert.calledOnceWithExactly(clusterReachabilityCtorStub, 'cluster name', {
+      isVideoMesh: false,
+      udp: ['testUDP1', 'testUDP2'],
+      tcp: ['testTCP1', 'testTCP2'],
+      xtls: ['testXTLS1', 'testXTLS2'],
+    }, undefined);
+  });
+
+  it('retry of getClusters is succesfull', async () => {
+    webex.config.meetings.enableReachabilityChecks = {tcp: true, tls: false};
+
     const getClustersResult = {
       clusters: {
         'cluster name': {
@@ -1866,10 +1882,7 @@ describe('gatherReachability', () => {
     };
 
     beforeEach(() => {
-      webex.config.meetings.experimental = {
-        enableTcpReachability: true,
-        enableTlsReachability: true,
-      };
+      webex.config.meetings.enableReachabilityChecks = true;
 
       receivedEvents = {
         done: 0,
@@ -2133,7 +2146,7 @@ describe('gatherReachability', () => {
         receivedEvents[event] = receivedEvents[event] + 1 || 1;
       });
     };
-    
+
     it('works as expected', async () => {
       setListener('reachability:stopped');
       setListener('reachability:done');
@@ -2948,4 +2961,4 @@ describe('isSubnetReachable', () => {
   it(`returns false if the subnet is unreachable`, () => {
     assert(!reachability.isSubnetReachable('11'));
   });
-});
+});

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

@@ -3,9 +3,40 @@ import {assert} from '@webex/test-helper-chai';
 import {
   convertStunUrlToTurn,
   convertStunUrlToTurnTls,
+  isReachabilityEnabled,
+  resolveReachabilityProtocols,
 } from '@webex/plugin-meetings/src/reachability/util';
 
 describe('plugin-meetings/src/reachability/util', () => {
+  describe('#resolveReachabilityProtocols()', () => {
+    [
+      {title: 'undefined defaults to all enabled', config: undefined, expected: {udp: true, tcp: true, tls: true}},
+      {title: 'true enables all protocols', config: true, expected: {udp: true, tcp: true, tls: true}},
+      {title: 'false disables all protocols', config: false, expected: {udp: false, tcp: false, tls: false}},
+      {title: 'empty object keeps udp on and defaults tcp/tls to enabled', config: {}, expected: {udp: true, tcp: true, tls: true}},
+      {title: 'object can disable tcp', config: {tcp: false}, expected: {udp: true, tcp: false, tls: true}},
+      {title: 'object can disable tls', config: {tls: false}, expected: {udp: true, tcp: true, tls: false}},
+      {title: 'object can disable both tcp and tls but udp stays on', config: {tcp: false, tls: false}, expected: {udp: true, tcp: false, tls: false}},
+    ].forEach(({title, config, expected}) => {
+      it(`resolves: ${title}`, () => {
+        assert.deepEqual(resolveReachabilityProtocols(config as any), expected);
+      });
+    });
+  });
+
+  describe('#isReachabilityEnabled()', () => {
+    [
+      {title: 'undefined', config: undefined, expected: true},
+      {title: 'true', config: true, expected: true},
+      {title: 'false', config: false, expected: false},
+      {title: 'object disabling tcp and tls (udp still on)', config: {tcp: false, tls: false}, expected: true},
+    ].forEach(({title, config, expected}) => {
+      it(`returns ${expected} for ${title}`, () => {
+        assert.equal(isReachabilityEnabled(config as any), expected);
+      });
+    });
+  });
+
   describe('#convertStunUrlToTurn()', () => {
     [
       {

package/test/unit/spec/recording-controller/index.js

@@ -35,6 +35,7 @@ describe('plugin-meetings', () => {
         beforeEach(() => {
           request = {
             request: sinon.stub().returns(Promise.resolve()),
+            locusDeltaRequest: sinon.stub().returns(Promise.resolve()),
           };
 
           controller = new RecordingController(request);
@@ -69,13 +70,13 @@ describe('plugin-meetings', () => {
 
             const result = controller.startRecording();
 
-            assert.calledWith(request.request, {
+            assert.calledWith(request.locusDeltaRequest, {
               uri: `${locusUrl}/controls`,
               body: {record: {recording: true, paused: false}},
               method: HTTP_VERBS.PATCH,
             });
 
-            assert.deepEqual(result, request.request.firstCall.returnValue);
+            assert.deepEqual(result, request.locusDeltaRequest.firstCall.returnValue);
           });
         });
 
@@ -103,13 +104,13 @@ describe('plugin-meetings', () => {
 
             const result = controller.stopRecording();
 
-            assert.calledWith(request.request, {
+            assert.calledWith(request.locusDeltaRequest, {
               uri: `${locusUrl}/controls`,
               body: {record: {recording: false, paused: false}},
               method: HTTP_VERBS.PATCH,
             });
 
-            assert.deepEqual(result, request.request.firstCall.returnValue);
+            assert.deepEqual(result, request.locusDeltaRequest.firstCall.returnValue);
           });
         });
 
@@ -139,13 +140,13 @@ describe('plugin-meetings', () => {
 
             const result = controller.pauseRecording();
 
-            assert.calledWith(request.request, {
+            assert.calledWith(request.locusDeltaRequest, {
               uri: `${locusUrl}/controls`,
               body: {record: {recording: true, paused: true}},
               method: HTTP_VERBS.PATCH,
             });
 
-            assert.deepEqual(result, request.request.firstCall.returnValue);
+            assert.deepEqual(result, request.locusDeltaRequest.firstCall.returnValue);
           });
         });
 
@@ -176,13 +177,13 @@ describe('plugin-meetings', () => {
 
             const result = controller.resumeRecording();
 
-            assert.calledWith(request.request, {
+            assert.calledWith(request.locusDeltaRequest, {
               uri: `${locusUrl}/controls`,
               body: {record: {recording: true, paused: false}},
               method: HTTP_VERBS.PATCH,
             });
 
-            assert.deepEqual(result, request.request.firstCall.returnValue);
+            assert.deepEqual(result, request.locusDeltaRequest.firstCall.returnValue);
           });
         });
       });