Restore: Normalize user CRDT writes to NFD (#2146)

backend/FwLite/FwDataMiniLcmBridge.Tests/MiniLcmTests/UpdateEntryTests.cs

@@ -81,7 +81,10 @@ public async Task UpdateEntry_CanUpdateExampleSentenceTranslations_WhenNoTransla
 
         var before = entry.Copy();
         var exampleSentence = entry.Senses[0].ExampleSentences[0];
-        exampleSentence.Translations = [new() { Text = { { "en", new RichString("updated") } } }];
+        exampleSentence.Translations =
+        [
+            new() { Id = Guid.NewGuid(), Text = { { "en", new RichString("updated") } } }
+        ];
 
         // Act
         var updatedEntry = await Api.UpdateEntry(before, entry);

backend/FwLite/FwLiteProjectSync/CrdtFwdataProjectSyncService.cs

@@ -4,16 +4,14 @@
 using LexCore.Sync;
 using Microsoft.Extensions.Logging;
 using MiniLcm;
-using MiniLcm.Normalization;
 using MiniLcm.SyncHelpers;
 using MiniLcm.Validators;
 
 namespace FwLiteProjectSync;
 
 public class CrdtFwdataProjectSyncService(MiniLcmImport miniLcmImport,
     ILogger<CrdtFwdataProjectSyncService> logger,
-    MiniLcmApiValidationWrapperFactory validationWrapperFactory,
-    MiniLcmApiStringNormalizationWrapperFactory normalizationWrapperFactory)
+    MiniLcmApiValidationWrapperFactory validationWrapperFactory)
 {
     public record DryRunSyncResult(
         int CrdtChanges,
@@ -63,8 +61,10 @@ private async Task<SyncResult> SyncOrImportInternal(IMiniLcmApi crdtApi, IMiniLc
             throw new InvalidOperationException("Project sync state does not match presence of snapshot.");
         }
 
-        crdtApi = normalizationWrapperFactory.Create(validationWrapperFactory.Create(crdtApi));
-        fwdataApi = normalizationWrapperFactory.Create(validationWrapperFactory.Create(fwdataApi));
+        // No write normalization: Data is already normalised on both sides.
+        // No query normalization: The sync doesn't do any querying.
+        crdtApi = validationWrapperFactory.Create(crdtApi);
+        fwdataApi = validationWrapperFactory.Create(fwdataApi);
 
         if (dryRun)
         {

backend/FwLite/FwLiteShared/Services/MiniLcmJsInvokable.cs

@@ -5,8 +5,6 @@
 using MiniLcm;
 using MiniLcm.Media;
 using MiniLcm.Models;
-using MiniLcm.Normalization;
-using MiniLcm.Validators;
 using MiniLcm.Wrappers;
 using Reinforced.Typings.Attributes;
 
@@ -18,11 +16,10 @@ public class MiniLcmJsInvokable(
     IProjectIdentifier project,
     ILogger<MiniLcmJsInvokable> logger,
     MiniLcmApiNotifyWrapperFactory notificationWrapperFactory,
-    MiniLcmApiValidationWrapperFactory validationWrapperFactory,
-    MiniLcmApiStringNormalizationWrapperFactory normalizationWrapperFactory
+    MiniLcmApiUserFacingWrappers userFacingWrappers
     ) : IDisposable
 {
-    private readonly IMiniLcmApi _wrappedApi = api.WrapWith([normalizationWrapperFactory, validationWrapperFactory, notificationWrapperFactory], project);
+    private readonly IMiniLcmApi _wrappedApi = userFacingWrappers.Apply(api, project, notificationWrapperFactory);
 
     public record MiniLcmFeatures(bool? History, bool? Write, bool? OpenWithFlex, bool? Feedback, bool? Sync, bool? Audio, bool? CustomViews);
     private bool SupportsSync => project.DataFormat == ProjectDataFormat.Harmony && api is CrdtMiniLcmApi;

backend/FwLite/FwLiteWeb/Hubs/CrdtMiniLcmApiHub.cs

@@ -1,15 +1,13 @@
-using FwLiteShared;
 using FwLiteShared.Events;
 using FwLiteShared.Projects;
 using FwLiteShared.Sync;
 using LcmCrdt;
 using LcmCrdt.Data;
-using FwLiteWeb.Services;
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.Extensions.Caching.Memory;
 using MiniLcm;
 using MiniLcm.Models;
-using MiniLcm.Validators;
+using MiniLcm.Wrappers;
 using SystemTextJsonPatch;
 
 namespace FwLiteWeb.Hubs;
@@ -23,8 +21,8 @@ public class CrdtMiniLcmApiHub(
     LexboxProjectService lexboxProjectService,
     IMemoryCache memoryCache,
     IHubContext<CrdtMiniLcmApiHub, ILexboxHubClient> hubContext,
-    MiniLcmApiValidationWrapperFactory validationWrapperFactory
-) : MiniLcmApiHubBase(miniLcmApi, validationWrapperFactory)
+    MiniLcmApiUserFacingWrappers userFacingWrappers
+) : MiniLcmApiHubBase(miniLcmApi, userFacingWrappers, projectContext.Project)
 {
     public const string ProjectRouteKey = "project";
     public static string ProjectGroup(string projectName) => "crdt-" + projectName;

backend/FwLite/FwLiteWeb/Hubs/FwDataMiniLcmHub.cs

@@ -1,10 +1,7 @@
 using FwDataMiniLcmBridge;
-using Microsoft.AspNetCore.SignalR;
-using Microsoft.Extensions.Options;
 using MiniLcm;
-using MiniLcm.Validators;
+using MiniLcm.Wrappers;
 using SIL.LCModel;
-using SystemTextJsonPatch;
 
 namespace FwLiteWeb.Hubs;
 
@@ -13,8 +10,9 @@ public class FwDataMiniLcmHub(
     IMiniLcmApi miniLcmApi,
     FwDataFactory fwDataFactory,
     FwDataProjectContext context,
-    MiniLcmApiValidationWrapperFactory validationWrapperFactory
-) : MiniLcmApiHubBase(miniLcmApi, validationWrapperFactory)
+    MiniLcmApiUserFacingWrappers userFacingWrappers
+)
+: MiniLcmApiHubBase(miniLcmApi, userFacingWrappers, context.Project ?? throw new InvalidOperationException("No project is set in the context."))
 {
     public const string ProjectRouteKey = "fwdata";
     public override async Task OnConnectedAsync()

backend/FwLite/FwLiteWeb/Hubs/MiniLcmApiHubBase.cs

@@ -1,16 +1,17 @@
 using Microsoft.AspNetCore.SignalR;
-using Microsoft.Extensions.Options;
 using MiniLcm;
 using MiniLcm.Models;
-using MiniLcm.Validators;
+using MiniLcm.Wrappers;
 using SystemTextJsonPatch;
 
 namespace FwLiteWeb.Hubs;
 
-public abstract class MiniLcmApiHubBase(IMiniLcmApi miniLcmApi,
-    MiniLcmApiValidationWrapperFactory validationWrapperFactory) : Hub<ILexboxHubClient>
+public abstract class MiniLcmApiHubBase(
+    IMiniLcmApi miniLcmApi,
+    MiniLcmApiUserFacingWrappers userFacingWrappers,
+    IProjectIdentifier projectIdentifier) : Hub<ILexboxHubClient>
 {
-    private readonly IMiniLcmApi _miniLcmApi = validationWrapperFactory.Create(miniLcmApi);
+    private readonly IMiniLcmApi _miniLcmApi = userFacingWrappers.Apply(miniLcmApi, projectIdentifier);
 
     public async Task<WritingSystems> GetWritingSystems()
     {

backend/FwLite/FwLiteWeb/Routes/MiniLcmRoutes.cs

@@ -7,6 +7,7 @@
 using MiniLcm.Models;
 using MiniLcm.Project;
 using MiniLcm.Validators;
+using MiniLcm.Wrappers;
 using System.Text.Json.Nodes;
 
 namespace FwLiteWeb.Routes;
@@ -86,12 +87,11 @@ public static IEndpointConventionBuilder MapMiniLcmRoutes(this IEndpointRouteBui
                     return Results.Problem($"Project {projectCode} not found");
                 }
 
-                var validationWrapperFactory = context.HttpContext.RequestServices
-                    .GetRequiredService<MiniLcmApiValidationWrapperFactory>();
+                var services = context.HttpContext.RequestServices;
+                var userFacingWrappers = services.GetRequiredService<MiniLcmApiUserFacingWrappers>();
 
-                miniLcmHolder.MiniLcmApi = validationWrapperFactory.Create(
-                    await projectProvider.OpenProject(project, context.HttpContext.RequestServices)
-                );
+                miniLcmHolder.MiniLcmApi = userFacingWrappers.Apply(
+                    await projectProvider.OpenProject(project, services), project);
                 return await next(context);
             });
 

backend/FwLite/MiniLcm.Tests/CreateEntryTestsBase.cs

@@ -22,7 +22,7 @@ public async Task CanCreateEntry_AutoFaker()
             .For(e => e.Components).Exclude(e => e.Id)
             .For(e => e.ComplexForms).Exclude(e => e.Id)
             .Excluding(e => e.HomographNumber) // FwData auto-assigns to fix broken CRDT numbering
-            );
+            .Excluding(member => member.Name == nameof(IOrderable.Order)));
     }
 
     [Fact]

backend/FwLite/MiniLcm.Tests/ExampleSentenceTestsBase.cs

@@ -49,24 +49,34 @@ public async Task CanCreateExampleSentence()
     {
         var expectedExampleSentence = new ExampleSentence()
         {
+            Id = Guid.NewGuid(),
             SenseId = _senseId,
             Reference = new RichString("This is a reference", "en"),
             Sentence = { { "en", new RichString("test", "en") } },
-            Translations = { new Translation() { Text = { { "en", new RichString("test", "en") } } } }
+            Translations = {
+                new Translation()
+                {
+                    Id = Guid.NewGuid(),
+                    Text = { { "en", new RichString("test", "en") } },
+                }
+            }
         };
         var actualSentence = await Api.CreateExampleSentence(_entryId, _senseId, expectedExampleSentence);
-        actualSentence.Should().BeEquivalentTo(expectedExampleSentence);
+        actualSentence.Should().BeEquivalentTo(expectedExampleSentence,
+            options => options.Excluding(s => s.Order));
     }
 
     [Fact]
     public async Task CanCreateEmptyExampleSentence()
     {
         var expectedExampleSentence = new ExampleSentence()
         {
+            Id = Guid.NewGuid(),
             SenseId = _senseId
         };
         var actualSentence = await Api.CreateExampleSentence(_entryId, _senseId, expectedExampleSentence);
-        actualSentence.Should().BeEquivalentTo(expectedExampleSentence);
+        actualSentence.Should().BeEquivalentTo(expectedExampleSentence,
+            options => options.Excluding(s => s.Order));
     }
 
     [Fact]