-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
package-hoister.js
664 lines (538 loc) · 19 KB
/
package-hoister.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
/* @flow */
import type PackageResolver from './package-resolver.js';
import type Config from './config.js';
import type {Manifest} from './types.js';
import {sortAlpha} from './util/misc.js';
const invariant = require('invariant');
const path = require('path');
type Parts = Array<string>;
let historyCounter = 0;
export class HoistManifest {
constructor(
key: string,
parts: Parts,
pkg: Manifest,
loc: string,
isDirectRequire: boolean,
isRequired: boolean,
isIncompatible: boolean,
) {
this.isDirectRequire = isDirectRequire;
this.isRequired = isRequired;
this.isIncompatible = isIncompatible;
this.loc = loc;
this.pkg = pkg;
this.key = key;
this.parts = parts;
this.originalKey = key;
this.previousKeys = [];
this.history = [];
this.addHistory(`Start position = ${key}`);
}
isRequired: boolean;
isIncompatible: boolean;
isDirectRequire: boolean;
pkg: Manifest;
loc: string;
parts: Parts;
previousKeys: Array<string>;
history: Array<string>;
key: string;
originalKey: string;
addHistory(msg: string) {
this.history.push(`${++historyCounter}: ${msg}`);
}
}
export default class PackageHoister {
constructor(config: Config, resolver: PackageResolver, {ignoreOptional}: {ignoreOptional: ?boolean} = {}) {
this.resolver = resolver;
this.config = config;
this.ignoreOptional = ignoreOptional;
this.taintedKeys = new Map();
this.levelQueue = [];
this.tree = new Map();
}
resolver: PackageResolver;
config: Config;
ignoreOptional: ?boolean;
levelQueue: Array<[string, HoistManifest]>;
tree: Map<string, HoistManifest>;
taintedKeys: Map<string, HoistManifest>;
/**
* Taint this key and prevent any modules from being hoisted to it.
*/
taintKey(key: string, info: HoistManifest): boolean {
const existingTaint = this.taintedKeys.get(key);
if (existingTaint && existingTaint.loc !== info.loc) {
return false;
} else {
this.taintedKeys.set(key, info);
return true;
}
}
/**
* Implode an array of ancestry parts into a key.
*/
implodeKey(parts: Parts): string {
return parts.join('#');
}
/**
* Seed the hoister with patterns taken from the included resolver.
*/
seed(patterns: Array<string>) {
this.prepass(patterns);
for (const pattern of this.resolver.dedupePatterns(patterns)) {
this._seed(pattern, {isDirectRequire: true});
}
while (true) {
let queue = this.levelQueue;
if (!queue.length) {
this._propagateRequired();
return;
}
this.levelQueue = [];
// sort queue to get determinism between runs
queue = queue.sort(([aPattern], [bPattern]) => {
return sortAlpha(aPattern, bPattern);
});
// sort the queue again to hoist packages without peer dependencies first
let sortedQueue = [];
const availableSet = new Set();
let hasChanged = true;
while (queue.length > 0 && hasChanged) {
hasChanged = false;
for (let t = 0; t < queue.length; ++t) {
const pattern = queue[t][0];
const pkg = this.resolver.getStrictResolvedPattern(pattern);
const peerDependencies = Object.keys(pkg.peerDependencies || {});
const areDependenciesFulfilled = peerDependencies.every(peerDependency => availableSet.has(peerDependency));
if (areDependenciesFulfilled) {
// Move the package inside our sorted queue
sortedQueue.push(queue[t]);
queue.splice(t--, 1);
// Add it to our set, so that we know it is available
availableSet.add(pattern);
// Schedule a next pass, in case other packages had peer dependencies on this one
hasChanged = true;
}
}
}
// We might end up with some packages left in the queue, that have not been sorted. We reach this codepath if two
// packages have a cyclic dependency, or if the peer dependency is provided by a parent package. In these case,
// nothing we can do, so we just add all of these packages to the end of the sorted queue.
sortedQueue = sortedQueue.concat(queue);
for (const [pattern, parent] of sortedQueue) {
const info = this._seed(pattern, {isDirectRequire: false, parent});
if (info) {
this.hoist(info);
}
}
}
}
/**
* Seed the hoister with a specific pattern.
*/
_seed(
pattern: string,
{isDirectRequire, parent}: {isDirectRequire: boolean, parent?: HoistManifest},
): ?HoistManifest {
//
const pkg = this.resolver.getStrictResolvedPattern(pattern);
const ref = pkg._reference;
invariant(ref, 'expected reference');
//
let parentParts: Parts = [];
const isIncompatible = ref.incompatible;
const isMarkedAsOptional = ref.optional && this.ignoreOptional;
let isRequired = isDirectRequire && !ref.ignore && !isIncompatible && !isMarkedAsOptional;
if (parent) {
if (!this.tree.get(parent.key)) {
return null;
}
// non ignored dependencies inherit parent's ignored status
// parent may transition from ignored to non ignored when hoisted if it is used in another non ignored branch
if (!isDirectRequire && !isIncompatible && parent.isRequired && !isMarkedAsOptional) {
isRequired = true;
}
parentParts = parent.parts;
}
//
const loc: string = this.config.generateHardModulePath(ref);
const parts = parentParts.concat(pkg.name);
const key: string = this.implodeKey(parts);
const info: HoistManifest = new HoistManifest(key, parts, pkg, loc, isDirectRequire, isRequired, isIncompatible);
//
this.tree.set(key, info);
this.taintKey(key, info);
//
for (const depPattern of ref.dependencies) {
this.levelQueue.push([depPattern, info]);
}
return info;
}
/**
* Propagate inherited ignore statuses from non-ignored to ignored packages
*/
_propagateRequired() {
//
const toVisit: Array<HoistManifest> = [];
// enumerate all non-ignored packages
for (const entry of this.tree.entries()) {
if (entry[1].isRequired) {
toVisit.push(entry[1]);
}
}
// visit them
while (toVisit.length) {
const info = toVisit.shift();
const ref = info.pkg._reference;
invariant(ref, 'expected reference');
for (const depPattern of ref.dependencies) {
const depinfo = this._lookupDependency(info, depPattern);
if (!depinfo) {
continue;
}
const isMarkedAsOptional = depinfo.pkg._reference && depinfo.pkg._reference.optional && this.ignoreOptional;
if (!depinfo.isRequired && !depinfo.isIncompatible && !isMarkedAsOptional) {
depinfo.isRequired = true;
depinfo.addHistory(`Mark as non-ignored because of usage by ${info.key}`);
toVisit.push(depinfo);
}
}
}
}
/**
* Looks up the package a dependency resolves to
*/
_lookupDependency(info: HoistManifest, depPattern: string): ?HoistManifest {
//
const pkg = this.resolver.getStrictResolvedPattern(depPattern);
const ref = pkg._reference;
invariant(ref, 'expected reference');
//
for (let i = info.parts.length; i >= 0; i--) {
const checkParts = info.parts.slice(0, i).concat(pkg.name);
const checkKey = this.implodeKey(checkParts);
const existing = this.tree.get(checkKey);
if (existing) {
return existing;
}
}
return null;
}
/**
* Find the highest position we can hoist this module to.
*/
getNewParts(
key: string,
info: HoistManifest,
parts: Parts,
): {
parts: Parts,
duplicate: boolean,
} {
let stepUp = false;
const fullKey = this.implodeKey(parts);
const stack = []; // stack of removed parts
const name = parts.pop();
for (let i = parts.length - 1; i >= 0; i--) {
const checkParts = parts.slice(0, i).concat(name);
const checkKey = this.implodeKey(checkParts);
info.addHistory(`Looked at ${checkKey} for a match`);
const existing = this.tree.get(checkKey);
if (existing) {
if (existing.loc === info.loc) {
// switch to non ignored if earlier deduped version was ignored (must be compatible)
if (!existing.isRequired && info.isRequired) {
existing.addHistory(`Deduped ${fullKey} to this item, marking as required`);
existing.isRequired = true;
} else {
existing.addHistory(`Deduped ${fullKey} to this item`);
}
return {parts: checkParts, duplicate: true};
} else {
// everything above will be shadowed and this is a conflict
info.addHistory(`Found a collision at ${checkKey}`);
break;
}
}
const existingTaint = this.taintedKeys.get(checkKey);
if (existingTaint && existingTaint.loc !== info.loc) {
info.addHistory(`Broken by ${checkKey}`);
break;
}
}
const peerDependencies = Object.keys(info.pkg.peerDependencies || {});
// remove redundant parts that wont collide
hoistLoop: while (parts.length) {
// we must not hoist a package higher than its peer dependencies
for (const peerDependency of peerDependencies) {
const checkParts = parts.concat(peerDependency);
const checkKey = this.implodeKey(checkParts);
info.addHistory(`Looked at ${checkKey} for a peer dependency match`);
const existing = this.tree.get(checkKey);
if (existing) {
info.addHistory(`Found a peer dependency requirement at ${checkKey}`);
break hoistLoop;
}
}
const checkParts = parts.concat(name);
const checkKey = this.implodeKey(checkParts);
//
const existing = this.tree.get(checkKey);
if (existing) {
stepUp = true;
break;
}
// check if we're trying to hoist ourselves to a previously unflattened module key,
// this will result in a conflict and we'll need to move ourselves up
if (key !== checkKey && this.taintedKeys.has(checkKey)) {
stepUp = true;
break;
}
//
stack.push(parts.pop());
}
//
parts.push(name);
//
const isValidPosition = (parts: Parts): boolean => {
const key = this.implodeKey(parts);
const existing = this.tree.get(key);
if (existing && existing.loc === info.loc) {
return true;
}
// ensure there's no taint or the taint is us
const existingTaint = this.taintedKeys.get(key);
if (existingTaint && existingTaint.loc !== info.loc) {
return false;
}
return true;
};
// we need to special case when we attempt to hoist to the top level as the `existing` logic
// wont be hit in the above `while` loop and we could conflict
if (!isValidPosition(parts)) {
stepUp = true;
}
// sometimes we need to step up to a parent module to install ourselves
while (stepUp && stack.length) {
info.addHistory(`Stepping up from ${this.implodeKey(parts)}`);
parts.pop(); // remove `name`
parts.push(stack.pop(), name);
if (isValidPosition(parts)) {
info.addHistory(`Found valid position ${this.implodeKey(parts)}`);
stepUp = false;
}
}
return {parts, duplicate: false};
}
/**
* Hoist all seeded patterns to their highest positions.
*/
hoist(info: HoistManifest) {
const {key: oldKey, parts: rawParts} = info;
// remove this item from the `tree` map so we can ignore it
this.tree.delete(oldKey);
const {parts, duplicate} = this.getNewParts(oldKey, info, rawParts.slice());
const newKey = this.implodeKey(parts);
if (duplicate) {
info.addHistory(`Satisfied from above by ${newKey}`);
this.declareRename(info, rawParts, parts);
return;
}
// update to the new key
if (oldKey === newKey) {
info.addHistory("Didn't hoist - conflicts above");
this.setKey(info, oldKey, rawParts);
return;
}
//
this.declareRename(info, rawParts, parts);
this.setKey(info, newKey, parts);
}
/**
* Declare that a module has been hoisted and update our internal references.
*/
declareRename(info: HoistManifest, oldParts: Array<string>, newParts: Array<string>) {
// go down the tree from our new position reserving our name
this.taintParents(info, oldParts.slice(0, -1), newParts.length - 1);
}
/**
* Crawl upwards through a list of ancestry parts and taint a package name.
*/
taintParents(info: HoistManifest, processParts: Array<string>, start: number) {
for (let i = start; i < processParts.length; i++) {
const parts = processParts.slice(0, i).concat(info.pkg.name);
const key = this.implodeKey(parts);
if (this.taintKey(key, info)) {
info.addHistory(`Tainted ${key} to prevent collisions`);
}
}
}
/**
* Update the key of a module and update our references.
*/
setKey(info: HoistManifest, newKey: string, parts: Array<string>) {
const oldKey = info.key;
info.key = newKey;
info.parts = parts;
this.tree.set(newKey, info);
if (oldKey === newKey) {
return;
}
info.previousKeys.push(newKey);
info.addHistory(`New position = ${newKey}`);
}
/**
* Perform a prepass and if there's multiple versions of the same package, hoist the one with
* the most dependents to the top.
*/
prepass(patterns: Array<string>) {
patterns = this.resolver.dedupePatterns(patterns).sort();
const visited: Map<
string,
Array<{
pkg: Manifest,
ancestry: Array<Manifest>,
pattern: string,
}>,
> = new Map();
const occurences: {
[packageName: string]: {
[version: string]: {
pattern: string,
occurences: Set<Manifest>,
},
},
} = {};
// visitor to be used inside add() to mark occurences of packages
const visitAdd = (pkg: Manifest, ancestry: Array<Manifest>, pattern: string) => {
const versions = (occurences[pkg.name] = occurences[pkg.name] || {});
const version = (versions[pkg.version] = versions[pkg.version] || {
occurences: new Set(),
pattern,
});
if (ancestry.length) {
version.occurences.add(ancestry[ancestry.length - 1]);
}
};
// add an occuring package to the above data structure
const add = (pattern: string, ancestry: Array<Manifest>, ancestryPatterns: Array<string>) => {
const pkg = this.resolver.getStrictResolvedPattern(pattern);
if (ancestry.indexOf(pkg) >= 0) {
// prevent recursive dependencies
return;
}
let visitedPattern = visited.get(pattern);
if (visitedPattern) {
// if a package has been visited before, simply increment occurrences of packages
// like last time this package was visited
visitedPattern.forEach(visitPkg => {
visitAdd(visitPkg.pkg, visitPkg.ancestry, visitPkg.pattern);
});
visitAdd(pkg, ancestry, pattern);
return;
}
const ref = pkg._reference;
invariant(ref, 'expected reference');
visitAdd(pkg, ancestry, pattern);
for (const depPattern of ref.dependencies) {
const depAncestry = ancestry.concat(pkg);
const depAncestryPatterns = ancestryPatterns.concat(depPattern);
add(depPattern, depAncestry, depAncestryPatterns);
}
visitedPattern = visited.get(pattern) || [];
visited.set(pattern, visitedPattern);
visitedPattern.push({pkg, ancestry, pattern});
ancestryPatterns.forEach(ancestryPattern => {
const visitedAncestryPattern = visited.get(ancestryPattern);
if (visitedAncestryPattern) {
visitedAncestryPattern.push({pkg, ancestry, pattern});
}
});
};
// get a list of root package names since we can't hoist other dependencies to these spots!
const rootPackageNames: Set<string> = new Set();
for (const pattern of patterns) {
const pkg = this.resolver.getStrictResolvedPattern(pattern);
rootPackageNames.add(pkg.name);
add(pattern, [], []);
}
for (const packageName of Object.keys(occurences).sort()) {
const versionOccurences = occurences[packageName];
const versions = Object.keys(versionOccurences);
if (versions.length === 1) {
// only one package type so we'll hoist this to the top anyway
continue;
}
if (this.tree.get(packageName)) {
// a transitive dependency of a previously hoisted dependency exists
continue;
}
if (rootPackageNames.has(packageName)) {
// can't replace top level packages
continue;
}
let mostOccurenceCount;
let mostOccurencePattern;
for (const version of Object.keys(versionOccurences).sort()) {
const {occurences, pattern} = versionOccurences[version];
const occurenceCount = occurences.size;
if (!mostOccurenceCount || occurenceCount > mostOccurenceCount) {
mostOccurenceCount = occurenceCount;
mostOccurencePattern = pattern;
}
}
invariant(mostOccurencePattern, 'expected most occuring pattern');
invariant(mostOccurenceCount, 'expected most occuring count');
// only hoist this module if it occured more than once
if (mostOccurenceCount > 1) {
this._seed(mostOccurencePattern, {isDirectRequire: false});
}
}
}
/**
* Produce a flattened list of module locations and manifests.
*/
init(): HoistManifestTuples {
const flatTree = [];
//
for (const [key, info] of this.tree.entries()) {
// decompress the location and push it to the flat tree. this path could be made
// up of modules from different registries so we need to handle this specially
const parts: Array<string> = [];
const keyParts = key.split('#');
for (let i = 0; i < keyParts.length; i++) {
const key = keyParts.slice(0, i + 1).join('#');
const hoisted = this.tree.get(key);
invariant(hoisted, 'expected hoisted manifest');
parts.push(this.config.getFolder(hoisted.pkg));
parts.push(keyParts[i]);
}
if (this.config.modulesFolder) {
// remove the first part which will be the folder name and replace it with a
// hardcoded modules folder
parts.splice(0, 1, this.config.modulesFolder);
} else {
// first part will be the registry-specific module folder
parts.splice(0, 0, this.config.lockfileFolder);
}
const loc = path.join(...parts);
flatTree.push([loc, info]);
}
// remove ignored modules from the tree
const visibleFlatTree = [];
for (const [loc, info] of flatTree) {
const ref = info.pkg._reference;
invariant(ref, 'expected reference');
if (!info.isRequired) {
info.addHistory('Deleted as this module was ignored');
} else {
visibleFlatTree.push([loc, info]);
}
}
return visibleFlatTree;
}
}
export type HoistManifestTuple = [string, HoistManifest];
export type HoistManifestTuples = Array<HoistManifestTuple>;