Merge pull request #135 from AlamoEngine-Tools/develop

Fix accidental disposing of singleton services.

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/LinuxSteamWrapperTest.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO.Abstractions;
 using AET.SteamAbstraction.Games;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/SteamLibraryFinderTest.cs

@@ -2,6 +2,7 @@
 using System.IO.Abstractions;
 using System.Linq;
 using AET.SteamAbstraction.Library;
+using AET.SteamAbstraction.Registry;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;
 using Testably.Abstractions.Testing;

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/SteamRegistryFactoryTest.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO.Abstractions;
 using System.Runtime.InteropServices;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using AnakinRaW.CommonUtilities.Registry;
 using Microsoft.Extensions.DependencyInjection;

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/SteamWrapperFactoryTest.cs

@@ -1,5 +1,6 @@
 using System;
 using System.IO.Abstractions;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/SteamWrapperTest.cs

@@ -6,6 +6,7 @@
 using System.Threading.Tasks;
 using AET.SteamAbstraction.Games;
 using AET.SteamAbstraction.Library;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;

src/AET.SteamAbstraction/AET.SteamAbstraction.Test/WindowsSteamWrapperTest.cs

@@ -2,6 +2,7 @@
 using System.Diagnostics;
 using System.IO.Abstractions;
 using AET.SteamAbstraction.Games;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;

src/AET.SteamAbstraction/AET.SteamAbstraction/Games/ISteamGameLocationFinder.cs

@@ -1,8 +1,6 @@
-using System;
+namespace AET.SteamAbstraction.Games;
 
