SF-3759 Add frontend interface

pmachapman · pmachapman · commit dae85dc7db2c · 2026-04-13T07:53:01.000+12:00
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.spec.ts
@@ -180,6 +180,19 @@ describe('SFProjectService', () => {
     }));
   });
 
+  describe('onlineSetQualityEstimationConfig', () => {
+    it('should invoke the command service', fakeAsync(async () => {
+      const env = new TestEnvironment();
+      await env.service.onlineSetQualityEstimationConfig('project01', {
+        version: '0.1',
+        slope: 109.6145,
+        intercept: -14.0633
+      });
+      verify(mockedCommandService.onlineInvoke(anything(), 'setQualityEstimationConfig', anything())).once();
+      expect().nothing();
+    }));
+  });
+
   class TestEnvironment {
     readonly httpTestingController: HttpTestingController;
     readonly service: SFProjectService;
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts
@@ -14,7 +14,10 @@ import { SF_PROJECT_RIGHTS, SFProjectDomain } from 'realtime-server/lib/esm/scri
 import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role';
 import { getSFProjectUserConfigDocId } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config';
 import { TextAudio } from 'realtime-server/lib/esm/scriptureforge/models/text-audio';
-import { DraftUsfmConfig } from 'realtime-server/lib/esm/scriptureforge/models/translate-config';
+import {
+  DraftUsfmConfig,
+  QualityEstimationConfig
+} from 'realtime-server/lib/esm/scriptureforge/models/translate-config';
 import { Subject } from 'rxjs';
 import { CommandService } from 'xforge-common/command.service';
 import { LocationService } from 'xforge-common/location.service';
@@ -362,6 +365,16 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     });
   }
 
