@webex/plugin-meetings 3.0.0-beta.11 → 3.0.0-beta.111

package/src/roap/request.ts

@@ -3,11 +3,7 @@
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  MEDIA,
-  HTTP_VERBS,
-  REACHABILITY
-} from '../constants';
+import {MEDIA, HTTP_VERBS, REACHABILITY} from '../constants';
 import Metrics from '../metrics';
 import {eventType} from '../metrics/config';
 
@@ -16,14 +12,17 @@ import {eventType} from '../metrics/config';
  */
 export default class RoapRequest extends StatelessWebexPlugin {
   /**
-   * Joins a meeting via ROAP
-   * @param {Object} options
-   * @returns {Promise} returns a promise that resolves/rejects whatever the request does
+   * Returns reachability data.
+   * @param {Object} localSdp
+   * @returns {Object}
    */
+  async attachReachabilityData(localSdp) {
+    let joinCookie;
 
-
-  attachRechabilityData(localSdp) {
-    const reachabilityData = window.localStorage.getItem(REACHABILITY.localStorage);
+    // @ts-ignore
+    const reachabilityData = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageResult)
+      .catch(() => {});
 
     if (reachabilityData) {
       try {
@@ -33,13 +32,29 @@ export default class RoapRequest extends StatelessWebexPlugin {
         if (reachabilityResult && Object.keys(reachabilityResult).length) {
           localSdp.reachability = reachabilityResult;
         }
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`
+        );
       }
-      catch (e) {
-        LoggerProxy.logger.error(`Roap:request#attachReachabilityData --> Error in parsing reachability data: ${e}`);
+    }
+
+    // @ts-ignore
+    const joinCookieRaw = await this.webex.boundedStorage
+      .get(REACHABILITY.namespace, REACHABILITY.localStorageJoinCookie)
+      .catch(() => {});
+
+    if (joinCookieRaw) {
+      try {
+        joinCookie = JSON.parse(joinCookieRaw);
+      } catch (e) {
+        LoggerProxy.logger.error(
+          `MeetingRequest#constructor --> Error in parsing join cookie data: ${e}`
+        );
       }
     }
 
-    return localSdp;
+    return {localSdp, joinCookie};
   }
 
   /**
@@ -52,9 +67,10 @@ export default class RoapRequest extends StatelessWebexPlugin {
    * @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: {
+  async sendRoap(options: {
     roapMessage: any;
     locusSelfUrl: string;
     mediaId: string;
@@ -64,59 +80,68 @@ export default class RoapRequest extends StatelessWebexPlugin {
     meetingId: string;
     preferTranscoding?: boolean;
   }) {
-    const {
-      roapMessage, locusSelfUrl, mediaId, correlationId, meetingId
-    } = options;
+    const {roapMessage, locusSelfUrl, mediaId, correlationId, meetingId} = options;
 
     if (!mediaId) {
       LoggerProxy.logger.info('Roap:request#sendRoap --> Race Condition /call mediaID not present');
     }
 
+    const {localSdp: localSdpWithReachabilityData, joinCookie} = await this.attachReachabilityData({
+      roapMessage,
+      // eslint-disable-next-line no-warning-comments
+      // TODO: check whats the need for video and audiomute
+      audioMuted: !!options.audioMuted,
+      videoMuted: !!options.videoMuted,
+    });
+
     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}`);
+    LoggerProxy.logger.info(
+      `Roap:request#sendRoap --> ${mediaUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
+    );
 
     Metrics.postEvent({event: eventType.MEDIA_REQUEST, meetingId});
 
     // @ts-ignore
-    return this.webex
-      .request({
-        uri: mediaUrl,
-        method: HTTP_VERBS.PUT,
-        body: {
-          device: {
-            url: deviceUrl,
-            // @ts-ignore
-            deviceType: this.config.meetings.deviceType
+    return this.request({
+      uri: mediaUrl,
+      method: HTTP_VERBS.PUT,
+      body: {
+        device: {
+          url: deviceUrl,
+          // @ts-ignore
+          deviceType: this.config.meetings.deviceType,
+        },
+        correlationId,
+        localMedias: [
+          {
+            localSdp: JSON.stringify(localSdpWithReachabilityData),
+            mediaId: options.mediaId,
           },
-          correlationId,
-          localMedias: [
-            {
-              localSdp: JSON.stringify(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
-              })),
-              mediaId: options.mediaId
-            }
-          ],
-          clientMediaPreferences: {
-            preferTranscoding: options.preferTranscoding ?? true
-          }
-        }
-      })
+        ],
+        clientMediaPreferences: {
+          preferTranscoding: options.preferTranscoding ?? true,
+          joinCookie,
+        },
+      },
+    })
       .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 mediaConnections =
+          res.body.mediaConnections &&
+          res.body.mediaConnections.length > 0 &&
+          res.body.mediaConnections[0];
+
+        LoggerProxy.logger.debug(
+          `Roap:request#sendRoap --> response:${JSON.stringify(
+            mediaConnections,
+            null,
+            2
+          )}'\n StatusCode:'${res.statusCode}`
         );
         const {locus} = res.body;
 
@@ -124,14 +149,22 @@ export default class RoapRequest extends StatelessWebexPlugin {
 
         return {
           locus,
-          ...(mediaConnections && {mediaConnections: res.body.mediaConnections})
+          ...(mediaConnections && {mediaConnections: res.body.mediaConnections}),
         };
       })
       .catch((err) => {
-        Metrics.postEvent({event: eventType.MEDIA_RESPONSE, meetingId, data: {error: Metrics.parseLocusError(err, true)}});
+        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}`
+          `Roap:request#sendRoapRequest --> errorBody:${JSON.stringify(
+            roapMessage,
+            null,
+            2
+          )} + '\\n mediaId:'${options.mediaId}`
         );
         throw err;
       });

package/src/roap/turnDiscovery.ts

@@ -48,7 +48,6 @@ export default class TurnDiscovery {
     };
   }
 
-
   /**
    * waits for TURN_DISCOVERY_RESPONSE message to arrive
    *
@@ -58,20 +57,28 @@ export default class TurnDiscovery {
    */
   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;
   }
@@ -89,7 +96,9 @@ export default class TurnDiscovery {
     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;
     }
@@ -106,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;
         }
       });