-namespace AET.SteamAbstraction.Games;
-
-internal interface ISteamGameFinder : IDisposable
+internal interface ISteamGameFinder
 {
     SteamAppManifest? FindGame(uint gameId);
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/Games/SteamGameFinder.cs

@@ -1,12 +1,11 @@
 using System;
 using System.Linq;
 using AET.SteamAbstraction.Library;
-using AnakinRaW.CommonUtilities;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace AET.SteamAbstraction.Games;
 
-internal class SteamGameFinder : DisposableObject, ISteamGameFinder
+internal class SteamGameFinder : ISteamGameFinder
 {
     private readonly ISteamLibraryFinder _libraryFinder;
 
@@ -26,10 +25,4 @@ public SteamGameFinder(IServiceProvider serviceProvider)
             .FirstOrDefault(matching => matching is not null);
         return game;
     }
-
-    protected override void DisposeManagedResources()
-    {
-        base.DisposeManagedResources();
-        _libraryFinder.Dispose();
-    }
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/Library/ISteamLibraryFinder.cs

@@ -1,9 +1,8 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 
 namespace AET.SteamAbstraction.Library;
 
-internal interface ISteamLibraryFinder : IDisposable
+internal interface ISteamLibraryFinder
 {
     IEnumerable<ISteamLibrary> FindLibraries();
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/Library/SteamLibrary.cs

@@ -16,9 +16,9 @@ internal class SteamLibrary : ISteamLibrary
 
     private readonly Dictionary<KnownLibraryLocations, string[]> _locationsNames = new()
     {
-        { KnownLibraryLocations.SteamApps, new[] { "steamapps" } },
-        { KnownLibraryLocations.Common, new[] { "steamapps", "common" } },
-        { KnownLibraryLocations.Workshops, new[] { "steamapps", "workshop" } }
+        { KnownLibraryLocations.SteamApps, ["steamapps"] },
+        { KnownLibraryLocations.Common, ["steamapps", "common"] },
+        { KnownLibraryLocations.Workshops, ["steamapps", "workshop"] }
     };
 
     private readonly string _normalizedLocation;

src/AET.SteamAbstraction/AET.SteamAbstraction/Library/SteamLibraryFinder.cs

@@ -1,15 +1,15 @@
 using System;
 using System.Collections.Generic;
 using System.IO.Abstractions;
-using AnakinRaW.CommonUtilities;
+using AET.SteamAbstraction.Registry;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace AET.SteamAbstraction.Library;
 
-internal class SteamLibraryFinder(IServiceProvider serviceProvider) : DisposableObject, ISteamLibraryFinder
+internal class SteamLibraryFinder(IServiceProvider serviceProvider) : ISteamLibraryFinder
 {
     private readonly IServiceProvider _serviceProvider = serviceProvider ?? throw new ArgumentNullException(nameof(serviceProvider));
-    private readonly ISteamRegistry _registry = serviceProvider.GetRequiredService<ISteamRegistryFactory>().CreateRegistry();
+    private readonly ISteamRegistryFactory _registryFactory = serviceProvider.GetRequiredService<ISteamRegistryFactory>();
     private readonly IFileSystem _fileSystem = serviceProvider.GetRequiredService<IFileSystem>();
     private readonly ISteamVdfReader _configReader = serviceProvider.GetRequiredService<ISteamVdfReader>();
 
@@ -41,7 +41,8 @@ private bool TryCreateLibraryFromLocation(IDirectoryInfo libraryLocation, out St
 
     private IFileInfo? GetLibraryLocationsFile()
     {
-        var steamInstallLocation = _registry.InstallationDirectory;
+        using var registry = _registryFactory.CreateRegistry();
+        var steamInstallLocation = registry.InstallationDirectory;
         if (steamInstallLocation is null)
             throw new SteamException("Unable to find an installation of Steam.");
 
@@ -56,10 +57,4 @@ private bool TryCreateLibraryFromLocation(IDirectoryInfo libraryLocation, out St
 
         return libraryLocationsFile.Exists ? libraryLocationsFile : null;
     }
-
-    protected override void DisposeManagedResources()
-    {
-        base.DisposeManagedResources();
-        _registry.Dispose();
-    }
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/Linux/LinuxSteamRegistry.cs

@@ -1,5 +1,6 @@
 using System;
 using System.IO.Abstractions;
+using AET.SteamAbstraction.Registry;
 using AnakinRaW.CommonUtilities;
 
 namespace AET.SteamAbstraction;

src/AET.SteamAbstraction/AET.SteamAbstraction/Linux/LinuxSteamWrapper.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Threading;
 using System.Threading.Tasks;
+using AET.SteamAbstraction.Registry;
 
 namespace AET.SteamAbstraction;
 

src/AET.SteamAbstraction/AET.SteamAbstraction/NativeMethods/WindowHandleInfo.cs

@@ -8,7 +8,7 @@ internal class WindowHandleInfo(IntPtr handle)
 {
     public List<IntPtr> GetAllChildHandles()
     {
-        List<IntPtr> childHandles = new();
+        List<IntPtr> childHandles = [];
 
         var gcChildHandlesList = GCHandle.Alloc(childHandles);
         var pointerChildHandlesList = GCHandle.ToIntPtr(gcChildHandlesList);

src/AET.SteamAbstraction/AET.SteamAbstraction/ISteamRegistry.cs → src/AET.SteamAbstraction/AET.SteamAbstraction/Registry/ISteamRegistry.cs

@@ -1,9 +1,7 @@
 using System;
-using System.Collections.Generic;
 using System.IO.Abstractions;
-using AnakinRaW.CommonUtilities.Registry;
 
-namespace AET.SteamAbstraction;
+namespace AET.SteamAbstraction.Registry;
 
 /// <summary>
 /// Registry representation for the Steam Client.
@@ -24,13 +22,4 @@ internal interface ISteamRegistry : IDisposable
     /// The installation directory of the Steam client
     /// </summary>
     IDirectoryInfo? InstallationDirectory { get; }
-}
-
-internal interface IWindowsSteamRegistry : ISteamRegistry
-{
-    IRegistryKey? ActiveProcessKey { get; }
-
-    int? ProcessId { get; }
-
-    ISet<uint>? InstalledApps { get; }
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/ISteamRegistryFactory.cs → src/AET.SteamAbstraction/AET.SteamAbstraction/Registry/ISteamRegistryFactory.cs

@@ -1,4 +1,4 @@
-namespace AET.SteamAbstraction;
+namespace AET.SteamAbstraction.Registry;
 
 internal interface ISteamRegistryFactory
 {

src/AET.SteamAbstraction/AET.SteamAbstraction/Registry/IWindowsSteamRegistry.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using AnakinRaW.CommonUtilities.Registry;
+
+namespace AET.SteamAbstraction.Registry;
+
+internal interface IWindowsSteamRegistry : ISteamRegistry
+{
+    IRegistryKey? ActiveProcessKey { get; }
+
+    int? ProcessId { get; }
+
+    ISet<uint>? InstalledApps { get; }
+}

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamRegistryFactory.cs → src/AET.SteamAbstraction/AET.SteamAbstraction/Registry/SteamRegistryFactory.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Runtime.InteropServices;
 
-namespace AET.SteamAbstraction;
+namespace AET.SteamAbstraction.Registry;
 
 internal class SteamRegistryFactory(IServiceProvider serviceProvider) : ISteamRegistryFactory
 {

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamAbstractionLayer.cs

@@ -1,5 +1,6 @@
 using AET.SteamAbstraction.Games;
 using AET.SteamAbstraction.Library;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -8,7 +9,7 @@ namespace AET.SteamAbstraction;
 /// <summary>
 /// Provides initialization routines for this library.
 /// </summary>
-public class SteamAbstractionLayer
+public static class SteamAbstractionLayer
 {
     /// <summary>
     /// Adds services provided by this library to the given <paramref name="serviceCollection"/>

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamException.cs

@@ -21,13 +21,4 @@ public SteamException(string message) : base(message)
     public SteamException(string message, Exception exception) : base(message, exception)
     {
     }
-}
-
-
-/// <summary>
-/// 
-/// </summary>
-public sealed class SteamNotFoundException : SteamException
-{
-
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamNotFoundException.cs

@@ -0,0 +1,6 @@
+namespace AET.SteamAbstraction;
+
+/// <summary>
+/// Exception which gets thrown if an installation of Steam was not found.
+/// </summary>
+public sealed class SteamNotFoundException : SteamException;

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamWrapper.cs

@@ -6,6 +6,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using AET.SteamAbstraction.Games;
+using AET.SteamAbstraction.Registry;
 using AnakinRaW.CommonUtilities;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -63,7 +64,7 @@ public bool IsUserLoggedIn
     public virtual bool IsGameInstalled(uint gameId, [NotNullWhen(true)] out SteamAppManifest? game)
     {
         ThrowIfSteamNotInstalled();
-        using var gameFinder = ServiceProvider.GetRequiredService<ISteamGameFinder>();
+        var gameFinder = ServiceProvider.GetRequiredService<ISteamGameFinder>();
         game = gameFinder.FindGame(gameId);
         return game is not null;
     }

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamWrapperFactory.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Runtime.InteropServices;
+using AET.SteamAbstraction.Registry;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace AET.SteamAbstraction;

src/AET.SteamAbstraction/AET.SteamAbstraction/Windows/WindowsSteamRegistry.cs

@@ -3,6 +3,7 @@
 using System.IO.Abstractions;
 using System;
 using System.Linq;
+using AET.SteamAbstraction.Registry;
 using AnakinRaW.CommonUtilities;
 using Microsoft.Extensions.DependencyInjection;
 

src/AET.SteamAbstraction/AET.SteamAbstraction/Windows/WindowsSteamWrapper.cs

@@ -7,6 +7,7 @@
 using System.Threading.Tasks;
 using AET.SteamAbstraction.Games;
 using AET.SteamAbstraction.NativeMethods;
+using AET.SteamAbstraction.Registry;
 using AET.SteamAbstraction.Utilities;
 using AnakinRaW.CommonUtilities.Registry.Windows;
 using Microsoft.Extensions.DependencyInjection;