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

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","correlationId","locusSelfUrl","selfUrl","mediaId","audioMuted","audio","isLocallyMuted","videoMuted","video","meetingId","id","preferTranscoding","isMultistream","then","mediaConnections","updateMediaConnections","OK","webex","meetings","reachability","isAnyClusterReachable","config","experimental","enableTurnDiscovery","getSkipReason","skipReason","turnDiscoverySkippedReason","turnServerInfo","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":["// @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';\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        correlationId: meeting.correlationId,\n        // @ts-ignore - Fix missing type\n        locusSelfUrl: meeting.selfUrl,\n        // @ts-ignore - Fix missing type\n        mediaId: isReconnecting ? '' : meeting.mediaId,\n        audioMuted: meeting.audio?.isLocallyMuted(),\n        videoMuted: meeting.video?.isLocallyMuted(),\n        meetingId: meeting.id,\n        preferTranscoding: !meeting.isMultistream,\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      correlationId: meeting.correlationId,\n      audioMuted: meeting.audio?.isLocallyMuted(),\n      videoMuted: meeting.video?.isLocallyMuted(),\n      meetingId: meeting.id,\n      preferTranscoding: !meeting.isMultistream,\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;AANA;;AAWA,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;MAAA;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;QACX0B,aAAa,EAAEX,OAAO,CAACW,aAAa;QACpC;QACAC,YAAY,EAAEZ,OAAO,CAACa,OAAO;QAC7B;QACAC,OAAO,EAAEb,cAAc,GAAG,EAAE,GAAGD,OAAO,CAACc,OAAO;QAC9CC,UAAU,oBAAEf,OAAO,CAACgB,KAAK,mDAAb,eAAeC,cAAc,EAAE;QAC3CC,UAAU,oBAAElB,OAAO,CAACmB,KAAK,mDAAb,eAAeF,cAAc,EAAE;QAC3CG,SAAS,EAAEpB,OAAO,CAACqB,EAAE;QACrBC,iBAAiB,EAAE,CAACtB,OAAO,CAACuB;MAC9B,CAAC,CAAC,CACDC,IAAI,CAAC,gBAAwB;QAAA,IAAtBC,gBAAgB,QAAhBA,gBAAgB;QACtB,IAAIA,gBAAgB,EAAE;UACpBzB,OAAO,CAAC0B,sBAAsB,CAACD,gBAAgB,CAAC;QAClD;MACF,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWzB,OAAgB,EAAE;MAAA;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,CAACsB,EAAE;UAC/BpB,OAAO,EAAEH,gBAAI,CAACI,YAAY;UAC1BC,GAAG,EAAEzC;QACP,CAAC;QACD;QACA4C,YAAY,EAAEZ,OAAO,CAACa,OAAO;QAC7B;QACAC,OAAO,EAAEd,OAAO,CAACc,OAAO;QACxBH,aAAa,EAAEX,OAAO,CAACW,aAAa;QACpCI,UAAU,qBAAEf,OAAO,CAACgB,KAAK,oDAAb,gBAAeC,cAAc,EAAE;QAC3CC,UAAU,qBAAElB,OAAO,CAACmB,KAAK,oDAAb,gBAAeF,cAAc,EAAE;QAC3CG,SAAS,EAAEpB,OAAO,CAACqB,EAAE;QACrBC,iBAAiB,EAAE,CAACtB,OAAO,CAACuB;MAC9B,CAAC,CAAC;IACJ;;IAEA;AACF;AACA;AACA;AACA;AACA;EALE;IAAA;IAAA;MAAA,6FAMA,iBAA4BvB,OAAgB;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OAENA,OAAO,CAAC4B,KAAK,CAACC,QAAQ,CAACC,YAAY,CAACC,qBAAqB,EAAE;YAAA;cAAzFA,qBAAqB;cAAA,KAEvBA,qBAAqB;gBAAA;gBAAA;cAAA;cACvBvD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,2FAA2F,CAC5F;cAAC,iCAEK,cAAc;YAAA;cAAA,IAIlBiB,OAAO,CAACgC,MAAM,CAACC,YAAY,CAACC,mBAAmB;gBAAA;gBAAA;cAAA;cAClD1D,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,CAACmC,aAAa,CAACnC,OAAO,CAAC;YAAA;cAA9CoC,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,kBAAsBpC,OAAgB,EAAEC,cAAwB;QAAA;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACrB,IAAI,CAACkC,aAAa,CAACnC,OAAO,CAAC;YAAA;cAA9DqC,0BAA0B;cAAA,KAE5BA,0BAA0B;gBAAA;gBAAA;cAAA;cAAA,kCACrB;gBACLC,cAAc,EAAExC,SAAS;gBACzBuC,0BAA0B,EAA1BA;cACF,CAAC;YAAA;cAAA,kCAGI,IAAI,CAACE,4BAA4B,CAACvC,OAAO,EAAEC,cAAc,CAAC,CAC9DuB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACgB,4BAA4B,EAAE;cAAA,EAAC,CAC/ChB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACiB,UAAU,CAACzC,OAAO,CAAC;cAAA,EAAC,CACpCwB,IAAI,CAAC,YAAM;gBACV,MAAI,CAACjD,KAAK,GAAGuB,SAAS;gBAEtBtB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,iEAAiE,CAAC;gBAE1F,OAAO;kBAACuD,cAAc,EAAE,MAAI,CAACnE,QAAQ;kBAAEkE,0BAA0B,EAAEvC;gBAAS,CAAC;cAC/E,CAAC,CAAC,CACD4C,KAAK,CAAC,UAACC,CAAC,EAAK;gBACZ;gBACAnE,oBAAW,CAACC,MAAM,CAACM,IAAI,kGACqE4D,CAAC,EAC5F;gBAEDC,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACC,sBAAsB,EAAE;kBACtEC,cAAc,EAAEhD,OAAO,CAACW,aAAa;kBACrCsC,QAAQ,EAAEjD,OAAO,CAACkD,QAAQ,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,EAAE;kBAC3CC,MAAM,EAAEV,CAAC,CAACW,OAAO;kBACjBC,KAAK,EAAEZ,CAAC,CAACY;gBACX,CAAC,CAAC;gBAEF,OAAO;kBAACjB,cAAc,EAAExC,SAAS;kBAAEuC,0BAA0B,EAAEvC;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","then","mediaConnections","updateMediaConnections","OK","webex","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';\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      })\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;AANA;;AAWA,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;MAC7B,CAAC,CAAC,CACDC,IAAI,CAAC,gBAAwB;QAAA,IAAtBC,gBAAgB,QAAhBA,gBAAgB;QACtB,IAAIA,gBAAgB,EAAE;UACpBlB,OAAO,CAACmB,sBAAsB,CAACD,gBAAgB,CAAC;QAClD;MACF,CAAC,CAAC;IACN;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWlB,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,CAACe,EAAE;UAC/Bb,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,CAACqB,KAAK,CAACC,QAAQ,CAACC,YAAY,CAACC,qBAAqB,EAAE;YAAA;cAAzFA,qBAAqB;cAAA,KAEvBA,qBAAqB;gBAAA;gBAAA;cAAA;cACvBhD,oBAAW,CAACC,MAAM,CAACM,IAAI,CACrB,2FAA2F,CAC5F;cAAC,iCAEK,cAAc;YAAA;cAAA,IAIlBiB,OAAO,CAACyB,MAAM,CAACC,YAAY,CAACC,mBAAmB;gBAAA;gBAAA;cAAA;cAClDnD,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,CAAC4B,aAAa,CAAC5B,OAAO,CAAC;YAAA;cAA9C6B,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,kBAAsB7B,OAAgB,EAAEC,cAAwB;QAAA;QAAA;QAAA;UAAA;YAAA;cAAA;cAAA,OACrB,IAAI,CAAC2B,aAAa,CAAC5B,OAAO,CAAC;YAAA;cAA9D8B,0BAA0B;cAAA,KAE5BA,0BAA0B;gBAAA;gBAAA;cAAA;cAAA,kCACrB;gBACLC,cAAc,EAAEjC,SAAS;gBACzBgC,0BAA0B,EAA1BA;cACF,CAAC;YAAA;cAAA,kCAGI,IAAI,CAACE,4BAA4B,CAAChC,OAAO,EAAEC,cAAc,CAAC,CAC9DgB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACgB,4BAA4B,EAAE;cAAA,EAAC,CAC/ChB,IAAI,CAAC;gBAAA,OAAM,MAAI,CAACiB,UAAU,CAAClC,OAAO,CAAC;cAAA,EAAC,CACpCiB,IAAI,CAAC,YAAM;gBACV,MAAI,CAAC1C,KAAK,GAAGuB,SAAS;gBAEtBtB,oBAAW,CAACC,MAAM,CAACM,IAAI,CAAC,iEAAiE,CAAC;gBAE1F,OAAO;kBAACgD,cAAc,EAAE,MAAI,CAAC5D,QAAQ;kBAAE2D,0BAA0B,EAAEhC;gBAAS,CAAC;cAC/E,CAAC,CAAC,CACDqC,KAAK,CAAC,UAACC,CAAC,EAAK;gBACZ;gBACA5D,oBAAW,CAACC,MAAM,CAACM,IAAI,kGACqEqD,CAAC,EAC5F;gBAEDC,gBAAO,CAACC,oBAAoB,CAACC,kBAAkB,CAACC,sBAAsB,EAAE;kBACtEC,cAAc,EAAEzC,OAAO,CAAC0C,aAAa;kBACrCC,QAAQ,EAAE3C,OAAO,CAAC4C,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,EAAEjC,SAAS;kBAAEgC,0BAA0B,EAAEhC;gBAAS,CAAC;cAC3E,CAAC,CAAC;YAAA;YAAA;cAAA;UAAA;QAAA;MAAA,CACL;MAAA;QAAA;MAAA;MAAA;IAAA;EAAA;EAAA;AAAA;AAAA"}

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

