@webex/plugin-meetings 2.37.0 → 2.37.2

package/src/roap/request.ts

@@ -3,14 +3,7 @@
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
-import {
-  PARTICIPANT,
-  LOCI,
-  CALL,
-  MEDIA,
-  HTTP_VERBS,
-  REACHABILITY
-} from '../constants';
+import {PARTICIPANT, LOCI, CALL, MEDIA, HTTP_VERBS, REACHABILITY} from '../constants';
 import Metrics from '../metrics';
 import {eventType} from '../metrics/config';
 import ParameterError from '../common/errors/parameter';
@@ -24,7 +17,6 @@ export default class RoapRequest extends StatelessWebexPlugin {
    * @returns {Promise} returns a promise that resolves/rejects whatever the request does
    */
 
-
   attachRechabilityData(localSdp) {
     const reachabilityData = window.localStorage.getItem(REACHABILITY.localStorage);
 
@@ -36,9 +28,10 @@ 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}`
+        );
       }
     }
 
@@ -47,7 +40,9 @@ export default class RoapRequest extends StatelessWebexPlugin {
 
   joinMeetingWithRoap(options) {
     LoggerProxy.logger.info('Roap:request#joinMeetingWithRoap --> Join locus with roap');
-    LoggerProxy.logger.info(`Roap:request#joinMeetingWithRoap --> Local SDP: ${options.roapMessage}`);
+    LoggerProxy.logger.info(
+      `Roap:request#joinMeetingWithRoap --> Local SDP: ${options.roapMessage}`
+    );
 
     return Promise.resolve().then(async () => {
       // @ts-ignore
@@ -60,37 +55,36 @@ export default class RoapRequest extends StatelessWebexPlugin {
         correlationId: options.correlationId,
         localMedias: [
           {
-            localSdp: JSON.stringify(this.attachRechabilityData({
-              roapMessage: options.roapMessage,
-              audioMuted: false,
-              videoMuted: false
-            }))
-          }
+            localSdp: JSON.stringify(
+              this.attachRechabilityData({
+                roapMessage: options.roapMessage,
+                audioMuted: false,
+                videoMuted: false,
+              })
+            ),
+          },
         ],
         clientMediaPreferences: {
-          preferTranscoding: options.preferTranscoding ?? true
-        }
+          preferTranscoding: options.preferTranscoding ?? true,
+        },
       };
 
       if (options.locusUrl) {
         url = `${options.locusUrl}/${PARTICIPANT}`;
-      }
-      else if (options.sipUrl) {
+      } else if (options.sipUrl) {
         try {
           // @ts-ignore
           await this.webex.internal.services.waitForCatalog('postauth');
           // @ts-ignore
           url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
           body.invitee = {
-            address: options.sipTarget
+            address: options.sipTarget,
           };
-        }
-        catch (e) {
+        } catch (e) {
           LoggerProxy.logger.error(`Roap:request#joinMeetingWithRoap --> ${e}`);
-          throw (e);
+          throw e;
         }
-      }
-      else {
+      } else {
         throw new ParameterError('Must provide a locusUrl or sipTarget');
       }
 
@@ -99,19 +93,23 @@ export default class RoapRequest extends StatelessWebexPlugin {
         .request({
           method: HTTP_VERBS.POST,
           uri: url,
-          body
+          body,
         })
         .then((res) => {
           const {locus} = res.body;
 
           locus.roapSeq = options.roapMessage.seq;
           locus.id = locus.url.split('/').pop();
-          LoggerProxy.logger.info(`Roap:request#joinMeetingWithRoap --> Joined locus [${locus.id}][${locus.fullState.lastActive}]`);
+          LoggerProxy.logger.info(
+            `Roap:request#joinMeetingWithRoap --> Joined locus [${locus.id}][${locus.fullState.lastActive}]`
+          );
 
           return locus;
         })
         .catch((err) => {
-          LoggerProxy.logger.error(`Roap:request#joinMeetingWithRoap --> failed with error: ${err}`);
+          LoggerProxy.logger.error(
+            `Roap:request#joinMeetingWithRoap --> failed with error: ${err}`
+          );
           throw err;
         });
     });
