Angular 6 View is not updated after changing a variable within subscribe

Question

Why is the view not being updated when a variable changes within a subscribe?

I have this code:

example.component.ts

testVariable: string;

ngOnInit() {
    this.testVariable = 'foo';

    this.someService.someObservable.subscribe(
        () => console.log('success'),
        (error) => console.log('error', error),
        () => {
            this.testVariable += '-bar';

            console.log('completed', this.testVariable);
            // prints: foo-Hello-bar
        }
    );

    this.testVariable += '-Hello';
}

example.component.html

{{testVariable}}

But the view displays: foo-Hello.

Why won't it display: foo-Hello-bar?

If I call ChangeDetectorRef.detectChanges() within the subscribe it will display the proper value, but why do I have to do this?

I shouldn't be calling this method from every subscribe, or, at all (angular should handle this). Is there a right way?

Did I miss something in the update from Angular/rxjs 5 to 6?

Right now I have Angular version 6.0.2 and rxjs 6.0.0. The same code works ok in Angular 5.2 and rxjs 5.5.10 without the need of calling detectChanges.

Solution 1

As far as I know, Angular is only updating the view, if you change data in the "Angular zone". The asynchronous call in your example does not qualify for this. But if you want, you can put it in the Angular zone or use rxjs or extract part of the code to a new component to solve this problem. I will explain all:

EDIT: It seems like not all solutions are working anymore. For most users the first Solution "Angular Zone" does the job.

1 Angular Zone

The most common use of this service is to optimize performance when starting a work consisting of one or more asynchronous tasks that don't require UI updates or error handling to be handled by Angular. Such tasks can be kicked off via runOutsideAngular and if needed, these tasks can reenter the Angular zone via run. https://angular.io/api/core/NgZone

The key part is the "run" function. You could inject NgZone and put your value update in the run callback of the NgZone object:

constructor(private ngZone: NgZone ) { }
testVariable: string;

ngOnInit() {
   this.testVariable = 'foo';

   this.someService.someObservable.subscribe(
      () => console.log('success'),
      (error) => console.log('error', error),
      () => {
      this.ngZone.run( () => {
         this.testVariable += '-bar';
      });
      }
   );
}

According to this answer, it would cause the whole application to detect changes, whereas your ChangeDetectorRef.detectChanges approach would only detect changes in your component and it's descendants.

2 RxJS

Another way would be to use rxjs to update the view. When you first subscribe to a ReplaySubject, it will give you the latest value. A BehaviorSubject is basically the same, but allows you to define a default value (makes sense in your example, but does not necessary be the right choice all the time). After this initial emission is it basically a normal Replay Subject:

this.testVariable = 'foo';
testEmitter$ = new BehaviorSubject<string>(this.testVariable);


ngOnInit() {

   this.someService.someObservable.subscribe(
      () => console.log('success'),
      (error) => console.log('error', error),
      () => {
         this.testVariable += '-bar';
         this.testEmitter.next(this.testVariable);
      }
   );
}

In your view, you could subscribe to the Subject using the async pipe:

{{testEmitter$ | async}}

3 Extract code to new Component

If you submit the string to another component, it will also be updated. You would have to use the @Input() selector in the new component.

So the new component has code like this:

@Input() testVariable = '';

And the testVariable is assigned in the HTML like before with curly brakets.

In the parent HTML View you can then pass the variable of the parentelement to the child element:

<app-child [testVariable]="testVariable"></app-child>

This way you are in the Angular zone.

4 Personal preference

My personal preference is to use the rxjs or the component way. Using detectChanges oder NGZone feels more hacky to me.

Solution 2

For me none of the above worked. However, ChangeDetectorRef did the trick.

From angular docs; this is how you can implement it

    class GiantList {
      constructor(private ref: ChangeDetectorRef, public dataProvider: DataListProvider) {
        ref.detach();
        setInterval(() => { this.ref.detectChanges(); }, 5000);
      }
    }

https://angular.io/api/core/ChangeDetectorRef

Solution 3

Important notice - Short way in subjects can makes problem!

I know it's not exactly what the PO asked, but there is sometimes very common problem that can happen, and maybe it will be helpful for someone.

It's very simple, and also I didn't inspect the issue deeply.

But in my case the problem was that I have used in short syntax for subscribe the subject to observable instead of full, and when I have changed it, it solved the issue.

So While this didn't work :

myServiceObservableCall.subscribe(this.myBehavSubj)

and with the same behavior that on log I am seeing the changes properly, only on the view not.

This does update the view :

myServiceObservableCall.subscribe((res)=>{
        this.myBehavSubj.next(res);
      } );

Although it's seems to be the same and the above only short-way syntax .

You are invited to explain the reason

Solution 4

The way I found that works best is to just wrap the variable assignment in a setTimeout() function. Angular's NgZone change detection checks for changes anytime a setTimeout() function is called. Example using the code in the question:

ngOnInit() {
    this.testVariable = 'foo';

    this.someService.someObservable.subscribe(
        () => console.log('success'),
        (error) => console.log('error', error),
        () => {
            setTimeout(() => { this.testVariable += '-bar'; }, 0); // Here's the line

            console.log('completed', this.testVariable);
            // prints: foo-Hello-bar
        }
    );

    this.testVariable += '-Hello';
}

View more solutions

Comments

[George C.]

Thanks, in my case the this.ngZone.run only worked

[besserwisser]

Interesting. Angular seems to change the behaviour a little bit form version to version. It can be quite a headache sometimes. At least you found your solution. I am happy it helped.

[BornToCode]

I also tried the RxJS example you provided and it doesn't work like @GeorgeC. wrote, I suggest that you update your answer that this may work only on some versions of behaviour, but not with the latest.

[George C.]

@BornToCode if you want to update an array you can try the spead operator: for more info look here developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/… else try to play wit this code this.ngZone.run( () => { this.testVariable += '-bar'; });

[AngularDoubts]

ngZone.run worked in my case while rxjs unfortunately didn't.

[Rishabh Gusain]

seriously user will have to wait at least 5 seconds to see the changes?

[Dalorzo]

@RishabhGusain ha ha ha. The 5seconds are simulating an async call like a REST Service. Feel free not to include this in your code. Of course, it is not necessary.

[kushal Baldev]

great I did with Rxjs in latest version!!

[andressh11]

What the actual F*UK !?? IT WORKED for me.

[andressh11]

the long way, but it worked for 2 mins and then didn't. I have this issue for 1 week now and can't find a solution

[lingar]

@andressh11 share your code in other question the community will try to help. Send me a link when you did it.