forked from angular/angular-cli
-
Notifications
You must be signed in to change notification settings - Fork 1
/
stats.ts
372 lines (315 loc) · 10.9 KB
/
stats.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
/**
* @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 { WebpackLoggingCallback } from '@angular-devkit/build-webpack';
import { logging, tags } from '@angular-devkit/core';
import * as path from 'path';
import textTable from 'text-table';
import { Configuration, StatsCompilation } from 'webpack';
import { Schema as BrowserBuilderOptions } from '../../browser/schema';
import { colors as ansiColors, removeColor } from '../../utils/color';
import { getWebpackStatsConfig } from '../configs/stats';
import { markAsyncChunksNonInitial } from './async-chunks';
import { normalizeExtraEntryPoints } from './helpers';
export function formatSize(size: number): string {
if (size <= 0) {
return '0 bytes';
}
const abbreviations = ['bytes', 'kB', 'MB', 'GB'];
const index = Math.floor(Math.log(size) / Math.log(1024));
const roundedSize = size / Math.pow(1024, index);
// bytes don't have a fraction
const fractionDigits = index === 0 ? 0 : 2;
return `${roundedSize.toFixed(fractionDigits)} ${abbreviations[index]}`;
}
export type BundleStatsData = [files: string, names: string, size: number | string];
export type ChunkType = 'modern' | 'legacy' | 'unknown';
export interface BundleStats {
initial: boolean;
stats: BundleStatsData;
chunkType: ChunkType;
}
export function generateBundleStats(info: {
size?: number;
files?: string[];
names?: string[];
initial?: boolean;
rendered?: boolean;
chunkType?: ChunkType;
}): BundleStats {
const size = typeof info.size === 'number' ? info.size : '-';
const files =
info.files
?.filter((f) => !f.endsWith('.map'))
.map((f) => path.basename(f))
.join(', ') ?? '';
const names = info.names?.length ? info.names.join(', ') : '-';
const initial = !!info.initial;
const chunkType = info.chunkType || 'unknown';
return {
chunkType,
initial,
stats: [files, names, size],
};
}
function generateBuildStatsTable(
data: BundleStats[],
colors: boolean,
showTotalSize: boolean,
): string {
const g = (x: string) => (colors ? ansiColors.greenBright(x) : x);
const c = (x: string) => (colors ? ansiColors.cyanBright(x) : x);
const bold = (x: string) => (colors ? ansiColors.bold(x) : x);
const dim = (x: string) => (colors ? ansiColors.dim(x) : x);
const changedEntryChunksStats: BundleStatsData[] = [];
const changedLazyChunksStats: BundleStatsData[] = [];
let initialModernTotalSize = 0;
let initialLegacyTotalSize = 0;
let modernFileSuffix: string | undefined;
for (const { initial, stats, chunkType } of data) {
const [files, names, size] = stats;
const data: BundleStatsData = [
g(files),
names,
c(typeof size === 'number' ? formatSize(size) : size),
];
if (initial) {
changedEntryChunksStats.push(data);
if (typeof size === 'number') {
switch (chunkType) {
case 'modern':
initialModernTotalSize += size;
if (!modernFileSuffix) {
const match = files.match(/-(es20\d{2}|esnext)/);
modernFileSuffix = match?.[1].toString().toUpperCase();
}
break;
case 'legacy':
initialLegacyTotalSize += size;
break;
default:
initialModernTotalSize += size;
initialLegacyTotalSize += size;
break;
}
}
} else {
changedLazyChunksStats.push(data);
}
}
const bundleInfo: (string | number)[][] = [];
// Entry chunks
if (changedEntryChunksStats.length) {
bundleInfo.push(['Initial Chunk Files', 'Names', 'Size'].map(bold), ...changedEntryChunksStats);
if (showTotalSize) {
bundleInfo.push([]);
if (initialModernTotalSize === initialLegacyTotalSize) {
bundleInfo.push([' ', 'Initial Total', formatSize(initialModernTotalSize)].map(bold));
} else {
bundleInfo.push(
[' ', 'Initial ES5 Total', formatSize(initialLegacyTotalSize)].map(bold),
[' ', `Initial ${modernFileSuffix} Total`, formatSize(initialModernTotalSize)].map(bold),
);
}
}
}
// Seperator
if (changedEntryChunksStats.length && changedLazyChunksStats.length) {
bundleInfo.push([]);
}
// Lazy chunks
if (changedLazyChunksStats.length) {
bundleInfo.push(['Lazy Chunk Files', 'Names', 'Size'].map(bold), ...changedLazyChunksStats);
}
return textTable(bundleInfo, {
hsep: dim(' | '),
stringLength: (s) => removeColor(s).length,
align: ['l', 'l', 'r'],
});
}
function generateBuildStats(hash: string, time: number, colors: boolean): string {
const w = (x: string) => (colors ? ansiColors.bold.white(x) : x);
return `Build at: ${w(new Date().toISOString())} - Hash: ${w(hash)} - Time: ${w('' + time)}ms`;
}
// We use this cache because we can have multiple builders running in the same process,
// where each builder has different output path.
// Ideally, we should create the logging callback as a factory, but that would need a refactoring.
const runsCache = new Set<string>();
function statsToString(
json: StatsCompilation,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
statsConfig: any,
bundleState?: BundleStats[],
): string {
if (!json.chunks?.length) {
return '';
}
const colors = statsConfig.colors;
const rs = (x: string) => (colors ? ansiColors.reset(x) : x);
const changedChunksStats: BundleStats[] = bundleState ?? [];
let unchangedChunkNumber = 0;
if (!bundleState?.length) {
const isFirstRun = !runsCache.has(json.outputPath || '');
for (const chunk of json.chunks) {
// During first build we want to display unchanged chunks
// but unchanged cached chunks are always marked as not rendered.
if (!isFirstRun && !chunk.rendered) {
continue;
}
const assets = json.assets?.filter((asset) => chunk.files?.includes(asset.name));
const summedSize = assets
?.filter((asset) => !asset.name.endsWith('.map'))
.reduce((total, asset) => total + asset.size, 0);
changedChunksStats.push(generateBundleStats({ ...chunk, size: summedSize }));
}
unchangedChunkNumber = json.chunks.length - changedChunksStats.length;
runsCache.add(json.outputPath || '');
}
// Sort chunks by size in descending order
changedChunksStats.sort((a, b) => {
if (a.stats[2] > b.stats[2]) {
return -1;
}
if (a.stats[2] < b.stats[2]) {
return 1;
}
return 0;
});
const statsTable = generateBuildStatsTable(
changedChunksStats,
colors,
unchangedChunkNumber === 0,
);
// In some cases we do things outside of webpack context
// Such us index generation, service worker augmentation etc...
// This will correct the time and include these.
let time = 0;
if (json.builtAt !== undefined && json.time !== undefined) {
time = Date.now() - json.builtAt + json.time;
}
if (unchangedChunkNumber > 0) {
return (
'\n' +
rs(tags.stripIndents`
${statsTable}
${unchangedChunkNumber} unchanged chunks
${generateBuildStats(json.hash || '', time, colors)}
`)
);
} else {
return (
'\n' +
rs(tags.stripIndents`
${statsTable}
${generateBuildStats(json.hash || '', time, colors)}
`)
);
}
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function statsWarningsToString(json: StatsCompilation, statsConfig: any): string {
const colors = statsConfig.colors;
const c = (x: string) => (colors ? ansiColors.reset.cyan(x) : x);
const y = (x: string) => (colors ? ansiColors.reset.yellow(x) : x);
const yb = (x: string) => (colors ? ansiColors.reset.yellowBright(x) : x);
const warnings = json.warnings ? [...json.warnings] : [];
if (json.children) {
warnings.push(...json.children.map((c) => c.warnings ?? []).reduce((a, b) => [...a, ...b], []));
}
let output = '';
for (const warning of warnings) {
if (typeof warning === 'string') {
output += yb(`Warning: ${warning}\n\n`);
} else {
const file = warning.file || warning.moduleName;
if (file) {
output += c(file);
if (warning.loc) {
output += ':' + yb(warning.loc);
}
output += ' - ';
}
if (!/^warning/i.test(warning.message)) {
output += y('Warning: ');
}
output += `${warning.message}\n\n`;
}
}
return output ? '\n' + output : output;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function statsErrorsToString(json: StatsCompilation, statsConfig: any): string {
const colors = statsConfig.colors;
const c = (x: string) => (colors ? ansiColors.reset.cyan(x) : x);
const yb = (x: string) => (colors ? ansiColors.reset.yellowBright(x) : x);
const r = (x: string) => (colors ? ansiColors.reset.redBright(x) : x);
const errors = json.errors ? [...json.errors] : [];
if (json.children) {
errors.push(...json.children.map((c) => c?.errors || []).reduce((a, b) => [...a, ...b], []));
}
let output = '';
for (const error of errors) {
if (typeof error === 'string') {
output += r(`Error: ${error}\n\n`);
} else {
const file = error.file || error.moduleName;
if (file) {
output += c(file);
if (error.loc) {
output += ':' + yb(error.loc);
}
output += ' - ';
}
if (!/^error/i.test(error.message)) {
output += r('Error: ');
}
output += `${error.message}\n\n`;
}
}
return output ? '\n' + output : output;
}
export function statsHasErrors(json: StatsCompilation): boolean {
return !!(json.errors?.length || json.children?.some((c) => c.errors?.length));
}
export function statsHasWarnings(json: StatsCompilation): boolean {
return !!(json.warnings?.length || json.children?.some((c) => c.warnings?.length));
}
export function createWebpackLoggingCallback(
options: BrowserBuilderOptions,
logger: logging.LoggerApi,
): WebpackLoggingCallback {
const { verbose = false, scripts = [], styles = [] } = options;
const extraEntryPoints = [
...normalizeExtraEntryPoints(styles, 'styles'),
...normalizeExtraEntryPoints(scripts, 'scripts'),
];
return (stats, config) => {
if (verbose) {
logger.info(stats.toString(config.stats));
}
const rawStats = stats.toJson(getWebpackStatsConfig(false));
const webpackStats = {
...rawStats,
chunks: markAsyncChunksNonInitial(rawStats, extraEntryPoints),
};
webpackStatsLogger(logger, webpackStats, config);
};
}
export function webpackStatsLogger(
logger: logging.LoggerApi,
json: StatsCompilation,
config: Configuration,
bundleStats?: BundleStats[],
): void {
logger.info(statsToString(json, config.stats, bundleStats));
if (statsHasWarnings(json)) {
logger.warn(statsWarningsToString(json, config.stats));
}
if (statsHasErrors(json)) {
logger.error(statsErrorsToString(json, config.stats));
}
}