@webex/plugin-meetings 2.33.1 → 2.34.0

package/dist/roap/turnDiscovery.js

@@ -240,13 +240,19 @@ var TurnDiscovery = /*#__PURE__*/function () {
       if (isAnyClusterReachable) {
         _loggerProxy.default.logger.info('Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery');
 
-        return _promise.default.resolve(undefined);
+        return _promise.default.resolve({
+          turnServerInfo: undefined,
+          turnDiscoverySkippedReason: 'reachability'
+        });
       }
 
       if (!meeting.config.experimental.enableTurnDiscovery) {
         _loggerProxy.default.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');
 
-        return _promise.default.resolve(undefined);
+        return _promise.default.resolve({
+          turnServerInfo: undefined,
+          turnDiscoverySkippedReason: 'config'
+        });
       }
 
       return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting).then(function () {
@@ -258,7 +264,10 @@ var TurnDiscovery = /*#__PURE__*/function () {
 
         _loggerProxy.default.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery completed');
 
-        return _this2.turnInfo;
+        return {
+          turnServerInfo: _this2.turnInfo,
+          turnDiscoverySkippedReason: undefined
+        };
       }).catch(function (e) {
         // we catch any errors and resolve with no turn information so that the normal call join flow can continue without TURN
         _loggerProxy.default.logger.info("Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ".concat(e));
@@ -270,7 +279,10 @@ var TurnDiscovery = /*#__PURE__*/function () {
           stack: e.stack
         });
 
-        return _promise.default.resolve(undefined);
+        return _promise.default.resolve({
+          turnServerInfo: undefined,
+          turnDiscoverySkippedReason: undefined
+        });
       });
     }
   }]);

package/dist/roap/turnDiscovery.js.map

