Add doNotEndWithSession public API for replays #4794
Description
Description
Currently, the replay lifecycle is the same one as we have for session health. Citing our docs:
A user session starts when the Sentry SDK is initialized or when the application enters the foreground. The session will capture screen transitions, navigations, touches and other events until the application is sent to the background. If the application is brought back to the foreground within 30 seconds (default), the same replay_id will be used and the session will continue.
The session will be terminated if the application has spent in the background more than 30 seconds or when the maximum duration of 60 minutes is reached. You can adjust the session tracking interval to extend or shorten the duration of a single replay, depending on your needs.
However, this might not be always suitable, for example, when there's a webview/chrome custom tab is involved in a user session (auth screen). A user can spend more than the default 30 seconds there, which would result in an abrupt session and would not reflect the real flow. We could potentially circumvent this by either:
- Adding a new public API that says
replay().doNotEndWithSession()(name TBD) that will prevent replay termination when this API is called. - Or having an option in SentryOptions that would decouple replays and sessions lifecycle
- ... (other ideas here)