Use newly created writing systems when updating the full text search table (#1789)

* create a test which simulates downloading a project from the server

* when updating the entry search table, use any writing systems that were created in the same transaction/SaveChanges

---------

Co-authored-by: Tim Haasdyk <tim_haasdyk@sil.org>

Author: hahn-kev

backend/FwLite/LcmCrdt.Tests/Data/DownloadProjectTests.cs

@@ -0,0 +1,29 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+
+namespace LcmCrdt.Tests.Data;
+
+public class DownloadProjectTests : IAsyncLifetime
+{
+    private readonly RegressionTestHelper _helper = new("DownloadProject");
+    private readonly MiniLcmApiFixture _apiFixture = MiniLcmApiFixture.Create(false);
+
+    public async Task InitializeAsync()
+    {
+        await _helper.InitializeAsync();
+        await _apiFixture.InitializeAsync();
+    }
+
+    public async Task DisposeAsync()
+    {
+        await _helper.DisposeAsync();
+        await _apiFixture.DisposeAsync();
+    }
+
+    [Fact]
+    public async Task CanCreateANewProjectViaSync()
+    {
+        var remoteModel = _helper.Services.GetRequiredService<DataModel>();
+        await _apiFixture.DataModel.SyncWith(remoteModel);
+    }
+}

backend/FwLite/LcmCrdt.Tests/MiniLcmApiFixture.cs

@@ -11,6 +11,7 @@ namespace LcmCrdt.Tests;
 
 public class MiniLcmApiFixture : IAsyncLifetime
 {
+    private readonly bool _seedWs = true;
     private AsyncServiceScope _services;
     private LcmCrdtDbContext? _crdtDbContext;
     public CrdtMiniLcmApi Api => (CrdtMiniLcmApi)_services.ServiceProvider.GetRequiredService<IMiniLcmApi>();
@@ -22,10 +23,21 @@ public T GetService<T>() where T : notnull
         return _services.ServiceProvider.GetRequiredService<T>();
     }
 
+    //must have an empty constructor for xunit
     public MiniLcmApiFixture()
     {
     }
 
+    public static MiniLcmApiFixture Create(bool seedWs = true)
+    {
+        return new MiniLcmApiFixture(seedWs);
+    }
+
+    private MiniLcmApiFixture(bool seedWs = true)
+    {
+        _seedWs = seedWs;
+    }
+
     public async Task InitializeAsync()
     {
         var db = ":memory:";
@@ -53,26 +65,28 @@ public async Task InitializeAsync()
         await CrdtProjectsService.InitProjectDb(_crdtDbContext,
             new ProjectData("Sena 3", "sena-3", Guid.NewGuid(), null, Guid.NewGuid()));
         await _services.ServiceProvider.GetRequiredService<CurrentProjectService>().RefreshProjectData();
-
-        await Api.CreateWritingSystem(new WritingSystem()
-        {
-            Id = Guid.NewGuid(),
-            WsId = "en",
-            Name = "English",
-            Abbreviation = "en",
-            Font = "Arial",
-            Exemplars = ["a", "b"],
-            Type = WritingSystemType.Vernacular
-        });
-        await Api.CreateWritingSystem(new WritingSystem()
+        if (_seedWs)
         {
-            Id = Guid.NewGuid(),
-            WsId = "en",
-            Name = "English",
-            Abbreviation = "en",
-            Font = "Arial",
-            Type = WritingSystemType.Analysis
-        });
+            await Api.CreateWritingSystem(new WritingSystem()
+            {
+                Id = Guid.NewGuid(),
+                WsId = "en",
+                Name = "English",
+                Abbreviation = "en",
+                Font = "Arial",
+                Exemplars = ["a", "b"],
+                Type = WritingSystemType.Vernacular
+            });
+            await Api.CreateWritingSystem(new WritingSystem()
+            {
+                Id = Guid.NewGuid(),
+                WsId = "en",
+                Name = "English",
+                Abbreviation = "en",
+                Font = "Arial",
+                Type = WritingSystemType.Analysis
+            });
+        }
     }
 
     ITestOutputHelper? _outputHelper;

backend/FwLite/LcmCrdt/FullTextSearch/EntrySearchService.cs

@@ -144,12 +144,16 @@ public async Task UpdateEntrySearchTable(Entry entry)
 
     public async Task UpdateEntrySearchTable(IEnumerable<Entry> entries)
     {
-        await UpdateEntrySearchTable(entries, dbContext);
+        await UpdateEntrySearchTable(entries, [], dbContext);
     }
 
-    public static async Task UpdateEntrySearchTable(IEnumerable<Entry> entries, LcmCrdtDbContext dbContext)
+    public static async Task UpdateEntrySearchTable(IEnumerable<Entry> entries, IEnumerable<WritingSystem> newWritingSystems, LcmCrdtDbContext dbContext)
     {
-        var writingSystems = await dbContext.WritingSystems.OrderBy(ws => ws.Order).ToArrayAsync();
+        WritingSystem[] writingSystems = [
+            ..dbContext.WritingSystems,
+            ..newWritingSystems
+        ];
+        Array.Sort(writingSystems, (ws1, ws2) => ws1.Order.CompareTo(ws2.Order));
         await dbContext.GetTable<EntrySearchRecord>()
             .BulkCopyAsync(entries.Select(entry => ToEntrySearchRecord(entry, writingSystems)));
     }

backend/FwLite/LcmCrdt/FullTextSearch/UpdateEntrySearchTableInterceptor.cs

@@ -29,6 +29,9 @@ private async Task UpdateSearchTableOnSave(DbContext? dbContext)
     {
         if (dbContext is null) return;
         List<Entry> toUpdate = [];
+        var newWritingSystems = dbContext.ChangeTracker.Entries()
+            .Where(e => e.Entity is WritingSystem && e.State == EntityState.Added)
+            .Select(e => (WritingSystem)e.Entity).ToList();
         foreach (var group in dbContext.ChangeTracker.Entries()
                      .Where(e => e is { State: EntityState.Added or EntityState.Modified, Entity: Entry or Sense })
                      .GroupBy(e =>
@@ -42,13 +45,13 @@ private async Task UpdateSearchTableOnSave(DbContext? dbContext)
                          };
                      }))
         {
-            toUpdate.Add(await ForUpdate(group, dbContext));
+            toUpdate.Add(await ForUpdate(group, group.Key, dbContext));
         }
         if (toUpdate is []) return;
-        await EntrySearchService.UpdateEntrySearchTable(toUpdate, (LcmCrdtDbContext)dbContext);
+        await EntrySearchService.UpdateEntrySearchTable(toUpdate, newWritingSystems, (LcmCrdtDbContext)dbContext);
     }
 
-    private async Task<Entry> ForUpdate(IGrouping<Guid, EntityEntry> group, DbContext dbContext)
+    private async Task<Entry> ForUpdate(IEnumerable<EntityEntry> group, Guid entryId, DbContext dbContext)
     {
         var entities = group.ToArray();
         //scope created so the entry variables don't collide
@@ -61,11 +64,11 @@ private async Task<Entry> ForUpdate(IGrouping<Guid, EntityEntry> group, DbContex
 
         var fullEntry = await dbContext.Set<Entry>()
             .Include(e => e.Senses)
-            .FirstOrDefaultAsync(e => e.Id == group.Key);
+            .FirstOrDefaultAsync(e => e.Id == entryId);
         if (fullEntry is null)
         {
             //null when a new entry is added along with some senses
-            fullEntry = new Entry() { Id = group.Key };
+            fullEntry = new Entry() { Id = entryId };
         }
 
         foreach (var entity in entities)