+  async onlineSetQualityEstimationConfig(
+    projectId: string,
+    qualityEstimationConfig: QualityEstimationConfig | null
+  ): Promise<void> {
+    return await this.onlineInvoke<void>('setQualityEstimationConfig', {
+      projectId,
+      qualityEstimationConfig
+    });
+  }
+
   async onlineSetServalConfig(projectId: string, servalConfig: string | null | undefined): Promise<void> {
     return await this.onlineInvoke<void>('setServalConfig', {
       projectId,
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.html b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.html
@@ -66,13 +66,52 @@ <h2>Pre-Translation Configuration</h2>
         <mat-form-field [formGroup]="form" appearance="outline" class="serval-config-field">
           <mat-label>NMT Build Options Override (JSON)</mat-label>
           <textarea matInput cdkTextareaAutosize id="serval-config" formControlName="servalConfig"></textarea>
-          <app-write-status [state]="updateState" [formGroup]="form" id="serval-config-status"></app-write-status>
+          <app-write-status
+            [state]="servalConfigUpdateState"
+            [formGroup]="form"
+            id="serval-config-status"
+          ></app-write-status>
         </mat-form-field>
       </mat-card-content>
       <mat-card-actions>
         <button mat-flat-button id="save-serval-config" color="primary" (click)="updateServalConfig()">Save</button>
       </mat-card-actions>
     </mat-card>
+    <mat-card>
+      <mat-card-header>
+        <mat-card-title>Quality Estimation Configuration</mat-card-title>
+      </mat-card-header>
+      <mat-card-content>
+        <p>
+          This value must be a valid JSON string, and will be in the file linregress.json created by
+          quality_estimation.py.
+        </p>
+        <mat-form-field [formGroup]="form" appearance="outline" class="quality-estimation-config-field">
+          <mat-label>Quality Estimation Configuration (JSON)</mat-label>
+          <textarea
+            matInput
+            cdkTextareaAutosize
+            id="quality-estimation-config"
+            formControlName="qualityEstimationConfig"
+          ></textarea>
+          <app-write-status
+            [state]="qualityEstimationConfigUpdateState"
+            [formGroup]="form"
+            id="quality-estimation-config-status"
+          ></app-write-status>
+        </mat-form-field>
+      </mat-card-content>
+      <mat-card-actions>
+        <button
+          mat-flat-button
+          id="save-quality-estimation-config"
+          color="primary"
+          (click)="updateQualityEstimationConfig()"
+        >
+          Save
+        </button>
+      </mat-card-actions>
+    </mat-card>
   </div>
 </div>
 
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.scss b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.scss
@@ -8,7 +8,8 @@
     flex-direction: row;
     column-gap: 10px;
 
-    .serval-config-field {
+    .serval-config-field,
+    .quality-estimation-config-field {
       width: 100%;
     }
   }
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.spec.ts
@@ -12,6 +12,7 @@ import { BehaviorSubject, of, throwError } from 'rxjs';
 import { anything, instance, mock, verify, when } from 'ts-mockito';
 import { ActivatedProjectService } from 'xforge-common/activated-project.service';
 import { AuthService } from 'xforge-common/auth.service';
+import { CommandError, CommandErrorCode } from 'xforge-common/command.service';
 import { FileService } from 'xforge-common/file.service';
 import { I18nService } from 'xforge-common/i18n.service';
 import { FileType } from 'xforge-common/models/file-offline-data';
@@ -308,6 +309,103 @@ describe('ServalProjectComponent', () => {
         verify(mockSFProjectService.onlineSetServalConfig(env.mockProjectId, anything())).never();
         expect(env.statusDone(env.servalConfigStatus)).toBeNull();
       }));
+
+      it('should notify of a backend error', fakeAsync(() => {
+        const env = new TestEnvironment();
+        when(mockSFProjectService.onlineSetServalConfig(env.mockProjectId, anything())).thenReject(
+          new CommandError(CommandErrorCode.InternalError, 'error')
+        );
+        expect(env.servalConfigTextArea.value).toBe('');
+        expect(env.statusError(env.servalConfigStatus)).toBeNull();
+
+        env.setServalConfigValue('{}');
+        env.clickElement(env.saveServalConfigButton);
+
+        verify(mockSFProjectService.onlineSetServalConfig(env.mockProjectId, anything())).once();
+        expect(env.statusError(env.servalConfigStatus)).not.toBeNull();
+      }));
+    });
+
+    describe('quality estimation configuration', () => {
+      it('should change quality estimation config value', fakeAsync(() => {
+        const env = new TestEnvironment();
+        expect(env.qualityEstimationConfigTextArea.value).toBe('');
+        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())).once();
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).not.toBeNull();
+      }));
+
+      it('should clear the 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('');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).once();
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).not.toBeNull();
+      }));
+
+      it('should not update an unchanged quality estimation config value', fakeAsync(() => {
+        const env = new TestEnvironment();
+        expect(env.qualityEstimationConfigTextArea.value).toBe('');
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).toBeNull();
+
+        env.setQualityEstimationConfigValue('');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).never();
+        expect(env.statusDone(env.qualityEstimationConfigStatus)).toBeNull();
+      }));
+
+      it('should not update a non-JSON value', fakeAsync(() => {
+        const env = new TestEnvironment();
+        expect(env.qualityEstimationConfigTextArea.value).toBe('');
+        expect(env.statusError(env.qualityEstimationConfigStatus)).toBeNull();
+
+        env.setQualityEstimationConfigValue('test');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).never();
+        expect(env.statusError(env.qualityEstimationConfigStatus)).not.toBeNull();
+      }));
+
+      it('should not update an invalid value', fakeAsync(() => {
+        const env = new TestEnvironment();
+        expect(env.qualityEstimationConfigTextArea.value).toBe('');
+        expect(env.statusError(env.qualityEstimationConfigStatus)).toBeNull();
+
+        env.setQualityEstimationConfigValue('{"prop": "value"}');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).never();
+        expect(env.statusError(env.qualityEstimationConfigStatus)).not.toBeNull();
+      }));
+
+      it('should notify of a backend error', fakeAsync(() => {
+        const env = new TestEnvironment();
+        when(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).thenReject(
+          new CommandError(CommandErrorCode.InternalError, 'error')
+        );
+        expect(env.qualityEstimationConfigTextArea.value).toBe('');
+        expect(env.statusError(env.qualityEstimationConfigStatus)).toBeNull();
+
+        env.setQualityEstimationConfigValue('{ "version": "0.1", "slope": 109.6145, "intercept": -14.0633 }');
+        env.clickElement(env.saveQualityEstimationConfigButton);
+
+        verify(mockSFProjectService.onlineSetQualityEstimationConfig(env.mockProjectId, anything())).once();
+        expect(env.statusError(env.qualityEstimationConfigStatus)).not.toBeNull();
+      }));
     });
   });
 
