@webex/plugin-meetings 3.0.0-beta.34 → 3.0.0-beta.340

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

@@ -1,114 +1,255 @@
-import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
+import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
-import Metrics from '@webex/plugin-meetings/src/metrics';
-
+import Meetings from '@webex/plugin-meetings';
 import RoapRequest from '@webex/plugin-meetings/src/roap/request';
-
-
-describe('RoapRequest', () => {
-  describe('attachRechabilityData', () => {
-    let webex;
-
-    beforeEach(() => {
-      webex = new MockWebex();
+import {IP_VERSION, REACHABILITY} from '@webex/plugin-meetings/src/constants';
+
+describe('plugin-meetings/roap', () => {
+  let roapRequest;
+  let webex;
+  const locusUrl = 'locusUrl';
+
+  beforeEach(async () => {
+    webex = new MockWebex({
+      children: {
+        meetings: Meetings,
+      },
     });
-    
-    it('attaches the reachability data when it exists', async () => {
-      // @ts-ignore
-      const roapRequest = new RoapRequest({}, {parent: webex});
 
-      const sdp = {some: 'attribute'};
+    webex.meetings.clientRegion = {
+      countryCode: 'US',
+      regionCode: 'WEST-COAST',
+    };
+
+    webex.internal = {
+      services: {
+        get: sinon.mock().returns(locusUrl),
+        waitForCatalog: sinon.mock().returns(Promise.resolve({})),
+      },
+      device: {
+        url: 'url',
+      },
+      newMetrics: {
+        submitClientEvent: sinon.stub()
+      },
+    };
+
+    // @ts-ignore
+    roapRequest = new RoapRequest({webex});
+
+    roapRequest.request = sinon.mock().returns(
+      Promise.resolve({
+        body: {
+          locus: {
+            roapSeq: '',
+            id: '',
+            url: 'url/path',
+            fullState: {
+              lastActive: 'lastActive',
+            },
+          },
+        },
+      })
+    );
 
-      const reachabilitData = {reachability: 'data'};
+    await webex.boundedStorage.put(
+      REACHABILITY.namespace,
+      REACHABILITY.localStorageJoinCookie,
+      JSON.stringify({
+        anycastEntryPoint: 'aws-eu-west-1',
+      })
+    );
+    await webex.boundedStorage.put(
+      REACHABILITY.namespace,
+      REACHABILITY.localStorageResult,
+      JSON.stringify({
+        clusterId: {
+          udp: { result: 'reachable', latencyInMilliseconds: 10 },
+          tcp: { result: 'unreachable' },
+          isVideoMesh: false,
+        },
+      })
+    );
+  });
 
-      await webex.boundedStorage.put(
-        'Reachability',
-        'reachability.result',
-        JSON.stringify(reachabilitData)
-      );
+  describe('#attachReachabilityData', () => {
+    it('returns the correct reachability data', async () => {
+      const res = await roapRequest.attachReachabilityData({});
+
+      assert.deepEqual(res.localSdp, {
+        reachability: {
+          clusterId: {
+            udp: {
+              reachable: 'true',
+              latencyInMilliseconds: '10',
+            },
+            tcp: {
+              reachable: 'false',
+            },
+            xtls: {
+              untested: 'true',
+            }
+          },
+        },
+      });
+      assert.deepEqual(res.joinCookie, {
+        anycastEntryPoint: 'aws-eu-west-1',
+      });
+    });
 
-      const newSdp = await roapRequest.attachRechabilityData(sdp);
+    it('handles the case when reachability data does not exist', async () => {
+      await webex.boundedStorage.del(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie);
 
-      assert.deepEqual(newSdp, {
+      await webex.boundedStorage.del(REACHABILITY.namespace, REACHABILITY.localStorageResult);
+      const sdp = {
         some: 'attribute',
-        reachability: reachabilitData
-      })
-    });
-  
-    it('handles the case when realiability data does not exist', async () => {
-      // @ts-ignore
-      const roapRequest = new RoapRequest({}, {parent: webex});
+      };
 
-      const sdp = {some: 'attribute'};
+      const result = await roapRequest.attachReachabilityData(sdp);
 
-      const newSdp = await roapRequest.attachRechabilityData(sdp);
-
-      assert.deepEqual(newSdp, sdp);
+      assert.deepEqual(result, {
+        joinCookie: undefined,
+        localSdp: {
+          some: 'attribute',
+        },
+      });
     });
   });
 
   describe('sendRoap', () => {
-    let webex;
-
-    beforeEach(() => {
-      webex = new MockWebex();
-    });
-
-    it('calls attachReliabilityData', async () => {
-      Metrics.postEvent = sinon.stub();
+    it('includes joinCookie in the request correctly', async () => {
+      const locusMediaRequest = {send: sinon.stub().resolves({body: {locus: {}}})};
+      const ipVersion = IP_VERSION.unknown;
 
-      // @ts-ignore
-      const roapRequest = new RoapRequest({}, {parent: webex});
-
-      const newSdp = {new: 'sdp'}
+      await roapRequest.sendRoap({
+        locusSelfUrl: locusUrl,
+        ipVersion,
+        mediaId: 'mediaId',
+        roapMessage: {
+          seq: 'seq',
+        },
+        meetingId: 'meeting-id',
+        locusMediaRequest,
+      });
 
-      roapRequest.attachRechabilityData = sinon.stub().returns(Promise.resolve(newSdp));
-      webex.request.returns(Promise.resolve({
-        body: {
-          locus: {}
-        }
-      }))
+      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.request',
+        options: {
+          meetingId: 'meeting-id',
+        },
+      });
 
-      const result = await roapRequest.sendRoap({
-        roapMessage: {seq: 1},
-        locusSelfUrl: 'locusSelfUrl',
-        mediaId: 'mediaId',
-        correlationId: 'correlationId',
-        audioMuted: true,
-        videoMuted: true,
-        meetingId: 'meetingId',
-        preferTranscoding: true
+      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.response',
+        options: {
+          meetingId: 'meeting-id',
+        },
       });
 
-      assert.calledOnceWithExactly(webex.request, {
-        uri: 'locusSelfUrl/media',
-        method: 'PUT',
-        body: {
-          device: {
-            url: undefined,
-            deviceType: undefined,
+      const requestParams = locusMediaRequest.send.getCall(0).args[0];
+      assert.deepEqual(requestParams, {
+        type: 'RoapMessage',
+        selfUrl: locusUrl,
+        ipVersion,
+        joinCookie: {
+          anycastEntryPoint: 'aws-eu-west-1',
+        },
+        mediaId: 'mediaId',
+        roapMessage: {
+          seq: 'seq',
+        },
+        reachability: {
+          clusterId: {
+            tcp: {
+              reachable: 'false',
+            },
+            udp: {
+              latencyInMilliseconds: '10',
+              reachable: 'true',
+            },
+            xtls: {
+              untested: 'true',
+            },
           },
-          correlationId: 'correlationId',
-          localMedias: [{
-            localSdp: JSON.stringify(newSdp),
-            mediaId: 'mediaId'
-          }],
-          clientMediaPreferences: {preferTranscoding: true}
         },
       });
+    });
 
-      assert.calledOnceWithExactly(roapRequest.attachRechabilityData, {
-        roapMessage: {seq: 1},
-        audioMuted: true,
-        videoMuted: true
+    it('sends correct client event when fails', async () => {
+      const locusMediaRequest = {send: sinon.stub().rejects({code: 300, message: 'error'})};
+      try {
+        await roapRequest.sendRoap({
+          locusSelfUrl: locusUrl,
+          mediaId: 'mediaId',
+          roapMessage: {
+            seq: 'seq',
+          },
+          meetingId: 'meeting-id',
+          locusMediaRequest,
+        });
+      } catch (err) {
+        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+          name: 'client.locus.media.response',
+          options: {
+            meetingId: 'meeting-id',
+            rawError: {code: 300, message: 'error'},
+          },
+        });
+      }
+    });
+  });
+
+  it('calls attachReachabilityData when sendRoap', async () => {
+    const locusMediaRequest = { send: sinon.stub().resolves({body: {locus: {}}})};
+
+    const newSdp = {
+      new: 'sdp',
+      reachability: { someResult: 'whatever' }
+    };
+    const ipVersion = IP_VERSION.only_ipv6;
+
+    roapRequest.attachReachabilityData = sinon.stub().returns(
+      Promise.resolve({
+        localSdp: newSdp,
+        joinCookie: {
+          anycastEntryPoint: 'aws-eu-west-1',
+        },
       })
+    );
+
+    await roapRequest.sendRoap({
+      roapMessage: {
+        seq: 1,
+      },
+      locusSelfUrl: 'locusSelfUrl',
+      ipVersion,
+      mediaId: 'mediaId',
+      meetingId: 'meetingId',
+      preferTranscoding: true,
+      locusMediaRequest
+    });
 
-      assert.deepEqual(result, {
-        locus: {
-          roapSeq: 1
-        }
-      });
+    const requestParams = locusMediaRequest.send.getCall(0).args[0];
+
+    assert.deepEqual(requestParams, {
+      type: 'RoapMessage',
+      selfUrl: 'locusSelfUrl',
+      ipVersion,
+      joinCookie: {
+        anycastEntryPoint: 'aws-eu-west-1',
+      },
+      mediaId: 'mediaId',
+      roapMessage: {
+        seq: 1,
+      },
+      reachability: { someResult: 'whatever' },
     });
-  })
+
+    assert.calledOnceWithExactly(roapRequest.attachReachabilityData, {
+      roapMessage: {
+        seq: 1,
+      },
+    });
+  });
 });

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

@@ -5,8 +5,10 @@ import TurnDiscovery from '@webex/plugin-meetings/src/roap/turnDiscovery';
 import Metrics from '@webex/plugin-meetings/src/metrics';
 import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
 import RoapRequest from '@webex/plugin-meetings/src/roap/request';
+import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 
 import testUtils from '../../../utils/testUtils';
+import { IP_VERSION } from '../../../../src/constants';
 
 describe('TurnDiscovery', () => {
   let clock;
@@ -23,6 +25,7 @@ describe('TurnDiscovery', () => {
     clock = sinon.useFakeTimers();
 
     sinon.stub(Metrics, 'sendBehavioralMetric');
+    sinon.stub(MeetingUtil, 'getIpVersion').returns(IP_VERSION.unknown);
 
     mockRoapRequest = {
       sendRoap: sinon.fake.resolves({mediaConnections: FAKE_MEDIA_CONNECTIONS_FROM_LOCUS}),
@@ -30,11 +33,6 @@ describe('TurnDiscovery', () => {
 
     testMeeting = {
       id: 'fake meeting id',
-      config: {
-        experimental: {
-          enableTurnDiscovery: true,
-        },
-      },
       correlationId: 'fake correlation id',
       selfUrl: 'fake self url',
       mediaId: 'fake media id',
@@ -50,8 +48,11 @@ describe('TurnDiscovery', () => {
         testMeeting.roapSeq = newSeq;
       }),
       updateMediaConnections: sinon.stub(),
-      webex: {meetings: {reachability: {isAnyClusterReachable: () => Promise.resolve(false)}}},
-      isMultistream: false
+      webex: {meetings: {reachability: {
+        isAnyPublicClusterReachable: () => Promise.resolve(false),
+      }}},
+      isMultistream: false,
+      locusMediaRequest: { fake: true },
     };
   });
 
@@ -68,20 +69,24 @@ describe('TurnDiscovery', () => {
     await testUtils.flushPromises();
 
     assert.calledOnce(mockRoapRequest.sendRoap);
-    assert.calledWith(mockRoapRequest.sendRoap, {
+
+    const expectedSendRoapArgs: any = {
       roapMessage: {
         messageType,
         version: '2',
         seq: expectedSeq,
       },
-      correlationId: testMeeting.correlationId,
       locusSelfUrl: testMeeting.selfUrl,
       mediaId: expectedMediaId,
-      audioMuted: testMeeting.audio?.isLocallyMuted(),
-      videoMuted: testMeeting.video?.isLocallyMuted(),
       meetingId: testMeeting.id,
-      preferTranscoding: !testMeeting.isMultistream
-    });
+      locusMediaRequest: testMeeting.locusMediaRequest,
+    };
+
+    if (messageType === 'TURN_DISCOVERY_REQUEST') {
+      expectedSendRoapArgs.ipVersion = 0;
+    }
+    
+    assert.calledWith(mockRoapRequest.sendRoap, expectedSendRoapArgs);
 
     if (messageType === 'TURN_DISCOVERY_REQUEST') {
       // check also that we've applied the media connections from the response
@@ -143,6 +148,44 @@ describe('TurnDiscovery', () => {
       });
     });
 
+    it('sends TURN_DISCOVERY_REQUEST, waits for response and sends OK when isForced = true when cluster is reachable', async () => {
+      const prev = testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable;
+      testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable = sinon.stub().resolves(true);
+
+      const td = new TurnDiscovery(mockRoapRequest);
+      const result = td.doTurnDiscovery(testMeeting, false, true);
+
+      // We ignore reachability results so we don't get skip reason
+      assert.notCalled(testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable);
+
+      // check that TURN_DISCOVERY_REQUEST was sent
+      await checkRoapMessageSent('TURN_DISCOVERY_REQUEST', 0);
+      // @ts-ignore
+      mockRoapRequest.sendRoap.resetHistory();
+      // simulate the response
+      td.handleTurnDiscoveryResponse({
+        headers: [
+          `x-cisco-turn-url=${FAKE_TURN_URL}`,
+          `x-cisco-turn-username=${FAKE_TURN_USERNAME}`,
+          `x-cisco-turn-password=${FAKE_TURN_PASSWORD}`,
+        ]
+      });
+      await testUtils.flushPromises();
+      // check that we've sent OK
+      await checkRoapMessageSent('OK', 0);
+
+      const {turnServerInfo, turnDiscoverySkippedReason} = await result;
+      assert.deepEqual(turnServerInfo, {
+        url: FAKE_TURN_URL,
+        username: FAKE_TURN_USERNAME,
+        password: FAKE_TURN_PASSWORD
+      });
+      assert.isUndefined(turnDiscoverySkippedReason);
+
+      // restore previous callback
+      testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable = prev;
+    });
+
     it('sends TURN_DISCOVERY_REQUEST with empty mediaId when isReconnecting is true', async () => {
       const td = new TurnDiscovery(mockRoapRequest);
 
@@ -214,24 +257,6 @@ describe('TurnDiscovery', () => {
       assert.isUndefined(turnDiscoverySkippedReason);
     });
 
-    it('resolves with undefined if turn discovery feature is disabled in config', async () => {
-      const prevConfigValue = testMeeting.config.experimental.enableTurnDiscovery;
-
-      testMeeting.config.experimental.enableTurnDiscovery = false;
-      // @ts-ignore
-      const result = await new TurnDiscovery(mockRoapRequest).doTurnDiscovery(testMeeting);
-
-      const {turnServerInfo, turnDiscoverySkippedReason} = result;
-
-      assert.isUndefined(turnServerInfo);
-      assert.equal(turnDiscoverySkippedReason, 'config');
-      assert.notCalled(mockRoapRequest.sendRoap);
-      assert.notCalled(Metrics.sendBehavioralMetric);
-
-      // restore previous config
-      testMeeting.config.experimental.enableTurnDiscovery = prevConfigValue;
-    });
-
     it('resolves with undefined if sending the request fails', async () => {
       const td = new TurnDiscovery(mockRoapRequest);
 
@@ -247,8 +272,8 @@ describe('TurnDiscovery', () => {
     });
 
     it('resolves with undefined when cluster is reachable', async () => {
-      const prev = testMeeting.webex.meetings.reachability.isAnyClusterReachable;
-      testMeeting.webex.meetings.reachability.isAnyClusterReachable = () => Promise.resolve(true);
+      const prev = testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable;
+      testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable = () => Promise.resolve(true);
       const result = await new TurnDiscovery(mockRoapRequest).doTurnDiscovery(testMeeting);
 
       const {turnServerInfo, turnDiscoverySkippedReason} = result;
@@ -257,7 +282,7 @@ describe('TurnDiscovery', () => {
       assert.equal(turnDiscoverySkippedReason, 'reachability');
       assert.notCalled(mockRoapRequest.sendRoap);
       assert.notCalled(Metrics.sendBehavioralMetric);
-      testMeeting.webex.meetings.reachability.isAnyClusterReachable = prev;
+      testMeeting.webex.meetings.reachability.isAnyPublicClusterReachable = prev;
     });
 
     it("resolves with undefined if we don't get a response within 10s", async () => {
@@ -367,6 +392,23 @@ describe('TurnDiscovery', () => {
     });
   });
 
+  describe('isSkipped', () => {
+    [
+      {isAnyPublicClusterReachable: true, expectedIsSkipped: true},
+      {isAnyPublicClusterReachable: false, expectedIsSkipped: false},
+    ].forEach(({isAnyPublicClusterReachable, expectedIsSkipped}) => {
+      it(`returns ${expectedIsSkipped} when isAnyPublicClusterReachable() returns ${isAnyPublicClusterReachable ? 'true' : 'false'}`, async () => {
+        sinon.stub(testMeeting.webex.meetings.reachability, 'isAnyPublicClusterReachable').resolves(isAnyPublicClusterReachable);
+
+        const td = new TurnDiscovery(mockRoapRequest);
+
+        const isSkipped = await td.isSkipped(testMeeting);
+
+        assert.equal(isSkipped, expectedIsSkipped);
+      })
+    })
+  })
+
   describe('handleTurnDiscoveryResponse', () => {
     it("doesn't do anything if turn discovery was not started", () => {
       const td = new TurnDiscovery(mockRoapRequest);

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

@@ -0,0 +1,93 @@
+import RtcMetrics from '@webex/plugin-meetings/src/rtcMetrics';
+import MockWebex from '@webex/test-helper-mock-webex';
+import {assert} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+import RTC_METRICS from '../../../../src/rtcMetrics/constants';
+
+const FAKE_METRICS_ITEM = {payload: ['fake-metrics']};
+
+const STATS_WITH_IP = '{\"id\":\"RTCIceCandidate_/kQs0ZNU\",\"type\":\"remote-candidate\",\"transportId\":\"RTCTransport_0_1\",\"isRemote\":true,\"ip\":\"11.22.111.255\",\"address\":\"11.22.111.255\",\"port\":5004,\"protocol\":\"udp\",\"candidateType\":\"host\",\"priority\":2130706431}';
+const STATS_WITH_IP_RESULT = '{\"id\":\"RTCIceCandidate_/kQs0ZNU\",\"type\":\"remote-candidate\",\"transportId\":\"RTCTransport_0_1\",\"isRemote\":true,\"ip\":\"11.22.111.240\",\"address\":\"11.22.111.240\",\"port\":5004,\"protocol\":\"udp\",\"candidateType\":\"host\",\"priority\":2130706431}';
+
+describe('RtcMetrics', () => {
+  let metrics: RtcMetrics;
+  let webex: MockWebex;
+  let clock;
+  let anonymizeIpSpy;
+
+  const sandbox = sinon.createSandbox();
+
+  beforeEach(() => {
+    clock = sinon.useFakeTimers();
+    webex = new MockWebex();
+    metrics = new RtcMetrics(webex, 'mock-meeting-id', 'mock-correlation-id');
+    anonymizeIpSpy = sandbox.spy(metrics, 'anonymizeIp');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  it('sendMetrics should send a webex request', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetrics();
+
+    assert.callCount(webex.request, 1);
+    assert.calledWithMatch(webex.request, sinon.match.has('headers', {
+      type: 'webrtcMedia',
+      appId: RTC_METRICS.APP_ID,
+    }));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].data[0].payload', FAKE_METRICS_ITEM.payload));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].meetingId', 'mock-meeting-id'));
+    assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
+  });
+
+  it('should have a defined sendMetricsInQueue function which is public', () => {
+    assert.isDefined(metrics.sendMetricsInQueue);
+    assert.isFunction(metrics.sendMetricsInQueue);
+  });
+
+  it('should send metrics requests over time', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    assert.deepEqual(metrics.metricsQueue, [FAKE_METRICS_ITEM]);
+    clock.tick(60 * 1000);
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should not send requests with no items in the queue', () => {
+    clock.tick(60 * 1000);
+    assert.notCalled(webex.request);
+  });
+
+  it('sendMetricsInQueue should send metrics if any exist in the queue', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    (metrics as any).sendMetricsInQueue();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should clear out metrics on close', () => {
+    assert.notCalled(webex.request);
+
+    metrics.addMetrics(FAKE_METRICS_ITEM);
+    metrics.closeMetrics();
+
+    assert.callCount(webex.request, 1);
+  });
+
+  it('should anonymize IP addresses', () => {
+    assert.strictEqual(metrics.anonymizeIp(STATS_WITH_IP), STATS_WITH_IP_RESULT);
+  });
+
+  it('should call anonymizeIp', () => {
+    metrics.addMetrics({ name: 'stats-report', payload: [STATS_WITH_IP] });
+    assert.calledOnce(anonymizeIpSpy);
+  })
+});