@sailfish-ai/recorder 1.8.10 → 1.8.12

package/dist/recording.js

@@ -155,8 +155,8 @@ export function initializeConsolePlugin(consoleRecordSettings, sessionId) {
 }
 export async function initializeRecording(captureSettings, // TODO - Sibyl post-launch - replace type
 // networkRecordSettings: NetworkRecordOptions,
-backendApi, apiKey, sessionId) {
-    const webSocket = initializeWebSocket(backendApi, apiKey, sessionId);
+backendApi, apiKey, sessionId, envValue) {
+    const webSocket = initializeWebSocket(backendApi, apiKey, sessionId, envValue);
     try {
         record({
             emit(event) {

package/dist/session.js

@@ -1,12 +1,49 @@
 import { v4 as uuidv4 } from "uuid";
 import { HAS_WINDOW } from "./runtimeEnv";
-// Storing the sailfishSessionId in window.name, as window.name retains its value after a page refresh
-// but resets when a new tab (including a duplicated tab) is opened.
+// Hybrid approach: use window.name as a temporary "refresh flag" and sessionStorage for persistence
+// - window.name flag is removed immediately after reading, preserving customer's data
+// - sessionStorage stores the actual session ID
+// - beforeunload sets a flag in window.name to detect page refresh vs duplicate tab
+const SESSION_ID_KEY = "sailfishSessionId";
+const REFRESH_FLAG = "__sailfish_refresh__";
+// Cache the resolved session ID to avoid regenerating on multiple calls
+let resolvedSessionId = null;
 export function getOrSetSessionId() {
     if (!HAS_WINDOW)
         return uuidv4();
-    if (!window.name) {
-        window.name = uuidv4();
+    // Return cached session ID if already resolved
+    if (resolvedSessionId) {
+        return resolvedSessionId;
     }
-    return window.name;
+    // Check if window.name contains our refresh flag
+    const isRefresh = window.name.startsWith(REFRESH_FLAG);
+    // Remove our flag and restore customer's original window.name
+    if (isRefresh) {
+        window.name = window.name.substring(REFRESH_FLAG.length);
+    }
+    if (isRefresh) {
+        // Page refresh - reuse existing session ID from sessionStorage
+        const existingSessionId = window.sessionStorage.getItem(SESSION_ID_KEY);
+        if (existingSessionId) {
+            resolvedSessionId = existingSessionId;
+            return existingSessionId;
+        }
+    }
+    // New tab or duplicate tab - generate new session ID
+    const sessionId = uuidv4();
+    resolvedSessionId = sessionId;
+    try {
+        window.sessionStorage.setItem(SESSION_ID_KEY, sessionId);
+    }
+    catch (error) {
+        // Ignore storage errors, use in-memory session ID
+    }
+    return sessionId;
+}
+// Set up beforeunload listener to mark page refresh
+if (HAS_WINDOW) {
+    window.addEventListener("beforeunload", () => {
+        // Prepend our flag to preserve customer's window.name
+        window.name = REFRESH_FLAG + window.name;
+    });
 }

package/dist/types/index.d.ts

@@ -31,6 +31,7 @@ export * from "./graphql";
 export { openReportIssueModal } from "./inAppReportIssueModal";
 export * from "./recording";
 export * from "./sendSailfishMessages";
+export { getOrSetSessionId } from "./session";
 export * from "./types";
 export * from "./utils";
 export * from "./websocket";

package/dist/types/recording.d.ts

@@ -10,4 +10,4 @@ export declare const getUrlAndStoredUuids: () => {
 export declare function initializeDomContentEvents(sessionId: string): void;
 export declare function initializeConsolePlugin(consoleRecordSettings: LogRecordOptions, sessionId: string): void;
 export declare function initializeRecording(captureSettings: any, // TODO - Sibyl post-launch - replace type
-backendApi: string, apiKey: string, sessionId: string): Promise<ReconnectingWebSocket>;
+backendApi: string, apiKey: string, sessionId: string, envValue?: string): Promise<ReconnectingWebSocket>;

package/dist/types/websocket.d.ts

@@ -1,7 +1,7 @@
 import ReconnectingWebSocket from "reconnecting-websocket";
 export declare function flushBufferedEvents(): Promise<void>;
 export declare function sendEvent(event: any): void;
-export declare function initializeWebSocket(backendApi: string, apiKey: string, sessionId: string): ReconnectingWebSocket;
+export declare function initializeWebSocket(backendApi: string, apiKey: string, sessionId: string, envValue?: string): ReconnectingWebSocket;
 export declare function sendMessage(message: Record<string, any>): void;
 /**
  * Enable function span tracking for this session (e.g., when report issue recording starts)

package/dist/websocket.js

@@ -203,14 +203,18 @@ export function sendEvent(event) {
         saveEventToIDB(enrichedEvent);
     }
 }
-export function initializeWebSocket(backendApi, apiKey, sessionId) {
+export function initializeWebSocket(backendApi, apiKey, sessionId, envValue) {
     // Note: Global function span tracking state is now loaded at module initialization time
     // (see IIFE above) so headers work immediately, even before WebSocket connects.
     // The WebSocket "funcSpanTrackingControl" message will update the state if needed.
     const wsHost = getWebSocketHost(backendApi);
     const apiProtocol = new URL(backendApi).protocol;
     const wsScheme = apiProtocol === "https:" ? "wss" : "ws";
-    const wsUrl = `${wsScheme}://${wsHost}/ws/notify/?apiKey=${apiKey}&sessionId=${sessionId}&sender=JS%2FTS&version=${version}`;
+    let wsUrl = `${wsScheme}://${wsHost}/ws/notify/?apiKey=${apiKey}&sessionId=${sessionId}&sender=JS%2FTS&version=${version}`;
+    // Append envValue if provided
+    if (envValue) {
+        wsUrl += `&envValue=${encodeURIComponent(envValue)}`;
+    }
     const options = {
         connectionTimeout: 30000,
     };
@@ -364,7 +368,12 @@ export function sendMessage(message) {
         ...message,
         app_url: message?.app_url ?? window?.location?.href,
     });
-    if (isWebSocketOpen(webSocket)) {
+    // Check isDraining to prevent out-of-order delivery during reconnection
+    // When draining buffered events, queue new messages to maintain order
+    if (isDraining || !isWebSocketOpen(webSocket)) {
+        saveNotifyMessageToIDB(msg);
+    }
+    else {
         try {
             webSocket.send(msg);
         }
@@ -372,9 +381,6 @@ export function sendMessage(message) {
             saveNotifyMessageToIDB(msg);
         }
     }
-    else {
-        saveNotifyMessageToIDB(msg);
-    }
 }
 function getWebSocketHost(url) {
     const parser = document.createElement("a");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailfish-ai/recorder",
-  "version": "1.8.10",
+  "version": "1.8.12",
   "publishPublicly": true,
   "type": "module",
   "main": "dist/recorder.cjs",
@@ -37,7 +37,7 @@
     "dist"
   ],
   "dependencies": {
-    "@sailfish-ai/sf-map-utils": "0.4.3",
+    "@sailfish-ai/sf-map-utils": "0.4.4",
     "@sailfish-rrweb/rrweb-plugin-console-record": "0.5.2",
     "@sailfish-rrweb/rrweb-record-only": "0.5.2",
     "@sailfish-rrweb/types": "0.5.2",