handzlikchris / handzlikchris/FastScriptReload

Editor Crash when quitting while in Playmode

オープン
#160 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
bug
主要言語
C#
スター
2.2k
フォーク
167
PR マージ指標
30日以内にマージされた PR はありません

説明

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)
{
```

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

FastScriptReloadManager の静的初期化とファイナライザから始め、次に issue で説明されている LoggerScoped.LogInternal と EditorApplication.quitting イベントを調べます。Playmode 中に Unity Editor を終了して再現します。完了の条件は、manager のファイナライズ時にシャットダウンでクラッシュしなくなり、通常のクリーンアップには影響がないことです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, unity
領域
game-dev, tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。