feat: Cache Unhandled session instead of sending it immediately

[bitsandfoxes]

Resolves #4632
Followup on #4633

Problem

Sessions that end in Unhandled can later on still crash. Updating a session with an end status is a terminal operation, see getsentry/sentry-docs#15086 and once updated, sessions must not receive further updates. We need to make sure the SDK finishes a session only when it is confident, that a session is actually finished.

Proposal

Instead of updating (and ending) a session with SessionEndStatus.Unhandled right away we persist the state to disk. We can make use of the fact that there is a separation between PersistedSessionUpdate and SessionUpdate.

• PersistedSessionUpdate is used locally only, the SDK does not send this to Sentry and we can add a flag PendingUnhandled to it
• SessionUpdate is the actual update the SDK sends to Sentry

The flow is as follows:

1. Unhandled non-terminal exception captured (i.e. via Unity loghandling)
2. The client triggers the session to be marked as Unhandled and the update is persisted to disk
3. If the app crashes we end the session as Crashed, overwriting the pending unhandled state
4. If the app exits normally, we check for the endstatus and overwrite Exited with Unhandled.

TODO

Currently, the SDK relies on restarts of the application to send the SessionEndStatus. Ideally, we would also hook into some shutdown mechanism, or at the very least, closing the SDK should also end any active sessions.

[github-actions]

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against a7ff327

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.20%. Comparing base (624524f) to head (a7ff327).

Additional details and impacted files

@@                       Coverage Diff                       @@
##           feat/session-type-unhandled    #4653      +/-   ##
===============================================================
+ Coverage                        73.17%   73.20%   +0.03%     
===============================================================
  Files                              479      479              
  Lines                            17349    17370      +21     
  Branches                          3426     3431       +5     
===============================================================
+ Hits                             12695    12716      +21     
  Misses                            3804     3804              
  Partials                           850      850              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[cursor]

Bug: Session State Loss During Persistence

The PauseSession method calls PersistSession without passing the pendingUnhandled state. This causes sessions marked as pending unhandled to lose this status when persisted, leading to them being incorrectly recovered as Exited instead of Unhandled on app restart.

src/Sentry/GlobalSessionManager.cs#L43-L44

sentry-dotnet/src/Sentry/GlobalSessionManager.cs

Lines 43 to 44 in a7ff327

	// potential race conditions.
	private void PersistSession(SessionUpdate update, DateTimeOffset? pauseTimestamp = null, bool pendingUnhandled = false)

src/Sentry/GlobalSessionManager.cs#L290-L305

sentry-dotnet/src/Sentry/GlobalSessionManager.cs

Lines 290 to 305 in a7ff327

	public void PauseSession()
	{
	if (_currentSession is not { } session)
	{
	_options.LogWarning("Attempted to pause a session, but a session has not been started.");
	return;
	}
	_options.LogInfo("Pausing session (SID: {0}; DID: {1}).", session.Id, session.DistinctId);
	var now = _clock.GetUtcNow();
	_lastPauseTimestamp = now;
	PersistSession(session.CreateUpdate(false, now), now);
	}
	public IReadOnlyList<SessionUpdate> ResumeSession()

 

---