@webex/internal-plugin-metrics 3.0.0-beta.4 → 3.0.0-beta.41

package/dist/metrics.js.map

@@ -1 +1 @@
-{"version":3,"names":["BrowserDetection","getOSName","getOSVersion","getBrowserName","getBrowserVersion","getSparkUserAgent","webex","config","appName","appVersion","appPlatform","sparkUserAgent","CLIENT_NAME","Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","callDiagnosticEventsBatcher","CallDiagnosticEventsBatcher","namespace","submit","key","value","request","submitClientMetrics","eventName","props","preLoginId","Error","payload","metricName","tags","browser","os","domain","window","location","hostname","client_id","credentials","user_id","internal","device","userId","org_id","getOrgId","logger","info","fields","browser_version","os_version","sdk_version","version","platform","spark_user_agent","type","metrics","context","app","locale","name","eventPayload","timestamp","Date","valueOf","_payload","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","getClientToken","then","token","authorization","toString","submitCallDiagnosticEvents","event"],"sources":["metrics.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {BrowserDetection} from '@webex/common';\n\nimport {CLIENT_NAME} from './config';\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\nimport CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';\n\nconst {\n  getOSName,\n  getOSVersion,\n  getBrowserName,\n  getBrowserVersion\n} = BrowserDetection();\n\nfunction getSparkUserAgent(webex) {\n  const {\n    appName,\n    appVersion,\n    appPlatform\n  } = webex?.config ?? {};\n\n  let sparkUserAgent = CLIENT_NAME;\n\n  if (appName) {\n    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n  }\n\n  if (appPlatform) {\n    sparkUserAgent += ` ${appPlatform}`;\n  }\n\n  return sparkUserAgent;\n}\n\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher\n  },\n\n  namespace: 'Metrics',\n\n  submit(key, value) {\n    return this.batcher.request(Object.assign({key}, value));\n  },\n\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props = {}, preLoginId) {\n    if (!eventName) {\n      throw Error('Missing behavioral metric name. Please provide one');\n    }\n    const payload = {metricName: eventName};\n\n    payload.tags = {\n      ...props.tags,\n      browser: getBrowserName(),\n      os: getOSName(),\n\n      // Node does not like this so we need to check if it exists or not\n      // eslint-disable-next-line no-undef\n      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure\n      client_id: this.webex.credentials.config.client_id,\n      user_id: this.webex.internal.device.userId\n    };\n\n    try {\n      payload.tags.org_id = this.webex.credentials.getOrgId();\n    }\n    catch {\n      this.logger.info('metrics: unable to get orgId');\n    }\n\n\n    payload.fields = {\n      ...props.fields,\n      browser_version: getBrowserVersion(),\n      os_version: getOSVersion(),\n      sdk_version: this.webex.version,\n      platform: 'Web',\n      spark_user_agent: getSparkUserAgent(this.webex)\n    };\n\n\n    payload.type = props.type || this.webex.config.metrics.type;\n\n\n    payload.context = {\n      ...props.context,\n      app: {\n        version: this.webex.version\n      },\n      locale: 'en-US',\n      os: {\n        name: getOSName(),\n        version: getOSVersion()\n      }\n    };\n\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    // Mocking the time in tests when running in node\n    // is impossible so unable to use Date.now()\n    payload.timestamp = new Date().valueOf();\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload]\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId\n      },\n      body: {},\n      qs: {\n        alias: true\n      }\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId\n        },\n        body: payload\n      }));\n  },\n\n  submitCallDiagnosticEvents(payload) {\n    const event = {\n      type: 'diagnostic-event',\n      eventPayload: payload\n    };\n\n    return this.callDiagnosticEventsBatcher.request(event);\n  }\n});\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AAEA;;AACA;;AACA;;AACA;;;;;;AAEA,wBAKI,IAAAA,wBAAA,GALJ;AAAA,IACEC,SADF,qBACEA,SADF;AAAA,IAEEC,YAFF,qBAEEA,YAFF;AAAA,IAGEC,cAHF,qBAGEA,cAHF;AAAA,IAIEC,iBAJF,qBAIEA,iBAJF;;AAOA,SAASC,iBAAT,CAA2BC,KAA3B,EAAkC;EAAA;;EAChC,4BAIIA,KAJJ,aAIIA,KAJJ,uBAIIA,KAAK,CAAEC,MAJX,yDAIqB,EAJrB;EAAA,IACEC,OADF,QACEA,OADF;EAAA,IAEEC,UAFF,QAEEA,UAFF;EAAA,IAGEC,WAHF,QAGEA,WAHF;;EAMA,IAAIC,cAAc,GAAGC,mBAArB;;EAEA,IAAIJ,OAAJ,EAAa;IACXG,cAAc,eAAQH,OAAR,cAAmBC,UAAnB,aAAmBA,UAAnB,cAAmBA,UAAnB,GAAiC,KAAjC,CAAd;EACD;;EAED,IAAIC,WAAJ,EAAiB;IACfC,cAAc,eAAQD,WAAR,CAAd;EACD;;EAED,OAAOC,cAAP;AACD;;AAGD,IAAME,OAAO,GAAGC,sBAAA,CAAYC,MAAZ,CAAmB;EACjCC,QAAQ,EAAE;IACRC,OAAO,EAAEC,gBADD;IAERC,oBAAoB,EAAEC,6BAFd;IAGRC,2BAA2B,EAAEC;EAHrB,CADuB;EAOjCC,SAAS,EAAE,SAPsB;EASjCC,MATiC,kBAS1BC,GAT0B,EASrBC,KATqB,EASd;IACjB,OAAO,KAAKT,OAAL,CAAaU,OAAb,CAAqB,qBAAc;MAACF,GAAG,EAAHA;IAAD,CAAd,EAAqBC,KAArB,CAArB,CAAP;EACD,CAXgC;;EAcjC;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,mBArBiC,+BAqBbC,SArBa,EAqBsB;IAAA,IAAxBC,KAAwB,uEAAhB,EAAgB;IAAA,IAAZC,UAAY;;IACrD,IAAI,CAACF,SAAL,EAAgB;MACd,MAAMG,KAAK,CAAC,oDAAD,CAAX;IACD;;IACD,IAAMC,OAAO,GAAG;MAACC,UAAU,EAAEL;IAAb,CAAhB;IAEAI,OAAO,CAACE,IAAR,mCACKL,KAAK,CAACK,IADX;MAEEC,OAAO,EAAEjC,cAAc,EAFzB;MAGEkC,EAAE,EAAEpC,SAAS,EAHf;MAKE;MACA;MACAqC,MAAM,EAAE,OAAOC,MAAP,KAAkB,WAAlB,GAAgCA,MAAM,CAACC,QAAP,CAAgBC,QAAhB,IAA4B,aAA5D,GAA4E,aAPtF;MAOqG;MACnGC,SAAS,EAAE,KAAKpC,KAAL,CAAWqC,WAAX,CAAuBpC,MAAvB,CAA8BmC,SAR3C;MASEE,OAAO,EAAE,KAAKtC,KAAL,CAAWuC,QAAX,CAAoBC,MAApB,CAA2BC;IATtC;;IAYA,IAAI;MACFd,OAAO,CAACE,IAAR,CAAaa,MAAb,GAAsB,KAAK1C,KAAL,CAAWqC,WAAX,CAAuBM,QAAvB,EAAtB;IACD,CAFD,CAGA,gBAAM;MACJ,KAAKC,MAAL,CAAYC,IAAZ,CAAiB,8BAAjB;IACD;;IAGDlB,OAAO,CAACmB,MAAR,mCACKtB,KAAK,CAACsB,MADX;MAEEC,eAAe,EAAEjD,iBAAiB,EAFpC;MAGEkD,UAAU,EAAEpD,YAAY,EAH1B;MAIEqD,WAAW,EAAE,KAAKjD,KAAL,CAAWkD,OAJ1B;MAKEC,QAAQ,EAAE,KALZ;MAMEC,gBAAgB,EAAErD,iBAAiB,CAAC,KAAKC,KAAN;IANrC;IAUA2B,OAAO,CAAC0B,IAAR,GAAe7B,KAAK,CAAC6B,IAAN,IAAc,KAAKrD,KAAL,CAAWC,MAAX,CAAkBqD,OAAlB,CAA0BD,IAAvD;IAGA1B,OAAO,CAAC4B,OAAR,mCACK/B,KAAK,CAAC+B,OADX;MAEEC,GAAG,EAAE;QACHN,OAAO,EAAE,KAAKlD,KAAL,CAAWkD;MADjB,CAFP;MAKEO,MAAM,EAAE,OALV;MAME1B,EAAE,EAAE;QACF2B,IAAI,EAAE/D,SAAS,EADb;QAEFuD,OAAO,EAAEtD,YAAY;MAFnB;IANN;;IAaA,IAAI4B,KAAK,CAACmC,YAAV,EAAwB;MACtBhC,OAAO,CAACgC,YAAR,GAAuBnC,KAAK,CAACmC,YAA7B;IACD,CAtDoD,CAwDrD;IACA;;;IACAhC,OAAO,CAACiC,SAAR,GAAoB,IAAIC,IAAJ,GAAWC,OAAX,EAApB;;IAEA,IAAIrC,UAAJ,EAAgB;MACd,IAAMsC,QAAQ,GAAG;QACfT,OAAO,EAAE,CAAC3B,OAAD;MADM,CAAjB,CADc,CAKd;MACA;MACA;;MACA,OAAO,KAAKqC,kBAAL,CAAwBD,QAAxB,EAAkCtC,UAAlC,CAAP;IACD;;IAED,OAAO,KAAKZ,oBAAL,CAA0BQ,OAA1B,CAAkCM,OAAlC,CAAP;EACD,CA7FgC;;EA+FjC;AACF;AACA;AACA;AACA;EACEsC,SApGiC,qBAoGvBxC,UApGuB,EAoGX;IACpB,OAAO,KAAKJ,OAAL,CAAa;MAClB6C,MAAM,EAAE,MADU;MAElBC,GAAG,EAAE,SAFa;MAGlBC,QAAQ,EAAE,eAHQ;MAIlBC,OAAO,EAAE;QACP,qBAAqB5C;MADd,CAJS;MAOlB6C,IAAI,EAAE,EAPY;MAQlBC,EAAE,EAAE;QACFC,KAAK,EAAE;MADL;IARc,CAAb,CAAP;EAYD,CAjHgC;EAmHjCR,kBAnHiC,8BAmHdrC,OAnHc,EAmHLF,UAnHK,EAmHO;IAAA;;IACtC,OAAO,KAAKzB,KAAL,CAAWqC,WAAX,CAAuBoC,cAAvB,GAAwCC,IAAxC,CAA6C,UAACC,KAAD;MAAA,OAClD,KAAI,CAACtD,OAAL,CAAa;QACX6C,MAAM,EAAE,MADG;QAEXC,GAAG,EAAE,SAFM;QAGXC,QAAQ,EAAE,wBAHC;QAIXC,OAAO,EAAE;UACPO,aAAa,EAAED,KAAK,CAACE,QAAN,EADR;UAEP,qBAAqBpD;QAFd,CAJE;QAQX6C,IAAI,EAAE3C;MARK,CAAb,CADkD;IAAA,CAA7C,CAAP;EAWD,CA/HgC;EAiIjCmD,0BAjIiC,sCAiINnD,OAjIM,EAiIG;IAClC,IAAMoD,KAAK,GAAG;MACZ1B,IAAI,EAAE,kBADM;MAEZM,YAAY,EAAEhC;IAFF,CAAd;IAKA,OAAO,KAAKZ,2BAAL,CAAiCM,OAAjC,CAAyC0D,KAAzC,CAAP;EACD,CAxIgC;EAAA;AAAA,CAAnB,CAAhB;;eA2IexE,O"}
+{"version":3,"names":["BrowserDetection","getOSName","getOSVersion","getBrowserName","getBrowserVersion","getOSNameInternal","OSMap","OS_NAME","OTHERS","getSparkUserAgent","webex","config","appName","appVersion","appPlatform","sparkUserAgent","CLIENT_NAME","Metrics","WebexPlugin","extend","children","batcher","Batcher","clientMetricsBatcher","ClientMetricsBatcher","callDiagnosticEventsBatcher","CallDiagnosticEventsBatcher","namespace","submit","key","value","request","submitClientMetrics","eventName","props","preLoginId","Error","payload","metricName","tags","browser","os","domain","window","location","hostname","client_id","credentials","user_id","internal","device","userId","org_id","getOrgId","logger","info","fields","browser_version","os_version","sdk_version","version","platform","spark_user_agent","type","metrics","context","app","locale","name","eventPayload","timestamp","Date","valueOf","_payload","postPreLoginMetric","aliasUser","method","api","resource","headers","body","qs","alias","getClientToken","then","token","authorization","toString","submitCallDiagnosticEvents","event"],"sources":["metrics.js"],"sourcesContent":["/* eslint-disable default-param-last */\n\n/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {WebexPlugin} from '@webex/webex-core';\nimport {BrowserDetection} from '@webex/common';\nimport {OS_NAME, OSMap, CLIENT_NAME} from './config';\n\nimport Batcher from './batcher';\nimport ClientMetricsBatcher from './client-metrics-batcher';\nimport CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';\n\nconst {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();\n\nexport function getOSNameInternal() {\n  return OSMap[getOSName()] ?? OS_NAME.OTHERS;\n}\n\nfunction getSparkUserAgent(webex) {\n  const {appName, appVersion, appPlatform} = webex?.config ?? {};\n\n  let sparkUserAgent = CLIENT_NAME;\n\n  if (appName) {\n    sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n  }\n\n  if (appPlatform) {\n    sparkUserAgent += ` ${appPlatform}`;\n  }\n\n  return sparkUserAgent;\n}\n\nconst Metrics = WebexPlugin.extend({\n  children: {\n    batcher: Batcher,\n    clientMetricsBatcher: ClientMetricsBatcher,\n    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher,\n  },\n\n  namespace: 'Metrics',\n\n  submit(key, value) {\n    return this.batcher.request({key, ...value});\n  },\n\n  /**\n   * This corresponds to #sendSemiStructured() in the deprecated metrics handler\n   * @param {string} eventName\n   * @param {Object} props\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  submitClientMetrics(eventName, props = {}, preLoginId) {\n    if (!eventName) {\n      throw Error('Missing behavioral metric name. Please provide one');\n    }\n    const payload = {metricName: eventName};\n\n    payload.tags = {\n      ...props.tags,\n      browser: getBrowserName(),\n      os: getOSNameInternal(),\n\n      // Node does not like this so we need to check if it exists or not\n      // eslint-disable-next-line no-undef\n      domain:\n        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure\n      client_id: this.webex.credentials.config.client_id,\n      user_id: this.webex.internal.device.userId,\n    };\n\n    try {\n      payload.tags.org_id = this.webex.credentials.getOrgId();\n    } catch {\n      this.logger.info('metrics: unable to get orgId');\n    }\n\n    payload.fields = {\n      ...props.fields,\n      browser_version: getBrowserVersion(),\n      os_version: getOSVersion(),\n      sdk_version: this.webex.version,\n      platform: 'Web',\n      spark_user_agent: getSparkUserAgent(this.webex),\n    };\n\n    payload.type = props.type || this.webex.config.metrics.type;\n\n    payload.context = {\n      ...props.context,\n      app: {\n        version: this.webex.version,\n      },\n      locale: 'en-US',\n      os: {\n        name: getOSNameInternal(),\n        version: getOSVersion(),\n      },\n    };\n\n    if (props.eventPayload) {\n      payload.eventPayload = props.eventPayload;\n    }\n\n    // Mocking the time in tests when running in node\n    // is impossible so unable to use Date.now()\n    payload.timestamp = new Date().valueOf();\n\n    if (preLoginId) {\n      const _payload = {\n        metrics: [payload],\n      };\n\n      // Do not batch these because pre-login events occur during onboarding, so we will be partially blind\n      // to users' progress through the reg flow if we wait to persist pre-login metrics for people who drop off because\n      // their metrics will not post from a queue flush in time\n      return this.postPreLoginMetric(_payload, preLoginId);\n    }\n\n    return this.clientMetricsBatcher.request(payload);\n  },\n\n  /**\n   * Issue request to alias a user's pre-login ID with their CI UUID\n   * @param {string} preLoginId\n   * @returns {Object} HttpResponse object\n   */\n  aliasUser(preLoginId) {\n    return this.request({\n      method: 'POST',\n      api: 'metrics',\n      resource: 'clientmetrics',\n      headers: {\n        'x-prelogin-userid': preLoginId,\n      },\n      body: {},\n      qs: {\n        alias: true,\n      },\n    });\n  },\n\n  postPreLoginMetric(payload, preLoginId) {\n    return this.webex.credentials.getClientToken().then((token) =>\n      this.request({\n        method: 'POST',\n        api: 'metrics',\n        resource: 'clientmetrics-prelogin',\n        headers: {\n          authorization: token.toString(),\n          'x-prelogin-userid': preLoginId,\n        },\n        body: payload,\n      })\n    );\n  },\n\n  submitCallDiagnosticEvents(payload) {\n    const event = {\n      type: 'diagnostic-event',\n      eventPayload: payload,\n    };\n\n    return this.callDiagnosticEventsBatcher.request(event);\n  },\n});\n\nexport default Metrics;\n"],"mappings":";;;;;;;;;;;;;;;AAMA;AACA;AACA;AAEA;AACA;AACA;AAA2E;AAAA;AAE3E,wBAAqE,IAAAA,wBAAgB,GAAE;EAAhFC,SAAS,qBAATA,SAAS;EAAEC,YAAY,qBAAZA,YAAY;EAAEC,cAAc,qBAAdA,cAAc;EAAEC,iBAAiB,qBAAjBA,iBAAiB;AAE1D,SAASC,iBAAiB,GAAG;EAAA;EAClC,2BAAOC,aAAK,CAACL,SAAS,EAAE,CAAC,+DAAIM,eAAO,CAACC,MAAM;AAC7C;AAEA,SAASC,iBAAiB,CAACC,KAAK,EAAE;EAAA;EAChC,4BAA2CA,KAAK,aAALA,KAAK,uBAALA,KAAK,CAAEC,MAAM,yDAAI,CAAC,CAAC;IAAvDC,OAAO,QAAPA,OAAO;IAAEC,UAAU,QAAVA,UAAU;IAAEC,WAAW,QAAXA,WAAW;EAEvC,IAAIC,cAAc,GAAGC,mBAAW;EAEhC,IAAIJ,OAAO,EAAE;IACXG,cAAc,eAAQH,OAAO,cAAIC,UAAU,aAAVA,UAAU,cAAVA,UAAU,GAAI,KAAK,CAAE;EACxD;EAEA,IAAIC,WAAW,EAAE;IACfC,cAAc,eAAQD,WAAW,CAAE;EACrC;EAEA,OAAOC,cAAc;AACvB;AAEA,IAAME,OAAO,GAAGC,sBAAW,CAACC,MAAM,CAAC;EACjCC,QAAQ,EAAE;IACRC,OAAO,EAAEC,gBAAO;IAChBC,oBAAoB,EAAEC,6BAAoB;IAC1CC,2BAA2B,EAAEC;EAC/B,CAAC;EAEDC,SAAS,EAAE,SAAS;EAEpBC,MAAM,kBAACC,GAAG,EAAEC,KAAK,EAAE;IACjB,OAAO,IAAI,CAACT,OAAO,CAACU,OAAO;MAAEF,GAAG,EAAHA;IAAG,GAAKC,KAAK,EAAE;EAC9C,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,mBAAmB,+BAACC,SAAS,EAA0B;IAAA,IAAxBC,KAAK,uEAAG,CAAC,CAAC;IAAA,IAAEC,UAAU;IACnD,IAAI,CAACF,SAAS,EAAE;MACd,MAAMG,KAAK,CAAC,oDAAoD,CAAC;IACnE;IACA,IAAMC,OAAO,GAAG;MAACC,UAAU,EAAEL;IAAS,CAAC;IAEvCI,OAAO,CAACE,IAAI,mCACPL,KAAK,CAACK,IAAI;MACbC,OAAO,EAAErC,cAAc,EAAE;MACzBsC,EAAE,EAAEpC,iBAAiB,EAAE;MAEvB;MACA;MACAqC,MAAM,EACJ,OAAOC,MAAM,KAAK,WAAW,GAAGA,MAAM,CAACC,QAAQ,CAACC,QAAQ,IAAI,aAAa,GAAG,aAAa;MAAE;MAC7FC,SAAS,EAAE,IAAI,CAACpC,KAAK,CAACqC,WAAW,CAACpC,MAAM,CAACmC,SAAS;MAClDE,OAAO,EAAE,IAAI,CAACtC,KAAK,CAACuC,QAAQ,CAACC,MAAM,CAACC;IAAM,EAC3C;IAED,IAAI;MACFd,OAAO,CAACE,IAAI,CAACa,MAAM,GAAG,IAAI,CAAC1C,KAAK,CAACqC,WAAW,CAACM,QAAQ,EAAE;IACzD,CAAC,CAAC,gBAAM;MACN,IAAI,CAACC,MAAM,CAACC,IAAI,CAAC,8BAA8B,CAAC;IAClD;IAEAlB,OAAO,CAACmB,MAAM,mCACTtB,KAAK,CAACsB,MAAM;MACfC,eAAe,EAAErD,iBAAiB,EAAE;MACpCsD,UAAU,EAAExD,YAAY,EAAE;MAC1ByD,WAAW,EAAE,IAAI,CAACjD,KAAK,CAACkD,OAAO;MAC/BC,QAAQ,EAAE,KAAK;MACfC,gBAAgB,EAAErD,iBAAiB,CAAC,IAAI,CAACC,KAAK;IAAC,EAChD;IAED2B,OAAO,CAAC0B,IAAI,GAAG7B,KAAK,CAAC6B,IAAI,IAAI,IAAI,CAACrD,KAAK,CAACC,MAAM,CAACqD,OAAO,CAACD,IAAI;IAE3D1B,OAAO,CAAC4B,OAAO,mCACV/B,KAAK,CAAC+B,OAAO;MAChBC,GAAG,EAAE;QACHN,OAAO,EAAE,IAAI,CAAClD,KAAK,CAACkD;MACtB,CAAC;MACDO,MAAM,EAAE,OAAO;MACf1B,EAAE,EAAE;QACF2B,IAAI,EAAE/D,iBAAiB,EAAE;QACzBuD,OAAO,EAAE1D,YAAY;MACvB;IAAC,EACF;IAED,IAAIgC,KAAK,CAACmC,YAAY,EAAE;MACtBhC,OAAO,CAACgC,YAAY,GAAGnC,KAAK,CAACmC,YAAY;IAC3C;;IAEA;IACA;IACAhC,OAAO,CAACiC,SAAS,GAAG,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE;IAExC,IAAIrC,UAAU,EAAE;MACd,IAAMsC,QAAQ,GAAG;QACfT,OAAO,EAAE,CAAC3B,OAAO;MACnB,CAAC;;MAED;MACA;MACA;MACA,OAAO,IAAI,CAACqC,kBAAkB,CAACD,QAAQ,EAAEtC,UAAU,CAAC;IACtD;IAEA,OAAO,IAAI,CAACZ,oBAAoB,CAACQ,OAAO,CAACM,OAAO,CAAC;EACnD,CAAC;EAED;AACF;AACA;AACA;AACA;EACEsC,SAAS,qBAACxC,UAAU,EAAE;IACpB,OAAO,IAAI,CAACJ,OAAO,CAAC;MAClB6C,MAAM,EAAE,MAAM;MACdC,GAAG,EAAE,SAAS;MACdC,QAAQ,EAAE,eAAe;MACzBC,OAAO,EAAE;QACP,mBAAmB,EAAE5C;MACvB,CAAC;MACD6C,IAAI,EAAE,CAAC,CAAC;MACRC,EAAE,EAAE;QACFC,KAAK,EAAE;MACT;IACF,CAAC,CAAC;EACJ,CAAC;EAEDR,kBAAkB,8BAACrC,OAAO,EAAEF,UAAU,EAAE;IAAA;IACtC,OAAO,IAAI,CAACzB,KAAK,CAACqC,WAAW,CAACoC,cAAc,EAAE,CAACC,IAAI,CAAC,UAACC,KAAK;MAAA,OACxD,KAAI,CAACtD,OAAO,CAAC;QACX6C,MAAM,EAAE,MAAM;QACdC,GAAG,EAAE,SAAS;QACdC,QAAQ,EAAE,wBAAwB;QAClCC,OAAO,EAAE;UACPO,aAAa,EAAED,KAAK,CAACE,QAAQ,EAAE;UAC/B,mBAAmB,EAAEpD;QACvB,CAAC;QACD6C,IAAI,EAAE3C;MACR,CAAC,CAAC;IAAA,EACH;EACH,CAAC;EAEDmD,0BAA0B,sCAACnD,OAAO,EAAE;IAClC,IAAMoD,KAAK,GAAG;MACZ1B,IAAI,EAAE,kBAAkB;MACxBM,YAAY,EAAEhC;IAChB,CAAC;IAED,OAAO,IAAI,CAACZ,2BAA2B,CAACM,OAAO,CAAC0D,KAAK,CAAC;EACxD,CAAC;EAAA;AACH,CAAC,CAAC;AAAC,eAEYxE,OAAO;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/internal-plugin-metrics",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.41",
   "description": "",
   "license": "MIT",
   "main": "dist/index.js",
@@ -24,12 +24,12 @@
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.4",
-    "@webex/common-timers": "3.0.0-beta.4",
-    "@webex/internal-plugin-device": "3.0.0-beta.4",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.4",
-    "@webex/test-helper-chai": "3.0.0-beta.4",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.4",
-    "@webex/webex-core": "3.0.0-beta.4"
+    "@webex/common": "3.0.0-beta.41",
+    "@webex/common-timers": "3.0.0-beta.41",
+    "@webex/internal-plugin-device": "3.0.0-beta.41",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.41",
+    "@webex/test-helper-chai": "3.0.0-beta.41",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.41",
+    "@webex/webex-core": "3.0.0-beta.41"
   }
 }

