Skip to content

Commit

Permalink
refactor(forms): Move FormControl to an overridden exported construct…
Browse files Browse the repository at this point in the history 
…or. (#44316)

This implementation change was originally proposed as part of Typed Forms, and will have major consequences for that project as described in the design doc. Submitting it separately will greatly simplify the risk of landing Typed Forms. This change should have no visible impact on normal users of FormControl.

See the Typed Forms design doc here: https://docs.google.com/document/d/1cWuBE-oo5WLtwkLFxbNTiaVQGNk8ipgbekZcKBeyxxo.

PR Close #44316
  • Loading branch information
@dylhunn @alxhub
dylhunn authored and alxhub committed Dec 8, 2021
1 parent 6df314f commit cdf50ff
Show file tree
Hide file tree
Showing 4 changed files with 182 additions and 65 deletions.
12 changes: 10 additions & 2 deletions goldens/public-api/forms/forms.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,8 +293,7 @@ export class FormBuilder {
}

// @public
export class FormControl extends AbstractControl {
constructor(formState?: any, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null);
export interface FormControl extends AbstractControl {
patchValue(value: any, options?: {
onlySelf?: boolean;
emitEvent?: boolean;
Expand All @@ -315,6 +314,15 @@ export class FormControl extends AbstractControl {
}): void;
}

// @public (undocumented)
export const FormControl: FormControlCtor;

// @public
export interface FormControlCtor {
new (): FormControl;
new (value: any, validatorOrOpts?: ValidatorFn | ValidatorFn[] | AbstractControlOptions | null, asyncValidator?: AsyncValidatorFn | AsyncValidatorFn[] | null): FormControl;
}

// @public
export class FormControlDirective extends NgControl implements OnChanges, OnDestroy {
constructor(validators: (Validator | ValidatorFn)[], asyncValidators: (AsyncValidator | AsyncValidatorFn)[], valueAccessors: ControlValueAccessor[], _ngModelWarningConfig: string | null);
Expand Down
2 changes: 1 addition & 1 deletion packages/forms/src/forms.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export {NgSelectOption, SelectControlValueAccessor} from './directives/select_co
export {SelectMultipleControlValueAccessor, ɵNgSelectMultipleOption} from './directives/select_multiple_control_value_accessor';
export {AsyncValidator, AsyncValidatorFn, CheckboxRequiredValidator, EmailValidator, MaxLengthValidator, MaxValidator, MinLengthValidator, MinValidator, PatternValidator, RequiredValidator, ValidationErrors, Validator, ValidatorFn} from './directives/validators';
export {FormBuilder} from './form_builder';
export {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormControlStatus, FormGroup} from './model';
export {AbstractControl, AbstractControlOptions, FormArray, FormControl, FormControlCtor, FormControlStatus, FormGroup} from './model';
export {NG_ASYNC_VALIDATORS, NG_VALIDATORS, Validators} from './validators';
export {VERSION} from './version';

Expand Down
212 changes: 151 additions & 61 deletions packages/forms/src/model.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1118,7 +1118,6 @@ export abstract class AbstractControl {
this._updateOn = opts.updateOn!;
}
}

/**
* Check to see if parent has been marked artificially dirty.
*
Expand All @@ -1131,13 +1130,15 @@ export abstract class AbstractControl {
}

/**
* Tracks the value and validation status of an individual form control.
* Tracks the value and validation status of an individual form control. Constructed by {@link
* FormControlCtor}.
*
* This is one of the three fundamental building blocks of Angular forms, along with
* `FormGroup` and `FormArray`. It extends the `AbstractControl` class that
* implements most of the base functionality for accessing the value, validation status,
* user interactions and events. See [usage examples below](#usage-notes).
*
* @see FormControlCtor
* @see `AbstractControl`
* @see [Reactive Forms Guide](guide/reactive-forms)
* @see [Usage Notes](#usage-notes)
Expand All @@ -1151,7 +1152,7 @@ export abstract class AbstractControl {
* ```ts
* const control = new FormControl('some value');
* console.log(control.value); // 'some value'
*```
* ```
*
* The following example initializes the control with a form state object. The `value`
* and `disabled` keys are required in this case.
Expand Down Expand Up @@ -1227,46 +1228,15 @@ export abstract class AbstractControl {
*
* @publicApi
*/
export class FormControl extends AbstractControl {
export declare interface FormControl extends AbstractControl {
/** @internal */
_onChange: Function[] = [];
_onChange: Function[];

/** @internal */
_pendingValue: any;
_pendingValue: boolean;

/** @internal */
_pendingChange: any;

/**
* Creates a new `FormControl` instance.
*
* @param formState Initializes the control with an initial value,
* or an object that defines the initial value and disabled state.
*
* @param validatorOrOpts A synchronous validator function, or an array of
* such functions, or an `AbstractControlOptions` object that contains validation functions
* and a validation trigger.
*
* @param asyncValidator A single async validator or array of async validator functions
*
*/
constructor(
formState: any = null,
validatorOrOpts?: ValidatorFn|ValidatorFn[]|AbstractControlOptions|null,
asyncValidator?: AsyncValidatorFn|AsyncValidatorFn[]|null) {
super(pickValidators(validatorOrOpts), pickAsyncValidators(asyncValidator, validatorOrOpts));
this._applyFormState(formState);
this._setUpdateStrategy(validatorOrOpts);
this._initObservables();
this.updateValueAndValidity({
onlySelf: true,
// If `asyncValidator` is present, it will trigger control status change from `PENDING` to
// `VALID` or `INVALID`.
// The status should be broadcasted via the `statusChanges` observable, so we set `emitEvent`
// to `true` to allow that during the control creation process.
emitEvent: !!this.asyncValidator
});
}
_pendingChange: boolean;

/**
* Sets a new value for the form control.
Expand All @@ -1291,19 +1261,12 @@ export class FormControl extends AbstractControl {
* event to update the model.
*
*/
override setValue(value: any, options: {
setValue(value: any, options?: {
onlySelf?: boolean,
emitEvent?: boolean,
emitModelToViewChange?: boolean,
emitViewToModelChange?: boolean
} = {}): void {
(this as {value: any}).value = this._pendingValue = value;
if (this._onChange.length && options.emitModelToViewChange !== false) {
this._onChange.forEach(
(changeFn) => changeFn(this.value, options.emitViewToModelChange !== false));
}
this.updateValueAndValidity(options);
}
}): void;

/**
* Patches the value of a control.
Expand All @@ -1314,14 +1277,12 @@ export class FormControl extends AbstractControl {
*
* @see `setValue` for options
*/
override patchValue(value: any, options: {
patchValue(value: any, options?: {
onlySelf?: boolean,
emitEvent?: boolean,
emitModelToViewChange?: boolean,
emitViewToModelChange?: boolean
} = {}): void {
this.setValue(value, options);
}
}): void;

/**
* Resets the form control, marking it `pristine` and `untouched`, and setting
Expand All @@ -1341,6 +1302,141 @@ export class FormControl extends AbstractControl {
* When false, no events are emitted.
*
*/
reset(formState?: any, options?: {onlySelf?: boolean, emitEvent?: boolean}): void;

/**
* @internal
*/
_updateValue(): void;

/**
* @internal
*/
_anyControls(condition: Function): boolean;

/**
* @internal
*/
_allControlsDisabled(): boolean;

/**
* Register a listener for change events.
*
* @param fn The method that is called when the value changes
*/
registerOnChange(fn: Function): void;

/**
* Internal function to unregister a change events listener.
* @internal
*/
_unregisterOnChange(fn: Function): void;

/**
* Register a listener for disabled events.
*
* @param fn The method that is called when the disabled status changes.
*/
registerOnDisabledChange(fn: (isDisabled: boolean) => void): void;

/**
* Internal function to unregister a disabled event listener.
* @internal
*/
_unregisterOnDisabledChange(fn: (isDisabled: boolean) => void): void;

/**
* @internal
*/
_forEachChild(cb: Function): void;

/** @internal */
_syncPendingControls(): boolean;
}

/**
* Various available constructors for `FormControl`.
*
* ```
* let fc = new FormControl('foo');
* ```
*
* {@link FormControl}
* @publicApi
*/
export declare interface FormControlCtor {
/**
* Construct a FormControl with no initial value or validators.
*/
new(): FormControl;

/**
* Creates a new `FormControl` instance.
*
* @param formState Initializes the control with an initial value,
* or an object that defines the initial value and disabled state.
*
* @param validatorOrOpts A synchronous validator function, or an array of
* such functions, or an `AbstractControlOptions` object that contains validation functions
* and a validation trigger.
*
* @param asyncValidator A single async validator or array of async validator functions
*/
new(value: any, validatorOrOpts?: ValidatorFn|ValidatorFn[]|AbstractControlOptions|null,
asyncValidator?: AsyncValidatorFn|AsyncValidatorFn[]|null): FormControl;
}

export class FormControlImpl extends AbstractControl {
/** @internal */
_onChange: Function[] = [];

/** @internal */
_pendingValue: boolean = false;

/** @internal */
_pendingChange: boolean = false;

constructor(
formState: any = null,
validatorOrOpts?: ValidatorFn|ValidatorFn[]|AbstractControlOptions|null,
asyncValidator?: AsyncValidatorFn|AsyncValidatorFn[]|null) {
super(pickValidators(validatorOrOpts), pickAsyncValidators(asyncValidator, validatorOrOpts));
this._applyFormState(formState);
this._setUpdateStrategy(validatorOrOpts);
this._initObservables();
this.updateValueAndValidity({
onlySelf: true,
// If `asyncValidator` is present, it will trigger control status change from `PENDING` to
// `VALID` or `INVALID`.
// The status should be broadcasted via the `statusChanges` observable, so we set `emitEvent`
// to `true` to allow that during the control creation process.
emitEvent: !!this.asyncValidator
});
}

override setValue(value: any, options: {
onlySelf?: boolean,
emitEvent?: boolean,
emitModelToViewChange?: boolean,
emitViewToModelChange?: boolean
} = {}): void {
(this as {value: any}).value = this._pendingValue = value;
if (this._onChange.length && options.emitModelToViewChange !== false) {
this._onChange.forEach(
(changeFn) => changeFn(this.value, options.emitViewToModelChange !== false));
}
this.updateValueAndValidity(options);
}

override patchValue(value: any, options: {
onlySelf?: boolean,
emitEvent?: boolean,
emitModelToViewChange?: boolean,
emitViewToModelChange?: boolean
} = {}): void {
this.setValue(value, options);
}

override reset(formState: any = null, options: {onlySelf?: boolean, emitEvent?: boolean} = {}):
void {
this._applyFormState(formState);
Expand Down Expand Up @@ -1369,11 +1465,6 @@ export class FormControl extends AbstractControl {
return this.disabled;
}

/**
* Register a listener for change events.
*
* @param fn The method that is called when the value changes
*/
registerOnChange(fn: Function): void {
this._onChange.push(fn);
}
Expand All @@ -1386,11 +1477,6 @@ export class FormControl extends AbstractControl {
removeListItem(this._onChange, fn);
}

/**
* Register a listener for disabled events.
*
* @param fn The method that is called when the disabled status changes.
*/
registerOnDisabledChange(fn: (isDisabled: boolean) => void): void {
this._onDisabledChange.push(fn);
}
Expand Down Expand Up @@ -1432,6 +1518,10 @@ export class FormControl extends AbstractControl {
}
}

// The constructor for FormControl is decoupled from its implementation.
// This allows us to provide multiple constructor signatures.
export const FormControl: FormControlCtor = FormControlImpl as FormControlCtor;

/**
* Tracks the value and validity state of a group of `FormControl` instances.
*
Expand Down
21 changes: 20 additions & 1 deletion packages/forms/test/form_control_spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

import {fakeAsync, tick} from '@angular/core/testing';
import {FormControl, FormGroup, Validators} from '@angular/forms';

import {FormArray} from '@angular/forms/src/model';

import {asyncValidator, asyncValidatorReturningObservable} from './util';

(function() {
Expand Down Expand Up @@ -1469,5 +1469,24 @@ describe('FormControl', () => {
});
});
});

describe('can be extended', () => {
// We don't technically support extending Forms classes, but people do it anyway.
// We need to make sure that there is some way to extend them to avoid causing breakage.

class FCExt extends FormControl {
constructor(formState?: any|{
value?: any;
disabled?: boolean;
}, ...args: any) {
super(formState, ...args);
}
}

it('should perform basic FormControl operations', () => {
const nc = new FCExt({value: 'foo'});
nc.setValue('bar');
});
});
});
})();

0 comments on commit cdf50ff

Please sign in to comment.