make gameenge disposable and cleanup FS handler

Author: AnakinRaW

src/ModVerify/GameVerifyPipeline.cs

@@ -35,6 +35,8 @@ internal sealed class GameVerifyPipeline : StepRunnerPipelineBase<AsyncStepRunne
     private readonly VerificationBaseline _baseline;
     private readonly SuppressionList _suppressions;
 
+    private IStarWarsGameEngineHandle? _gameEngine;
+
     internal IReadOnlyCollection<VerificationError> Errors => [.._errors];
 
     internal IReadOnlyCollection<IGameVerifierInfo> Verifiers => [.. _verifiers];
@@ -78,28 +80,27 @@ protected override async Task PrepareCoreAsync(CancellationToken token)
         _verifiers.Clear();
         _errors.Clear();
 
-        IStarWarsGameEngine gameEngine;
-
         try
         {
             var engineService = ServiceProvider.GetRequiredService<IPetroglyphStarWarsGameEngineService>();
-            gameEngine = await engineService.InitializeAsync(
+            _gameEngine = await engineService.InitializeAsync(
                 _verificationTarget.Engine,
                 _verificationTarget.Location,
                 _engineErrorReporter,
                 _engineInitializationReporter,
                 false,
-                CancellationToken.None).ConfigureAwait(false);
+                configureFileSystem:fs => fs.UseLiveVirtualStrategy(),
+                cancellationToken: CancellationToken.None).ConfigureAwait(false);
         }
         catch (Exception e)
         {
             Logger?.LogError(e, "Creating game engine failed: {Message}", e.Message);
             throw;
         }
 
-        AddStep(new GameEngineErrorCollector(_engineErrorReporter, gameEngine, _serviceSettings.GameVerifySettings, ServiceProvider));
+        AddStep(new GameEngineErrorCollector(_engineErrorReporter, _gameEngine, _serviceSettings.GameVerifySettings, ServiceProvider));
 
-        foreach (var gameVerificationStep in CreateVerifiers(gameEngine))
+        foreach (var gameVerificationStep in CreateVerifiers(_gameEngine))
             AddStep(gameVerificationStep);
     }
 
@@ -147,6 +148,8 @@ protected override void DisposeResources()
         _engineErrorReporter.Clear();
         _aggregatedVerifyProgressReporter?.Dispose();
         _aggregatedVerifyProgressReporter = null;
+        _gameEngine?.Dispose();
+        _gameEngine = null;
     }
 
     private void AddStep(GameVerifier verifier)

src/PetroglyphTools/PG.StarWarsGame.Engine/GameEngine.cs

@@ -1,4 +1,6 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
+using System.Threading;
 using PG.StarWarsGame.Engine.Audio.Sfx;
 using PG.StarWarsGame.Engine.CommandBar;
 using PG.StarWarsGame.Engine.GameConstants;
@@ -11,25 +13,83 @@
 
 namespace PG.StarWarsGame.Engine;
 
-internal sealed class GameEngine : IStarWarsGameEngine
+internal sealed class GameEngine : IStarWarsGameEngineHandle
 {
+    private int _disposed;
+
+    private PetroglyphFileSystem? _pgFileSystem;
+
     public required GameEngineType EngineType { get; init; }
 
-    public required IPGRender PGRender { get; init; }
+    public required IPGRender PGRender
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
+
+    public required IFontManager FontManager
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
+
+    public required ICommandBarGameManager CommandBar
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required IFontManager FontManager { get; init; }
+    public required IGameRepository GameRepository
+    {
+        get { ThrowIfDisposed(); return field; }
+        init
+        {
+            field = value;
+            _pgFileSystem = value.PGFileSystem;
+        }
+    }
 
-    public required ICommandBarGameManager CommandBar { get; init; }
+    public required IGameConstants GameConstants
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required IGameRepository GameRepository { get; init; }
+    public required IGuiDialogManager GuiDialogManager
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required IGameConstants GameConstants { get; init; }
+    public required IGameObjectTypeGameManager GameObjectTypeManager
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required IGuiDialogManager GuiDialogManager { get; init; }
+    public required ISfxEventGameManager SfxGameManager
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required IGameObjectTypeGameManager GameObjectTypeManager { get; init; }
+    public required IEnumerable<LanguageType> InstalledLanguages
+    {
+        get { ThrowIfDisposed(); return field; }
+        init;
+    }
 
-    public required ISfxEventGameManager SfxGameManager { get; init; }
+    public void Dispose()
+    {
+        if (Interlocked.Exchange(ref _disposed, 1) != 0)
+            return;
+        _pgFileSystem?.CleanupStrategy();
+        _pgFileSystem = null;
+    }
 
-    public required IEnumerable<LanguageType> InstalledLanguages { get; init; }
-}
+    private void ThrowIfDisposed()
+    {
+        if (_disposed != 0)
+            throw new ObjectDisposedException(nameof(GameEngine));
+    }
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/IPetroglyphStarWarsGameEngineService.cs