package/src/batcher.js

@@ -23,11 +23,13 @@ const MetricsBatcher = Batcher.extend({
   },
 
   prepareRequest(queue) {
-    return Promise.resolve(queue.map((item) => {
-      item.postTime = item.postTime || Date.now();
+    return Promise.resolve(
+      queue.map((item) => {
+        item.postTime = item.postTime || Date.now();
 
-      return item;
-    }));
+        return item;
+      })
+    );
   },
 
   submitHttpRequest(payload) {
@@ -36,8 +38,8 @@ const MetricsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'metrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
   },
 
@@ -47,38 +49,43 @@ const MetricsBatcher = Batcher.extend({
 
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError.NetworkOrCORSError) {
-      this.logger.warn('metrics-batcher: received network error submitting metrics, reenqueuing payload');
-
-      return Promise.all(reason.options.body.metrics.map((item) => new Promise((resolve) => {
-        const delay = item[sym].nextDelay;
-
-        if (delay < this.config.batcherRetryPlateau) {
-          item[sym].nextDelay *= 2;
-        }
-        safeSetTimeout(() => {
-          resolve(this.rerequest(item));
-        }, delay);
-      })));
+      this.logger.warn(
+        'metrics-batcher: received network error submitting metrics, reenqueuing payload'
+      );
+
+      return Promise.all(
+        reason.options.body.metrics.map(
+          (item) =>
+            new Promise((resolve) => {
+              const delay = item[sym].nextDelay;
+
+              if (delay < this.config.batcherRetryPlateau) {
+                item[sym].nextDelay *= 2;
+              }
+              safeSetTimeout(() => {
+                resolve(this.rerequest(item));
+              }, delay);
+            })
+        )
+      );
     }
 
     return Reflect.apply(Batcher.prototype.handleHttpError, this, [reason]);
   },
 
   rerequest(item) {
-    return Promise.all([
-      this.getDeferredForRequest(item),
-      this.prepareItem(item)
-    ])
-      .then(([defer, req]) => {
+    return Promise.all([this.getDeferredForRequest(item), this.prepareItem(item)]).then(
+      ([defer, req]) => {
         this.enqueue(req)
           .then(() => this.bounce())
           .catch((reason) => defer.reject(reason));
-      });
+      }
+    );
   },
 
   fingerprintRequest(item) {
     item[sym] = item[sym] || {
-      nextDelay: 1000
+      nextDelay: 1000,
     };
 
     return Promise.resolve(item[sym]);
@@ -86,7 +93,7 @@ const MetricsBatcher = Batcher.extend({
 
   fingerprintResponse(item) {
     return Promise.resolve(item[sym]);
-  }
+  },
 });
 
 export default MetricsBatcher;

package/src/call-diagnostic-events-batcher.js

@@ -10,7 +10,7 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
   /**
    * @param {string} webClientDomain
    * @returns {string}
-  */
+   */
   getBuildType(webClientDomain) {
     if (
       webClientDomain?.includes('teams.webex.com') ||
@@ -29,7 +29,7 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
     // Browsers cannot provide such information right now. However, it is a required field.
     const origin = {
       buildType: this.getBuildType(item.event?.eventData?.webClientDomain),
-      networkType: 'unknown'
+      networkType: 'unknown',
     };
 
     item.eventPayload.origin = Object.assign(origin, item.eventPayload.origin);
@@ -53,10 +53,10 @@ const CallDiagnosticEventsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'clientmetrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
-  }
+  },
 });
 
 export default CallDiagnosticEventsBatcher;

