@sailfish-ai/recorder 1.10.13 → 1.11.1

package/dist/index.js

@@ -293,40 +293,11 @@ function storeCredentialsAndConnection({ apiKey, backendApi, }) {
     sessionStorage.setItem("sailfishApiKey", apiKey);
     sessionStorage.setItem("sailfishBackendApi", backendApi);
 }
-// Utility function to match domains or paths with wildcard support
-export function matchUrlWithWildcard(input, patterns) {
-    // Tolerate non-string inputs (Request, URL, etc.); coerce to string when possible.
-    let urlStr;
-    if (typeof input === "string") {
-        urlStr = input;
-    }
-    else if (typeof URL !== "undefined" && input instanceof URL) {
-        urlStr = input.href;
-    }
-    else if (typeof Request !== "undefined" && input instanceof Request) {
-        urlStr = input.url;
-    }
-    else if (input != null && typeof input.toString === "function") {
-        // As per web APIs, fetch/open may accept any object with a stringifier.
-        urlStr = input.toString();
-    }
-    if (!urlStr)
-        return false;
-    // Use WHATWG URL parsing with a base for relative URLs.
-    let parsed;
-    try {
-        const base = typeof window !== "undefined"
-            ? window.location.href
-            : "http://localhost/";
-        parsed = new URL(urlStr, base);
-    }
-    catch {
-        return false; // If we can't parse, just say "no match" instead of throwing.
-    }
-    const { hostname, pathname, port, protocol } = parsed;
-    // Only match http(s) hosts/paths; ignore others like data:, blob:, about:.
-    if (!/^https?:$/.test(protocol))
-        return false;
+// Internal: match a *pre-parsed* URL against patterns. Hot path on the
+// header-propagation gate, called twice per request (deny + allow). Splitting
+// this from matchUrlWithWildcard() lets callers parse the URL once and reuse.
+function matchParsedUrlAgainstPatterns(parsed, patterns) {
+    const { hostname, pathname, port } = parsed;
     // Handle stripping 'www.' and port
     const domain = hostname.startsWith("www.")
         ? hostname.slice(4).toLowerCase()
@@ -383,6 +354,38 @@ export function matchUrlWithWildcard(input, patterns) {
         return true;
     });
 }
