rename to getReplayId

Author: mydea

packages/replay/README.md

@@ -140,7 +140,7 @@ A session starts when the Session Replay SDK is first loaded and initialized. Th
 
 ### Accessing the Replay Session ID
 
-You can get the ID of the currently running session via `replay.getSessionId()`.
+You can get the ID of the currently running session via `replay.getReplayId()`.
 This will return `undefined` if no session is ongoing.
 
 ### Replay Captures Only on Errors

packages/replay/src/coreHandlers/handleGlobalEvent.ts

@@ -38,7 +38,7 @@ export function handleGlobalEventListener(
 
     // Only tag transactions with replayId if not waiting for an error
     if (isErrorEvent(event) || (isTransactionEvent(event) && replay.recordingMode === 'session')) {
-      event.tags = { ...event.tags, replayId: replay.getSessionId() };
+      event.tags = { ...event.tags, replayId: replay.getReplayId() };
     }
 
     if (__DEBUG_BUILD__ && replay.getOptions()._experiments.traceInternals && isErrorEvent(event)) {

packages/replay/src/integration.ts

@@ -229,12 +229,12 @@ Sentry.init({ replaysOnErrorSampleRate: ${errorSampleRate} })`,
   /**
    * Get the current session ID.
    */
-  public getSessionId(): string | undefined {
+  public getReplayId(): string | undefined {
     if (!this._replay || !this._replay.isEnabled()) {
       return;
     }
 
-    return this._replay.getSessionId();
+    return this._replay.getReplayId();
   }
 
   /** Setup the integration. */

packages/replay/src/replay.ts

@@ -359,7 +359,7 @@ export class ReplayContainer implements ReplayContainerInterface {
   }
 
   /** Get the current sesion (=replay) ID */
-  public getSessionId(): string | undefined {
+  public getReplayId(): string | undefined {
     return this.session && this.session.id;
   }
 
@@ -372,7 +372,7 @@ export class ReplayContainer implements ReplayContainerInterface {
    * @hidden
    */
   public checkAndHandleExpiredSession(): boolean | void {
-    const oldSessionId = this.getSessionId();
+    const oldSessionId = this.getReplayId();
 
     // Prevent starting a new session if the last user activity is older than
     // SESSION_IDLE_DURATION. Otherwise non-user activity can trigger a new
@@ -399,7 +399,7 @@ export class ReplayContainer implements ReplayContainerInterface {
     }
 
     // Session was expired if session ids do not match
-    const expired = oldSessionId !== this.getSessionId();
+    const expired = oldSessionId !== this.getReplayId();
 
     if (!expired) {
       return true;
@@ -458,7 +458,7 @@ export class ReplayContainer implements ReplayContainerInterface {
       this.setInitialState();
     }
 
-    const currentSessionId = this.getSessionId();
+    const currentSessionId = this.getReplayId();
     if (session.id !== currentSessionId) {
       session.previousSessionId = currentSessionId;
     }

packages/replay/src/types.ts

@@ -445,7 +445,7 @@ export interface ReplayContainer {
   triggerUserActivity(): void;
   addUpdate(cb: AddUpdateCallback): void;
   getOptions(): ReplayPluginOptions;
-  getSessionId(): string | undefined;
+  getReplayId(): string | undefined;
   checkAndHandleExpiredSession(): boolean | void;
   setInitialState(): void;
 }

packages/replay/src/util/addGlobalListeners.ts

@@ -34,7 +34,7 @@ export function addGlobalListeners(replay: ReplayContainer): void {
   if (hasHooks(client)) {
     client.on('afterSendEvent', handleAfterSendEvent(replay));
     client.on('createDsc', (dsc: DynamicSamplingContext) => {
-      const replayId = replay.getSessionId();
+      const replayId = replay.getReplayId();
       if (replayId) {
         dsc.replay_id = replayId;
       }

packages/replay/test/integration/getSessionId.test.ts renamed to packages/replay/test/integration/getReplayId.test.ts

@@ -3,7 +3,7 @@ import { useFakeTimers } from '../utils/use-fake-timers';
 
 useFakeTimers();
 
-describe('Integration | getSessionId', () => {
+describe('Integration | getReplayId', () => {
   afterEach(() => {
     jest.clearAllMocks();
   });
@@ -15,12 +15,12 @@ describe('Integration | getSessionId', () => {
       },
     });
 
-    expect(integration.getSessionId()).toBeDefined();
-    expect(integration.getSessionId()).toEqual(replay.session?.id);
+    expect(integration.getReplayId()).toBeDefined();
+    expect(integration.getReplayId()).toEqual(replay.session?.id);
 
     // When stopped, it is undefined
     integration.stop();
 
-    expect(integration.getSessionId()).toBeUndefined();
+    expect(integration.getReplayId()).toBeUndefined();
   });
 });