Merge pull request #2849 from Nexus-Mods/fix/clear-empty-folders

Cleanup empty directories when switching loadouts

Author: Al12rs

src/Abstractions/NexusMods.Abstractions.Loadouts.Synchronizers/ALoadoutSynchronizer.cs

@@ -553,7 +553,7 @@ public async Task RunActions(Dictionary<GamePath, SyncNode> syncTree, GameInstal
         var gameMetadataId = gameInstallation.GameMetadataId;
         var gameMetadata = GameInstallMetadata.Load(Connection.Db, gameMetadataId);
         var register = gameInstallation.LocationsRegister;
-        var deletedFiles = new HashSet<(GamePath GamePath, AbsolutePath FullPath)>();
+        HashSet<(GamePath GamePath, AbsolutePath FullPath)> foldersWithDeletedFiles = [];
 
         foreach (var action in ActionsInOrder)
         {
@@ -574,7 +574,7 @@ public async Task RunActions(Dictionary<GamePath, SyncNode> syncTree, GameInstal
                     break;
 
                 case Actions.DeleteFromDisk:
-                    ActionDeleteFromDisk(syncTree, register, tx, gameInstallation.GameMetadataId, deletedFiles);
+                    ActionDeleteFromDisk(syncTree, register, tx, gameInstallation.GameMetadataId, foldersWithDeletedFiles);
                     break;
 
                 case Actions.ExtractToDisk:
@@ -608,7 +608,15 @@ public async Task RunActions(Dictionary<GamePath, SyncNode> syncTree, GameInstal
         }
         tx.Add(gameMetadataId, GameInstallMetadata.LastScannedDiskStateTransaction, EntityId.From(tx.ThisTxId.Value));
 
-        await tx.Commit();
+        var result = await tx.Commit();
+
+        var newMetadata = gameMetadata.Rebase(result.Db);
+
+        // Clean up empty directories
+        if (foldersWithDeletedFiles.Count > 0)
+        {
+            CleanDirectories(foldersWithDeletedFiles, newMetadata.DiskStateEntries, gameInstallation);
+        }
     }
 
     private void WarnOfConflict(Dictionary<GamePath, SyncNode> tree)
@@ -757,12 +765,13 @@ private void ActionDeleteFromDisk(Dictionary<GamePath, SyncNode> groupings, IGam
                 continue;
             var resolvedPath = register.GetResolvedPath(path);
             resolvedPath.Delete();
-            foldersWithDeletedFiles.Add((path, resolvedPath.Parent));
 
 
-            // Don't delete the entry if we're just going to replace it
+            // Only delete the entry if we're not going to replace it
             if (!node.Actions.HasFlag(Actions.ExtractToDisk))
             {
+                foldersWithDeletedFiles.Add((path, resolvedPath.Parent));
+
                 var id = node.Disk.EntityId;
                 tx.Retract(id, DiskStateEntry.Path, ((EntityId)gameMetadataId, path.LocationId, path.Path));
                 tx.Retract(id, DiskStateEntry.Hash, node.Disk.Hash);
@@ -828,7 +837,6 @@ private bool ActionIngestFromDisk(Dictionary<GamePath, SyncNode> syncTree, Loado
             var prevLoadout = Loadout.Load(loadout.Db, lastAppliedId);
             if (prevLoadout.IsValid())
             {
-                await Synchronize(prevLoadout);
                 await DeactivateCurrentLoadout(loadout.InstallationInstance);
                 await ActivateLoadout(loadout);
                 return loadout.Rebase();

tests/NexusMods.DataModel.Synchronizer.Tests/SynchronizerUnitTests.cs

@@ -16,6 +16,33 @@ namespace NexusMods.DataModel.Synchronizer.Tests;
 /// </summary>
 public class SynchronizerUnitTests(ITestOutputHelper testOutputHelper) : ACyberpunkIsolatedGameTest<SynchronizerUnitTests>(testOutputHelper)
 {
+    
+    [Fact]
+    [GithubIssue(2077)]
+    public async Task EmptyFoldersAreRemovedWhenSwitchingLoadouts()
+    {
+        var loadoutA = await CreateLoadout();
+
+        var nestedFile = new GamePath(LocationId.Game, "a/b/nested.txt");
+        var nestedFileFullPath = GameInstallation.LocationsRegister.GetResolvedPath(nestedFile);
+
+        nestedFileFullPath.Parent.CreateDirectory();
+        await nestedFileFullPath.WriteAllTextAsync("Nested File");
+
+        loadoutA = await Synchronizer.Synchronize(loadoutA);
+
+        loadoutA.Items.Should().ContainSingle(f => f.Name == "nested.txt");
+
+        // Create new empty loadout
+        var loadoutB = await CreateLoadout();
+
+        // Switch to empty loadout
+        loadoutB = await Synchronizer.Synchronize(loadoutB);
+        
+        // 'a/' directory should be deleted
+        nestedFileFullPath.Parent.Parent.DirectoryExists().Should().BeFalse();
+    }
+    
     [Fact]
     [GithubIssue(1925)]
     public async Task EmptyChildFoldersDontDeleteNonEmptyParents()
@@ -38,7 +65,6 @@ public async Task EmptyChildFoldersDontDeleteNonEmptyParents()
 
         loadout.Items.Should().ContainSingle(f => f.Name == "parent.txt");
         loadout.Items.Should().ContainSingle(f => f.Name == "grandchild.txt");
-        
 
 
         using (var tx = Connection.BeginTransaction())
@@ -50,8 +76,15 @@ public async Task EmptyChildFoldersDontDeleteNonEmptyParents()
 
         loadout = loadout.Rebase();
         loadout = await Synchronizer.Synchronize(loadout);
-        
+         
+        // a/b/c/grandchild.txt
         grandChildFileFullPath.FileExists.Should().BeFalse();
+        // a/b/c
+        grandChildFileFullPath.Parent.DirectoryExists().Should().BeFalse();
+        // a/b
+        grandChildFileFullPath.Parent.Parent.DirectoryExists().Should().BeFalse();
+
+        // a/parent.txt
         parentFileFullPath.FileExists.Should().BeTrue();
     }