Auto Session Tracking should only be enabled by default on Mobile until total process isolation is supported

The session support currently expects exclusive access to the directory it caches data. This works well in sandboxed apps like on mobile but not on Desktop when multiple instances can be executed concurrently.

For this reason, until getsentry/sentry-dotnet#1067 is fixed, we can only opt-in to auto session tracking safely if we are sure there's only 1 instance of the app (mobile, or a player on desktop that only allows one instance running).

When PlayerSettings.forceSingleInstance is set we're safe to enable auto session tracking. Also if the player is Android or iOS and console.

PlayerSettings.forceSingleInstance is present in UnityEditor.dll and not available in Sentry.Unity (references UnityEngine) where logic for this is executing (SentryOptionsUtility.SetDefaults).

There are 2 possible approaches to determine the platform: Application.platform or Platform dependent compilation.

Suggested way is to use Platform dependent compilation approach. But the problem is still in PlayerSettings.forceSingleInstance not available at the place of calling.

Possible implementation could look something like this

scriptableOptions.AutoSessionTracking = IsAutoSessionTracking(options.AutoSessionTracking);

private bool IsAutoSessionTracking(bool autoSessionTracking)
{
#if UNITY_IOS || UNITY_ANDROID || UNITY_PS4 || UNITY_XBOXONE
    return autoSessionTracking;
#elif UNITY_STANDALONE || UNITY_EDITOR
    return PlayerSettings.forceSingleInstance;
#else
    return autoSessionTracking;
#endif
}

SentryWindow runs in the editor (Sentry.Unity.Editor), we could read PlayerSettings.forceSingleInstance there and set it to the scriptable object and rely on that value at runtime to disable auto session tracking if the Application.platform is standalone and forceSingleInstance is not true.

Or we live with this until we address getsentry/sentry-dotnet#1067

The SentryWindow would not get notified about a change to the player settings. But we could read them during pre-build and set it accordingly?

As per a discord discussion:

this is rather important for the Windows standalone support so bumping to P1
until the dotnet issue is resolved, implement a named mutex so that exactly one instance of the app uses the cache dir

fix: add a workaround for #264 - don't run multiple sessions at the s…

Updating impact, priority & status after the workaround has been implemented. The final solution is blocked by the dotnet issue.

fix: add a workaround for #264 - don't run multiple sessions at the s…

Don't run sentry-dotnet with multiple app instances at the same time …

Navigation Menu

Repository navigation

Auto Session Tracking should only be enabled by default on Mobile until total process isolation is supported #264

3 remaining items

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Auto Session Tracking should only be enabled by default on Mobile until total process isolation is supported #264

Description

Activity

semuserable commented on Jul 30, 2021

bruno-garcia commented on Aug 3, 2021

bitsandfoxes commented on Sep 16, 2021

vaind commented on Mar 11, 2022

3 remaining items

vaind commented on Mar 21, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions