@webex/internal-plugin-metrics 3.7.0-next.1 → 3.7.0-next.11

package/dist/types/generic-metrics.d.ts

@@ -17,7 +17,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
      */
     constructor(...args: any[]);
     /**
-     * Submit a buisness metric to our metrics endpoint.
+     * Submit a business metric to our metrics endpoint.
      * @param {string} kind of metric for logging
      * @param {string} name of the metric
      * @param {object} event
@@ -44,7 +44,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
      */
     protected getBrowserDetails(): object;
     /**
-     * Returns true once we have the deviceId we need to submit behavioral/operational/buisness events
+     * Returns true once we have the deviceId we need to submit behavioral/operational/business events
      * @returns {boolean}
      */
     isReadyToSubmitEvents(): boolean;

package/dist/types/metrics.types.d.ts

@@ -11,6 +11,7 @@ export type MetricEventProduct = 'webex' | 'wxcc_desktop';
 export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
 export type MetricEventVerb = 'abort' | 'accept' | 'activate' | 'apply' | 'answer' | 'authorize' | 'build' | 'cancel' | 'change' | 'click' | 'close' | 'complete' | 'connect' | 'create' | 'deactivate' | 'decrypt' | 'delete' | 'deliver' | 'destroy' | 'disable' | 'disconnect' | 'dismiss' | 'display' | 'download' | 'edit' | 'enable' | 'encrypt' | 'end' | 'expire' | 'fail' | 'fetch' | 'fire' | 'generate' | 'get' | 'hide' | 'hover' | 'ignore' | 'initialize' | 'initiate' | 'invalidate' | 'join' | 'list' | 'load' | 'login' | 'logout' | 'notify' | 'offer' | 'open' | 'press' | 'receive' | 'refer' | 'refresh' | 'register' | 'release' | 'reload' | 'reject' | 'request' | 'reset' | 'resize' | 'respond' | 'retry' | 'revoke' | 'save' | 'search' | 'select' | 'send' | 'set' | 'sign' | 'start' | 'submit' | 'switch' | 'sync' | 'toggle' | 'transfer' | 'unregister' | 'update' | 'upload' | 'use' | 'validate' | 'view' | 'visit' | 'wait' | 'warn' | 'exit';
 export type MetricEventJoinFlowVersion = 'Other' | 'NewFTE';
