feat: introduce _experimental_discardDataAfterInactivity (#1670)

Author: amertak

packages/session-recorder/src/index.ts

@@ -272,7 +272,11 @@ const SplunkRumRecorder = {
 					return
 				}
 
-				if (currentState.state === 'expired-duration' && recorder) {
+				if (
+					currentState.state === 'expired-duration' ||
+					(currentState.state === 'expired-inactivity' &&
+						SplunkRum._processedOptions?._experimental_discardDataAfterInactivity)
+				) {
 					recorder?.stop()
 					recorder?.destroy()
 					recorder = undefined

packages/web/src/index.ts

@@ -564,13 +564,18 @@ export const SplunkRum: SplunkOtelWebType = {
 				}
 			})
 
-			this.attributesProcessor = new SplunkSpanAttributesProcessor(this.sessionManager, this.userManager, {
-				...(deploymentEnvironment
-					? { 'deployment.environment': deploymentEnvironment, 'environment': deploymentEnvironment }
-					: {}),
-				...(version ? { 'app.version': version } : {}),
-				...processedOptions.globalAttributes,
-			})
+			this.attributesProcessor = new SplunkSpanAttributesProcessor(
+				this.sessionManager,
+				this.userManager,
+				{
+					...(deploymentEnvironment
+						? { 'deployment.environment': deploymentEnvironment, 'environment': deploymentEnvironment }
+						: {}),
+					...(version ? { 'app.version': version } : {}),
+					...processedOptions.globalAttributes,
+				},
+				processedOptions._experimental_discardDataAfterInactivity,
+			)
 
 			const spanProcessors: SpanProcessor[] = [this.attributesProcessor]
 

packages/web/src/managers/session-manager/session-manager.test.ts

@@ -250,7 +250,13 @@ describe('SessionManager', () => {
 						startTime: expect.any(Number),
 						state: 'active',
 					},
-					previousState: null,
+					previousState: {
+						expiresAt: expect.any(Number),
+						id: expect.any(String),
+						source: 'web',
+						startTime: expect.any(Number),
+						state: 'active',
+					},
 				}),
 			)
 		})
@@ -508,7 +514,13 @@ describe('SessionManager', () => {
 						startTime: expect.any(Number),
 						state: 'active',
 					},
-					previousState: null,
+					previousState: {
+						expiresAt: expect.any(Number),
+						id: expect.any(String),
+						source: 'web',
+						startTime: expect.any(Number),
+						state: 'active',
+					},
 				}),
 			)
 		})

packages/web/src/managers/session-manager/session-manager.ts

@@ -51,6 +51,7 @@ export class SessionManager {
 	private set session(state: SessionState) {
 		const previousState = this._session
 		this._session = state
+		this.previousSessionState = previousState
 		this.sessionHistory.set(state.id, state)
 
 		diag.debug('SessionManager: Updating session', { currentState: state, previousState })

packages/web/src/splunk-span-attributes-processor.ts

@@ -28,6 +28,7 @@ export class SplunkSpanAttributesProcessor implements SpanProcessor {
 		private sessionManager: SessionManager,
 		private userManager: UserManager,
 		globalAttributes: Attributes,
+		private readonly _experimental_discardDataAfterInactivity: boolean = false,
 	) {
 		this._globalAttributes = globalAttributes ?? {}
 	}
@@ -63,7 +64,13 @@ export class SplunkSpanAttributesProcessor implements SpanProcessor {
 
 		const sessionState = this.sessionManager.getSessionState()
 
-		if (sessionState.state !== 'expired-duration') {
+		// Negated condition was hard to read
+		if (
+			sessionState.state === 'expired-duration' ||
+			(sessionState.state === 'expired-inactivity' && this._experimental_discardDataAfterInactivity)
+		) {
+			// Do not attach session ID to the span
+		} else {
 			span.setAttribute('splunk.rumSessionId', sessionState.id)
 		}
 

packages/web/src/types/config.ts

@@ -97,6 +97,12 @@ export interface SplunkOtelWebConfig {
 	 */
 	_experimental_dataAttributesToCapture?: string[]
 
+	/**
+	 * Experimental: If true, no additional span will be sent after 15 minutes of user inactivity (it will be dropped).
+	 * @default false
+	 */
+	_experimental_discardDataAfterInactivity?: boolean
+
 	/**
 	 * @deprecated Please use `spaMetrics` instead.
 	 */