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

package/dist/umd/telemetry-amazon.min.js

@@ -1718,6 +1718,9 @@
     const ESRI_SIGNING_SERVICE = 'execute-api';
     const ESRI_SIGNING_REGION = 'us-east-1';
     const ESRI_ENDPOINT_URL = (appId) => `https://tedev.arcgis.com/v1/apps/${appId}/events`;
+    const SESSION_START_EVENT = '_session.start';
+    const SESSION_STOP_EVENT = '_session.stop';
+    const DEFAULT_IDLE_TIMEOUT_MS = 30 * 60 * 1000;
     /** Converts a string to a number, guarded against invalid values */
     function getNumber(value, fallback = 0) {
         const numeric = Number(value);
@@ -1759,11 +1762,17 @@
             metrics,
         };
     }
-    function buildBatchEventPayload({ eventName, payload, trackerName, appName, appVersion, }) {
+    function buildBatchEventPayload({ eventName, payload, trackerName, appName, appVersion, session, }) {
         var _a, _b, _c, _d;
         const endpointId = getEndpointId();
-        const sessionId = `${Date.now()}-${Math.random().toString(16).slice(2)}`;
         const timestamp = new Date().toISOString();
+        const sessionContext = session ||
+            {
+                id: `${Date.now()}-${Math.random().toString(16).slice(2)}`,
+                startTimestamp: timestamp,
+                startUnixMs: Date.now(),
+            };
+        const isStopEvent = eventName === SESSION_STOP_EVENT;
         const { attributes, metrics } = splitEventData(payload);
         return {
             BatchEvent: {
@@ -1790,10 +1799,12 @@
                         EventType: eventName,
                         Timestamp: timestamp,
                         Session: {
-                            Id: sessionId,
-                            StartTimestamp: timestamp,
+                            Id: sessionContext.id,
+                            StartTimestamp: sessionContext.startTimestamp,
                             EndTimestamp: timestamp,
-                            Duration: 0,
+                            Duration: isStopEvent
+                                ? Math.max(0, Date.now() - sessionContext.startUnixMs)
+                                : 0,
                         },
                         Attributes: attributes,
                         Metrics: metrics,
@@ -1806,6 +1817,13 @@
         const url = ESRI_ENDPOINT_URL(appId);
         let isDisabled = false;
         let hasWarned = false;
+        let hasSessionStarted = false;
+        let sessionStopSent = false;
+        let activeSession;
+        let idleTimerId;
+        let lifecycleListenersAttached = false;
+        const removeLifecycleListeners = [];
+        const isBrowser = typeof window !== 'undefined' && typeof document !== 'undefined';
         const warnOnce = (message, details) => {
             if (hasWarned) {
                 return;
@@ -1835,64 +1853,191 @@
                 trackerName,
             });
         }
-        return {
-            track: (eventName, payload) => {
-                if (isDisabled || !url || !userPoolID) {
-                    debugLog('Skipping esri track call', {
-                        eventName,
-                        reason: 'plugin-disabled',
-                    });
-                    return false;
-                }
-                debugLog('Sending esri endpoint event', {
+        const clearIdleTimer = () => {
+            if (!idleTimerId) {
+                return;
+            }
+            clearTimeout(idleTimerId);
+            idleTimerId = undefined;
+        };
+        const removeAllLifecycleListeners = () => {
+            removeLifecycleListeners.splice(0).forEach((removeListener) => {
+                removeListener();
+            });
+            lifecycleListenersAttached = false;
+        };
+        const createSession = () => {
+            const now = Date.now();
+            return {
+                id: `${now}-${Math.random().toString(16).slice(2)}`,
+                startTimestamp: new Date(now).toISOString(),
+                startUnixMs: now,
+            };
+        };
+        const sendEvent = (eventName, payload, sessionOverride) => {
+            if (isDisabled || !url || !userPoolID) {
+                debugLog('Skipping esri track call', {
                     eventName,
-                    trackerName,
-                    url,
+                    reason: 'plugin-disabled',
                 });
-                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,
-                        })),
-                    });
-                })
-                    .then(() => {
-                    debugLog('Endpoint event sent', {
-                        eventName,
-                        trackerName,
-                    });
-                })
-                    .catch((error) => {
-                    isDisabled = true;
-                    warnOnce('Esri telemetry disabled after endpoint track failure', {
+                return false;
+            }
+            debugLog('Sending 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,
-                        message: (error === null || error === void 0 ? void 0 : error.message) || String(error),
-                    });
+                        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),
                 });
-                return true;
+            });
+            return true;
+        };
+        const sendSessionLifecycleEvent = (eventName, reason, sessionOverride) => {
+            return sendEvent(eventName, {
+                reason,
+            }, sessionOverride);
+        };
+        const stopSession = (reason) => {
+            if (!hasSessionStarted || sessionStopSent) {
+                return false;
+            }
+            const sessionToStop = activeSession;
+            const didStop = sendSessionLifecycleEvent(SESSION_STOP_EVENT, reason, sessionToStop);
+            if (didStop) {
+                sessionStopSent = true;
+                hasSessionStarted = false;
+                clearIdleTimer();
+                activeSession = undefined;
+            }
+            return didStop;
+        };
+        const startSession = (reason) => {
+            if (hasSessionStarted) {
+                return false;
+            }
+            activeSession = activeSession || createSession();
+            const sessionToStart = activeSession;
+            const didStart = sendSessionLifecycleEvent(SESSION_START_EVENT, reason, sessionToStart);
+            if (didStart) {
+                hasSessionStarted = true;
+                sessionStopSent = false;
+            }
+            else {
+                activeSession = undefined;
+            }
+            return didStart;
+        };
+        const resetIdleTimer = () => {
+            if (!isBrowser || isDisabled || !hasSessionStarted) {
+                return;
+            }
+            clearIdleTimer();
+            idleTimerId = setTimeout(() => {
+                stopSession('idle');
+            }, DEFAULT_IDLE_TIMEOUT_MS);
+        };
+        const handleActivity = () => {
+            if (isDisabled) {
+                return;
+            }
+            if (!hasSessionStarted) {
+                startSession('wakeup');
+            }
+            resetIdleTimer();
+        };
+        const addLifecycleListener = (target, eventName, listener) => {
+            target.addEventListener(eventName, listener);
+            removeLifecycleListeners.push(() => {
+                target.removeEventListener(eventName, listener);
+            });
+        };
+        const attachLifecycleListeners = () => {
+            if (!isBrowser || lifecycleListenersAttached || isDisabled) {
+                return;
+            }
+            const activityEvents = ['pointerdown', 'keydown', 'scroll', 'focus'];
+            activityEvents.forEach((eventName) => {
+                addLifecycleListener(window, eventName, handleActivity);
+            });
+            addLifecycleListener(window, 'beforeunload', () => {
+                stopSession('beforeunload');
+            });
+            lifecycleListenersAttached = true;
+        };
+        return {
+            track: (eventName, payload) => {
+                attachLifecycleListeners();
+                const isSessionStopEvent = eventName === SESSION_STOP_EVENT;
+                if (!hasSessionStarted &&
+                    eventName !== SESSION_START_EVENT &&
+                    !isSessionStopEvent) {
+                    startSession('init');
+                }
+                if (eventName === SESSION_START_EVENT) {
+                    activeSession = activeSession || createSession();
+                    hasSessionStarted = true;
+                    sessionStopSent = false;
+                }
+                if (isSessionStopEvent) {
+                    sessionStopSent = true;
+                    hasSessionStarted = false;
+                    clearIdleTimer();
+                }
+                if (hasSessionStarted && !activeSession && !isSessionStopEvent) {
+                    activeSession = createSession();
+                }
+                if (hasSessionStarted && !isSessionStopEvent) {
+                    resetIdleTimer();
+                }
+                const sessionForEvent = activeSession;
+                const didSend = sendEvent(eventName, payload, sessionForEvent);
+                if (isSessionStopEvent && didSend) {
+                    activeSession = undefined;
+                }
+                return didSend;
             },
         };
     }