package/src/client-metrics-batcher.js

@@ -22,11 +22,10 @@ const ClientMetricsBatcher = Batcher.extend({
       service: 'metrics',
       resource: 'clientmetrics',
       body: {
-        metrics: payload
-      }
+        metrics: payload,
+      },
     });
-  }
-
+  },
 });
 
 export default ClientMetricsBatcher;

package/src/config.js

@@ -8,15 +8,35 @@ export const CLIENT_NAME = 'webex-js-sdk';
 export default {
   device: {
     preDiscoveryServices: {
-      metricsServiceUrl: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
-      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1'
-    }
+      metricsServiceUrl:
+        process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
+      metrics: process.env.METRICS_SERVICE_URL || 'https://metrics-a.wbx2.com/metrics/api/v1',
+    },
   },
   metrics: {
     appType: inBrowser ? 'browser' : 'nodejs',
     batcherWait: 500,
     batcherMaxCalls: 50,
     batcherMaxWait: 1500,
-    batcherRetryPlateau: 32000
-  }
+    batcherRetryPlateau: 32000,
+  },
+};
+
+export const OS_NAME = {
+  WINDOWS: 'windows',
+  MAC: 'mac',
+  IOS: 'ios',
+  ANDROID: 'android',
+  CHROME: 'chrome',
+  LINUX: 'linux',
+  OTHERS: 'other',
+};
+
+export const OSMap = {
+  'Chrome OS': OS_NAME.CHROME,
+  macOS: OS_NAME.MAC,
+  Windows: OS_NAME.WINDOWS,
+  iOS: OS_NAME.IOS,
+  Android: OS_NAME.ANDROID,
+  Linux: OS_NAME.LINUX,
 };

