@sailfish-ai/recorder 1.5.8 → 1.6.0

package/dist/index.js

@@ -4,7 +4,7 @@ import { gatherAndCacheDeviceInfo } from "./deviceInfo";
 import { sendRecordingEvents } from "./eventCache";
 import { fetchCaptureSettings, sendDomainsToNotPropagateHeaderTo, startRecordingSession, } from "./graphql";
 import { sendMapUuidIfAvailable } from "./mapUuid";
-import { initializeRecording } from "./recording";
+import { initializeConsolePlugin, initializeRecording } from "./recording";
 import { sendMessage } from "./websocket";
 // Default list of domains to ignore
 const DOMAINS_TO_NOT_PROPAGATE_HEADER_TO_DEFAULT = [
@@ -16,7 +16,6 @@ const DOMAINS_TO_NOT_PROPAGATE_HEADER_TO_DEFAULT = [
     "*.smooch.io", // Exclude smooch-related requests
     "*.zendesk.com", // Exclude zendesk-related requests
 ];
-const DOMAINS_TO_NOT_RECORD_NETWORK_REQUESTS_TO = [];
 export const DEFAULT_CAPTURE_SETTINGS = {
     recordCanvas: false,
     recordCrossOriginIframes: false,
@@ -39,7 +38,6 @@ export const DEFAULT_CONSOLE_RECORDING_SETTINGS = {
     },
     logger: "console",
 };
-const PERSIST_SESSION_FOR_REOPENING_TABS = false;
 // export const DEFAULT_NETWORK_CAPTURE_SETTINGS: NetworkRecordOptions = {
 //   initiatorTypes: ["fetch", "xmlhttprequest"],
 //   ignoreRequestFn: (request) => {
@@ -118,42 +116,13 @@ function getOrSetUserDeviceUuid() {
     }
     return userDeviceUuid;
 }
-// Function to generate a unique key for storing sessionId in localStorage
-function getTabKey() {
-    let tabKey = sessionStorage.getItem("sailfishTabKey");
-    if (!tabKey) {
-        tabKey = uuidv4();
-        sessionStorage.setItem("sailfishTabKey", tabKey);
-    }
-    return tabKey;
-}
-// Function to get or set the current sessionId in sessionStorage
-function getOrSetSessionId(forceNew = false) {
-    let sessionId = sessionStorage.getItem("sailfishSessionId");
-    if (!sessionId || forceNew) {
-        const tabKey = getTabKey();
-        const storedSessionId = PERSIST_SESSION_FOR_REOPENING_TABS
-            ? localStorage.getItem(`sailfishSessionId_${tabKey}`)
-            : null;
-        if (storedSessionId && !forceNew) {
-            sessionId = storedSessionId;
-        }
-        else {
-            sessionId = uuidv4();
-        }
-        sessionStorage.setItem("sailfishSessionId", sessionId);
-    }
-    return sessionId;
-}
-// Function to store the current sessionId in localStorage on page unload
-function storeSessionId() {
-    if (PERSIST_SESSION_FOR_REOPENING_TABS) {
-        const tabKey = getTabKey();
-        const sessionId = sessionStorage.getItem("sailfishSessionId");
-        if (sessionId) {
-            localStorage.setItem(`sailfishSessionId_${tabKey}`, sessionId);
-        }
+// 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.
+function getOrSetSessionId() {
+    if (!window.name) {
+        window.name = uuidv4();
     }
+    return window.name;
 }
 // Function to handle resetting the sessionId when the page becomes visible again
 function handleVisibilityChange() {
@@ -163,7 +132,6 @@ function handleVisibilityChange() {
 }
 // Initialize event listeners for visibility change and page unload
 document.addEventListener("visibilitychange", handleVisibilityChange);
-window.addEventListener("beforeunload", storeSessionId);
 function storeCredentialsAndConnection({ apiKey, backendApi, }) {
     sessionStorage.setItem("sailfishApiKey", apiKey);
     sessionStorage.setItem("sailfishBackendApi", backendApi);
@@ -352,6 +320,7 @@ function setupFetchInterceptor(domainsToNotPropagateHeadersTo, domainsToPropagat
 }
 // Main Recording Function
 export async function startRecording({ apiKey, backendApi = "https://api-service.sailfishqa.com", domainsToPropagateHeaderTo = [], domainsToNotPropagateHeaderTo = [], serviceVersion = "", }) {
+    initializeConsolePlugin(DEFAULT_CONSOLE_RECORDING_SETTINGS);
     let sessionId = getOrSetSessionId();
     storeCredentialsAndConnection({ apiKey, backendApi });
     trackDomainChanges();
@@ -369,16 +338,12 @@ export async function startRecording({ apiKey, backendApi = "https://api-service
             DEFAULT_CAPTURE_SETTINGS;
         const sessionResponse = await startRecordingSession(apiKey, sessionId, backendApi);
         if (sessionResponse.data?.startRecordingSession) {
-            const websocket = await initializeRecording(captureSettings, DEFAULT_CONSOLE_RECORDING_SETTINGS, 
+            const websocket = await initializeRecording(captureSettings, 
             // DEFAULT_NETWORK_CAPTURE_SETTINGS,
             backendApi, apiKey, sessionId);
             // Send parameters once before starting interval
             sendMapUuidIfAvailable(serviceVersion);
-            setInterval(() => {
-                if (websocket && websocket.readyState === WebSocket.OPEN) {
-                    sendRecordingEvents(websocket);
-                }
-            }, 10000);
+            setInterval(() => sendRecordingEvents(websocket), 10000);
         }
         else {
             console.error("Failed to start recording session:", sessionResponse.errors || sessionResponse);

package/dist/recording.js

@@ -1,5 +1,6 @@
 import { getRecordConsolePlugin, } from "@sailfish-rrweb/rrweb-plugin-console-record";
 import record from "@sailfish-rrweb/rrweb-record-only";
+import { EventType } from "@sailfish-rrweb/types";
 import { cacheEvents, sendRecordingEvents } from "./eventCache";
 import { initializeWebSocket } from "./websocket";
 const MASK_CLASS = "sailfishSanitize";
@@ -36,8 +37,18 @@ function maskInputFn(text, node) {
     // Default to returning the original text
     return text;
 }
+export function initializeConsolePlugin(consoleRecordSettings) {
+    const { name, observer } = getRecordConsolePlugin(consoleRecordSettings);
+    observer((payload) => cacheEvents({
+        type: EventType.Plugin,
+        timestamp: Date.now(),
+        data: {
+            plugin: name,
+            payload,
+        },
+    }), window, consoleRecordSettings);
+}
 export async function initializeRecording(captureSettings, // TODO - Sibyl post-launch - replace type
-consoleRecordSettings, 
 // networkRecordSettings: NetworkRecordOptions,
 backendApi, apiKey, sessionId) {
     const webSocket = initializeWebSocket(backendApi, apiKey, sessionId);
@@ -46,10 +57,6 @@ backendApi, apiKey, sessionId) {
             emit(event) {
                 cacheEvents(event);
             },
-            plugins: [
-                getRecordConsolePlugin(consoleRecordSettings),
-                // getRecordNetworkPlugin(networkRecordSettings),
-            ],
             maskInputOptions: { text: true }, // Fix the incorrect property name
             maskInputFn,
             maskTextClass: MASK_CLASS,