-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
AssetGraph.js
641 lines (578 loc) Β· 18.6 KB
/
AssetGraph.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
// @flow strict-local
import type {GraphVisitor} from '@parcel/types';
import type {
ContentGraphOpts,
ContentKey,
NodeId,
SerializedContentGraph,
} from '@parcel/graph';
import type {
Asset,
AssetGraphNode,
AssetGroup,
AssetGroupNode,
AssetNode,
Dependency,
DependencyNode,
Entry,
EntryFileNode,
EntrySpecifierNode,
Environment,
Target,
} from './types';
import invariant from 'assert';
import {hashString, Hash} from '@parcel/hash';
import {hashObject} from '@parcel/utils';
import nullthrows from 'nullthrows';
import {ContentGraph} from '@parcel/graph';
import {createDependency} from './Dependency';
import {type ProjectPath, fromProjectPathRelative} from './projectPath';
export const assetGraphEdgeTypes = {
null: 1,
// In addition to the null edge, a dependency can be connected to the asset containing the symbols
// that the dependency requested (after reexports were skipped).
redirected: 2,
};
export type AssetGraphEdgeType = $Values<typeof assetGraphEdgeTypes>;
type InitOpts = {|
entries?: Array<ProjectPath>,
targets?: Array<Target>,
assetGroups?: Array<AssetGroup>,
|};
type AssetGraphOpts = {|
...ContentGraphOpts<AssetGraphNode>,
symbolPropagationRan: boolean,
hash?: ?string,
|};
type SerializedAssetGraph = {|
...SerializedContentGraph<AssetGraphNode, AssetGraphEdgeType>,
hash?: ?string,
symbolPropagationRan: boolean,
|};
export function nodeFromDep(dep: Dependency): DependencyNode {
return {
id: dep.id,
type: 'dependency',
value: dep,
deferred: false,
excluded: false,
usedSymbolsDown: new Set(),
usedSymbolsUp: new Map(),
usedSymbolsDownDirty: true,
usedSymbolsUpDirtyDown: true,
usedSymbolsUpDirtyUp: true,
symbolTarget: null,
};
}
export function nodeFromAssetGroup(assetGroup: AssetGroup): AssetGroupNode {
return {
id: hashString(
fromProjectPathRelative(assetGroup.filePath) +
assetGroup.env.id +
String(assetGroup.isSource) +
String(assetGroup.sideEffects) +
(assetGroup.code ?? '') +
':' +
(assetGroup.pipeline ?? '') +
':' +
(assetGroup.query ?? ''),
),
type: 'asset_group',
value: assetGroup,
usedSymbolsDownDirty: true,
};
}
export function nodeFromAsset(asset: Asset): AssetNode {
return {
id: asset.id,
type: 'asset',
value: asset,
usedSymbols: new Set(),
usedSymbolsDownDirty: true,
usedSymbolsUpDirty: true,
};
}
export function nodeFromEntrySpecifier(entry: ProjectPath): EntrySpecifierNode {
return {
id: 'entry_specifier:' + fromProjectPathRelative(entry),
type: 'entry_specifier',
value: entry,
};
}
export function nodeFromEntryFile(entry: Entry): EntryFileNode {
return {
id: 'entry_file:' + hashObject(entry),
type: 'entry_file',
value: entry,
};
}
export default class AssetGraph extends ContentGraph<
AssetGraphNode,
AssetGraphEdgeType,
> {
onNodeRemoved: ?(nodeId: NodeId) => mixed;
hash: ?string;
envCache: Map<string, Environment>;
symbolPropagationRan: boolean;
constructor(opts: ?AssetGraphOpts) {
if (opts) {
let {hash, symbolPropagationRan, ...rest} = opts;
super(rest);
this.hash = hash;
this.symbolPropagationRan = symbolPropagationRan;
} else {
super();
this.setRootNodeId(
this.addNode({
id: '@@root',
type: 'root',
value: null,
}),
);
}
this.envCache = new Map();
this.symbolPropagationRan = false;
}
// $FlowFixMe[prop-missing]
static deserialize(opts: AssetGraphOpts): AssetGraph {
return new AssetGraph(opts);
}
// $FlowFixMe[prop-missing]
serialize(): SerializedAssetGraph {
return {
...super.serialize(),
hash: this.hash,
symbolPropagationRan: this.symbolPropagationRan,
};
}
// Deduplicates Environments by making them referentially equal
normalizeEnvironment(input: Asset | Dependency | AssetGroup) {
let {id, context} = input.env;
let idAndContext = `${id}-${context}`;
let env = this.envCache.get(idAndContext);
if (env) {
input.env = env;
} else {
this.envCache.set(idAndContext, input.env);
}
}
setRootConnections({entries, assetGroups}: InitOpts) {
let nodes = [];
if (entries) {
for (let entry of entries) {
let node = nodeFromEntrySpecifier(entry);
nodes.push(node);
}
} else if (assetGroups) {
nodes.push(
...assetGroups.map(assetGroup => nodeFromAssetGroup(assetGroup)),
);
}
this.replaceNodeIdsConnectedTo(
nullthrows(this.rootNodeId),
nodes.map(node => this.addNode(node)),
);
}
addNode(node: AssetGraphNode): NodeId {
this.hash = null;
let existing = this.getNodeByContentKey(node.id);
if (existing != null) {
invariant(existing.type === node.type);
// $FlowFixMe[incompatible-type] Checked above
// $FlowFixMe[prop-missing]
existing.value = node.value;
let existingId = this.getNodeIdByContentKey(node.id);
this.updateNode(existingId, existing);
return existingId;
}
return super.addNodeByContentKey(node.id, node);
}
removeNode(nodeId: NodeId): void {
this.hash = null;
this.onNodeRemoved && this.onNodeRemoved(nodeId);
// This needs to mark all connected nodes that doesn't become orphaned
// due to replaceNodesConnectedTo to make sure that the symbols of
// nodes from which at least one parent was removed are updated.
let node = nullthrows(this.getNode(nodeId));
if (this.isOrphanedNode(nodeId) && node.type === 'dependency') {
let children = this.getNodeIdsConnectedFrom(nodeId).map(id =>
nullthrows(this.getNode(id)),
);
for (let n of children) {
invariant(n.type === 'asset_group' || n.type === 'asset');
n.usedSymbolsDownDirty = true;
}
}
return super.removeNode(nodeId);
}
resolveEntry(
entry: ProjectPath,
resolved: Array<Entry>,
correspondingRequest: ContentKey,
) {
let entrySpecifierNodeId = this.getNodeIdByContentKey(
nodeFromEntrySpecifier(entry).id,
);
let entrySpecifierNode = nullthrows(this.getNode(entrySpecifierNodeId));
invariant(entrySpecifierNode.type === 'entry_specifier');
entrySpecifierNode.correspondingRequest = correspondingRequest;
this.replaceNodeIdsConnectedTo(
entrySpecifierNodeId,
resolved.map(file => this.addNode(nodeFromEntryFile(file))),
);
}
resolveTargets(
entry: Entry,
targets: Array<Target>,
correspondingRequest: string,
) {
let depNodes = targets.map(target => {
let node = nodeFromDep(
// The passed project path is ignored in this case, because there is no `loc`
createDependency('', {
specifier: fromProjectPathRelative(entry.filePath),
specifierType: 'esm', // ???
pipeline: target.pipeline,
target: target,
env: target.env,
isEntry: true,
needsStableName: true,
symbols: target.env.isLibrary
? new Map([['*', {local: '*', isWeak: true, loc: null}]])
: undefined,
}),
);
if (node.value.env.isLibrary) {
// in library mode, all of the entry's symbols are "used"
node.usedSymbolsDown.add('*');
}
return node;
});
let entryNodeId = this.getNodeIdByContentKey(nodeFromEntryFile(entry).id);
let entryNode = nullthrows(this.getNode(entryNodeId));
invariant(entryNode.type === 'entry_file');
entryNode.correspondingRequest = correspondingRequest;
this.replaceNodeIdsConnectedTo(
entryNodeId,
depNodes.map(node => this.addNode(node)),
);
}
resolveDependency(
dependency: Dependency,
assetGroup: ?AssetGroup,
correspondingRequest: string,
) {
let depNodeId = this.getNodeIdByContentKey(dependency.id);
let depNode = nullthrows(this.getNode(depNodeId));
invariant(depNode.type === 'dependency');
depNode.correspondingRequest = correspondingRequest;
if (!assetGroup) {
return;
}
let assetGroupNode = nodeFromAssetGroup(assetGroup);
let existing = this.getNodeByContentKey(assetGroupNode.id);
if (existing != null) {
invariant(existing.type === 'asset_group');
assetGroupNode.value.canDefer =
assetGroupNode.value.canDefer && existing.value.canDefer;
}
let assetGroupNodeId = this.addNode(assetGroupNode);
this.replaceNodeIdsConnectedTo(this.getNodeIdByContentKey(dependency.id), [
assetGroupNodeId,
]);
this.replaceNodeIdsConnectedTo(depNodeId, [assetGroupNodeId]);
}
shouldVisitChild(nodeId: NodeId, childNodeId: NodeId): boolean {
let node = nullthrows(this.getNode(nodeId));
let childNode = nullthrows(this.getNode(childNodeId));
if (
node.type !== 'dependency' ||
childNode.type !== 'asset_group' ||
childNode.deferred === false
) {
return true;
}
// Node types are proved above
let dependencyNode = node;
let assetGroupNode = childNode;
let {sideEffects, canDefer = true} = assetGroupNode.value;
let dependency = dependencyNode.value;
let dependencyPreviouslyDeferred = dependencyNode.hasDeferred;
let assetGroupPreviouslyDeferred = assetGroupNode.deferred;
let defer = this.shouldDeferDependency(dependency, sideEffects, canDefer);
dependencyNode.hasDeferred = defer;
assetGroupNode.deferred = defer;
if (!dependencyPreviouslyDeferred && defer) {
this.markParentsWithHasDeferred(nodeId);
} else if (assetGroupPreviouslyDeferred && !defer) {
this.unmarkParentsWithHasDeferred(childNodeId);
}
return !defer;
}
// Dependency: mark parent Asset <- AssetGroup with hasDeferred true
markParentsWithHasDeferred(nodeId: NodeId) {
this.traverseAncestors(nodeId, (traversedNodeId, _, actions) => {
let traversedNode = nullthrows(this.getNode(traversedNodeId));
if (traversedNode.type === 'asset') {
traversedNode.hasDeferred = true;
} else if (traversedNode.type === 'asset_group') {
traversedNode.hasDeferred = true;
actions.skipChildren();
} else if (nodeId !== traversedNodeId) {
actions.skipChildren();
}
});
}
// AssetGroup: update hasDeferred of all parent Dependency <- Asset <- AssetGroup
unmarkParentsWithHasDeferred(nodeId: NodeId) {
this.traverseAncestors(nodeId, (traversedNodeId, ctx, actions) => {
let traversedNode = nullthrows(this.getNode(traversedNodeId));
if (traversedNode.type === 'asset') {
let hasDeferred = this.getNodeIdsConnectedFrom(traversedNodeId).some(
childNodeId => {
let childNode = nullthrows(this.getNode(childNodeId));
return childNode.hasDeferred == null
? false
: childNode.hasDeferred;
},
);
if (!hasDeferred) {
delete traversedNode.hasDeferred;
}
return {hasDeferred};
} else if (
traversedNode.type === 'asset_group' &&
nodeId !== traversedNodeId
) {
if (!ctx?.hasDeferred) {
delete traversedNode.hasDeferred;
}
actions.skipChildren();
} else if (traversedNode.type === 'dependency') {
traversedNode.hasDeferred = false;
} else if (nodeId !== traversedNodeId) {
actions.skipChildren();
}
});
}
// Defer transforming this dependency if it is marked as weak, there are no side effects,
// no re-exported symbols are used by ancestor dependencies and the re-exporting asset isn't
// using a wildcard and isn't an entry (in library mode).
// This helps with performance building large libraries like `lodash-es`, which re-exports
// a huge number of functions since we can avoid even transforming the files that aren't used.
shouldDeferDependency(
dependency: Dependency,
sideEffects: ?boolean,
canDefer: boolean,
): boolean {
let defer = false;
let dependencySymbols = dependency.symbols;
if (
dependencySymbols &&
[...dependencySymbols].every(([, {isWeak}]) => isWeak) &&
sideEffects === false &&
canDefer &&
!dependencySymbols.has('*')
) {
let depNodeId = this.getNodeIdByContentKey(dependency.id);
let depNode = this.getNode(depNodeId);
invariant(depNode);
let assets = this.getNodeIdsConnectedTo(depNodeId);
let symbols = new Map(
[...dependencySymbols].map(([key, val]) => [val.local, key]),
);
invariant(assets.length === 1);
let firstAsset = nullthrows(this.getNode(assets[0]));
invariant(firstAsset.type === 'asset');
let resolvedAsset = firstAsset.value;
let deps = this.getIncomingDependencies(resolvedAsset);
defer = deps.every(
d =>
d.symbols &&
!(d.env.isLibrary && d.isEntry) &&
!d.symbols.has('*') &&
![...d.symbols.keys()].some(symbol => {
if (!resolvedAsset.symbols) return true;
let assetSymbol = resolvedAsset.symbols?.get(symbol)?.local;
return assetSymbol != null && symbols.has(assetSymbol);
}),
);
}
return defer;
}
resolveAssetGroup(
assetGroup: AssetGroup,
assets: Array<Asset>,
correspondingRequest: ContentKey,
) {
this.normalizeEnvironment(assetGroup);
let assetGroupNode = nodeFromAssetGroup(assetGroup);
assetGroupNode = this.getNodeByContentKey(assetGroupNode.id);
if (!assetGroupNode) {
return;
}
invariant(assetGroupNode.type === 'asset_group');
assetGroupNode.correspondingRequest = correspondingRequest;
let assetsByKey = new Map();
for (let asset of assets) {
if (asset.uniqueKey != null) {
assetsByKey.set(asset.uniqueKey, asset);
}
}
let dependentAssetKeys = new Set();
for (let asset of assets) {
for (let dep of asset.dependencies.values()) {
if (assetsByKey.has(dep.specifier)) {
dependentAssetKeys.add(dep.specifier);
}
}
}
let assetObjects: Array<{|
assetNodeId: NodeId,
dependentAssets: Array<Asset>,
|}> = [];
let assetNodeIds = [];
for (let asset of assets) {
this.normalizeEnvironment(asset);
let isDirect = !dependentAssetKeys.has(asset.uniqueKey);
let dependentAssets = [];
for (let dep of asset.dependencies.values()) {
let dependentAsset = assetsByKey.get(dep.specifier);
if (dependentAsset) {
dependentAssets.push(dependentAsset);
}
}
let id = this.addNode(nodeFromAsset(asset));
assetObjects.push({
assetNodeId: id,
dependentAssets,
});
if (isDirect) {
assetNodeIds.push(id);
}
}
this.replaceNodeIdsConnectedTo(
this.getNodeIdByContentKey(assetGroupNode.id),
assetNodeIds,
);
for (let {assetNodeId, dependentAssets} of assetObjects) {
// replaceNodesConnectedTo has merged the value into the existing node, retrieve
// the actual current node.
let assetNode = nullthrows(this.getNode(assetNodeId));
invariant(assetNode.type === 'asset');
this.resolveAsset(assetNode, dependentAssets);
}
}
resolveAsset(assetNode: AssetNode, dependentAssets: Array<Asset>) {
let depNodeIds: Array<NodeId> = [];
let depNodesWithAssets = [];
for (let dep of assetNode.value.dependencies.values()) {
this.normalizeEnvironment(dep);
let depNode = nodeFromDep(dep);
let existing = this.getNodeByContentKey(depNode.id);
if (
existing?.type === 'dependency' &&
existing.value.resolverMeta != null
) {
depNode.value.meta = {
...depNode.value.meta,
...existing.value.resolverMeta,
};
}
let dependentAsset = dependentAssets.find(
a => a.uniqueKey === dep.specifier,
);
if (dependentAsset) {
depNode.complete = true;
depNodesWithAssets.push([depNode, nodeFromAsset(dependentAsset)]);
}
depNode.value.sourceAssetType = assetNode.value.type;
depNodeIds.push(this.addNode(depNode));
}
assetNode.usedSymbolsDownDirty = true;
this.replaceNodeIdsConnectedTo(
this.getNodeIdByContentKey(assetNode.id),
depNodeIds,
);
for (let [depNode, dependentAssetNode] of depNodesWithAssets) {
let depAssetNodeId = this.addNode(dependentAssetNode);
this.replaceNodeIdsConnectedTo(this.getNodeIdByContentKey(depNode.id), [
depAssetNodeId,
]);
}
}
getIncomingDependencies(asset: Asset): Array<Dependency> {
let nodeId = this.getNodeIdByContentKey(asset.id);
let assetGroupIds = this.getNodeIdsConnectedTo(nodeId);
let dependencies = [];
for (let i = 0; i < assetGroupIds.length; i++) {
let assetGroupId = assetGroupIds[i];
// Sometimes assets are connected directly to dependencies
// rather than through an asset group. This happens due to
// inline dependencies on assets via uniqueKey. See resolveAsset.
let node = this.getNode(assetGroupId);
if (node?.type === 'dependency') {
dependencies.push(node.value);
continue;
}
let assetIds = this.getNodeIdsConnectedTo(assetGroupId);
for (let j = 0; j < assetIds.length; j++) {
let node = this.getNode(assetIds[j]);
if (!node || node.type !== 'dependency') {
continue;
}
dependencies.push(node.value);
}
}
return dependencies;
}
traverseAssets<TContext>(
visit: GraphVisitor<Asset, TContext>,
startNodeId: ?NodeId,
): ?TContext {
return this.filteredTraverse(
nodeId => {
let node = nullthrows(this.getNode(nodeId));
return node.type === 'asset' ? node.value : null;
},
visit,
startNodeId,
);
}
getEntryAssetGroupNodes(): Array<AssetGroupNode> {
let entryNodes = [];
this.traverse((nodeId, _, actions) => {
let node = nullthrows(this.getNode(nodeId));
if (node.type === 'asset_group') {
entryNodes.push(node);
actions.skipChildren();
}
});
return entryNodes;
}
getEntryAssets(): Array<Asset> {
let entries = [];
this.traverseAssets((asset, ctx, traversal) => {
entries.push(asset);
traversal.skipChildren();
});
return entries;
}
getHash(): string {
if (this.hash != null) {
return this.hash;
}
let hash = new Hash();
// TODO: sort??
this.traverse(nodeId => {
let node = nullthrows(this.getNode(nodeId));
if (node.type === 'asset') {
hash.writeString(nullthrows(node.value.outputHash));
} else if (node.type === 'dependency' && node.value.target) {
hash.writeString(JSON.stringify(node.value.target));
}
});
this.hash = hash.finish();
return this.hash;
}
}