Fixes for issues raised by devin

Author: pmachapman

src/RealtimeServer/scriptureforge/models/translate-config.ts

@@ -58,6 +58,9 @@ export interface DraftUsfmConfig {
   quoteFormat: QuoteFormat;
 }
 
+/**
+ * The configuration used for Quality Estimation.
+ */
 export interface QualityEstimationConfig {
   version: string;
   slope: number;

src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.spec.ts

@@ -357,6 +357,23 @@ describe('ServalProjectComponent', () => {
       }));
 
       it('should not update an unchanged quality estimation config value', fakeAsync(() => {
+        const env = new TestEnvironment({
+          preTranslate: true,
+          draftConfig: { qualityEstimationConfig: { version: '0.1', slope: 109.6145, intercept: -14.0633 } }
+        });
+        expect(env.qualityEstimationConfigTextArea.value).toBe(
+          '{"version":"0.1","slope":109.6145,"intercept":-14.0633}'
+        );
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).toBeNull();
+
+        env.setQualityEstimationConfigValue('{ "version": "0.1", "slope": 109.6145, "intercept": -14.0633 }');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).never();
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).toBeNull();
+      }));
+
+      it('should not update an unchanged empty quality estimation config value', fakeAsync(() => {
         const env = new TestEnvironment();
         expect(env.qualityEstimationConfigTextArea.value).toBe('');
         expect(env.statusDone(env.qualityEstimationConfigStatus)).toBeNull();

src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.ts

@@ -367,12 +367,15 @@ export class ServalProjectComponent extends DataLoadingComponent implements OnIn
   }
 
   updateQualityEstimationConfig(): void {
+    // Do not save if we do not have the project doc or if the configuration was and is empty
+    const projectId: string | undefined = this.activatedProjectService.projectId;
+    const project: SFProjectProfile | undefined = this.activatedProjectService.projectDoc?.data;
     if (
-      this.activatedProjectService.projectDoc?.data == null ||
+      project == null ||
+      projectId == null ||
       (this.form.value.qualityEstimationConfig ?? '') ===
-        (this.activatedProjectService.projectDoc.data.translateConfig.draftConfig.qualityEstimationConfig ?? '')
+        (project.translateConfig.draftConfig.qualityEstimationConfig ?? '')
     ) {
-      // Do not save if we do not have the project doc or if the configuration has not changed
       return;
     }
 
@@ -391,19 +394,30 @@ export class ServalProjectComponent extends DataLoadingComponent implements OnIn
     // Ensure the JSON is valid
     if (
       qualityEstimationConfig != null &&
-      typeof qualityEstimationConfig.version !== 'string' &&
-      typeof qualityEstimationConfig.slope !== 'number' &&
-      typeof qualityEstimationConfig.intercept !== 'number' &&
-      qualityEstimationConfig.version !== '0.1'
+      (typeof qualityEstimationConfig.version !== 'string' ||
+        typeof qualityEstimationConfig.slope !== 'number' ||
+        typeof qualityEstimationConfig.intercept !== 'number' ||
+        qualityEstimationConfig.version !== '0.1')
     ) {
       this.qualityEstimationConfigUpdateState = ElementState.Error;
       return;
     }
 
+    // Do not update if the values did not change
+    const existingQualityEstimationConfig: QualityEstimationConfig | undefined =
+      project.translateConfig.draftConfig.qualityEstimationConfig;
+    if (
+      qualityEstimationConfig?.version === existingQualityEstimationConfig?.version &&
+      qualityEstimationConfig?.slope === existingQualityEstimationConfig?.slope &&
+      qualityEstimationConfig?.intercept === existingQualityEstimationConfig?.intercept
+    ) {
+      return;
+    }
+
     // Update the Quality Estimation Configuration
     this.qualityEstimationConfigUpdateState = ElementState.Submitting;
     void this.projectService
-      .onlineSetQualityEstimationConfig(this.activatedProjectService.projectDoc.id, qualityEstimationConfig)
+      .onlineSetQualityEstimationConfig(projectId, qualityEstimationConfig)
       .then(() => (this.qualityEstimationConfigUpdateState = ElementState.Submitted))
       .catch(() => (this.qualityEstimationConfigUpdateState = ElementState.Error));
   }

src/SIL.XForge.Scripture/Controllers/SFProjectsRpcController.cs

@@ -965,6 +965,10 @@ await projectService.SetQualityEstimationConfigAsync(
         {
             return ForbiddenError();
         }
+        catch (InvalidOperationException e)
+        {
+            return InvalidParamsError(e.Message);
+        }
         catch (DataNotFoundException dnfe)
         {
             return NotFoundError(dnfe.Message);

src/SIL.XForge.Scripture/Models/QualityEstimationConfig.cs

@@ -1,5 +1,8 @@
 namespace SIL.XForge.Scripture.Models;
 
+/// <summary>
+/// The configuration used for Quality Estimation.
+/// </summary>
 public class QualityEstimationConfig
 {
     public required string Version { get; set; }

src/SIL.XForge.Scripture/Services/SFProjectService.cs

@@ -1243,6 +1243,9 @@ public async Task SetQualityEstimationConfigAsync(
         if (!systemRoles.Contains(SystemRole.ServalAdmin))
             throw new ForbiddenException();
 
+        if ((qualityEstimationConfig?.Version ?? "0.1") != "0.1")
+            throw new InvalidOperationException("Unsupported version number");
+
         await using IConnection conn = await RealtimeService.ConnectAsync(curUserId);
         IDocument<SFProject> projectDoc = await GetProjectDocAsync(projectId, conn);
         if (qualityEstimationConfig is null)

test/SIL.XForge.Scripture.Tests/Controllers/SFProjectsRpcControllerTests.cs

@@ -1053,6 +1053,26 @@ await env
             .SetQualityEstimationConfigAsync(User01, Roles, Project01, qualityEstimationConfig);
     }
 
+    [Test]
+    public async Task SetQualityEstimationConfig_InvalidParams()
+    {
+        var env = new TestEnvironment();
+        var qualityEstimationConfig = new QualityEstimationConfig
+        {
+            Version = "11.0",
+            Slope = 109.6145,
+            Intercept = -14.0633,
+        };
+        const string errorMessage = "Unsupported version number";
+        env.SFProjectService.SetQualityEstimationConfigAsync(User01, Roles, Project01, qualityEstimationConfig)
+            .Throws(new InvalidOperationException(errorMessage));
+
+        // SUT
+        var result = await env.Controller.SetQualityEstimationConfig(Project01, qualityEstimationConfig);
+        Assert.IsInstanceOf<RpcMethodErrorResult>(result);
+        Assert.AreEqual(errorMessage, (result as RpcMethodErrorResult)!.Message);
+    }
+
     [Test]
     public async Task SetQualityEstimationConfig_NotFound()
     {

test/SIL.XForge.Scripture.Tests/Services/SFProjectServiceTests.cs

@@ -3971,6 +3971,28 @@ await env.Service.SetQualityEstimationConfigAsync(
         );
     }
 
+    [Test]
+    public void SetQualityEstimationConfigAsync_UnsupportedVersion()
+    {
+        var env = new TestEnvironment();
+        var qualityEstimationConfig = new QualityEstimationConfig
+        {
+            Version = "11.0",
+            Slope = 109.6145,
+            Intercept = -14.0633,
+        };
+
+        // SUT
+        Assert.ThrowsAsync<InvalidOperationException>(() =>
+            env.Service.SetQualityEstimationConfigAsync(
+                User01,
+                [SystemRole.ServalAdmin],
+                Project01,
+                qualityEstimationConfig
+            )
+        );
+    }
+
     [Test]
     public void SetQualityEstimationConfigAsync_UserMustBeServalAdmin()
     {