Merge pull request #25 from CrowdStrike/validation-timing2

Support for `@validateOn`/`@revalidateOn` options

ember-headless-form/package.json

@@ -28,6 +28,7 @@
   "dependencies": {
     "@babel/runtime": "^7.20.7",
     "@embroider/addon-shim": "^1.0.0",
+    "@ember/test-waiters": "^3.0.2",
     "@embroider/util": "^1.9.0",
     "tracked-built-ins": "^3.1.0"
   },
@@ -57,6 +58,7 @@
     "@types/ember__debug": "^4.0.0",
     "@types/ember__engine": "^4.0.0",
     "@types/ember__error": "^4.0.0",
+    "@types/ember__modifier": "^4.0.3",
     "@types/ember__object": "^4.0.0",
     "@types/ember__polyfills": "^4.0.0",
     "@types/ember__routing": "^4.0.0",

ember-headless-form/src/components/-private/types.ts

@@ -55,7 +55,7 @@ export type FieldValidateCallback<
  * Internal structure to track used fields
  * @private
  */
-export interface FieldData<
+export interface FieldRegistrationData<
   DATA extends FormData,
   KEY extends FormKey<DATA> = FormKey<DATA>
 > {
@@ -69,7 +69,7 @@ export interface FieldData<
 export type RegisterFieldCallback<
   DATA extends FormData,
   KEY extends FormKey<DATA> = FormKey<DATA>
-> = (name: KEY, field: FieldData<DATA, KEY>) => void;
+> = (name: KEY, field: FieldRegistrationData<DATA, KEY>) => void;
 
 export type UnregisterFieldCallback<
   DATA extends FormData,
@@ -79,6 +79,4 @@ export type UnregisterFieldCallback<
 /**
  * Mapper type to construct subset of objects, whose keys are only strings (and not number or symbol)
  */
-export type OnlyStringKeys<T extends object> = {
-  [P in Extract<keyof T, string>]: T[P];
-};
+export type OnlyStringKeys<T extends object> = Pick<T, keyof T & string>;

ember-headless-form/src/components/headless-form.hbs

@@ -1,11 +1,20 @@
-<form ...attributes {{on 'submit' this.onSubmit}}>
+{{! ignoring prettier here is need to *not* wrap the modifier usage below into a new line, making @glint-expect-error fail to work 🙈 }}
+{{! prettier-ignore }}
+<form
+  ...attributes
+  {{on 'submit' this.onSubmit}}
+  {{! @glint-expect-error: modifier helper not supported, see https://github.com/typed-ember/glint/issues/410 }}
+  {{(if this.fieldValidationEvent (modifier this.on this.fieldValidationEvent this.handleFieldValidation))}}
+  {{! @glint-expect-error: modifier helper not supported, see https://github.com/typed-ember/glint/issues/410 }}
+  {{(if this.fieldRevalidationEvent (modifier this.on this.fieldRevalidationEvent this.handleFieldRevalidation))}}
+>
   {{yield
     (hash
       field=(component
         (ensure-safe-component this.FieldComponent)
         data=this.internalData
         set=this.set
-        errors=this.lastValidationResult
+        errors=this.visibleErrors
         registerField=this.registerField
         unregisterField=this.unregisterField
       )

ember-headless-form/src/components/headless-form.ts

@@ -1,7 +1,9 @@
 import Component from '@glimmer/component';
 import { tracked } from '@glimmer/tracking';
 import { assert } from '@ember/debug';
+import { on } from '@ember/modifier';
 import { action } from '@ember/object';
+import { waitFor } from '@ember/test-waiters';
 
 import { TrackedObject } from 'tracked-built-ins';
 
@@ -10,11 +12,13 @@ import FieldComponent from './-private/field';
 import type { HeadlessFormFieldComponentSignature } from './-private/field';
 import type {
   ErrorRecord,
-  FieldData,
+  FieldRegistrationData,
+  FieldValidateCallback,
   FormData,
   FormKey,
   FormValidateCallback,
   UserData,
+  ValidationError,
 } from './-private/types';
 import type { ComponentLike, WithBoundArgs } from '@glint/template';
 
@@ -37,28 +41,62 @@ export interface HeadlessFormComponentSignature<DATA extends UserData> {
     default: [
       {
         field: WithBoundArgs<
-          typeof FieldComponent<FormData<DATA>>,
+          typeof FieldComponent<DATA>,
           'data' | 'set' | 'errors' | 'registerField' | 'unregisterField'
         >;
       }
     ];
   };
 }
 
+/**
+ * This internal data structure maintains information about each field that is registered to the form by `registerField`.
+ */
+class FieldData<
+  DATA extends FormData,
+  KEY extends FormKey<DATA> = FormKey<DATA>
+> {
+  constructor(fieldRegistration: FieldRegistrationData<DATA, KEY>) {
+    this.validate = fieldRegistration.validate;
+  }
+
+  /**
+   * tracked state that enabled a dynamic validation of a field *before* the whole form is submitted, e.g. by `@validateOn="blur" and the blur event being triggered for that particular field.
+   */
+  @tracked validationEnabled = false;
+
+  /**
+   * The *field* level validation callback passed to the field as in `<form.field @name="foo" @validate={{this.validateCallback}}>`
+   */
+  validate?: FieldValidateCallback<DATA, KEY>;
+}
+
 export default class HeadlessFormComponent<
   DATA extends UserData
 > extends Component<HeadlessFormComponentSignature<DATA>> {
   FieldComponent: ComponentLike<HeadlessFormFieldComponentSignature<DATA>> =
     FieldComponent;
 
-  internalData: FormData<DATA> = new TrackedObject(
-    this.args.data ?? {}
-  ) as FormData<DATA>;
+  // we cannot use (modifier "on") directly in the template due to https://github.com/emberjs/ember.js/issues/19869
+  on = on;
+
+  /**
+   * A copy of the passed `@data` stored internally, which is only passed back to the component consumer after a (successful) form submission.
+   */
+  internalData: DATA = new TrackedObject(this.args.data ?? {}) as DATA;
 
   fields = new Map<FormKey<FormData<DATA>>, FieldData<FormData<DATA>>>();
 
+  /**
+   * The last result of calling `this.validate()`.
+   */
   @tracked lastValidationResult?: ErrorRecord<FormData<DATA>>;
 
+  /**
+   * When this is set to true by submitting the form, eventual validation errors are show for *all* field, regardless of their individual dynamic validation status in `FieldData#validationEnabled`
+   */
+  @tracked showAllValidations = false;
+
   get validateOn(): ValidateOn {
     return this.args.validateOn ?? 'submit';
   }
@@ -67,6 +105,43 @@ export default class HeadlessFormComponent<
     return this.args.revalidateOn ?? 'change';
   }
 
+  /**
+   * Return the event type that will be listened on for dynamic validation (i.e. *before* submitting)
+   */
+  get fieldValidationEvent(): 'focusout' | 'change' | undefined {
+    const { validateOn } = this;
+
+    return validateOn === 'submit'
+      ? // no need for dynamic validation, as validation always happens on submit
+        undefined
+      : // our component API expects "blur", but the actual blur event does not bubble up, so we use focusout internally instead
+      validateOn === 'blur'
+      ? 'focusout'
+      : validateOn;
+  }
+
+  /**
+   * Return the event type that will be listened on for dynamic *re*validation, i.e. updating the validation status of a field that has been previously marked as invalid
+   */
+  get fieldRevalidationEvent(): 'focusout' | 'change' | undefined {
+    const { validateOn, revalidateOn } = this;
+
+    return revalidateOn === 'submit'
+      ? // no need for dynamic validation, as validation always happens on submit
+        undefined
+      : // when validation happens more frequently than revalidation, then we can ignore revalidation, because the validation handler will already cover us
+      validateOn === 'change' ||
+        (validateOn === 'blur' && revalidateOn === 'blur')
+      ? undefined
+      : // our component API expects "blur", but the actual blur event does not bubble up, so we use focusout internally instead
+      revalidateOn === 'blur'
+      ? 'focusout'
+      : revalidateOn;
+  }
+
+  /**
+   * Return true if validation has happened (by submitting or by an `@validateOn` event being triggered) and at least one field is invalid
+   */
   get hasValidationErrors(): boolean {
     // Only consider validation errors for which we actually have a field rendered
     return this.lastValidationResult
@@ -76,6 +151,10 @@ export default class HeadlessFormComponent<
       : false;
   }
 
+  /**
+   * Call the passed validation callbacks, defined both on the whole form as well as on field level, and return the merged result for all fields.
+   */
+  @waitFor
   async validate(): Promise<ErrorRecord<FormData<DATA>> | undefined> {
     let errors: ErrorRecord<FormData<DATA>> | undefined = undefined;
 
@@ -106,11 +185,46 @@ export default class HeadlessFormComponent<
     return Object.keys(errors).length > 0 ? errors : undefined;
   }
 
+  /**
+   * Return a mapping of field to validation errors, for all fields that are invalid *and* for which validation errors should be visible.
+   * Validation errors will be visible for a certain field, if validation errors for *all* fields are visible, which is the case when trying to submit the form,
+   * or when that field has triggered the event given by `@validateOn` for showing validation errors before submitting, e.g. on blur.
+   */
+  get visibleErrors(): ErrorRecord<FormData<DATA>> | undefined {
+    if (!this.lastValidationResult) {
+      return undefined;
+    }
+
+    const visibleErrors: ErrorRecord<FormData<DATA>> = {};
+
+    for (const [field, errors] of Object.entries(this.lastValidationResult) as [
+      FormKey<FormData<DATA>>,
+      ValidationError<FormData<DATA>[FormKey<FormData<DATA>>]>[]
+    ][]) {
+      if (this.showErrorsFor(field)) {
+        visibleErrors[field] = errors;
+      }
+    }
+
+    return visibleErrors;
+  }
+
+  /**
+   * Given a field name, return if eventual errors for the field should be visible. See `visibleErrors` for further details.
+   */
+  showErrorsFor(field: FormKey<FormData<DATA>>): boolean {
+    return (
+      this.showAllValidations ||
+      (this.fields.get(field)?.validationEnabled ?? false)
+    );
+  }
+
   @action
   async onSubmit(e: Event): Promise<void> {
     e.preventDefault();
 
     this.lastValidationResult = await this.validate();
+    this.showAllValidations = true;
 
     if (!this.hasValidationErrors) {
       this.args.onSubmit?.(this.internalData);
@@ -126,15 +240,15 @@ export default class HeadlessFormComponent<
   @action
   registerField(
     name: FormKey<FormData<DATA>>,
-    field: FieldData<FormData<DATA>>
+    field: FieldRegistrationData<FormData<DATA>>
   ): void {
     assert(
       `You passed @name="${String(
         name
       )}" to the form field, but this is already in use. Names of form fields must be unique!`,
       !this.fields.has(name)
     );
-    this.fields.set(name, field);
+    this.fields.set(name, new FieldData(field));
   }
 
   @action
@@ -146,4 +260,47 @@ export default class HeadlessFormComponent<
   set<KEY extends FormKey<FormData<DATA>>>(key: KEY, value: DATA[KEY]): void {
     this.internalData[key] = value;
   }
+
+  /**
+   * Handle the `@validateOn` event for a certain field, e.g. "blur".
+   * Associating the event with a field is done by looking at the event target's `name` attribute, which must match one of the `<form.field @name="...">` invocations by the user's template.
+   * Validation will be triggered, and the particular field will be marked to show eventual validation errors.
+   */
+  @action
+  async handleFieldValidation(e: Event): Promise<void> {
+    const { target } = e;
+    const { name } = target as HTMLInputElement;
+
+    if (name) {
+      const field = this.fields.get(name as FormKey<FormData<DATA>>);
+
+      if (field) {
+        this.lastValidationResult = await this.validate();
+        field.validationEnabled = true;
+      }
+    } else {
+      // @todo how to handle custom controls that don't emit focusout/change events from native form controls?
+    }
+  }
+
+  /**
+   * Handle the `@revalidateOn` event for a certain field, e.g. "blur".
+   * Associating the event with a field is done by looking at the event target's `name` attribute, which must match one of the `<form.field @name="...">` invocations by the user's template.
+   * When a field has been already marked to show validation errors by `@validateOn`, then for revalidation another validation will be triggered.
+   *
+   * The use case here is to allow this to happen more frequently than the initial validation, e.g. `@validateOn="blur" @revalidateOn="change"`.
+   */
+  @action
+  async handleFieldRevalidation(e: Event): Promise<void> {
+    const { target } = e;
+    const { name } = target as HTMLInputElement;
+
+    if (name) {
+      if (this.showErrorsFor(name as FormKey<FormData<DATA>>)) {
+        this.lastValidationResult = await this.validate();
+      }
+    } else {
+      // @todo how to handle custom controls that don't emit focusout/change events from native form controls?
+    }
+  }
 }

test-app/app/templates/index.hbs

@@ -1,4 +1,9 @@
-<HeadlessForm @data={{this.data}} @onSubmit={{this.doSomething}} as |form|>
+<HeadlessForm
+  @data={{this.data}}
+  @validateOn='blur'
+  @onSubmit={{this.doSomething}}
+  as |form|
+>
   <form.field @name='name' as |field|>
     <field.label>Name</field.label>
     <field.input />