forked from angular/angular-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaugment-index-html_spec.ts
577 lines (520 loc) · 16.8 KB
/
augment-index-html_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
/**
* @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 { tags } from '@angular-devkit/core';
import { AugmentIndexHtmlOptions, augmentIndexHtml } from './augment-index-html';
describe('augment-index-html', () => {
const indexGeneratorOptions: AugmentIndexHtmlOptions = {
html: '<html><head></head><body></body></html>',
baseHref: '/',
sri: false,
files: [],
loadOutputFile: async (_fileName: string) => '',
entrypoints: [
['scripts', false],
['polyfills', true],
['main', true],
['styles', false],
],
};
const oneLineHtml = (html: TemplateStringsArray) =>
tags.stripIndents`${html}`.replace(/(>\s+)/g, '>');
it('can generate index.html', async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
files: [
{ file: 'styles.css', extension: '.css', name: 'styles' },
{ file: 'runtime.js', extension: '.js', name: 'main' },
{ file: 'main.js', extension: '.js', name: 'main' },
{ file: 'runtime.js', extension: '.js', name: 'polyfills' },
{ file: 'polyfills.js', extension: '.js', name: 'polyfills' },
],
});
expect(content).toEqual(oneLineHtml`
<html>
<head><base href="/">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<script src="runtime.js" type="module"></script>
<script src="polyfills.js" type="module"></script>
<script src="main.js" type="module"></script>
</body>
</html>
`);
});
it('should replace base href value', async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
html: '<html><head><base href="/"></head><body></body></html>',
baseHref: '/Apps/',
});
expect(content).toEqual(oneLineHtml`
<html>
<head><base href="/Apps/">
</head>
<body>
</body>
</html>
`);
});
it('should add lang and dir LTR attribute for French (fr)', async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
lang: 'fr',
});
expect(content).toEqual(oneLineHtml`
<html lang="fr" dir="ltr">
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
it('should add lang and dir RTL attribute for Pashto (ps)', async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
lang: 'ps',
});
expect(content).toEqual(oneLineHtml`
<html lang="ps" dir="rtl">
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
it(`should fallback to use language ID to set the dir attribute (en-US)`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
lang: 'en-US',
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html lang="en-US" dir="ltr">
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
it(`should work when lang (locale) is not provided by '@angular/common'`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
lang: 'xx-XX',
});
expect(warnings).toEqual([
`Locale data for 'xx-XX' cannot be found. 'dir' attribute will not be set for this locale.`,
]);
expect(content).toEqual(oneLineHtml`
<html lang="xx-XX">
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
it(`should add script and link tags even when body and head element doesn't exist`, async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
html: `<app-root></app-root>`,
files: [
{ file: 'styles.css', extension: '.css', name: 'styles' },
{ file: 'runtime.js', extension: '.js', name: 'main' },
{ file: 'main.js', extension: '.js', name: 'main' },
{ file: 'runtime.js', extension: '.js', name: 'polyfills' },
{ file: 'polyfills.js', extension: '.js', name: 'polyfills' },
],
});
expect(content).toEqual(oneLineHtml`
<link rel="stylesheet" href="styles.css">
<script src="runtime.js" type="module"></script>
<script src="polyfills.js" type="module"></script>
<script src="main.js" type="module"></script>
<app-root></app-root>
`);
});
it(`should add preconnect and dns-prefetch hints when provided with cross origin`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'preconnect', url: 'http://example.com' },
{ mode: 'dns-prefetch', url: 'http://example.com' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="http://example.com">
<link rel="dns-prefetch" href="http://example.com">
</head>
<body>
</body>
</html>
`);
});
it(`should add preconnect and dns-prefetch hints when provided with "use-credentials" cross origin`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
crossOrigin: 'use-credentials',
hints: [
{ mode: 'preconnect', url: 'http://example.com' },
{ mode: 'dns-prefetch', url: 'http://example.com' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="http://example.com" crossorigin="use-credentials">
<link rel="dns-prefetch" href="http://example.com" crossorigin="use-credentials">
</head>
<body>
</body>
</html>
`);
});
it(`should add preconnect and dns-prefetch hints when provided with "anonymous" cross origin`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
crossOrigin: 'anonymous',
hints: [
{ mode: 'preconnect', url: 'http://example.com' },
{ mode: 'dns-prefetch', url: 'http://example.com' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="http://example.com" crossorigin>
<link rel="dns-prefetch" href="http://example.com" crossorigin>
</head>
<body>
</body>
</html>
`);
});
it(`should add preconnect and dns-prefetch hints when provided with "none" cross origin`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
crossOrigin: 'none',
hints: [
{ mode: 'preconnect', url: 'http://example.com' },
{ mode: 'dns-prefetch', url: 'http://example.com' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="http://example.com">
<link rel="dns-prefetch" href="http://example.com">
</head>
<body>
</body>
</html>
`);
});
it(`should add preconnect and dns-prefetch hints when provided with no cross origin`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'preconnect', url: 'http://example.com' },
{ mode: 'dns-prefetch', url: 'http://example.com' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="http://example.com">
<link rel="dns-prefetch" href="http://example.com">
</head>
<body>
</body>
</html>
`);
});
it(`should add modulepreload hint when provided`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'modulepreload', url: 'x.js' },
{ mode: 'modulepreload', url: 'y/z.js' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
</head>
<body>
<link rel="modulepreload" href="x.js">
<link rel="modulepreload" href="y/z.js">
</body>
</html>
`);
});
it(`should add modulepreload hint with no crossorigin attribute when provided with cross origin set`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
crossOrigin: 'anonymous',
hints: [
{ mode: 'modulepreload', url: 'x.js' },
{ mode: 'modulepreload', url: 'y/z.js' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
</head>
<body>
<link rel="modulepreload" href="x.js">
<link rel="modulepreload" href="y/z.js">
</body>
</html>
`);
});
it(`should add prefetch/preload hints with as=script when specified with a JS url`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'prefetch', url: 'x.js' },
{ mode: 'preload', url: 'y/z.js' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="prefetch" href="x.js" as="script">
<link rel="preload" href="y/z.js" as="script">
</head>
<body>
</body>
</html>
`);
});
it(`should add prefetch/preload hints with as=style when specified with a CSS url`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'prefetch', url: 'x.css' },
{ mode: 'preload', url: 'y/z.css' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="prefetch" href="x.css" as="style">
<link rel="preload" href="y/z.css" as="style">
</head>
<body>
</body>
</html>
`);
});
it(`should add prefetch/preload hints with as=style when specified with a URL and an 'as' option`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
hints: [
{ mode: 'prefetch', url: 'https://example.com/x?a=1', as: 'style' },
{ mode: 'preload', url: 'http://example.com/y?b=2', as: 'style' },
],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="prefetch" href="https://example.com/x?a=1" as="style">
<link rel="preload" href="http://example.com/y?b=2" as="style">
</head>
<body>
</body>
</html>
`);
});
it(`should not add deploy URL to hints with an absolute URL`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
deployUrl: 'https://localhost/',
hints: [{ mode: 'preload', url: 'http://example.com/y?b=2' }],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preload" href="http://example.com/y?b=2">
</head>
<body>
</body>
</html>
`);
});
it(`should not add deploy URL to hints with a root-relative URL`, async () => {
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
deployUrl: 'https://example.com/',
hints: [{ mode: 'preload', url: '/y?b=2' }],
});
expect(warnings).toHaveSize(0);
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preload" href="/y?b=2">
</head>
<body>
</body>
</html>
`);
});
it('should add `.mjs` script tags', async () => {
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
files: [{ file: 'main.mjs', extension: '.mjs', name: 'main' }],
entrypoints: [['main', true /* isModule */]],
});
expect(content).toContain('<script src="main.mjs" type="module"></script>');
});
it('should reject non-module `.mjs` scripts', async () => {
const options: AugmentIndexHtmlOptions = {
...indexGeneratorOptions,
files: [{ file: 'main.mjs', extension: '.mjs', name: 'main' }],
entrypoints: [['main', false /* isModule */]],
};
await expectAsync(augmentIndexHtml(options)).toBeRejectedWithError(
'`.mjs` files *must* set `isModule` to `true`.',
);
});
it('should add image domain preload tags', async () => {
const imageDomains = ['https://www.example.com', 'https://www.example2.com'];
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
imageDomains,
});
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="https://www.example.com" data-ngimg>
<link rel="preconnect" href="https://www.example2.com" data-ngimg>
</head>
<body>
</body>
</html>
`);
});
it('should add no image preconnects if provided empty domain list', async () => {
const imageDomains: Array<string> = [];
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
imageDomains,
});
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
</head>
<body>
</body>
</html>
`);
});
it('should not add duplicate preconnects', async () => {
const imageDomains = ['https://www.example1.com', 'https://www.example2.com'];
const { content, warnings } = await augmentIndexHtml({
...indexGeneratorOptions,
html: '<html><head><link rel="preconnect" href="https://www.example1.com"></head><body></body></html>',
imageDomains,
});
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="https://www.example1.com">
<link rel="preconnect" href="https://www.example2.com" data-ngimg>
</head>
<body>
</body>
</html>
`);
});
it('should add image preconnects if it encounters preconnect elements for other resources', async () => {
const imageDomains = ['https://www.example2.com', 'https://www.example3.com'];
const { content } = await augmentIndexHtml({
...indexGeneratorOptions,
html: '<html><head><link rel="preconnect" href="https://www.example1.com"></head><body></body></html>',
imageDomains,
});
expect(content).toEqual(oneLineHtml`
<html>
<head>
<base href="/">
<link rel="preconnect" href="https://www.example1.com">
<link rel="preconnect" href="https://www.example2.com" data-ngimg>
<link rel="preconnect" href="https://www.example3.com" data-ngimg>
</head>
<body>
</body>
</html>
`);
});
describe('self-closing tags', () => {
it('should return an error when used on a not supported element', async () => {
const { errors } = await augmentIndexHtml({
...indexGeneratorOptions,
html: `
<html>
<body>
<app-root />
</body>
</html>'
`,
});
expect(errors.length).toEqual(1);
expect(errors).toEqual([`Invalid self-closing element in index HTML file: '<app-root />'.`]);
});
it('should not return an error when used on a supported element', async () => {
const { errors } = await augmentIndexHtml({
...indexGeneratorOptions,
html: `
<html>
<body>
<br />
<app-root><app-root>
</body>
</html>'
`,
});
expect(errors.length).toEqual(0);
});
});
});