@grafana/faro-web-sdk 1.2.3 → 1.2.4

package/dist/types/instrumentations/session/instrumentation.d.ts

@@ -1,9 +1,9 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class SessionInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-session";
-    readonly version = "1.2.3";
+    readonly version = "1.2.4";
     private notifiedSession;
-    private sessionUpdater;
     private sendSessionStartEvent;
+    private getSessionManagerInstanceByConfiguredStrategy;
     initialize(): void;
 }

package/dist/types/instrumentations/session/sessionManager/PersistentSessionsManager.d.ts

@@ -0,0 +1,12 @@
+import type { FaroUserSession } from './types';
+export declare class PersistentSessionsManager {
+    private initialSessionId?;
+    private static storageTypeLocal;
+    private updateUserSession;
+    constructor(initialSessionId?: string | undefined);
+    static removeUserSession(): void;
+    static storeUserSession(session: FaroUserSession): void;
+    static fetchUserSession(): FaroUserSession | null;
+    updateSession: () => void;
+    private init;
+}

package/dist/types/instrumentations/session/sessionManager/VolatileSessionManager.d.ts

@@ -0,0 +1,12 @@
+import type { FaroUserSession } from './types';
+export declare class VolatileSessionsManager {
+    private initialSessionId?;
+    private static storageTypeSession;
+    private updateUserSession;
+    constructor(initialSessionId?: string | undefined);
+    static removeUserSession(): void;
+    static storeUserSession(session: FaroUserSession): void;
+    static fetchUserSession(): FaroUserSession | null;
+    updateSession: () => void;
+    private init;
+}

package/dist/types/instrumentations/session/sessionManager/index.d.ts

@@ -0,0 +1,3 @@
+export { PersistentSessionsManager } from './PersistentSessionsManager';
+export { VolatileSessionsManager } from './VolatileSessionManager';
+export type { FaroUserSession } from './types';

package/dist/types/instrumentations/session/sessionManager/sessionManagerUtils.d.ts

@@ -0,0 +1,16 @@
+import type { FaroUserSession } from './types';
+export declare const STORAGE_KEY = "__FARO_SESSION__";
+export declare const SESSION_EXPIRATION_TIME: number;
+export declare const SESSION_INACTIVITY_TIME: number;
+export declare const STORAGE_UPDATE_DELAY: number;
+export declare const MAX_SESSION_PERSISTENCE_TIME_BUFFER: number;
+export declare const MAX_SESSION_PERSISTENCE_TIME: number;
+export declare function createUserSessionObject(sessionId?: string): FaroUserSession;
+export declare function isUserSessionValid(session: FaroUserSession | null): boolean;
+type GetUserSessionUpdaterParams = {
+    storeUserSession: (session: FaroUserSession) => void;
+    fetchUserSession: () => FaroUserSession | null;
+};
+export declare function getUserSessionUpdater({ fetchUserSession, storeUserSession }: GetUserSessionUpdaterParams): () => void;
+export declare function addSessionMetadataToNextSession(newSession: FaroUserSession, previousSession: FaroUserSession | null): Required<FaroUserSession>;
+export {};

package/dist/types/instrumentations/session/sessionManager/types.d.ts

@@ -0,0 +1,7 @@
+import type { MetaSession } from '@grafana/faro-core';
+export interface FaroUserSession {
+    sessionId: string;
+    lastActivity: number;
+    started: number;
+    sessionMeta?: MetaSession;
+}

package/dist/types/instrumentations/view/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class ViewInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-view";
-    readonly version = "1.2.3";
+    readonly version = "1.2.4";
     private notifiedView;
     private sendViewChangedEvent;
     initialize(): void;

package/dist/types/instrumentations/webVitals/instrumentation.d.ts

