handzlikchris / handzlikchris/FastScriptReload

Editor Crash when quitting while in Playmode

Open
#160 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
C#
Stars
2.2k
Forks
167
PR merge metrics
No merged PRs in 30d

Description

So when closing the UnityEditor while in playmode, the Finalizer of FastScriptReloadManager causes Unity to Crash.

Here is the Stack Trace from the Unity Log:
```
=================================================================
Managed Stacktrace:
=================================================================
at <0xffffffff>
at UnityEngine.DebugLogHandler:Internal_Log <0x000f9>
at UnityEngine.DebugLogHandler:LogFormat <0x000da>
at UnityEngine.Logger:Log <0x001dd>
at ImmersiveVrToolsCommon.Runtime.Logging.LoggerScoped:LogInternal <0x000eb>
at ImmersiveVrToolsCommon.Runtime.Logging.LoggerScoped:LogError <0x00072>
at FastScriptReload.Editor.FastScriptReloadManager:Finalize <0x00172>
at System.Object:runtime_invoke_virtual_void__this__ <0x0018b>
=================================================================
```

The problem is that LoggerScoped uses `UnityEngine.Debug.unityLogger.Log` in the background, which is `null` as soon as Unity is quitting... An exception in that state causes Unity to hard-crash...
```csharp
private static void LogInternal(LogType logType, object message, Object context)
{
UnityEngine.Debug.unityLogger.Log(logType, string.Empty, (object) (LoggerScoped.LogPrefix + message), context);
}
```

To fix the issue I created a Flag that is set as reaction to the quitting Event of the Editor Application.
When the flag is set during deconstruction, it exits early and makes no calls to the LoggerScoped.
Cleanup of the FileWatchers should be savely ommittable in this instance as the process is shutting down anyway. The watchers being IDisposables should automatically dispose themselves.

```diff
@@ -239,6 +239,10 @@ static FastScriptReloadManager()
//do not add init code in here as with domain reload turned off it won't be properly set on play-mode enter, use Init method instead
EditorApplication.update += Instance.Update;
EditorApplication.playModeStateChanged += Instance.OnEditorApplicationOnplayModeStateChanged;
+ EditorApplication.quitting += () =>
+ {
+ _editorIsClosing = true;
+ };

///if is enabled, disable auto reload automatically when launching editor. Will be enabled automatically when adding file watcher manually
if ((bool)FastScriptReloadPreference.WatchOnlySpecified.GetEditorPersistedValueOrDefault() && SessionState.GetBool("NEED_EDITOR_SESSION_INIT", true))
@@ -248,8 +252,10 @@ static FastScriptReloadManager()
}
}

+ private static bool _editorIsClosing;
~FastScriptReloadManager()
{
+ if (_editorIsClosing) return;
LoggerScoped.LogDebug("Destroying FSR Manager ");
if (_instance != null)
{
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.