Search code examples
angularunit-testingpromiseangular-componentsangular-unit-test

ngOnChanges not called in Angular 4 unit test detectChanges()


The question

I have a button component that accepts a promise and disables the button until the promise has resolved and I want to write a unit test for this functionality.

My Code

My button component has an input for the promise

  /**
   * A single promise that triggers the busy state until it resolves
   */
  @Input()
  public promise: Promise<any>;

Inside ngOnChanges I listen for the promise

/**
 * Enable button busy state until promise resolves
 */
if (changes && changes.promise && changes.promise.currentValue) {
  this.busyUntilPromiseResolves(changes.promise.currentValue);
}

Then I store an array of active promises so multiple promises can be passed in

  /**
   * Add a promise that will keep the button in a busy state until it resolves
   * @param activityProimise
   */
  private busyUntilPromiseResolves(activityProimise) {
    this.activityPromises.push(activityProimise);
    activityProimise.then(() => {
      this.activityPromises.splice(this.activityPromises.indexOf(activityProimise), 1);
    });
  }

Then finally in my template I disable the button if there are any promises in the array.

[disabled]="activityPromises.length > 0"

Help me obi-wan

I have been dabbling and trying different things to make this work, this is my current test code that doesn't work. Basically I need to check that the button is disabled before the promise resolves, and I will then want to do another test that checks it is re-enabled after the promise resolves.

  it('should be disabled when passed a single promise', async((done) => {
    let promise;

    return promise = new Promise(resolve => {
      component.promise = promise;
      fixture.detectChanges();
      expect(buttonElement.disabled).toBe(true);
      return resolve();
    });
  }));

As always any help will be appreciated, thanks.


Solution

  • The short answer to this question is that ngOnChanges doesn't get fired automatically during unit tests so I had to call it manually.

    it('should be disabled when passed a single promise', async () => {
        let promise;
        let resolve;
    
        // should not be disabled here
        expect(buttonElement.disabled).toBe(false);
    
        // Pass a promise to the component to disable it
        promise = new Promise((r) => (resolve = r));
        component.ngOnChanges({
            promise: new SimpleChange(null, promise, null),
        });
    
        fixture.detectChanges();
        expect(buttonElement.disabled).toBe(true);
    
        // now resolve the promise and make sure it's enabled again.
        promise.then(() => {
            fixture.detectChanges();
            expect(buttonElement.disabled).toBe(false);
        });
    
        resolve();
    });