@@ -1,16 +1,19 @@
-using System.Threading;
+using System;
+using System.Threading;
 using System.Threading.Tasks;
 using PG.StarWarsGame.Engine.ErrorReporting;
+using PG.StarWarsGame.Engine.IO;
 
 namespace PG.StarWarsGame.Engine;
 
 public interface IPetroglyphStarWarsGameEngineService
 {
-    public Task<IStarWarsGameEngine> InitializeAsync(
+    public Task<IStarWarsGameEngineHandle> InitializeAsync(
         GameEngineType engineType,
         GameLocations gameLocations,
         IGameEngineErrorReporter? errorReporter = null,
-        IGameEngineInitializationReporter? initReporter = null, 
+        IGameEngineInitializationReporter? initReporter = null,
         bool cancelOnInitializationError = false,
+        Action<PetroglyphFileSystem>? configureFileSystem = null,
         CancellationToken cancellationToken = default);
 }

src/PetroglyphTools/PG.StarWarsGame.Engine/IStarWarsGameEngineHandle.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace PG.StarWarsGame.Engine;
+
+/// <summary>
+/// An owned reference to a <see cref="IStarWarsGameEngine"/> that controls its lifetime.
+/// Disposing this handle releases all resources held by the engine.
+/// </summary>
+public interface IStarWarsGameEngineHandle : IStarWarsGameEngine, IDisposable
+{
+}

src/PetroglyphTools/PG.StarWarsGame.Engine/PetroglyphStarWarsGameEngineService.cs

@@ -23,12 +23,13 @@ internal sealed class PetroglyphStarWarsGameEngineService(IServiceProvider servi
     private readonly ILogger? _logger = serviceProvider.GetService<ILoggerFactory>()
         ?.CreateLogger(typeof(PetroglyphStarWarsGameEngineService));
 
-    public async Task<IStarWarsGameEngine> InitializeAsync(
+    public async Task<IStarWarsGameEngineHandle> InitializeAsync(
         GameEngineType engineType,
         GameLocations gameLocations,
         IGameEngineErrorReporter? errorReporter = null,
         IGameEngineInitializationReporter? initReporter = null,
         bool cancelOnInitializationError = false,
+        Action<PetroglyphFileSystem>? configureFileSystem = null,
         CancellationToken cancellationToken = default)
 
     {
@@ -39,7 +40,7 @@ public async Task<IStarWarsGameEngine> InitializeAsync(
 
         try
         {
-            return await InitializeEngineAsync(engineType, gameLocations, errorListenerWrapper, initReporter, cts.Token)
+            return await InitializeEngineAsync(engineType, gameLocations, errorListenerWrapper, initReporter, configureFileSystem, cts.Token)
                 .ConfigureAwait(false);
         }
         finally
@@ -57,11 +58,12 @@ void OnInitializationError(object sender, InitializationError e)
         }
     }
 
-    private async Task<IStarWarsGameEngine> InitializeEngineAsync(
+    private async Task<IStarWarsGameEngineHandle> InitializeEngineAsync(
         GameEngineType engineType,
         GameLocations gameLocations,
         GameEngineErrorReporterWrapper errorReporter,
         IGameEngineInitializationReporter? initReporter,
+        Action<PetroglyphFileSystem>? configureFileSystem,
         CancellationToken token)
     {
         try
@@ -71,6 +73,7 @@ private async Task<IStarWarsGameEngine> InitializeEngineAsync(
 
             var repoFactory = _serviceProvider.GetRequiredService<IGameRepositoryFactory>();
             var repository = repoFactory.Create(engineType, gameLocations, errorReporter);
+            configureFileSystem?.Invoke(repository.PGFileSystem);
 
             var pgRender = new PGRender(repository, errorReporter, serviceProvider);