@esri/telemetry-amazon 6.0.0-beta.4 → 6.0.0-beta.6

package/dist/umd/telemetry-amazon.js

@@ -257,16 +257,13 @@
             },
             body: JSON.stringify({ IdentityPoolId }),
         };
-        return fetch(COGNITO_URL, fetchOptions)
-            .then((response) => {
-            if (!response.ok) {
-                throw new Error(response.statusText);
+        return (async () => {
+            const getIdResponse = await fetch(COGNITO_URL, fetchOptions);
+            if (!getIdResponse.ok) {
+                throw new Error(getIdResponse.statusText);
             }
-            return response.json();
-        })
-            .then((response) => {
-            const { IdentityId } = response;
-            const options = {
+            const { IdentityId } = await getIdResponse.json();
+            const credentialsOptions = {
                 method: 'POST',
                 headers: {
                     'Content-type': 'application/x-amz-json-1.1',
@@ -274,18 +271,14 @@
                 },
                 body: JSON.stringify({ IdentityId }),
             };
-            return fetch(COGNITO_URL, options);
-        })
-            .then((response) => {
-            if (!response.ok) {
-                throw new Error(response.statusText);
+            const getCredentialsResponse = await fetch(COGNITO_URL, credentialsOptions);
+            if (!getCredentialsResponse.ok) {
+                throw new Error(getCredentialsResponse.statusText);
             }
-            return response.json();
-        })
-            .then(({ Credentials }) => {
+            const { Credentials } = await getCredentialsResponse.json();
             storage.set(COGNITO_KEY, Credentials);
             return Credentials;
-        });
+        })();
     }
 
     /******************************************************************************
@@ -1667,7 +1660,144 @@
       return [HOST_SERVICES[service] || service, region || '']
     }
 
-    // Shared utilities for plugins
+    function parseOS(userAgent) {
+        var _a;
+        const cleanAgent = userAgent.toLowerCase().replace(/ /g, '');
+        const osMatchers = [
+            {
+                name: 'Windows',
+                regex: /windowsnt/i,
+                versionRegex: /windowsnt([\d\.]+)/i,
+            },
+            {
+                name: 'MacOS',
+                regex: /macos|macosx|macintosh|macintel|darwin/i,
+                versionRegex: /osx([\d_\.]+)/i,
+            },
+            {
+                name: 'Android',
+                regex: /android/i,
+                versionRegex: /android([\d\.]+)/i,
+            },
+            {
+                name: 'iOS',
+                regex: /iphone|ipad|ipod/i,
+                versionRegex: /os([\d_\.]+)/i,
+            },
+            {
+                name: 'Linux',
+                regex: /linux/i,
+            },
+        ];
+        const matched = osMatchers.find((entry) => entry.regex.test(cleanAgent));
+        if (!matched) {
+            return {};
+        }
+        const version = matched.versionRegex
+            ? (_a = (cleanAgent.match(matched.versionRegex) || [])[1]) === null || _a === void 0 ? void 0 : _a.replace(/_/g, '.')
+            : undefined;
+        return {
+            name: matched.name,
+            version,
+        };
+    }
+
+    function getNavigatorSafe() {
+        if (typeof window === 'undefined' || !window.navigator) {
+            return undefined;
+        }
+        return window.navigator;
+    }
+    function getLanguageInfo(nav) {
+        if (!nav) {
+            return '';
+        }
+        const lang = nav.language ||
+            nav.browserLanguage ||
+            (Array.isArray(nav.languages) && nav.languages.length > 0
+                ? nav.languages[0]
+                : 'en_US') ||
+            '';
+        return String(lang).toLowerCase().replace('-', '_');
+    }
+    function getBrowserTimezone() {
+        const tzMatch = /\(([A-Za-z\s].*)\)/.exec(new Date().toString());
+        return tzMatch ? tzMatch[1] || '' : '';
+    }
+    function parseBrowserType(userAgent) {
+        const operaMatch = /.+(Opera[\s[A-Z]*|OPR[\sA-Z]*)\/([0-9\.]+).*/i.exec(userAgent);
+        if (operaMatch) {
+            return {
+                type: operaMatch[1],
+                version: operaMatch[2],
+            };
+        }
+        const edgeOrTridentMatch = /.+(Trident|Edge)\/([0-9\.]+).*/i.exec(userAgent);
+        if (edgeOrTridentMatch) {
+            return {
+                type: edgeOrTridentMatch[1],
+                version: edgeOrTridentMatch[2],
+            };
+        }
+        const headlessMatch = /(headlesschrome)(?:\/([\w\.]+)| )/i.exec(userAgent);
+        if (headlessMatch) {
+            return {
+                type: headlessMatch[1],
+                version: headlessMatch[2],
+            };
+        }
+        const browserMatch = /.+(Chrome|Firefox|FxiOS)\/([0-9\.]+).*/i.exec(userAgent);
+        if (browserMatch) {
+            return {
+                type: browserMatch[1],
+                version: browserMatch[2],
+            };
+        }
+        const safariMatch = /.+(Safari)\/([0-9\.]+).*/i.exec(userAgent);
+        if (safariMatch) {
+            return {
+                type: safariMatch[1],
+                version: safariMatch[2],
+            };
+        }
+        const webkitMatch = /.+(AppleWebKit)\/([0-9\.]+).*/i.exec(userAgent);
+        if (webkitMatch) {
+            return {
+                type: webkitMatch[1],
+                version: webkitMatch[2],
+            };
+        }
+        const anyMatch = /.*([A-Z]+)\/([0-9\.]+).*/i.exec(userAgent);
+        const fallback = anyMatch || ['', 'NA', '0.0.0'];
+        return {
+            type: fallback[1],
+            version: fallback[2],
+        };
+    }
+    function getBrowserClientInfo() {
+        const nav = getNavigatorSafe();
+        if (!nav) {
+            return {};
+        }
+        const userAgent = nav.userAgent || '';
+        const browser = parseBrowserType(userAgent);
+        const isBrave = (nav.brave && nav.brave.isBrave) || false;
+        const type = isBrave ? 'Brave' : browser.type;
+        const os = parseOS(userAgent);
+        const vendorToken = (nav.vendor || '').split(' ').filter(Boolean)[0];
+        const make = type === 'Brave' ? type : vendorToken || nav.product || '';
+        return {
+            language: getLanguageInfo(nav),
+            make,
+            model: type,
+            version: browser.version,
+            name: [type, browser.version].filter(Boolean).join('/'),
+            timezone: getBrowserTimezone(),
+            platform: nav.platform,
+            os,
+        };
+    }
+
     const PINPOINT_ENDPOINT_KEY = 'TELEMETRY_PINPOINT_ENDPOINT_ID';
     const LOG_PREFIX = '[telemetry-amazon]';
     function isDebugEnabled() {
@@ -1721,11 +1851,13 @@
     const SESSION_START_EVENT = '_session.start';
     const SESSION_STOP_EVENT = '_session.stop';
     const DEFAULT_IDLE_TIMEOUT_MS = 30 * 60 * 1000;
+    const DEFAULT_DEBOUNCE_MS = 5000;
     /** Converts a string to a number, guarded against invalid values */
     function getNumber(value, fallback = 0) {
         const numeric = Number(value);
         return Number.isFinite(numeric) ? numeric : fallback;
     }
+    /** Splits an EsriBatchEventPayload into attributes and metrics */
     function splitEventData(payload) {
         const attributes = {};
         const metrics = {};
@@ -1762,58 +1894,73 @@
             metrics,
         };
     }
-    function buildBatchEventPayload({ eventName, payload, trackerName, appName, appVersion, session, }) {
-        var _a, _b, _c, _d;
-        const endpointId = getEndpointId();
-        const timestamp = new Date().toISOString();
-        const sessionContext = session ||
+    /** Constructs an event payload in the shape expected by the endpoint.  */
+    function buildBatchEventPayload({ queuedEvents, trackerName, appName, appVersion, }) {
+        var _a, _b, _c, _d, _e, _f;
+        const endpointEvent = queuedEvents[queuedEvents.length - 1] ||
             {
-                id: `${Date.now()}-${Math.random().toString(16).slice(2)}`,
-                startTimestamp: timestamp,
-                startUnixMs: Date.now(),
+                payload: {},
+                browserInfo: {},
             };
-        const isStopEvent = eventName === SESSION_STOP_EVENT;
-        const { attributes, metrics } = splitEventData(payload);
+        const payload = endpointEvent.payload || {};
+        const browserInfo = endpointEvent.browserInfo || {};
+        const endpointId = getEndpointId();
+        const location = {};
+        if (payload === null || payload === void 0 ? void 0 : payload.city) {
+            location.City = payload.city;
+        }
+        if (payload === null || payload === void 0 ? void 0 : payload.country) {
+            location.Country = payload.country;
+        }
+        if ((payload === null || payload === void 0 ? void 0 : payload.lat) !== undefined && (payload === null || payload === void 0 ? void 0 : payload.lat) !== null) {
+            location.Lat = getNumber(payload.lat);
+        }
+        if ((payload === null || payload === void 0 ? void 0 : payload.lon) !== undefined && (payload === null || payload === void 0 ? void 0 : payload.lon) !== null) {
+            location.Lon = getNumber(payload.lon);
+        }
         return {
             BatchEvent: {
                 Endpoint: {
                     Id: endpointId,
-                    Device: {
-                        Make: (payload === null || payload === void 0 ? void 0 : payload.deviceMake) || '',
-                        Model: (payload === null || payload === void 0 ? void 0 : payload.deviceModel) || '',
-                    },
-                    Location: {
-                        City: (payload === null || payload === void 0 ? void 0 : payload.city) || '',
-                        Country: (payload === null || payload === void 0 ? void 0 : payload.country) || '',
-                        Lat: getNumber(payload === null || payload === void 0 ? void 0 : payload.lat),
-                        Lon: getNumber(payload === null || payload === void 0 ? void 0 : payload.lon),
-                    },
+                    Device: Object.assign({ Locale: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.language) || '', Make: (payload === null || payload === void 0 ? void 0 : payload.deviceMake) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.make) || '', Model: (payload === null || payload === void 0 ? void 0 : payload.deviceModel) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.model) || '', ModelVersion: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.version) || '', Platform: ((_a = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _a === void 0 ? void 0 : _a.name) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.platform) || '' }, (((_b = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _b === void 0 ? void 0 : _b.version)
+                        ? { PlatformVersion: browserInfo.os.version }
+                        : {})),
+                    Location: location,
                     Application: {
-                        AppTitle: (_b = (_a = payload === null || payload === void 0 ? void 0 : payload.appTitle) !== null && _a !== void 0 ? _a : appName) !== null && _b !== void 0 ? _b : trackerName,
-                        AppVersion: (_c = payload === null || payload === void 0 ? void 0 : payload.appVersion) !== null && _c !== void 0 ? _c : appVersion,
-                        ClientSdkVersion: (_d = payload === null || payload === void 0 ? void 0 : payload.clientSdkVersion) !== null && _d !== void 0 ? _d : trackerName,
+                        AppTitle: (_d = (_c = payload === null || payload === void 0 ? void 0 : payload.appTitle) !== null && _c !== void 0 ? _c : appName) !== null && _d !== void 0 ? _d : trackerName,
+                        AppVersion: (_e = payload === null || payload === void 0 ? void 0 : payload.appVersion) !== null && _e !== void 0 ? _e : appVersion,
+                        ClientSdkVersion: (_f = payload === null || payload === void 0 ? void 0 : payload.clientSdkVersion) !== null && _f !== void 0 ? _f : trackerName,
                     },
                 },
-                Events: [
-                    {
-                        EventType: eventName,
+                Events: queuedEvents.map((queuedEvent) => {
+                    const timestamp = queuedEvent.timestamp;
+                    const { attributes, metrics } = splitEventData(queuedEvent.payload);
+                    const sessionContext = queuedEvent.session ||
+                        {
+                            id: `${queuedEvent.unixMs}-${Math.random().toString(16).slice(2)}`,
+                            startTimestamp: timestamp,
+                            startUnixMs: queuedEvent.unixMs,
+                        };
+                    const isStopEvent = queuedEvent.eventName === SESSION_STOP_EVENT;
+                    return {
+                        EventType: queuedEvent.eventName,
                         Timestamp: timestamp,
                         Session: {
                             Id: sessionContext.id,
                             StartTimestamp: sessionContext.startTimestamp,
                             EndTimestamp: timestamp,
                             Duration: isStopEvent
-                                ? Math.max(0, Date.now() - sessionContext.startUnixMs)
+                                ? Math.max(0, queuedEvent.unixMs - sessionContext.startUnixMs)
                                 : 0,
                         },
                         Attributes: attributes,
                         Metrics: metrics,
-                    },
-                ],
+                    };
+                }),
             },
         };
     }