@@ -1 +1 @@
-{"version":3,"names":["TURN_DISCOVERY_TIMEOUT","TurnDiscovery","roapRequest","turnInfo","url","username","password","defer","LoggerProxy","logger","warn","reject","Error","responseTimer","setTimeout","info","promise","roapMessage","headers","expectedHeaders","headerName","field","foundHeaders","forEach","receivedHeader","expectedHeader","startsWith","substring","length","clearTimeout","undefined","resolve","meeting","isReconnecting","seq","roapSeq","Defer","messageType","ROAP","ROAP_TYPES","TURN_DISCOVERY_REQUEST","version","ROAP_VERSION","sendRoap","correlationId","locusSelfUrl","selfUrl","mediaId","audioMuted","isAudioMuted","videoMuted","isVideoMuted","meetingId","id","then","mediaConnections","setRoapSeq","updateMediaConnections","OK","isAnyClusterReachable","webex","meetings","reachability","config","experimental","enableTurnDiscovery","sendRoapTurnDiscoveryRequest","waitForTurnDiscoveryResponse","sendRoapOK","catch","e","Metrics","sendBehavioralMetric","BEHAVIORAL_METRICS","TURN_DISCOVERY_FAILURE","correlation_id","locus_id","locusUrl","split","pop","reason","message","stack"],"sources":["turnDiscovery.ts"],"sourcesContent":["import {Defer} from '@webex/common';\n\nimport Metrics from '../metrics';\nimport BEHAVIORAL_METRICS from '../metrics/constants';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {ROAP} from '../constants';\n\nimport RoapRequest from './request';\n\nconst TURN_DISCOVERY_TIMEOUT = 10; // in seconds\n\n/**\n * Handles the process of finding out TURN server information from Linus.\n * This is achieved by sending a TURN_DISCOVERY_REQUEST.\n */\nexport default class TurnDiscovery {\n  private roapRequest: RoapRequest;\n\n  private defer?: Defer; // used for waiting for the response\n\n  private turnInfo: {\n    url: string;\n    username: string;\n    password: string;\n  };\n\n  private responseTimer?: ReturnType<typeof setTimeout>;\n\n  /**\n   * Constructor\n   *\n   * @param {RoapRequest} roapRequest\n   */\n  constructor(roapRequest: RoapRequest) {\n    this.roapRequest = roapRequest;\n    this.turnInfo = {\n      url: '',\n      username: '',\n      password: '',\n    };\n  }\n\n\n  /**\n   * waits for TURN_DISCOVERY_RESPONSE message to arrive\n   *\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  waitForTurnDiscoveryResponse() {\n    if (!this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress');\n\n      return Promise.reject(new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()'));\n    }\n\n    const {defer} = this;\n\n    this.responseTimer = setTimeout(() => {\n      LoggerProxy.logger.warn(`Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`);\n\n      defer.reject(new Error('Timed out waiting for TURN_DISCOVERY_RESPONSE'));\n    }, TURN_DISCOVERY_TIMEOUT * 1000);\n\n    LoggerProxy.logger.info('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...');\n\n    return defer.promise;\n  }\n\n  /**\n   * handles TURN_DISCOVERY_RESPONSE roap message\n   *\n   * @param {Object} roapMessage\n   * @returns {void}\n   * @public\n   * @memberof Roap\n   */\n  handleTurnDiscoveryResponse(roapMessage) {\n    const {headers} = roapMessage;\n\n    if (!this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response');\n\n      return;\n    }\n\n    const expectedHeaders = [\n      {headerName: 'x-cisco-turn-url', field: 'url'},\n      {headerName: 'x-cisco-turn-username', field: 'username'},\n      {headerName: 'x-cisco-turn-password', field: 'password'},\n    ];\n\n    let foundHeaders = 0;\n\n    headers?.forEach((receivedHeader) => {\n      // check if it matches any of our expected headers\n      expectedHeaders.forEach((expectedHeader) => {\n        if (receivedHeader.startsWith(`${expectedHeader.headerName}=`)) {\n          this.turnInfo[expectedHeader.field] = receivedHeader.substring(expectedHeader.headerName.length + 1);\n          foundHeaders += 1;\n        }\n      });\n    });\n\n    clearTimeout(this.responseTimer);\n    this.responseTimer = undefined;\n\n    if (foundHeaders !== expectedHeaders.length) {\n      LoggerProxy.logger.warn(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(headers)}`);\n      this.defer.reject(new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`));\n    }\n    else {\n      LoggerProxy.logger.info(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`);\n      this.defer.resolve();\n    }\n  }\n\n  /**\n   * sends the TURN_DISCOVERY_REQUEST roap request\n   *\n   * @param {Meeting} meeting\n   * @param {Boolean} isReconnecting\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  sendRoapTurnDiscoveryRequest(meeting, isReconnecting) {\n    const seq = meeting.roapSeq + 1;\n\n    if (this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress');\n\n      return Promise.resolve();\n    }\n\n    this.defer = new Defer();\n\n    const roapMessage = {\n      messageType: ROAP.ROAP_TYPES.TURN_DISCOVERY_REQUEST,\n      version: ROAP.ROAP_VERSION,\n      seq,\n    };\n\n    LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST');\n\n    return this.roapRequest\n      .sendRoap({\n        roapMessage,\n        correlationId: meeting.correlationId,\n        locusSelfUrl: meeting.selfUrl,\n        mediaId: isReconnecting ? '' : meeting.mediaId,\n        audioMuted: meeting.isAudioMuted(),\n        videoMuted: meeting.isVideoMuted(),\n        meetingId: meeting.id\n      })\n      .then(({mediaConnections}) => {\n        meeting.setRoapSeq(seq);\n\n        if (mediaConnections) {\n          meeting.updateMediaConnections(mediaConnections);\n        }\n      });\n  }\n\n  /**\n   * Sends the OK message that server expects to receive\n   * after it sends us TURN_DISCOVERY_RESPONSE\n   *\n   * @param {Meeting} meeting\n   * @returns {Promise}\n   */\n  sendRoapOK(meeting) {\n    LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapOK --> sending OK');\n\n    return this.roapRequest.sendRoap({\n      roapMessage: {\n        messageType: ROAP.ROAP_TYPES.OK,\n        version: ROAP.ROAP_VERSION,\n        seq: meeting.roapSeq\n      },\n      locusSelfUrl: meeting.selfUrl,\n      mediaId: meeting.mediaId,\n      correlationId: meeting.correlationId,\n      audioMuted: meeting.isAudioMuted(),\n      videoMuted: meeting.isVideoMuted(),\n      meetingId: meeting.id\n    });\n  }\n\n  /**\n   * Retrieves TURN server information from the backend by doing\n   * a roap message exchange:\n   * client                             server\n   *  | -----TURN_DISCOVERY_REQUEST-----> |\n   *  | <----TURN_DISCOVERY_RESPONSE----- |\n   *  | --------------OK----------------> |\n   *\n   * @param {Meeting} meeting\n   * @param {Boolean} isReconnecting should be set to true if this is a new\n   *                                 media connection just after a reconnection\n   * @returns {Promise}\n   */\n  doTurnDiscovery(meeting, isReconnecting) {\n    const isAnyClusterReachable = meeting.webex.meetings.reachability.isAnyClusterReachable();\n\n    if (isAnyClusterReachable) {\n      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery');\n      return Promise.resolve(undefined);\n    }\n\n    if (!meeting.config.experimental.enableTurnDiscovery) {\n      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');\n\n      return Promise.resolve(undefined);\n    }\n\n    return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting)\n      .then(() => this.waitForTurnDiscoveryResponse())\n      .then(() => this.sendRoapOK(meeting))\n      .then(() => {\n        this.defer = undefined;\n\n        LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery completed');\n\n        return this.turnInfo;\n      })\n      .catch((e) => {\n        // we catch any errors and resolve with no turn information so that the normal call join flow can continue without TURN\n        LoggerProxy.logger.info(`Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`);\n\n        Metrics.sendBehavioralMetric(\n          BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE,\n          {\n            correlation_id: meeting.correlationId,\n            locus_id: meeting.locusUrl.split('/').pop(),\n            reason: e.message,\n            stack: e.stack\n          }\n        );\n\n        return Promise.resolve(undefined);\n      });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;;AAEA;;AACA;;AACA;;AACA;;AAIA,IAAMA,sBAAsB,GAAG,EAA/B,C,CAAmC;;AAEnC;AACA;AACA;AACA;;IACqBC,a;EAGI;;EAUvB;AACF;AACA;AACA;AACA;EACE,uBAAYC,WAAZ,EAAsC;IAAA;IAAA;IAAA;IAAA;IAAA;IACpC,KAAKA,WAAL,GAAmBA,WAAnB;IACA,KAAKC,QAAL,GAAgB;MACdC,GAAG,EAAE,EADS;MAEdC,QAAQ,EAAE,EAFI;MAGdC,QAAQ,EAAE;IAHI,CAAhB;EAKD;EAGD;AACF;AACA;AACA;AACA;AACA;AACA;;;;;WACE,wCAA+B;MAC7B,IAAI,CAAC,KAAKC,KAAV,EAAiB;QACfC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,uFAAxB;;QAEA,OAAO,iBAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,6EAAV,CAAf,CAAP;MACD;;MAED,IAAOL,KAAP,GAAgB,IAAhB,CAAOA,KAAP;MAEA,KAAKM,aAAL,GAAqBC,UAAU,CAAC,YAAM;QACpCN,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,mGAAmHV,sBAAnH;;QAEAO,KAAK,CAACI,MAAN,CAAa,IAAIC,KAAJ,CAAU,+CAAV,CAAb;MACD,CAJ8B,EAI5BZ,sBAAsB,GAAG,IAJG,CAA/B;;MAMAQ,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,4FAAxB;;MAEA,OAAOR,KAAK,CAACS,OAAb;IACD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,qCAA4BC,WAA5B,EAAyC;MAAA;;MACvC,IAAOC,OAAP,GAAkBD,WAAlB,CAAOC,OAAP;;MAEA,IAAI,CAAC,KAAKX,KAAV,EAAiB;QACfC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,uFAAxB;;QAEA;MACD;;MAED,IAAMS,eAAe,GAAG,CACtB;QAACC,UAAU,EAAE,kBAAb;QAAiCC,KAAK,EAAE;MAAxC,CADsB,EAEtB;QAACD,UAAU,EAAE,uBAAb;QAAsCC,KAAK,EAAE;MAA7C,CAFsB,EAGtB;QAACD,UAAU,EAAE,uBAAb;QAAsCC,KAAK,EAAE;MAA7C,CAHsB,CAAxB;MAMA,IAAIC,YAAY,GAAG,CAAnB;MAEAJ,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEK,OAAT,CAAiB,UAACC,cAAD,EAAoB;QACnC;QACAL,eAAe,CAACI,OAAhB,CAAwB,UAACE,cAAD,EAAoB;UAC1C,IAAID,cAAc,CAACE,UAAf,WAA6BD,cAAc,CAACL,UAA5C,OAAJ,EAAgE;YAC9D,KAAI,CAACjB,QAAL,CAAcsB,cAAc,CAACJ,KAA7B,IAAsCG,cAAc,CAACG,SAAf,CAAyBF,cAAc,CAACL,UAAf,CAA0BQ,MAA1B,GAAmC,CAA5D,CAAtC;YACAN,YAAY,IAAI,CAAhB;UACD;QACF,CALD;MAMD,CARD;MAUAO,YAAY,CAAC,KAAKhB,aAAN,CAAZ;MACA,KAAKA,aAAL,GAAqBiB,SAArB;;MAEA,IAAIR,YAAY,KAAKH,eAAe,CAACS,MAArC,EAA6C;QAC3CpB,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,8FAA8G,wBAAeQ,OAAf,CAA9G;;QACA,KAAKX,KAAL,CAAWI,MAAX,CAAkB,IAAIC,KAAJ,yDAA2D,wBAAeM,OAAf,CAA3D,EAAlB;MACD,CAHD,MAIK;QACHV,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,6FAA6G,KAAKZ,QAAL,CAAcC,GAA3H;;QACA,KAAKG,KAAL,CAAWwB,OAAX;MACD;IACF;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,sCAA6BC,OAA7B,EAAsCC,cAAtC,EAAsD;MACpD,IAAMC,GAAG,GAAGF,OAAO,CAACG,OAAR,GAAkB,CAA9B;;MAEA,IAAI,KAAK5B,KAAT,EAAgB;QACdC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,yEAAxB;;QAEA,OAAO,iBAAQqB,OAAR,EAAP;MACD;;MAED,KAAKxB,KAAL,GAAa,IAAI6B,aAAJ,EAAb;MAEA,IAAMnB,WAAW,GAAG;QAClBoB,WAAW,EAAEC,gBAAA,CAAKC,UAAL,CAAgBC,sBADX;QAElBC,OAAO,EAAEH,gBAAA,CAAKI,YAFI;QAGlBR,GAAG,EAAHA;MAHkB,CAApB;;MAMA1B,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,oFAAxB;;MAEA,OAAO,KAAKb,WAAL,CACJyC,QADI,CACK;QACR1B,WAAW,EAAXA,WADQ;QAER2B,aAAa,EAAEZ,OAAO,CAACY,aAFf;QAGRC,YAAY,EAAEb,OAAO,CAACc,OAHd;QAIRC,OAAO,EAAEd,cAAc,GAAG,EAAH,GAAQD,OAAO,CAACe,OAJ/B;QAKRC,UAAU,EAAEhB,OAAO,CAACiB,YAAR,EALJ;QAMRC,UAAU,EAAElB,OAAO,CAACmB,YAAR,EANJ;QAORC,SAAS,EAAEpB,OAAO,CAACqB;MAPX,CADL,EAUJC,IAVI,CAUC,gBAAwB;QAAA,IAAtBC,gBAAsB,QAAtBA,gBAAsB;QAC5BvB,OAAO,CAACwB,UAAR,CAAmBtB,GAAnB;;QAEA,IAAIqB,gBAAJ,EAAsB;UACpBvB,OAAO,CAACyB,sBAAR,CAA+BF,gBAA/B;QACD;MACF,CAhBI,CAAP;IAiBD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;;;;WACE,oBAAWvB,OAAX,EAAoB;MAClBxB,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,8CAAxB;;MAEA,OAAO,KAAKb,WAAL,CAAiByC,QAAjB,CAA0B;QAC/B1B,WAAW,EAAE;UACXoB,WAAW,EAAEC,gBAAA,CAAKC,UAAL,CAAgBmB,EADlB;UAEXjB,OAAO,EAAEH,gBAAA,CAAKI,YAFH;UAGXR,GAAG,EAAEF,OAAO,CAACG;QAHF,CADkB;QAM/BU,YAAY,EAAEb,OAAO,CAACc,OANS;QAO/BC,OAAO,EAAEf,OAAO,CAACe,OAPc;QAQ/BH,aAAa,EAAEZ,OAAO,CAACY,aARQ;QAS/BI,UAAU,EAAEhB,OAAO,CAACiB,YAAR,EATmB;QAU/BC,UAAU,EAAElB,OAAO,CAACmB,YAAR,EAVmB;QAW/BC,SAAS,EAAEpB,OAAO,CAACqB;MAXY,CAA1B,CAAP;IAaD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,yBAAgBrB,OAAhB,EAAyBC,cAAzB,EAAyC;MAAA;;MACvC,IAAM0B,qBAAqB,GAAG3B,OAAO,CAAC4B,KAAR,CAAcC,QAAd,CAAuBC,YAAvB,CAAoCH,qBAApC,EAA9B;;MAEA,IAAIA,qBAAJ,EAA2B;QACzBnD,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,6FAAxB;;QACA,OAAO,iBAAQgB,OAAR,CAAgBD,SAAhB,CAAP;MACD;;MAED,IAAI,CAACE,OAAO,CAAC+B,MAAR,CAAeC,YAAf,CAA4BC,mBAAjC,EAAsD;QACpDzD,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,uFAAxB;;QAEA,OAAO,iBAAQgB,OAAR,CAAgBD,SAAhB,CAAP;MACD;;MAED,OAAO,KAAKoC,4BAAL,CAAkClC,OAAlC,EAA2CC,cAA3C,EACJqB,IADI,CACC;QAAA,OAAM,MAAI,CAACa,4BAAL,EAAN;MAAA,CADD,EAEJb,IAFI,CAEC;QAAA,OAAM,MAAI,CAACc,UAAL,CAAgBpC,OAAhB,CAAN;MAAA,CAFD,EAGJsB,IAHI,CAGC,YAAM;QACV,MAAI,CAAC/C,KAAL,GAAauB,SAAb;;QAEAtB,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,iEAAxB;;QAEA,OAAO,MAAI,CAACZ,QAAZ;MACD,CATI,EAUJkE,KAVI,CAUE,UAACC,CAAD,EAAO;QACZ;QACA9D,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,kGAAkHuD,CAAlH;;QAEAC,gBAAA,CAAQC,oBAAR,CACEC,kBAAA,CAAmBC,sBADrB,EAEE;UACEC,cAAc,EAAE3C,OAAO,CAACY,aAD1B;UAEEgC,QAAQ,EAAE5C,OAAO,CAAC6C,QAAR,CAAiBC,KAAjB,CAAuB,GAAvB,EAA4BC,GAA5B,EAFZ;UAGEC,MAAM,EAAEV,CAAC,CAACW,OAHZ;UAIEC,KAAK,EAAEZ,CAAC,CAACY;QAJX,CAFF;;QAUA,OAAO,iBAAQnD,OAAR,CAAgBD,SAAhB,CAAP;MACD,CAzBI,CAAP;IA0BD"}
+{"version":3,"names":["TURN_DISCOVERY_TIMEOUT","TurnDiscovery","roapRequest","turnInfo","url","username","password","defer","LoggerProxy","logger","warn","reject","Error","responseTimer","setTimeout","info","promise","roapMessage","headers","expectedHeaders","headerName","field","foundHeaders","forEach","receivedHeader","expectedHeader","startsWith","substring","length","clearTimeout","undefined","resolve","meeting","isReconnecting","seq","roapSeq","Defer","messageType","ROAP","ROAP_TYPES","TURN_DISCOVERY_REQUEST","version","ROAP_VERSION","sendRoap","correlationId","locusSelfUrl","selfUrl","mediaId","audioMuted","isAudioMuted","videoMuted","isVideoMuted","meetingId","id","then","mediaConnections","setRoapSeq","updateMediaConnections","OK","isAnyClusterReachable","webex","meetings","reachability","turnServerInfo","turnDiscoverySkippedReason","config","experimental","enableTurnDiscovery","sendRoapTurnDiscoveryRequest","waitForTurnDiscoveryResponse","sendRoapOK","catch","e","Metrics","sendBehavioralMetric","BEHAVIORAL_METRICS","TURN_DISCOVERY_FAILURE","correlation_id","locus_id","locusUrl","split","pop","reason","message","stack"],"sources":["turnDiscovery.ts"],"sourcesContent":["import {Defer} from '@webex/common';\n\nimport Metrics from '../metrics';\nimport BEHAVIORAL_METRICS from '../metrics/constants';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {ROAP} from '../constants';\n\nimport RoapRequest from './request';\n\nconst TURN_DISCOVERY_TIMEOUT = 10; // in seconds\n\n/**\n * Handles the process of finding out TURN server information from Linus.\n * This is achieved by sending a TURN_DISCOVERY_REQUEST.\n */\nexport default class TurnDiscovery {\n  private roapRequest: RoapRequest;\n\n  private defer?: Defer; // used for waiting for the response\n\n  private turnInfo: {\n    url: string;\n    username: string;\n    password: string;\n  };\n\n  private responseTimer?: ReturnType<typeof setTimeout>;\n\n  /**\n   * Constructor\n   *\n   * @param {RoapRequest} roapRequest\n   */\n  constructor(roapRequest: RoapRequest) {\n    this.roapRequest = roapRequest;\n    this.turnInfo = {\n      url: '',\n      username: '',\n      password: '',\n    };\n  }\n\n\n  /**\n   * waits for TURN_DISCOVERY_RESPONSE message to arrive\n   *\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  waitForTurnDiscoveryResponse() {\n    if (!this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress');\n\n      return Promise.reject(new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()'));\n    }\n\n    const {defer} = this;\n\n    this.responseTimer = setTimeout(() => {\n      LoggerProxy.logger.warn(`Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`);\n\n      defer.reject(new Error('Timed out waiting for TURN_DISCOVERY_RESPONSE'));\n    }, TURN_DISCOVERY_TIMEOUT * 1000);\n\n    LoggerProxy.logger.info('Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...');\n\n    return defer.promise;\n  }\n\n  /**\n   * handles TURN_DISCOVERY_RESPONSE roap message\n   *\n   * @param {Object} roapMessage\n   * @returns {void}\n   * @public\n   * @memberof Roap\n   */\n  handleTurnDiscoveryResponse(roapMessage) {\n    const {headers} = roapMessage;\n\n    if (!this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response');\n\n      return;\n    }\n\n    const expectedHeaders = [\n      {headerName: 'x-cisco-turn-url', field: 'url'},\n      {headerName: 'x-cisco-turn-username', field: 'username'},\n      {headerName: 'x-cisco-turn-password', field: 'password'},\n    ];\n\n    let foundHeaders = 0;\n\n    headers?.forEach((receivedHeader) => {\n      // check if it matches any of our expected headers\n      expectedHeaders.forEach((expectedHeader) => {\n        if (receivedHeader.startsWith(`${expectedHeader.headerName}=`)) {\n          this.turnInfo[expectedHeader.field] = receivedHeader.substring(expectedHeader.headerName.length + 1);\n          foundHeaders += 1;\n        }\n      });\n    });\n\n    clearTimeout(this.responseTimer);\n    this.responseTimer = undefined;\n\n    if (foundHeaders !== expectedHeaders.length) {\n      LoggerProxy.logger.warn(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(headers)}`);\n      this.defer.reject(new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`));\n    }\n    else {\n      LoggerProxy.logger.info(`Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`);\n      this.defer.resolve();\n    }\n  }\n\n  /**\n   * sends the TURN_DISCOVERY_REQUEST roap request\n   *\n   * @param {Meeting} meeting\n   * @param {Boolean} isReconnecting\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  sendRoapTurnDiscoveryRequest(meeting, isReconnecting) {\n    const seq = meeting.roapSeq + 1;\n\n    if (this.defer) {\n      LoggerProxy.logger.warn('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress');\n\n      return Promise.resolve();\n    }\n\n    this.defer = new Defer();\n\n    const roapMessage = {\n      messageType: ROAP.ROAP_TYPES.TURN_DISCOVERY_REQUEST,\n      version: ROAP.ROAP_VERSION,\n      seq,\n    };\n\n    LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST');\n\n    return this.roapRequest\n      .sendRoap({\n        roapMessage,\n        correlationId: meeting.correlationId,\n        locusSelfUrl: meeting.selfUrl,\n        mediaId: isReconnecting ? '' : meeting.mediaId,\n        audioMuted: meeting.isAudioMuted(),\n        videoMuted: meeting.isVideoMuted(),\n        meetingId: meeting.id\n      })\n      .then(({mediaConnections}) => {\n        meeting.setRoapSeq(seq);\n\n        if (mediaConnections) {\n          meeting.updateMediaConnections(mediaConnections);\n        }\n      });\n  }\n\n  /**\n   * Sends the OK message that server expects to receive\n   * after it sends us TURN_DISCOVERY_RESPONSE\n   *\n   * @param {Meeting} meeting\n   * @returns {Promise}\n   */\n  sendRoapOK(meeting) {\n    LoggerProxy.logger.info('Roap:turnDiscovery#sendRoapOK --> sending OK');\n\n    return this.roapRequest.sendRoap({\n      roapMessage: {\n        messageType: ROAP.ROAP_TYPES.OK,\n        version: ROAP.ROAP_VERSION,\n        seq: meeting.roapSeq\n      },\n      locusSelfUrl: meeting.selfUrl,\n      mediaId: meeting.mediaId,\n      correlationId: meeting.correlationId,\n      audioMuted: meeting.isAudioMuted(),\n      videoMuted: meeting.isVideoMuted(),\n      meetingId: meeting.id\n    });\n  }\n\n  /**\n   * Retrieves TURN server information from the backend by doing\n   * a roap message exchange:\n   * client                             server\n   *  | -----TURN_DISCOVERY_REQUEST-----> |\n   *  | <----TURN_DISCOVERY_RESPONSE----- |\n   *  | --------------OK----------------> |\n   *\n   * @param {Meeting} meeting\n   * @param {Boolean} isReconnecting should be set to true if this is a new\n   *                                 media connection just after a reconnection\n   * @returns {Promise}\n   */\n  doTurnDiscovery(meeting, isReconnecting) {\n    const isAnyClusterReachable = meeting.webex.meetings.reachability.isAnyClusterReachable();\n\n    if (isAnyClusterReachable) {\n      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery');\n      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'reachability'});\n    }\n\n    if (!meeting.config.experimental.enableTurnDiscovery) {\n      LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');\n\n      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});\n    }\n\n    return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting)\n      .then(() => this.waitForTurnDiscoveryResponse())\n      .then(() => this.sendRoapOK(meeting))\n      .then(() => {\n        this.defer = undefined;\n\n        LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery completed');\n\n        return {turnServerInfo: this.turnInfo, turnDiscoverySkippedReason: undefined};\n      })\n      .catch((e) => {\n        // we catch any errors and resolve with no turn information so that the normal call join flow can continue without TURN\n        LoggerProxy.logger.info(`Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`);\n\n        Metrics.sendBehavioralMetric(\n          BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE,\n          {\n            correlation_id: meeting.correlationId,\n            locus_id: meeting.locusUrl.split('/').pop(),\n            reason: e.message,\n            stack: e.stack\n          }\n        );\n\n        return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});\n      });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;;AAEA;;AACA;;AACA;;AACA;;AAIA,IAAMA,sBAAsB,GAAG,EAA/B,C,CAAmC;;AAEnC;AACA;AACA;AACA;;IACqBC,a;EAGI;;EAUvB;AACF;AACA;AACA;AACA;EACE,uBAAYC,WAAZ,EAAsC;IAAA;IAAA;IAAA;IAAA;IAAA;IACpC,KAAKA,WAAL,GAAmBA,WAAnB;IACA,KAAKC,QAAL,GAAgB;MACdC,GAAG,EAAE,EADS;MAEdC,QAAQ,EAAE,EAFI;MAGdC,QAAQ,EAAE;IAHI,CAAhB;EAKD;EAGD;AACF;AACA;AACA;AACA;AACA;AACA;;;;;WACE,wCAA+B;MAC7B,IAAI,CAAC,KAAKC,KAAV,EAAiB;QACfC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,uFAAxB;;QAEA,OAAO,iBAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,6EAAV,CAAf,CAAP;MACD;;MAED,IAAOL,KAAP,GAAgB,IAAhB,CAAOA,KAAP;MAEA,KAAKM,aAAL,GAAqBC,UAAU,CAAC,YAAM;QACpCN,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,mGAAmHV,sBAAnH;;QAEAO,KAAK,CAACI,MAAN,CAAa,IAAIC,KAAJ,CAAU,+CAAV,CAAb;MACD,CAJ8B,EAI5BZ,sBAAsB,GAAG,IAJG,CAA/B;;MAMAQ,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,4FAAxB;;MAEA,OAAOR,KAAK,CAACS,OAAb;IACD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,qCAA4BC,WAA5B,EAAyC;MAAA;;MACvC,IAAOC,OAAP,GAAkBD,WAAlB,CAAOC,OAAP;;MAEA,IAAI,CAAC,KAAKX,KAAV,EAAiB;QACfC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,uFAAxB;;QAEA;MACD;;MAED,IAAMS,eAAe,GAAG,CACtB;QAACC,UAAU,EAAE,kBAAb;QAAiCC,KAAK,EAAE;MAAxC,CADsB,EAEtB;QAACD,UAAU,EAAE,uBAAb;QAAsCC,KAAK,EAAE;MAA7C,CAFsB,EAGtB;QAACD,UAAU,EAAE,uBAAb;QAAsCC,KAAK,EAAE;MAA7C,CAHsB,CAAxB;MAMA,IAAIC,YAAY,GAAG,CAAnB;MAEAJ,OAAO,SAAP,IAAAA,OAAO,WAAP,YAAAA,OAAO,CAAEK,OAAT,CAAiB,UAACC,cAAD,EAAoB;QACnC;QACAL,eAAe,CAACI,OAAhB,CAAwB,UAACE,cAAD,EAAoB;UAC1C,IAAID,cAAc,CAACE,UAAf,WAA6BD,cAAc,CAACL,UAA5C,OAAJ,EAAgE;YAC9D,KAAI,CAACjB,QAAL,CAAcsB,cAAc,CAACJ,KAA7B,IAAsCG,cAAc,CAACG,SAAf,CAAyBF,cAAc,CAACL,UAAf,CAA0BQ,MAA1B,GAAmC,CAA5D,CAAtC;YACAN,YAAY,IAAI,CAAhB;UACD;QACF,CALD;MAMD,CARD;MAUAO,YAAY,CAAC,KAAKhB,aAAN,CAAZ;MACA,KAAKA,aAAL,GAAqBiB,SAArB;;MAEA,IAAIR,YAAY,KAAKH,eAAe,CAACS,MAArC,EAA6C;QAC3CpB,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,8FAA8G,wBAAeQ,OAAf,CAA9G;;QACA,KAAKX,KAAL,CAAWI,MAAX,CAAkB,IAAIC,KAAJ,yDAA2D,wBAAeM,OAAf,CAA3D,EAAlB;MACD,CAHD,MAIK;QACHV,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,6FAA6G,KAAKZ,QAAL,CAAcC,GAA3H;;QACA,KAAKG,KAAL,CAAWwB,OAAX;MACD;IACF;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,sCAA6BC,OAA7B,EAAsCC,cAAtC,EAAsD;MACpD,IAAMC,GAAG,GAAGF,OAAO,CAACG,OAAR,GAAkB,CAA9B;;MAEA,IAAI,KAAK5B,KAAT,EAAgB;QACdC,oBAAA,CAAYC,MAAZ,CAAmBC,IAAnB,CAAwB,yEAAxB;;QAEA,OAAO,iBAAQqB,OAAR,EAAP;MACD;;MAED,KAAKxB,KAAL,GAAa,IAAI6B,aAAJ,EAAb;MAEA,IAAMnB,WAAW,GAAG;QAClBoB,WAAW,EAAEC,gBAAA,CAAKC,UAAL,CAAgBC,sBADX;QAElBC,OAAO,EAAEH,gBAAA,CAAKI,YAFI;QAGlBR,GAAG,EAAHA;MAHkB,CAApB;;MAMA1B,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,oFAAxB;;MAEA,OAAO,KAAKb,WAAL,CACJyC,QADI,CACK;QACR1B,WAAW,EAAXA,WADQ;QAER2B,aAAa,EAAEZ,OAAO,CAACY,aAFf;QAGRC,YAAY,EAAEb,OAAO,CAACc,OAHd;QAIRC,OAAO,EAAEd,cAAc,GAAG,EAAH,GAAQD,OAAO,CAACe,OAJ/B;QAKRC,UAAU,EAAEhB,OAAO,CAACiB,YAAR,EALJ;QAMRC,UAAU,EAAElB,OAAO,CAACmB,YAAR,EANJ;QAORC,SAAS,EAAEpB,OAAO,CAACqB;MAPX,CADL,EAUJC,IAVI,CAUC,gBAAwB;QAAA,IAAtBC,gBAAsB,QAAtBA,gBAAsB;QAC5BvB,OAAO,CAACwB,UAAR,CAAmBtB,GAAnB;;QAEA,IAAIqB,gBAAJ,EAAsB;UACpBvB,OAAO,CAACyB,sBAAR,CAA+BF,gBAA/B;QACD;MACF,CAhBI,CAAP;IAiBD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;;;;WACE,oBAAWvB,OAAX,EAAoB;MAClBxB,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,8CAAxB;;MAEA,OAAO,KAAKb,WAAL,CAAiByC,QAAjB,CAA0B;QAC/B1B,WAAW,EAAE;UACXoB,WAAW,EAAEC,gBAAA,CAAKC,UAAL,CAAgBmB,EADlB;UAEXjB,OAAO,EAAEH,gBAAA,CAAKI,YAFH;UAGXR,GAAG,EAAEF,OAAO,CAACG;QAHF,CADkB;QAM/BU,YAAY,EAAEb,OAAO,CAACc,OANS;QAO/BC,OAAO,EAAEf,OAAO,CAACe,OAPc;QAQ/BH,aAAa,EAAEZ,OAAO,CAACY,aARQ;QAS/BI,UAAU,EAAEhB,OAAO,CAACiB,YAAR,EATmB;QAU/BC,UAAU,EAAElB,OAAO,CAACmB,YAAR,EAVmB;QAW/BC,SAAS,EAAEpB,OAAO,CAACqB;MAXY,CAA1B,CAAP;IAaD;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;WACE,yBAAgBrB,OAAhB,EAAyBC,cAAzB,EAAyC;MAAA;;MACvC,IAAM0B,qBAAqB,GAAG3B,OAAO,CAAC4B,KAAR,CAAcC,QAAd,CAAuBC,YAAvB,CAAoCH,qBAApC,EAA9B;;MAEA,IAAIA,qBAAJ,EAA2B;QACzBnD,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,6FAAxB;;QACA,OAAO,iBAAQgB,OAAR,CAAgB;UAACgC,cAAc,EAAEjC,SAAjB;UAA4BkC,0BAA0B,EAAE;QAAxD,CAAhB,CAAP;MACD;;MAED,IAAI,CAAChC,OAAO,CAACiC,MAAR,CAAeC,YAAf,CAA4BC,mBAAjC,EAAsD;QACpD3D,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,uFAAxB;;QAEA,OAAO,iBAAQgB,OAAR,CAAgB;UAACgC,cAAc,EAAEjC,SAAjB;UAA4BkC,0BAA0B,EAAE;QAAxD,CAAhB,CAAP;MACD;;MAED,OAAO,KAAKI,4BAAL,CAAkCpC,OAAlC,EAA2CC,cAA3C,EACJqB,IADI,CACC;QAAA,OAAM,MAAI,CAACe,4BAAL,EAAN;MAAA,CADD,EAEJf,IAFI,CAEC;QAAA,OAAM,MAAI,CAACgB,UAAL,CAAgBtC,OAAhB,CAAN;MAAA,CAFD,EAGJsB,IAHI,CAGC,YAAM;QACV,MAAI,CAAC/C,KAAL,GAAauB,SAAb;;QAEAtB,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,CAAwB,iEAAxB;;QAEA,OAAO;UAACgD,cAAc,EAAE,MAAI,CAAC5D,QAAtB;UAAgC6D,0BAA0B,EAAElC;QAA5D,CAAP;MACD,CATI,EAUJyC,KAVI,CAUE,UAACC,CAAD,EAAO;QACZ;QACAhE,oBAAA,CAAYC,MAAZ,CAAmBM,IAAnB,kGAAkHyD,CAAlH;;QAEAC,gBAAA,CAAQC,oBAAR,CACEC,kBAAA,CAAmBC,sBADrB,EAEE;UACEC,cAAc,EAAE7C,OAAO,CAACY,aAD1B;UAEEkC,QAAQ,EAAE9C,OAAO,CAAC+C,QAAR,CAAiBC,KAAjB,CAAuB,GAAvB,EAA4BC,GAA5B,EAFZ;UAGEC,MAAM,EAAEV,CAAC,CAACW,OAHZ;UAIEC,KAAK,EAAEZ,CAAC,CAACY;QAJX,CAFF;;QAUA,OAAO,iBAAQrD,OAAR,CAAgB;UAACgC,cAAc,EAAEjC,SAAjB;UAA4BkC,0BAA0B,EAAElC;QAAxD,CAAhB,CAAP;MACD,CAzBI,CAAP;IA0BD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "2.33.1",
+  "version": "2.34.0",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -24,30 +24,30 @@
     ]
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "2.33.1",
-    "@webex/test-helper-chai": "2.33.1",
-    "@webex/test-helper-mocha": "2.33.1",
-    "@webex/test-helper-mock-webex": "2.33.1",
-    "@webex/test-helper-retry": "2.33.1",
-    "@webex/test-helper-test-users": "2.33.1",
+    "@webex/plugin-meetings": "2.34.0",
+    "@webex/test-helper-chai": "2.34.0",
+    "@webex/test-helper-mocha": "2.34.0",
+    "@webex/test-helper-mock-webex": "2.34.0",
+    "@webex/test-helper-retry": "2.34.0",
+    "@webex/test-helper-test-users": "2.34.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "2.33.1",
+    "@webex/common": "2.34.0",
     "@webex/internal-media-core": "^0.0.7-beta",
-    "@webex/internal-plugin-conversation": "2.33.1",
-    "@webex/internal-plugin-device": "2.33.1",
-    "@webex/internal-plugin-mercury": "2.33.1",
-    "@webex/internal-plugin-metrics": "2.33.1",
-    "@webex/internal-plugin-support": "2.33.1",
-    "@webex/internal-plugin-user": "2.33.1",
-    "@webex/plugin-people": "2.33.1",
-    "@webex/plugin-rooms": "2.33.1",
+    "@webex/internal-plugin-conversation": "2.34.0",
+    "@webex/internal-plugin-device": "2.34.0",
+    "@webex/internal-plugin-mercury": "2.34.0",
+    "@webex/internal-plugin-metrics": "2.34.0",
+    "@webex/internal-plugin-support": "2.34.0",
+    "@webex/internal-plugin-user": "2.34.0",
+    "@webex/plugin-people": "2.34.0",
+    "@webex/plugin-rooms": "2.34.0",
     "@webex/ts-sdp": "^1.0.1",
-    "@webex/webex-core": "2.33.1",
+    "@webex/webex-core": "2.34.0",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
     "dotenv": "^4.0.0",

package/src/meeting/index.js

@@ -4184,6 +4184,9 @@ export default class Meeting extends StatelessWebexPlugin {
   addMedia(options = {}) {
     const LOG_HEADER = 'Meeting:index#addMedia -->';
 
+    let turnDiscoverySkippedReason;
+    let turnServerUsed = false;
+
     if (this.meetingState !== FULL_STATE.ACTIVE) {
       return Promise.reject(new MeetingNotActiveError());
     }
@@ -4225,7 +4228,12 @@ export default class Meeting extends StatelessWebexPlugin {
 
     return MeetingUtil.validateOptions(options)
       .then(() => this.roap.doTurnDiscovery(this, false))
-      .then((turnServerInfo) => {
+      .then((turnDiscoveryObject) => {
+        ({turnDiscoverySkippedReason} = turnDiscoveryObject);
+        turnServerUsed = !turnDiscoverySkippedReason;
+
+        const {turnServerInfo} = turnDiscoveryObject;
+
         this.mediaProperties.setMediaPeerConnection(MediaUtil.createPeerConnection(turnServerInfo));
         this.setMercuryListener();
         PeerConnectionManager.setPeerConnectionEvents(this);
@@ -4266,7 +4274,9 @@ export default class Meeting extends StatelessWebexPlugin {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
               reason: error.message,
-              stack: error.stack
+              stack: error.stack,
+              turnDiscoverySkippedReason,
+              turnServerUsed
             }
           );
 
@@ -4376,7 +4386,9 @@ export default class Meeting extends StatelessWebexPlugin {
                 locus_id: this.locusUrl.split('/').pop(),
                 reason: error.message,
                 stack: error.stack,
-                code: error.code
+                code: error.code,
+                turnDiscoverySkippedReason,
+                turnServerUsed
               }
             );
 

package/src/roap/turnDiscovery.ts

@@ -206,13 +206,13 @@ export default class TurnDiscovery {
 
     if (isAnyClusterReachable) {
       LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> reachability has not failed, skipping TURN discovery');
-      return Promise.resolve(undefined);
+      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'reachability'});
     }
 
     if (!meeting.config.experimental.enableTurnDiscovery) {
       LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery disabled in config, skipping it');
 
-      return Promise.resolve(undefined);
+      return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});
     }
 
     return this.sendRoapTurnDiscoveryRequest(meeting, isReconnecting)
@@ -223,7 +223,7 @@ export default class TurnDiscovery {
 
         LoggerProxy.logger.info('Roap:turnDiscovery#doTurnDiscovery --> TURN discovery completed');
 
-        return this.turnInfo;
+        return {turnServerInfo: this.turnInfo, turnDiscoverySkippedReason: undefined};
       })
       .catch((e) => {
         // we catch any errors and resolve with no turn information so that the normal call join flow can continue without TURN
@@ -239,7 +239,7 @@ export default class TurnDiscovery {
           }
         );
 
-        return Promise.resolve(undefined);
+        return Promise.resolve({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
       });
   }
 }

package/test/unit/spec/meeting/index.js

@@ -920,7 +920,7 @@ describe('plugin-meetings', () => {
             meeting.mediaProperties.peerConnection.connectionState = CONSTANTS.CONNECTION_STATE.CONNECTED;
             resolve();
           }));
-          meeting.roap.doTurnDiscovery = sinon.stub().resolves();
+          meeting.roap.doTurnDiscovery = sinon.stub().resolves({turnServerInfo: {}, turnDiscoverySkippedReason: undefined});
           PeerConnectionManager.setContentSlides = sinon.stub().returns(true);
         });
 
