/
PackagerRunner.js
689 lines (620 loc) Β· 19 KB
/
PackagerRunner.js
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
// @flow strict-local
import type {
Blob,
FilePath,
BundleResult,
Bundle as BundleType,
BundleGraph as BundleGraphType,
NamedBundle as NamedBundleType,
Async,
} from '@parcel/types';
import type SourceMap from '@parcel/source-map';
import type {
Bundle as InternalBundle,
Config,
DevDepRequest,
ParcelOptions,
ReportFn,
RequestInvalidation,
} from './types';
import type ParcelConfig, {LoadedPlugin} from './ParcelConfig';
import type InternalBundleGraph from './BundleGraph';
import type {ConfigRequest} from './requests/ConfigRequest';
import type {DevDepSpecifier} from './requests/DevDepRequest';
import invariant from 'assert';
import {blobToStream, TapStream} from '@parcel/utils';
import {PluginLogger} from '@parcel/logger';
import ThrowableDiagnostic, {errorToDiagnostic} from '@parcel/diagnostic';
import {Readable} from 'stream';
import nullthrows from 'nullthrows';
import path from 'path';
import url from 'url';
import {hashString, hashBuffer, Hash} from '@parcel/hash';
import {NamedBundle, bundleToInternalBundle} from './public/Bundle';
import BundleGraph, {
bundleGraphToInternalBundleGraph,
} from './public/BundleGraph';
import PluginOptions from './public/PluginOptions';
import {PARCEL_VERSION, HASH_REF_PREFIX, HASH_REF_REGEX} from './constants';
import {
fromProjectPath,
toProjectPathUnsafe,
fromProjectPathRelative,
joinProjectPath,
} from './projectPath';
import {createConfig} from './InternalConfig';
import {
loadPluginConfig,
getConfigHash,
getConfigRequests,
type PluginWithLoadConfig,
} from './requests/ConfigRequest';
import {
createDevDependency,
getWorkerDevDepRequests,
} from './requests/DevDepRequest';
import {createBuildCache} from './buildCache';
import {getInvalidationId, getInvalidationHash} from './assetUtils';
import {optionsProxy} from './utils';
import {invalidateDevDeps} from './requests/DevDepRequest';
type Opts = {|
config: ParcelConfig,
options: ParcelOptions,
report: ReportFn,
previousDevDeps: Map<string, string>,
previousInvalidations: Array<RequestInvalidation>,
|};
export type PackageRequestResult = {|
bundleInfo: BundleInfo,
configRequests: Array<ConfigRequest>,
devDepRequests: Array<DevDepRequest>,
invalidations: Array<RequestInvalidation>,
|};
export type BundleInfo = {|
+type: string,
+size: number,
+hash: string,
+hashReferences: Array<string>,
+time?: number,
+cacheKeys: CacheKeyMap,
+isLargeBlob: boolean,
|};
type CacheKeyMap = {|
content: string,
map: string,
info: string,
|};
const BOUNDARY_LENGTH = HASH_REF_PREFIX.length + 32 - 1;
// Packager/optimizer configs are not bundle-specific, so we only need to
// load them once per build.
const pluginConfigs = createBuildCache();
export default class PackagerRunner {
config: ParcelConfig;
options: ParcelOptions;
pluginOptions: PluginOptions;
distDir: FilePath;
distExists: Set<FilePath>;
report: ReportFn;
previousDevDeps: Map<string, string>;
devDepRequests: Map<string, DevDepRequest>;
invalidations: Map<string, RequestInvalidation>;
previousInvalidations: Array<RequestInvalidation>;
constructor({
config,
options,
report,
previousDevDeps,
previousInvalidations,
}: Opts) {
this.config = config;
this.options = options;
this.report = report;
this.previousDevDeps = previousDevDeps;
this.devDepRequests = new Map();
this.previousInvalidations = previousInvalidations;
this.invalidations = new Map();
this.pluginOptions = new PluginOptions(
optionsProxy(this.options, option => {
let invalidation: RequestInvalidation = {
type: 'option',
key: option,
};
this.invalidations.set(getInvalidationId(invalidation), invalidation);
}),
);
}
async run(
bundleGraph: InternalBundleGraph,
bundle: InternalBundle,
invalidDevDeps: Array<DevDepSpecifier>,
): Promise<PackageRequestResult> {
invalidateDevDeps(invalidDevDeps, this.options, this.config);
let configs = await this.loadConfigs(bundleGraph, bundle);
let bundleInfo =
(await this.getBundleInfoFromCache(bundleGraph, bundle, configs)) ??
(await this.getBundleInfo(bundle, bundleGraph, configs));
let configRequests = getConfigRequests([...configs.values()]);
let devDepRequests = getWorkerDevDepRequests([
...this.devDepRequests.values(),
]);
return {
bundleInfo,
configRequests,
devDepRequests,
invalidations: [...this.invalidations.values()],
};
}
async loadConfigs(
bundleGraph: InternalBundleGraph,
bundle: InternalBundle,
): Promise<Map<string, Config>> {
let configs = new Map();
await this.loadConfig(bundle, configs);
for (let inlineBundle of bundleGraph.getInlineBundles(bundle)) {
await this.loadConfig(inlineBundle, configs);
}
return configs;
}
async loadConfig(
bundle: InternalBundle,
configs: Map<string, Config>,
): Promise<void> {
let name = nullthrows(bundle.name);
let plugin = await this.config.getPackager(name);
await this.loadPluginConfig(plugin, configs);
let optimizers = await this.config.getOptimizers(name, bundle.pipeline);
for (let optimizer of optimizers) {
await this.loadPluginConfig(optimizer, configs);
}
}
async loadPluginConfig<T: PluginWithLoadConfig>(
plugin: LoadedPlugin<T>,
configs: Map<string, Config>,
): Promise<void> {
if (configs.has(plugin.name)) {
return;
}
// Only load config for a plugin once per build.
let existing = pluginConfigs.get(plugin.name);
if (existing != null) {
configs.set(plugin.name, existing);
return;
}
if (plugin.plugin.loadConfig != null) {
let config = createConfig({
plugin: plugin.name,
searchPath: toProjectPathUnsafe('index'),
});
await loadPluginConfig(plugin, config, this.options);
for (let devDep of config.devDeps) {
let devDepRequest = await createDevDependency(
devDep,
this.previousDevDeps,
this.options,
);
let key = `${devDep.specifier}:${fromProjectPath(
this.options.projectRoot,
devDep.resolveFrom,
)}`;
this.devDepRequests.set(key, devDepRequest);
}
pluginConfigs.set(plugin.name, config);
configs.set(plugin.name, config);
}
}
async getBundleInfoFromCache(
bundleGraph: InternalBundleGraph,
bundle: InternalBundle,
configs: Map<string, Config>,
): Async<?BundleInfo> {
if (this.options.shouldDisableCache) {
return;
}
let cacheKey = await this.getCacheKey(
bundle,
bundleGraph,
configs,
this.previousInvalidations,
);
let infoKey = PackagerRunner.getInfoKey(cacheKey);
return this.options.cache.get<BundleInfo>(infoKey);
}
async getBundleInfo(
bundle: InternalBundle,
bundleGraph: InternalBundleGraph,
configs: Map<string, Config>,
): Promise<BundleInfo> {
let {type, contents, map} = await this.getBundleResult(
bundle,
bundleGraph,
configs,
);
// Recompute cache keys as they may have changed due to dev dependencies.
let cacheKey = await this.getCacheKey(bundle, bundleGraph, configs, [
...this.invalidations.values(),
]);
let cacheKeys = {
content: PackagerRunner.getContentKey(cacheKey),
map: PackagerRunner.getMapKey(cacheKey),
info: PackagerRunner.getInfoKey(cacheKey),
};
return this.writeToCache(cacheKeys, type, contents, map);
}
async getBundleResult(
bundle: InternalBundle,
bundleGraph: InternalBundleGraph,
configs: Map<string, Config>,
): Promise<{|
type: string,
contents: Blob,
map: ?string,
|}> {
let packaged = await this.package(bundle, bundleGraph, configs);
let type = packaged.type ?? bundle.type;
let res = await this.optimize(
bundle,
bundleGraph,
type,
packaged.contents,
packaged.map,
configs,
);
let map =
res.map != null ? await this.generateSourceMap(bundle, res.map) : null;
return {
type: res.type ?? type,
contents: res.contents,
map,
};
}
getSourceMapReference(bundle: NamedBundle, map: ?SourceMap): Async<?string> {
if (map && bundle.env.sourceMap && bundle.bundleBehavior !== 'inline') {
if (bundle.env.sourceMap && bundle.env.sourceMap.inline) {
return this.generateSourceMap(bundleToInternalBundle(bundle), map);
} else {
return path.basename(bundle.name) + '.map';
}
} else {
return null;
}
}
async package(
internalBundle: InternalBundle,
bundleGraph: InternalBundleGraph,
configs: Map<string, Config>,
): Promise<BundleResult> {
let bundle = NamedBundle.get(internalBundle, bundleGraph, this.options);
this.report({
type: 'buildProgress',
phase: 'packaging',
bundle,
});
let packager = await this.config.getPackager(bundle.name);
let {name, resolveFrom, plugin} = packager;
try {
return await plugin.package({
config: configs.get(name)?.result,
bundle,
bundleGraph: new BundleGraph<NamedBundleType>(
bundleGraph,
NamedBundle.get.bind(NamedBundle),
this.options,
),
getSourceMapReference: map => {
return this.getSourceMapReference(bundle, map);
},
options: this.pluginOptions,
logger: new PluginLogger({origin: name}),
getInlineBundleContents: async (
bundle: BundleType,
bundleGraph: BundleGraphType<NamedBundleType>,
) => {
if (bundle.bundleBehavior !== 'inline') {
throw new Error(
'Bundle is not inline and unable to retrieve contents',
);
}
let res = await this.getBundleResult(
bundleToInternalBundle(bundle),
// $FlowFixMe
bundleGraphToInternalBundleGraph(bundleGraph),
configs,
);
return {contents: res.contents};
},
});
} catch (e) {
throw new ThrowableDiagnostic({
diagnostic: errorToDiagnostic(e, {
origin: name,
filePath: path.join(bundle.target.distDir, bundle.name),
}),
});
} finally {
// Add dev dependency for the packager. This must be done AFTER running it due to
// the potential for lazy require() that aren't executed until the request runs.
let devDepRequest = await createDevDependency(
{
specifier: name,
resolveFrom,
},
this.previousDevDeps,
this.options,
);
this.devDepRequests.set(
`${name}:${fromProjectPathRelative(resolveFrom)}`,
devDepRequest,
);
}
}
async optimize(
internalBundle: InternalBundle,
internalBundleGraph: InternalBundleGraph,
type: string,
contents: Blob,
map?: ?SourceMap,
configs: Map<string, Config>,
): Promise<BundleResult> {
let bundle = NamedBundle.get(
internalBundle,
internalBundleGraph,
this.options,
);
let bundleGraph = new BundleGraph<NamedBundleType>(
internalBundleGraph,
NamedBundle.get.bind(NamedBundle),
this.options,
);
let optimizers = await this.config.getOptimizers(
bundle.name,
internalBundle.pipeline,
);
if (!optimizers.length) {
return {type: bundle.type, contents, map};
}
this.report({
type: 'buildProgress',
phase: 'optimizing',
bundle,
});
let optimized = {
type,
contents,
map,
};
for (let optimizer of optimizers) {
try {
let next = await optimizer.plugin.optimize({
config: configs.get(optimizer.name)?.result,
bundle,
bundleGraph,
contents: optimized.contents,
map: optimized.map,
getSourceMapReference: map => {
return this.getSourceMapReference(bundle, map);
},
options: this.pluginOptions,
logger: new PluginLogger({origin: optimizer.name}),
});
optimized.type = next.type ?? optimized.type;
optimized.contents = next.contents;
optimized.map = next.map;
} catch (e) {
throw new ThrowableDiagnostic({
diagnostic: errorToDiagnostic(e, {
origin: optimizer.name,
filePath: path.join(bundle.target.distDir, bundle.name),
}),
});
} finally {
// Add dev dependency for the optimizer. This must be done AFTER running it due to
// the potential for lazy require() that aren't executed until the request runs.
let devDepRequest = await createDevDependency(
{
specifier: optimizer.name,
resolveFrom: optimizer.resolveFrom,
},
this.previousDevDeps,
this.options,
);
this.devDepRequests.set(
`${optimizer.name}:${fromProjectPathRelative(optimizer.resolveFrom)}`,
devDepRequest,
);
}
}
return optimized;
}
async generateSourceMap(
bundle: InternalBundle,
map: SourceMap,
): Promise<string> {
// sourceRoot should be a relative path between outDir and rootDir for node.js targets
let filePath = joinProjectPath(
bundle.target.distDir,
nullthrows(bundle.name),
);
let fullPath = fromProjectPath(this.options.projectRoot, filePath);
let sourceRoot: string = path.relative(
path.dirname(fullPath),
this.options.projectRoot,
);
let inlineSources = false;
if (bundle.target) {
if (
bundle.env.sourceMap &&
bundle.env.sourceMap.sourceRoot !== undefined
) {
sourceRoot = bundle.env.sourceMap.sourceRoot;
} else if (
this.options.serveOptions &&
bundle.target.env.context === 'browser'
) {
sourceRoot = '/__parcel_source_root';
}
if (
bundle.env.sourceMap &&
bundle.env.sourceMap.inlineSources !== undefined
) {
inlineSources = bundle.env.sourceMap.inlineSources;
} else if (bundle.target.env.context !== 'node') {
// inlining should only happen in production for browser targets by default
inlineSources = this.options.mode === 'production';
}
}
let mapFilename = fullPath + '.map';
let isInlineMap = bundle.env.sourceMap && bundle.env.sourceMap.inline;
let stringified = await map.stringify({
file: path.basename(mapFilename),
// $FlowFixMe
fs: this.options.inputFS,
rootDir: this.options.projectRoot,
sourceRoot: !inlineSources
? url.format(url.parse(sourceRoot + '/'))
: undefined,
inlineSources,
format: isInlineMap ? 'inline' : 'string',
});
invariant(typeof stringified === 'string');
return stringified;
}
async getCacheKey(
bundle: InternalBundle,
bundleGraph: InternalBundleGraph,
configs: Map<string, Config>,
invalidations: Array<RequestInvalidation>,
): Promise<string> {
let configResults = {};
for (let [pluginName, config] of configs) {
if (config) {
configResults[pluginName] = await getConfigHash(
config,
pluginName,
this.options,
);
}
}
let devDepHashes = await this.getDevDepHashes(bundle);
for (let inlineBundle of bundleGraph.getInlineBundles(bundle)) {
devDepHashes += await this.getDevDepHashes(inlineBundle);
}
let invalidationHash = await getInvalidationHash(
invalidations,
this.options,
);
return hashString(
PARCEL_VERSION +
devDepHashes +
invalidationHash +
bundle.target.publicUrl +
bundleGraph.getHash(bundle) +
JSON.stringify(configResults) +
this.options.mode,
);
}
async getDevDepHashes(bundle: InternalBundle): Promise<string> {
let name = nullthrows(bundle.name);
let packager = await this.config.getPackager(name);
let optimizers = await this.config.getOptimizers(name);
let key = `${packager.name}:${fromProjectPathRelative(
packager.resolveFrom,
)}`;
let devDepHashes =
this.devDepRequests.get(key)?.hash ?? this.previousDevDeps.get(key) ?? '';
for (let {name, resolveFrom} of optimizers) {
let key = `${name}:${fromProjectPathRelative(resolveFrom)}`;
devDepHashes +=
this.devDepRequests.get(key)?.hash ??
this.previousDevDeps.get(key) ??
'';
}
return devDepHashes;
}
async readFromCache(cacheKey: string): Promise<?{|
contents: Readable,
map: ?Readable,
|}> {
let contentKey = PackagerRunner.getContentKey(cacheKey);
let mapKey = PackagerRunner.getMapKey(cacheKey);
let isLargeBlob = await this.options.cache.hasLargeBlob(contentKey);
let contentExists =
isLargeBlob || (await this.options.cache.has(contentKey));
if (!contentExists) {
return null;
}
let mapExists = await this.options.cache.has(mapKey);
return {
contents: isLargeBlob
? this.options.cache.getStream(contentKey)
: blobToStream(await this.options.cache.getBlob(contentKey)),
map: mapExists
? blobToStream(await this.options.cache.getBlob(mapKey))
: null,
};
}
async writeToCache(
cacheKeys: CacheKeyMap,
type: string,
contents: Blob,
map: ?string,
): Promise<BundleInfo> {
let size = 0;
let hash;
let hashReferences = [];
let isLargeBlob = false;
// TODO: don't replace hash references in binary files??
if (contents instanceof Readable) {
isLargeBlob = true;
let boundaryStr = '';
let h = new Hash();
await this.options.cache.setStream(
cacheKeys.content,
blobToStream(contents).pipe(
new TapStream(buf => {
let str = boundaryStr + buf.toString();
hashReferences = hashReferences.concat(
str.match(HASH_REF_REGEX) ?? [],
);
size += buf.length;
h.writeBuffer(buf);
boundaryStr = str.slice(str.length - BOUNDARY_LENGTH);
}),
),
);
hash = h.finish();
} else if (typeof contents === 'string') {
let buffer = Buffer.from(contents);
size = buffer.byteLength;
hash = hashBuffer(buffer);
hashReferences = contents.match(HASH_REF_REGEX) ?? [];
await this.options.cache.setBlob(cacheKeys.content, buffer);
} else {
size = contents.length;
hash = hashBuffer(contents);
hashReferences = contents.toString().match(HASH_REF_REGEX) ?? [];
await this.options.cache.setBlob(cacheKeys.content, contents);
}
if (map != null) {
await this.options.cache.setBlob(cacheKeys.map, map);
}
let info = {
type,
size,
hash,
hashReferences,
cacheKeys,
isLargeBlob,
};
await this.options.cache.set(cacheKeys.info, info);
return info;
}
static getContentKey(cacheKey: string): string {
return hashString(`${cacheKey}:content`);
}
static getMapKey(cacheKey: string): string {
return hashString(`${cacheKey}:map`);
}
static getInfoKey(cacheKey: string): string {
return hashString(`${cacheKey}:info`);
}
}