angular2 async form validation

Question

I am trying to accomplish a piece of a form validation with Angular2.

I am trying to find out, via an asynchronous call, if a username has already been taken and used in my database.

Here is my code so far:

FORM COMPONENT:

import {Component, OnInit} from 'angular2/core';
import {FORM_PROVIDERS, Control, ControlGroup, FormBuilder, Validators} from 'angular2/common';
import {Http, Headers, RequestOptions} from 'angular2/http';
import {ROUTER_DIRECTIVES, Router, RouteParams} from 'angular2/router';
import {ControlMessages} from './control.messages';
import {ValidationService} from './validation.service';

@Component({
    selector: 'account-form',
    templateUrl: './app/account/account.form.component.html',
    providers: [ROUTER_DIRECTIVES, CaseDataService],
    directives: [ControlMessages]
})

accountForm: ControlGroup;

constructor(private _accountService: AccountDataService,
    private _formBuilder: FormBuilder, private _router: Router, private _params?: RouteParams) {
    this.model = this._accountService.getUser();

    this.accountForm = this._formBuilder.group({
        'firstName': ['', Validators.required],
        'lastName': ['', Validators.required],
        'userName': ['', Validators.compose([ValidationService.userNameValidator, ValidationService.userNameIsTaken])],

....
}

VALIDATION SERVICE:

export class ValidationService {


static getValidatorErrorMessage(code: string) {
    let config = {
        'required': 'Required',
        'invalidEmailAddress': 'Invalid email address',
        'invalidPassword': 'Invalid password. Password must be at least 6 characters long, and contain a number.',
        'mismatchedPasswords': 'Passwords do not match.',
        'startsWithNumber': 'Username cannot start with a number.'
    };
    return config[code];
}

static userNameValidator(control, service, Headers) {
    // Username cannot start with a number
    if (!control.value.match(/^(?:[0-9])/)) {
        return null;
    } else {
        return { 'startsWithNumber': true };
    }
}
  // NEEDS TO BE AN ASYNC CALL TO DATABASE to check if userName exists. 
// COULD userNameIsTaken be combined with userNameValidator??

static userNameIsTaken(control: Control) {
    return new Promise(resolve => {
        let headers = new Headers();
        headers.append('Content-Type', 'application/json')

        // needs to call api route - _http will be my data service. How to include that?

        this._http.get('ROUTE GOES HERE', { headers: headers })
            .map(res => res.json())
            .subscribe(data => {
                console.log(data);
                if (data.userName == true) {
                    resolve({ taken: true })
                }
                else { resolve({ taken: false }); }
            })
    });
}
}

NEW CODE (UPDATED x2). ControlGroup is returning undefined.

    this.form = this.accountForm;
    this.accountForm = this._formBuilder.group({
        'firstName': ['', Validators.required],
        'lastName': ['', Validators.required],
        'userName': ['', Validators.compose([Validators.required, this.accountValidationService.userNameValidator]), this.userNameIsTaken(this.form, 'userName')],
        'email': ['', Validators.compose([Validators.required, this.accountValidationService.emailValidator])],
        'password': ['', Validators.compose([Validators.required, this.accountValidationService.passwordValidator])],
        'confirm': ['', Validators.required]
    });         
};

userNameIsTaken(group: any, userName: string) {
    return new Promise(resolve => {

        this._accountService.read('/username/' + group.controls[userName].value)
            .subscribe(data => {
                data = data
                if (data) {
                    resolve({ taken: true })
                } else {
                    resolve(null);
                }
            });
    })
};

HTML:

<div class="input-group">
    <span class="input-group-label">Username</span>
    <input class="input-group-field" type="text" required [(ngModel)]="model.userName" ngControl="userName" #userName="ngForm">
    <control-messages control="userName"></control-messages>
    <div *ngIf="taken">Username is already in use.</div>
</div>

Thierry Templier · Accepted Answer · 2016-04-07 13:17:48Z

5

You should define your async validator this way:

'userName': ['', ValidationService.userNameValidator, 
       ValidationService.userNameIsTaken],

And not with the Validators.compose method. As a matter of fact, here is what parameters correspond to:

'<field-name>': [ '', syncValidators, asyncValidators ]

Moreover you should resolve with null when the user name isn't taken instead of `{taken: false}

if (data.userName == true) {
  resolve({ taken: true })
} else {
  resolve(null);
}

See this article for more details (section "Asynchronous validation for fields"):

http://restlet.com/blog/2016/02/17/implementing-angular2-forms-beyond-basics-part-2/

Edit

Perhaps my answer isn't clear enough. You still need to use Validators.compose but only when you have several synchronous validators:

this.accountForm = this._formBuilder.group({
    'firstName': ['', Validators.required],
    'lastName': ['', Validators.required],
    'userName': ['', Validators.compose([
             Validators.required,
             this.accountValidationService.userNameValidator
          ], this.userNameIsTaken],
    'email': ['', Validators.compose([
             Validators.required,
             this.accountValidationService.emailValidator
          ]],
    'password': ['', Validators.compose([
             Validators.required,
             this.accountValidationService.passwordValidator
          ]],
    'confirm': ['', Validators.required]
  });         
};

Edit1

You need to leverage the ngFormControl instead of the ngControl one because you define your controls using the FormBuilder class.

<div class="input-group">
  <span class="input-group-label">Username</span>
  <input class="input-group-field" type="text" required [(ngModel)]="model.userName" [ngControl]="accountForm.controls.userName" >
  <control-messages [control]="accountForm.controls.userName"></control-messages>
  <div *ngIf="accountForm.controls.userName.errors && accountForm.controls.userName.errors.taken">Username is already in use.</div>
</div>

See this article for more details:

http://restlet.com/blog/2016/02/11/implementing-angular2-forms-beyond-basics-part-1/

edited Apr 7, 2016 at 13:17

answered Apr 6, 2016 at 13:19

Thierry Templier

203k44 gold badges407 silver badges365 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

wjfieseler Over a year ago

Hi Thierry - Thank you. I've appended my code above, but still can't seem to get it to fire. :(

Thierry Templier Over a year ago

You're welcome! Yes there are still problems in your code. I updated my answer...

wjfieseler Over a year ago

Making progress. Here is the updated code, however, I can't seem to access the control group.

Thierry Templier Over a year ago

I udpated my answer. You should use ngFormControl instead of ngControl. What is control-messages? A custom component you implemented?

wjfieseler Over a year ago

Yes, control-messages is a custom component I have implemented. However, I'm trying to get the *ngIf to work first before I attempt to include the new validation int he control-messages.

|

Collectives™ on Stack Overflow

angular2 async form validation

1 Answer 1

7 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

7 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related