@@ -961,6 +961,39 @@ describe('plugin-meetings', () => {
           await meeting.addMedia().catch((err) => {
             assert.exists(err);
             assert.isNull(meeting.statsAnalyzer);
+            assert(Metrics.sendBehavioralMetric.calledOnce);
+            assert.calledWith(
+              Metrics.sendBehavioralMetric,
+              BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE, {
+                correlation_id: meeting.correlationId,
+                locus_id: meeting.locusUrl.split('/').pop(),
+                reason: err.message,
+                stack: err.stack,
+                code: err.code,
+                turnDiscoverySkippedReason: undefined,
+                turnServerUsed: true
+              }
+            );
+          });
+        });
+
+        it('checks metrics called with skipped reason config', async () => {
+          meeting.roap.doTurnDiscovery = sinon.stub().resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: 'config'});
+          meeting.meetingState = 'ACTIVE';
+          await meeting.addMedia().catch((err) => {
+            assert.exists(err);
+            assert(Metrics.sendBehavioralMetric.calledOnce);
+            assert.calledWith(
+              Metrics.sendBehavioralMetric,
+              BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE, {
+                correlation_id: meeting.correlationId,
+                locus_id: meeting.locusUrl.split('/').pop(),
+                reason: err.message,
+                stack: err.stack,
+                turnDiscoverySkippedReason: 'config',
+                turnServerUsed: false
+              }
+            );
           });
         });
 
