@webex/internal-plugin-metrics 3.5.0-next.9 → 3.5.0-wxcc.1

package/src/business-metrics.ts

@@ -1,5 +1,5 @@
 import GenericMetrics from './generic-metrics';
-import {EventPayload, Table} from './metrics.types';
+import {EventPayload} from './metrics.types';
 
 /**
  * @description Util class to handle Buisness Metrics
@@ -8,71 +8,16 @@ import {EventPayload, Table} from './metrics.types';
  */
 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
-   * @param {EventPayload} payload payload of the metric
-   * @returns {Promise<any>}
-   */
-  private submitCallEndEvent({payload}: {payload: EventPayload}) {
-    const event = {
-      type: ['business'],
-      eventPayload: {
-        key: 'callEnd',
-        client_timestamp: Date.now(),
-        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
-   * @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: Date.now(),
-        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
+   * Submit a buisness metric to our metrics endpoint.
    * @param {string} name of the metric
    * @param {EventPayload} user payload of the metric
    * @returns {Promise<any>}
    */
-  private submitDefaultEvent({name, payload}: {name: string; payload: EventPayload}) {
+  public submitBusinessEvent({name, payload}: {name: string; payload: EventPayload}) {
     const event = {
       type: ['business'],
       eventPayload: {
         key: name,
-        appType: 'Web Client',
         client_timestamp: Date.now(),
         context: this.getContext(),
         browserDetails: this.getBrowserDetails(),
@@ -80,39 +25,6 @@ export default class BusinessMetrics extends GenericMetrics {
       },
     };
 
-    return this.submitEvent({kind: 'buisness-events:default -> ', name, event});
-  }
-
-  /**
-   * Submit a buisness metric to our metrics endpoint.
-   * routes to the correct table with the correct schema payload by table
-   * @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
-   * @returns {Promise<any>}
-   */
-  public submitBusinessEvent({
-    name,
-    payload,
-    table,
-  }: {
-    name: string;
-    payload: EventPayload;
-    table?: Table;
-  }): Promise<void> {
-    if (!table) {
-      table = 'default';
-    }
-    switch (table) {
-      case 'wbxapp_callend_metrics':
-        return this.submitCallEndEvent({payload});
-      case 'business_metrics':
-        return this.submitBusinessMetricsEvent({name, payload});
-      case 'business_ucf':
-        return this.submitDefaultEvent({name, payload});
-      case 'default':
-      default:
-        return this.submitDefaultEvent({name, payload});
-    }
+    this.submitEvent({kind: 'buisness-events -> ', name, event});
   }
 }

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

@@ -49,7 +49,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   private getMeeting() {
     if (this.meetingId) {
       // @ts-ignore
-      return this.webex.meetings.getBasicMeetingInformation(this.meetingId);
+      return this.webex.meetings.meetingCollection.get(this.meetingId);
     }
 
     return undefined;

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

@@ -139,7 +139,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   getIsConvergedArchitectureEnabled({meetingId}: {meetingId?: string}): boolean {
     if (meetingId) {
       // @ts-ignore
-      const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+      const meeting = this.webex.meetings.meetingCollection.get(meetingId);
 
       return meeting?.meetingInfo?.enableConvergedArchitecture;
     }
@@ -245,7 +245,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
       if (meetingId) {
         // @ts-ignore
-        const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+        const meeting = this.webex.meetings.meetingCollection.get(meetingId);
         if (meeting?.environment) {
           origin.environment = meeting.environment;
         }
@@ -289,14 +289,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       sessionCorrelationId,
     } = options;
     const identifiers: Event['event']['identifiers'] = {
-      correlationId: 'unknown', // concerned with setting this to unknown. This will fail diagnostic events parsing because it's not a uuid pattern
+      correlationId: 'unknown',
     };
 
     if (meeting) {
       identifiers.correlationId = meeting.correlationId;
-      if (meeting.sessionCorrelationId) {
-        identifiers.sessionCorrelationId = meeting.sessionCorrelationId;
-      }
     }
 
     if (sessionCorrelationId) {
@@ -307,8 +304,6 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       identifiers.correlationId = correlationId;
     }
 
-    // TODO: should we use patterns.uuid to validate correlationId and session correlation id? they will fail the diagnostic events validation pipeline if improperly formatted
-
     if (this.device) {
       const {device} = this;
       const {installationId} = device?.config || {};
@@ -430,7 +425,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     // events that will most likely happen in join phase
     if (meetingId) {
       // @ts-ignore
-      const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+      const meeting = this.webex.meetings.meetingCollection.get(meetingId);
 
       if (!meeting) {
         console.warn(
@@ -631,11 +626,10 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       });
     }
 
-    // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
+    // otherwise return unkown error
     return this.getErrorPayloadForClientErrorCode({
       clientErrorCode: UNKNOWN_ERROR,
-      serviceErrorCode: serviceErrorCode || UNKNOWN_ERROR,
-      serviceErrorName: rawError?.name,
+      serviceErrorCode: UNKNOWN_ERROR,
       payloadOverrides: rawError.payloadOverrides,
       rawErrorMessage,
       httpStatusCode,
@@ -667,7 +661,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     } = options;
 
     // @ts-ignore
-    const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
+    const meeting = this.webex.meetings.meetingCollection.get(meetingId);
 
     if (!meeting) {
       console.warn(

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

@@ -231,19 +231,13 @@ export const getBuildType = (
  * @returns {Object} prepared item
  */
 export const prepareDiagnosticMetricItem = (webex: any, item: any) => {
-  const buildType = getBuildType(
-    webex,
-    item.eventPayload?.event?.eventData?.webClientDomain,
-    item.eventPayload?.event?.eventData?.markAsTestEvent
-  );
-
-  // Set upgradeChannel to 'gold' if buildType is 'prod', otherwise to the buildType value
-  const upgradeChannel = buildType === 'prod' ? 'gold' : buildType;
-
   const origin: Partial<Event['origin']> = {
-    buildType,
+    buildType: getBuildType(
+      webex,
+      item.eventPayload?.event?.eventData?.webClientDomain,
+      item.eventPayload?.event?.eventData?.markAsTestEvent
+    ),
     networkType: 'unknown',
-    upgradeChannel,
   };
 
   // check event names and append latencies?

package/src/call-diagnostic/config.ts

@@ -129,7 +129,6 @@ export const ERROR_DESCRIPTIONS = {
   ICE_AND_REACHABILITY_FAILED: 'ICEAndReachabilityFailed',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
-  WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
 };
 
 export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
@@ -289,12 +288,6 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   100005: 4103, // Depracated because of an issue in the UCF Clients
   // If both email-hash and domain-hash are null or undefined.
   100004: 4103,
-
-  // ---- WDM ----
-  // WDM_BLOCKED_ACCESS_BY_COUNTRY_CODE_BANNED_COUNTRY_ERROR_CODE
-  4404002: 13000,
-  // WDM_BLOCKED_ACCESS_BY_COUNTRY_CODE_RESTRICTED_COUNTRY_ERROR_CODE
-  4404003: 13000,
 };
 
 export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>> = {
@@ -694,11 +687,6 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
-  13000: {
-    errorDescription: ERROR_DESCRIPTIONS.WDM_RESTRICTED_REGION,
-    category: 'expected',
-    fatal: true,
-  },
 };
 
 export const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = 'js_sdk_call_diagnostic_event_failed_to_send';

package/src/index.ts

@@ -25,7 +25,6 @@ import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-l
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
-import RtcMetrics from './rtcMetrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -48,7 +47,6 @@ export {
   BehavioralMetrics,
   OperationalMetrics,
   BusinessMetrics,
-  RtcMetrics,
 };
 export type {
   ClientEvent,

package/src/metrics.types.ts

@@ -115,8 +115,6 @@ export interface DeviceContext {
 
 export type MetricType = 'behavioral' | 'operational' | 'business';
 
-export type Table = 'wbxapp_callend_metrics' | 'business_metrics' | 'business_ucf' | 'default';
-
 type InternalEventPayload = string | number | boolean;
 export type EventPayload = Record<string, InternalEventPayload>;
 export type BehavioralEventPayload = EventPayload; // for compatibilty, can be remove after wxcc-desktop did change their imports.

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

@@ -74,7 +74,7 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#sendEvent', () => {
-      it('should send correctly shaped business event (check name building and internal tagged event building) and default correctly', () => {
+      it('should send correctly shaped business event (check name building and internal tagged event building)', () => {
         // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
         const requestCalls = [];
         const request = function(arg) { requestCalls.push(arg) }
@@ -86,7 +86,6 @@ describe('internal-plugin-metrics', () => {
         assert.equal(requestCalls.length, 1)
         assert.deepEqual(requestCalls[0], {
           eventPayload: {
-            appType: 'Web Client',
             context: {
               app: {version: 'webex-version'},
               device: {id: 'deviceId'},
@@ -116,67 +115,6 @@ describe('internal-plugin-metrics', () => {
         });
         assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
       })
-
-      describe('when table is provided', () => {
-        it('should send correctly shaped business event with table: wbx_app_callend_metrics and ignore the key name', () => {
-          // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
-          const requestCalls = [];
-          const request = function(arg) { requestCalls.push(arg) }
-
-          businessMetrics.clientMetricsBatcher.request = request;
-          
-          assert.equal(requestCalls.length, 0)
-          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'wbxapp_callend_metrics' })
-          assert.equal(requestCalls.length, 1)
-          assert.deepEqual(requestCalls[0], {
-            eventPayload: {
-              key: 'callEnd',
-              client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
-              appType: 'Web Client',
-              value: {
-                bar: 'gee'
-              }
-            },
-            type: ['business'],
-          });
-          assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
-        });
-
-        it('should send correctly shaped business event with table: business_metrics', () => {
-          // For some reasons `jest` isn't available when testing form build server - so can't use `jest.fn()` here...
-          const requestCalls = [];
-          const request = function(arg) { requestCalls.push(arg) }
-
-          businessMetrics.clientMetricsBatcher.request = request;
-          
-          assert.equal(requestCalls.length, 0)
-          businessMetrics.submitBusinessEvent({ name: "foobar", payload: {bar:"gee"}, table: 'business_metrics' })
-          assert.equal(requestCalls.length, 1)
-          assert.deepEqual(requestCalls[0], {
-            eventPayload: {
-              key: 'foobar',
-              appType: 'Web Client',
-              client_timestamp: requestCalls[0].eventPayload.client_timestamp, // This is to bypass time check, which is checked below.
-              value: {
-                bar: "gee",
-                browser: getBrowserName(),
-                browserHeight: window.innerHeight,
-                browserVersion: getBrowserVersion(),
-                browserWidth: window.innerWidth,
-                domain: window.location.hostname,
-                inIframe: false,
-                locale: window.navigator.language,
-                os: getOSNameInternal(),
-                app: {version: 'webex-version'},
-                device: {id: 'deviceId'},
-                locale: 'language',
-              }
-            },
-            type: ['business'],
-          });
-          assert.isNumber(requestCalls[0].eventPayload.client_timestamp)
-        });
-      });
     })
   });
 });

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

@@ -441,7 +441,7 @@ describe('plugin-metrics', () => {
         // item also gets assigned a delay property but the key is a Symbol and haven't been able to test that..
         assert.deepEqual(calls.args[0].eventPayload, {
           event: 'my.event',
-          origin: {buildType: 'test', networkType: 'unknown', upgradeChannel: 'test'},
+          origin: {buildType: 'test', networkType: 'unknown'},
         });
 
         assert.deepEqual(calls.args[0].type, ['diagnostic-event']);
@@ -455,7 +455,6 @@ describe('plugin-metrics', () => {
           origin: {
             buildType: 'test',
             networkType: 'unknown',
-            upgradeChannel: 'test',
           },
         });
         assert.deepEqual(prepareDiagnosticMetricItemCalls[0].args[1].type, ['diagnostic-event']);

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

@@ -12,10 +12,12 @@ describe('internal-plugin-metrics', () => {
       sinon.useFakeTimers(now.getTime());
       const webex = {
         meetings: {
-          getBasicMeetingInformation: (id: string) => {
-            if (id === 'meeting-id') {
-              return {id: 'meeting-id', allowMediaInLobby: true};
-            }
+          meetingCollection: {
+            get: (id: string) => {
+              if (id === 'meeting-id') {
+                return {id: 'meeting-id', allowMediaInLobby: true};
+              }
+            },
           },
         },
       };