+// Public wrapper: parse + delegate. Preserved for callers outside the gate
+// (interceptor wrappers, tests). Hot paths should call
+// matchParsedUrlAgainstPatterns() directly with a pre-parsed URL.
+export function matchUrlWithWildcard(input, patterns) {
+    // Tolerate non-string inputs (Request, URL, etc.); coerce to string when possible.
+    let urlStr;
+    if (typeof input === "string") {
+        urlStr = input;
+    }
+    else if (typeof URL !== "undefined" && input instanceof URL) {
+        urlStr = input.href;
+    }
+    else if (typeof Request !== "undefined" && input instanceof Request) {
+        urlStr = input.url;
+    }
+    else if (input != null && typeof input.toString === "function") {
+        urlStr = input.toString();
+    }
+    if (!urlStr)
+        return false;
+    let parsed;
+    try {
+        const base = typeof window !== "undefined"
+            ? window.location.href
+            : "http://localhost/";
+        parsed = new URL(urlStr, base);
+    }
+    catch {
+        return false;
+    }
+    return matchParsedUrlAgainstPatterns(parsed, patterns);
+}
 export function createSkipHeadersPropagationChecker(domainsToNotPropagateHeaderTo = [], domainsToPropagateHeaderTo = []) {
     // Pre-compute the combined domain exclusion patterns once per interceptor setup
     const combinedPatterns = [
@@ -392,26 +395,30 @@ export function createSkipHeadersPropagationChecker(domainsToNotPropagateHeaderT
     // Pre-compute allowlist presence once (avoids per-request .length check overhead)
     const hasAllowlist = domainsToPropagateHeaderTo.length > 0;
     return function shouldSkipHeadersPropagation(url) {
-        let urlObj;
+        // Parse the URL ONCE and reuse for every subsequent check. URL parsing is
+        // the dominant cost on this hot path (called for every fetch/XHR), so
+        // calling matchParsedUrlAgainstPatterns() with the cached parse instead of
+        // matchUrlWithWildcard() (which would re-parse) is the key perf win.
+        let parsed;
         try {
-            urlObj = new URL(typeof url === "string" ? url : String(url?.url ?? url), window.location.href);
+            parsed = new URL(typeof url === "string" ? url : String(url?.url ?? url), window.location.href);
         }
         catch {
             // If we cannot parse, play it safe and do NOT inject headers.
             return true;
         }
         // 1️⃣ STATIC ASSET EXCLUSIONS (by comprehensive file extension list) — O(1) Set lookup
-        const lowerPathname = urlObj.pathname.toLowerCase();
+        const lowerPathname = parsed.pathname.toLowerCase();
         const lastDotIdx = lowerPathname.lastIndexOf(".");
         if (lastDotIdx !== -1 && STATIC_EXTENSIONS_SET.has(lowerPathname.slice(lastDotIdx))) {
             return true;
         }
         // 2️⃣ ALLOWLIST CHECK — if provided, URL must match at least one allowlist pattern
-        if (hasAllowlist && !matchUrlWithWildcard(url, domainsToPropagateHeaderTo)) {
+        if (hasAllowlist && !matchParsedUrlAgainstPatterns(parsed, domainsToPropagateHeaderTo)) {
             return true;
         }
         // 3️⃣ WILDCARD-BASED EXCLUSION (domain + path) — blocklist still applies even if allowlisted
-        if (matchUrlWithWildcard(url, combinedPatterns)) {
+        if (matchParsedUrlAgainstPatterns(parsed, combinedPatterns)) {
             return true;
         }
         return false;
@@ -1028,7 +1035,12 @@ function getMapUuidFromWindow() {
 // Note - we do NOT send serviceIdentifier because
 // it would be 1 serviceIdentifier per frontend user session,
 // which is very wasteful
-export async function startRecording({ apiKey, backendApi = "https://api-service.sailfishqa.com", domainsToPropagateHeaderTo = [], domainsToNotPropagateHeaderTo = [], serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody = true, captureResponseBodyMaxMb = 10, captureStreamPrefixKb = 64, captureStreamTimeoutMs = 10000, enableFiberTracking = false, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker = true, }) {
+export async function startRecording({ apiKey, backendApi = "https://api-service.sailfishqa.com", 
+// Default: ["*"] = propagate to every URL (deny list still applies).
+// Pass [] to fully disable header propagation. Pass exact patterns
+// (e.g. ["api.myapp.com", "*.internal.com"]) to restrict propagation
+// to a known set of domains.
+domainsToPropagateHeaderTo = ["*"], domainsToNotPropagateHeaderTo = [], serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody = true, captureResponseBodyMaxMb = 10, captureStreamPrefixKb = 64, captureStreamTimeoutMs = 10000, enableFiberTracking = false, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker = true, maskTextClass, library, }) {
     // Synthetic-environment no-op: Lighthouse/PSI, HeadlessChrome, WebPageTest
     // (PTST), Puppeteer/Playwright/Selenium (navigator.webdriver). We skip init
     // entirely to avoid WSS retry noise, third-party perf penalties in audits,
@@ -1145,7 +1157,7 @@ export async function startRecording({ apiKey, backendApi = "https://api-service
         const effectiveGitSha = gitSha ?? readGitSha();
         const effectiveServiceIdentifier = serviceIdentifier ?? "";
         const effectiveServiceVersion = serviceVersion ?? "";
-        const effectiveLibrary = "JS/TS";
+        const effectiveLibrary = library ?? "JS/TS";
         const effectiveMapUuid = getMapUuidFromWindow();
         const metadataWithAppUrl = withAppUrlMetadata(serviceAdditionalMetadata);
         // Detect the front-end framework. DOM queries are allowed only when the
@@ -1170,6 +1182,9 @@ export async function startRecording({ apiKey, backendApi = "https://api-service
             ...DEFAULT_CAPTURE_SETTINGS,
             ...captureSettingsResponse.data?.captureSettingsFromApiKey,
             enableFiberTracking,
+            // Caller-supplied maskTextClass wins over server-fetched value; only
+            // applied when explicitly set so undefined cannot clobber the server.
+            ...(maskTextClass !== undefined ? { maskTextClass } : {}),
         };
         // If a socket is already open now, stop here.
         if (g.ws && g.ws.readyState === 1) {
@@ -1220,40 +1235,47 @@ export const initRecorder = async (options) => {
     // Coalesce concurrent calls into one promise
     if (!g.initPromise) {
         g.initPromise = (async () => {
-            if (!g.hasLoggedInitOnce) {
-                // Log only once per window lifecycle to avoid noisy logs when routes remount.
-                console.log("Initializing Sailfish Recorder (first run) …");
-                g.hasLoggedInitOnce = true;
-            }
-            await startRecording(options);
-            // Set up the issue reporting UI once (lazy-loaded)
-            if (!g.issueReportingInit) {
-                const backendApiUrl = options.backendApi ?? "https://api-service.sailfishqa.com";
-                // Dynamically import issue reporting modules to reduce initial bundle
-                const [{ setupIssueReporting }, { fetchIntegrationData, getIntegrationData }] = await Promise.all([
-                    import("./inAppReportIssueModal"),
-                    import("./inAppReportIssueModal/integrations"),
-                ]);
-                // Fetch integration data before setting up issue reporting
-                let integrationData = null;
-                try {
-                    await fetchIntegrationData(options.apiKey, backendApiUrl);
-                    integrationData = getIntegrationData();
+            try {
+                if (!g.hasLoggedInitOnce) {
+                    // Log only once per window lifecycle to avoid noisy logs when routes remount.
+                    console.log("Initializing Sailfish Recorder (first run) …");
+                    g.hasLoggedInitOnce = true;
                 }
-                catch (error) {
-                    console.warn("[Sailfish] Failed to fetch integration data for issue reporting:", error);
-                    // Continue with null integration data - the modal will work without it
+                await startRecording(options);
+                // Set up the issue reporting UI once (lazy-loaded)
+                if (!g.issueReportingInit) {
+                    const backendApiUrl = options.backendApi ?? "https://api-service.sailfishqa.com";
+                    // Dynamically import issue reporting modules to reduce initial bundle
+                    const [{ setupIssueReporting }, { fetchIntegrationData, getIntegrationData }] = await Promise.all([
+                        import("./inAppReportIssueModal"),
+                        import("./inAppReportIssueModal/integrations"),
+                    ]);
+                    // Fetch integration data before setting up issue reporting
+                    let integrationData = null;
+                    try {
+                        await fetchIntegrationData(options.apiKey, backendApiUrl);
+                        integrationData = getIntegrationData();
+                    }
+                    catch (error) {
+                        console.warn("[Sailfish] Failed to fetch integration data for issue reporting:", error);
+                        // Continue with null integration data - the modal will work without it
+                    }
+                    setupIssueReporting({
+                        apiKey: options.apiKey,
+                        backendApi: backendApiUrl,
+                        getSessionId: () => getOrSetSessionId(),
+                        shortcuts: options.reportIssueShortcuts,
+                        customBaseUrl: options.customBaseUrl,
+                        integrationData,
+                        showEngTicketFieldsInReportIssueModalDefault: options.showEngTicketFieldsInReportIssueModalDefault,
+                    });
+                    g.issueReportingInit = true;
                 }
-                setupIssueReporting({
-                    apiKey: options.apiKey,
-                    backendApi: backendApiUrl,
-                    getSessionId: () => getOrSetSessionId(),
-                    shortcuts: options.reportIssueShortcuts,
-                    customBaseUrl: options.customBaseUrl,
-                    integrationData,
-                    showEngTicketFieldsInReportIssueModalDefault: options.showEngTicketFieldsInReportIssueModalDefault,
-                });
-                g.issueReportingInit = true;
+            }
+            catch (err) {
+                // CRITICAL: Never let Sailfish errors break the customer's application.
+                // Log a warning so developers can debug, but swallow the error.
+                console.warn("[Sailfish] Recorder initialization failed:", err);
             }
         })().finally(() => {
             // Keep all state/flags, but clear the temp promise so a brand-new session can re-init later
@@ -1271,3 +1293,6 @@ export { getOrSetSessionId } from "./session";
 export * from "./types";
 export * from "./utils";
 export * from "./websocket";
+// Auto-init code for CDN/snippet mode lives in snippet-auto-init.ts
+// and is only included in the UMD build entry point (not ES/CJS).
+// This keeps sideEffects: false accurate for tree-shaking.

package/dist/recorder.cjs

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const e = require("./chunks/index-DW416eVj.js");
-exports.DEFAULT_CAPTURE_SETTINGS = e.DEFAULT_CAPTURE_SETTINGS, exports.DEFAULT_CONSOLE_RECORDING_SETTINGS = e.DEFAULT_CONSOLE_RECORDING_SETTINGS, exports.STORAGE_VERSION = e.STORAGE_VERSION, exports.addOrUpdateMetadata = e.addOrUpdateMetadata, exports.buildBatches = e.buildBatches, exports.clearStaleFuncSpanState = e.clearStaleFuncSpanState, exports.createSkipHeadersPropagationChecker = e.createSkipHeadersPropagationChecker, exports.createTriageAndIssueFromRecorder = e.createTriageAndIssueFromRecorder, exports.createTriageFromRecorder = e.createTriageFromRecorder, exports.disableFunctionSpanTracking = e.disableFunctionSpanTracking, exports.enableFunctionSpanTracking = e.enableFunctionSpanTracking, exports.ensureHrefCache = e.ensureHrefCache, exports.eventSize = e.eventSize, exports.fetchAndSendIp = e.fetchAndSendIp, exports.fetchCaptureSettings = e.fetchCaptureSettings, exports.fetchEngineeringTicketPlatformIntegrations = e.fetchEngineeringTicketPlatformIntegrations, exports.fetchFunctionSpanTrackingEnabled = e.fetchFunctionSpanTrackingEnabled, exports.flushBufferedEvents = e.flushBufferedEvents, exports.getCachedHref = e.getCachedHref, exports.getCachedHrefNoQuery = e.getCachedHrefNoQuery, exports.getFuncSpanHeader = e.getFuncSpanHeader, exports.getOrSetSessionId = e.getOrSetSessionId, exports.getUrlAndStoredUuids = e.getUrlAndStoredUuids, exports.identify = e.identify, exports.initRecorder = e.initRecorder, exports.initializeConsolePlugin = e.initializeConsolePlugin, exports.initializeDomContentEvents = e.initializeDomContentEvents, exports.initializeFunctionSpanTrackingFromApi = e.initializeFunctionSpanTrackingFromApi, exports.initializeRecording = e.initializeRecording, exports.initializeWebSocket = e.initializeWebSocket, exports.invalidateUrlCache = e.invalidateUrlCache, exports.isFunctionSpanTrackingEnabled = e.isFunctionSpanTrackingEnabled, exports.matchUrlWithWildcard = e.matchUrlWithWildcard, Object.defineProperty(exports, "nowTimestamp", { enumerable: true, get: () => e.nowTimestamp }), exports.onNavigationChange = e.onNavigationChange, exports.openReportIssueModal = e.openReportIssueModal, exports.restoreFuncSpanState = e.restoreFuncSpanState, exports.sendDomainsToNotPropagateHeaderTo = e.sendDomainsToNotPropagateHeaderTo, exports.sendEvent = e.sendEvent, exports.sendGraphQLRequest = e.sendGraphQLRequest, exports.sendMessage = e.sendMessage, exports.startRecording = e.startRecording, exports.startRecordingSession = e.startRecordingSession, exports.trackingEvent = e.trackingEvent, exports.withAppUrlMetadata = e.withAppUrlMetadata;
+const e = require("./chunks/index-Cfj4Epfd.js");
+exports.DEFAULT_CAPTURE_SETTINGS = e.DEFAULT_CAPTURE_SETTINGS, exports.DEFAULT_CONSOLE_RECORDING_SETTINGS = e.DEFAULT_CONSOLE_RECORDING_SETTINGS, exports.STORAGE_VERSION = e.STORAGE_VERSION, exports.addOrUpdateMetadata = e.addOrUpdateMetadata, exports.buildBatches = e.buildBatches, exports.clearStaleFuncSpanState = e.clearStaleFuncSpanState, exports.createSkipHeadersPropagationChecker = e.createSkipHeadersPropagationChecker, exports.createTriageAndIssueFromRecorder = e.createTriageAndIssueFromRecorder, exports.createTriageFromRecorder = e.createTriageFromRecorder, exports.disableFunctionSpanTracking = e.disableFunctionSpanTracking, exports.enableFunctionSpanTracking = e.enableFunctionSpanTracking, exports.ensureHrefCache = e.ensureHrefCache, exports.eventSize = e.eventSize, exports.fetchAndSendIp = e.fetchAndSendIp, exports.fetchCaptureSettings = e.fetchCaptureSettings, exports.fetchEngineeringTicketPlatformIntegrations = e.fetchEngineeringTicketPlatformIntegrations, exports.fetchFunctionSpanTrackingEnabled = e.fetchFunctionSpanTrackingEnabled, exports.flushBufferedEvents = e.flushBufferedEvents, exports.getCachedHref = e.getCachedHref, exports.getCachedHrefNoQuery = e.getCachedHrefNoQuery, exports.getFuncSpanHeader = e.getFuncSpanHeader, exports.getIdentifiedUser = e.getIdentifiedUser, exports.getOrSetSessionId = e.getOrSetSessionId, exports.getUrlAndStoredUuids = e.getUrlAndStoredUuids, exports.identify = e.identify, exports.initRecorder = e.initRecorder, exports.initializeConsolePlugin = e.initializeConsolePlugin, exports.initializeDomContentEvents = e.initializeDomContentEvents, exports.initializeFunctionSpanTrackingFromApi = e.initializeFunctionSpanTrackingFromApi, exports.initializeRecording = e.initializeRecording, exports.initializeWebSocket = e.initializeWebSocket, exports.invalidateUrlCache = e.invalidateUrlCache, exports.isFunctionSpanTrackingEnabled = e.isFunctionSpanTrackingEnabled, exports.matchUrlWithWildcard = e.matchUrlWithWildcard, Object.defineProperty(exports, "nowTimestamp", { enumerable: true, get: () => e.nowTimestamp }), exports.onNavigationChange = e.onNavigationChange, exports.openReportIssueModal = e.openReportIssueModal, exports.restoreFuncSpanState = e.restoreFuncSpanState, exports.sendDomainsToNotPropagateHeaderTo = e.sendDomainsToNotPropagateHeaderTo, exports.sendEvent = e.sendEvent, exports.sendGraphQLRequest = e.sendGraphQLRequest, exports.sendMessage = e.sendMessage, exports.startRecording = e.startRecording, exports.startRecordingSession = e.startRecordingSession, exports.trackingEvent = e.trackingEvent, exports.withAppUrlMetadata = e.withAppUrlMetadata;

package/dist/recorder.js

@@ -1,4 +1,4 @@
-import { D, a, S, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, z, A, B, C, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, T } from "./chunks/index-DvLh2k6O.js";
+import { D, a, S, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, z, A, B, C, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, T, U } from "./chunks/index-CuXHImrI.js";
 export {
   D as DEFAULT_CAPTURE_SETTINGS,
   a as DEFAULT_CONSOLE_RECORDING_SETTINGS,
@@ -21,28 +21,29 @@ export {
   q as getCachedHref,
   r as getCachedHrefNoQuery,
   s as getFuncSpanHeader,
-  t as getOrSetSessionId,
-  u as getUrlAndStoredUuids,
-  v as identify,
-  w as initRecorder,
-  x as initializeConsolePlugin,
-  z as initializeDomContentEvents,
-  A as initializeFunctionSpanTrackingFromApi,
-  B as initializeRecording,
-  C as initializeWebSocket,
-  E as invalidateUrlCache,
-  F as isFunctionSpanTrackingEnabled,
-  G as matchUrlWithWildcard,
-  H as nowTimestamp,
-  I as onNavigationChange,
-  J as openReportIssueModal,
-  K as restoreFuncSpanState,
-  L as sendDomainsToNotPropagateHeaderTo,
-  M as sendEvent,
-  N as sendGraphQLRequest,
-  O as sendMessage,
-  P as startRecording,
-  Q as startRecordingSession,
-  R as trackingEvent,
-  T as withAppUrlMetadata
+  t as getIdentifiedUser,
+  u as getOrSetSessionId,
+  v as getUrlAndStoredUuids,
+  w as identify,
+  x as initRecorder,
+  z as initializeConsolePlugin,
+  A as initializeDomContentEvents,
+  B as initializeFunctionSpanTrackingFromApi,
+  C as initializeRecording,
+  E as initializeWebSocket,
+  F as invalidateUrlCache,
+  G as isFunctionSpanTrackingEnabled,
+  H as matchUrlWithWildcard,
+  I as nowTimestamp,
+  J as onNavigationChange,
+  K as openReportIssueModal,
+  L as restoreFuncSpanState,
+  M as sendDomainsToNotPropagateHeaderTo,
+  N as sendEvent,
+  O as sendGraphQLRequest,
+  P as sendMessage,
+  Q as startRecording,
+  R as startRecordingSession,
+  T as trackingEvent,
+  U as withAppUrlMetadata
 };