@@ -139,9 +137,7 @@ 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');
@@ -151,7 +147,9 @@ export default class RoapRequest extends StatelessWebexPlugin {
     // @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});
 
@@ -164,34 +162,43 @@ export default class RoapRequest extends StatelessWebexPlugin {
           device: {
             url: deviceUrl,
             // @ts-ignore
-            deviceType: this.config.meetings.deviceType
+            deviceType: this.config.meetings.deviceType,
           },
           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
-            }
+              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
-          }
-        }
+            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];
+        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}`
+          `Roap:request#sendRoap --> response:${JSON.stringify(
+            mediaConnections,
+            null,
+            2
+          )}'\n StatusCode:'${res.statusCode}`
         );
         const {locus} = res.body;
 
@@ -199,14 +206,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/state.ts

@@ -19,8 +19,14 @@ const shouldStep = (roap, meeting) => {
       return false;
     }
   }
-  LoggerProxy.logger.log('Roap:state#shouldStep --> RoapStateMachine: PeerConnectionState, ', meeting.mediaProperties.peerConnection.signalingState);
-  LoggerProxy.logger.log('Roap:state#shouldStep --> RoapStateMachine: success save proceeding with transition, ', roap.msg);
+  LoggerProxy.logger.log(
+    'Roap:state#shouldStep --> RoapStateMachine: PeerConnectionState, ',
+    meeting.mediaProperties.peerConnection.signalingState
+  );
+  LoggerProxy.logger.log(
+    'Roap:state#shouldStep --> RoapStateMachine: success save proceeding with transition, ',
+    roap.msg
+  );
 
   return true;
 };
@@ -49,7 +55,9 @@ const handleTransition = (value, signal, meeting) => {
         if (meeting.mediaId) {
           return ROAP.ROAP_STATE.WAIT_TX_OK;
         }
-        LoggerProxy.logger.error('Roap:state#handleTransition --> Race Condition no mediaId, continuing.');
+        LoggerProxy.logger.error(
+          'Roap:state#handleTransition --> Race Condition no mediaId, continuing.'
+        );
 
         return value;
       }
@@ -124,8 +132,8 @@ const RoapStateMachine = {
             }
 
             return handleTransition(value, signal, meeting);
-          }
-        }
+          },
+        },
       ],
       methods: {
         /**
@@ -135,16 +143,14 @@ const RoapStateMachine = {
          */
         onAfterStep(transition: any) {
           LoggerProxy.logger.log(
-            `Roap:state#onAfterStep --> RoapStateMachine->onAfterStep#fired! State changed from '${transition.from}' to '${
-              transition.to
-            }' with transition '${transition.transition}''.`
+            `Roap:state#onAfterStep --> RoapStateMachine->onAfterStep#fired! State changed from '${transition.from}' to '${transition.to}' with transition '${transition.transition}''.`
           );
-        }
-      }
+        },
+      },
     });
 
     return new RoapState();
-  }
+  },
 };
 
 export default RoapStateMachine;

package/src/roap/turnDiscovery.ts

@@ -42,7 +42,6 @@ export default class TurnDiscovery {
     };
   }
 
