Ws changes cleanup (#1588)

* create a validator prevening WsId changes

* use new change context api to detect and resolve unique constraint conflicts

* simplify the CreateWritingSystem API to remove the specific type parameter as there's a property for it in the WritingSystem class

* check for existing writing systems before trying to create it via a change

Author: hahn-kev

backend/FwLite/FwDataMiniLcmBridge/Api/FwDataMiniLcmApi.cs

@@ -146,9 +146,10 @@ internal void CompleteExemplars(WritingSystems writingSystems)
         }
     }
 
-    public async Task<WritingSystem> CreateWritingSystem(WritingSystemType type, WritingSystem writingSystem)
+    public async Task<WritingSystem> CreateWritingSystem(WritingSystem writingSystem)
     {
         await validators.ValidateAndThrow(writingSystem);
+        var type = writingSystem.Type;
         var exitingWs = type == WritingSystemType.Analysis ? Cache.ServiceLocator.WritingSystems.AnalysisWritingSystems : Cache.ServiceLocator.WritingSystems.VernacularWritingSystems;
         if (exitingWs.Any(ws => ws.Id == writingSystem.WsId))
         {
@@ -186,6 +187,7 @@ public async Task<WritingSystem> CreateWritingSystem(WritingSystemType type, Wri
 
     public async Task<WritingSystem> UpdateWritingSystem(WritingSystemId id, WritingSystemType type, UpdateObjectInput<WritingSystem> update)
     {
+        await validators.ValidateAndThrow(update);
         if (!Cache.ServiceLocator.WritingSystemManager.TryGet(id.Code, out var lcmWritingSystem))
         {
             throw new InvalidOperationException($"Writing system {id.Code} not found");

backend/FwLite/FwLiteProjectSync.Tests/Fixtures/SyncFixture.cs

@@ -102,7 +102,7 @@ public async Task EnsureDefaultVernacularWritingSystemExistsInCrdt()
             if ((await CrdtApi.GetWritingSystems()).Vernacular.Length == 0)
             {
                 var firstVernacularWs = (await FwDataApi.GetWritingSystems()).Vernacular.First();
-                await CrdtApi.CreateWritingSystem(WritingSystemType.Vernacular, firstVernacularWs);
+                await CrdtApi.CreateWritingSystem(firstVernacularWs);
             }
         }
         finally

backend/FwLite/FwLiteProjectSync.Tests/Sena3SyncTests.cs

@@ -68,7 +68,7 @@ private async Task BypassImport(bool wsImported = false)
     private async Task WorkaroundMissingWritingSystems()
     {
         //must have at least one writing system to query for entries
-        await _crdtApi.CreateWritingSystem(WritingSystemType.Vernacular, (await _fwDataApi.GetWritingSystems()).Vernacular.First());
+        await _crdtApi.CreateWritingSystem((await _fwDataApi.GetWritingSystems()).Vernacular.First());
 
     }
 

backend/FwLite/FwLiteProjectSync.Tests/SyncTests.cs

@@ -415,8 +415,8 @@ public async Task UpdatingAnEntryInEachProjectSyncsAcrossBoth()
     {
         var crdtApi = _fixture.CrdtApi;
         var fwdataApi = _fixture.FwDataApi;
-        await fwdataApi.CreateWritingSystem(WritingSystemType.Vernacular, new WritingSystem() { Id = Guid.NewGuid(), Type = WritingSystemType.Vernacular, WsId = new WritingSystemId("es"), Name = "Spanish", Abbreviation = "es", Font = "Arial" });
-        await fwdataApi.CreateWritingSystem(WritingSystemType.Vernacular, new WritingSystem() { Id = Guid.NewGuid(), Type = WritingSystemType.Vernacular, WsId = new WritingSystemId("fr"), Name = "French", Abbreviation = "fr", Font = "Arial" });
+        await fwdataApi.CreateWritingSystem(new WritingSystem() { Id = Guid.NewGuid(), Type = WritingSystemType.Vernacular, WsId = new WritingSystemId("es"), Name = "Spanish", Abbreviation = "es", Font = "Arial" });
+        await fwdataApi.CreateWritingSystem(new WritingSystem() { Id = Guid.NewGuid(), Type = WritingSystemType.Vernacular, WsId = new WritingSystemId("fr"), Name = "French", Abbreviation = "fr", Font = "Arial" });
         await _syncService.Sync(crdtApi, fwdataApi);
 
         await crdtApi.UpdateEntry(_testEntry.Id, new UpdateObjectInput<Entry>().Set(entry => entry.LexemeForm["es"], "Manzana"));

backend/FwLite/FwLiteProjectSync/DryRunMiniLcmApi.cs

@@ -18,9 +18,9 @@ public void Dispose()
 
     public record DryRunRecord(string Method, string Description);
 
-    public Task<WritingSystem> CreateWritingSystem(WritingSystemType type, WritingSystem writingSystem)
+    public Task<WritingSystem> CreateWritingSystem(WritingSystem writingSystem)
     {
-        DryRunRecords.Add(new DryRunRecord(nameof(CreateWritingSystem), $"Create writing system {type}"));
+        DryRunRecords.Add(new DryRunRecord(nameof(CreateWritingSystem), $"Create writing system {writingSystem.Type}"));
         return Task.FromResult(writingSystem);
     }
 

backend/FwLite/FwLiteProjectSync/MiniLcmImport.cs

@@ -103,13 +103,13 @@ internal async Task ImportWritingSystems(IMiniLcmApi importTo, IMiniLcmApi impor
         var writingSystems = await importFrom.GetWritingSystems();
         foreach (var ws in writingSystems.Analysis)
         {
-            await importTo.CreateWritingSystem(WritingSystemType.Analysis, ws);
+            await importTo.CreateWritingSystem(ws);
             logger.LogInformation("Imported ws {WsId}", ws.WsId);
         }
 
         foreach (var ws in writingSystems.Vernacular)
         {
-            await importTo.CreateWritingSystem(WritingSystemType.Vernacular, ws);
+            await importTo.CreateWritingSystem(ws);
             logger.LogInformation("Imported ws {WsId}", ws.WsId);
         }
     }

backend/FwLite/FwLiteShared/Services/MiniLcmJsInvokable.cs

@@ -119,7 +119,7 @@ public ValueTask<Entry[]> SearchEntries(string query, QueryOptions? options = nu
     [JSInvokable]
     public Task<WritingSystem> CreateWritingSystem(WritingSystemType type, WritingSystem writingSystem)
     {
-        return _wrappedApi.CreateWritingSystem(type, writingSystem);
+        return _wrappedApi.CreateWritingSystem(writingSystem);
     }
 
     [JSInvokable]

backend/FwLite/FwLiteWeb/Hubs/CrdtMiniLcmApiHub.cs

@@ -97,9 +97,9 @@ public override IAsyncEnumerable<Entry> SearchEntries(string query, QueryOptions
         return base.SearchEntries(query, options);
     }
 
-    public override async Task<WritingSystem> CreateWritingSystem(WritingSystemType type, WritingSystem writingSystem)
+    public override async Task<WritingSystem> CreateWritingSystem(WritingSystem writingSystem)
     {
-        var newWritingSystem = await base.CreateWritingSystem(type, writingSystem);
+        var newWritingSystem = await base.CreateWritingSystem(writingSystem);
         TriggerSync();
         return newWritingSystem;
     }

backend/FwLite/FwLiteWeb/Hubs/MiniLcmApiHubBase.cs

@@ -13,9 +13,9 @@ public async Task<WritingSystems> GetWritingSystems()
         return await miniLcmApi.GetWritingSystems();
     }
 
-    public virtual async Task<WritingSystem> CreateWritingSystem(WritingSystemType type, WritingSystem writingSystem)
+    public virtual async Task<WritingSystem> CreateWritingSystem(WritingSystem writingSystem)
     {
-        var newWritingSystem = await miniLcmApi.CreateWritingSystem(type, writingSystem);
+        var newWritingSystem = await miniLcmApi.CreateWritingSystem(writingSystem);
         return newWritingSystem;
     }
 

backend/FwLite/LcmCrdt.Tests/Changes/UseChangesTests.cs

@@ -111,7 +111,7 @@ private static IEnumerable<ChangeWithDependencies> GetAllChanges()
         yield return new ChangeWithDependencies(createSemanticDomainChange);
 
         var writingSystem = new WritingSystem { Id = Guid.NewGuid(), WsId = "de", Name = "test ws", Abbreviation = "tws", Font = "Arial", Type = WritingSystemType.Vernacular };
-        var createWritingSystemChange = new CreateWritingSystemChange(writingSystem, writingSystem.Type, writingSystem.Id, 0);
+        var createWritingSystemChange = new CreateWritingSystemChange(writingSystem, writingSystem.Id, 0);
         yield return new ChangeWithDependencies(createWritingSystemChange);
 
         var complexFormTypeName = new MultiString { { "en", "test cft" } };