@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.21

package/src/roap/request.ts

@@ -0,0 +1,157 @@
+/* global window */
+// @ts-ignore
+import {StatelessWebexPlugin} from '@webex/webex-core';
+
+import LoggerProxy from '../common/logs/logger-proxy';
+import {MEDIA, HTTP_VERBS, REACHABILITY} from '../constants';
+import Metrics from '../metrics';
+import {eventType} from '../metrics/config';
+
+/**
+ * @class RoapRequest
+ */
+export default class RoapRequest extends StatelessWebexPlugin {
+  /**
+   * Joins a meeting via ROAP
+   * @param {Object} localSdp
+   * @returns {Promise} returns a promise that resolves/rejects whatever the request does
+   */
+  async attachRechabilityData(localSdp) {
+    // @ts-ignore
+    const reachabilityData = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorage)
+      .catch(() => {});
+
+    if (reachabilityData) {
+      try {
+        const reachabilityResult = JSON.parse(reachabilityData);
+
+        /* istanbul ignore else */
+        if (reachabilityResult && Object.keys(reachabilityResult).length) {
+          localSdp.reachability = reachabilityResult;
+        }
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`
+        );
+      }
+    }
+
+    return localSdp;
+  }
+
+  /**
+   * Sends a ROAP message
+   * @param {Object} options
+   * @param {Object} options.roapMessage
+   * @param {String} options.locusSelfUrl
+   * @param {String} options.mediaId
+   * @param {String} options.correlationId
+   * @param {Boolean} options.audioMuted
+   * @param {Boolean} options.videoMuted
+   * @param {String} options.meetingId
+   * @param {Boolean} options.preferTranscoding
+   * @returns {Promise} returns the response/failure of the request
+   */
+  sendRoap(options: {
+    roapMessage: any;
+    locusSelfUrl: string;
+    mediaId: string;
+    correlationId: string;
+    audioMuted: boolean;
+    videoMuted: boolean;
+    meetingId: string;
+    preferTranscoding?: boolean;
+  }) {
+    const {roapMessage, locusSelfUrl, mediaId, correlationId, meetingId} = options;
+
+    if (!mediaId) {
+      LoggerProxy.logger.info('Roap:request#sendRoap --> Race Condition /call mediaID not present');
+    }
+
+    const mediaUrl = `${locusSelfUrl}/${MEDIA}`;
+    // @ts-ignore
+    const deviceUrl = this.webex.internal.device.url;
+
+    LoggerProxy.logger.info(
+      `Roap:request#sendRoap --> ${mediaUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
+    );
+
+    Metrics.postEvent({event: eventType.MEDIA_REQUEST, meetingId});
+
+    return this.attachRechabilityData({
+      roapMessage,
+      // eslint-disable-next-line no-warning-comments
+      // TODO: check whats the need for video and audiomute
+      audioMuted: !!options.audioMuted,
+      videoMuted: !!options.videoMuted,
+    }).then((sdpWithReachability) => {
+      // @ts-ignore
+      return this.webex
+        .request({
+          uri: mediaUrl,
+          method: HTTP_VERBS.PUT,
+          body: {
+            device: {
+              url: deviceUrl,
+              // @ts-ignore
+              deviceType: this.config.meetings.deviceType,
+            },
+            correlationId,
+            localMedias: [
+              {
+                localSdp: JSON.stringify(sdpWithReachability),
+                mediaId: options.mediaId,
+              },
+            ],
+            clientMediaPreferences: {
+              preferTranscoding: options.preferTranscoding ?? true,
+            },
+          },
+        })
+        .then((res) => {
+          Metrics.postEvent({event: eventType.MEDIA_RESPONSE, meetingId});
+
+          // always it will be the first mediaConnection Object
+          const mediaConnections =
+            res.body.mediaConnections &&
+            res.body.mediaConnections.length > 0 &&
+            res.body.mediaConnections[0];
+
+          LoggerProxy.logger.info(
+            `Roap:request#sendRoap --> response:${JSON.stringify(
+              mediaConnections,
+              null,
+              2
+            )}'\n StatusCode:'${res.statusCode}`
+          );
+          const {locus} = res.body;
+
+          locus.roapSeq = options.roapMessage.seq;
+
+          return {
+            locus,
+            ...(mediaConnections && {mediaConnections: res.body.mediaConnections}),
+          };
+        })
+        .catch((err) => {
+          Metrics.postEvent({
+            event: eventType.MEDIA_RESPONSE,
+            meetingId,
+            data: {error: Metrics.parseLocusError(err, true)},
+          });
+          LoggerProxy.logger.error(
+            `Roap:request#sendRoap --> Error:${JSON.stringify(err, null, 2)}`
+          );
+          LoggerProxy.logger.error(
+            `Roap:request#sendRoapRequest --> errorBody:${JSON.stringify(
+              roapMessage,
+              null,
+              2
+            )} + '\\n mediaId:'${options.mediaId}`
+          );
+          throw err;
+        });
+    });
+  }
+}

