119602: Force minimum time out

Author: AAwouters

src/app/accessibility/accessibility-settings.service.stub.ts

@@ -37,4 +37,8 @@ export class AccessibilitySettingsServiceStub {
   convertStoredValuesToFormValues = jasmine.createSpy('convertStoredValuesToFormValues').and.returnValue({});
 
   getPlaceholder = jasmine.createSpy('getPlaceholder').and.returnValue('placeholder');
+
+  isValid = jasmine.createSpy('isValid').and.returnValue(true);
+
+  allValid = jasmine.createSpy('allValid').and.returnValue(true);
 }

src/app/accessibility/accessibility-settings.service.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@angular/core';
 import { Observable, of, switchMap } from 'rxjs';
 import { map, take } from 'rxjs/operators';
 import { CookieService } from '../core/services/cookie.service';
-import { hasValue, isNotEmpty } from '../shared/empty.util';
+import { hasValue, isNotEmpty, hasNoValue } from '../shared/empty.util';
 import { AuthService } from '../core/auth/auth.service';
 import { EPerson } from '../core/eperson/models/eperson.model';
 import { EPersonDataService } from '../core/eperson/eperson-data.service';
@@ -276,6 +276,26 @@ export class AccessibilitySettingsService {
     };
   }
 
+  /**
+   * Returns true if the provided value is a valid value for the provided AccessibilitySetting.
+   */
+  isValid(setting: AccessibilitySetting | string, value: string): boolean {
+    switch (setting) {
+      case 'notificationTimeOut':
+        return hasNoValue(value) || parseFloat(value) > 0;
+      case 'liveRegionTimeOut':
+        return hasNoValue(value) || parseFloat(value) > 0;
+      default:
+        throw new Error(`Unhandled accessibility setting during validity check: ${setting}`);
+    }
+  }
+
+  /**
+   * Returns true if all settings in the provided AccessibilitySettings object are valid
+   */
+  allValid(settings: AccessibilitySettings) {
+    return Object.entries(settings).every(([setting, value], _) => this.isValid(setting, value));
+  }
 }
 
 /**

src/app/info/accessibility-settings/accessibility-settings.component.html

@@ -30,10 +30,15 @@ <h2>{{ 'info.accessibility-settings.title' | translate }}</h2>
 
       <div class="col-sm-4">
         <input [type]="'number'" [id]="'notificationTimeOutInput'" class="form-control"
+               [ngClass]="{'is-invalid': !settingsService.isValid('notificationTimeOut', formValues.notificationTimeOut)}"
+               [min]="1"
                [placeholder]="getPlaceholder('notificationTimeOut')"
                [readOnly]="!formValues.notificationTimeOutEnabled"
                [(ngModel)]="formValues.notificationTimeOut" [ngModelOptions]="{ standalone: true }"
                [attr.aria-describedby]="'notificationTimeOutHint'">
+        <div class="invalid-feedback" [ngClass]="{ 'd-block': !settingsService.isValid('notificationTimeOut', formValues.notificationTimeOut) }">
+          {{ 'info.accessibility-settings.notificationTimeOut.invalid' | translate }}
+        </div>
       </div>
 
 
@@ -53,9 +58,14 @@ <h2>{{ 'info.accessibility-settings.title' | translate }}</h2>
 
       <div class="col-sm-4">
         <input [type]="'number'" [id]="'liveRegionTimeOutInput'" class="form-control"
+               [ngClass]="{'is-invalid': !settingsService.isValid('liveRegionTimeOut', formValues.liveRegionTimeOut)}"
+               [min]="1"
                [placeholder]="getPlaceholder('liveRegionTimeOut')"
                [(ngModel)]="formValues.liveRegionTimeOut" [ngModelOptions]="{ standalone: true }"
                [attr.aria-describedby]="'liveRegionTimeOutHint'">
+        <div class="invalid-feedback" [ngClass]="{ 'd-block': !settingsService.isValid('liveRegionTimeOut', formValues.liveRegionTimeOut) }">
+          {{ 'info.accessibility-settings.liveRegionTimeOut.invalid' | translate }}
+        </div>
       </div>
 
 

src/app/info/accessibility-settings/accessibility-settings.component.ts

@@ -42,10 +42,18 @@ export class AccessibilitySettingsComponent implements OnInit {
   saveSettings() {
     const formValues = this.formValues;
     const convertedValues = this.settingsService.convertFormValuesToStoredValues(formValues);
-    this.settingsService.setSettings(convertedValues).pipe(take(1)).subscribe(location => {
-      this.notificationsService.success(null, this.translateService.instant('info.accessibility-settings.save-notification.' + location));
-      this.updateFormValues();
-    });
+
+    if (this.settingsService.allValid(convertedValues)) {
+      this.settingsService.setSettings(convertedValues).pipe(take(1)).subscribe(location => {
+        this.notificationsService.success(null, this.translateService.instant('info.accessibility-settings.save-notification.' + location));
+        this.updateFormValues();
+      });
+    } else {
+      this.notificationsService.error(
+        null,
+        this.translateService.instant('info.accessibility-settings.invalid-form-notification'),
+      );
+    }
   }
 
   /**

src/assets/i18n/en.json5

@@ -1848,14 +1848,20 @@
 
   "info.accessibility-settings.disableNotificationTimeOut.hint": "When this toggle is activated, notifications will close automatically after the time out passes. When deactivated, notifications will remain open untill manually closed.",
 
+  "info.accessibility-settings.invalid-form-notification": "Did not save. The form contains invalid values.",
+
   "info.accessibility-settings.liveRegionTimeOut.label": "ARIA Live region time out (in seconds)",
 
   "info.accessibility-settings.liveRegionTimeOut.hint": "The duration after which a message in the ARIA live region disappears. ARIA live regions are not visible on the page, but proivde announcements of notifications (or other actions) to screen readers.",
 
+  "info.accessibility-settings.liveRegionTimeOut.invalid": "Live region time out must be greater than 0",
+
   "info.accessibility-settings.notificationTimeOut.label": "Notification time out (in seconds)",
 
   "info.accessibility-settings.notificationTimeOut.hint": "The duration after which a notification disappears.",
 
+  "info.accessibility-settings.notificationTimeOut.invalid": "Notification time out must be greater than 0",
+
   "info.accessibility-settings.save-notification.cookie": "Successfully saved settings locally.",
 
   "info.accessibility-settings.save-notification.metadata": "Successfully saved settings on the user profile.",