ValueField: add support for async validators

Wait for pending fields on load

333353

Author: cguglielmo

eclipse-scout-core/src/form/Form.ts

@@ -9,9 +9,9 @@
  */
 import {
   AbortKeyStroke, App, aria, AriaLabelledByInsertPosition, arrays, BusyIndicatorOptions, Button, ButtonSystemType, ChildModelOf, DialogLayout, DisabledStyle, DisplayParent, DisplayViewId, EnumObject, ErrorHandler, Event, EventHandler,
-  FileChooser, FileChooserController, FocusRule, FormController, FormEventMap, FormField, FormGrid, FormInvalidEvent, FormLayout, FormLifecycle, FormModel, FormRevealInvalidFieldEvent, GlassPaneRenderer, GroupBox, HtmlComponent,
-  InitModelOf, KeyStroke, KeyStrokeContext, Lifecycle, MessageBox, MessageBoxController, MessageBoxes, ModelOf, NotificationBadgeStatus, ObjectOrChildModel, objects, Point, PopupWindow, PropertyChangeEvent, Rectangle, scout, Status,
-  StatusOrModel, strings, TextListWithTitle, tooltips, TreeVisitResult, ValidationResult, webstorage, Widget, WrappedFormField
+  FileChooser, FileChooserController, FocusRule, FormController, FormEventMap, FormGrid, FormInvalidEvent, FormLayout, FormLifecycle, FormModel, FormRevealInvalidFieldEvent, GlassPaneRenderer, GroupBox, HtmlComponent, InitModelOf,
+  KeyStroke, KeyStrokeContext, Lifecycle, MessageBox, MessageBoxController, MessageBoxes, ModelOf, NotificationBadgeStatus, ObjectOrChildModel, objects, Point, PopupWindow, PropertyChangeEvent, Rectangle, scout, Status, StatusOrModel,
+  strings, TextListWithTitle, tooltips, TreeVisitResult, ValidationResult, webstorage, Widget, WrappedFormField
 } from '../index';
 import $ from 'jquery';
 
@@ -449,17 +449,23 @@ export class Form extends Widget implements FormModel, DisplayParent {
     try {
       this._setFormLoading(true);
       return this._load()
-        .then(async data => {
+        .then(data => {
           if (this.destroyed) {
             // If form has been closed right after it was opened ignore the load result
             return;
           }
+
           this.setData(data);
           this.importData();
-          await this._whenPendingFieldsReady();
-          this._setFormLoading(false);
-          this.formLoaded = true;
-          this.trigger('load');
+
+          // Wait for async field validators to complete so the value is set when the form loading finishes
+          let pendingFields = FormLifecycle.validateFormFields(this).pendingElements;
+          if (pendingFields.length) {
+            return $.promiseAll(pendingFields.map(field => field.promise))
+              .then(() => this._loadingDone());
+          }
+
+          this._loadingDone();
         })
         .always(() => this._setFormLoading(false));
     } catch (error) {
@@ -468,23 +474,14 @@ export class Form extends Widget implements FormModel, DisplayParent {
     }
   }
 
-  protected _setFormLoading(loading: boolean) {
-    this._setProperty('formLoading', loading);
+  protected _loadingDone() {
+    this._setFormLoading(false);
+    this.formLoaded = true;
+    this.trigger('load');
   }
 
-  protected _whenPendingFieldsReady() {
-    let promises = [];
-    this.visitFields((field: FormField) => {
-      let result = field.getValidationResult();
-      if (result.promise) {
-        promises.push(result.promise);
-      }
-      if (field.lifecycleBoundary) {
-        return TreeVisitResult.SKIP_SUBTREE;
-      }
-      return result.visitResult;
-    });
-    return $.promiseAll(promises);
+  protected _setFormLoading(loading: boolean) {
+    this._setProperty('formLoading', loading);
   }
 
   /**

eclipse-scout-core/test/form/FormSpec.ts

@@ -246,6 +246,24 @@ describe('Form', () => {
       await form.load();
       expect(loadCounter).toBe(1);
     });
+
+    it('waits for async field validators to complete', async () => {
+      let form = helper.createFormWithOneField();
+      let field = form.rootGroupBox.fields[0] as StringField;
+
+      field.setValidators([value => sleep(50).then(() => value + ' async')], false);
+      field.setValue('x');
+
+      let promise = form.load();
+      expect(field.value).toBe(null);
+      expect(field.validatePending).toBe(true);
+
+      await promise;
+      expect(field.value).toBe('x async');
+      expect(field.validatePending).toBe(false);
+
+      return promise;
+    });
   });
 
   describe('save', () => {