@webex/plugin-meetings 3.0.0-beta.257 → 3.0.0-beta.259

package/dist/roap/turnDiscovery.js.map

@@ -1 +1 @@
-{"version":3,"names":["TURN_DISCOVERY_TIMEOUT","TURN_DISCOVERY_SEQ","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","Defer","messageType","ROAP","ROAP_TYPES","TURN_DISCOVERY_REQUEST","version","ROAP_VERSION","seq","sendRoap","locusSelfUrl","selfUrl","mediaId","meetingId","id","locusMediaRequest","ipVersion","MeetingUtil","getIpVersion","webex","then","mediaConnections","updateMediaConnections","OK","meetings","reachability","isAnyClusterReachable","config","experimental","enableTurnDiscovery","getSkipReason","skipReason","turnDiscoverySkippedReason","turnServerInfo","sendRoapTurnDiscoveryRequest","waitForTurnDiscoveryResponse","sendRoapOK","catch","e","Metrics","sendBehavioralMetric","BEHAVIORAL_METRICS","TURN_DISCOVERY_FAILURE","correlation_id","correlationId","locus_id","locusUrl","split","pop","reason","message","stack"],"sources":["turnDiscovery.ts"],"sourcesContent":["// @ts-ignore - Types not available for @webex/common\nimport {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';\nimport Meeting from '../meeting';\nimport MeetingUtil from '../meeting/util';\n\nconst TURN_DISCOVERY_TIMEOUT = 10; // in seconds\n\n// Roap spec says that seq should start from 1, but TURN discovery works fine with seq=0\n// and this is handy for us, because TURN discovery is always done before the first SDP exchange,\n// so we can do it with seq=0 or not do it at all and then we create the RoapMediaConnection\n// and do the SDP offer with seq=1\nconst TURN_DISCOVERY_SEQ = 0;\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   * waits for TURN_DISCOVERY_RESPONSE message to arrive\n   *\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  private waitForTurnDiscoveryResponse() {\n    if (!this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress'\n      );\n\n      return Promise.reject(\n        new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()')\n      );\n    }\n\n    const {defer} = this;\n\n    this.responseTimer = setTimeout(() => {\n      LoggerProxy.logger.warn(\n        `Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`\n      );\n\n      defer.reject(new Error('Timed out waiting for TURN_DISCOVERY_RESPONSE'));\n    }, TURN_DISCOVERY_TIMEOUT * 1000);\n\n    LoggerProxy.logger.info(\n      'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...'\n    );\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  public handleTurnDiscoveryResponse(roapMessage: object) {\n    // @ts-ignore - Fix missing type\n    const {headers} = roapMessage;\n\n    if (!this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response'\n      );\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(\n            expectedHeader.headerName.length + 1\n          );\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(\n        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(\n          headers\n        )}`\n      );\n      this.defer.reject(\n        new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`)\n      );\n    } else {\n      LoggerProxy.logger.info(\n        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`\n      );\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: Meeting, isReconnecting: boolean) {\n    if (this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress'\n      );\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: TURN_DISCOVERY_SEQ,\n    };\n\n    LoggerProxy.logger.info(\n      'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST'\n    );\n\n    return this.roapRequest\n      .sendRoap({\n        roapMessage,\n        // @ts-ignore - Fix missing type\n        locusSelfUrl: meeting.selfUrl,\n        // @ts-ignore - Fix missing type\n        mediaId: isReconnecting ? '' : meeting.mediaId,\n        meetingId: meeting.id,\n        locusMediaRequest: meeting.locusMediaRequest,\n        // @ts-ignore - because of meeting.webex\n        ipVersion: MeetingUtil.getIpVersion(meeting.webex),\n      })\n      .then(({mediaConnections}) => {\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: 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: TURN_DISCOVERY_SEQ,\n      },\n      // @ts-ignore - fix type\n      locusSelfUrl: meeting.selfUrl,\n      // @ts-ignore - fix type\n      mediaId: meeting.mediaId,\n      meetingId: meeting.id,\n      locusMediaRequest: meeting.locusMediaRequest,\n    });\n  }\n\n  /**\n   * Gets the reason why reachability is skipped.\n   *\n   * @param {Meeting} meeting\n   * @returns {Promise<string>} Promise with empty string if reachability is not skipped or a reason if it is skipped\n   */\n  private async getSkipReason(meeting: Meeting): Promise<string> {\n    // @ts-ignore - fix type\n    const isAnyClusterReachable = await meeting.webex.meetings.reachability.isAnyClusterReachable();\n\n    if (isAnyClusterReachable) {\n      LoggerProxy.logger.info(\n        'Roap:turnDiscovery#getSkipReason --> reachability has not failed, skipping TURN discovery'\n      );\n\n      return 'reachability';\n    }\n\n    // @ts-ignore - fix type\n    if (!meeting.config.experimental.enableTurnDiscovery) {\n      LoggerProxy.logger.info(\n        'Roap:turnDiscovery#getSkipReason --> TURN discovery disabled in config, skipping it'\n      );\n\n      return 'config';\n    }\n\n    return '';\n  }\n\n  /**\n   * Checks if TURN discovery is skipped.\n   *\n   * @param {Meeting} meeting\n   * @returns {Boolean} true if TURN discovery is being skipped, false if it is being done\n   */\n  async isSkipped(meeting) {\n    const skipReason = await this.getSkipReason(meeting);\n\n    return !!skipReason;\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   * This TURN discovery roap exchange is always done with seq=0.\n   * The RoapMediaConnection SDP exchange always starts with seq=1,\n   * so it works fine no matter if TURN discovery is done or not.\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  async doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean) {\n    const turnDiscoverySkippedReason = await this.getSkipReason(meeting);\n\n    if (turnDiscoverySkippedReason) {\n      return {\n        turnServerInfo: undefined,\n        turnDiscoverySkippedReason,\n      };\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(\n          `Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`\n        );\n\n        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE, {\n          correlation_id: meeting.correlationId,\n          locus_id: meeting.locusUrl.split('/').pop(),\n          reason: e.message,\n          stack: e.stack,\n        });\n\n        return {turnServerInfo: undefined, turnDiscoverySkippedReason: undefined};\n      });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AACA;AAEA;AACA;AACA;AACA;AAIA;AAVA;;AAYA,IAAMA,sBAAsB,GAAG,EAAE,CAAC,CAAC;;AAEnC;AACA;AACA;AACA;AACA,IAAMC,kBAAkB,GAAG,CAAC;;AAE5B;AACA;AACA;AACA;AAHA,IAIqBC,aAAa;EAGT;;EAUvB;AACF;AACA;AACA;AACA;EACE,uBAAYC,WAAwB,EAAE;IAAA;IAAA;IAAA;IAAA;IAAA;IACpC,IAAI,CAACA,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,QAAQ,GAAG;MACdC,GAAG,EAAE,EAAE;MACPC,QAAQ,EAAE,EAAE;MACZC,QAAQ,EAAE;IACZ,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,wCAAuC;MACrC,IAAI,CAAC,IAAI,CAACC,KAAK,EAAE;QACfC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,uFAAuF,CACxF;QAED,OAAO,iBAAQC,MAAM,CACnB,IAAIC,KAAK,CAAC,6EAA6E,CAAC,CACzF;MACH;MAEA,IAAOL,KAAK,GAAI,IAAI,CAAbA,KAAK;MAEZ,IAAI,CAACM,aAAa,GAAGC,UAAU,CAAC,YAAM;QACpCN,oBAAW,CAACC,MAAM,CAACC,IAAI,mGACsEX,sBAAsB,cAClH;QAEDQ,KAAK,CAACI,MAAM,CAAC,IAAIC,KAAK,CAAC,+CAA+C,CAAC,CAAC;MAC1E,CAAC,EAAEb,sBAAsB,GAAG,IAAI,CAAC;MAEjCS,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,4FAA4F,CAC7F;MAED,OAAOR,KAAK,CAACS,OAAO;IACtB;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAA;IAAA,OAQA,qCAAmCC,WAAmB,EAAE;MAAA;MACtD;MACA,IAAOC,OAAO,GAAID,WAAW,CAAtBC,OAAO;MAEd,IAAI,CAAC,IAAI,CAACX,KAAK,EAAE;QACfC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,uFAAuF,CACxF;QAED;MACF;MAEA,IAAMS,eAAe,GAAG,CACtB;QAACC,UAAU,EAAE,kBAAkB;QAAEC,KAAK,EAAE;MAAK,CAAC,EAC9C;QAACD,UAAU,EAAE,uBAAuB;QAAEC,KAAK,EAAE;MAAU,CAAC,EACxD;QAACD,UAAU,EAAE,uBAAuB;QAAEC,KAAK,EAAE;MAAU,CAAC,CACzD;MAED,IAAIC,YAAY,GAAG,CAAC;MAEpBJ,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEK,OAAO,CAAC,UAACC,cAAc,EAAK;QACnC;QACAL,eAAe,CAACI,OAAO,CAAC,UAACE,cAAc,EAAK;UAC1C,IAAID,cAAc,CAACE,UAAU,WAAID,cAAc,CAACL,UAAU,OAAI,EAAE;YAC9D,KAAI,CAACjB,QAAQ,CAACsB,cAAc,CAACJ,KAAK,CAAC,GAAGG,cAAc,CAACG,SAAS,CAC5DF,cAAc,CAACL,UAAU,CAACQ,MAAM,GAAG,CAAC,CACrC;YACDN,YAAY,IAAI,CAAC;UACnB;QACF,CAAC,CAAC;MACJ,CAAC,CAAC;MAEFO,YAAY,CAAC,IAAI,CAAChB,aAAa,CAAC;MAChC,IAAI,CAACA,aAAa,GAAGiB,SAAS;MAE9B,IAAIR,YAAY,KAAKH,eAAe,CAACS,MAAM,EAAE;QAC3CpB,oBAAW,CAACC,MAAM,CAACC,IAAI,8FACiE,wBACpFQ,OAAO,CACR,EACF;QACD,IAAI,CAACX,KAAK,CAACI,MAAM,CACf,IAAIC,KAAK,yDAAkD,wBAAeM,OAAO,CAAC,EAAG,CACtF;MACH,CAAC,MAAM;QACLV,oBAAW,CAACC,MAAM,CAACM,IAAI,6FACgE,IAAI,CAACZ,QAAQ,CAACC,GAAG,EACvG;QACD,IAAI,CAACG,KAAK,CAACwB,OAAO,EAAE;MACtB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EARE;IAAA;IAAA,OASA,sCAA6BC,OAAgB,EAAEC,cAAuB,EAAE;MACtE,IAAI,IAAI,CAAC1B,KAAK,EAAE;QACdC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,yEAAyE,CAC1E;QAED,OAAO,iBAAQqB,OAAO,EAAE;MAC1B;MAEA,IAAI,CAACxB,KAAK,GAAG,IAAI2B,aAAK,EAAE;MAExB,IAAMjB,WAAW,GAAG;QAClBkB,WAAW,EAAEC,gBAAI,CAACC,UAAU,CAACC,sBAAsB;QACnDC,OAAO,EAAEH,gBAAI,CAACI,YAAY;QAC1BC,GAAG,EAAEzC;MACP,CAAC;MAEDQ,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,oFAAoF,CACrF;MAED,OAAO,IAAI,CAACb,WAAW,CACpBwC,QAAQ,CAAC;QACRzB,WAAW,EAAXA,WAAW;QACX;QACA0B,YAAY,EAAEX,OAAO,CAACY,OAAO;QAC7B;QACAC,OAAO,EAAEZ,cAAc,GAAG,EAAE,GAAGD,OAAO,CAACa,OAAO;QAC9CC,SAAS,EAAEd,OAAO,CAACe,EAAE;QACrBC,iBAAiB,EAAEhB,OAAO,CAACgB,iBAAiB;QAC5C;QACAC,SAAS,EAAEC,aAAW,CAACC,YAAY,CAACnB,OAAO,CAACoB,KAAK;MACnD,CAAC,CAAC,CACDC,IAAI,CAAC,gBAAwB;QAAA,IAAtBC,gBAAgB,QAAhBA,gBAAgB;QACtB,IAAIA,gBAAgB,EAAE;UACpBtB,OAAO,CAACuB,sBAAsB,CAACD,gBAAgB,CAAC;QAClD;MACF,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWtB,OAAgB,EAAE;MAC3BxB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,8CAA8C,CAAC;MAEvE,OAAO,IAAI,CAACb,WAAW,CAACwC,QAAQ,CAAC;QAC/BzB,WAAW,EAAE;UACXkB,WAAW,EAAEC,gBAAI,CAACC,UAAU,CAACmB,EAAE;UAC/BjB,OAAO,EAAEH,gBAAI,CAACI,YAAY;UAC1BC,GAAG,EAAEzC;QACP,CAAC;QACD;QACA2C,YAAY,EAAEX,OAAO,CAACY,OAAO;QAC7B;QACAC,OAAO,EAAEb,OAAO,CAACa,OAAO;QACxBC,SAAS,EAAEd,OAAO,CAACe,EAAE;QACrBC,iBAAiB,EAAEhB,OAAO,CAACgB;MAC7B,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,6FAMA,iBAA4BhB,OAAgB;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OAENA,OAAO,CAACoB,KAAK,CAACK,QAAQ,CAACC,YAAY,CAACC,qBAAqB,EAAE;YAAA;cAAzFA,qBAAqB;cAAA,KAEvBA,qBAAqB;gBAAA;gBAAA;cAAA;cACvBnD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,2FAA2F,CAC5F;cAAC,iCAEK,cAAc;YAAA;cAAA,IAIlBiB,OAAO,CAAC4B,MAAM,CAACC,YAAY,CAACC,mBAAmB;gBAAA;gBAAA;cAAA;cAClDtD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,qFAAqF,CACtF;cAAC,iCAEK,QAAQ;YAAA;cAAA,iCAGV,EAAE;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACV;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,yFAMA,kBAAgBiB,OAAO;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACI,IAAI,CAAC+B,aAAa,CAAC/B,OAAO,CAAC;YAAA;cAA9CgC,UAAU;cAAA,kCAET,CAAC,CAACA,UAAU;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACpB;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAhBE;IAAA;IAAA;MAAA,+FAiBA,kBAAsBhC,OAAgB,EAAEC,cAAwB;QAAA;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACrB,IAAI,CAAC8B,aAAa,CAAC/B,OAAO,CAAC;YAAA;cAA9DiC,0BAA0B;cAAA,KAE5BA,0BAA0B;gBAAA;gBAAA;cAAA;cAAA,kCACrB;gBACLC,cAAc,EAAEpC,SAAS;gBACzBmC,0BAA0B,EAA1BA;cACF,CAAC;YAAA;cAAA,kCAGI,IAAI,CAACE,4BAA4B,CAACnC,OAAO,EAAEC,cAAc,CAAC,CAC9DoB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACe,4BAA4B,EAAE;cAAA,EAAC,CAC/Cf,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACgB,UAAU,CAACrC,OAAO,CAAC;cAAA,EAAC,CACpCqB,IAAI,CAAC,YAAM;gBACV,MAAI,CAAC9C,KAAK,GAAGuB,SAAS;gBAEtBtB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,iEAAiE,CAAC;gBAE1F,OAAO;kBAACmD,cAAc,EAAE,MAAI,CAAC/D,QAAQ;kBAAE8D,0BAA0B,EAAEnC;gBAAS,CAAC;cAC/E,CAAC,CAAC,CACDwC,KAAK,CAAC,UAACC,CAAC,EAAK;gBACZ;gBACA/D,oBAAW,CAACC,MAAM,CAACM,IAAI,kGACqEwD,CAAC,EAC5F;gBAEDC,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACC,sBAAsB,EAAE;kBACtEC,cAAc,EAAE5C,OAAO,CAAC6C,aAAa;kBACrCC,QAAQ,EAAE9C,OAAO,CAAC+C,QAAQ,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,EAAE;kBAC3CC,MAAM,EAAEX,CAAC,CAACY,OAAO;kBACjBC,KAAK,EAAEb,CAAC,CAACa;gBACX,CAAC,CAAC;gBAEF,OAAO;kBAAClB,cAAc,EAAEpC,SAAS;kBAAEmC,0BAA0B,EAAEnC;gBAAS,CAAC;cAC3E,CAAC,CAAC;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACL;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA;AAAA"}
+{"version":3,"names":["TURN_DISCOVERY_TIMEOUT","TURN_DISCOVERY_SEQ","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","Defer","messageType","ROAP","ROAP_TYPES","TURN_DISCOVERY_REQUEST","version","ROAP_VERSION","seq","sendRoap","locusSelfUrl","selfUrl","mediaId","meetingId","id","locusMediaRequest","ipVersion","MeetingUtil","getIpVersion","webex","then","mediaConnections","updateMediaConnections","OK","meetings","reachability","isAnyPublicClusterReachable","config","experimental","enableTurnDiscovery","getSkipReason","skipReason","turnDiscoverySkippedReason","turnServerInfo","sendRoapTurnDiscoveryRequest","waitForTurnDiscoveryResponse","sendRoapOK","catch","e","Metrics","sendBehavioralMetric","BEHAVIORAL_METRICS","TURN_DISCOVERY_FAILURE","correlation_id","correlationId","locus_id","locusUrl","split","pop","reason","message","stack"],"sources":["turnDiscovery.ts"],"sourcesContent":["// @ts-ignore - Types not available for @webex/common\nimport {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';\nimport Meeting from '../meeting';\nimport MeetingUtil from '../meeting/util';\n\nconst TURN_DISCOVERY_TIMEOUT = 10; // in seconds\n\n// Roap spec says that seq should start from 1, but TURN discovery works fine with seq=0\n// and this is handy for us, because TURN discovery is always done before the first SDP exchange,\n// so we can do it with seq=0 or not do it at all and then we create the RoapMediaConnection\n// and do the SDP offer with seq=1\nconst TURN_DISCOVERY_SEQ = 0;\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   * waits for TURN_DISCOVERY_RESPONSE message to arrive\n   *\n   * @returns {Promise}\n   * @private\n   * @memberof Roap\n   */\n  private waitForTurnDiscoveryResponse() {\n    if (!this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> TURN discovery is not in progress'\n      );\n\n      return Promise.reject(\n        new Error('waitForTurnDiscoveryResponse() called before sendRoapTurnDiscoveryRequest()')\n      );\n    }\n\n    const {defer} = this;\n\n    this.responseTimer = setTimeout(() => {\n      LoggerProxy.logger.warn(\n        `Roap:turnDiscovery#waitForTurnDiscoveryResponse --> timeout! no response arrived within ${TURN_DISCOVERY_TIMEOUT} seconds`\n      );\n\n      defer.reject(new Error('Timed out waiting for TURN_DISCOVERY_RESPONSE'));\n    }, TURN_DISCOVERY_TIMEOUT * 1000);\n\n    LoggerProxy.logger.info(\n      'Roap:turnDiscovery#waitForTurnDiscoveryResponse --> waiting for TURN_DISCOVERY_RESPONSE...'\n    );\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  public handleTurnDiscoveryResponse(roapMessage: object) {\n    // @ts-ignore - Fix missing type\n    const {headers} = roapMessage;\n\n    if (!this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#handleTurnDiscoveryResponse --> unexpected TURN discovery response'\n      );\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(\n            expectedHeader.headerName.length + 1\n          );\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(\n        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> missing some headers, received: ${JSON.stringify(\n          headers\n        )}`\n      );\n      this.defer.reject(\n        new Error(`TURN_DISCOVERY_RESPONSE missing some headers: ${JSON.stringify(headers)}`)\n      );\n    } else {\n      LoggerProxy.logger.info(\n        `Roap:turnDiscovery#handleTurnDiscoveryResponse --> received a valid response, url=${this.turnInfo.url}`\n      );\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: Meeting, isReconnecting: boolean) {\n    if (this.defer) {\n      LoggerProxy.logger.warn(\n        'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> already in progress'\n      );\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: TURN_DISCOVERY_SEQ,\n    };\n\n    LoggerProxy.logger.info(\n      'Roap:turnDiscovery#sendRoapTurnDiscoveryRequest --> sending TURN_DISCOVERY_REQUEST'\n    );\n\n    return this.roapRequest\n      .sendRoap({\n        roapMessage,\n        // @ts-ignore - Fix missing type\n        locusSelfUrl: meeting.selfUrl,\n        // @ts-ignore - Fix missing type\n        mediaId: isReconnecting ? '' : meeting.mediaId,\n        meetingId: meeting.id,\n        locusMediaRequest: meeting.locusMediaRequest,\n        // @ts-ignore - because of meeting.webex\n        ipVersion: MeetingUtil.getIpVersion(meeting.webex),\n      })\n      .then(({mediaConnections}) => {\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: 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: TURN_DISCOVERY_SEQ,\n      },\n      // @ts-ignore - fix type\n      locusSelfUrl: meeting.selfUrl,\n      // @ts-ignore - fix type\n      mediaId: meeting.mediaId,\n      meetingId: meeting.id,\n      locusMediaRequest: meeting.locusMediaRequest,\n    });\n  }\n\n  /**\n   * Gets the reason why reachability is skipped.\n   *\n   * @param {Meeting} meeting\n   * @returns {Promise<string>} Promise with empty string if reachability is not skipped or a reason if it is skipped\n   */\n  private async getSkipReason(meeting: Meeting): Promise<string> {\n    const isAnyPublicClusterReachable =\n      // @ts-ignore - fix type\n      await meeting.webex.meetings.reachability.isAnyPublicClusterReachable();\n\n    if (isAnyPublicClusterReachable) {\n      LoggerProxy.logger.info(\n        'Roap:turnDiscovery#getSkipReason --> reachability has not failed, skipping TURN discovery'\n      );\n\n      return 'reachability';\n    }\n\n    // @ts-ignore - fix type\n    if (!meeting.config.experimental.enableTurnDiscovery) {\n      LoggerProxy.logger.info(\n        'Roap:turnDiscovery#getSkipReason --> TURN discovery disabled in config, skipping it'\n      );\n\n      return 'config';\n    }\n\n    return '';\n  }\n\n  /**\n   * Checks if TURN discovery is skipped.\n   *\n   * @param {Meeting} meeting\n   * @returns {Boolean} true if TURN discovery is being skipped, false if it is being done\n   */\n  async isSkipped(meeting) {\n    const skipReason = await this.getSkipReason(meeting);\n\n    return !!skipReason;\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   * This TURN discovery roap exchange is always done with seq=0.\n   * The RoapMediaConnection SDP exchange always starts with seq=1,\n   * so it works fine no matter if TURN discovery is done or not.\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  async doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean) {\n    const turnDiscoverySkippedReason = await this.getSkipReason(meeting);\n\n    if (turnDiscoverySkippedReason) {\n      return {\n        turnServerInfo: undefined,\n        turnDiscoverySkippedReason,\n      };\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(\n          `Roap:turnDiscovery#doTurnDiscovery --> TURN discovery failed, continuing without TURN: ${e}`\n        );\n\n        Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.TURN_DISCOVERY_FAILURE, {\n          correlation_id: meeting.correlationId,\n          locus_id: meeting.locusUrl.split('/').pop(),\n          reason: e.message,\n          stack: e.stack,\n        });\n\n        return {turnServerInfo: undefined, turnDiscoverySkippedReason: undefined};\n      });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;AACA;AAEA;AACA;AACA;AACA;AAIA;AAVA;;AAYA,IAAMA,sBAAsB,GAAG,EAAE,CAAC,CAAC;;AAEnC;AACA;AACA;AACA;AACA,IAAMC,kBAAkB,GAAG,CAAC;;AAE5B;AACA;AACA;AACA;AAHA,IAIqBC,aAAa;EAGT;;EAUvB;AACF;AACA;AACA;AACA;EACE,uBAAYC,WAAwB,EAAE;IAAA;IAAA;IAAA;IAAA;IAAA;IACpC,IAAI,CAACA,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,QAAQ,GAAG;MACdC,GAAG,EAAE,EAAE;MACPC,QAAQ,EAAE,EAAE;MACZC,QAAQ,EAAE;IACZ,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,wCAAuC;MACrC,IAAI,CAAC,IAAI,CAACC,KAAK,EAAE;QACfC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,uFAAuF,CACxF;QAED,OAAO,iBAAQC,MAAM,CACnB,IAAIC,KAAK,CAAC,6EAA6E,CAAC,CACzF;MACH;MAEA,IAAOL,KAAK,GAAI,IAAI,CAAbA,KAAK;MAEZ,IAAI,CAACM,aAAa,GAAGC,UAAU,CAAC,YAAM;QACpCN,oBAAW,CAACC,MAAM,CAACC,IAAI,mGACsEX,sBAAsB,cAClH;QAEDQ,KAAK,CAACI,MAAM,CAAC,IAAIC,KAAK,CAAC,+CAA+C,CAAC,CAAC;MAC1E,CAAC,EAAEb,sBAAsB,GAAG,IAAI,CAAC;MAEjCS,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,4FAA4F,CAC7F;MAED,OAAOR,KAAK,CAACS,OAAO;IACtB;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAPE;IAAA;IAAA,OAQA,qCAAmCC,WAAmB,EAAE;MAAA;MACtD;MACA,IAAOC,OAAO,GAAID,WAAW,CAAtBC,OAAO;MAEd,IAAI,CAAC,IAAI,CAACX,KAAK,EAAE;QACfC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,uFAAuF,CACxF;QAED;MACF;MAEA,IAAMS,eAAe,GAAG,CACtB;QAACC,UAAU,EAAE,kBAAkB;QAAEC,KAAK,EAAE;MAAK,CAAC,EAC9C;QAACD,UAAU,EAAE,uBAAuB;QAAEC,KAAK,EAAE;MAAU,CAAC,EACxD;QAACD,UAAU,EAAE,uBAAuB;QAAEC,KAAK,EAAE;MAAU,CAAC,CACzD;MAED,IAAIC,YAAY,GAAG,CAAC;MAEpBJ,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEK,OAAO,CAAC,UAACC,cAAc,EAAK;QACnC;QACAL,eAAe,CAACI,OAAO,CAAC,UAACE,cAAc,EAAK;UAC1C,IAAID,cAAc,CAACE,UAAU,WAAID,cAAc,CAACL,UAAU,OAAI,EAAE;YAC9D,KAAI,CAACjB,QAAQ,CAACsB,cAAc,CAACJ,KAAK,CAAC,GAAGG,cAAc,CAACG,SAAS,CAC5DF,cAAc,CAACL,UAAU,CAACQ,MAAM,GAAG,CAAC,CACrC;YACDN,YAAY,IAAI,CAAC;UACnB;QACF,CAAC,CAAC;MACJ,CAAC,CAAC;MAEFO,YAAY,CAAC,IAAI,CAAChB,aAAa,CAAC;MAChC,IAAI,CAACA,aAAa,GAAGiB,SAAS;MAE9B,IAAIR,YAAY,KAAKH,eAAe,CAACS,MAAM,EAAE;QAC3CpB,oBAAW,CAACC,MAAM,CAACC,IAAI,8FACiE,wBACpFQ,OAAO,CACR,EACF;QACD,IAAI,CAACX,KAAK,CAACI,MAAM,CACf,IAAIC,KAAK,yDAAkD,wBAAeM,OAAO,CAAC,EAAG,CACtF;MACH,CAAC,MAAM;QACLV,oBAAW,CAACC,MAAM,CAACM,IAAI,6FACgE,IAAI,CAACZ,QAAQ,CAACC,GAAG,EACvG;QACD,IAAI,CAACG,KAAK,CAACwB,OAAO,EAAE;MACtB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EARE;IAAA;IAAA,OASA,sCAA6BC,OAAgB,EAAEC,cAAuB,EAAE;MACtE,IAAI,IAAI,CAAC1B,KAAK,EAAE;QACdC,oBAAW,CAACC,MAAM,CAACC,IAAI,CACrB,yEAAyE,CAC1E;QAED,OAAO,iBAAQqB,OAAO,EAAE;MAC1B;MAEA,IAAI,CAACxB,KAAK,GAAG,IAAI2B,aAAK,EAAE;MAExB,IAAMjB,WAAW,GAAG;QAClBkB,WAAW,EAAEC,gBAAI,CAACC,UAAU,CAACC,sBAAsB;QACnDC,OAAO,EAAEH,gBAAI,CAACI,YAAY;QAC1BC,GAAG,EAAEzC;MACP,CAAC;MAEDQ,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,oFAAoF,CACrF;MAED,OAAO,IAAI,CAACb,WAAW,CACpBwC,QAAQ,CAAC;QACRzB,WAAW,EAAXA,WAAW;QACX;QACA0B,YAAY,EAAEX,OAAO,CAACY,OAAO;QAC7B;QACAC,OAAO,EAAEZ,cAAc,GAAG,EAAE,GAAGD,OAAO,CAACa,OAAO;QAC9CC,SAAS,EAAEd,OAAO,CAACe,EAAE;QACrBC,iBAAiB,EAAEhB,OAAO,CAACgB,iBAAiB;QAC5C;QACAC,SAAS,EAAEC,aAAW,CAACC,YAAY,CAACnB,OAAO,CAACoB,KAAK;MACnD,CAAC,CAAC,CACDC,IAAI,CAAC,gBAAwB;QAAA,IAAtBC,gBAAgB,QAAhBA,gBAAgB;QACtB,IAAIA,gBAAgB,EAAE;UACpBtB,OAAO,CAACuB,sBAAsB,CAACD,gBAAgB,CAAC;QAClD;MACF,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWtB,OAAgB,EAAE;MAC3BxB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,8CAA8C,CAAC;MAEvE,OAAO,IAAI,CAACb,WAAW,CAACwC,QAAQ,CAAC;QAC/BzB,WAAW,EAAE;UACXkB,WAAW,EAAEC,gBAAI,CAACC,UAAU,CAACmB,EAAE;UAC/BjB,OAAO,EAAEH,gBAAI,CAACI,YAAY;UAC1BC,GAAG,EAAEzC;QACP,CAAC;QACD;QACA2C,YAAY,EAAEX,OAAO,CAACY,OAAO;QAC7B;QACAC,OAAO,EAAEb,OAAO,CAACa,OAAO;QACxBC,SAAS,EAAEd,OAAO,CAACe,EAAE;QACrBC,iBAAiB,EAAEhB,OAAO,CAACgB;MAC7B,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,6FAMA,iBAA4BhB,OAAgB;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OAGlCA,OAAO,CAACoB,KAAK,CAACK,QAAQ,CAACC,YAAY,CAACC,2BAA2B,EAAE;YAAA;cAFnEA,2BAA2B;cAAA,KAI7BA,2BAA2B;gBAAA;gBAAA;cAAA;cAC7BnD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,2FAA2F,CAC5F;cAAC,iCAEK,cAAc;YAAA;cAAA,IAIlBiB,OAAO,CAAC4B,MAAM,CAACC,YAAY,CAACC,mBAAmB;gBAAA;gBAAA;cAAA;cAClDtD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,qFAAqF,CACtF;cAAC,iCAEK,QAAQ;YAAA;cAAA,iCAGV,EAAE;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACV;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,yFAMA,kBAAgBiB,OAAO;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACI,IAAI,CAAC+B,aAAa,CAAC/B,OAAO,CAAC;YAAA;cAA9CgC,UAAU;cAAA,kCAET,CAAC,CAACA,UAAU;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACpB;MAAA;QAAA;MAAA;MAAA;IAAA;IAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAhBE;IAAA;IAAA;MAAA,+FAiBA,kBAAsBhC,OAAgB,EAAEC,cAAwB;QAAA;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACrB,IAAI,CAAC8B,aAAa,CAAC/B,OAAO,CAAC;YAAA;cAA9DiC,0BAA0B;cAAA,KAE5BA,0BAA0B;gBAAA;gBAAA;cAAA;cAAA,kCACrB;gBACLC,cAAc,EAAEpC,SAAS;gBACzBmC,0BAA0B,EAA1BA;cACF,CAAC;YAAA;cAAA,kCAGI,IAAI,CAACE,4BAA4B,CAACnC,OAAO,EAAEC,cAAc,CAAC,CAC9DoB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACe,4BAA4B,EAAE;cAAA,EAAC,CAC/Cf,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACgB,UAAU,CAACrC,OAAO,CAAC;cAAA,EAAC,CACpCqB,IAAI,CAAC,YAAM;gBACV,MAAI,CAAC9C,KAAK,GAAGuB,SAAS;gBAEtBtB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,iEAAiE,CAAC;gBAE1F,OAAO;kBAACmD,cAAc,EAAE,MAAI,CAAC/D,QAAQ;kBAAE8D,0BAA0B,EAAEnC;gBAAS,CAAC;cAC/E,CAAC,CAAC,CACDwC,KAAK,CAAC,UAACC,CAAC,EAAK;gBACZ;gBACA/D,oBAAW,CAACC,MAAM,CAACM,IAAI,kGACqEwD,CAAC,EAC5F;gBAEDC,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACC,sBAAsB,EAAE;kBACtEC,cAAc,EAAE5C,OAAO,CAAC6C,aAAa;kBACrCC,QAAQ,EAAE9C,OAAO,CAAC+C,QAAQ,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,EAAE;kBAC3CC,MAAM,EAAEX,CAAC,CAACY,OAAO;kBACjBC,KAAK,EAAEb,CAAC,CAACa;gBACX,CAAC,CAAC;gBAEF,OAAO;kBAAClB,cAAc,EAAEpC,SAAS;kBAAEmC,0BAA0B,EAAEnC;gBAAS,CAAC;cAC3E,CAAC,CAAC;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACL;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA;AAAA"}

package/dist/types/meetings/index.d.ts

@@ -244,7 +244,17 @@ export default class Meetings extends WebexPlugin {
      * @public
      * @memberof Meetings
      */
-    startReachability(): Promise<unknown>;
+    startReachability(): Promise<{
+        [x: string]: {
+            udp: import("../reachability").TransportResult;
+            tcp: import("../reachability").TransportResult;
+            xtls: {
+                untested: "true";
+            };
+        } & {
+            isVideoMesh?: boolean;
+        };
+    }>;
     /**
      * Get geoHint for info for meetings
      * @returns {Promise}

package/dist/types/reachability/index.d.ts

@@ -1,8 +1,26 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+export type TransportResult = {
+    reachable: 'true' | 'false';
+    latencyInMilliseconds?: string;
+    clientMediaIPs?: string[];
+    untested?: 'true';
+};
+type ReachabilityResult = {
+    udp: TransportResult;
+    tcp: TransportResult;
+    xtls: {
+        untested: 'true';
+    };
+};
+export type ReachabilityResults = Record<string, ReachabilityResult>;
+type InternalReachabilityResults = Record<string, ReachabilityResult & {
+    isVideoMesh?: boolean;
+}>;
 export type ICECandidateResult = {
     clusterId: string;
+    isVideoMesh: boolean;
     elapsed?: string | null;
     publicIPs?: string[];
 };
@@ -28,14 +46,20 @@ export default class Reachability {
      * @async
      * @memberof Reachability
      */
-    gatherReachability(): Promise<unknown>;
+    gatherReachability(): Promise<InternalReachabilityResults>;
+    /**
+     * Reachability results as an object in the format that backend expects
+     *
+     * @returns {any} reachability results that need to be sent to the backend
+     */
+    getReachabilityResults(): Promise<ReachabilityResults | undefined>;
     /**
      * fetches reachability data and checks for cluster reachability
      * @returns {boolean}
      * @public
      * @memberof Reachability
      */
-    isAnyClusterReachable(): Promise<boolean>;
+    isAnyPublicClusterReachable(): Promise<boolean>;
     /**
      * Generate peerConnection config settings
      * @param {object} cluster
@@ -99,7 +123,7 @@ export default class Reachability {
      * speed.
      * @private
      * @param {RTCPeerConnection} peerConnection
-     * @param {number} timeout
+     * @param {boolean} isVideoMesh
      * @returns {Promise}
      */
     private iceGatheringState;
@@ -117,11 +141,11 @@ export default class Reachability {
      * @protected
      * @memberof Reachability
      */
-    protected parseIceResultsToReachabilityResults(iceResults: Array<ICECandidateResult>): {};
+    protected parseIceResultsToInternalReachabilityResults(iceResults: Array<ICECandidateResult>): InternalReachabilityResults;
     /**
      * fetches reachability data
      * @param {object} clusterList
-     * @returns {Promise<localSDPData>} reachability check results
+     * @returns {Promise<InternalReachabilityResults>} reachability check results
      * @private
      * @memberof Reachability
      */
@@ -150,3 +174,4 @@ export default class Reachability {
      */
     private setup;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.257",
+  "version": "3.0.0-beta.259",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.257",
-    "@webex/test-helper-chai": "3.0.0-beta.257",
-    "@webex/test-helper-mocha": "3.0.0-beta.257",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.257",
-    "@webex/test-helper-retry": "3.0.0-beta.257",
-    "@webex/test-helper-test-users": "3.0.0-beta.257",
+    "@webex/plugin-meetings": "3.0.0-beta.259",
+    "@webex/test-helper-chai": "3.0.0-beta.259",
+    "@webex/test-helper-mocha": "3.0.0-beta.259",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.259",
+    "@webex/test-helper-retry": "3.0.0-beta.259",
+    "@webex/test-helper-test-users": "3.0.0-beta.259",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.257",
-    "@webex/internal-media-core": "2.0.3",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.257",
-    "@webex/internal-plugin-device": "3.0.0-beta.257",
-    "@webex/internal-plugin-llm": "3.0.0-beta.257",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.257",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.257",
-    "@webex/internal-plugin-support": "3.0.0-beta.257",
-    "@webex/internal-plugin-user": "3.0.0-beta.257",
-    "@webex/media-helpers": "3.0.0-beta.257",
-    "@webex/plugin-people": "3.0.0-beta.257",
-    "@webex/plugin-rooms": "3.0.0-beta.257",
-    "@webex/webex-core": "3.0.0-beta.257",
+    "@webex/common": "3.0.0-beta.259",
+    "@webex/internal-media-core": "2.0.4",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.259",
+    "@webex/internal-plugin-device": "3.0.0-beta.259",
+    "@webex/internal-plugin-llm": "3.0.0-beta.259",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.259",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.259",
+    "@webex/internal-plugin-support": "3.0.0-beta.259",
+    "@webex/internal-plugin-user": "3.0.0-beta.259",
+    "@webex/media-helpers": "3.0.0-beta.259",
+    "@webex/plugin-people": "3.0.0-beta.259",
+    "@webex/plugin-rooms": "3.0.0-beta.259",
+    "@webex/webex-core": "3.0.0-beta.259",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/reachability/index.ts

@@ -4,7 +4,7 @@
 
 /* eslint-disable class-methods-use-this */
 /* globals window */
-import _ from 'lodash';
+import {uniq, mapValues, pick} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import MeetingUtil from '../meeting/util';
@@ -16,7 +16,39 @@ import ReachabilityRequest from './request';
 const DEFAULT_TIMEOUT = 3000;
 const VIDEO_MESH_TIMEOUT = 1000;
 
-export type ICECandidateResult = {clusterId: string; elapsed?: string | null; publicIPs?: string[]};
+// result for a specific transport protocol (like udp or tcp)
+export type TransportResult = {
+  reachable: 'true' | 'false';
+  latencyInMilliseconds?: string;
+  clientMediaIPs?: string[];
+  untested?: 'true';
+};
+
+// reachability result for a specifc media cluster
+type ReachabilityResult = {
+  udp: TransportResult;
+  tcp: TransportResult;
+  xtls: {
+    untested: 'true';
+  };
+};
+// this is the type that is required by the backend when we send them reachability results
+export type ReachabilityResults = Record<string, ReachabilityResult>;
+
+// this is the type used by Reachability class internally and stored in local storage
+type InternalReachabilityResults = Record<
+  string,
+  ReachabilityResult & {
+    isVideoMesh?: boolean;
+  }
+>;
+
+export type ICECandidateResult = {
+  clusterId: string;
+  isVideoMesh: boolean;
+  elapsed?: string | null;
+  publicIPs?: string[];
+};
 /**
  * @class Reachability
  * @export
@@ -61,7 +93,7 @@ export default class Reachability {
    * @async
    * @memberof Reachability
    */
-  public async gatherReachability() {
+  public async gatherReachability(): Promise<InternalReachabilityResults> {
     this.setup();
 
     // Remove stored reachability results to ensure no stale data
@@ -106,13 +138,45 @@ export default class Reachability {
     }
   }
 
+  /**
+   * Reachability results as an object in the format that backend expects
+   *
+   * @returns {any} reachability results that need to be sent to the backend
+   */
+  async getReachabilityResults(): Promise<ReachabilityResults | undefined> {
+    let results: ReachabilityResults;
+
+    // these are the only props that backend needs in the reachability results:
+    const reachabilityResultsProps: Array<keyof ReachabilityResult> = ['udp', 'tcp', 'xtls'];
+
+    try {
+      // @ts-ignore
+      const resultsJson = await this.webex.boundedStorage.get(
+        REACHABILITY.namespace,
+        REACHABILITY.localStorageResult
+      );
+
+      const internalResults: InternalReachabilityResults = JSON.parse(resultsJson);
+
+      results = mapValues(internalResults, (result) => pick(result, reachabilityResultsProps));
+    } catch (e) {
+      // empty storage, that's ok
+      LoggerProxy.logger.warn(
+        'Roap:request#attachReachabilityData --> Error parsing reachability data: ',
+        e
+      );
+    }
+
+    return results;
+  }
+
   /**
    * fetches reachability data and checks for cluster reachability
    * @returns {boolean}
    * @public
    * @memberof Reachability
    */
-  async isAnyClusterReachable() {
+  async isAnyPublicClusterReachable() {
     let reachable = false;
     // @ts-ignore
     const reachabilityData = await this.webex.boundedStorage
@@ -121,10 +185,12 @@ export default class Reachability {
 
     if (reachabilityData) {
       try {
-        const reachabilityResults = JSON.parse(reachabilityData);
+        const reachabilityResults: InternalReachabilityResults = JSON.parse(reachabilityData);
 
         reachable = Object.values(reachabilityResults).some(
-          (result: any) => result.udp?.reachable === 'true' || result.tcp?.reachable === 'true'
+          (result) =>
+            !result.isVideoMesh &&
+            (result.udp?.reachable === 'true' || result.tcp?.reachable === 'true')
         );
       } catch (e) {
         LoggerProxy.logger.error(
@@ -144,7 +210,7 @@ export default class Reachability {
    * @memberof Reachability
    */
   private buildPeerConnectionConfig(cluster: any) {
-    const iceServers = _.uniq(cluster.udp).map((url) => ({
+    const iceServers = uniq(cluster.udp).map((url) => ({
       username: '',
       credential: '',
       urls: [url],
@@ -205,7 +271,7 @@ export default class Reachability {
    * @private
    * @memberof Reachability
    */
-  private getLocalSDPForClusters(clusterList: object) {
+  private getLocalSDPForClusters(clusterList: object): Promise<InternalReachabilityResults> {
     let clusters: any[] = [...Object.keys(clusterList)];
 
     clusters = clusters.map(async (key) => {
@@ -218,18 +284,17 @@ export default class Reachability {
       peerConnection.begin = Date.now();
       peerConnection.setLocalDescription(description);
 
-      return this.iceGatheringState(
-        peerConnection,
-        cluster.isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT
-      ).catch((iceGatheringStateError) => {
-        LoggerProxy.logger.log(
-          `Reachability:index#getLocalSDPForClusters --> Error in getLocalSDP : ${iceGatheringStateError}`
-        );
-      });
+      return this.iceGatheringState(peerConnection, cluster.isVideoMesh).catch(
+        (iceGatheringStateError) => {
+          LoggerProxy.logger.log(
+            `Reachability:index#getLocalSDPForClusters --> Error in getLocalSDP : ${iceGatheringStateError}`
+          );
+        }
+      );
     });
 
     return Promise.all(clusters)
-      .then(this.parseIceResultsToReachabilityResults)
+      .then(this.parseIceResultsToInternalReachabilityResults)
       .then((reachabilityLatencyResults) => {
         this.logUnreachableClusters();
 
@@ -318,12 +383,14 @@ export default class Reachability {
    * speed.
    * @private
    * @param {RTCPeerConnection} peerConnection
-   * @param {number} timeout
+   * @param {boolean} isVideoMesh
    * @returns {Promise}
    */
-  private iceGatheringState(peerConnection: RTCPeerConnection, timeout: number) {
+  private iceGatheringState(peerConnection: RTCPeerConnection, isVideoMesh: boolean) {
     const ELAPSED = 'elapsed';
 
+    const timeout = isVideoMesh ? VIDEO_MESH_TIMEOUT : DEFAULT_TIMEOUT;
+
     return new Promise<ICECandidateResult>((resolve) => {
       const peerConnectionProxy = new window.Proxy(peerConnection, {
         // eslint-disable-next-line require-jsdoc
@@ -339,8 +406,14 @@ export default class Reachability {
         set: (target, property, value) => {
           // only intercept elapsed property
           if (property === ELAPSED) {
-            // @ts-ignore
-            resolve({clusterId: peerConnection.key, publicIPs: target.publicIPs, elapsed: value});
+            resolve({
+              // @ts-ignore
+              clusterId: peerConnection.key,
+              isVideoMesh,
+              // @ts-ignore
+              publicIPs: target.publicIPs,
+              elapsed: value,
+            });
 
             return true;
           }
@@ -392,10 +465,12 @@ export default class Reachability {
    * @protected
    * @memberof Reachability
    */
-  protected parseIceResultsToReachabilityResults(iceResults: Array<ICECandidateResult>) {
+  protected parseIceResultsToInternalReachabilityResults(
+    iceResults: Array<ICECandidateResult>
+  ): InternalReachabilityResults {
     const reachabilityMap = {};
 
-    iceResults.forEach(({clusterId, elapsed, publicIPs}) => {
+    iceResults.forEach(({clusterId, isVideoMesh, elapsed, publicIPs}) => {
       const latencyResult = {};
 
       if (!elapsed) {
@@ -417,6 +492,7 @@ export default class Reachability {
         udp: latencyResult,
         tcp: {untested: 'true'},
         xtls: {untested: 'true'},
+        isVideoMesh,
       };
     });
 
@@ -426,11 +502,11 @@ export default class Reachability {
   /**
    * fetches reachability data
    * @param {object} clusterList
-   * @returns {Promise<localSDPData>} reachability check results
+   * @returns {Promise<InternalReachabilityResults>} reachability check results
    * @private
    * @memberof Reachability
    */
-  private performReachabilityCheck(clusterList: object) {
+  private performReachabilityCheck(clusterList: object): Promise<InternalReachabilityResults> {
     if (!clusterList || !Object.keys(clusterList).length) {
       return Promise.resolve({});
     }

package/src/reachability/request.ts

@@ -49,7 +49,7 @@ class ReachabilityRequest {
         const {clusters, joinCookie} = res.body;
 
         Object.keys(clusters).forEach((key) => {
-          clusters[key].isVideoMesh = res.body.clusterClasses?.hybridMedia?.includes(key);
+          clusters[key].isVideoMesh = !!res.body.clusterClasses?.hybridMedia?.includes(key);
         });
 
         LoggerProxy.logger.log(

package/src/roap/request.ts

@@ -18,23 +18,10 @@ export default class RoapRequest extends StatelessWebexPlugin {
     let joinCookie;
 
     // @ts-ignore
-    const reachabilityData = await this.webex.boundedStorage
-      .get(REACHABILITY.namespace, REACHABILITY.localStorageResult)
-      .catch(() => {});
-
-    if (reachabilityData) {
-      try {
-        const reachabilityResult = JSON.parse(reachabilityData);
+    const reachabilityResult = await this.webex.meetings.reachability.getReachabilityResults();
 
-        /* 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}`
-        );
-      }
+    if (reachabilityResult && Object.keys(reachabilityResult).length) {
+      localSdp.reachability = reachabilityResult;
     }
 
     // @ts-ignore

package/src/roap/turnDiscovery.ts

@@ -225,10 +225,11 @@ export default class TurnDiscovery {
    * @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();
+    const isAnyPublicClusterReachable =
+      // @ts-ignore - fix type
+      await meeting.webex.meetings.reachability.isAnyPublicClusterReachable();
 
-    if (isAnyClusterReachable) {
+    if (isAnyPublicClusterReachable) {
       LoggerProxy.logger.info(
         'Roap:turnDiscovery#getSkipReason --> reachability has not failed, skipping TURN discovery'
       );

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

@@ -1722,7 +1722,8 @@ describe('plugin-meetings', () => {
           meeting.locusInfo.onFullLocus = sinon.stub();
           meeting.webex.meetings.geoHintInfo = {regionCode: 'EU', countryCode: 'UK'};
           meeting.webex.meetings.reachability = {
-            isAnyClusterReachable: sinon.stub().resolves(true),
+            isAnyPublicClusterReachable: sinon.stub().resolves(true),
+            getReachabilityResults: sinon.stub().resolves(undefined),
           };
           meeting.roap.doTurnDiscovery = sinon
             .stub()