@@ -116,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();
     }
   }
@@ -136,7 +154,9 @@ export default class TurnDiscovery {
    */
   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();
     }
@@ -149,19 +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
+        // @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
+        audioMuted: meeting.audio?.isLocallyMuted(),
+        videoMuted: meeting.video?.isLocallyMuted(),
+        meetingId: meeting.id,
+        preferTranscoding: !meeting.isMultistream,
       })
       .then(({mediaConnections}) => {
         if (mediaConnections) {
@@ -191,12 +214,55 @@ export default class TurnDiscovery {
       // @ts-ignore - fix type
       mediaId: meeting.mediaId,
       correlationId: meeting.correlationId,
-      audioMuted: meeting.isAudioMuted(),
-      videoMuted: meeting.isVideoMuted(),
-      meetingId: meeting.id
+      audioMuted: meeting.audio?.isLocallyMuted(),
+      videoMuted: meeting.video?.isLocallyMuted(),
+      meetingId: meeting.id,
+      preferTranscoding: !meeting.isMultistream,
     });
   }
 
+  /**
+   * Gets the reason why reachability is skipped.
+   *
+   * @param {Meeting} meeting
+   * @returns {Promise<string>} Promise with empty string if reachability is not skipped or a reason if it is skipped
+   */
+  private async getSkipReason(meeting: Meeting): Promise<string> {
+    // @ts-ignore - fix type
+    const isAnyClusterReachable = await meeting.webex.meetings.reachability.isAnyClusterReachable();
+
+    if (isAnyClusterReachable) {
+      LoggerProxy.logger.info(
+        'Roap:turnDiscovery#getSkipReason --> reachability has not failed, skipping TURN discovery'
+      );
+
+      return 'reachability';
+    }
+
+    // @ts-ignore - fix type
+    if (!meeting.config.experimental.enableTurnDiscovery) {
+      LoggerProxy.logger.info(
+        'Roap:turnDiscovery#getSkipReason --> TURN discovery disabled in config, skipping it'
+      );
+
+      return 'config';
+    }
+
+    return '';
+  }
+
+  /**
+   * Checks if TURN discovery is skipped.
+   *
+   * @param {Meeting} meeting
+   * @returns {Boolean} true if TURN discovery is being skipped, false if it is being done
+   */
+  async isSkipped(meeting) {
+    const skipReason = await this.getSkipReason(meeting);
+
+    return !!skipReason;
+  }
+
   /**
    * Retrieves TURN server information from the backend by doing
    * a roap message exchange:
@@ -214,20 +280,14 @@ export default class TurnDiscovery {
    *                                 media connection just after a reconnection
    * @returns {Promise}
    */
-  doTurnDiscovery(meeting: Meeting, isReconnecting: boolean) {
-    // @ts-ignore - fix type
-    const isAnyClusterReachable = 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'});
-    }
-
-    // @ts-ignore - fix type
-    if (!meeting.config.experimental.enableTurnDiscovery) {
-      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');
-
-      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});
+  async doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean) {
+    const turnDiscoverySkippedReason = await this.getSkipReason(meeting);
+
+    if (turnDiscoverySkippedReason) {
+      return {
+        turnServerInfo: undefined,
+        turnDiscoverySkippedReason,
+      };
     }
 
     return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting)