@@ -1,7 +1,7 @@
 import { BaseInstrumentation } from '@grafana/faro-core';
 export declare class WebVitalsInstrumentation extends BaseInstrumentation {
     readonly name = "@grafana/faro-web-sdk:instrumentation-web-vitals";
-    readonly version = "1.2.3";
+    readonly version = "1.2.4";
     static mapping: {
         cls: (onReport: import("web-vitals").CLSReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;
         fcp: (onReport: import("web-vitals").FCPReportCallback, opts?: import("web-vitals").ReportOpts | undefined) => void;

package/dist/types/metas/index.d.ts

@@ -3,3 +3,4 @@ export { defaultMetas } from './const';
 export { pageMeta } from './page';
 export { createSession } from './session';
 export { defaultViewMeta } from './view';
+export { sdkMeta } from './sdk';

package/dist/types/metas/sdk/index.d.ts

@@ -0,0 +1 @@
+export { sdkMeta } from './meta';

package/dist/types/metas/sdk/meta.d.ts

@@ -0,0 +1,2 @@
+import type { Meta, MetaItem } from '@grafana/faro-core';
+export declare const sdkMeta: MetaItem<Pick<Meta, 'sdk'>>;

package/dist/types/transports/console/transport.d.ts

@@ -4,7 +4,7 @@ import type { ConsoleTransportOptions } from './types';
 export declare class ConsoleTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-console";
-    readonly version = "1.2.3";
+    readonly version = "1.2.4";
     constructor(options?: ConsoleTransportOptions);
     send(item: TransportItem): void;
 }

package/dist/types/transports/fetch/transport.d.ts

@@ -4,7 +4,7 @@ import type { FetchTransportOptions } from './types';
 export declare class FetchTransport extends BaseTransport {
     private options;
     readonly name = "@grafana/faro-web-sdk:transport-fetch";
-    readonly version = "1.2.3";
+    readonly version = "1.2.4";
     promiseBuffer: PromiseBuffer<Response | void>;
     private readonly rateLimitBackoffMs;
     private readonly getNow;

package/dist/types/utils/webStorage.d.ts

@@ -1,7 +1,33 @@
-type StorageMechanism = 'sessionStorage' | 'localStorage';
+export declare const webStorageType: {
+    readonly session: "sessionStorage";
+    readonly local: "localStorage";
+};
+type StorageMechanism = (typeof webStorageType)[keyof typeof webStorageType];
+/**
+ * Check if selected web storage mechanism is available.
+ * @param type storage mechanism to test availability for.
+ * @returns
+ */
 export declare function isWebStorageAvailable(type: StorageMechanism): boolean;
+/**
+ * Get item from SessionStorage or LocalStorage.
+ * @param key: the item key.
+ * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.
+ */
+export declare function getItem(key: string, webStorageMechanism: StorageMechanism): string | null;
+/**
+ * Store item in SessionStorage or LocalStorage.
+ * @param key: the item key.
+ * @param value: the item data.
+ * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.
+ */
+export declare function setItem(key: string, value: string, webStorageMechanism: StorageMechanism): void;
+/**
+ * Remove item from SessionStorage or LocalStorage.
+ * @param key: the item key.
+ * @param webStorageMechanism: wether the item shall be received form local storage or session storage. Defaults to local storage.
+ */
+export declare function removeItem(key: string, webStorageMechanism: StorageMechanism): void;
 export declare const isLocalStorageAvailable: boolean;
-export declare function getItem(key: string): string | null;
-export declare function setItem(key: string, value: string): void;
-export declare function removeItem(key: string): void;
+export declare const isSessionStorageAvailable: boolean;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-web-sdk",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Faro instrumentations, metas, transports for web.",
   "keywords": [
     "observability",
@@ -52,7 +52,7 @@
     "quality:circular-deps": "madge --circular ."
   },
   "dependencies": {
-    "@grafana/faro-core": "^1.2.3",
+    "@grafana/faro-core": "^1.2.4",
     "ua-parser-js": "^1.0.32",
     "web-vitals": "^3.1.1"
   },
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e15cdf130a4400c4e4f8d597b58a2dc7d488522a"
+  "gitHead": "72cda534dc953ddaa37a0192ef956ac6ea505962"
 }

package/dist/bundle/types/instrumentations/session/sessionHandler.d.ts

@@ -1,22 +0,0 @@
-import { MetaSession } from '@grafana/faro-core';
-export interface FaroUserSession {
-    sessionId: string;
-    lastActivity: number;
-    started: number;
-    sessionMeta?: MetaSession;
-}
-export interface UserSessionUpdater {
-    handleUpdate: () => void;
-    init: () => void;
-}
-export declare const SESSION_EXPIRATION_TIME: number;
-export declare const SESSION_INACTIVITY_TIME: number;
-export declare const STORAGE_KEY = "__FARO_SESSION__";
-export declare function createUserSessionObject(sessionId?: string): FaroUserSession;
-export declare function removeUserSession(): void;
-export declare function storeUserSession(session: FaroUserSession): void;
-export declare function fetchUserSession(): FaroUserSession | null;
-export declare function isUserSessionValid(session: FaroUserSession | null): boolean;
-export declare function persistentUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
-export declare function inMemoryUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
-export declare function getSessionUpdater(initialSessionId?: string): UserSessionUpdater;

package/dist/cjs/instrumentations/session/sessionHandler.js

@@ -1,170 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSessionUpdater = exports.inMemoryUserSessionsUpdater = exports.persistentUserSessionsUpdater = exports.isUserSessionValid = exports.fetchUserSession = exports.storeUserSession = exports.removeUserSession = exports.createUserSessionObject = exports.STORAGE_KEY = exports.SESSION_INACTIVITY_TIME = exports.SESSION_EXPIRATION_TIME = void 0;
-var faro_core_1 = require("@grafana/faro-core");
-var utils_1 = require("../../utils");
-var webStorage_1 = require("../../utils/webStorage");
-// TODO: make this configurable from the outside
-exports.SESSION_EXPIRATION_TIME = 4 * 60 * 60 * 1000; // n hrs
-exports.SESSION_INACTIVITY_TIME = 15 * 60 * 1000; // n minutes
-var STORAGE_UPDATE_DELAY = 1 * 1000; // n seconds
-exports.STORAGE_KEY = '__FARO_SESSION__';
-function createUserSessionObject(sessionId) {
-    var now = (0, faro_core_1.dateNow)();
-    return {
-        sessionId: sessionId !== null && sessionId !== void 0 ? sessionId : (0, faro_core_1.genShortID)(),
-        lastActivity: now,
-        started: now,
-    };
-}
-exports.createUserSessionObject = createUserSessionObject;
-function removeUserSession() {
-    (0, webStorage_1.removeItem)(exports.STORAGE_KEY);
-}
-exports.removeUserSession = removeUserSession;
-function storeUserSession(session) {
-    (0, webStorage_1.setItem)(exports.STORAGE_KEY, JSON.stringify(session));
-}
-exports.storeUserSession = storeUserSession;
-function fetchUserSession() {
-    var storedSession = (0, webStorage_1.getItem)(exports.STORAGE_KEY);
-    if (storedSession) {
-        return JSON.parse(storedSession);
-    }
-    return null;
-}
-exports.fetchUserSession = fetchUserSession;
-function isUserSessionValid(session) {
-    if (session == null) {
-        return false;
-    }
-    var now = (0, faro_core_1.dateNow)();
-    var lifetimeValid = now - session.started < exports.SESSION_EXPIRATION_TIME;
-    if (!lifetimeValid) {
-        return false;
-    }
-    var inactivityPeriodValid = now - session.lastActivity < exports.SESSION_INACTIVITY_TIME;
-    return inactivityPeriodValid;
-}
-exports.isUserSessionValid = isUserSessionValid;
-function persistentUserSessionsUpdater(initialSessionId) {
-    var throttledSessionUpdate = (0, utils_1.throttle)(function () {
-        var _a, _b, _c, _d, _e, _f;
-        var sessionFromLocalStorage = fetchUserSession();
-        if (isUserSessionValid(sessionFromLocalStorage)) {
-            storeUserSession(__assign(__assign({}, sessionFromLocalStorage), { lastActivity: (0, faro_core_1.dateNow)() }));
-        }
-        else {
-            var newSession = createUserSessionObject(); // create local srorage session
-            newSession = __assign(__assign({}, newSession), { sessionMeta: {
-                    id: newSession.sessionId,
-                    attributes: __assign(__assign({}, ((_b = (_a = faro_core_1.faro.metas.value.session) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), (sessionFromLocalStorage != null ? { previousSession: sessionFromLocalStorage.sessionId } : {})),
-                } });
-            storeUserSession(newSession);
-            (_c = faro_core_1.faro.api) === null || _c === void 0 ? void 0 : _c.setSession(newSession.sessionMeta);
-            (_e = (_d = faro_core_1.faro.config.experimentalSessions) === null || _d === void 0 ? void 0 : _d.onSessionChange) === null || _e === void 0 ? void 0 : _e.call(_d, (_f = sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionMeta) !== null && _f !== void 0 ? _f : null, newSession.sessionMeta);
-        }
-    }, STORAGE_UPDATE_DELAY);
-    function init() {
-        storeUserSession(createUserSessionObject(initialSessionId));
-        document.addEventListener('visibilitychange', function () {
-            if (document.visibilityState === 'visible') {
-                throttledSessionUpdate();
-            }
-        });
-        window.addEventListener('storage', function (event) {
-            var _a, _b, _c;
-            if (event.key !== exports.STORAGE_KEY) {
-                return;
-            }
-            var newSession = JSON.parse((_a = event.newValue) !== null && _a !== void 0 ? _a : '');
-            var previousSession = JSON.parse((_b = event.oldValue) !== null && _b !== void 0 ? _b : '');
-            if (newSession.sessionId !== previousSession.sessionId) {
-                (_c = faro_core_1.faro.api) === null || _c === void 0 ? void 0 : _c.setSession(newSession.sessionMeta);
-            }
-        });
-        // Users can call the setSession() method, so we need to sync this with the local storage session
-        faro_core_1.faro.metas.addListener(function syncSessionIfChangedExternally(meta) {
-            var _a, _b;
-            var session = meta.session;
-            var sessionFromLocalStorage = fetchUserSession();
-            if (session && session.id !== (sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionId)) {
-                var userSession = __assign(__assign({}, createUserSessionObject(session.id)), { sessionMeta: {
-                        id: session.id,
-                        attributes: __assign(__assign(__assign({}, ((_b = (_a = sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionMeta) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), session.attributes), (sessionFromLocalStorage ? { previousSession: sessionFromLocalStorage.sessionId } : {})),
-                    } });
-                storeUserSession(userSession);
-                faro_core_1.faro.api.setSession(userSession.sessionMeta);
-            }
-        });
-    }
-    return {
-        handleUpdate: throttledSessionUpdate,
-        init: init,
-    };
-}
-exports.persistentUserSessionsUpdater = persistentUserSessionsUpdater;
-function inMemoryUserSessionsUpdater(initialSessionId) {
-    var inMemoryUserSession = createUserSessionObject(initialSessionId);
-    function handleUpdate() {
-        var _a, _b, _c, _d, _e;
-        if (isUserSessionValid(inMemoryUserSession)) {
-            inMemoryUserSession.lastActivity = (0, faro_core_1.dateNow)();
-        }
-        else {
-            inMemoryUserSession = createUserSessionObject();
-            var previousSessionMeta = faro_core_1.faro.metas.value.session;
-            var newSessionMeta = {
-                id: inMemoryUserSession.sessionId,
-                attributes: __assign(__assign({}, ((_b = (_a = faro_core_1.faro.metas.value.session) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), ((previousSessionMeta === null || previousSessionMeta === void 0 ? void 0 : previousSessionMeta.id) ? { previousSession: previousSessionMeta.id } : {})),
-            };
-            (_d = (_c = faro_core_1.faro.config.experimentalSessions) === null || _c === void 0 ? void 0 : _c.onSessionChange) === null || _d === void 0 ? void 0 : _d.call(_c, previousSessionMeta !== null && previousSessionMeta !== void 0 ? previousSessionMeta : null, newSessionMeta);
-            (_e = faro_core_1.faro.api) === null || _e === void 0 ? void 0 : _e.setSession(newSessionMeta);
-        }
-    }
-    function init() {
-        document.addEventListener('visibilitychange', function () {
-            if (document.visibilityState === 'visible') {
-                handleUpdate();
-            }
-        });
-        // Users can call the setSession() method, so we need to sync this with the inMemoryUserSession
-        faro_core_1.faro.metas.addListener(function syncSessionIfChangedExternally(meta) {
-            var _a;
-            var session = meta.session;
-            if (session && session.id !== (inMemoryUserSession === null || inMemoryUserSession === void 0 ? void 0 : inMemoryUserSession.sessionId)) {
-                var previousSessionId = inMemoryUserSession.sessionId;
-                inMemoryUserSession = createUserSessionObject(session.id);
-                faro_core_1.faro.api.setSession({
-                    id: inMemoryUserSession.sessionId,
-                    attributes: __assign(__assign({}, ((_a = session.attributes) !== null && _a !== void 0 ? _a : {})), { previousSession: previousSessionId }),
-                });
-            }
-        });
-    }
-    return {
-        handleUpdate: handleUpdate,
-        init: init,
-    };
-}
-exports.inMemoryUserSessionsUpdater = inMemoryUserSessionsUpdater;
-function getSessionUpdater(initialSessionId) {
-    var _a;
-    if (((_a = faro_core_1.faro.config.experimentalSessions) === null || _a === void 0 ? void 0 : _a.persistent) && webStorage_1.isLocalStorageAvailable) {
-        return persistentUserSessionsUpdater(initialSessionId);
-    }
-    return inMemoryUserSessionsUpdater(initialSessionId);
-}
-exports.getSessionUpdater = getSessionUpdater;
-//# sourceMappingURL=sessionHandler.js.map

package/dist/cjs/instrumentations/session/sessionHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sessionHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/session/sessionHandler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,gDAAkF;AAElF,qCAAuC;AACvC,qDAA+F;AAa/F,gDAAgD;AACnC,QAAA,uBAAuB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AACtD,QAAA,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;AACnE,IAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,YAAY;AAEtC,QAAA,WAAW,GAAG,kBAAkB,CAAC;AAE9C,SAAgB,uBAAuB,CAAC,SAAkB;IACxD,IAAM,GAAG,GAAG,IAAA,mBAAO,GAAE,CAAC;IAEtB,OAAO;QACL,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAA,sBAAU,GAAE;QACpC,YAAY,EAAE,GAAG;QACjB,OAAO,EAAE,GAAG;KACb,CAAC;AACJ,CAAC;AARD,0DAQC;AAED,SAAgB,iBAAiB;IAC/B,IAAA,uBAAU,EAAC,mBAAW,CAAC,CAAC;AAC1B,CAAC;AAFD,8CAEC;AAED,SAAgB,gBAAgB,CAAC,OAAwB;IACvD,IAAA,oBAAO,EAAC,mBAAW,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AAChD,CAAC;AAFD,4CAEC;AAED,SAAgB,gBAAgB;IAC9B,IAAM,aAAa,GAAG,IAAA,oBAAO,EAAC,mBAAW,CAAC,CAAC;IAE3C,IAAI,aAAa,EAAE;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAoB,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AARD,4CAQC;AAED,SAAgB,kBAAkB,CAAC,OAA+B;IAChE,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,IAAM,GAAG,GAAG,IAAA,mBAAO,GAAE,CAAC;IACtB,IAAM,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,+BAAuB,CAAC;IAEtE,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IAED,IAAM,qBAAqB,GAAG,GAAG,GAAG,OAAO,CAAC,YAAY,GAAG,+BAAuB,CAAC;IACnF,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAdD,gDAcC;AAED,SAAgB,6BAA6B,CAAC,gBAAyB;IACrE,IAAM,sBAAsB,GAAG,IAAA,gBAAQ,EAAC;;QACtC,IAAM,uBAAuB,GAAG,gBAAgB,EAAE,CAAC;QAEnD,IAAI,kBAAkB,CAAC,uBAAuB,CAAC,EAAE;YAC/C,gBAAgB,uBAAM,uBAAwB,KAAE,YAAY,EAAE,IAAA,mBAAO,GAAE,IAAG,CAAC;SAC5E;aAAM;YACL,IAAI,UAAU,GAAG,uBAAuB,EAAE,CAAC,CAAC,+BAA+B;YAC3E,UAAU,yBACL,UAAU,KACb,WAAW,EAAE;oBACX,EAAE,EAAE,UAAU,CAAC,SAAS;oBACxB,UAAU,wBACL,CAAC,MAAA,MAAA,gBAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,0CAAE,UAAU,mCAAI,EAAE,CAAC,GAC5C,CAAC,uBAAuB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,uBAAuB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACnG;iBACF,GACF,CAAC;YAEF,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAE7B,MAAA,gBAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC7C,MAAA,MAAA,gBAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,eAAe,mDAC/C,MAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,WAAW,mCAAI,IAAI,EAC5C,UAAU,CAAC,WAAY,CACxB,CAAC;SACH;IACH,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,SAAS,IAAI;QACX,gBAAgB,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAE5D,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE;YAC5C,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE;gBAC1C,sBAAsB,EAAE,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAC,KAAmB;;YACrD,IAAI,KAAK,CAAC,GAAG,KAAK,mBAAW,EAAE;gBAC7B,OAAO;aACR;YAED,IAAM,UAAU,GAAoB,IAAI,CAAC,KAAK,CAAC,MAAA,KAAK,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;YACrE,IAAM,eAAe,GAAoB,IAAI,CAAC,KAAK,CAAC,MAAA,KAAK,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;YAE1E,IAAI,UAAU,CAAC,SAAS,KAAK,eAAe,CAAC,SAAS,EAAE;gBACtD,MAAA,gBAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;QAEH,iGAAiG;QACjG,gBAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,8BAA8B,CAAC,IAAU;;YACvE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,IAAM,uBAAuB,GAAG,gBAAgB,EAAE,CAAC;YAEnD,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,MAAK,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,SAAS,CAAA,EAAE;gBAChE,IAAM,WAAW,yBACZ,uBAAuB,CAAC,OAAO,CAAC,EAAE,CAAC,KACtC,WAAW,EAAE;wBACX,EAAE,EAAE,OAAO,CAAC,EAAE;wBACd,UAAU,iCACL,CAAC,MAAA,MAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,WAAW,0CAAE,UAAU,mCAAI,EAAE,CAAC,GACxD,OAAO,CAAC,UAAU,GAClB,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,uBAAuB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC3F;qBACF,GACF,CAAC;gBAEF,gBAAgB,CAAC,WAAW,CAAC,CAAC;gBAC9B,gBAAI,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,YAAY,EAAE,sBAAsB;QACpC,IAAI,MAAA;KACL,CAAC;AACJ,CAAC;AA/ED,sEA+EC;AAED,SAAgB,2BAA2B,CAAC,gBAAyB;IACnE,IAAI,mBAAmB,GAAoB,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IAErF,SAAS,YAAY;;QACnB,IAAI,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;YAC3C,mBAAmB,CAAC,YAAY,GAAG,IAAA,mBAAO,GAAE,CAAC;SAC9C;aAAM;YACL,mBAAmB,GAAG,uBAAuB,EAAE,CAAC;YAEhD,IAAM,mBAAmB,GAAG,gBAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;YACrD,IAAM,cAAc,GAAG;gBACrB,EAAE,EAAE,mBAAmB,CAAC,SAAS;gBACjC,UAAU,wBACL,CAAC,MAAA,MAAA,gBAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,0CAAE,UAAU,mCAAI,EAAE,CAAC,GAC5C,CAAC,CAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,EAAE,EAAC,CAAC,CAAC,EAAE,eAAe,EAAE,mBAAmB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChF;aACF,CAAC;YAEF,MAAA,MAAA,gBAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,eAAe,mDAAG,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,IAAI,EAAE,cAAc,CAAC,CAAC;YAEjG,MAAA,gBAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,cAAc,CAAC,CAAC;SACtC;IACH,CAAC;IAED,SAAS,IAAI;QACX,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE;YAC5C,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE;gBAC1C,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;QAEH,+FAA+F;QAC/F,gBAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,8BAA8B,CAAC,IAAU;;YACvE,IAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE7B,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,MAAK,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,SAAS,CAAA,EAAE;gBAC5D,IAAM,iBAAiB,GAAG,mBAAmB,CAAC,SAAS,CAAC;gBACxD,mBAAmB,GAAG,uBAAuB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAE1D,gBAAI,CAAC,GAAG,CAAC,UAAU,CAAC;oBAClB,EAAE,EAAE,mBAAmB,CAAC,SAAS;oBACjC,UAAU,wBACL,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CAAC,KAC7B,eAAe,EAAE,iBAAiB,GACnC;iBACF,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,YAAY,cAAA;QACZ,IAAI,MAAA;KACL,CAAC;AACJ,CAAC;AAtDD,kEAsDC;AAED,SAAgB,iBAAiB,CAAC,gBAAyB;;IACzD,IAAI,CAAA,MAAA,gBAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,UAAU,KAAI,oCAAuB,EAAE;QAC3E,OAAO,6BAA6B,CAAC,gBAAgB,CAAC,CAAC;KACxD;IAED,OAAO,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;AACvD,CAAC;AAND,8CAMC","sourcesContent":["import { dateNow, faro, genShortID, Meta, MetaSession } from '@grafana/faro-core';\n\nimport { throttle } from '../../utils';\nimport { getItem, isLocalStorageAvailable, removeItem, setItem } from '../../utils/webStorage';\n\nexport interface FaroUserSession {\n  sessionId: string;\n  lastActivity: number;\n  started: number;\n  sessionMeta?: MetaSession;\n}\nexport interface UserSessionUpdater {\n  handleUpdate: () => void;\n  init: () => void;\n}\n\n// TODO: make this configurable from the outside\nexport const SESSION_EXPIRATION_TIME = 4 * 60 * 60 * 1000; // n hrs\nexport const SESSION_INACTIVITY_TIME = 15 * 60 * 1000; // n minutes\nconst STORAGE_UPDATE_DELAY = 1 * 1000; // n seconds\n\nexport const STORAGE_KEY = '__FARO_SESSION__';\n\nexport function createUserSessionObject(sessionId?: string): FaroUserSession {\n  const now = dateNow();\n\n  return {\n    sessionId: sessionId ?? genShortID(),\n    lastActivity: now,\n    started: now,\n  };\n}\n\nexport function removeUserSession() {\n  removeItem(STORAGE_KEY);\n}\n\nexport function storeUserSession(session: FaroUserSession): void {\n  setItem(STORAGE_KEY, JSON.stringify(session));\n}\n\nexport function fetchUserSession(): FaroUserSession | null {\n  const storedSession = getItem(STORAGE_KEY);\n\n  if (storedSession) {\n    return JSON.parse(storedSession) as FaroUserSession;\n  }\n\n  return null;\n}\n\nexport function isUserSessionValid(session: FaroUserSession | null): boolean {\n  if (session == null) {\n    return false;\n  }\n\n  const now = dateNow();\n  const lifetimeValid = now - session.started < SESSION_EXPIRATION_TIME;\n\n  if (!lifetimeValid) {\n    return false;\n  }\n\n  const inactivityPeriodValid = now - session.lastActivity < SESSION_INACTIVITY_TIME;\n  return inactivityPeriodValid;\n}\n\nexport function persistentUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater {\n  const throttledSessionUpdate = throttle(() => {\n    const sessionFromLocalStorage = fetchUserSession();\n\n    if (isUserSessionValid(sessionFromLocalStorage)) {\n      storeUserSession({ ...sessionFromLocalStorage!, lastActivity: dateNow() });\n    } else {\n      let newSession = createUserSessionObject(); // create local srorage session\n      newSession = {\n        ...newSession,\n        sessionMeta: {\n          id: newSession.sessionId,\n          attributes: {\n            ...(faro.metas.value.session?.attributes ?? {}),\n            ...(sessionFromLocalStorage != null ? { previousSession: sessionFromLocalStorage.sessionId } : {}),\n          },\n        },\n      };\n\n      storeUserSession(newSession);\n\n      faro.api?.setSession(newSession.sessionMeta);\n      faro.config.experimentalSessions?.onSessionChange?.(\n        sessionFromLocalStorage?.sessionMeta ?? null,\n        newSession.sessionMeta!\n      );\n    }\n  }, STORAGE_UPDATE_DELAY);\n\n  function init() {\n    storeUserSession(createUserSessionObject(initialSessionId));\n\n    document.addEventListener('visibilitychange', () => {\n      if (document.visibilityState === 'visible') {\n        throttledSessionUpdate();\n      }\n    });\n\n    window.addEventListener('storage', (event: StorageEvent) => {\n      if (event.key !== STORAGE_KEY) {\n        return;\n      }\n\n      const newSession: FaroUserSession = JSON.parse(event.newValue ?? '');\n      const previousSession: FaroUserSession = JSON.parse(event.oldValue ?? '');\n\n      if (newSession.sessionId !== previousSession.sessionId) {\n        faro.api?.setSession(newSession.sessionMeta);\n      }\n    });\n\n    // Users can call the setSession() method, so we need to sync this with the local storage session\n    faro.metas.addListener(function syncSessionIfChangedExternally(meta: Meta) {\n      const session = meta.session;\n      const sessionFromLocalStorage = fetchUserSession();\n\n      if (session && session.id !== sessionFromLocalStorage?.sessionId) {\n        const userSession = {\n          ...createUserSessionObject(session.id),\n          sessionMeta: {\n            id: session.id,\n            attributes: {\n              ...(sessionFromLocalStorage?.sessionMeta?.attributes ?? {}),\n              ...session.attributes,\n              ...(sessionFromLocalStorage ? { previousSession: sessionFromLocalStorage.sessionId } : {}),\n            },\n          },\n        };\n\n        storeUserSession(userSession);\n        faro.api.setSession(userSession.sessionMeta);\n      }\n    });\n  }\n\n  return {\n    handleUpdate: throttledSessionUpdate,\n    init,\n  };\n}\n\nexport function inMemoryUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater {\n  let inMemoryUserSession: FaroUserSession = createUserSessionObject(initialSessionId);\n\n  function handleUpdate() {\n    if (isUserSessionValid(inMemoryUserSession)) {\n      inMemoryUserSession.lastActivity = dateNow();\n    } else {\n      inMemoryUserSession = createUserSessionObject();\n\n      const previousSessionMeta = faro.metas.value.session;\n      const newSessionMeta = {\n        id: inMemoryUserSession.sessionId,\n        attributes: {\n          ...(faro.metas.value.session?.attributes ?? {}),\n          ...(previousSessionMeta?.id ? { previousSession: previousSessionMeta.id } : {}),\n        },\n      };\n\n      faro.config.experimentalSessions?.onSessionChange?.(previousSessionMeta ?? null, newSessionMeta);\n\n      faro.api?.setSession(newSessionMeta);\n    }\n  }\n\n  function init() {\n    document.addEventListener('visibilitychange', () => {\n      if (document.visibilityState === 'visible') {\n        handleUpdate();\n      }\n    });\n\n    // Users can call the setSession() method, so we need to sync this with the inMemoryUserSession\n    faro.metas.addListener(function syncSessionIfChangedExternally(meta: Meta) {\n      const session = meta.session;\n\n      if (session && session.id !== inMemoryUserSession?.sessionId) {\n        const previousSessionId = inMemoryUserSession.sessionId;\n        inMemoryUserSession = createUserSessionObject(session.id);\n\n        faro.api.setSession({\n          id: inMemoryUserSession.sessionId,\n          attributes: {\n            ...(session.attributes ?? {}),\n            previousSession: previousSessionId,\n          },\n        });\n      }\n    });\n  }\n\n  return {\n    handleUpdate,\n    init,\n  };\n}\n\nexport function getSessionUpdater(initialSessionId?: string): UserSessionUpdater {\n  if (faro.config.experimentalSessions?.persistent && isLocalStorageAvailable) {\n    return persistentUserSessionsUpdater(initialSessionId);\n  }\n\n  return inMemoryUserSessionsUpdater(initialSessionId);\n}\n"]}

package/dist/esm/instrumentations/session/sessionHandler.js

@@ -1,148 +0,0 @@
-import { dateNow, faro, genShortID } from '@grafana/faro-core';
-import { throttle } from '../../utils';
-import { getItem, isLocalStorageAvailable, removeItem, setItem } from '../../utils/webStorage';
-// TODO: make this configurable from the outside
-export const SESSION_EXPIRATION_TIME = 4 * 60 * 60 * 1000; // n hrs
-export const SESSION_INACTIVITY_TIME = 15 * 60 * 1000; // n minutes
-const STORAGE_UPDATE_DELAY = 1 * 1000; // n seconds
-export const STORAGE_KEY = '__FARO_SESSION__';
-export function createUserSessionObject(sessionId) {
-    const now = dateNow();
-    return {
-        sessionId: sessionId !== null && sessionId !== void 0 ? sessionId : genShortID(),
-        lastActivity: now,
-        started: now,
-    };
-}
-export function removeUserSession() {
-    removeItem(STORAGE_KEY);
-}
-export function storeUserSession(session) {
-    setItem(STORAGE_KEY, JSON.stringify(session));
-}
-export function fetchUserSession() {
-    const storedSession = getItem(STORAGE_KEY);
-    if (storedSession) {
-        return JSON.parse(storedSession);
-    }
-    return null;
-}
-export function isUserSessionValid(session) {
-    if (session == null) {
-        return false;
-    }
-    const now = dateNow();
-    const lifetimeValid = now - session.started < SESSION_EXPIRATION_TIME;
-    if (!lifetimeValid) {
-        return false;
-    }
-    const inactivityPeriodValid = now - session.lastActivity < SESSION_INACTIVITY_TIME;
-    return inactivityPeriodValid;
-}
-export function persistentUserSessionsUpdater(initialSessionId) {
-    const throttledSessionUpdate = throttle(() => {
-        var _a, _b, _c, _d, _e, _f;
-        const sessionFromLocalStorage = fetchUserSession();
-        if (isUserSessionValid(sessionFromLocalStorage)) {
-            storeUserSession(Object.assign(Object.assign({}, sessionFromLocalStorage), { lastActivity: dateNow() }));
-        }
-        else {
-            let newSession = createUserSessionObject(); // create local srorage session
-            newSession = Object.assign(Object.assign({}, newSession), { sessionMeta: {
-                    id: newSession.sessionId,
-                    attributes: Object.assign(Object.assign({}, ((_b = (_a = faro.metas.value.session) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), (sessionFromLocalStorage != null ? { previousSession: sessionFromLocalStorage.sessionId } : {})),
-                } });
-            storeUserSession(newSession);
-            (_c = faro.api) === null || _c === void 0 ? void 0 : _c.setSession(newSession.sessionMeta);
-            (_e = (_d = faro.config.experimentalSessions) === null || _d === void 0 ? void 0 : _d.onSessionChange) === null || _e === void 0 ? void 0 : _e.call(_d, (_f = sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionMeta) !== null && _f !== void 0 ? _f : null, newSession.sessionMeta);
-        }
-    }, STORAGE_UPDATE_DELAY);
-    function init() {
-        storeUserSession(createUserSessionObject(initialSessionId));
-        document.addEventListener('visibilitychange', () => {
-            if (document.visibilityState === 'visible') {
-                throttledSessionUpdate();
-            }
-        });
-        window.addEventListener('storage', (event) => {
-            var _a, _b, _c;
-            if (event.key !== STORAGE_KEY) {
-                return;
-            }
-            const newSession = JSON.parse((_a = event.newValue) !== null && _a !== void 0 ? _a : '');
-            const previousSession = JSON.parse((_b = event.oldValue) !== null && _b !== void 0 ? _b : '');
-            if (newSession.sessionId !== previousSession.sessionId) {
-                (_c = faro.api) === null || _c === void 0 ? void 0 : _c.setSession(newSession.sessionMeta);
-            }
-        });
-        // Users can call the setSession() method, so we need to sync this with the local storage session
-        faro.metas.addListener(function syncSessionIfChangedExternally(meta) {
-            var _a, _b;
-            const session = meta.session;
-            const sessionFromLocalStorage = fetchUserSession();
-            if (session && session.id !== (sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionId)) {
-                const userSession = Object.assign(Object.assign({}, createUserSessionObject(session.id)), { sessionMeta: {
-                        id: session.id,
-                        attributes: Object.assign(Object.assign(Object.assign({}, ((_b = (_a = sessionFromLocalStorage === null || sessionFromLocalStorage === void 0 ? void 0 : sessionFromLocalStorage.sessionMeta) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), session.attributes), (sessionFromLocalStorage ? { previousSession: sessionFromLocalStorage.sessionId } : {})),
-                    } });
-                storeUserSession(userSession);
-                faro.api.setSession(userSession.sessionMeta);
-            }
-        });
-    }
-    return {
-        handleUpdate: throttledSessionUpdate,
-        init,
-    };
-}
-export function inMemoryUserSessionsUpdater(initialSessionId) {
-    let inMemoryUserSession = createUserSessionObject(initialSessionId);
-    function handleUpdate() {
-        var _a, _b, _c, _d, _e;
-        if (isUserSessionValid(inMemoryUserSession)) {
-            inMemoryUserSession.lastActivity = dateNow();
-        }
-        else {
-            inMemoryUserSession = createUserSessionObject();
-            const previousSessionMeta = faro.metas.value.session;
-            const newSessionMeta = {
-                id: inMemoryUserSession.sessionId,
-                attributes: Object.assign(Object.assign({}, ((_b = (_a = faro.metas.value.session) === null || _a === void 0 ? void 0 : _a.attributes) !== null && _b !== void 0 ? _b : {})), ((previousSessionMeta === null || previousSessionMeta === void 0 ? void 0 : previousSessionMeta.id) ? { previousSession: previousSessionMeta.id } : {})),
-            };
-            (_d = (_c = faro.config.experimentalSessions) === null || _c === void 0 ? void 0 : _c.onSessionChange) === null || _d === void 0 ? void 0 : _d.call(_c, previousSessionMeta !== null && previousSessionMeta !== void 0 ? previousSessionMeta : null, newSessionMeta);
-            (_e = faro.api) === null || _e === void 0 ? void 0 : _e.setSession(newSessionMeta);
-        }
-    }
-    function init() {
-        document.addEventListener('visibilitychange', () => {
-            if (document.visibilityState === 'visible') {
-                handleUpdate();
-            }
-        });
-        // Users can call the setSession() method, so we need to sync this with the inMemoryUserSession
-        faro.metas.addListener(function syncSessionIfChangedExternally(meta) {
-            var _a;
-            const session = meta.session;
-            if (session && session.id !== (inMemoryUserSession === null || inMemoryUserSession === void 0 ? void 0 : inMemoryUserSession.sessionId)) {
-                const previousSessionId = inMemoryUserSession.sessionId;
-                inMemoryUserSession = createUserSessionObject(session.id);
-                faro.api.setSession({
-                    id: inMemoryUserSession.sessionId,
-                    attributes: Object.assign(Object.assign({}, ((_a = session.attributes) !== null && _a !== void 0 ? _a : {})), { previousSession: previousSessionId }),
-                });
-            }
-        });
-    }
-    return {
-        handleUpdate,
-        init,
-    };
-}
-export function getSessionUpdater(initialSessionId) {
-    var _a;
-    if (((_a = faro.config.experimentalSessions) === null || _a === void 0 ? void 0 : _a.persistent) && isLocalStorageAvailable) {
-        return persistentUserSessionsUpdater(initialSessionId);
-    }
-    return inMemoryUserSessionsUpdater(initialSessionId);
-}
-//# sourceMappingURL=sessionHandler.js.map

package/dist/esm/instrumentations/session/sessionHandler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sessionHandler.js","sourceRoot":"","sources":["../../../../src/instrumentations/session/sessionHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAqB,MAAM,oBAAoB,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAa/F,gDAAgD;AAChD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,YAAY;AACnE,MAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,YAAY;AAEnD,MAAM,CAAC,MAAM,WAAW,GAAG,kBAAkB,CAAC;AAE9C,MAAM,UAAU,uBAAuB,CAAC,SAAkB;IACxD,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IAEtB,OAAO;QACL,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,UAAU,EAAE;QACpC,YAAY,EAAE,GAAG;QACjB,OAAO,EAAE,GAAG;KACb,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,UAAU,CAAC,WAAW,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAwB;IACvD,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3C,IAAI,aAAa,EAAE;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAoB,CAAC;KACrD;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA+B;IAChE,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,MAAM,aAAa,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,GAAG,uBAAuB,CAAC;IAEtE,IAAI,CAAC,aAAa,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IAED,MAAM,qBAAqB,GAAG,GAAG,GAAG,OAAO,CAAC,YAAY,GAAG,uBAAuB,CAAC;IACnF,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,gBAAyB;IACrE,MAAM,sBAAsB,GAAG,QAAQ,CAAC,GAAG,EAAE;;QAC3C,MAAM,uBAAuB,GAAG,gBAAgB,EAAE,CAAC;QAEnD,IAAI,kBAAkB,CAAC,uBAAuB,CAAC,EAAE;YAC/C,gBAAgB,iCAAM,uBAAwB,KAAE,YAAY,EAAE,OAAO,EAAE,IAAG,CAAC;SAC5E;aAAM;YACL,IAAI,UAAU,GAAG,uBAAuB,EAAE,CAAC,CAAC,+BAA+B;YAC3E,UAAU,mCACL,UAAU,KACb,WAAW,EAAE;oBACX,EAAE,EAAE,UAAU,CAAC,SAAS;oBACxB,UAAU,kCACL,CAAC,MAAA,MAAA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,0CAAE,UAAU,mCAAI,EAAE,CAAC,GAC5C,CAAC,uBAAuB,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,uBAAuB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACnG;iBACF,GACF,CAAC;YAEF,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAE7B,MAAA,IAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC7C,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,eAAe,mDAC/C,MAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,WAAW,mCAAI,IAAI,EAC5C,UAAU,CAAC,WAAY,CACxB,CAAC;SACH;IACH,CAAC,EAAE,oBAAoB,CAAC,CAAC;IAEzB,SAAS,IAAI;QACX,gBAAgB,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAE5D,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,GAAG,EAAE;YACjD,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE;gBAC1C,sBAAsB,EAAE,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAmB,EAAE,EAAE;;YACzD,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,EAAE;gBAC7B,OAAO;aACR;YAED,MAAM,UAAU,GAAoB,IAAI,CAAC,KAAK,CAAC,MAAA,KAAK,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;YACrE,MAAM,eAAe,GAAoB,IAAI,CAAC,KAAK,CAAC,MAAA,KAAK,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;YAE1E,IAAI,UAAU,CAAC,SAAS,KAAK,eAAe,CAAC,SAAS,EAAE;gBACtD,MAAA,IAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;QAEH,iGAAiG;QACjG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,8BAA8B,CAAC,IAAU;;YACvE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,MAAM,uBAAuB,GAAG,gBAAgB,EAAE,CAAC;YAEnD,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,MAAK,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,SAAS,CAAA,EAAE;gBAChE,MAAM,WAAW,mCACZ,uBAAuB,CAAC,OAAO,CAAC,EAAE,CAAC,KACtC,WAAW,EAAE;wBACX,EAAE,EAAE,OAAO,CAAC,EAAE;wBACd,UAAU,gDACL,CAAC,MAAA,MAAA,uBAAuB,aAAvB,uBAAuB,uBAAvB,uBAAuB,CAAE,WAAW,0CAAE,UAAU,mCAAI,EAAE,CAAC,GACxD,OAAO,CAAC,UAAU,GAClB,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,uBAAuB,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC3F;qBACF,GACF,CAAC;gBAEF,gBAAgB,CAAC,WAAW,CAAC,CAAC;gBAC9B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;aAC9C;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,YAAY,EAAE,sBAAsB;QACpC,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,gBAAyB;IACnE,IAAI,mBAAmB,GAAoB,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;IAErF,SAAS,YAAY;;QACnB,IAAI,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;YAC3C,mBAAmB,CAAC,YAAY,GAAG,OAAO,EAAE,CAAC;SAC9C;aAAM;YACL,mBAAmB,GAAG,uBAAuB,EAAE,CAAC;YAEhD,MAAM,mBAAmB,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;YACrD,MAAM,cAAc,GAAG;gBACrB,EAAE,EAAE,mBAAmB,CAAC,SAAS;gBACjC,UAAU,kCACL,CAAC,MAAA,MAAA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,0CAAE,UAAU,mCAAI,EAAE,CAAC,GAC5C,CAAC,CAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,EAAE,EAAC,CAAC,CAAC,EAAE,eAAe,EAAE,mBAAmB,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChF;aACF,CAAC;YAEF,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,eAAe,mDAAG,mBAAmB,aAAnB,mBAAmB,cAAnB,mBAAmB,GAAI,IAAI,EAAE,cAAc,CAAC,CAAC;YAEjG,MAAA,IAAI,CAAC,GAAG,0CAAE,UAAU,CAAC,cAAc,CAAC,CAAC;SACtC;IACH,CAAC;IAED,SAAS,IAAI;QACX,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,GAAG,EAAE;YACjD,IAAI,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE;gBAC1C,YAAY,EAAE,CAAC;aAChB;QACH,CAAC,CAAC,CAAC;QAEH,+FAA+F;QAC/F,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,8BAA8B,CAAC,IAAU;;YACvE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAE7B,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE,MAAK,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,SAAS,CAAA,EAAE;gBAC5D,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,SAAS,CAAC;gBACxD,mBAAmB,GAAG,uBAAuB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;gBAE1D,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC;oBAClB,EAAE,EAAE,mBAAmB,CAAC,SAAS;oBACjC,UAAU,kCACL,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,EAAE,CAAC,KAC7B,eAAe,EAAE,iBAAiB,GACnC;iBACF,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,YAAY;QACZ,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,gBAAyB;;IACzD,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,CAAC,oBAAoB,0CAAE,UAAU,KAAI,uBAAuB,EAAE;QAC3E,OAAO,6BAA6B,CAAC,gBAAgB,CAAC,CAAC;KACxD;IAED,OAAO,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;AACvD,CAAC","sourcesContent":["import { dateNow, faro, genShortID, Meta, MetaSession } from '@grafana/faro-core';\n\nimport { throttle } from '../../utils';\nimport { getItem, isLocalStorageAvailable, removeItem, setItem } from '../../utils/webStorage';\n\nexport interface FaroUserSession {\n  sessionId: string;\n  lastActivity: number;\n  started: number;\n  sessionMeta?: MetaSession;\n}\nexport interface UserSessionUpdater {\n  handleUpdate: () => void;\n  init: () => void;\n}\n\n// TODO: make this configurable from the outside\nexport const SESSION_EXPIRATION_TIME = 4 * 60 * 60 * 1000; // n hrs\nexport const SESSION_INACTIVITY_TIME = 15 * 60 * 1000; // n minutes\nconst STORAGE_UPDATE_DELAY = 1 * 1000; // n seconds\n\nexport const STORAGE_KEY = '__FARO_SESSION__';\n\nexport function createUserSessionObject(sessionId?: string): FaroUserSession {\n  const now = dateNow();\n\n  return {\n    sessionId: sessionId ?? genShortID(),\n    lastActivity: now,\n    started: now,\n  };\n}\n\nexport function removeUserSession() {\n  removeItem(STORAGE_KEY);\n}\n\nexport function storeUserSession(session: FaroUserSession): void {\n  setItem(STORAGE_KEY, JSON.stringify(session));\n}\n\nexport function fetchUserSession(): FaroUserSession | null {\n  const storedSession = getItem(STORAGE_KEY);\n\n  if (storedSession) {\n    return JSON.parse(storedSession) as FaroUserSession;\n  }\n\n  return null;\n}\n\nexport function isUserSessionValid(session: FaroUserSession | null): boolean {\n  if (session == null) {\n    return false;\n  }\n\n  const now = dateNow();\n  const lifetimeValid = now - session.started < SESSION_EXPIRATION_TIME;\n\n  if (!lifetimeValid) {\n    return false;\n  }\n\n  const inactivityPeriodValid = now - session.lastActivity < SESSION_INACTIVITY_TIME;\n  return inactivityPeriodValid;\n}\n\nexport function persistentUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater {\n  const throttledSessionUpdate = throttle(() => {\n    const sessionFromLocalStorage = fetchUserSession();\n\n    if (isUserSessionValid(sessionFromLocalStorage)) {\n      storeUserSession({ ...sessionFromLocalStorage!, lastActivity: dateNow() });\n    } else {\n      let newSession = createUserSessionObject(); // create local srorage session\n      newSession = {\n        ...newSession,\n        sessionMeta: {\n          id: newSession.sessionId,\n          attributes: {\n            ...(faro.metas.value.session?.attributes ?? {}),\n            ...(sessionFromLocalStorage != null ? { previousSession: sessionFromLocalStorage.sessionId } : {}),\n          },\n        },\n      };\n\n      storeUserSession(newSession);\n\n      faro.api?.setSession(newSession.sessionMeta);\n      faro.config.experimentalSessions?.onSessionChange?.(\n        sessionFromLocalStorage?.sessionMeta ?? null,\n        newSession.sessionMeta!\n      );\n    }\n  }, STORAGE_UPDATE_DELAY);\n\n  function init() {\n    storeUserSession(createUserSessionObject(initialSessionId));\n\n    document.addEventListener('visibilitychange', () => {\n      if (document.visibilityState === 'visible') {\n        throttledSessionUpdate();\n      }\n    });\n\n    window.addEventListener('storage', (event: StorageEvent) => {\n      if (event.key !== STORAGE_KEY) {\n        return;\n      }\n\n      const newSession: FaroUserSession = JSON.parse(event.newValue ?? '');\n      const previousSession: FaroUserSession = JSON.parse(event.oldValue ?? '');\n\n      if (newSession.sessionId !== previousSession.sessionId) {\n        faro.api?.setSession(newSession.sessionMeta);\n      }\n    });\n\n    // Users can call the setSession() method, so we need to sync this with the local storage session\n    faro.metas.addListener(function syncSessionIfChangedExternally(meta: Meta) {\n      const session = meta.session;\n      const sessionFromLocalStorage = fetchUserSession();\n\n      if (session && session.id !== sessionFromLocalStorage?.sessionId) {\n        const userSession = {\n          ...createUserSessionObject(session.id),\n          sessionMeta: {\n            id: session.id,\n            attributes: {\n              ...(sessionFromLocalStorage?.sessionMeta?.attributes ?? {}),\n              ...session.attributes,\n              ...(sessionFromLocalStorage ? { previousSession: sessionFromLocalStorage.sessionId } : {}),\n            },\n          },\n        };\n\n        storeUserSession(userSession);\n        faro.api.setSession(userSession.sessionMeta);\n      }\n    });\n  }\n\n  return {\n    handleUpdate: throttledSessionUpdate,\n    init,\n  };\n}\n\nexport function inMemoryUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater {\n  let inMemoryUserSession: FaroUserSession = createUserSessionObject(initialSessionId);\n\n  function handleUpdate() {\n    if (isUserSessionValid(inMemoryUserSession)) {\n      inMemoryUserSession.lastActivity = dateNow();\n    } else {\n      inMemoryUserSession = createUserSessionObject();\n\n      const previousSessionMeta = faro.metas.value.session;\n      const newSessionMeta = {\n        id: inMemoryUserSession.sessionId,\n        attributes: {\n          ...(faro.metas.value.session?.attributes ?? {}),\n          ...(previousSessionMeta?.id ? { previousSession: previousSessionMeta.id } : {}),\n        },\n      };\n\n      faro.config.experimentalSessions?.onSessionChange?.(previousSessionMeta ?? null, newSessionMeta);\n\n      faro.api?.setSession(newSessionMeta);\n    }\n  }\n\n  function init() {\n    document.addEventListener('visibilitychange', () => {\n      if (document.visibilityState === 'visible') {\n        handleUpdate();\n      }\n    });\n\n    // Users can call the setSession() method, so we need to sync this with the inMemoryUserSession\n    faro.metas.addListener(function syncSessionIfChangedExternally(meta: Meta) {\n      const session = meta.session;\n\n      if (session && session.id !== inMemoryUserSession?.sessionId) {\n        const previousSessionId = inMemoryUserSession.sessionId;\n        inMemoryUserSession = createUserSessionObject(session.id);\n\n        faro.api.setSession({\n          id: inMemoryUserSession.sessionId,\n          attributes: {\n            ...(session.attributes ?? {}),\n            previousSession: previousSessionId,\n          },\n        });\n      }\n    });\n  }\n\n  return {\n    handleUpdate,\n    init,\n  };\n}\n\nexport function getSessionUpdater(initialSessionId?: string): UserSessionUpdater {\n  if (faro.config.experimentalSessions?.persistent && isLocalStorageAvailable) {\n    return persistentUserSessionsUpdater(initialSessionId);\n  }\n\n  return inMemoryUserSessionsUpdater(initialSessionId);\n}\n"]}

package/dist/types/instrumentations/session/sessionHandler.d.ts

@@ -1,22 +0,0 @@
-import { MetaSession } from '@grafana/faro-core';
-export interface FaroUserSession {
-    sessionId: string;
-    lastActivity: number;
-    started: number;
-    sessionMeta?: MetaSession;
-}
-export interface UserSessionUpdater {
-    handleUpdate: () => void;
-    init: () => void;
-}
-export declare const SESSION_EXPIRATION_TIME: number;
-export declare const SESSION_INACTIVITY_TIME: number;
-export declare const STORAGE_KEY = "__FARO_SESSION__";
-export declare function createUserSessionObject(sessionId?: string): FaroUserSession;
-export declare function removeUserSession(): void;
-export declare function storeUserSession(session: FaroUserSession): void;
-export declare function fetchUserSession(): FaroUserSession | null;
-export declare function isUserSessionValid(session: FaroUserSession | null): boolean;
-export declare function persistentUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
-export declare function inMemoryUserSessionsUpdater(initialSessionId?: string): UserSessionUpdater;
-export declare function getSessionUpdater(initialSessionId?: string): UserSessionUpdater;