feat(internal-plugin-metrics): allow caller to specify metadata of business metric events

packages/@webex/internal-plugin-metrics/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});
+      }
     }
   }
 }

packages/@webex/internal-plugin-metrics/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 {

packages/@webex/internal-plugin-metrics/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});
   }
 
   /**

packages/@webex/internal-plugin-metrics/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'],

packages/@webex/internal-plugin-metrics/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' },
       });
     });