fix: do not extend session from discarded session replay spans #939
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Joozty
force-pushed
the
fix/session-long-tasks
branch
from
4da363c to
420bd23
Compare
Joozty
commented
Jan 27, 2025
| @@ -206,6 +204,13 @@ const SplunkRumRecorder = { | |||
| return | |||
| } | |||
|
|
|||
| // We need to call it here before another getSessionID call. This will create a new session | |||
| // if the previous one was expired | |||
| if (SplunkRum._internalOnExternalSpanCreated) { | |||
There was a problem hiding this comment.
The hook is called only when we are sure the session recorder chunk is not discarded.
Joozty
commented
Jan 27, 2025
| if (hasNativeSessionId()) { | ||
| return window['SplunkRumNative'].getNativeSessionId() | ||
| } | ||
|
|
||
| return rumSessionId | ||
| return getCurrentSessionState({ useLocalStorage, forceStoreRead: true })?.id |
There was a problem hiding this comment.
When calling getRumSessionId we always read the fresh value from storage. Explained in the PR descriptions.
Joozty
commented
Jan 27, 2025
| @@ -45,7 +45,6 @@ import { context } from '@opentelemetry/api' | |||
| with setting cookies, checking for inactivity, etc. | |||
| */ | |||
|
|
|||
| let rumSessionId: SessionId | undefined | |||
There was a problem hiding this comment.
we no longer have this global variable
Joozty
changed the title
amertak
approved these changes
Jan 27, 2025
millcek
approved these changes
Jan 27, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This update resolves issues with the
_experimental_allSpansExtendSessionflag, which did not work correctly with the session recorder. Spans created via the session recorder improperly extended sessions in a backgrounded tab.Issue:
SplunkRum._internalOnExternalSpanCreated(), which results in either starting a new session or artificially extending the previous session.The changes in this update ensure that the callback is invoked only after confirming that the events will not be discarded.
Possible Breaking Changes
The
SplunkRum.getSessionID()method can return undefined between sessions. It is already typed that way (string|undefined) but the previous implementation would always return string unless agent is not initialized.Previously, it would always return a string, even if the session was no longer active, by incorrectly referencing the previous session. With this change, if there is no activity and no active session, it will return
undefined.Spans initiate sessions, so if you call
getSessionID()between sessions and there is no activity, it will correctly returnundefined.Type of change
Delete options that are not relevant.
How has this been tested?
Delete options that are not relevant.