@@ -970,6 +1003,18 @@ describe('plugin-meetings', () => {
           await meeting.addMedia().catch((err) => {
             assert.exists(err);
             assert.isNull(meeting.mediaProperties.peerConnection);
+            assert(Metrics.sendBehavioralMetric.calledOnce);
+            assert.calledWith(
+              Metrics.sendBehavioralMetric,
+              BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE, {
+                correlation_id: meeting.correlationId,
+                locus_id: meeting.locusUrl.split('/').pop(),
+                reason: err.message,
+                stack: err.stack,
+                turnDiscoverySkippedReason: undefined,
+                turnServerUsed: true
+              }
+            );
           });
         });
 
@@ -1035,6 +1080,8 @@ describe('plugin-meetings', () => {
         });
 
         it('should attach the media and return promise', async () => {
+          meeting.roap.doTurnDiscovery = sinon.stub().resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
+
           meeting.meetingState = 'ACTIVE';
           MediaUtil.createPeerConnection.resetHistory();
           const media = meeting.addMedia({
@@ -1065,10 +1112,14 @@ describe('plugin-meetings', () => {
           meeting.meetingState = 'ACTIVE';
           MediaUtil.createPeerConnection.resetHistory();
 
+
           meeting.roap.doTurnDiscovery = sinon.stub().resolves({
-            url: FAKE_TURN_URL,
-            username: FAKE_TURN_USER,
-            password: FAKE_TURN_PASSWORD
+            turnServerInfo: {
+              url: FAKE_TURN_URL,
+              username: FAKE_TURN_USER,
+              password: FAKE_TURN_PASSWORD
+            },
+            turnServerSkippedReason: undefined
           });
           const media = meeting.addMedia({
             mediaSettings: {}
@@ -1087,6 +1138,7 @@ describe('plugin-meetings', () => {
         });
 
         it('should attach the media and return promise', async () => {
+          meeting.roap.doTurnDiscovery = sinon.stub().resolves({turnServerInfo: undefined, turnDiscoverySkippedReason: undefined});
           meeting.meetingState = 'ACTIVE';
           meeting.mediaProperties.peerConnection.connectionState = 'DISCONNECTED';
           const media = meeting.addMedia({

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

@@ -117,14 +117,15 @@ describe('TurnDiscovery', () => {
       // check that we've sent OK
       await checkRoapMessageSent('OK', 0);
 
-      const turnInfo = await result;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await result;
 
-      assert.deepEqual(turnInfo, {
+      assert.deepEqual(turnServerInfo, {
         url: FAKE_TURN_URL,
         username: FAKE_TURN_USERNAME,
         password: FAKE_TURN_PASSWORD
       });
 
+      assert.isUndefined(turnDiscoverySkippedReason);
     });
 
     it('sends TURN_DISCOVERY_REQUEST with empty mediaId when isReconnecting is true', async () => {
@@ -152,13 +153,14 @@ describe('TurnDiscovery', () => {
       // check that we've sent OK
       await checkRoapMessageSent('OK', 0);
 
-      const turnInfo = await result;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await result;
 
-      assert.deepEqual(turnInfo, {
+      assert.deepEqual(turnServerInfo, {
         url: FAKE_TURN_URL,
         username: FAKE_TURN_USERNAME,
         password: FAKE_TURN_PASSWORD
       });
+      assert.isUndefined(turnDiscoverySkippedReason);
     });
 
     it('ignores any extra, unexpected headers in the response', async () => {
@@ -187,13 +189,13 @@ describe('TurnDiscovery', () => {
       // check that we've sent OK and still parsed the headers we care about
       await checkRoapMessageSent('OK', 0);
 
-      const turnInfo = await result;
-
-      assert.deepEqual(turnInfo, {
+      const {turnServerInfo, turnDiscoverySkippedReason} = await result;
+      assert.deepEqual(turnServerInfo, {
         url: FAKE_TURN_URL,
         username: FAKE_TURN_USERNAME,
         password: FAKE_TURN_PASSWORD
       });
+      assert.isUndefined(turnDiscoverySkippedReason);
     });
 
     it('resolves with undefined if turn discovery feature is disabled in config', async () => {
@@ -203,7 +205,10 @@ describe('TurnDiscovery', () => {
 
       const result = await new TurnDiscovery(mockRoapRequest).doTurnDiscovery(testMeeting);
 
-      assert.isUndefined(result);
+      const {turnServerInfo, turnDiscoverySkippedReason} = result;
+
+      assert.isUndefined(turnServerInfo);
+      assert.equal(turnDiscoverySkippedReason, 'config');
       assert.notCalled(mockRoapRequest.sendRoap);
       assert.notCalled(Metrics.sendBehavioralMetric);
 
@@ -218,7 +223,10 @@ describe('TurnDiscovery', () => {
 
       const result = await td.doTurnDiscovery(testMeeting, false);
 
-      assert.isUndefined(result);
+      const {turnServerInfo, turnDiscoverySkippedReason} = result;
+
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
 
@@ -227,7 +235,10 @@ describe('TurnDiscovery', () => {
       testMeeting.webex.meetings.reachability.isAnyClusterReachable = () => true;
       const result = await new TurnDiscovery(mockRoapRequest).doTurnDiscovery(testMeeting);
 
-      assert.isUndefined(result);
+      const {turnServerInfo, turnDiscoverySkippedReason} = result;
+
+      assert.isUndefined(turnServerInfo);
+      assert.equal(turnDiscoverySkippedReason, 'reachability');
       assert.notCalled(mockRoapRequest.sendRoap);
       assert.notCalled(Metrics.sendBehavioralMetric);
       testMeeting.webex.meetings.reachability.isAnyClusterReachable = prev;
@@ -242,9 +253,10 @@ describe('TurnDiscovery', () => {
       await clock.tickAsync(10 * 1000);
       await testUtils.flushPromises();
 
-      const turnInfo = await promise;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await promise;
 
-      assert.isUndefined(turnInfo);
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
 
@@ -260,9 +272,10 @@ describe('TurnDiscovery', () => {
         ]
       });
       await testUtils.flushPromises();
-      const turnInfo = await turnDiscoveryPromise;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await turnDiscoveryPromise;
 
-      assert.isUndefined(turnInfo);
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
 
@@ -274,9 +287,10 @@ describe('TurnDiscovery', () => {
       td.handleTurnDiscoveryResponse({});
 
       await testUtils.flushPromises();
-      const turnInfo = await turnDiscoveryPromise;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await turnDiscoveryPromise;
 
-      assert.isUndefined(turnInfo);
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
 
@@ -288,9 +302,10 @@ describe('TurnDiscovery', () => {
       td.handleTurnDiscoveryResponse({headers: []});
 
       await testUtils.flushPromises();
-      const turnInfo = await turnDiscoveryPromise;
+      const {turnServerInfo, turnDiscoverySkippedReason}= await turnDiscoveryPromise;
 
-      assert.isUndefined(turnInfo);
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
 
@@ -321,9 +336,10 @@ describe('TurnDiscovery', () => {
       // check that we've sent OK
       await checkRoapMessageSent('OK', 0);
 
-      const turnInfo = await turnDiscoveryPromise;
+      const {turnServerInfo, turnDiscoverySkippedReason} = await turnDiscoveryPromise;
 
-      assert.isUndefined(turnInfo);
+      assert.isUndefined(turnServerInfo);
+      assert.isUndefined(turnDiscoverySkippedReason);
       checkFailureMetricsSent();
     });
   });