@webex/internal-plugin-metrics 3.0.0-beta.20 → 3.0.0-beta.200

package/dist/types/call-diagnostic/call-diagnostic-metrics.d.ts

@@ -0,0 +1,348 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { Event, ClientType, SubClientType, NetworkType, ClientEvent, SubmitClientEventOptions, MediaQualityEvent, SubmitMQEOptions, SubmitMQEPayload, ClientEventError, ClientEventPayload } from '../metrics.types';
+type GetOriginOptions = {
+    clientType: ClientType;
+    subClientType: SubClientType;
+    networkType?: NetworkType;
+};
+type GetIdentifiersOptions = {
+    meeting?: any;
+    mediaConnections?: any[];
+    correlationId?: string;
+};
+/**
+ * @description Util class to handle Call Analyzer Metrics
+ * @export
+ * @class CallDiagnosticMetrics
+ */
+export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
+    private callDiagnosticEventsBatcher;
+    /**
+     * Constructor
+     * @param args
+     */
+    constructor(...args: any[]);
+    /**
+     * Returns the login type of the current user
+     * @returns one of 'login-ci','unverified-guest', null
+     */
+    getCurLoginType(): "login-ci" | "unverified-guest";
+    /**
+     * Get origin object for Call Diagnostic Event payload.
+     * @param options
+     * @param meetingId
+     * @returns
+     */
+    getOrigin(options: GetOriginOptions, meetingId?: string): {
+        name: "antares" | "beech" | "breakout" | "cb" | "cloudproxy" | "edonus" | "endpoint" | "givr" | "hecate" | "hedge" | "hesiod" | "homer" | "superhomer" | "l2sip" | "linus" | "locus" | "mcc" | "mcs" | "mercury" | "mes" | "mjs" | "mmp" | "mygdon" | "orpheus" | "page" | "poros" | "rhesos" | "terminus" | "tpgw" | "ucc" | "wdm" | "webexivr";
+        userAgent: string;
+        buildType?: "debug" | "test" | "prod" | "tap" | "analyzer-test";
+        upgradeChannel?: string;
+        instanceId?: string;
+        networkType: "unknown" | "wifi" | "ethernet" | "cellular";
+        localIP?: string;
+        usingProxy?: boolean;
+        mediaEngineSoftwareVersion?: string;
+        environment?: string;
+        newEnvironment?: string;
+        clientInfo?: {
+            os: "windows" | "mac" | "ios" | "android" | "chrome" | "linux" | "other" | "uwp-arm64";
+            osVersion: string;
+            localIP?: string;
+            gatewayIP?: string;
+            macAddress?: string;
+            localNetworkPrefix?: string;
+            publicNetworkPrefix?: string;
+            browserLaunchMethod?: "activex" | "npapi" | "extension" | "cwsapi" | "java" | "tfs" | "webacd" | "url-handler" | "thinclient";
+            clientLaunchMethod?: "url-handler" | "universal-link" | "voice-command" | "notification" | "manual" | "teams-cross-launch";
+            browser?: string;
+            browserVersion?: string;
+            clientType?: "SIP" | "MEETING_CENTER" | "EVENT_CENTER" | "TRAINING_CENTER" | "TEAMS_CLIENT" | "TEAMS_DEVICE" | "TEAMS_SHARE" | "RECORDING" | "CLOUD_AWARE_SIP" | "TEAMS_WXC_CLIENT" | "WXC_CLIENT" | "WXC_DEVICE" | "WEBEX_JS_SDK" | "VOICEA_CLIENT" | "CISCO_SIP_GW" | "WEBEX_SDK" | "CPAAS_THIRD_PARTY_SDK" | "WXC_THIRD_PARTY";
+            subClientType?: "DESKTOP_APP" | "DESKTOP_APP_VDI" | "DEVICE_CURRENT" | "DEVICE_LEGACY_2020" | "HVDI_APP" | "MOBILE_APP" | "VDI_APP" | "WEB_APP" | "MOBILE_NETWORK" | "HOLOGRAM_HEADSET_APP";
+            clientVersion?: string;
+            localClientVersion?: string;
+            modelNumber?: string;
+            joinFirstUpdateLater?: "ep-enabled" | "sp-enabled" | "not-enabled";
+            standbyUsed?: boolean;
+            prefetchDocShowUsed?: boolean;
+            fastJoinUsed?: boolean;
+            clientDownloadSize?: number;
+            clientDownloadFileCount?: number;
+            nodeId?: number;
+            machineInfo?: string;
+            parentAppName?: string;
+            parentAppInPermitList?: boolean;
+            meetingSiteType?: "train" | "webex-11" | "orion";
+            CDNEnabled?: boolean;
+            clientMajorVersion?: string;
+            majorVersion?: number;
+            minorVersion?: number;
+            revision?: number;
+            isValidClientVersion?: boolean;
+            cpuInfo?: {
+                description: string;
+                clockSpeedGigaHertz: number;
+                numberOfCores: number;
+                architecture: "unknown" | "intel32" | "intel64" | "amd32" | "amd64" | "arm32" | "arm64";
+                staticPerformance?: string;
+            };
+            shareType?: "cb-normal-share" | "ce-airplay-share" | "ce-direct-share" | "ce-gui-loopback-share" | "ce-input-source-share" | "ce-input-source-share-hdmi" | "ce-input-source-share-usbc" | "ce-jpg-share" | "ce-miracast-share" | "mcs-normal-share" | "mcs-normal-audio-share" | "mcs-hfps-share" | "mcs-hfps-audio-share";
+            videoDisplayMode?: "grid-view" | "active-speaker-view";
+            videoLayoutType?: "stack" | "stackWithShare" | "sideBySide" | "sideBySideWithShare" | "grid" | "floatingActive" | "floatingThumbnail" | "floatingGrid" | "overlay" | "focus" | "prominent" | "focusWithShare" | "prominentWithShare" | "equal" | "equalWithShare";
+            videoRenderType?: "wme" | "client_d3d" | "client_gdi";
+            vdiInfo?: unknown;
+            is64BitsClient?: boolean;
+            webexAppVersion?: string;
+            launch32BitsReason?: "forcewin32" | "disablewin64" | "platform_win32" | "platform_arm" | "platform_unknown" | "version_below_41.11";
+            inMeetingUpdate?: boolean;
+            mtaVersion?: string;
+            isWarholOpening?: boolean;
+        };
+        isHybridMedia?: boolean;
+        originData?: {};
+    };
+    /**
+     * Gather identifier details for call diagnostic payload.
+     * @throws Error if initialization fails.
+     * @param options
+     */
+    getIdentifiers(options: GetIdentifiersOptions): {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+    } | {
+        attendeeId?: string;
+        breakoutGroupId?: string;
+        breakoutMoveId?: string;
+        breakoutSessionId?: string;
+        confluenceId?: string;
+        cpaasIdentifiers?: {
+            imiTenantId: string;
+            devClientId: string;
+            imiServiceId: string;
+            imiAppId: string;
+            sessionId: string;
+            sessionInstanceId: string;
+        };
+        csdmDeviceUrl?: string;
+        destinationBreakoutSessionId?: string;
+        destinationLocusSessionId?: string;
+        destinationLocusUrl?: string;
+        destinationVenueId?: string;
+        deviceId?: string;
+        ivrCallId?: string;
+        ivrDialogId?: string;
+        ivrId?: string;
+        locusId?: string;
+        locusSessionId?: string;
+        locusStartTime?: string;
+        locusUrl?: string;
+        mediaAgentAlias?: string;
+        mediaAgentGroupId?: string;
+        meetClusterName?: string;
+        meetingLookupUrl?: string;
+        meetingOrgId?: string;
+        msteamsTenantGuid?: string;
+        msteamsConferenceId?: string;
+        oauth2ClientId?: string;
+        orgId?: string;
+        provisionalCorrelationId?: string;
+        roomId?: string;
+        sipCallId?: string;
+        sipSessionId?: {
+            local?: string;
+            remote?: string;
+        };
+        sipUri?: string;
+        subConfId?: string;
+        tenantId?: string;
+        trackingId?: string;
+        userId?: string;
+        venueId?: string;
+        venueUrl?: string;
+        whiteboardUrl?: string;
+        webexConferenceId?: number;
+        webexClusterName?: string;
+        webexConferenceIdStr?: string;
+        webexDataCenter?: string;
+        webexGuestId?: number;
+        webexMeetingId?: number;
+        webexNodeId?: number;
+        webexSiteId?: number;
+        webexSiteName?: string;
+        webexUserId?: number;
+        webexWebDomain?: string;
+        correlationId: string;
+    };
+    /**
+     * Create diagnostic event, which can hold client event, feature event or MQE event data.
+     * This just initiates the shared properties that are required for all the 3 event categories.
+     * @param eventData
+     * @param options
+     * @returns
+     */
+    prepareDiagnosticEvent(eventData: Event['event'], options: any): Event;
+    /**
+     * TODO: NOT IMPLEMENTED
+     * Submit Feature Event
+     * @returns
+     */
+    submitFeatureEvent(): void;
+    /**
+     * Submit Media Quality Event
+     * @param args - submit params
+     * @param arg.name - event key
+     * @param arg.payload - additional payload to be merge with the default payload
+     * @param arg.options - options
+     */
+    submitMQE({ name, payload, options, }: {
+        name: MediaQualityEvent['name'];
+        payload: SubmitMQEPayload;
+        options: SubmitMQEOptions;
+    }): void;
+    /**
+     * Return Client Event payload by client error code
+     * @param arg - get error arg
+     * @param arg.clientErrorCode
+     * @param arg.serviceErrorCode
+     * @returns
+     */
+    getErrorPayloadForClientErrorCode({ clientErrorCode, serviceErrorCode, }: {
+        clientErrorCode: number;
+        serviceErrorCode: any;
+    }): ClientEventError;
+    /**
+     * Generate error payload for Client Event
+     * @param rawError
+     */
+    generateClientEventErrorPayload(rawError: any): {
+        fatal: boolean;
+        category: "other" | "signaling" | "media" | "expected";
+        errorDescription?: string;
+        errorCode?: number;
+        errorCodeStr?: string;
+        httpCode?: number;
+        errorData?: {};
+        shownToUser: boolean;
+        serviceErrorCode?: number;
+        name: "other" | "media-engine" | "ice.failed" | "locus.response" | "locus.leave" | "client.leave" | "media-device" | "media-sca";
+    };
+    /**
+     * Create client event object for in meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - options
+     * @returns object
+     */
+    private createClientEventObjectInMeeting;
+    /**
+     * Create client event object for pre meeting events
+     * @param arg - create args
+     * @param arg.event - event key
+     * @param arg.options - payload
+     * @returns object
+     */
+    private createClientEventObjectPreMeeting;
+    /**
+     * Prepare Client Event CA event.
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - payload
+     * @returns {any} options to be with fetch
+     * @throws
+     */
+    private prepareClientEvent;
+    /**
+     * Submit Client Event CA event.
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - payload
+     * @throws
+     */
+    submitClientEvent({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: ClientEventPayload;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+    /**
+     * Prepare the event and send the request to metrics-a service.
+     * @param event
+     * @returns promise
+     */
+    submitToCallDiagnostics(event: Event): Promise<any>;
+    /**
+     * Builds a request options object to later be passed to fetch().
+     * @param arg - submit params
+     * @param arg.event - event key
+     * @param arg.payload - additional payload to be merged with default payload
+     * @param arg.options - client event options
+     * @returns {Promise<any>}
+     * @throws
+     */
+    buildClientEventFetchRequestOptions({ name, payload, options, }: {
+        name: ClientEvent['name'];
+        payload?: ClientEventPayload;
+        options?: SubmitClientEventOptions;
+    }): Promise<any>;
+}
+export {};

package/dist/types/call-diagnostic/call-diagnostic-metrics.util.d.ts

@@ -0,0 +1,52 @@
+export declare const anonymizeIPAddress: (localIp: any) => string;
+/**
+ * Returns a formated string of the user agent.
+ *
+ * @returns {string} formatted user agent information
+ */
+export declare const userAgentToString: ({ clientName, webexVersion }: {
+    clientName: any;
+    webexVersion: any;
+}) => string;
+/**
+ * Iterates object recursively and removes any
+ * property that returns isEmpty for it's associated value
+ * isEmpty = implementation from Lodash.
+ *
+ * It modifies the object in place (mutable)
+ *
+ * @param obj - input
+ * @returns
+ */
+export declare const clearEmptyKeysRecursively: (obj: any) => void;
+/**
+ * Locus error codes start with 2. The next three digits are the
+ * HTTP status code related to the error code (like 400, 403, 502, etc.)
+ * The remaining three digits are just an increasing integer.
+ * If it is 7 digits and starts with a 2, it is locus.
+ *
+ * @param errorCode
+ * @returns
+ */
+export declare const isLocusServiceErrorCode: (errorCode: string | number) => boolean;
+/**
+ * @param webClientDomain
+ * @returns
+ */
+export declare const getBuildType: (webClientDomain: any) => "production" | "test";
+/**
+ * Prepare metric item for submission.
+ * @param {Object} webex sdk instance
+ * @param {Object} item
+ * @returns {Object} prepared item
+ */
+export declare const prepareDiagnosticMetricItem: (webex: any, item: any) => any;
+/**
+ * Sets the originTime value(s) before the request/fetch.
+ * This function is only useful if you are about to submit a metrics
+ * request using pre-built fetch options;
+ *
+ * @param {any} options
+ * @returns {any} the updated options object
+ */
+export declare const setMetricTimings: (options: any) => any;

package/dist/types/call-diagnostic/config.d.ts

@@ -0,0 +1,57 @@
+import { ClientEventError } from '../metrics.types';
+export declare const NEW_LOCUS_ERROR_CLIENT_CODE = 4008;
+export declare const MEETING_INFO_LOOKUP_ERROR_CLIENT_CODE = 4100;
+export declare const ICE_FAILURE_CLIENT_CODE = 2004;
+export declare const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP: {
+    58400: number;
+    99002: number;
+    99009: number;
+    403040: number;
+    403041: number;
+    403038: number;
+    403036: number;
+    403043: number;
+    403048: number;
+    403049: number;
+    403100: number;
+    403101: number;
+    403102: number;
+    403103: number;
+    403104: number;
+    404001: number;
+    404006: number;
+    429005: number;
+    2403001: number;
+    2403002: number;
+    2403003: number;
+    2403004: number;
+    2403018: number;
+    2403019: number;
+    2423003: number;
+    2423004: number;
+    2423005: number;
+    2423007: number;
+    2403010: number;
+    2403014: number;
+    2403015: number;
+    2423010: number;
+    2400008: number;
+    2400011: number;
+    2400012: number;
+    2403007: number;
+    2401002: number;
+    2404002: number;
+    2400009: number;
+    2400025: number;
+    2423009: number;
+    2403022: number;
+    2423008: number;
+    2400006: number;
+    2400014: number;
+    2404001: number;
+    2403025: number;
+    2405001: number;
+    2409005: number;
+};
+export declare const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>>;
+export declare const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = "js_sdk_call_diagnostic_event_failed_to_send";