-
   /**
    * waits for TURN_DISCOVERY_RESPONSE message to arrive
    *
@@ -52,20 +51,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;
   }
@@ -83,7 +90,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;
     }
@@ -100,7 +109,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;
         }
       });
@@ -110,11 +121,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();
     }
   }
@@ -132,7 +150,9 @@ export default class TurnDiscovery {
     const seq = meeting.roapSeq + 1;
 
     if (this.defer) {
-      LoggerProxy.logger.warn('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress');
+      LoggerProxy.logger.warn(
+        'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress'
+      );
 
       return Promise.resolve();
     }
@@ -145,19 +165,21 @@ export default class TurnDiscovery {
       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
+        meetingId: meeting.id,
       })
       .then(({mediaConnections}) => {
         meeting.setRoapSeq(seq);
@@ -182,7 +204,7 @@ export default class TurnDiscovery {
       roapMessage: {
         messageType: ROAP.ROAP_TYPES.OK,
         version: ROAP.ROAP_VERSION,
-        seq: meeting.roapSeq
+        seq: meeting.roapSeq,
       },
       // @ts-ignore - fix type
       locusSelfUrl: meeting.selfUrl,
@@ -191,7 +213,7 @@ export default class TurnDiscovery {
       correlationId: meeting.correlationId,
       audioMuted: meeting.isAudioMuted(),
       videoMuted: meeting.isVideoMuted(),
-      meetingId: meeting.id
+      meetingId: meeting.id,
     });
   }
 
@@ -213,13 +235,21 @@ export default class TurnDiscovery {
     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'});
+      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');
+      LoggerProxy.logger.info(
+        'Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it'
+      );
 
       return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});
     }
@@ -236,18 +266,17 @@ 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}`
         );
 
+        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE, {
+          correlation_id: meeting.correlationId,
+          locus_id: meeting.locusUrl.split('/').pop(),
+          reason: e.message,
+          stack: e.stack,
+        });
+
         return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
       });
   }

package/src/roap/util.ts

@@ -1,11 +1,5 @@
 import PeerConnectionManager from '../peer-connection-manager';
-import {
-  _ANSWER_,
-  _ERROR_,
-  _CONFLICT_,
-  ROAP,
-  SDP
-} from '../constants';
+import {_ANSWER_, _ERROR_, _CONFLICT_, ROAP, SDP} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import ParameterError from '../common/errors/parameter';
 
@@ -34,10 +28,16 @@ RoapUtil.handleError = (pc) =>
     });
 
 RoapUtil.findError = (messageType, errorType, type) =>
-  (type === ROAP.RECEIVE_ROAP_MSG || type === ROAP.SEND_ROAP_MSG) && messageType === _ERROR_ && errorType === _CONFLICT_;
+  (type === ROAP.RECEIVE_ROAP_MSG || type === ROAP.SEND_ROAP_MSG) &&
+  messageType === _ERROR_ &&
+  errorType === _CONFLICT_;
 
 RoapUtil.ensureMeeting = (meeting, type) => {
-  if (type === ROAP.RECEIVE_ROAP_MSG || type === ROAP.SEND_ROAP_MSG || type === ROAP.SEND_ROAP_MSG_SUCCESS) {
+  if (
+    type === ROAP.RECEIVE_ROAP_MSG ||
+    type === ROAP.SEND_ROAP_MSG ||
+    type === ROAP.SEND_ROAP_MSG_SUCCESS
+  ) {
     if (!meeting) {
       return false;
     }
@@ -46,25 +46,30 @@ RoapUtil.ensureMeeting = (meeting, type) => {
   return true;
 };
 
-RoapUtil.updatePeerConnection = (meeting, session) => PeerConnectionManager.updatePeerConnection({
-  offerSdp: session.OFFER.sdps,
-  peerConnection: meeting.mediaProperties.peerConnection
-},
-{
-  meetingId: meeting.id,
-  remoteQualityLevel: meeting.mediaProperties.remoteQualityLevel
-})
-  .then((res) => {
+RoapUtil.updatePeerConnection = (meeting, session) =>
+  PeerConnectionManager.updatePeerConnection(
+    {
+      offerSdp: session.OFFER.sdps,
+      peerConnection: meeting.mediaProperties.peerConnection,
+    },
+    {
+      meetingId: meeting.id,
+      remoteQualityLevel: meeting.mediaProperties.remoteQualityLevel,
+    }
+  ).then((res) => {
     meeting.roap.lastRoapOffer = session.OFFER.sdps;
 
     return res;
   });
 
-
 RoapUtil.setRemoteDescription = (meeting, session) => {
-  LoggerProxy.logger.info(`Roap:util#setRemoteDescription --> Transmit WAIT_TX_OK, correlationId: ${meeting.correlationId}`);
-  if (!(meeting && (meeting.mediaProperties.peerConnection))) {
-    LoggerProxy.logger.error(`Roap:util#setRemoteDescription --> DANGER no media or screen peer connection, correlationId: ${meeting.correlationId}`);
+  LoggerProxy.logger.info(
+    `Roap:util#setRemoteDescription --> Transmit WAIT_TX_OK, correlationId: ${meeting.correlationId}`
+  );
+  if (!(meeting && meeting.mediaProperties.peerConnection)) {
+    LoggerProxy.logger.error(
+      `Roap:util#setRemoteDescription --> DANGER no media or screen peer connection, correlationId: ${meeting.correlationId}`
+    );
 
     return Promise.reject(new ParameterError('Must provide a media or screen peer connection'));
   }
@@ -74,15 +79,18 @@ RoapUtil.setRemoteDescription = (meeting, session) => {
     ROAP_ANSWER,
     session.ANSWER.sdps[0],
     meeting.id
-  ).then(() => {
-    LoggerProxy.logger.info(`Roap:util#setRemoteDescription --> Success for correlationId: ${meeting.correlationId}`);
-
-    return {
-      seq: session.ANSWER.seq,
-      mediaId: meeting.mediaId,
-      correlationId: meeting.correlationId
-    };
-  })
+  )
+    .then(() => {
+      LoggerProxy.logger.info(
+        `Roap:util#setRemoteDescription --> Success for correlationId: ${meeting.correlationId}`
+      );
+
+      return {
+        seq: session.ANSWER.seq,
+        mediaId: meeting.mediaId,
+        correlationId: meeting.correlationId,
+      };
+    })
     .catch((err) => {
       LoggerProxy.logger.error(`Roap:util#setRemoteDescription --> ${err}`);
       throw err;