package/src/roap/turnDiscovery.ts

@@ -1,3 +1,4 @@
+// @ts-ignore - Types not available for @webex/common
 import {Defer} from '@webex/common';
 
 import Metrics from '../metrics';
@@ -6,6 +7,7 @@ import LoggerProxy from '../common/logs/logger-proxy';
 import {ROAP} from '../constants';
 
 import RoapRequest from './request';
+import Meeting from '../meeting';
 
 const TURN_DISCOVERY_TIMEOUT = 10; // in seconds
 
@@ -46,7 +48,6 @@ export default class TurnDiscovery {
     };
   }
 
-
   /**
    * waits for TURN_DISCOVERY_RESPONSE message to arrive
    *
@@ -54,22 +55,30 @@ export default class TurnDiscovery {
    * @private
    * @memberof Roap
    */
-  waitForTurnDiscoveryResponse() {
+  private waitForTurnDiscoveryResponse() {
     if (!this.defer) {
-      LoggerProxy.logger.warn('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress');
+      LoggerProxy.logger.warn(
+        'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress'
+      );
 
-      return Promise.reject(new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()'));
+      return Promise.reject(
+        new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()')
+      );
     }
 
     const {defer} = this;
 
     this.responseTimer = setTimeout(() => {
-      LoggerProxy.logger.warn(`Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`);
+      LoggerProxy.logger.warn(
+        `Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`
+      );
 
       defer.reject(new Error('Timed out waiting for TURN_DISCOVERY_RESPONSE'));
     }, TURN_DISCOVERY_TIMEOUT * 1000);
 
-    LoggerProxy.logger.info('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...');
+    LoggerProxy.logger.info(
+      'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...'
+    );
 
     return defer.promise;
   }
@@ -82,11 +91,14 @@ export default class TurnDiscovery {
    * @public
    * @memberof Roap
    */
-  handleTurnDiscoveryResponse(roapMessage) {
+  public handleTurnDiscoveryResponse(roapMessage: object) {
+    // @ts-ignore - Fix missing type
     const {headers} = roapMessage;
 
     if (!this.defer) {
-      LoggerProxy.logger.warn('Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response');
+      LoggerProxy.logger.warn(
+        'Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response'
+      );
 
       return;
     }
@@ -103,7 +115,9 @@ export default class TurnDiscovery {
       // check if it matches any of our expected headers
       expectedHeaders.forEach((expectedHeader) => {
         if (receivedHeader.startsWith(`${expectedHeader.headerName}=`)) {
-          this.turnInfo[expectedHeader.field] = receivedHeader.substring(expectedHeader.headerName.length + 1);
+          this.turnInfo[expectedHeader.field] = receivedHeader.substring(
+            expectedHeader.headerName.length + 1
+          );
           foundHeaders += 1;
         }
       });
@@ -113,11 +127,18 @@ export default class TurnDiscovery {
     this.responseTimer = undefined;
 
     if (foundHeaders !== expectedHeaders.length) {
-      LoggerProxy.logger.warn(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(headers)}`);
-      this.defer.reject(new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`));
-    }
-    else {
-      LoggerProxy.logger.info(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`);
+      LoggerProxy.logger.warn(
+        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(
+          headers
+        )}`
+      );
+      this.defer.reject(
+        new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`)
+      );
+    } else {
+      LoggerProxy.logger.info(
+        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`
+      );
       this.defer.resolve();
     }
   }
@@ -131,9 +152,11 @@ export default class TurnDiscovery {
    * @private
    * @memberof Roap
    */
-  sendRoapTurnDiscoveryRequest(meeting, isReconnecting) {
+  sendRoapTurnDiscoveryRequest(meeting: Meeting, isReconnecting: boolean) {
     if (this.defer) {
-      LoggerProxy.logger.warn('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress');
+      LoggerProxy.logger.warn(
+        'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress'
+      );
 
       return Promise.resolve();
     }
@@ -146,17 +169,22 @@ export default class TurnDiscovery {
       seq: TURN_DISCOVERY_SEQ,
     };
 
-    LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST');
+    LoggerProxy.logger.info(
+      'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST'
+    );
 
     return this.roapRequest
       .sendRoap({
         roapMessage,
         correlationId: meeting.correlationId,
+        // @ts-ignore - Fix missing type
         locusSelfUrl: meeting.selfUrl,
+        // @ts-ignore - Fix missing type
         mediaId: isReconnecting ? '' : meeting.mediaId,
         audioMuted: meeting.isAudioMuted(),
         videoMuted: meeting.isVideoMuted(),
-        meetingId: meeting.id
+        meetingId: meeting.id,
+        preferTranscoding: !meeting.isMultistream,
       })
       .then(({mediaConnections}) => {
         if (mediaConnections) {
@@ -172,7 +200,7 @@ export default class TurnDiscovery {
    * @param {Meeting} meeting
    * @returns {Promise}
    */
-  sendRoapOK(meeting) {
+  sendRoapOK(meeting: Meeting) {
     LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapOK --> sending OK');
 
     return this.roapRequest.sendRoap({
@@ -181,12 +209,15 @@ export default class TurnDiscovery {
         version: ROAP.ROAP_VERSION,
         seq: TURN_DISCOVERY_SEQ,
       },
+      // @ts-ignore - fix type
       locusSelfUrl: meeting.selfUrl,
+      // @ts-ignore - fix type
       mediaId: meeting.mediaId,
       correlationId: meeting.correlationId,
       audioMuted: meeting.isAudioMuted(),
       videoMuted: meeting.isVideoMuted(),
-      meetingId: meeting.id
+      meetingId: meeting.id,
+      preferTranscoding: !meeting.isMultistream,
     });
   }
 
@@ -207,18 +238,28 @@ export default class TurnDiscovery {
    *                                 media connection just after a reconnection
    * @returns {Promise}
    */
-  doTurnDiscovery(meeting, isReconnecting) {
-    const isAnyClusterReachable = meeting.webex.meetings.reachability.isAnyClusterReachable();
+  async doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean) {
+    // @ts-ignore - fix type
+    const isAnyClusterReachable = await meeting.webex.meetings.reachability.isAnyClusterReachable();
 
     if (isAnyClusterReachable) {
-      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery');
-      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'reachability'});
+      LoggerProxy.logger.info(
+        'Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery'
+      );
+
+      return {
+        turnServerInfo: undefined,
+        turnDiscoverySkippedReason: 'reachability',
+      };
     }
 
+    // @ts-ignore - fix type
     if (!meeting.config.experimental.enableTurnDiscovery) {
-      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');
+      LoggerProxy.logger.info(
+        'Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it'
+      );
 
-      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});
+      return {turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'};
     }
 
     return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting)
@@ -233,19 +274,18 @@ export default class TurnDiscovery {
       })
       .catch((e) => {
         // we catch any errors and resolve with no turn information so that the normal call join flow can continue without TURN
-        LoggerProxy.logger.info(`Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`);
-
-        Metrics.sendBehavioralMetric(
-          BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE,
-          {
-            correlation_id: meeting.correlationId,
-            locus_id: meeting.locusUrl.split('/').pop(),
-            reason: e.message,
-            stack: e.stack
-          }
+        LoggerProxy.logger.info(
+          `Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`
         );
 
-        return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE, {
+          correlation_id: meeting.correlationId,
+          locus_id: meeting.locusUrl.split('/').pop(),
+          reason: e.message,
+          stack: e.stack,
+        });
+
+        return {turnServerInfo: undefined, turnDiscoverySkippedReason: undefined};
       });
   }
 }

package/src/statsAnalyzer/{global.js → global.ts}

@@ -7,14 +7,14 @@ const STATS_DEFAULT = {
       availableBandwidth: 0,
       bytesSent: 0,
       meanRemoteJitter: [],
-      meanRoundTripTime: []
+      meanRoundTripTime: [],
     },
     recv: {
       availableBandwidth: 0,
       bytesReceived: 0,
       meanRtpJitter: [],
-      meanRoundTripTime: []
-    }
+      meanRoundTripTime: [],
+    },
   },
   video: {
     send: {
@@ -22,17 +22,16 @@ const STATS_DEFAULT = {
       maxPacketLossRatio: 0,
       availableBandwidth: 0,
       meanRemoteJitter: [],
-      meanRoundTripTime: []
+      meanRoundTripTime: [],
     },
     recv: {
       availableBandwidth: 0,
       totalPacketsLost: 0,
       meanRtpJitter: [],
-      meanRoundTripTime: []
-
+      meanRoundTripTime: [],
     },
     latency: 0,
-    packetsLost: 0
+    packetsLost: 0,
   },
   share: {
     send: {
@@ -40,16 +39,16 @@ const STATS_DEFAULT = {
       availableBandwidth: 0,
       totalPacketsLost: 0,
       meanRemoteJitter: [],
-      meanRoundTripTime: []
+      meanRoundTripTime: [],
     },
     recv: {
       availableBandwidth: 0,
       meanRtpJitter: [],
-      meanRoundTripTime: []
+      meanRoundTripTime: [],
     },
 
     latency: 0,
-    packetsLost: 0
+    packetsLost: 0,
   },
   bandwidth: {
     systemBandwidth: 0,
@@ -57,9 +56,9 @@ const STATS_DEFAULT = {
     encodedPerSecond: 0,
     helper: {
       audioBytesSent: 0,
-      videoBytestSent: 0
+      videoBytestSent: 0,
     },
-    speed: 0
+    speed: 0,
   },
   results: {},
   connectionType: {
@@ -69,65 +68,63 @@ const STATS_DEFAULT = {
       candidateType: [],
       transport: [],
       ipAddress: [],
-      networkType: []
+      networkType: [],
     },
     remote: {
       candidateType: [],
       transport: [],
       ipAddress: [],
-      networkType: []
-    }
+      networkType: [],
+    },
   },
   resolutions: {
     audio: {
       send: {
         width: 0,
-        height: 0
+        height: 0,
       },
       recv: {
         width: 0,
-        height: 0
-      }
+        height: 0,
+      },
     },
     video: {
       send: {
         width: 0,
-        height: 0
+        height: 0,
       },
       recv: {
         width: 0,
-        height: 0
-      }
+        height: 0,
+      },
     },
     share: {
       send: {
         width: 0,
-        height: 0
+        height: 0,
       },
       recv: {
         width: 0,
-        height: 0
-      }
-    }
+        height: 0,
+      },
+    },
   },
   internal: {
     audio: {
       send: {},
-      recv: {}
+      recv: {},
     },
     video: {
       send: {},
-      recv: {}
+      recv: {},
     },
     share: {
       send: {},
-      recv: {}
+      recv: {},
     },
-    remote: {
-
-    },
-    candidates: {}
-  }
+    remote: {},
+    candidates: {},
+  },
 };
 
 export default STATS_DEFAULT;