forked from angular/angular
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathchange_detection_scheduler_spec.ts
956 lines (844 loc) · 30 KB
/
change_detection_scheduler_spec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import {AsyncPipe} from '@angular/common';
import {PLATFORM_BROWSER_ID} from '@angular/common/src/platform_id';
import {
afterNextRender,
afterRender,
ApplicationRef,
ChangeDetectorRef,
Component,
createComponent,
destroyPlatform,
ElementRef,
EnvironmentInjector,
ErrorHandler,
EventEmitter,
inject,
Input,
NgZone,
Output,
PLATFORM_ID,
provideExperimentalZonelessChangeDetection as provideZonelessChangeDetection,
provideZoneChangeDetection,
signal,
TemplateRef,
Type,
ViewChild,
ViewContainerRef,
} from '@angular/core';
import {toSignal} from '@angular/core/rxjs-interop';
import {
ComponentFixture,
ComponentFixtureAutoDetect,
TestBed,
fakeAsync,
flush,
tick,
} from '@angular/core/testing';
import {bootstrapApplication} from '@angular/platform-browser';
import {withBody} from '@angular/private/testing';
import {BehaviorSubject, firstValueFrom} from 'rxjs';
import {filter, take, tap} from 'rxjs/operators';
import {RuntimeError, RuntimeErrorCode} from '../src/errors';
import {scheduleCallbackWithRafRace} from '../src/util/callback_scheduler';
import {ChangeDetectionSchedulerImpl} from '../src/change_detection/scheduling/zoneless_scheduling_impl';
import {global} from '../src/util/global';
function isStable(injector = TestBed.inject(EnvironmentInjector)): boolean {
return toSignal(injector.get(ApplicationRef).isStable, {requireSync: true, injector})();
}
describe('Angular with zoneless enabled', () => {
async function createFixture<T>(type: Type<T>): Promise<ComponentFixture<T>> {
const fixture = TestBed.createComponent(type);
await fixture.whenStable();
return fixture;
}
beforeEach(() => {
TestBed.configureTestingModule({
providers: [
provideZonelessChangeDetection(),
{provide: PLATFORM_ID, useValue: PLATFORM_BROWSER_ID},
],
});
});
describe('notifies scheduler', () => {
it('contributes to application stableness', async () => {
const val = signal('initial');
@Component({template: '{{val()}}', standalone: true})
class TestComponent {
val = val;
}
const fixture = await createFixture(TestComponent);
// Cause another pending CD immediately after render and verify app has not stabilized
await fixture.whenStable().then(() => {
val.set('new');
});
expect(fixture.isStable()).toBeFalse();
await fixture.whenStable();
expect(fixture.isStable()).toBeTrue();
});
it('when signal updates', async () => {
const val = signal('initial');
@Component({template: '{{val()}}', standalone: true})
class TestComponent {
val = val;
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
val.set('new');
expect(fixture.isStable()).toBeFalse();
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('when using markForCheck()', async () => {
@Component({template: '{{val}}', standalone: true})
class TestComponent {
cdr = inject(ChangeDetectorRef);
val = 'initial';
setVal(val: string) {
this.val = val;
this.cdr.markForCheck();
}
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
fixture.componentInstance.setVal('new');
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('on input binding', async () => {
@Component({template: '{{val}}', standalone: true})
class TestComponent {
@Input() val = 'initial';
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
fixture.componentRef.setInput('val', 'new');
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('on event listener bound in template', async () => {
@Component({template: '<div (click)="updateVal()">{{val}}</div>', standalone: true})
class TestComponent {
val = 'initial';
updateVal() {
this.val = 'new';
}
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
fixture.debugElement
.query((p) => p.nativeElement.tagName === 'DIV')
.triggerEventHandler('click');
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('on event listener bound in host', async () => {
@Component({host: {'(click)': 'updateVal()'}, template: '{{val}}', standalone: true})
class TestComponent {
val = 'initial';
updateVal() {
this.val = 'new';
}
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
fixture.debugElement.triggerEventHandler('click');
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('with async pipe', async () => {
@Component({template: '{{val | async}}', standalone: true, imports: [AsyncPipe]})
class TestComponent {
val = new BehaviorSubject('initial');
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
fixture.componentInstance.val.next('new');
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('when creating a view', async () => {
@Component({
template: '<ng-template #ref>{{"binding"}}</ng-template>',
standalone: true,
})
class TestComponent {
@ViewChild(TemplateRef) template!: TemplateRef<unknown>;
@ViewChild('ref', {read: ViewContainerRef}) viewContainer!: ViewContainerRef;
createView(): any {
this.viewContainer.createEmbeddedView(this.template);
}
}
const fixture = await createFixture(TestComponent);
fixture.componentInstance.createView();
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('binding');
});
it('when inserting a view', async () => {
@Component({
template: '{{"binding"}}',
standalone: true,
})
class DynamicCmp {
elementRef = inject(ElementRef);
}
@Component({
template: '<ng-template #ref></ng-template>',
standalone: true,
})
class TestComponent {
@ViewChild('ref', {read: ViewContainerRef}) viewContainer!: ViewContainerRef;
}
const fixture = await createFixture(TestComponent);
const otherComponent = createComponent(DynamicCmp, {
environmentInjector: TestBed.inject(EnvironmentInjector),
});
fixture.componentInstance.viewContainer.insert(otherComponent.hostView);
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('binding');
});
it('when destroying a view (with animations)', async () => {
@Component({
template: '{{"binding"}}',
standalone: true,
})
class DynamicCmp {
elementRef = inject(ElementRef);
}
@Component({
template: '<ng-template #ref></ng-template>',
standalone: true,
})
class TestComponent {
@ViewChild('ref', {read: ViewContainerRef}) viewContainer!: ViewContainerRef;
}
const fixture = await createFixture(TestComponent);
const component = createComponent(DynamicCmp, {
environmentInjector: TestBed.inject(EnvironmentInjector),
});
fixture.componentInstance.viewContainer.insert(component.hostView);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('binding');
fixture.componentInstance.viewContainer.remove();
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('');
const component2 = createComponent(DynamicCmp, {
environmentInjector: TestBed.inject(EnvironmentInjector),
});
fixture.componentInstance.viewContainer.insert(component2.hostView);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('binding');
component2.destroy();
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('');
});
function whenStable(): Promise<void> {
return TestBed.inject(ApplicationRef).whenStable();
}
it(
'when destroying a view (*no* animations)',
withBody('<app></app>', async () => {
destroyPlatform();
let doCheckCount = 0;
let renderHookCalls = 0;
@Component({
template: '{{"binding"}}',
standalone: true,
})
class DynamicCmp {
elementRef = inject(ElementRef);
}
@Component({
selector: 'app',
template: '<ng-template #ref></ng-template>',
standalone: true,
})
class App {
@ViewChild('ref', {read: ViewContainerRef}) viewContainer!: ViewContainerRef;
unused = afterRender(() => {
renderHookCalls++;
});
ngDoCheck() {
doCheckCount++;
}
}
const applicationRef = await bootstrapApplication(App, {
providers: [
provideZonelessChangeDetection(),
{provide: PLATFORM_ID, useValue: PLATFORM_BROWSER_ID},
],
});
const appViewRef = (applicationRef as any)._views[0] as {context: App; rootNodes: any[]};
await applicationRef.whenStable();
const component2 = createComponent(DynamicCmp, {
environmentInjector: applicationRef.injector,
});
appViewRef.context.viewContainer.insert(component2.hostView);
expect(isStable(applicationRef.injector)).toBe(false);
await applicationRef.whenStable();
component2.destroy();
// destroying the view synchronously removes element from DOM when not using animations
expect(appViewRef.rootNodes[0].innerText).toEqual('');
// Destroying the view notifies scheduler because render hooks need to run
expect(isStable(applicationRef.injector)).toBe(false);
let checkCountBeforeStable = doCheckCount;
let renderCountBeforeStable = renderHookCalls;
await applicationRef.whenStable();
// The view should not have refreshed
expect(doCheckCount).toEqual(checkCountBeforeStable);
// but render hooks should have run
expect(renderHookCalls).toEqual(renderCountBeforeStable + 1);
destroyPlatform();
}),
);
it('when attaching view to ApplicationRef', async () => {
@Component({
selector: 'dynamic-cmp',
template: '{{"binding"}}',
standalone: true,
})
class DynamicCmp {
elementRef = inject(ElementRef);
}
const environmentInjector = TestBed.inject(EnvironmentInjector);
const appRef = TestBed.inject(ApplicationRef);
const component = createComponent(DynamicCmp, {environmentInjector});
const host = document.createElement('div');
host.appendChild(component.instance.elementRef.nativeElement);
expect(host.innerHTML).toEqual('<dynamic-cmp></dynamic-cmp>');
appRef.attachView(component.hostView);
await whenStable();
expect(host.innerHTML).toEqual('<dynamic-cmp>binding</dynamic-cmp>');
const component2 = createComponent(DynamicCmp, {environmentInjector});
// TODO(atscott): Only needed because renderFactory will not run if ApplicationRef has no
// views. This should likely be fixed in ApplicationRef
appRef.attachView(component2.hostView);
appRef.detachView(component.hostView);
// DOM is not synchronously removed because change detection hasn't run
expect(host.innerHTML).toEqual('<dynamic-cmp>binding</dynamic-cmp>');
expect(isStable()).toBe(false);
await whenStable();
expect(host.innerHTML).toEqual('');
host.appendChild(component.instance.elementRef.nativeElement);
// reattaching non-dirty view notifies scheduler because afterRender hooks must run
appRef.attachView(component.hostView);
expect(isStable()).toBe(false);
});
it('when a stable subscription synchronously causes another notification', async () => {
const val = signal('initial');
@Component({template: '{{val()}}', standalone: true})
class TestComponent {
val = val;
}
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
val.set('new');
await TestBed.inject(ApplicationRef)
.isStable.pipe(
filter((stable) => stable),
take(1),
tap(() => val.set('newer')),
)
.toPromise();
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('newer');
});
it('executes render hooks when a new one is registered', async () => {
let resolveFn: Function;
let calledPromise = new Promise((resolve) => {
resolveFn = resolve;
});
TestBed.runInInjectionContext(() => {
afterNextRender(() => {
resolveFn();
});
});
await expectAsync(calledPromise).toBeResolved();
});
it('executes render hooks without refreshing CheckAlways views', async () => {
let checks = 0;
@Component({
template: '',
standalone: true,
})
class Dummy {
ngDoCheck() {
checks++;
}
}
const fixture = TestBed.createComponent(Dummy);
await fixture.whenStable();
expect(checks).toBe(1);
let resolveFn: Function;
let calledPromise = new Promise((resolve) => {
resolveFn = resolve;
});
TestBed.runInInjectionContext(() => {
afterNextRender(() => {
resolveFn();
});
});
await expectAsync(calledPromise).toBeResolved();
// render hooks was called but component was not refreshed
expect(checks).toBe(1);
});
});
it('can recover when an error is re-thrown by the ErrorHandler', async () => {
const val = signal('initial');
let throwError = false;
@Component({template: '{{val()}}{{maybeThrow()}}', standalone: true})
class TestComponent {
val = val;
maybeThrow() {
if (throwError) {
throw new Error('e');
} else {
return '';
}
}
}
TestBed.configureTestingModule({
providers: [
{
provide: ErrorHandler,
useClass: class extends ErrorHandler {
override handleError(error: any): void {
throw error;
}
},
},
],
});
const fixture = await createFixture(TestComponent);
expect(fixture.nativeElement.innerText).toEqual('initial');
val.set('new');
throwError = true;
// error is thrown in a timeout and can't really be "caught".
// Still need to wrap in expect so it happens in the expect context and doesn't fail the test.
expect(async () => await fixture.whenStable()).not.toThrow();
expect(fixture.nativeElement.innerText).toEqual('initial');
throwError = false;
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toEqual('new');
});
it('change detects embedded view when attached to a host on ApplicationRef and declaration is marked for check', async () => {
@Component({
template: '<ng-template #template><div>{{thing}}</div></ng-template>',
standalone: true,
})
class DynamicCmp {
@ViewChild('template') templateRef!: TemplateRef<{}>;
thing = 'initial';
}
@Component({
template: '',
standalone: true,
})
class Host {
readonly vcr = inject(ViewContainerRef);
}
const fixture = TestBed.createComponent(DynamicCmp);
const host = createComponent(Host, {environmentInjector: TestBed.inject(EnvironmentInjector)});
TestBed.inject(ApplicationRef).attachView(host.hostView);
await fixture.whenStable();
const embeddedViewRef = fixture.componentInstance.templateRef.createEmbeddedView({});
host.instance.vcr.insert(embeddedViewRef);
await fixture.whenStable();
expect(embeddedViewRef.rootNodes[0].innerHTML).toContain('initial');
fixture.componentInstance.thing = 'new';
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
expect(embeddedViewRef.rootNodes[0].innerHTML).toContain('new');
});
it('change detects embedded view when attached directly to ApplicationRef and declaration is marked for check', async () => {
@Component({
template: '<ng-template #template><div>{{thing}}</div></ng-template>',
standalone: true,
})
class DynamicCmp {
@ViewChild('template') templateRef!: TemplateRef<{}>;
thing = 'initial';
}
const fixture = TestBed.createComponent(DynamicCmp);
await fixture.whenStable();
const embeddedViewRef = fixture.componentInstance.templateRef.createEmbeddedView({});
TestBed.inject(ApplicationRef).attachView(embeddedViewRef);
await fixture.whenStable();
expect(embeddedViewRef.rootNodes[0].innerHTML).toContain('initial');
fixture.componentInstance.thing = 'new';
fixture.changeDetectorRef.markForCheck();
await fixture.whenStable();
expect(embeddedViewRef.rootNodes[0].innerHTML).toContain('new');
});
it('does not fail when global timing functions are patched and unpatched', async () => {
@Component({template: '', standalone: true})
class App {
cdr = inject(ChangeDetectorRef);
}
let patched = false;
const originalSetTimeout = global.setTimeout;
global.setTimeout = (handler: any) => {
if (!patched) {
throw new Error('no longer patched');
}
originalSetTimeout(handler);
};
patched = true;
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
global.setTimeout = originalSetTimeout;
patched = false;
expect(() => {
// cause another scheduler notification. This should not fail due to `setTimeout` being
// unpatched.
fixture.componentInstance.cdr.markForCheck();
}).not.toThrow();
await fixture.whenStable();
});
it('should not run change detection twice if manual tick called when CD was scheduled', async () => {
let changeDetectionRuns = 0;
TestBed.runInInjectionContext(() => {
afterRender(() => {
changeDetectionRuns++;
});
});
@Component({template: '', standalone: true})
class MyComponent {
cdr = inject(ChangeDetectorRef);
}
const fixture = TestBed.createComponent(MyComponent);
await fixture.whenStable();
expect(changeDetectionRuns).toEqual(1);
// notify the scheduler
fixture.componentInstance.cdr.markForCheck();
// call tick manually
TestBed.inject(ApplicationRef).tick();
await fixture.whenStable();
// ensure we only ran render hook 1 more time rather than once for tick and once for the
// scheduled run
expect(changeDetectionRuns).toEqual(2);
});
it('coalesces microtasks that happen during change detection into a single paint', async () => {
if (!isBrowser) {
return;
}
@Component({
template: '{{thing}}',
standalone: true,
})
class App {
thing = 'initial';
cdr = inject(ChangeDetectorRef);
ngAfterViewInit() {
queueMicrotask(() => {
this.thing = 'new';
this.cdr.markForCheck();
});
}
}
const fixture = TestBed.createComponent(App);
await new Promise<void>((resolve) => scheduleCallbackWithRafRace(resolve));
expect(fixture.nativeElement.innerText).toContain('new');
});
it('throws a nice error when notifications prevent exiting the event loop (infinite CD)', async () => {
let caughtError: unknown;
let previousHandle = (Zone.root as any)._zoneDelegate.handleError;
(Zone.root as any)._zoneDelegate.handleError = (zone: ZoneSpec, e: unknown) => {
caughtError = e;
};
@Component({
template: '',
standalone: true,
})
class App {
cdr = inject(ChangeDetectorRef);
ngDoCheck() {
queueMicrotask(() => {
this.cdr.markForCheck();
});
}
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(caughtError).toBeInstanceOf(RuntimeError);
const runtimeError = caughtError as RuntimeError;
expect(runtimeError.code).toEqual(RuntimeErrorCode.INFINITE_CHANGE_DETECTION);
expect(runtimeError.message).toContain('markForCheck');
expect(runtimeError.message).toContain('notify');
(Zone.root as any)._zoneDelegate.handleError = previousHandle;
});
it('runs inside fakeAsync zone', fakeAsync(() => {
let didRun = false;
@Component({standalone: true, template: ''})
class App {
ngOnInit() {
didRun = true;
}
}
TestBed.createComponent(App);
expect(didRun).toBe(false);
tick();
expect(didRun).toBe(true);
didRun = false;
TestBed.createComponent(App);
expect(didRun).toBe(false);
flush();
expect(didRun).toBe(true);
}));
it('can run inside fakeAsync zone', fakeAsync(() => {
let didRun = false;
@Component({standalone: true, template: ''})
class App {
ngDoCheck() {
didRun = true;
}
}
// create component runs inside the zone and triggers CD as a result
const fixture = TestBed.createComponent(App);
didRun = false;
// schedules change detection
fixture.debugElement.injector.get(ChangeDetectorRef).markForCheck();
expect(didRun).toBe(false);
tick();
expect(didRun).toBe(true);
}));
});
describe('Angular with scheduler and ZoneJS', () => {
beforeEach(() => {
TestBed.configureTestingModule({
providers: [
{provide: ComponentFixtureAutoDetect, useValue: true},
{provide: PLATFORM_ID, useValue: PLATFORM_BROWSER_ID},
],
});
});
it('requires updates inside Angular zone when using ngZoneOnly', async () => {
TestBed.configureTestingModule({
providers: [provideZoneChangeDetection({ignoreChangesOutsideZone: true})],
});
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
TestBed.inject(NgZone).runOutsideAngular(() => {
fixture.componentInstance.thing.set('new');
});
expect(fixture.isStable()).toBe(true);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
});
it('will not schedule change detection if listener callback is outside the zone', async () => {
let renders = 0;
TestBed.runInInjectionContext(() => {
afterRender(() => {
renders++;
});
});
@Component({selector: 'component-with-output', template: '', standalone: true})
class ComponentWithOutput {
@Output() out = new EventEmitter();
}
let called = false;
@Component({
standalone: true,
imports: [ComponentWithOutput],
template: '<component-with-output (out)="onOut()" />',
})
class App {
onOut() {
called = true;
}
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
const outComponent = fixture.debugElement.query(
(debugNode) => debugNode.providerTokens!.indexOf(ComponentWithOutput) !== -1,
).componentInstance as ComponentWithOutput;
TestBed.inject(NgZone).runOutsideAngular(() => {
outComponent.out.emit();
});
await fixture.whenStable();
expect(renders).toBe(1);
expect(called).toBe(true);
expect(renders).toBe(1);
});
it('updating signal outside of zone still schedules update when in hybrid mode', async () => {
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
TestBed.inject(NgZone).runOutsideAngular(() => {
fixture.componentInstance.thing.set('new');
});
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('new');
});
it('updating signal in another "Angular" zone schedules update when in hybrid mode', async () => {
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
const differentAngularZone: NgZone = Zone.root.run(() => new NgZone({}));
differentAngularZone.run(() => {
fixture.componentInstance.thing.set('new');
});
expect(fixture.isStable()).toBe(false);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('new');
});
it('updating signal in a child zone of Angular does not schedule extra CD', async () => {
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
const childZone = TestBed.inject(NgZone).run(() => Zone.current.fork({name: 'child'}));
childZone.run(() => {
fixture.componentInstance.thing.set('new');
expect(TestBed.inject(ChangeDetectionSchedulerImpl)['cancelScheduledCallback']).toBeNull();
});
});
it('updating signal in a child Angular zone of Angular does not schedule extra CD', async () => {
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
expect(fixture.nativeElement.innerText).toContain('initial');
const childAngularZone = TestBed.inject(NgZone).run(() => new NgZone({}));
childAngularZone.run(() => {
fixture.componentInstance.thing.set('new');
expect(TestBed.inject(ChangeDetectionSchedulerImpl)['cancelScheduledCallback']).toBeNull();
});
});
it('should not run change detection twice if notified during AppRef.tick', async () => {
TestBed.configureTestingModule({
providers: [
provideZoneChangeDetection({ignoreChangesOutsideZone: false}),
{provide: PLATFORM_ID, useValue: PLATFORM_BROWSER_ID},
],
});
let changeDetectionRuns = 0;
TestBed.runInInjectionContext(() => {
afterRender(() => {
changeDetectionRuns++;
});
});
@Component({template: '', standalone: true})
class MyComponent {
cdr = inject(ChangeDetectorRef);
ngDoCheck() {
// notify scheduler every time this component is checked
this.cdr.markForCheck();
}
}
const fixture = TestBed.createComponent(MyComponent);
await fixture.whenStable();
expect(changeDetectionRuns).toEqual(1);
// call tick manually
TestBed.inject(ApplicationRef).tick();
await fixture.whenStable();
// ensure we only ran render hook 1 more time rather than once for tick and once for the
// scheduled run
expect(changeDetectionRuns).toEqual(2);
});
it('does not cause double change detection with run coalescing', async () => {
if (isNode) {
return;
}
TestBed.configureTestingModule({
providers: [
provideZoneChangeDetection({runCoalescing: true, ignoreChangesOutsideZone: false}),
],
});
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
let ticks = 0;
TestBed.runInInjectionContext(() => {
afterRender(() => {
ticks++;
});
});
fixture.componentInstance.thing.set('new');
await fixture.whenStable();
expect(ticks).toBe(1);
});
it('does not cause double change detection with run coalescing when both schedulers are notified', async () => {
if (isNode) {
return;
}
TestBed.configureTestingModule({
providers: [
provideZoneChangeDetection({runCoalescing: true, ignoreChangesOutsideZone: false}),
],
});
@Component({template: '{{thing()}}', standalone: true})
class App {
thing = signal('initial');
}
const fixture = TestBed.createComponent(App);
await fixture.whenStable();
let ticks = 0;
TestBed.runInInjectionContext(() => {
afterRender(() => {
ticks++;
});
});
// notifies the zoneless scheduler
fixture.componentInstance.thing.set('new');
// notifies the zone scheduler
TestBed.inject(NgZone).run(() => {});
await fixture.whenStable();
expect(ticks).toBe(1);
});
it('can run inside fakeAsync zone', fakeAsync(() => {
TestBed.configureTestingModule({
providers: [provideZoneChangeDetection({scheduleInRootZone: false} as any)],
});
let didRun = false;
@Component({standalone: true, template: ''})
class App {
ngDoCheck() {
didRun = true;
}
}
// create component runs inside the zone and triggers CD as a result
const fixture = TestBed.createComponent(App);
didRun = false;
// schedules change detection
fixture.debugElement.injector.get(ChangeDetectorRef).markForCheck();
expect(didRun).toBe(false);
tick();
expect(didRun).toBe(true);
}));
});