-
Notifications
You must be signed in to change notification settings - Fork 24.8k
/
defer_spec.ts
4154 lines (3497 loc) · 123 KB
/
defer_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
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @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.io/license
*/
import {ɵPLATFORM_BROWSER_ID as PLATFORM_BROWSER_ID} from '@angular/common';
import {ApplicationRef, Attribute, ChangeDetectionStrategy, ChangeDetectorRef, Component, ComponentRef, createComponent, DebugElement, Directive, EnvironmentInjector, ErrorHandler, getDebugNode, inject, Injectable, InjectionToken, Input, NgModule, NgZone, Pipe, PipeTransform, PLATFORM_ID, QueryList, Type, ViewChildren, ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR} from '@angular/core';
import {getComponentDef} from '@angular/core/src/render3/definition';
import {ComponentFixture, DeferBlockBehavior, fakeAsync, flush, TestBed, tick} from '@angular/core/testing';
/**
* Clears all associated directive defs from a given component class.
*
* This is a *hack* for TestBed, which compiles components in JIT mode
* and can not remove dependencies and their imports in the same way as AOT.
* From JIT perspective, all dependencies inside a defer block remain eager.
* We need to clear this association to run tests that verify loading and
* prefetching behavior.
*/
function clearDirectiveDefs(type: Type<unknown>): void {
const cmpDef = getComponentDef(type);
cmpDef!.dependencies = [];
cmpDef!.directiveDefs = null;
}
/**
* Emulates a dynamic import promise.
*
* Note: `setTimeout` is used to make `fixture.whenStable()` function
* wait for promise resolution, since `whenStable()` relies on the state
* of a macrotask queue.
*/
function dynamicImportOf<T>(type: T, timeout = 0): Promise<T> {
return new Promise<T>(resolve => {
setTimeout(() => resolve(type), timeout);
});
}
/**
* Emulates a failed dynamic import promise.
*/
function failedDynamicImport(): Promise<void> {
return new Promise((_, reject) => {
setTimeout(() => reject());
});
}
/**
* Helper function to await all pending dynamic imports
* emulated using `dynamicImportOf` function.
*/
function allPendingDynamicImports() {
return dynamicImportOf(null, 10);
}
/**
* Invoke a callback function after a specified amount of time (in ms).
*/
function timer(delay: number): Promise<void> {
return new Promise<void>((resolve) => {
setTimeout(() => resolve(), delay);
});
}
/**
* Allows to verify behavior of defer blocks by providing a set of
* [time, expected output] pairs. Also allows to provide a function
* instead of an expected output string, in which case the function
* is invoked at a specified time.
*/
async function verifyTimeline(
fixture: ComponentFixture<unknown>,
...slots: Array<[time: number, expected: string|VoidFunction]>) {
for (let i = 0; i < slots.length; i++) {
const timeToWait = i === 0 ? slots[0][0] : (slots[i][0] - slots[i - 1][0]);
const slotValue = slots[i][1];
// This is an action, just invoke a function.
if (typeof slotValue === 'function') {
slotValue();
}
tick(timeToWait);
fixture.detectChanges();
if (typeof slotValue === 'string') {
const actual = fixture.nativeElement.textContent.trim();
expect(actual).withContext(`${slots[i][0]}ms`).toBe(slotValue);
}
}
}
/**
* Given a template, creates a component fixture and returns
* a set of helper functions to trigger rendering of prefetching
* of a defer block.
*/
function createFixture(template: string) {
@Component({
selector: 'nested-cmp',
standalone: true,
template: '{{ block }}',
})
class NestedCmp {
@Input() block!: string;
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [NestedCmp],
template,
})
class MyCmp {
trigger = false;
prefetchTrigger = false;
}
let loadingTimeout = 0;
const deferDepsInterceptor = {
intercept() {
return () => {
return [dynamicImportOf(NestedCmp, loadingTimeout)];
};
}
};
TestBed.configureTestingModule({
providers: [
...COMMON_PROVIDERS,
{provide: ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR, useValue: deferDepsInterceptor},
],
});
clearDirectiveDefs(MyCmp);
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
const trigger = (loadingResourcesTime: number) => () => {
loadingTimeout = loadingResourcesTime;
fixture.componentInstance.trigger = true;
fixture.detectChanges();
};
const triggerPrefetch = (loadingResourcesTime: number) => () => {
loadingTimeout = loadingResourcesTime;
fixture.componentInstance.prefetchTrigger = true;
fixture.detectChanges();
};
return {trigger, triggerPrefetch, fixture};
}
// Set `PLATFORM_ID` to a browser platform value to trigger defer loading
// while running tests in Node.
const COMMON_PROVIDERS = [{provide: PLATFORM_ID, useValue: PLATFORM_BROWSER_ID}];
describe('@defer', () => {
beforeEach(() => {
TestBed.configureTestingModule({providers: COMMON_PROVIDERS});
});
it('should transition between placeholder, loading and loaded states', async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
template: 'Hi!',
})
class MyLazyCmp {
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp],
template: `
@defer (when isVisible) {
<my-lazy-cmp />
} @loading {
Loading...
} @placeholder {
Placeholder!
} @error {
Failed to load dependencies :(
}
`
})
class MyCmp {
isVisible = false;
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Placeholder');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Loading');
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>Hi!</my-lazy-cmp>');
});
it('should work when only main block is present', async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
template: 'Hi!',
})
class MyLazyCmp {
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp],
template: `
<p>Text outside of a defer block</p>
@defer (when isVisible) {
<my-lazy-cmp />
}
`
})
class MyCmp {
isVisible = false;
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Text outside of a defer block');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>Hi!</my-lazy-cmp>');
});
it('should be able to use pipes injecting ChangeDetectorRef in defer blocks', async () => {
@Pipe({name: 'test', standalone: true})
class TestPipe implements PipeTransform {
changeDetectorRef = inject(ChangeDetectorRef);
transform(value: any) {
return value;
}
}
@Component({
standalone: true,
imports: [TestPipe],
template: `@defer (when isVisible | test; prefetch when isVisible | test) {Hello}`
})
class MyCmp {
isVisible = false;
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.textContent).toBe('');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.textContent).toBe('Hello');
});
it('should preserve execution order of dependencies', async () => {
// Important note: the framework does *NOT* guarantee an exact order
// in which directives are instantiated. Directives should not depend
// on the order in which other directives are invoked. This test just
// verifies that the order does not change when a particular part of
// code is wrapped using the `@defer` block.
const logs: string[] = [];
@Directive({
standalone: true,
selector: '[dirA]',
})
class DirA {
constructor(@Attribute('mode') mode: string) {
logs.push(`DirA.${mode}`);
}
}
@Directive({
standalone: true,
selector: '[dirB]',
})
class DirB {
constructor(@Attribute('mode') mode: string) {
logs.push(`DirB.${mode}`);
}
}
@Directive({
standalone: true,
selector: '[dirC]',
})
class DirC {
constructor(@Attribute('mode') mode: string) {
logs.push(`DirC.${mode}`);
}
}
@Component({
standalone: true,
// Directive order is intentional here (different from the order
// in which they are defined on the host element).
imports: [DirC, DirB, DirA],
template: `
@defer (when isVisible) {
<div mode="defer" dirA dirB dirC></div>
}
<div mode="eager" dirA dirB dirC></div>
`
})
class MyCmp {
isVisible = true;
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
await allPendingDynamicImports();
fixture.detectChanges();
const actual = {defer: [], eager: []};
for (const log of logs) {
const [dir, category] = log.split('.');
(actual as {[key: string]: string[]})[category].push(dir);
}
// Expect that in both cases we have the same order.
expect(actual.defer).toEqual(actual.eager);
});
describe('with OnPush', () => {
it('should render when @defer is used inside of an OnPush component', async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
template: '{{ foo }}',
})
class MyLazyCmp {
foo = 'bar';
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
@defer (on immediate) {
<my-lazy-cmp />
}
`
})
class MyCmp {
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>bar</my-lazy-cmp>');
});
it('should render when @defer-loaded component uses OnPush', async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
changeDetection: ChangeDetectionStrategy.OnPush,
template: '{{ foo }}',
})
class MyLazyCmp {
foo = 'bar';
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp],
template: `
@defer (on immediate) {
<my-lazy-cmp />
}
`
})
class MyCmp {
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>bar</my-lazy-cmp>');
});
it('should render when both @defer-loaded and host component use OnPush', async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
changeDetection: ChangeDetectionStrategy.OnPush,
template: '{{ foo }}',
})
class MyLazyCmp {
foo = 'bar';
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
@defer (on immediate) {
<my-lazy-cmp />
}
`
})
class MyCmp {
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>bar</my-lazy-cmp>');
});
it('should render when both OnPush components used in other blocks (e.g. @placeholder)',
async () => {
@Component({
selector: 'my-lazy-cmp',
standalone: true,
changeDetection: ChangeDetectionStrategy.OnPush,
template: '{{ foo }}',
})
class MyLazyCmp {
foo = 'main';
}
@Component({
selector: 'another-lazy-cmp',
standalone: true,
changeDetection: ChangeDetectionStrategy.OnPush,
template: '{{ foo }}',
})
class AnotherLazyCmp {
foo = 'placeholder';
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [MyLazyCmp, AnotherLazyCmp],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
@defer (when isVisible) {
<my-lazy-cmp />
} @placeholder {
<another-lazy-cmp />
}
`
})
class MyCmp {
isVisible = false;
changeDetectorRef = inject(ChangeDetectorRef);
triggerDeferBlock() {
this.isVisible = true;
this.changeDetectorRef.detectChanges();
}
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
// Expect placeholder to be rendered correctly.
expect(fixture.nativeElement.outerHTML)
.toContain('<another-lazy-cmp>placeholder</another-lazy-cmp>');
fixture.componentInstance.triggerDeferBlock();
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('<my-lazy-cmp>main</my-lazy-cmp>');
});
});
describe('`on` conditions', () => {
it('should support `on immediate` condition', async () => {
@Component({
selector: 'nested-cmp',
standalone: true,
template: 'Rendering {{ block }} block.',
})
class NestedCmp {
@Input() block!: string;
}
@Component({
standalone: true,
selector: 'root-app',
imports: [NestedCmp],
template: `
@defer (on immediate) {
<nested-cmp [block]="'primary'" />
} @placeholder {
Placeholder
} @loading {
Loading
}
`
})
class RootCmp {
}
let loadingFnInvokedTimes = 0;
const deferDepsInterceptor = {
intercept() {
return () => {
loadingFnInvokedTimes++;
return [dynamicImportOf(NestedCmp)];
};
}
};
TestBed.configureTestingModule({
providers: [
...COMMON_PROVIDERS,
{provide: ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR, useValue: deferDepsInterceptor},
],
});
clearDirectiveDefs(RootCmp);
const fixture = TestBed.createComponent(RootCmp);
fixture.detectChanges();
// Expecting that no placeholder content would be rendered when
// a loading block is present.
expect(fixture.nativeElement.outerHTML).toContain('Loading');
// Expecting loading function to be triggered right away.
expect(loadingFnInvokedTimes).toBe(1);
await allPendingDynamicImports();
fixture.detectChanges();
// Expect that the loading resources function was not invoked again.
expect(loadingFnInvokedTimes).toBe(1);
// Verify primary block content.
const primaryBlockHTML = fixture.nativeElement.outerHTML;
expect(primaryBlockHTML)
.toContain(
'<nested-cmp ng-reflect-block="primary">Rendering primary block.</nested-cmp>');
// Expect that the loading resources function was not invoked again (counter remains 1).
expect(loadingFnInvokedTimes).toBe(1);
});
});
describe('directive matching', () => {
it('should support directive matching in all blocks', async () => {
@Component({
selector: 'nested-cmp',
standalone: true,
template: 'Rendering {{ block }} block.',
})
class NestedCmp {
@Input() block!: string;
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [NestedCmp],
template: `
@defer (when isVisible) {
<nested-cmp [block]="'primary'" />
} @loading {
Loading...
<nested-cmp [block]="'loading'" />
} @placeholder {
Placeholder!
<nested-cmp [block]="'placeholder'" />
} @error {
Failed to load dependencies :(
<nested-cmp [block]="'error'" />
}
`
})
class MyCmp {
isVisible = false;
}
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML)
.toContain(
'<nested-cmp ng-reflect-block="placeholder">Rendering placeholder block.</nested-cmp>');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML)
.toContain(
'<nested-cmp ng-reflect-block="loading">Rendering loading block.</nested-cmp>');
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML)
.toContain(
'<nested-cmp ng-reflect-block="primary">Rendering primary block.</nested-cmp>');
});
});
describe('minimum and after conditions', () => {
it('should support minimum and after conditions', fakeAsync(() => {
const {trigger, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @loading (after 100ms; minimum 150ms) {
Loading
} @placeholder (minimum 100ms) {
Placeholder
} @error {
Error
}
`);
verifyTimeline(
fixture,
[50, 'Placeholder'],
[100, trigger(170)],
[150, 'Placeholder'],
[250, 'Loading'],
[300, 'Loading'],
[450, 'Main'],
);
}));
it('should support @placeholder with `minimum`', fakeAsync(() => {
const {trigger, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @placeholder (minimum 100ms) {
Placeholder
}
`);
verifyTimeline(
fixture,
[0, trigger(40)],
[90, 'Placeholder'],
[100, 'Main'],
);
}));
it('should keep rendering @placeholder if trigger happened later', fakeAsync(() => {
const {trigger, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @placeholder (minimum 100ms) {
Placeholder
}
`);
verifyTimeline(
fixture,
[0, 'Placeholder'],
[50, trigger(20)],
[90, 'Placeholder'],
[100, 'Main'],
);
}));
it('should transition from @placeholder to primary content ' +
'if it was prefetched',
fakeAsync(() => {
const {trigger, triggerPrefetch, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @placeholder (minimum 100ms) {
Placeholder
}
`);
verifyTimeline(
fixture,
[0, 'Placeholder'],
[20, triggerPrefetch(20)],
[150, 'Placeholder'],
[200, trigger(0)],
[225, 'Main'],
);
}));
it('should support @loading with `minimum`', fakeAsync(() => {
const {trigger, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @loading (minimum 100ms) {
Loading
}
`);
verifyTimeline(
fixture,
[0, trigger(20)],
// Even though loading happened in 20ms,
// we still render @loading block for longer
// period of time, since there was `minimum` defined.
[95, 'Loading'],
[100, 'Main'],
);
}));
it('should support @loading with `after` and `minimum`', fakeAsync(() => {
const {trigger, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @loading (after 100ms; minimum 150ms) {
Loading
}
`);
verifyTimeline(
fixture,
[0, trigger(150)],
[50, ''],
// Start showing loading after `after` ms.
[100, 'Loading'],
[150, 'Loading'],
[200, 'Loading'],
// Render main content after `after` + `minimum` ms.
[300, 'Main'],
);
}));
it('should skip @loading when resources were prefetched', fakeAsync(() => {
const {trigger, triggerPrefetch, fixture} = createFixture(`
@defer (when trigger; prefetch when prefetchTrigger) {
<nested-cmp [block]="'Main'" />
} @loading (minimum 100ms) {
Loading
}
`);
verifyTimeline(
fixture,
[0, triggerPrefetch(50)],
[50, ''],
[75, ''],
[100, trigger(0)],
// We go directly into the final state, since
// resources were already preloaded.
[125, 'Main'],
);
}));
});
describe('error handling', () => {
it('should render an error block when loading fails', async () => {
@Component({
selector: 'nested-cmp',
standalone: true,
template: 'Rendering {{ block }} block.',
})
class NestedCmp {
@Input() block!: string;
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [NestedCmp],
template: `
@defer (when isVisible) {
<nested-cmp [block]="'primary'" />
} @loading {
Loading...
} @placeholder {
Placeholder!
} @error {
Failed to load dependencies :(
<nested-cmp [block]="'error'" />
}
`
})
class MyCmp {
isVisible = false;
@ViewChildren(NestedCmp) cmps!: QueryList<NestedCmp>;
}
const deferDepsInterceptor = {
intercept() {
return () => [failedDynamicImport()];
}
};
TestBed.configureTestingModule({
providers: [
{provide: ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR, useValue: deferDepsInterceptor},
],
});
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Placeholder');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Loading');
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
// Verify that the error block is rendered.
// Also verify that selector matching works in an error block.
expect(fixture.nativeElement.outerHTML)
.toContain('<nested-cmp ng-reflect-block="error">Rendering error block.</nested-cmp>');
// Verify that queries work within an error block.
expect(fixture.componentInstance.cmps.length).toBe(1);
expect(fixture.componentInstance.cmps.get(0)?.block).toBe('error');
});
it('should report an error to the ErrorHandler if no `@error` block is defined', async () => {
@Component({
selector: 'nested-cmp',
standalone: true,
template: 'NestedCmp',
})
class NestedCmp {
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [NestedCmp],
template: `
@defer (when isVisible) {
<nested-cmp />
} @loading {
Loading...
} @placeholder {
Placeholder
}
`
})
class MyCmp {
isVisible = false;
}
const deferDepsInterceptor = {
intercept() {
return () => [failedDynamicImport()];
}
};
const reportedErrors: Error[] = [];
TestBed.configureTestingModule({
providers: [
{
provide: ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR,
useValue: deferDepsInterceptor,
},
{
provide: ErrorHandler, useClass: class extends ErrorHandler{
override handleError(error: Error) {
reportedErrors.push(error);
}
},
},
],
});
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Placeholder');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Loading');
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();
// Verify that there was an error reported to the `ErrorHandler`.
expect(reportedErrors.length).toBe(1);
expect(reportedErrors[0].message).toContain('NG0750');
expect(reportedErrors[0].message).toContain(`(used in the 'MyCmp' component template)`);
});
it('should not render `@error` block if loaded component has errors', async () => {
@Component({
selector: 'cmp-with-error',
standalone: true,
template: 'CmpWithError',
})
class CmpWithError {
constructor() {
throw new Error('CmpWithError produced an error');
}
}
@Component({
standalone: true,
selector: 'simple-app',
imports: [CmpWithError],
template: `
@defer (when isVisible) {
<cmp-with-error />
} @loading {
Loading...
} @error {
Error
} @placeholder {
Placeholder
}
`
})
class MyCmp {
isVisible = false;
}
const deferDepsInterceptor = {
intercept() {
return () => [dynamicImportOf(CmpWithError)];
}
};
const reportedErrors: Error[] = [];
TestBed.configureTestingModule({
providers: [
{
provide: ɵDEFER_BLOCK_DEPENDENCY_INTERCEPTOR,
useValue: deferDepsInterceptor,
},
{
provide: ErrorHandler, useClass: class extends ErrorHandler{
override handleError(error: Error) {
reportedErrors.push(error);
}
},
},
],
});
const fixture = TestBed.createComponent(MyCmp);
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Placeholder');
fixture.componentInstance.isVisible = true;
fixture.detectChanges();
expect(fixture.nativeElement.outerHTML).toContain('Loading');
// Wait for dependencies to load.
await allPendingDynamicImports();
fixture.detectChanges();