@@ -363,7 +461,8 @@ describe('ServalProjectComponent', () => {
               lastSelectedTrainingScriptureRanges: args.draftConfig?.lastSelectedTrainingScriptureRanges ?? undefined,
               lastSelectedTranslationScriptureRanges:
                 args.draftConfig?.lastSelectedTranslationScriptureRanges ?? undefined,
-              servalConfig: args.draftConfig?.servalConfig ?? undefined
+              servalConfig: args.draftConfig?.servalConfig ?? undefined,
+              qualityEstimationConfig: args.draftConfig?.qualityEstimationConfig ?? undefined
             },
             preTranslate: args.preTranslate,
             source: {
@@ -395,6 +494,7 @@ describe('ServalProjectComponent', () => {
       when(mockDraftGenerationService.getBuildProgress(anything())).thenReturn(of({ additionalInfo: {} } as BuildDto));
       when(mockSFProjectService.hasDraft(anything())).thenReturn(args.preTranslate);
       when(mockSFProjectService.onlineSetServalConfig(this.mockProjectId, anything())).thenResolve();
+      when(mockSFProjectService.onlineSetQualityEstimationConfig(this.mockProjectId, anything())).thenResolve();
       const trainingData: TrainingDataDoc[] = [
         {
           id: 'training01',
@@ -444,6 +544,18 @@ describe('ServalProjectComponent', () => {
       return this.fixture.nativeElement.querySelector('.training-data-table td button');
     }
 
+    get qualityEstimationConfigStatus(): DebugElement {
+      return this.fixture.debugElement.query(By.css('#quality-estimation-config-status'));
+    }
+
+    get qualityEstimationConfigTextArea(): HTMLTextAreaElement {
+      return this.fixture.nativeElement.querySelector('#quality-estimation-config') as HTMLTextAreaElement;
+    }
+
+    get saveQualityEstimationConfigButton(): HTMLInputElement {
+      return this.fixture.nativeElement.querySelector('#save-quality-estimation-config');
+    }
+
     get saveServalConfigButton(): HTMLInputElement {
       return this.fixture.nativeElement.querySelector('#save-serval-config');
     }
@@ -485,6 +597,14 @@ describe('ServalProjectComponent', () => {
       return node.querySelector('.translation-range')?.textContent ?? '';
     }
 
+    setQualityEstimationConfigValue(value: string): void {
+      this.qualityEstimationConfigTextArea.value = value;
+      this.qualityEstimationConfigTextArea.dispatchEvent(new Event('input'));
+      this.fixture.detectChanges();
+      tick();
+      this.fixture.detectChanges();
+    }
+
     setServalConfigValue(value: string): void {
       this.servalConfigTextArea.value = value;
       this.servalConfigTextArea.dispatchEvent(new Event('input'));
@@ -496,5 +616,9 @@ describe('ServalProjectComponent', () => {
     statusDone(element: DebugElement): HTMLElement {
       return element.nativeElement.querySelector('.check-icon') as HTMLElement;
     }
+
+    statusError(element: DebugElement): HTMLElement {
+      return element.nativeElement.querySelector('.error-icon') as HTMLElement;
+    }
   }
 });
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-project.component.ts

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`flex-direction: row;`
`9`	`9`	`column-gap: 10px;`
`10`	`10`
`11`		`- .serval-config-field {`
	`11`	`+ .serval-config-field,`
	`12`	`+ .quality-estimation-config-field {`
`12`	`13`	`width: 100%;`
`13`	`14`	`}`
`14`	`15`	`}`