+export type MetricEventMeetingJoinPhase = 'pre-join' | 'join' | 'in-meeting';
 export type SubmitClientEventOptions = {
     meetingId?: string;
     mediaConnections?: any[];
@@ -25,6 +26,8 @@ export type SubmitClientEventOptions = {
     webexConferenceIdStr?: string;
     globalMeetingId?: string;
     joinFlowVersion?: MetricEventJoinFlowVersion;
+    meetingJoinPhase?: MetricEventMeetingJoinPhase;
+    triggeredTime?: string;
 };
 export type SubmitMQEOptions = {
     meetingId: string;

package/dist/types/new-metrics.d.ts

@@ -60,7 +60,7 @@ declare class Metrics extends WebexPlugin {
      */
     isReadyToSubmitOperationalEvents(): boolean;
     /**
-     * @returns true once we have the deviceId we need to submit buisness events
+     * @returns true once we have the deviceId we need to submit business events
      */
     isReadyToSubmitBusinessEvents(): boolean;
     /**
@@ -83,13 +83,14 @@ declare class Metrics extends WebexPlugin {
         payload?: EventPayload;
     }): void | Promise<void>;
     /**
-     * Buisness event
+     * Business event
      * @param args
      */
-    submitBusinessEvent({ name, payload, table, }: {
+    submitBusinessEvent({ name, payload, table, metadata, }: {
         name: string;
         payload: EventPayload;
         table?: Table;
+        metadata?: EventPayload;
     }): Promise<void>;
     /**
      * Call Analyzer: Media Quality Event

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.7.0-next.1",
-    "@webex/test-helper-mocha": "3.7.0-next.1",
-    "@webex/test-helper-mock-webex": "3.7.0-next.1",
-    "@webex/test-helper-test-users": "3.7.0-next.1",
+    "@webex/test-helper-chai": "3.7.0-next.11",
+    "@webex/test-helper-mocha": "3.7.0-next.11",
+    "@webex/test-helper-mock-webex": "3.7.0-next.11",
+    "@webex/test-helper-test-users": "3.7.0-next.11",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.7.0-next.1",
-    "@webex/common-timers": "3.7.0-next.1",
-    "@webex/event-dictionary-ts": "^1.0.1594",
-    "@webex/internal-plugin-metrics": "3.7.0-next.1",
-    "@webex/test-helper-chai": "3.7.0-next.1",
-    "@webex/test-helper-mock-webex": "3.7.0-next.1",
-    "@webex/webex-core": "3.7.0-next.1",
+    "@webex/common": "3.7.0-next.11",
+    "@webex/common-timers": "3.7.0-next.11",
+    "@webex/event-dictionary-ts": "^1.0.1643",
+    "@webex/internal-plugin-metrics": "3.7.0-next.11",
+    "@webex/test-helper-chai": "3.7.0-next.11",
+    "@webex/test-helper-mock-webex": "3.7.0-next.11",
+    "@webex/webex-core": "3.7.0-next.11",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.7.0-next.1"
+  "version": "3.7.0-next.11"
 }

package/src/business-metrics.ts

@@ -2,121 +2,111 @@ import GenericMetrics from './generic-metrics';
 import {EventPayload, Table} from './metrics.types';
 
 /**
- * @description Util class to handle Buisness Metrics
+ * @description Util class to handle Business Metrics
  * @export
  * @class BusinessMetrics
  */
 export default class BusinessMetrics extends GenericMetrics {
   /**
-   * unfortunately, the pinot team does not allow changes to the schema of wbxapp_callend_metrics
-   * so we have to shim this layer specifically for this
-   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table+wbxapp_callend_metrics
-   * @param {EventPayload} payload payload of the metric
-   * @returns {Promise<any>}
-   */
-  private submitCallEndEvent({payload}: {payload: EventPayload}) {
-    const event = {
-      type: ['business'],
-      eventPayload: {
-        key: 'callEnd',
-        client_timestamp: new Date().toISOString(),
-        appType: 'Web Client',
-        value: {
-          ...payload,
-        },
-      },
-    };
-
-    return this.submitEvent({
-      kind: 'buisness-events:wbxapp_callend_metrics -> ',
-      name: 'wbxapp_callend_metrics',
-      event,
-    });
-  }
-
-  /**
-   * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
-   * all event payload keys are converted into a hex string value
-   * unfortunately, the pinot team does not allow changes to the schema of business_metrics
-   * so we have to shim this layer specifically for this
-   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table%3A+business_metrics
+   * Build the metric event to submit.
    * @param {string} name of the metric
-   * @param {EventPayload} payload payload of the metric
-   * @returns {Promise<any>}
-   */
-  private submitBusinessMetricsEvent({name, payload}: {name: string; payload: EventPayload}) {
-    const event = {
-      type: ['business'],
-      eventPayload: {
-        key: name,
-        client_timestamp: new Date().toISOString(),
-        appType: 'Web Client',
-        value: {
-          ...this.getContext(),
-          ...this.getBrowserDetails(),
-          ...payload,
-        },
-      },
-    };
-
-    return this.submitEvent({kind: 'buisness-events:business_metrics -> ', name, event});
-  }
-
-  /**
-   * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
-   * all event payload keys are converted into a hex string value
-   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
-   * @param {string} name of the metric
-   * @param {EventPayload} user payload of the metric
-   * @returns {Promise<any>}
+   * @param {EventPayload} payload user payload of the metric
+   * @param {EventPayload} metadata to include outside of eventPayload.value
+   * @returns {MetricEvent} The constructed metric event
    */
-  private submitDefaultEvent({name, payload}: {name: string; payload: EventPayload}) {
-    const event = {
+  private buildEvent({name, payload, metadata}: {name: string; payload: object; metadata: object}) {
+    return {
       type: ['business'],
       eventPayload: {
         key: name,
-        appType: 'Web Client',
         client_timestamp: new Date().toISOString(),
-        context: this.getContext(),
-        browserDetails: this.getBrowserDetails(),
+        ...metadata,
         value: payload,
       },
     };
-
-    return this.submitEvent({kind: 'buisness-events:default -> ', name, event});
   }
 
   /**
-   * Submit a buisness metric to our metrics endpoint.
+   * Submit a business metric to our metrics endpoint.
    * routes to the correct table with the correct schema payload by table
    * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
    * @param {string} name of the metric, ignored if going to wbxapp_callend_metrics
    * @param {EventPayload} payload user payload of the metric
    * @param {Table} table optional - to submit the metric to and adapt the sent schema
+   * @param {EventPayload} metadata optional - to include outside of eventPayload.value
    * @returns {Promise<any>}
    */
   public submitBusinessEvent({
     name,
     payload,
     table,
+    metadata,
   }: {
     name: string;
     payload: EventPayload;
     table?: Table;
+    metadata?: EventPayload;
   }): Promise<void> {
     if (!table) {
       table = 'default';
     }
+    if (!metadata) {
+      metadata = {};
+    }
+    if (!metadata.appType) {
+      metadata.appType = 'Web Client';
+    }
     switch (table) {
-      case 'wbxapp_callend_metrics':
-        return this.submitCallEndEvent({payload});
-      case 'business_metrics':
-        return this.submitBusinessMetricsEvent({name, payload});
+      case 'wbxapp_callend_metrics': {
+        // https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table+wbxapp_callend_metrics
+        const callEndEvent = this.buildEvent({name: 'callEnd', payload, metadata});
+
+        return this.submitEvent({
+          kind: 'business-events:wbxapp_callend_metrics -> ',
+          name: 'wbxapp_callend_metrics',
+          event: callEndEvent,
+        });
+      }
+
+      case 'business_metrics': {
+        // all event payload keys are converted into a hex string value
+        // unfortunately, the pinot team does not allow changes to the schema of business_metrics
+        // so we have to shim this layer specifically for this
+        // https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table%3A+business_metrics
+        const businessEvent = this.buildEvent({
+          name,
+          payload: {
+            ...this.getContext(),
+            ...this.getBrowserDetails(),
+            ...payload,
+          },
+          metadata,
+        });
+
+        return this.submitEvent({
+          kind: 'business-events:business_metrics -> ',
+          name,
+          event: businessEvent,
+        });
+      }
+
       case 'business_ucf':
-        return this.submitDefaultEvent({name, payload});
       case 'default':
-      default:
-        return this.submitDefaultEvent({name, payload});
+      default: {
+        // all event payload keys are converted into a hex string value
+        // https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+        const defaultEvent = this.buildEvent({
+          name,
+          payload,
+          metadata: {
+            context: this.getContext(),
+            browserDetails: this.getBrowserDetails(),
+            ...metadata,
+          },
+        });
+
+        return this.submitEvent({kind: 'business-events:default -> ', name, event: defaultEvent});
+      }
     }
   }
 }

package/src/call-diagnostic/call-diagnostic-metrics-latencies.ts

@@ -83,11 +83,16 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
       key === 'client.media.rx.start' ||
       key === 'client.media.tx.start' ||
       key === 'internal.client.meetinginfo.request' ||
-      key === 'internal.client.meetinginfo.response'
+      key === 'internal.client.meetinginfo.response' ||
+      key === 'client.media-engine.remote-sdp-received'
     ) {
       this.saveFirstTimestampOnly(key, value);
     } else {
       this.latencyTimestamps.set(key, value);
+      // new offer/answer so reset the remote SDP timestamp
+      if (key === 'client.media-engine.local-sdp-generated') {
+        this.latencyTimestamps.delete('client.media-engine.remote-sdp-received');
+      }
     }
   }
 

package/src/call-diagnostic/call-diagnostic-metrics.ts

@@ -377,7 +377,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
    * @returns
    */
   prepareDiagnosticEvent(eventData: Event['event'], options: any) {
-    const {meetingId} = options;
+    const {meetingId, triggeredTime} = options;
     const origin = this.getOrigin(options, meetingId);
 
     const event: Event = {
@@ -385,7 +385,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       version: 1,
       origin,
       originTime: {
-        triggered: new Date().toISOString(),
+        triggered: triggeredTime || new Date().toISOString(),
         // is overridden in prepareRequest batcher
         sent: 'not_defined_yet',
       },
@@ -723,6 +723,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       clientEventObject.joinFlowVersion = joinFlowVersion;
     }
 
+    if (options.meetingJoinPhase) {
+      clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
+    }
+
     return clientEventObject;
   }
 
@@ -770,6 +774,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       clientEventObject.joinFlowVersion = options.joinFlowVersion;
     }
 
+    if (options.meetingJoinPhase) {
+      clientEventObject.meetingJoinPhase = options.meetingJoinPhase;
+    }
+
     return clientEventObject;
   }
 

package/src/call-diagnostic/config.ts

@@ -17,6 +17,7 @@ export const DTLS_HANDSHAKE_FAILED_CLIENT_CODE = 2008;
 export const ICE_FAILED_WITH_TURN_TLS_CLIENT_CODE = 2010;
 export const ICE_FAILED_WITHOUT_TURN_TLS_CLIENT_CODE = 2009;
 export const ICE_AND_REACHABILITY_FAILED_CLIENT_CODE = 2011;
+export const MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE = 2012;
 export const WBX_APP_API_URL = 'wbxappapi'; // MeetingInfo WebexAppApi response object normally contains a body.url that includes the string 'wbxappapi'
 
 export const WEBEX_SUB_SERVICE_TYPES: Record<string, ClientSubServiceType> = {
@@ -127,6 +128,7 @@ export const ERROR_DESCRIPTIONS = {
   ICE_FAILED_WITHOUT_TURN_TLS: 'ICEFailedWithoutTURN_TLS',
   ICE_FAILED_WITH_TURN_TLS: 'ICEFailedWithTURN_TLS',
   ICE_AND_REACHABILITY_FAILED: 'ICEAndReachabilityFailed',
+  MULTISTREAM_NOT_AVAILABLE: 'MultistreamNotAvailable',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
   WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
@@ -409,6 +411,11 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  [MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE]: {
+    errorDescription: ERROR_DESCRIPTIONS.MULTISTREAM_NOT_AVAILABLE,
+    category: 'expected',
+    fatal: false,
+  },
   2050: {
     errorDescription: ERROR_DESCRIPTIONS.SDP_OFFER_CREATION_ERROR,
     category: 'media',

package/src/generic-metrics.ts

@@ -37,7 +37,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   }
 
   /**
-   * Submit a buisness metric to our metrics endpoint.
+   * Submit a business metric to our metrics endpoint.
    * @param {string} kind of metric for logging
    * @param {string} name of the metric
    * @param {object} event
@@ -105,7 +105,7 @@ export default abstract class GenericMetrics extends StatelessWebexPlugin {
   }
 
   /**
-   * Returns true once we have the deviceId we need to submit behavioral/operational/buisness events
+   * Returns true once we have the deviceId we need to submit behavioral/operational/business events
    * @returns {boolean}
    */
   public isReadyToSubmitEvents(): boolean {

package/src/metrics.types.ts

@@ -111,6 +111,7 @@ export type MetricEventVerb =
   | 'exit';
 
 export type MetricEventJoinFlowVersion = 'Other' | 'NewFTE';
+export type MetricEventMeetingJoinPhase = 'pre-join' | 'join' | 'in-meeting';
 
 export type SubmitClientEventOptions = {
   meetingId?: string;
@@ -126,6 +127,8 @@ export type SubmitClientEventOptions = {
   webexConferenceIdStr?: string;
   globalMeetingId?: string;
   joinFlowVersion?: MetricEventJoinFlowVersion;
+  meetingJoinPhase?: MetricEventMeetingJoinPhase;
+  triggeredTime?: string;
 };
 
 export type SubmitMQEOptions = {

package/src/new-metrics.ts

@@ -141,7 +141,7 @@ class Metrics extends WebexPlugin {
   }
 
   /**
-   * @returns true once we have the deviceId we need to submit buisness events
+   * @returns true once we have the deviceId we need to submit business events
    */
   isReadyToSubmitBusinessEvents() {
     this.lazyBuildBusinessMetrics();
@@ -200,17 +200,19 @@ class Metrics extends WebexPlugin {
   }
 
   /**
-   * Buisness event
+   * Business event
    * @param args
    */
   submitBusinessEvent({
     name,
     payload,
     table,
+    metadata,
   }: {
     name: string;
     payload: EventPayload;
     table?: Table;
+    metadata?: EventPayload;
   }) {
     if (!this.isReady) {
       // @ts-ignore
@@ -223,7 +225,7 @@ class Metrics extends WebexPlugin {
 
     this.lazyBuildBusinessMetrics();
 
-    return this.businessMetrics.submitBusinessEvent({name, payload, table});
+    return this.businessMetrics.submitBusinessEvent({name, payload, table, metadata});
   }
 
   /**

package/test/unit/spec/business/business-metrics.ts

@@ -154,11 +154,12 @@ describe('internal-plugin-metrics', () => {
           businessMetrics.clientMetricsBatcher.request = request;
           
           assert.equal(requestCalls.length, 0)
-          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'business_metrics' })
+          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar: "gee"}, table: 'business_metrics', metadata: {asdf: 'hjkl'} })
           assert.equal(requestCalls.length, 1)
           assert.deepEqual(requestCalls[0], {
             eventPayload: {
               key: 'foobar',
+              asdf: 'hjkl',
               appType: 'Web Client',
               client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
               value: {
@@ -173,7 +174,6 @@ describe('internal-plugin-metrics', () => {
                 os: getOSNameInternal(),
                 app: {version: 'webex-version'},
                 device: {id: 'deviceId'},
-                locale: 'language',
               }
             },
             type: ['business'],

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics-latencies.ts

@@ -283,6 +283,18 @@ describe('internal-plugin-metrics', () => {
         cdl.saveTimestamp({key: 'internal.client.meetinginfo.response', value: 20});
         assert.deepEqual(saveFirstTimestamp.callCount, 1);
       });
+
+      it('calls saveFirstTimestamp for remote SDP received', () => {
+        const saveFirstTimestamp = sinon.stub(cdl, 'saveFirstTimestampOnly');
+        cdl.saveTimestamp({key: 'client.media-engine.remote-sdp-received', value: 10});
+        assert.deepEqual(saveFirstTimestamp.callCount, 1);
+      });
+
+      it('clears timestamp for remote SDP received when local SDP generated', () => {
+        cdl.saveTimestamp({key: 'client.media-engine.remote-sdp-received', value: 10});
+        cdl.saveTimestamp({key: 'client.media-engine.local-sdp-generated', value: 20});
+        assert.isUndefined(cdl.latencyTimestamps.get('client.media-engine.remote-sdp-received'));
+      });
     });
 
     it('calculates getShowInterstitialTime correctly', () => {

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics.ts

@@ -745,6 +745,52 @@ describe('internal-plugin-metrics', () => {
       });
     });
 
+    it('should prepare diagnostic event successfully when triggeredTime is supplied in the options object', () => {
+      const options = {meetingId: fakeMeeting.id, triggeredTime: 'fake-triggered-time'};
+      const getOriginStub = sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
+      const clearEmptyKeysRecursivelyStub = sinon.stub(
+        CallDiagnosticUtils,
+        'clearEmptyKeysRecursively'
+      );
+
+      const res = cd.prepareDiagnosticEvent(
+        {
+          canProceed: false,
+          identifiers: {
+            correlationId: 'id',
+            webexConferenceIdStr: 'webexConferenceIdStr1',
+            globalMeetingId: 'globalMeetingId1',
+          },
+          name: 'client.alert.displayed',
+        },
+        options
+      );
+
+      assert.calledWith(getOriginStub, options, options.meetingId);
+      assert.calledOnce(clearEmptyKeysRecursivelyStub);
+      assert.deepEqual(res, {
+        event: {
+          canProceed: false,
+          identifiers: {
+            correlationId: 'id',
+            webexConferenceIdStr: 'webexConferenceIdStr1',
+            globalMeetingId: 'globalMeetingId1',
+          },
+          name: 'client.alert.displayed',
+        },
+        eventId: 'my-fake-id',
+        origin: {
+          origin: 'fake-origin',
+        },
+        originTime: {
+          sent: 'not_defined_yet',
+          triggered: 'fake-triggered-time',
+        },
+        senderCountryCode: 'UK',
+        version: 1,
+      });
+    });
+
     describe('#submitClientEvent', () => {
       it('should submit client event successfully with meetingId', () => {
         const prepareDiagnosticEventSpy = sinon.spy(cd, 'prepareDiagnosticEvent');
@@ -2759,11 +2805,12 @@ describe('internal-plugin-metrics', () => {
         });
       });
 
-      it('includes expected joinFlowVersion from options when in-meeting', async () => {
+      it('includes expected joinFlowVersion and meetingJoinPhase from options when in-meeting', async () => {
         // meetingId means in-meeting
         const options = {
           meetingId: fakeMeeting.id,
           joinFlowVersion: 'NewFTE',
+          meetingJoinPhase: 'join',
         };
 
         const triggered = new Date();
@@ -2777,6 +2824,11 @@ describe('internal-plugin-metrics', () => {
           fetchOptions.body.metrics[0].eventPayload.event.joinFlowVersion,
           options.joinFlowVersion
         );
+
+        assert.equal(
+          fetchOptions.body.metrics[0].eventPayload.event.meetingJoinPhase,
+          options.meetingJoinPhase
+        );
       });
 
       it('includes expected joinFlowVersion from meeting callStateForMetrics when in-meeting', async () => {
@@ -2815,12 +2867,13 @@ describe('internal-plugin-metrics', () => {
         );
       });
 
-      it('includes expected joinFlowVersion from options during prejoin', async () => {
+      it('includes expected joinFlowVersion and meetingJoinPhase from options during prejoin', async () => {
         // correlationId and no meeting id means prejoin
         const options = {
           correlationId: 'myCorrelationId',
           preLoginId: 'myPreLoginId',
           joinFlowVersion: 'NewFTE',
+          meetingJoinPhase: 'pre-join',
         };
 
         const triggered = new Date();
@@ -2834,6 +2887,11 @@ describe('internal-plugin-metrics', () => {
           fetchOptions.body.metrics[0].eventPayload.event.joinFlowVersion,
           options.joinFlowVersion
         );
+
+        assert.equal(
+          fetchOptions.body.metrics[0].eventPayload.event.meetingJoinPhase,
+          options.meetingJoinPhase
+        );
       });
     });
 

package/test/unit/spec/new-metrics.ts

@@ -93,12 +93,14 @@ describe('internal-plugin-metrics', () => {
         name: 'foobar',
         payload: {},
         table: 'test',
+        metadata: { foo: 'bar' },
       });
 
       assert.calledWith(webex.internal.newMetrics.businessMetrics.submitBusinessEvent, {
         name: 'foobar',
         payload: {},
         table: 'test',
+        metadata: { foo: 'bar' },
       });
     });