package/src/index.js

@@ -10,8 +10,8 @@ import Metrics from './metrics';
 import config from './config';
 
 registerInternalPlugin('metrics', Metrics, {
-  config
+  config,
 });
 
-export {default} from './metrics';
+export {default, getOSNameInternal} from './metrics';
 export {config};

package/src/metrics.js

@@ -1,28 +1,25 @@
+/* eslint-disable default-param-last */
+
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
 import {WebexPlugin} from '@webex/webex-core';
 import {BrowserDetection} from '@webex/common';
+import {OS_NAME, OSMap, CLIENT_NAME} from './config';
 
-import {CLIENT_NAME} from './config';
 import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
 import CallDiagnosticEventsBatcher from './call-diagnostic-events-batcher';
 
-const {
-  getOSName,
-  getOSVersion,
-  getBrowserName,
-  getBrowserVersion
-} = BrowserDetection();
+const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
+
+export function getOSNameInternal() {
+  return OSMap[getOSName()] ?? OS_NAME.OTHERS;
+}
 
 function getSparkUserAgent(webex) {
-  const {
-    appName,
-    appVersion,
-    appPlatform
-  } = webex?.config ?? {};
+  const {appName, appVersion, appPlatform} = webex?.config ?? {};
 
   let sparkUserAgent = CLIENT_NAME;
 
@@ -37,21 +34,19 @@ function getSparkUserAgent(webex) {
   return sparkUserAgent;
 }
 
-
 const Metrics = WebexPlugin.extend({
   children: {
     batcher: Batcher,
     clientMetricsBatcher: ClientMetricsBatcher,
-    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher
+    callDiagnosticEventsBatcher: CallDiagnosticEventsBatcher,
   },
 
   namespace: 'Metrics',
 
   submit(key, value) {
-    return this.batcher.request(Object.assign({key}, value));
+    return this.batcher.request({key, ...value});
   },
 
-
   /**
    * This corresponds to #sendSemiStructured() in the deprecated metrics handler
    * @param {string} eventName
@@ -68,49 +63,45 @@ const Metrics = WebexPlugin.extend({
     payload.tags = {
       ...props.tags,
       browser: getBrowserName(),
-      os: getOSName(),
+      os: getOSNameInternal(),
 
       // Node does not like this so we need to check if it exists or not
       // eslint-disable-next-line no-undef
-      domain: typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
+      domain:
+        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
       client_id: this.webex.credentials.config.client_id,
-      user_id: this.webex.internal.device.userId
+      user_id: this.webex.internal.device.userId,
     };
 
     try {
       payload.tags.org_id = this.webex.credentials.getOrgId();
-    }
-    catch {
+    } catch {
       this.logger.info('metrics: unable to get orgId');
     }
 
-
     payload.fields = {
       ...props.fields,
       browser_version: getBrowserVersion(),
       os_version: getOSVersion(),
       sdk_version: this.webex.version,
       platform: 'Web',
-      spark_user_agent: getSparkUserAgent(this.webex)
+      spark_user_agent: getSparkUserAgent(this.webex),
     };
 
-
     payload.type = props.type || this.webex.config.metrics.type;
 
-
     payload.context = {
       ...props.context,
       app: {
-        version: this.webex.version
+        version: this.webex.version,
       },
       locale: 'en-US',
       os: {
-        name: getOSName(),
-        version: getOSVersion()
-      }
+        name: getOSNameInternal(),
+        version: getOSVersion(),
+      },
     };
 
-
     if (props.eventPayload) {
       payload.eventPayload = props.eventPayload;
     }
@@ -121,7 +112,7 @@ const Metrics = WebexPlugin.extend({
 
     if (preLoginId) {
       const _payload = {
-        metrics: [payload]
+        metrics: [payload],
       };
 
       // Do not batch these because pre-login events occur during onboarding, so we will be partially blind
@@ -144,12 +135,12 @@ const Metrics = WebexPlugin.extend({
       api: 'metrics',
       resource: 'clientmetrics',
       headers: {
-        'x-prelogin-userid': preLoginId
+        'x-prelogin-userid': preLoginId,
       },
       body: {},
       qs: {
-        alias: true
-      }
+        alias: true,
+      },
     });
   },
 
@@ -161,20 +152,21 @@ const Metrics = WebexPlugin.extend({
         resource: 'clientmetrics-prelogin',
         headers: {
           authorization: token.toString(),
-          'x-prelogin-userid': preLoginId
+          'x-prelogin-userid': preLoginId,
         },
-        body: payload
-      }));
+        body: payload,
+      })
+    );
   },
 
   submitCallDiagnosticEvents(payload) {
     const event = {
       type: 'diagnostic-event',
-      eventPayload: payload
+      eventPayload: payload,
     };
 
     return this.callDiagnosticEventsBatcher.request(event);
-  }
+  },
 });
 
 export default Metrics;

package/test/unit/spec/batcher.js

@@ -27,8 +27,8 @@ describe('plugin-metrics', () => {
     beforeEach(() => {
       webex = new MockWebex({
         children: {
-          metrics: Metrics
-        }
+          metrics: Metrics,
+        },
       });
 
       webex.config.metrics = config.metrics;
@@ -37,7 +37,7 @@ describe('plugin-metrics', () => {
         return Promise.resolve({
           statusCode: 204,
           body: undefined,
-          options
+          options,
         });
       };
       sinon.spy(webex, 'request');
@@ -58,9 +58,10 @@ describe('plugin-metrics', () => {
         it('clears the queue', () => {
           clock.uninstall();
 
-          return webex.internal.metrics.batcher.request({
-            key: 'testMetric'
-          })
+          return webex.internal.metrics.batcher
+            .request({
+              key: 'testMetric',
+            })
             .then(() => {
               assert.calledOnce(webex.request);
               assert.lengthOf(webex.internal.metrics.batcher.queue, 0);
@@ -80,26 +81,28 @@ describe('plugin-metrics', () => {
 
           sinon.stub(webex, 'request').callsFake((options) => {
             options.headers = {
-              trackingid: count
+              trackingid: count,
             };
 
             count += 1;
             if (count < 9) {
-              return Promise.reject(new WebexHttpError.NetworkOrCORSError({
-                statusCode: 0,
-                options
-              }));
+              return Promise.reject(
+                new WebexHttpError.NetworkOrCORSError({
+                  statusCode: 0,
+                  options,
+                })
+              );
             }
 
             return Promise.resolve({
               statusCode: 204,
               body: undefined,
-              options
+              options,
             });
           });
 
           const promise = webex.internal.metrics.batcher.request({
-            key: 'testMetric'
+            key: 'testMetric',
           });
 
           return promiseTick(50)
@@ -159,8 +162,16 @@ describe('plugin-metrics', () => {
             .then(() => assert.lengthOf(webex.internal.metrics.batcher.queue, 0))
             .then(() => promise)
             .then(() => {
-              assert.lengthOf(webex.request.args[1][0].body.metrics, 1, 'Reenqueuing the metric once did not increase the number of metrics to be submitted');
-              assert.lengthOf(webex.request.args[2][0].body.metrics, 1, 'Reenqueuing the metric twice did not increase the number of metrics to be submitted');
+              assert.lengthOf(
+                webex.request.args[1][0].body.metrics,
+                1,
+                'Reenqueuing the metric once did not increase the number of metrics to be submitted'
+              );
+              assert.lengthOf(
+                webex.request.args[2][0].body.metrics,
+                1,
+                'Reenqueuing the metric twice did not increase the number of metrics to be submitted'
+              );
               assert.lengthOf(webex.internal.metrics.batcher.queue, 0);
             });
         });