/
npm.ts
809 lines (739 loc) · 21.3 KB
/
npm.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
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
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
import { existsSync } from 'fs';
import { satisfies } from 'semver';
import { readJsonFile } from '../utils/fileutils';
import { output } from '../utils/output';
import { joinPathFragments } from '../utils/path';
import { workspaceRoot } from '../utils/workspace-root';
import { LockFileData, PackageDependency } from './utils/lock-file-type';
import { TransitiveLookupFunctionInput } from './utils/mapping';
import { hashString, generatePrunnedHash } from './utils/hashing';
import type { PackageJsonDeps } from './utils/pruning';
type PackageMeta = {
path: string;
optional?: boolean;
dev?: boolean;
[key: string]: any;
};
type Dependencies = Record<string, Omit<PackageDependency, 'packageMeta'>>;
type NpmDependency = {
version: string;
resolved: string;
integrity: string;
requires?: Record<string, string>;
dependencies?: Record<string, NpmDependency>;
dev?: boolean;
peer?: boolean;
devOptional?: boolean;
optional?: boolean;
};
/**
* Lock file version differences:
* - v1 has only dependencies
* - v2 has dependencies and packages for backwards compatibility
* - v3 has only packages
*/
type NpmLockFile = {
name?: string;
lockfileVersion: number;
requires?: boolean;
packages?: Record<string, NpmDependency>;
dependencies?: Record<string, NpmDependency>;
};
/**
* Parses package-lock.json file to `LockFileData` object
*
* @param lockFile
* @returns
*/
export function parseNpmLockFile(lockFile: string): LockFileData {
const { packages, dependencies, ...metadata } = JSON.parse(
lockFile
) as NpmLockFile;
return {
dependencies: mapPackages(dependencies, packages, metadata.lockfileVersion),
lockFileMetadata: {
metadata,
...(packages && { rootPackage: packages[''] }),
},
hash: hashString(lockFile),
};
}
// Maps /node_modules/@abc/def with version 1.2.3 => @abc/def > @abc/dev@1.2.3
function mapPackages(
dependencies: Record<string, NpmDependency>,
packages: Record<string, NpmDependency>,
lockfileVersion: number
): LockFileData['dependencies'] {
const mappedPackages: LockFileData['dependencies'] = {};
if (lockfileVersion === 1) {
Object.entries(dependencies).forEach(([packageName, value]) => {
const { newKey, packagePath } = prepareDependency(
packageName,
value,
mappedPackages
);
mapPackageDependency(
mappedPackages,
packageName,
newKey,
packagePath,
value,
lockfileVersion,
true
);
// we need to map the nested dependencies recursively
mapPackageDependencies(
mappedPackages,
value.dependencies,
packagePath,
lockfileVersion
);
});
} else {
Object.entries(packages).forEach(([packagePath, value]) => {
// we parse root package.json separately
if (packagePath !== '') {
const packageName = packagePath.split('node_modules/').pop();
const { newKey } = prepareDependency(
packageName,
value,
mappedPackages,
undefined,
packagePath
);
let dependency;
if (lockfileVersion === 2) {
const path = packagePath.split(/\/?node_modules\//).slice(1);
path.forEach((proj) => {
if (!dependency) {
dependency = dependencies[proj];
} else {
dependency = dependency.dependencies[proj];
}
});
// if versions are same, no need to track it further
if (dependency && value.version === dependency.version) {
dependency = undefined;
}
}
mapPackageDependency(
mappedPackages,
packageName,
newKey,
packagePath,
value,
lockfileVersion,
undefined,
dependency
);
}
});
}
return mappedPackages;
}
function prepareDependency(
packageName: string,
dependency: NpmDependency,
mappedPackages: LockFileData['dependencies'],
pathPrefix: string = '',
path?: string
) {
mappedPackages[packageName] = mappedPackages[packageName] || {};
const version = dependency.integrity
? dependency.version
: dependency.resolved;
const newKey = packageName + '@' + version;
const packagePath =
path || pathPrefix
? `${pathPrefix}/node_modules/${packageName}`
: `node_modules/${packageName}`;
return { newKey, packagePath };
}
function mapPackageDependency(
mappedPackages: LockFileData['dependencies'],
packageName: string,
key: string,
packagePath: string,
value: NpmDependency | Omit<PackageDependency, 'packageMeta'>,
lockfileVersion: number,
isRootVersion?: boolean,
dependencyValue?: NpmDependency
) {
const { dev, peer, optional } = value;
const packageMeta = {
path: packagePath,
dev,
peer,
optional,
};
const rootVersion =
isRootVersion ?? packagePath.split('/node_modules/').length === 1;
if (!mappedPackages[packageName][key] || rootVersion) {
// const packageDependencies = lockfileVersion === 1 ? requires : dependencies;
if (lockfileVersion === 1) {
const { requires, ...rest } = value;
if (requires) {
rest.dependencies = requires;
}
value = rest;
}
mappedPackages[packageName][key] = {
...(value as Omit<PackageDependency, 'packageMeta'>),
...(!value.integrity &&
value.version && {
actualVersion: value.version,
version: value.resolved,
}),
...(value.integrity &&
dependencyValue && {
actualVersion: value.version,
version: dependencyValue.version,
}),
...(dependencyValue && { dependencyValue }),
packageMeta: [],
rootVersion,
};
}
mappedPackages[packageName][key].packageMeta.push(packageMeta);
}
function mapPackageDependencies(
mappedPackages: LockFileData['dependencies'],
dependencies: Record<string, NpmDependency>,
parentPath: string,
lockfileVersion: number
): void {
if (!dependencies) {
return;
}
Object.entries(dependencies).forEach(([packageName, value]) => {
const { newKey, packagePath } = prepareDependency(
packageName,
value,
mappedPackages,
parentPath
);
mapPackageDependency(
mappedPackages,
packageName,
newKey,
packagePath,
value,
lockfileVersion,
false
);
mapPackageDependencies(
mappedPackages,
value.dependencies,
packagePath,
lockfileVersion
);
});
}
/**
* Generates package-lock.json file from `LockFileData` object
*
* @param lockFile
* @returns
*/
export function stringifyNpmLockFile(lockFileData: LockFileData): string {
const notV1 = lockFileData.lockFileMetadata.metadata.lockfileVersion > 1;
const notV3 = lockFileData.lockFileMetadata.metadata.lockfileVersion < 3;
// initialize the lockfile collections
const dependencies = {};
const packages: Dependencies = {
...(notV1 && { '': lockFileData.lockFileMetadata.rootPackage }),
};
const keys = Object.keys(lockFileData.dependencies);
for (let i = 0; i < keys.length; i++) {
const packageName = keys[i];
const packageVersions = lockFileData.dependencies[packageName];
const values = Object.values(packageVersions);
values.forEach((value) => {
if (notV1) {
unmapPackage(packages, value);
}
if (notV3) {
unmapDependencies(dependencies, packageName, value);
}
});
}
// generate package lock JSON
const lockFileJson: NpmLockFile = {
...lockFileData.lockFileMetadata.metadata,
...(notV1 && {
packages: sortObject(packages),
}),
...(notV3 && { dependencies: sortDependencies(dependencies) }),
};
return JSON.stringify(lockFileJson, null, 2) + '\n';
}
function sortObject(packages: Dependencies): Dependencies | undefined {
const keys = Object.keys(packages);
if (keys.length === 0) {
return;
}
keys.sort((a, b) => a.localeCompare(b));
const result: Dependencies = {};
keys.forEach((key) => {
result[key] = packages[key];
});
return result;
}
// remapping the package back to package-lock format
function unmapPackage(packages: Dependencies, dependency: PackageDependency) {
const {
packageMeta,
rootVersion,
version,
actualVersion,
resolved,
integrity,
dev,
peer,
optional,
dependencyValue,
...value
} = dependency;
// we need to decompose value, to achieve particular field ordering
for (let i = 0; i < packageMeta.length; i++) {
const { path, dev, peer, optional } = packageMeta[i];
// we are sorting the properties to get as close as possible to the original package-lock.json
packages[path] = {
version: actualVersion || version,
resolved,
integrity,
dev,
peer,
optional,
...value,
};
}
}
function unmapDependencies(
dependencies: Record<string, NpmDependency>,
packageName: string,
{ packageMeta, ...value }: PackageDependency & { packageMeta: PackageMeta[] }
): void {
const { version, resolved, integrity, devOptional, dependencyValue, from } =
value;
for (let i = 0; i < packageMeta.length; i++) {
const { path, dev, optional, peer } = packageMeta[i];
const projectPath = path.split('node_modules/').slice(1);
const requires = unmapDependencyRequires(value);
const innerDeps = getProjectNodeAndEnsureParentHierarchy(
projectPath,
dependencies
);
// sorting fields to match package-lock structure
innerDeps[packageName] = dependencyValue || {
version,
resolved,
integrity,
from,
dev,
devOptional,
optional,
peer,
requires,
...innerDeps[packageName],
};
}
}
// generates/ensures entire parent hierarchy exists for the given project path
// returns pointer to last project in the path
function getProjectNodeAndEnsureParentHierarchy(
projects: string[],
dependencies: Record<string, NpmDependency>
) {
while (projects.length > 1) {
const parentName = projects.shift().replace(/\/$/, '');
if (!dependencies[parentName]) {
dependencies[parentName] = {} as NpmDependency;
}
if (!dependencies[parentName].dependencies) {
dependencies[parentName].dependencies = {};
}
dependencies = dependencies[parentName].dependencies;
}
return dependencies;
}
// combine dependencies and optionalDependencies into requires and sort them
function unmapDependencyRequires(
value: Omit<PackageDependency, 'packageMeta'>
): Record<string, string> {
if (!value.dependencies && !value.optionalDependencies) {
return undefined;
}
const dependencies = {
...(value.dependencies || {}),
...(value.optionalDependencies || {}),
};
const sortedKeys = Object.keys(dependencies).sort((a, b) =>
a.localeCompare(b)
);
const result = {};
for (let i = 0; i < sortedKeys.length; i++) {
const key = sortedKeys[i];
result[key] = dependencies[key];
}
return result;
}
// recursively sort dependencies
function sortDependencies(
unsortedDependencies: Record<string, NpmDependency>
): Record<string, NpmDependency> {
const dependencies = {};
const sortedKeys = Object.keys(unsortedDependencies).sort((a, b) =>
a.localeCompare(b)
);
for (let i = 0; i < sortedKeys.length; i++) {
const value = unsortedDependencies[sortedKeys[i]];
dependencies[sortedKeys[i]] = value;
if (value.dependencies) {
value.dependencies = sortDependencies(value.dependencies);
}
}
return dependencies;
}
/**
* Returns matching version of the dependency
*/
export function transitiveDependencyNpmLookup({
packageName,
parentPackages,
versions,
version,
}: TransitiveLookupFunctionInput): PackageDependency {
const packageDependencies = Object.values(versions);
for (let i = 0; i < packageDependencies.length; i++) {
if (satisfies(packageDependencies[i].version, version)) {
const packageMeta = packageDependencies[i].packageMeta.find((p) =>
isPathMatching(p.path, packageName, parentPackages)
);
if (packageMeta) {
return {
...packageDependencies[i],
packageMeta: [packageMeta],
};
}
}
}
// otherwise return the root version
return Object.values(versions).find((v) => v.rootVersion);
}
function isPathMatching(
path: string,
packageName: string,
parentPackages: string[]
): boolean {
const packages = path.split(/\/?node_modules\//).slice(1);
if (packages[packages.length - 1] !== packageName) {
return false;
}
const locations = parentPackages
.map((p) => packages.indexOf(p))
.filter((p) => p !== -1);
if (locations.length === 0) {
return false;
}
for (let i = 0; i < locations.length - 2; i++) {
if (locations[i] > locations[i + 1]) {
return false;
}
}
return true;
}
/**
* Prunes the lock file data based on the list of packages and their transitive dependencies
*
* @param lockFileData
* @returns
*/
export function pruneNpmLockFile(
lockFileData: LockFileData,
normalizedPackageJson: PackageJsonDeps
): LockFileData {
const isV1 = lockFileData.lockFileMetadata.metadata.lockfileVersion === 1;
// NPM V1 does not track full dependency list in the lock file,
// so we can't reuse the lock file to generate a new one
if (isV1) {
output.warn({
title: 'Pruning v1 lock file',
bodyLines: [
`If your "node_modules" are not in sync with the lock file, you might get inaccurate results.`,
`Run "npm ci" to ensure your installed packages are synchronized or upgrade to NPM v7+ to benefit from the new lock file format`,
],
});
}
const dependencies = pruneDependencies(
lockFileData.dependencies,
normalizedPackageJson,
isV1
);
const lockFileMetadata = {
...lockFileData.lockFileMetadata,
...pruneRootPackage(lockFileData, normalizedPackageJson),
};
let prunedLockFileData: LockFileData;
prunedLockFileData = {
dependencies,
lockFileMetadata,
hash: generatePrunnedHash(lockFileData.hash, normalizedPackageJson),
};
return prunedLockFileData;
}
function pruneRootPackage(
lockFileData: LockFileData,
{ name, version, license, ...dependencyInfo }: PackageJsonDeps
): Record<string, any> {
if (lockFileData.lockFileMetadata.metadata.lockfileVersion === 1) {
return undefined;
}
const rootPackage = {
name: name || lockFileData.lockFileMetadata.rootPackage.name,
version: version || lockFileData.lockFileMetadata.rootPackage.version,
...(lockFileData.lockFileMetadata.rootPackage.license && {
license: license || lockFileData.lockFileMetadata.rootPackage.license,
}),
...dependencyInfo,
};
return { rootPackage };
}
type PeerDepsInfo = Record<
string,
{
parentPackages: string[];
dependency: PackageDependency;
packageMeta: PackageMeta;
packageName: string;
key: string;
}
>;
// iterate over packages to collect the affected tree of dependencies
function pruneDependencies(
dependencies: LockFileData['dependencies'],
normalizedPackageJson: PackageJsonDeps,
isV1?: boolean
): LockFileData['dependencies'] {
const result: LockFileData['dependencies'] = {};
const peerDependenciesToPrune: PeerDepsInfo = {};
Object.keys({
...normalizedPackageJson.dependencies,
...normalizedPackageJson.devDependencies,
...normalizedPackageJson.peerDependencies,
}).forEach((packageName) => {
if (dependencies[packageName]) {
const [key, { packageMeta, dev: _d, peer: _p, optional: _o, ...value }] =
Object.entries(dependencies[packageName]).find(
([_, v]) => v.rootVersion
);
const dev = normalizedPackageJson.devDependencies?.[packageName];
const peer = normalizedPackageJson.peerDependencies?.[packageName];
const optional =
normalizedPackageJson.peerDependenciesMeta?.[packageName]?.optional;
const modifier = peer
? 'peer'
: optional
? 'optional'
: dev
? 'dev'
: undefined;
result[packageName] = result[packageName] || {};
result[packageName][key] = Object.assign(value, {
packageMeta: [
{
path: `node_modules/${packageName}`,
...(dev ? { dev } : {}),
...(optional ? { optional } : {}),
...(peer ? { peer } : {}),
},
],
});
pruneTransitiveDependencies(
[packageName],
dependencies,
result,
result[packageName][key],
isV1,
modifier,
peerDependenciesToPrune
);
} else {
console.warn(
`Could not find ${packageName} in the lock file. Skipping...`
);
}
});
// add all peer dependencies
Object.values(peerDependenciesToPrune).forEach(
({ parentPackages, dependency, packageMeta, packageName, key }) => {
addPrunedDependency(
parentPackages,
dependencies,
result,
dependency,
packageMeta,
packageName,
key,
isV1
);
}
);
return result;
}
// find all transitive dependencies of already pruned packages
// and adds them to the collection
// recursively prune their dependencies
function pruneTransitiveDependencies(
parentPackages: string[],
dependencies: LockFileData['dependencies'],
prunedDeps: LockFileData['dependencies'],
value: PackageDependency,
isV1?: boolean,
modifier?: 'dev' | 'optional' | 'peer',
peerDependenciesToPrune?: PeerDepsInfo
): void {
let packageJSON: PackageDependency;
if (isV1) {
const pathToPackageJSON = joinPathFragments(
workspaceRoot,
value.packageMeta[0].path,
'package.json'
);
// if node_modules are our of sync with lock file, we might not have the package.json
if (existsSync(pathToPackageJSON)) {
packageJSON = readJsonFile(pathToPackageJSON);
}
}
if (
!value.dependencies &&
!value.peerDependencies &&
!packageJSON?.peerDependencies
) {
return;
}
Object.entries({
...value.dependencies,
...value.peerDependencies,
...value.optionalDependencies,
...packageJSON?.peerDependencies,
}).forEach(([packageName, version]: [string, string]) => {
const versions = dependencies[packageName];
if (versions) {
const dependency = transitiveDependencyNpmLookup({
packageName,
parentPackages,
versions,
version,
});
if (dependency) {
// dev/optional/peer dependencies can be changed during the pruning process
// so we need to update them
if (!prunedDeps[packageName]) {
prunedDeps[packageName] = {};
}
const key = `${packageName}@${dependency.version}`;
const packageMeta = setPackageMetaModifiers(
packageName,
dependency,
packageJSON || value,
modifier
);
// initially will collect only non-peer dependencies
// this gives priority to direct dependencies over peer ones
if (
peerDependenciesToPrune &&
(value.peerDependencies?.[packageName] ||
packageJSON?.peerDependencies?.[packageName])
) {
peerDependenciesToPrune[key] = peerDependenciesToPrune[key] || {
parentPackages,
dependency,
packageMeta,
packageName,
key,
};
return;
}
addPrunedDependency(
parentPackages,
dependencies,
prunedDeps,
dependency,
packageMeta,
packageName,
key,
isV1,
peerDependenciesToPrune
);
}
}
});
}
function addPrunedDependency(
parentPackages,
dependencies: LockFileData['dependencies'],
prunedDeps: LockFileData['dependencies'],
dependency: PackageDependency,
packageMeta: PackageMeta,
packageName: string,
key: string,
isV1?: boolean,
peerDependenciesToPrune?: PeerDepsInfo
) {
if (prunedDeps[packageName][key]) {
const currentMeta = prunedDeps[packageName][key].packageMeta;
if (!currentMeta.find((p) => p.path === dependency.packageMeta[0].path)) {
currentMeta.push(packageMeta);
currentMeta.sort();
}
} else {
dependency.packageMeta = [packageMeta];
prunedDeps[packageName][key] = dependency;
// recurively collect dependencies
pruneTransitiveDependencies(
[...parentPackages, packageName],
dependencies,
prunedDeps,
prunedDeps[packageName][key],
isV1,
getModifier(packageMeta),
peerDependenciesToPrune
);
}
}
function getModifier(
packageMeta: PackageMeta
): 'dev' | 'optional' | 'peer' | undefined {
if (packageMeta.dev) {
return 'dev';
} else if (packageMeta.optional) {
return 'optional';
} else if (packageMeta.peer) {
return 'peer';
}
}
function setPackageMetaModifiers(
packageName: string,
dependency: PackageDependency,
parent: PackageDependency,
modifier?: 'dev' | 'optional' | 'peer'
): PackageMeta {
const packageMeta: PackageMeta = { path: dependency.packageMeta[0].path };
if (parent.devDependencies?.[packageName]) {
packageMeta.dev = true;
} else if (parent.optionalDependencies?.[packageName]) {
packageMeta.optional = true;
} else if (parent.peerDependencies?.[packageName]) {
packageMeta.peer = true;
} else if (modifier === 'dev') {
packageMeta.dev = true;
} else if (modifier === 'optional') {
packageMeta.optional = true;
}
// peer is carried over from the parent
if (modifier === 'peer') {
packageMeta.peer = true;
}
return packageMeta;
}