-    function createEsriPlugin({ trackerName, appName, appId, appVersion, userPoolID, fips, }) {
+    function createEsriPlugin({ trackerName, appName, appId, appVersion, userPoolID, fips, debounceMs = DEFAULT_DEBOUNCE_MS, }) {
         const url = ESRI_ENDPOINT_URL(appId);
         let isDisabled = false;
         let hasWarned = false;
@@ -1821,8 +1968,10 @@
         let sessionStopSent = false;
         let activeSession;
         let idleTimerId;
+        let debounceTimerId;
         let lifecycleListenersAttached = false;
         const removeLifecycleListeners = [];
+        let pendingEvents = [];
         const isBrowser = typeof window !== 'undefined' && typeof document !== 'undefined';
         const warnOnce = (message, details) => {
             if (hasWarned) {
@@ -1860,6 +2009,106 @@
             clearTimeout(idleTimerId);
             idleTimerId = undefined;
         };
+        const clearDebounceTimer = () => {
+            if (!debounceTimerId) {
+                return;
+            }
+            clearTimeout(debounceTimerId);
+            debounceTimerId = undefined;
+        };
+        const clearPendingEvents = () => {
+            pendingEvents = [];
+        };
+        const enqueueEvent = (event) => {
+            pendingEvents.push(event);
+        };
+        const dequeuePendingEvents = () => {
+            if (pendingEvents.length === 0) {
+                return [];
+            }
+            const queuedEvents = pendingEvents;
+            pendingEvents = [];
+            return queuedEvents;
+        };
+        const sendQueuedEvents = (queuedEvents) => {
+            var _a;
+            if (queuedEvents.length === 0) {
+                return;
+            }
+            if (isDisabled || !url || !userPoolID) {
+                debugLog('Skipping esri track call', {
+                    eventName: (_a = queuedEvents[queuedEvents.length - 1]) === null || _a === void 0 ? void 0 : _a.eventName,
+                    reason: 'plugin-disabled',
+                });
+                return;
+            }
+            debugLog('Sending esri endpoint batch event', {
+                trackerName,
+                url,
+                eventCount: queuedEvents.length,
+            });
+            void (async () => {
+                var _a;
+                try {
+                    const credentials = await getCredentials(userPoolID, { fips });
+                    const accessKeyId = (credentials === null || credentials === void 0 ? void 0 : credentials.AccessKeyId) || (credentials === null || credentials === void 0 ? void 0 : credentials.accessKeyId);
+                    const secretAccessKey = (credentials === null || credentials === void 0 ? void 0 : credentials.SecretKey) || (credentials === null || credentials === void 0 ? void 0 : credentials.secretAccessKey);
+                    const sessionToken = (credentials === null || credentials === void 0 ? void 0 : credentials.SessionToken) || (credentials === null || credentials === void 0 ? void 0 : credentials.sessionToken);
+                    if (!accessKeyId || !secretAccessKey) {
+                        throw new Error('Signed endpoint credentials are missing required key fields.');
+                    }
+                    const client = new AwsClient({
+                        accessKeyId,
+                        secretAccessKey,
+                        sessionToken,
+                        service: ESRI_SIGNING_SERVICE,
+                        region: ESRI_SIGNING_REGION,
+                    });
+                    await client.fetch(url, {
+                        method: 'POST',
+                        headers: {
+                            'Content-Type': 'application/json',
+                        },
+                        body: JSON.stringify(buildBatchEventPayload({
+                            queuedEvents,
+                            trackerName,
+                            appName,
+                            appVersion,
+                        })),
+                    });
+                    debugLog('Endpoint event sent', {
+                        trackerName,
+                        eventCount: queuedEvents.length,
+                    });
+                }
+                catch (error) {
+                    isDisabled = true;
+                    clearIdleTimer();
+                    clearDebounceTimer();
+                    clearPendingEvents();
+                    removeAllLifecycleListeners();
+                    warnOnce('Esri telemetry disabled after endpoint track failure', {
+                        eventName: (_a = queuedEvents[queuedEvents.length - 1]) === null || _a === void 0 ? void 0 : _a.eventName,
+                        trackerName,
+                        message: (error === null || error === void 0 ? void 0 : error.message) || String(error),
+                    });
+                }
+            })();
+        };
+        const flushPendingEvents = (eventToAppend) => {
+            clearDebounceTimer();
+            const queuedEvents = dequeuePendingEvents();
+            if (eventToAppend) {
+                queuedEvents.push(eventToAppend);
+            }
+            sendQueuedEvents(queuedEvents);
+        };
+        const scheduleDebounceFlush = () => {
+            clearDebounceTimer();
+            debounceTimerId = setTimeout(() => {
+                flushPendingEvents();
+            }, debounceMs);
+        };
         const removeAllLifecycleListeners = () => {
             removeLifecycleListeners.splice(0).forEach((removeListener) => {
                 removeListener();
@@ -1874,7 +2123,7 @@
                 startUnixMs: now,
             };
         };
-        const sendEvent = (eventName, payload, sessionOverride) => {
+        const sendEvent = (eventName, payload, sessionOverride, options, forceImmediate = false) => {
             if (isDisabled || !url || !userPoolID) {
                 debugLog('Skipping esri track call', {
                     eventName,
@@ -1882,63 +2131,32 @@
                 });
                 return false;
             }
-            debugLog('Sending esri endpoint event', {
+            debugLog('Queueing esri endpoint event', {
                 eventName,
                 trackerName,
-                url,
-            });
-            void getCredentials(userPoolID, { fips })
-                .then((credentials) => {
-                const accessKeyId = (credentials === null || credentials === void 0 ? void 0 : credentials.AccessKeyId) || (credentials === null || credentials === void 0 ? void 0 : credentials.accessKeyId);
-                const secretAccessKey = (credentials === null || credentials === void 0 ? void 0 : credentials.SecretKey) || (credentials === null || credentials === void 0 ? void 0 : credentials.secretAccessKey);
-                const sessionToken = (credentials === null || credentials === void 0 ? void 0 : credentials.SessionToken) || (credentials === null || credentials === void 0 ? void 0 : credentials.sessionToken);
-                if (!accessKeyId || !secretAccessKey) {
-                    throw new Error('Signed endpoint credentials are missing required key fields.');
-                }
-                const client = new AwsClient({
-                    accessKeyId,
-                    secretAccessKey,
-                    sessionToken,
-                    service: ESRI_SIGNING_SERVICE,
-                    region: ESRI_SIGNING_REGION,
-                });
-                return client.fetch(url, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify(buildBatchEventPayload({
-                        eventName,
-                        payload: payload,
-                        trackerName,
-                        appName,
-                        appVersion,
-                        session: sessionOverride || activeSession,
-                    })),
-                });
-            })
-                .then(() => {
-                debugLog('Endpoint event sent', {
-                    eventName,
-                    trackerName,
-                });
-            })
-                .catch((error) => {
-                isDisabled = true;
-                clearIdleTimer();
-                removeAllLifecycleListeners();
-                warnOnce('Esri telemetry disabled after endpoint track failure', {
-                    eventName,
-                    trackerName,
-                    message: (error === null || error === void 0 ? void 0 : error.message) || String(error),
-                });
+                immediate: Boolean((options === null || options === void 0 ? void 0 : options.immediate) || forceImmediate),
             });
+            const queuedEvent = {
+                eventName,
+                payload: payload,
+                session: sessionOverride || activeSession,
+                browserInfo: getBrowserClientInfo(),
+                timestamp: new Date().toISOString(),
+                unixMs: Date.now(),
+            };
+            if ((options === null || options === void 0 ? void 0 : options.immediate) || forceImmediate) {
+                flushPendingEvents(queuedEvent);
+            }
+            else {
+                enqueueEvent(queuedEvent);
+                scheduleDebounceFlush();
+            }
             return true;
         };
         const sendSessionLifecycleEvent = (eventName, reason, sessionOverride) => {
             return sendEvent(eventName, {
                 reason,
-            }, sessionOverride);
+            }, sessionOverride, undefined, true);
         };
         const stopSession = (reason) => {
             if (!hasSessionStarted || sessionStopSent) {
@@ -2008,7 +2226,7 @@
             lifecycleListenersAttached = true;
         };
         return {
-            track: (eventName, payload) => {
+            track: (eventName, payload, options) => {
                 attachLifecycleListeners();
                 const isSessionStopEvent = eventName === SESSION_STOP_EVENT;
                 if (!hasSessionStarted &&
@@ -2033,7 +2251,7 @@
                     resetIdleTimer();
                 }
                 const sessionForEvent = activeSession;
-                const didSend = sendEvent(eventName, payload, sessionForEvent);
+                const didSend = sendEvent(eventName, payload, sessionForEvent, options, eventName === SESSION_START_EVENT || eventName === SESSION_STOP_EVENT);
                 if (isSessionStopEvent && didSend) {
                     activeSession = undefined;
                 }
@@ -2111,14 +2329,14 @@
             const result = this.analytics.track('pageView', telemetryPayload);
             return typeof result === 'boolean' ? result : true;
         }
-        logEvent(event = {}) {
+        logEvent(event = {}, trackOptions) {
             const telemetryPayload = createEventLog({
                 event,
                 dimensionLookup: this.dimensions,
                 metricLookup: this.metrics,
             });
             const { name } = telemetryPayload;
-            const result = this.analytics.track(name, telemetryPayload);
+            const result = this.analytics.track(name, telemetryPayload, trackOptions);
             return typeof result === 'boolean' ? result : true;
         }
     }