@sailfish-ai/recorder 1.11.1 → 1.11.3

package/dist/recording.js

@@ -1,6 +1,6 @@
 // import { NetworkRecordOptions } from "@sailfish-rrweb/rrweb-plugin-network-record";
 import { EventType } from "@sailfish-rrweb/types";
-import { Complete, DomContentEventId, DomContentSource, Loading, } from "./constants";
+import { Complete, DomContentEventId, DomContentSource, Loading, PerformanceMetricEventId, } from "./constants";
 import { getCallerLocation, getCallerLocationFromTrace, } from "./sourceLocation";
 import suppressConsoleLogsDuringCall from "./suppressConsoleLogsDuringCall";
 import { yieldToMain } from "./scheduler";
@@ -157,6 +157,36 @@ export function initializeDomContentEvents(sessionId) {
         });
     });
 }
+export async function initializePerformancePlugin(sessionId) {
+    try {
+        const { getRecordPerformancePlugin } = await import("@sailfish-rrweb/rrweb-plugin-performance-record");
+        await yieldToMain();
+        const plugin = getRecordPerformancePlugin({
+            getPageVisitUuid: () => sessionStorage.getItem("pageVisitUUID"),
+        });
+        // `observer` is defined on the plugin (see rrweb-plugin-performance-record).
+        // Call it directly so the plugin can start its PerformanceObservers without
+        // needing to be registered through rrweb's record() lifecycle — same pattern
+        // as initializeConsolePlugin.
+        plugin.observer?.((payload) => {
+            const typed = payload;
+            sendEvent({
+                type: PerformanceMetricEventId,
+                timestamp: typed.timestamp,
+                sessionId,
+                data: {
+                    plugin: plugin.name,
+                    payload: typed,
+                },
+                ...getUrlAndStoredUuids(),
+            });
+        }, window, plugin.options);
+    }
+    catch (error) {
+        // Never let a plugin failure break the recorder.
+        console.warn("[Sailfish] Performance plugin failed to initialize:", error);
+    }
+}
 export async function initializeConsolePlugin(consoleRecordSettings, sessionId) {
     const { getRecordConsolePlugin } = await import("@sailfish-rrweb/rrweb-plugin-console-record");
     // Yield between dynamic import and observer setup

package/dist/types/constants.d.ts

@@ -1,5 +1,6 @@
 export declare const DomContentEventId = 24;
 export declare const NetworkRequestEventId = 27;
+export declare const PerformanceMetricEventId = 28;
 export declare const xSf3RidHeader = "X-Sf3-Rid";
 export declare const DomContentSource: {
     loading: number;

package/dist/types/index.d.ts

@@ -6,7 +6,7 @@ export declare const DEFAULT_CAPTURE_SETTINGS: CaptureSettings;
 export declare const DEFAULT_CONSOLE_RECORDING_SETTINGS: LogRecordOptions;
 export declare function matchUrlWithWildcard(input: unknown, patterns: string[]): boolean;
 export declare function createSkipHeadersPropagationChecker(domainsToNotPropagateHeaderTo?: string[], domainsToPropagateHeaderTo?: string[]): (url: string) => boolean;
-export declare function startRecording({ apiKey, backendApi, domainsToPropagateHeaderTo, domainsToNotPropagateHeaderTo, serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody, captureResponseBodyMaxMb, captureStreamPrefixKb, captureStreamTimeoutMs, enableFiberTracking, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker, maskTextClass, library, }: {
+export declare function startRecording({ apiKey, backendApi, domainsToPropagateHeaderTo, domainsToNotPropagateHeaderTo, serviceVersion, serviceIdentifier, gitSha, serviceAdditionalMetadata, enableIpTracking, captureStreamingResponseBody, captureResponseBodyMaxMb, captureStreamPrefixKb, captureStreamTimeoutMs, enableFiberTracking, deferRecording, deferRecordingStart, chunkSnapshot, useWsWorker, capturePerformanceMetrics, maskTextClass, library, headlessRecording, }: {
     apiKey: string;
     backendApi?: string;
     domainsToPropagateHeaderTo?: string[];
@@ -27,7 +27,9 @@ export declare function startRecording({ apiKey, backendApi, domainsToPropagateH
     deferRecordingStart?: boolean;
     chunkSnapshot?: boolean;
     useWsWorker?: boolean;
+    capturePerformanceMetrics?: boolean;
     maskTextClass?: string;
+    headlessRecording?: boolean;
 }): Promise<void>;
 export declare const initRecorder: (options: {
     apiKey: string;
@@ -77,8 +79,26 @@ export declare const initRecorder: (options: {
      */
     chunkSnapshot?: boolean;
     useWsWorker?: boolean;
+    /**
+     * Capture browser performance metrics (FCP, LCP, TBT, DCL, LOAD) per
+     * page_visit_uuid via the `@sailfish-rrweb/rrweb-plugin-performance-record`
+     * plugin. Set to `false` to skip the plugin entirely — the plugin code is
+     * dynamically imported, so opting out also avoids loading `web-vitals` and
+     * the metric observers. Useful for benchmarking the recorder's own
+     * overhead, or for sites that already collect RUM through another vendor.
+     * @default true
+     */
+    capturePerformanceMetrics?: boolean;
     showEngTicketFieldsInReportIssueModalDefault?: boolean;
     maskTextClass?: string;
+    /**
+     * When true, recording proceeds even inside headless / automated browser
+     * environments (Puppeteer, Playwright, Cypress, etc.), bypassing the
+     * `isHeadlessOrLighthouse()` guard in `startRecording`.
+     * When false (default), those environments are silently skipped.
+     * @default false
+     */
+    headlessRecording?: boolean;
 }) => Promise<void>;
 export * from "./graphql";
 export { openReportIssueModal } from "./inAppReportIssueModal";

package/dist/types/recording.d.ts

@@ -10,6 +10,7 @@ export declare const getUrlAndStoredUuids: () => {
     tabVisibilityState: string;
 };
 export declare function initializeDomContentEvents(sessionId: string): void;
+export declare function initializePerformancePlugin(sessionId: string): Promise<void>;
 export declare function initializeConsolePlugin(consoleRecordSettings: LogRecordOptions, sessionId: string): Promise<void>;
 export declare function initializeRecording(captureSettings: any, // TODO - Sibyl post-launch - replace type
 backendApi: string, apiKey: string, sessionId: string, envValue?: string, deferRecordingStart?: boolean, useWsWorker?: boolean, chunkSnapshot?: boolean): Promise<WsHandle>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailfish-ai/recorder",
-  "version": "1.11.1",
+  "version": "1.11.3",
   "publishPublicly": true,
   "publishToCdn": {
     "jsdelivr": true,
@@ -19,6 +19,7 @@
     "test": "vitest run",
     "test:watch": "vitest watch",
     "check-types": "tsc --noEmit",
+    "bench-perf": "node scripts/bench-perf.js",
     "prepublish": "npm run check-types && npm run build",
     "artifactregistry-login": "npx google-artifactregistry-auth",
     "publish-local": "npm publish --tag latest --registry http://localhost:4873 --//localhost:4873/:_authToken=none"
@@ -47,9 +48,10 @@
     "dist"
   ],
   "dependencies": {
-    "@sailfish-rrweb/rrweb-plugin-console-record": "0.5.9",
-    "@sailfish-rrweb/rrweb-record-only": "0.5.9",
-    "@sailfish-rrweb/types": "0.5.9",
+    "@sailfish-rrweb/rrweb-plugin-console-record": "0.5.11",
+    "@sailfish-rrweb/rrweb-plugin-performance-record": "0.5.11",
+    "@sailfish-rrweb/rrweb-record-only": "0.5.11",
+    "@sailfish-rrweb/types": "0.5.11",
     "reconnecting-websocket": "^4.4.0",
     "source-map-js": "^1.2.1"
   },
@@ -74,6 +76,7 @@
     "jest-localstorage-mock": "^2.4.26",
     "jest-transform-stub": "^2.0.0",
     "jsdom": "^25.0.0",
+    "puppeteer": "^23.0.0",
     "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-visualizer": "^5.12.0",
     "ts-jest": "^29.4.0",