@@ -16,6 +16,7 @@ import { ReactionServerType, SkinToneType } from '../reactions/reactions.type';
 import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
+import { LocusMediaRequest } from './locusMediaRequest';
 export declare const MEDIA_UPDATE_TYPE: {
     ALL: string;
     AUDIO: string;
@@ -312,6 +313,7 @@ export default class Meeting extends StatelessWebexPlugin {
     resource: string;
     roap: Roap;
     roapSeq: number;
+    selfUrl?: string;
     sipUri: string;
     type: string;
     userId: string;
@@ -333,6 +335,7 @@ export default class Meeting extends StatelessWebexPlugin {
     keepAliveTimerId: NodeJS.Timeout;
     lastVideoLayoutInfo: any;
     locusInfo: any;
+    locusMediaRequest?: LocusMediaRequest;
     mediaProperties: MediaProperties;
     mediaRequestManagers: {
         audio: MediaRequestManager;

package/dist/types/meeting/locusMediaRequest.d.ts

@@ -0,0 +1,68 @@
+import { WebexPlugin } from '@webex/webex-core';
+export type MediaRequestType = 'RoapMessage' | 'LocalMute';
+export type RequestResult = any;
+export type RoapRequest = {
+    type: 'RoapMessage';
+    selfUrl: string;
+    mediaId: string;
+    roapMessage: any;
+    reachability: any;
+    joinCookie: any;
+};
+export type LocalMuteRequest = {
+    type: 'LocalMute';
+    selfUrl: string;
+    mediaId: string;
+    muteOptions: {
+        audioMuted?: boolean;
+        videoMuted?: boolean;
+    };
+};
+export type Request = RoapRequest | LocalMuteRequest;
+export type Config = {
+    device: {
+        url: string;
+        deviceType: string;
+    };
+    correlationId: string;
+    preferTranscoding: boolean;
+};
+/**
+ * This class manages all /media API requests to Locus. Every call to that
+ * Locus API has to go through this class.
+ */
+export declare class LocusMediaRequest extends WebexPlugin {
+    private config;
+    private latestAudioMuted?;
+    private latestVideoMuted?;
+    private isRequestInProgress;
+    private queuedRequests;
+    private confluenceState;
+    /**
+     * Constructor
+     */
+    constructor(config: Config, options: any);
+    /**
+     * Add a request to the internal queue.
+     */
+    private addToQueue;
+    /**
+     * Takes the next request from the queue and executes it. Once that
+     * request is completed, the next one will be taken from the queue
+     * and executed and this is repeated until the queue is empty.
+     */
+    private executeNextQueuedRequest;
+    /**
+     * Returns latest requested audio and video mute values. If they have never been
+     * requested, we assume audio/video to be muted.
+     */
+    private getLatestMuteState;
+    /**
+     * Prepares the uri and body for the media request to be sent to Locus
+     */
+    private sendHttpRequest;
+    /**
+     * Sends a media request to Locus
+     */
+    send(request: Request): Promise<RequestResult>;
+}

package/dist/types/meeting/muteState.d.ts

@@ -4,8 +4,10 @@ export declare const createMuteState: (type: any, meeting: any, mediaDirection:
    the last requested state by the client.
 
    More info about Locus muting API: https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html#
+
+   This class is exported only for unit tests. It should never be instantiated directly with new MuteState(), instead createMuteState() should be called
 */
-declare class MuteState {
+export declare class MuteState {
     pendingPromiseReject: any;
     pendingPromiseResolve: any;
     state: any;
@@ -182,4 +184,3 @@ declare class MuteState {
     get muted(): any;
     get self(): boolean;
 }
-export {};

package/dist/types/meeting/request.d.ts

@@ -30,6 +30,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      * @param {boolean} options.moveToResource
      * @param {Object} options.roapMessage
      * @param {boolean} options.breakoutsSupported
+     * @param {String} options.locale,
+     * @param {Array} options.deviceCapabilities
      * @param {boolean} options.liveAnnotationSupported
      * @returns {Promise}
      */
@@ -50,6 +52,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         permissionToken: any;
         preferTranscoding: any;
         breakoutsSupported: boolean;
+        locale?: string;
+        deviceCapabilities?: Array<string>;
         liveAnnotationSupported: boolean;
     }): Promise<any>;
     /**
@@ -161,24 +165,6 @@ export default class MeetingRequest extends StatelessWebexPlugin {
         deviceUrl: string;
         reason: string;
     }): any;
-    /**
-     * Toggle remote audio and/or video
-     * @param {Object} options options for toggling
-     * @param {String} options.selfId Locus self id??
-     * @param {String} options.locusUrl Locus url
-     * @param {String} options.deviceUrl Url of a device
-     * @param {String} options.resourceId Populated if you are paired to a device
-     * @param {String} options.localMedias local sdps
-     * @param {Boolean} options.preferTranscoding false for multistream (Homer), true for transcoded media (Edonus)
-     * @returns {Promise}
-     */
-    remoteAudioVideoToggle(options: {
-        selfId: string;
-        locusUrl: string;
-        deviceUrl: string;
-        resourceId: string;
-        localMedias: string;
-    } | any): any;
     /**
      * change the content floor grant
      * @param {Object} options options for floor grant

package/dist/types/roap/request.d.ts

@@ -1,4 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import { LocusMediaRequest } from '../meeting/locusMediaRequest';
 /**
  * @class RoapRequest
  */
@@ -19,20 +20,17 @@ export default class RoapRequest extends StatelessWebexPlugin {
      * @param {String} options.locusSelfUrl
      * @param {String} options.mediaId
      * @param {String} options.correlationId
-     * @param {Boolean} options.audioMuted
-     * @param {Boolean} options.videoMuted
      * @param {String} options.meetingId
-     * @param {Boolean} options.preferTranscoding
      * @returns {Promise} returns the response/failure of the request
      */
     sendRoap(options: {
         roapMessage: any;
         locusSelfUrl: string;
         mediaId: string;
-        correlationId: string;
-        audioMuted: boolean;
-        videoMuted: boolean;
         meetingId: string;
-        preferTranscoding?: boolean;
-    }): Promise<any>;
+        locusMediaRequest?: LocusMediaRequest;
+    }): Promise<{
+        mediaConnections: any;
+        locus: any;
+    }>;
 }

package/dist/types/roap/turnDiscovery.d.ts

@@ -49,7 +49,10 @@ export default class TurnDiscovery {
      * @param {Meeting} meeting
      * @returns {Promise}
      */
-    sendRoapOK(meeting: Meeting): Promise<any>;
+    sendRoapOK(meeting: Meeting): Promise<{
+        mediaConnections: any;
+        locus: any;
+    }>;
     /**
      * Gets the reason why reachability is skipped.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.111",
+  "version": "3.0.0-beta.113",
   "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.111",
-    "@webex/test-helper-chai": "3.0.0-beta.111",
-    "@webex/test-helper-mocha": "3.0.0-beta.111",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.111",
-    "@webex/test-helper-retry": "3.0.0-beta.111",
-    "@webex/test-helper-test-users": "3.0.0-beta.111",
+    "@webex/plugin-meetings": "3.0.0-beta.113",
+    "@webex/test-helper-chai": "3.0.0-beta.113",
+    "@webex/test-helper-mocha": "3.0.0-beta.113",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.113",
+    "@webex/test-helper-retry": "3.0.0-beta.113",
+    "@webex/test-helper-test-users": "3.0.0-beta.113",
     "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.111",
+    "@webex/common": "3.0.0-beta.113",
     "@webex/internal-media-core": "1.38.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.111",
-    "@webex/internal-plugin-device": "3.0.0-beta.111",
-    "@webex/internal-plugin-llm": "3.0.0-beta.111",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.111",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.111",
-    "@webex/internal-plugin-support": "3.0.0-beta.111",
-    "@webex/internal-plugin-user": "3.0.0-beta.111",
-    "@webex/media-helpers": "3.0.0-beta.111",
-    "@webex/plugin-people": "3.0.0-beta.111",
-    "@webex/plugin-rooms": "3.0.0-beta.111",
-    "@webex/webex-core": "3.0.0-beta.111",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.113",
+    "@webex/internal-plugin-device": "3.0.0-beta.113",
+    "@webex/internal-plugin-llm": "3.0.0-beta.113",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.113",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.113",
+    "@webex/internal-plugin-support": "3.0.0-beta.113",
+    "@webex/internal-plugin-user": "3.0.0-beta.113",
+    "@webex/media-helpers": "3.0.0-beta.113",
+    "@webex/plugin-people": "3.0.0-beta.113",
+    "@webex/plugin-rooms": "3.0.0-beta.113",
+    "@webex/webex-core": "3.0.0-beta.113",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/media/index.ts

@@ -50,29 +50,6 @@ export type BundlePolicy = ConstructorParameters<
  */
 const Media: any = {};
 
-/**
- * format the media array for send
- * @param {String} mediaId
- * @param {Boolean} audioMuted
- * @param {Boolean} videoMuted
- * @returns {Array} medias
- */
-Media.generateLocalMedias = (mediaId: string, audioMuted: boolean, videoMuted: boolean) => {
-  if (mediaId) {
-    return [
-      {
-        localSdp: JSON.stringify({
-          audioMuted,
-          videoMuted,
-        }),
-        mediaId,
-      },
-    ];
-  }
-
-  return [];
-};
-
 /**
  * make a browser call to get the media
  * @param {SendOptions} options

package/src/meeting/index.ts

@@ -124,6 +124,7 @@ import {REACTION_RELAY_TYPES} from '../reactions/constants';
 import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import PermissionError from '../common/errors/permission';
+import {LocusMediaRequest} from './locusMediaRequest';
 
 const {isBrowser} = BrowserDetection();
 
@@ -467,6 +468,7 @@ export default class Meeting extends StatelessWebexPlugin {
   resource: string;
   roap: Roap;
   roapSeq: number;
+  selfUrl?: string; // comes from Locus, initialized by updateMeetingObject()
   sipUri: string;
   type: string;
   userId: string;
@@ -488,6 +490,7 @@ export default class Meeting extends StatelessWebexPlugin {
   keepAliveTimerId: NodeJS.Timeout;
   lastVideoLayoutInfo: any;
   locusInfo: any;
+  locusMediaRequest?: LocusMediaRequest;
   mediaProperties: MediaProperties;
   mediaRequestManagers: {
     audio: MediaRequestManager;
@@ -3732,6 +3735,8 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   public closePeerConnections() {
+    this.locusMediaRequest = undefined;
+
     if (this.mediaProperties.webrtcMediaConnection) {
       if (this.remoteMediaManager) {
         this.remoteMediaManager.stop();
@@ -5580,6 +5585,23 @@ export default class Meeting extends StatelessWebexPlugin {
     });
 
     return MeetingUtil.validateOptions(options)
+      .then(() => {
+        this.locusMediaRequest = new LocusMediaRequest(
+          {
+            correlationId: this.correlationId,
+            device: {
+              url: this.deviceUrl,
+              // @ts-ignore
+              deviceType: this.config.deviceType,
+            },
+            preferTranscoding: !this.isMultistream,
+          },
+          {
+            // @ts-ignore
+            parent: this.webex,
+          }
+        );
+      })
       .then(() => this.roap.doTurnDiscovery(this, false))
       .then((turnDiscoveryObject) => {
         ({turnDiscoverySkippedReason} = turnDiscoveryObject);