@webex/plugin-meetings 3.0.0-beta.280 → 3.0.0-beta.281

package/dist/rtcMetrics/index.js

@@ -33,12 +33,12 @@ var RtcMetrics = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "meetingId", void 0);
     (0, _defineProperty2.default)(this, "correlationId", void 0);
     // `window` is used to prevent typescript from returning a NodeJS.Timer.
-    this.intervalId = window.setInterval(this.checkMetrics.bind(this), 30 * 1000);
+    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
     this.meetingId = meetingId;
     this.webex = webex;
     this.correlationId = correlationId;
     // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.
-    setTimeout(this.checkMetrics.bind(this), 5 * 1000);
+    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);
   }
 
   /**
@@ -47,8 +47,8 @@ var RtcMetrics = /*#__PURE__*/function () {
    * @returns {void}
    */
   (0, _createClass2.default)(RtcMetrics, [{
-    key: "checkMetrics",
-    value: function checkMetrics() {
+    key: "sendMetricsInQueue",
+    value: function sendMetricsInQueue() {
       if (this.metricsQueue.length) {
         this.sendMetrics();
         this.metricsQueue = [];
@@ -78,7 +78,7 @@ var RtcMetrics = /*#__PURE__*/function () {
   }, {
     key: "closeMetrics",
     value: function closeMetrics() {
-      this.checkMetrics();
+      this.sendMetricsInQueue();
       clearInterval(this.intervalId);
     }
 

package/dist/rtcMetrics/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["RtcMetrics","webex","meetingId","correlationId","intervalId","window","setInterval","checkMetrics","bind","setTimeout","metricsQueue","length","sendMetrics","data","payload","push","clearInterval","request","method","service","resource","headers","type","appId","RTC_METRICS","APP_ID","body","metrics","version","userId","internal","device"],"sources":["index.ts"],"sourcesContent":["import RTC_METRICS from './constants';\n\n/**\n * Rtc Metrics\n */\nexport default class RtcMetrics {\n  /**\n   * Array of MetricData items to be sent to the metrics service.\n   */\n  metricsQueue = [];\n\n  intervalId: number;\n\n  webex: any;\n\n  meetingId: string;\n\n  correlationId: string;\n\n  /**\n   * Initialize the interval.\n   *\n   * @param {object} webex - The main `webex` object.\n   * @param {string} meetingId - The meeting id.\n   * @param {string} correlationId - The correlation id.\n   */\n  constructor(webex, meetingId, correlationId) {\n    // `window` is used to prevent typescript from returning a NodeJS.Timer.\n    this.intervalId = window.setInterval(this.checkMetrics.bind(this), 30 * 1000);\n    this.meetingId = meetingId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.\n    setTimeout(this.checkMetrics.bind(this), 5 * 1000);\n  }\n\n  /**\n   * Check to see if the metrics queue has any items.\n   *\n   * @returns {void}\n   */\n  private checkMetrics() {\n    if (this.metricsQueue.length) {\n      this.sendMetrics();\n      this.metricsQueue = [];\n    }\n  }\n\n  /**\n   * Add metrics items to the metrics queue.\n   *\n   * @param {object} data - An object with a payload array of metrics items.\n   *\n   * @returns {void}\n   */\n  addMetrics(data) {\n    if (data.payload.length) {\n      this.metricsQueue.push(data);\n    }\n  }\n\n  /**\n   * Clear the metrics interval.\n   *\n   * @returns {void}\n   */\n  closeMetrics() {\n    this.checkMetrics();\n    clearInterval(this.intervalId);\n  }\n\n  /**\n   * Send metrics to the metrics service.\n   *\n   * @returns {void}\n   */\n  private sendMetrics() {\n    this.webex.request({\n      method: 'POST',\n      service: 'unifiedTelemetry',\n      resource: 'metric/v2',\n      headers: {\n        type: 'webrtcMedia',\n        appId: RTC_METRICS.APP_ID,\n      },\n      body: {\n        metrics: [\n          {\n            type: 'webrtc',\n            version: '1.0.1',\n            userId: this.webex.internal.device.userId,\n            meetingId: this.meetingId,\n            correlationId: this.correlationId,\n            data: this.metricsQueue,\n          },\n        ],\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAAA;AAEA;AACA;AACA;AAFA,IAGqBA,UAAU;EAC7B;AACF;AACA;;EAWE;AACF;AACA;AACA;AACA;AACA;AACA;EACE,oBAAYC,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA;IAAA,oDAjB9B,EAAE;IAAA;IAAA;IAAA;IAAA;IAkBf;IACA,IAAI,CAACC,UAAU,GAAGC,MAAM,CAACC,WAAW,CAAC,IAAI,CAACC,YAAY,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IAC7E,IAAI,CAACN,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACD,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC;IACAM,UAAU,CAAC,IAAI,CAACF,YAAY,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;EACpD;;EAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,wBAAuB;MACrB,IAAI,IAAI,CAACE,YAAY,CAACC,MAAM,EAAE;QAC5B,IAAI,CAACC,WAAW,EAAE;QAClB,IAAI,CAACF,YAAY,GAAG,EAAE;MACxB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWG,IAAI,EAAE;MACf,IAAIA,IAAI,CAACC,OAAO,CAACH,MAAM,EAAE;QACvB,IAAI,CAACD,YAAY,CAACK,IAAI,CAACF,IAAI,CAAC;MAC9B;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,wBAAe;MACb,IAAI,CAACN,YAAY,EAAE;MACnBS,aAAa,CAAC,IAAI,CAACZ,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,uBAAsB;MACpB,IAAI,CAACH,KAAK,CAACgB,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPC,IAAI,EAAE,aAAa;UACnBC,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEL,IAAI,EAAE,QAAQ;YACdM,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAAC5B,KAAK,CAAC6B,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzC3B,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCU,IAAI,EAAE,IAAI,CAACH;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA;AAAA;AAAA"}
+{"version":3,"names":["RtcMetrics","webex","meetingId","correlationId","intervalId","window","setInterval","sendMetricsInQueue","bind","setTimeout","metricsQueue","length","sendMetrics","data","payload","push","clearInterval","request","method","service","resource","headers","type","appId","RTC_METRICS","APP_ID","body","metrics","version","userId","internal","device"],"sources":["index.ts"],"sourcesContent":["import RTC_METRICS from './constants';\n\n/**\n * Rtc Metrics\n */\nexport default class RtcMetrics {\n  /**\n   * Array of MetricData items to be sent to the metrics service.\n   */\n  metricsQueue = [];\n\n  intervalId: number;\n\n  webex: any;\n\n  meetingId: string;\n\n  correlationId: string;\n\n  /**\n   * Initialize the interval.\n   *\n   * @param {object} webex - The main `webex` object.\n   * @param {string} meetingId - The meeting id.\n   * @param {string} correlationId - The correlation id.\n   */\n  constructor(webex, meetingId, correlationId) {\n    // `window` is used to prevent typescript from returning a NodeJS.Timer.\n    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);\n    this.meetingId = meetingId;\n    this.webex = webex;\n    this.correlationId = correlationId;\n    // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.\n    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);\n  }\n\n  /**\n   * Check to see if the metrics queue has any items.\n   *\n   * @returns {void}\n   */\n  public sendMetricsInQueue() {\n    if (this.metricsQueue.length) {\n      this.sendMetrics();\n      this.metricsQueue = [];\n    }\n  }\n\n  /**\n   * Add metrics items to the metrics queue.\n   *\n   * @param {object} data - An object with a payload array of metrics items.\n   *\n   * @returns {void}\n   */\n  addMetrics(data) {\n    if (data.payload.length) {\n      this.metricsQueue.push(data);\n    }\n  }\n\n  /**\n   * Clear the metrics interval.\n   *\n   * @returns {void}\n   */\n  closeMetrics() {\n    this.sendMetricsInQueue();\n    clearInterval(this.intervalId);\n  }\n\n  /**\n   * Send metrics to the metrics service.\n   *\n   * @returns {void}\n   */\n  private sendMetrics() {\n    this.webex.request({\n      method: 'POST',\n      service: 'unifiedTelemetry',\n      resource: 'metric/v2',\n      headers: {\n        type: 'webrtcMedia',\n        appId: RTC_METRICS.APP_ID,\n      },\n      body: {\n        metrics: [\n          {\n            type: 'webrtc',\n            version: '1.0.1',\n            userId: this.webex.internal.device.userId,\n            meetingId: this.meetingId,\n            correlationId: this.correlationId,\n            data: this.metricsQueue,\n          },\n        ],\n      },\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;AAAA;AAEA;AACA;AACA;AAFA,IAGqBA,UAAU;EAC7B;AACF;AACA;;EAWE;AACF;AACA;AACA;AACA;AACA;AACA;EACE,oBAAYC,KAAK,EAAEC,SAAS,EAAEC,aAAa,EAAE;IAAA;IAAA,oDAjB9B,EAAE;IAAA;IAAA;IAAA;IAAA;IAkBf;IACA,IAAI,CAACC,UAAU,GAAGC,MAAM,CAACC,WAAW,CAAC,IAAI,CAACC,kBAAkB,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC;IACnF,IAAI,CAACN,SAAS,GAAGA,SAAS;IAC1B,IAAI,CAACD,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACE,aAAa,GAAGA,aAAa;IAClC;IACAM,UAAU,CAAC,IAAI,CAACF,kBAAkB,CAACC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;EAC1D;;EAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,8BAA4B;MAC1B,IAAI,IAAI,CAACE,YAAY,CAACC,MAAM,EAAE;QAC5B,IAAI,CAACC,WAAW,EAAE;QAClB,IAAI,CAACF,YAAY,GAAG,EAAE;MACxB;IACF;;IAEA;AACF;AACA;AACA;AACA;AACA;AACA;EANE;IAAA;IAAA,OAOA,oBAAWG,IAAI,EAAE;MACf,IAAIA,IAAI,CAACC,OAAO,CAACH,MAAM,EAAE;QACvB,IAAI,CAACD,YAAY,CAACK,IAAI,CAACF,IAAI,CAAC;MAC9B;IACF;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,wBAAe;MACb,IAAI,CAACN,kBAAkB,EAAE;MACzBS,aAAa,CAAC,IAAI,CAACZ,UAAU,CAAC;IAChC;;IAEA;AACF;AACA;AACA;AACA;EAJE;IAAA;IAAA,OAKA,uBAAsB;MACpB,IAAI,CAACH,KAAK,CAACgB,OAAO,CAAC;QACjBC,MAAM,EAAE,MAAM;QACdC,OAAO,EAAE,kBAAkB;QAC3BC,QAAQ,EAAE,WAAW;QACrBC,OAAO,EAAE;UACPC,IAAI,EAAE,aAAa;UACnBC,KAAK,EAAEC,kBAAW,CAACC;QACrB,CAAC;QACDC,IAAI,EAAE;UACJC,OAAO,EAAE,CACP;YACEL,IAAI,EAAE,QAAQ;YACdM,OAAO,EAAE,OAAO;YAChBC,MAAM,EAAE,IAAI,CAAC5B,KAAK,CAAC6B,QAAQ,CAACC,MAAM,CAACF,MAAM;YACzC3B,SAAS,EAAE,IAAI,CAACA,SAAS;YACzBC,aAAa,EAAE,IAAI,CAACA,aAAa;YACjCU,IAAI,EAAE,IAAI,CAACH;UACb,CAAC;QAEL;MACF,CAAC,CAAC;IACJ;EAAC;EAAA;AAAA;AAAA"}

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

@@ -1144,6 +1144,13 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Boolean}
      */
     canUpdateMedia(): boolean;
+    /**
+     *  media failed, so collect a stats report from webrtc using the wcme connection to grab the rtc stats report
+     * send a webrtc telemetry dump to the configured server using the internal media core check metrics configured callback
+     * @param {String} callFrom - the function calling this function, optional.
+     * @returns {Promise<void>}
+     */
+    private forceSendStatsReport;
     /**
      * Enqueues a media update operation.
      * @param {String} mediaUpdateType one of MEDIA_UPDATE_TYPE values

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

@@ -23,7 +23,7 @@ export default class RtcMetrics {
      *
      * @returns {void}
      */
-    private checkMetrics;
+    sendMetricsInQueue(): void;
     /**
      * Add metrics items to the metrics queue.
      *

package/package.json

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

package/src/media/index.ts

@@ -182,8 +182,10 @@ Media.createMediaConnection = (
     return new MultistreamRoapMediaConnection(
       config,
       meetingId,
+      /* the rtc metrics objects callbacks */
       (data) => rtcMetrics.addMetrics(data),
-      () => rtcMetrics.closeMetrics()
+      () => rtcMetrics.closeMetrics(),
+      () => rtcMetrics.sendMetricsInQueue()
     );
   }
 

package/src/meeting/index.ts

@@ -5944,6 +5944,10 @@ export default class Meeting extends StatelessWebexPlugin {
 
         this.statsAnalyzer = null;
 
+        // when media fails, we want to upload a webrtc dump to see whats going on
+        // this function is async, but returns once the stats have been gathered
+        await this.forceSendStatsReport({callFrom: 'addMedia'});
+
         if (this.mediaProperties.webrtcMediaConnection) {
           this.closePeerConnections();
           this.unsetPeerConnections();
@@ -5979,6 +5983,24 @@ export default class Meeting extends StatelessWebexPlugin {
     return !this.isRoapInProgress;
   }
 
+  /**
+   *  media failed, so collect a stats report from webrtc using the wcme connection to grab the rtc stats report
+   * send a webrtc telemetry dump to the configured server using the internal media core check metrics configured callback
+   * @param {String} callFrom - the function calling this function, optional.
+   * @returns {Promise<void>}
+   */
+  private forceSendStatsReport = async ({callFrom}: {callFrom?: string}) => {
+    const LOG_HEADER = `Meeting:index#forceSendStatsReport --> called from ${callFrom} : `;
+    try {
+      await this.mediaProperties?.webrtcMediaConnection?.forceRtcMetricsSend();
+      LoggerProxy.logger.info(
+        `${LOG_HEADER} successfully uploaded available webrtc telemetry statistics`
+      );
+    } catch (e) {
+      LoggerProxy.logger.error(`${LOG_HEADER} failed to upload webrtc telemetry statistics: `, e);
+    }
+  };
+
   /**
    * Enqueues a media update operation.
    * @param {String} mediaUpdateType one of MEDIA_UPDATE_TYPE values

package/src/rtcMetrics/index.ts

@@ -26,12 +26,12 @@ export default class RtcMetrics {
    */
   constructor(webex, meetingId, correlationId) {
     // `window` is used to prevent typescript from returning a NodeJS.Timer.
-    this.intervalId = window.setInterval(this.checkMetrics.bind(this), 30 * 1000);
+    this.intervalId = window.setInterval(this.sendMetricsInQueue.bind(this), 30 * 1000);
     this.meetingId = meetingId;
     this.webex = webex;
     this.correlationId = correlationId;
     // Send the first set of metrics at 5 seconds in the case of a user leaving the call shortly after joining.
-    setTimeout(this.checkMetrics.bind(this), 5 * 1000);
+    setTimeout(this.sendMetricsInQueue.bind(this), 5 * 1000);
   }
 
   /**
@@ -39,7 +39,7 @@ export default class RtcMetrics {
    *
    * @returns {void}
    */
-  private checkMetrics() {
+  public sendMetricsInQueue() {
     if (this.metricsQueue.length) {
       this.sendMetrics();
       this.metricsQueue = [];
@@ -65,7 +65,7 @@ export default class RtcMetrics {
    * @returns {void}
    */
   closeMetrics() {
-    this.checkMetrics();
+    this.sendMetricsInQueue();
     clearInterval(this.intervalId);
   }
 

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

@@ -1186,6 +1186,7 @@ describe('plugin-meetings', () => {
 
         it('should send metrics and reset the statsAnalyzer to null if addMedia throws an error', async () => {
           meeting.meetingState = 'ACTIVE';
+          
           meeting.webex.meetings.reachability = {
             getReachabilityMetrics: sinon.stub().resolves({
               someReachabilityMetric1: 'some value1',
@@ -1193,15 +1194,20 @@ describe('plugin-meetings', () => {
             }),
           };
 
+          const forceRtcMetricsSend = sinon.stub().resolves();
+
           // setup the mock to return an incomplete object - this will cause addMedia to fail
           // because some methods (like on() or initiateOffer()) are missing
           Media.createMediaConnection = sinon.stub().returns({
             close: sinon.stub(),
+            forceRtcMetricsSend,
           });
           // set a statsAnalyzer on the meeting so that we can check that it gets reset to null
           meeting.statsAnalyzer = {stopAnalyzer: sinon.stub().resolves()};
           const error = await assert.isRejected(meeting.addMedia());
 
+          assert.calledOnce(forceRtcMetricsSend);
+
           assert.isNull(meeting.statsAnalyzer);
           assert(webex.internal.newMetrics.submitInternalEvent.calledTwice);
           assert.calledWith(webex.internal.newMetrics.submitInternalEvent.firstCall, {

package/test/unit/spec/rtcMetrics/index.ts

@@ -33,6 +33,11 @@ describe('RtcMetrics', () => {
     assert.calledWithMatch(webex.request, sinon.match.hasNested('body.metrics[0].correlationId', 'mock-correlation-id'));
   });
 
+  it('should have a defined sendMetricsInQueue function which is public', () => {
+    assert.isDefined(metrics.sendMetricsInQueue);
+    assert.isFunction(metrics.sendMetricsInQueue);
+  });
+
   it('should send metrics requests over time', () => {
     assert.notCalled(webex.request);
 
@@ -48,11 +53,11 @@ describe('RtcMetrics', () => {
     assert.notCalled(webex.request);
   });
 
-  it('checkMetrics should send metrics if any exist in the queue', () => {
+  it('sendMetricsInQueue should send metrics if any exist in the queue', () => {
     assert.notCalled(webex.request);
 
     metrics.addMetrics(FAKE_METRICS_ITEM);
-    (metrics as any).checkMetrics();
+    (metrics as any).sendMetricsInQueue();
 
     assert.callCount(webex.request, 1);
   });