@sailfish-ai/recorder 1.7.33 → 1.7.34

package/dist/graphql.js

@@ -41,11 +41,33 @@ export function fetchCaptureSettings(apiKey, backendApi) {
     }
   `, { apiKey, backendApi });
 }
-export function startRecordingSession(apiKey, recordingId, backendApi) {
-    return sendGraphQLRequest("StartSession", `mutation StartSession($apiKey: UUID!, $recordingSessionId: UUID!) {
+export function startRecordingSession(apiKey, recordingId, backendApi, serviceIdentifier, serviceVersion, mapUuid, gitSha, library, serviceAdditionalMetadata) {
+    // These must be sent as None/Null for now (not user-provided)
+    const startRecordingFilePath = null;
+    const startRecordingFileNumber = null;
+    return sendGraphQLRequest("StartSession", `mutation StartSession(
+      $apiKey: UUID!,
+      $recordingSessionId: UUID!,
+      $serviceIdentifier: String!,
+      $serviceVersion: String,
+      $mapUuid: String,
+      $gitSha: String,
+      $library: String,
+      $serviceAdditionalMetadata: JSON,
+      $startRecordingFilePath: String,
+      $startRecordingFileNumber: Int
+    ) {
       startRecordingSession(
         companyApiKey: $apiKey,
-        sessionId: $recordingSessionId
+        sessionId: $recordingSessionId,
+        serviceIdentifier: $serviceIdentifier,
+        serviceVersion: $serviceVersion,
+        mapUuid: $mapUuid,
+        gitSha: $gitSha,
+        library: $library,
+        serviceAdditionalMetadata: $serviceAdditionalMetadata,
+        startRecordingFilePath: $startRecordingFilePath,
+        startRecordingFileNumber: $startRecordingFileNumber
       ) {
         id
       }
@@ -53,6 +75,14 @@ export function startRecordingSession(apiKey, recordingId, backendApi) {
         apiKey,
         recordingSessionId: recordingId,
         backendApi,
+        serviceIdentifier,
+        serviceVersion,
+        mapUuid,
+        gitSha,
+        library,
+        serviceAdditionalMetadata,
+        startRecordingFilePath,
+        startRecordingFileNumber,
     });
 }
 export function sendDomainsToNotPropagateHeaderTo(apiKey, domains, backendApi) {

package/dist/index.js

@@ -771,9 +771,60 @@ function setupFetchInterceptor(domainsToNotPropagateHeadersTo = []) {
         }
     }
 }
+// Note - if you update this, you must copy this function to the documentation in docs/docs/getting-started/updating-autoinstall-prs.md.
+function getCompileTimeGitSha() {
+    // 1) Preferred: a hard-coded global replaced at build time (all bundlers support "define")
+    //    e.g. webpack DefinePlugin/esbuild/rollup/vite: __GIT_SHA__ => JSON.stringify('<sha>')
+    try {
+        const g = globalThis;
+        if (g && typeof g.__GIT_SHA__ === "string" && g.__GIT_SHA__) {
+            return g.__GIT_SHA__;
+        }
+    }
+    catch { }
+    // 2) Common pattern: process.env.GIT_SHA (webpack/rollup/esbuild/parcel)
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const p = typeof process !== "undefined" ? process : undefined;
+        if (p?.env?.GIT_SHA)
+            return String(p.env.GIT_SHA);
+    }
+    catch { }
+    // 3) Vite (or other tools exposing import.meta.env)
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const im = import.meta;
+        if (im?.env?.VITE_GIT_SHA)
+            return String(im.env.VITE_GIT_SHA);
+        if (im?.env?.GIT_SHA)
+            return String(im.env.GIT_SHA);
+    }
+    catch { }
+    return undefined;
+}
+// --- helper for mapUuid default from window ---
+function getMapUuidFromWindow() {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const w = window;
+        if (w && typeof w.sfMapUuid === "string" && w.sfMapUuid) {
+            return w.sfMapUuid;
+        }
+    }
+    catch { }
+    return undefined;
+}
 // Main Recording Function
-export async function startRecording({ apiKey, backendApi = "https://api-service.sailfishqa.com", domainsToPropagateHeaderTo = [], domainsToNotPropagateHeaderTo = [], serviceVersion = "", serviceIdentifier = "", }) {
-    let sessionId = getOrSetSessionId();
+// 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, }) {
+    const effectiveGitSha = gitSha ?? getCompileTimeGitSha();
+    const effectiveServiceIdentifier = serviceIdentifier ?? "";
+    const effectiveServiceVersion = serviceVersion ?? "";
+    const effectiveLibrary = "JS/TS"; // from Recorder.LIBRARY_CHOICES
+    const effectiveMapUuid = getMapUuidFromWindow();
+    const sessionId = getOrSetSessionId();
     initializeDomContentEvents(sessionId);
     initializeConsolePlugin(DEFAULT_CONSOLE_RECORDING_SETTINGS, sessionId);
     storeCredentialsAndConnection({ apiKey, backendApi });
@@ -806,7 +857,7 @@ export async function startRecording({ apiKey, backendApi = "https://api-service
         const captureSettingsResponse = await fetchCaptureSettings(apiKey, backendApi);
         const captureSettings = captureSettingsResponse.data?.captureSettingsFromApiKey ||
             DEFAULT_CAPTURE_SETTINGS;
-        const sessionResponse = await startRecordingSession(apiKey, sessionId, backendApi);
+        const sessionResponse = await startRecordingSession(apiKey, sessionId, backendApi, effectiveServiceIdentifier, effectiveServiceVersion, effectiveMapUuid, effectiveGitSha, effectiveLibrary, serviceAdditionalMetadata);
         if (sessionResponse.data?.startRecordingSession) {
             const websocket = await initializeRecording(captureSettings, 
             // DEFAULT_NETWORK_CAPTURE_SETTINGS,