@@ -242,19 +302,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.ts

@@ -1,65 +1,14 @@
 const STATS_DEFAULT = {
   encryption: 'sha-256',
-  audio: {
-    send: {
-      trackLabel: '',
-      maxPacketLossRatio: 0,
-      availableBandwidth: 0,
-      bytesSent: 0,
-      meanRemoteJitter: [],
-      meanRoundTripTime: []
-    },
-    recv: {
-      availableBandwidth: 0,
-      bytesReceived: 0,
-      meanRtpJitter: [],
-      meanRoundTripTime: []
-    }
-  },
-  video: {
-    send: {
-      trackLabel: '',
-      maxPacketLossRatio: 0,
-      availableBandwidth: 0,
-      meanRemoteJitter: [],
-      meanRoundTripTime: []
-    },
-    recv: {
-      availableBandwidth: 0,
-      totalPacketsLost: 0,
-      meanRtpJitter: [],
-      meanRoundTripTime: []
-
-    },
-    latency: 0,
-    packetsLost: 0
-  },
-  share: {
-    send: {
-      maxPacketLossRatio: 0,
-      availableBandwidth: 0,
-      totalPacketsLost: 0,
-      meanRemoteJitter: [],
-      meanRoundTripTime: []
-    },
-    recv: {
-      availableBandwidth: 0,
-      meanRtpJitter: [],
-      meanRoundTripTime: []
-    },
-
-    latency: 0,
-    packetsLost: 0
-  },
   bandwidth: {
     systemBandwidth: 0,
     sentPerSecond: 0,
     encodedPerSecond: 0,
     helper: {
       audioBytesSent: 0,
-      videoBytestSent: 0
+      videoBytestSent: 0,
     },
-    speed: 0
+    speed: 0,
   },
   results: {},
   connectionType: {
@@ -69,65 +18,20 @@ const STATS_DEFAULT = {
       candidateType: [],
       transport: [],
       ipAddress: [],
-      networkType: []
+      networkType: [],
     },
     remote: {
       candidateType: [],
       transport: [],
       ipAddress: [],
-      networkType: []
-    }
-  },
-  resolutions: {
-    audio: {
-      send: {
-        width: 0,
-        height: 0
-      },
-      recv: {
-        width: 0,
-        height: 0
-      }
-    },
-    video: {
-      send: {
-        width: 0,
-        height: 0
-      },
-      recv: {
-        width: 0,
-        height: 0
-      }
+      networkType: [],
     },
-    share: {
-      send: {
-        width: 0,
-        height: 0
-      },
-      recv: {
-        width: 0,
-        height: 0
-      }
-    }
   },
+  resolutions: {},
   internal: {
-    audio: {
-      send: {},
-      recv: {}
-    },
-    video: {
-      send: {},
-      recv: {}
-    },
-    share: {
-      send: {},
-      recv: {}
-    },
-    remote: {
-
-    },
-    candidates: {}
-  }
+    remote: {},
+    candidates: {},
+  },
 };
 
 export default STATS_DEFAULT;