Improve path items sorting (#72)

Author: paul-fresquet

src/ByteSync.Client/Business/Profiles/LocalSessionProfileDetails.cs

@@ -23,5 +23,5 @@ public override string ProfileId
 
     public LocalSessionProfileOptions Options { get; set; }
 
-    public List<PathItem> PathItems { get; set; }
+    public IList<PathItem> PathItems { get; set; }
 }

src/ByteSync.Client/Business/Sessions/RunSessionInfos/RunLocalSessionProfileInfo.cs

@@ -19,7 +19,7 @@ public RunLocalSessionProfileInfo(LocalSessionProfile cloudSessionProfile,
 
     public LocalSessionProfileDetails ProfileDetails { get; set; }
 
-    public List<PathItem> GetMyPathItems()
+    public IList<PathItem> GetMyPathItems()
     {
         return ProfileDetails.PathItems;
     }

src/ByteSync.Client/Factories/InventoryBuilderFactory.cs

@@ -31,7 +31,7 @@ public IInventoryBuilder CreateInventoryBuilder()
 
         var sessionMember = sessionMemberRepository.GetCurrentSessionMember();
         var cloudSessionSettings = sessionService.CurrentSessionSettings!;
-        var myPathItems = pathItemRepository.CurrentMemberPathItems.Items.ToList();
+        var myPathItems = pathItemRepository.SortedCurrentMemberPathItems;
 
         var inventoryBuilder = _context.Resolve<IInventoryBuilder>(
             new TypedParameter(typeof(SessionMemberInfo), sessionMember),

src/ByteSync.Client/Interfaces/Repositories/IPathItemRepository.cs

@@ -6,4 +6,6 @@ namespace ByteSync.Interfaces.Repositories;
 public interface IPathItemRepository : IBaseSourceCacheRepository<PathItem, string>
 {
     public IObservableCache<PathItem, string> CurrentMemberPathItems { get; }
+    
+    public IList<PathItem> SortedCurrentMemberPathItems { get; }
 }

src/ByteSync.Client/Repositories/PathItemRepository.cs

@@ -23,4 +23,12 @@ public PathItemRepository(IEnvironmentService environmentService, ISessionInvali
     protected override string KeySelector(PathItem pathItem) => pathItem.Key;
 
     public IObservableCache<PathItem, string> CurrentMemberPathItems { get; }
+    
+    public IList<PathItem> SortedCurrentMemberPathItems
+    {
+        get
+        {
+            return CurrentMemberPathItems.Items.OrderBy(pi => pi.Code).ToList();
+        }
+    }
 }

src/ByteSync.Client/Services/Inventories/DataInventoryStarter.cs

@@ -250,7 +250,7 @@ private void FinalizeSessionSettings(SessionSettings sessionSettings)
     {
         if (session is LocalSession)
         {
-            var pathItems = _pathItemRepository.CurrentMemberPathItems.Items.ToList();
+            var pathItems = _pathItemRepository.SortedCurrentMemberPathItems;
             if (pathItems.Count < 2)
             {
                 return LogAndBuildStartInventoryResult(session, StartInventoryStatuses.LessThan2DataSources);

src/ByteSync.Client/Services/Profiles/SessionProfileManager.cs

@@ -395,8 +395,7 @@ private LocalSessionProfileDetails BuildLocalSessionProfileDetails(string profil
         localSessionProfileDetails.CreationDatetime = DateTime.Now;
         localSessionProfileDetails.CreatedWithVersion = _connectionService.CurrentEndPoint!.Version;
         localSessionProfileDetails.Options = localSessionProfileOptions;
-        localSessionProfileDetails.PathItems = _pathItemRepository.CurrentMemberPathItems.Items
-            .ToList();
+        localSessionProfileDetails.PathItems = _pathItemRepository.SortedCurrentMemberPathItems;
 
         var synchronizationRules = _synchronizationRulesConverter.ConvertLooseSynchronizationRules(
             _synchronizationRuleRepository.Elements.ToList());

tests/ByteSync.Client.IntegrationTests/Factories/TestInventoryBuilderFactory.cs

@@ -0,0 +1,65 @@
+using Autofac;
+using ByteSync.Business.Inventories;
+using ByteSync.Business.PathItems;
+using ByteSync.Business.SessionMembers;
+using ByteSync.Business.Sessions;
+using ByteSync.Common.Business.Misc;
+using ByteSync.Factories;
+using ByteSync.Interfaces.Controls.Applications;
+using ByteSync.Interfaces.Controls.Inventories;
+using ByteSync.Interfaces.Repositories;
+using ByteSync.Interfaces.Services.Sessions;
+using ByteSync.TestsCommon;
+using FluentAssertions;
+using Moq;
+
+namespace ByteSync.Client.IntegrationTests.Factories;
+
+public class TestInventoryBuilderFactory : IntegrationTest
+{
+    private InventoryBuilderFactory _inventoryBuilderFactor;
+
+    [SetUp]
+    public void Setup()
+    {
+        RegisterType<InventoryBuilderFactory>();
+        BuildMoqContainer();
+        
+        _inventoryBuilderFactor = Container.Resolve<InventoryBuilderFactory>();
+    }
+    
+    [Test]
+    public void CreateInventoryBuilder_ShouldBuildInventoryWithCorrectParts()
+    {
+        // Arrange
+        var mockSessionMemberRepo = Container.Resolve<Mock<ISessionMemberRepository>>();
+        var mockSessionService = Container.Resolve<Mock<ISessionService>>();
+        var mockInventoryService = Container.Resolve<Mock<IInventoryService>>();
+        var mockEnvironmentService = Container.Resolve<Mock<IEnvironmentService>>();
+        var mockPathItemRepository = Container.Resolve<Mock<IPathItemRepository>>();
+        
+        var fakeSessionMember = new SessionMemberInfo();
+        var fakeSessionSettings = new SessionSettings();
+        var fakeProcessData = new InventoryProcessData();
+        var fakePlatform = OSPlatforms.Windows;
+        var fakePathItems = new List<PathItem> { Mock.Of<PathItem>(), Mock.Of<PathItem>() };
+        
+        mockSessionMemberRepo.Setup(r => r.GetCurrentSessionMember()).Returns(fakeSessionMember).Verifiable();
+        mockSessionService.SetupGet(s => s.CurrentSessionSettings).Returns(fakeSessionSettings).Verifiable();
+        mockInventoryService.SetupGet(s => s.InventoryProcessData).Returns(fakeProcessData).Verifiable();
+        mockEnvironmentService.SetupGet(e => e.OSPlatform).Returns(fakePlatform).Verifiable();
+        mockPathItemRepository.SetupGet(r => r.SortedCurrentMemberPathItems).Returns(fakePathItems).Verifiable();
+
+        // Act
+        var inventoryBuilder = _inventoryBuilderFactor.CreateInventoryBuilder();
+
+        // Assert
+        inventoryBuilder.Should().NotBeNull();
+        
+        mockSessionMemberRepo.Verify();
+        mockSessionService.Verify();
+        mockInventoryService.Verify();
+        mockEnvironmentService.Verify();
+        mockPathItemRepository.Verify();
+    }
+}