/
yarn.ts
394 lines (361 loc) · 11.3 KB
/
yarn.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
import { parseSyml, stringifySyml } from '@yarnpkg/parsers';
import { stringify } from '@yarnpkg/lockfile';
import {
LockFileData,
PackageDependency,
PackageVersions,
} from './lock-file-type';
import { sortObject, hashString, isRootVersion } from './utils';
import { satisfies } from 'semver';
type LockFileDependencies = Record<
string,
Omit<PackageDependency, 'packageMeta'>
>;
const BERRY_LOCK_FILE_DISCLAIMER = `# This file was generated by Nx. Do not edit this file directly\n# Manual changes might be lost - proceed with caution!\n\n`;
/**
* Parses `yarn.lock` syml file and maps to {@link LockFileData}
*
* @param lockFile
* @returns
*/
export function parseYarnLockFile(lockFile: string): LockFileData {
const { __metadata, ...dependencies } = parseSyml(lockFile);
// Yarn Berry has workspace packages includes, so we need to extract those to metadata
const [mappedPackages, workspacePackages] = mapPackages(dependencies);
const isBerry = !!__metadata;
const hash = hashString(lockFile);
if (isBerry) {
return {
dependencies: mappedPackages,
lockFileMetadata: {
__metadata,
workspacePackages,
},
hash,
};
} else {
return { dependencies: mappedPackages, hash };
}
}
// map original yarn packages to the LockFileData structure
function mapPackages(
packages: LockFileDependencies
): [LockFileData['dependencies'], LockFileDependencies] {
const mappedPackages: LockFileData['dependencies'] = {};
const workspacePackages: LockFileDependencies = {};
Object.entries(packages).forEach(([keyExpr, value]) => {
// separate workspace packages from the external ones
// we only combine them back when stringifying
if (value.linkType === 'soft') {
workspacePackages[keyExpr] = value;
} else {
// key might be "@nrwl/somedep@1.2.3, @nrwl/somedep@^1.0.0..."
const keys = keyExpr.split(', ');
const packageName = keys[0].slice(0, keys[0].lastIndexOf('@'));
const newKey = `${packageName}@${value.version}`;
mappedPackages[packageName] = mappedPackages[packageName] || {};
if (!mappedPackages[packageName][newKey]) {
mappedPackages[packageName][newKey] = {
...value,
packageMeta: keys,
};
} else {
mappedPackages[packageName][newKey].packageMeta.push(...keys);
}
}
});
Object.keys(mappedPackages).forEach((packageName) => {
const versions = mappedPackages[packageName];
const versionKeys = Object.keys(versions);
if (versionKeys.length === 1) {
versions[versionKeys[0]].rootVersion = true;
} else {
const rootVersionKey = versionKeys.find((v) =>
isRootVersion(packageName, versions[v].version)
);
// this should never happen, but just in case
if (rootVersionKey) {
versions[rootVersionKey].rootVersion = true;
}
}
});
return [mappedPackages, workspacePackages];
}
/**
* Generates yarn.lock file from `LockFileData` object
*
* @param lockFileData
* @returns
*/
export function stringifyYarnLockFile(lockFileData: LockFileData): string {
// only berry's format has metadata defined
// this is an easy way to distinguish it from the classic
const isBerry = !!lockFileData.lockFileMetadata?.__metadata;
const dependencies = unmapPackages(lockFileData.dependencies, isBerry);
if (isBerry) {
const lockFile = {
__metadata: lockFileData.lockFileMetadata.__metadata,
...lockFileData.lockFileMetadata.workspacePackages,
...dependencies,
};
// berry's stringifySyml doesn't generate comment
return BERRY_LOCK_FILE_DISCLAIMER + stringifySyml(lockFile);
} else {
return stringify(dependencies);
}
}
// revert mapping of packages from LockFileData to the original JSON structure
// E.g. from:
// "abc": {
// "abc@1.2.3": {
// ...value
// packageMeta: ["abc@^1.0.0", "abc@~1.2.0"]
// }
// }
// to:
// "abc@^1.0.0, abc@~1.2.0": {
// ...value
// }
//
function unmapPackages(
dependencies: LockFileDependencies,
isBerry = false
): LockFileDependencies {
const packages: LockFileDependencies = {};
Object.values(dependencies).forEach((packageVersions) => {
Object.values(packageVersions).forEach((value) => {
const { packageMeta, rootVersion, ...rest } = value;
if (isBerry) {
// berry's `stringifySyml` does not combine packages
// we have to do it manually
packages[packageMeta.join(', ')] = rest;
} else {
// classic's `stringify` combines packages with same resolution
packageMeta.forEach((key) => {
packages[key] = rest;
});
}
});
});
return packages;
}
/**
* Returns matching version of the dependency
*/
export function transitiveDependencyYarnLookup(
packageName: string,
parentPackage: string,
versions: PackageVersions,
version: string
): string {
return Object.values(versions).find((v) =>
v.packageMeta.some((p) => p === `${packageName}@${version}`)
).version;
}
/**
* Prunes the lock file data based on the list of packages and their transitive dependencies
*
* @param lockFileData
* @returns
*/
export function pruneYarnLockFile(
lockFileData: LockFileData,
packages: string[]
): LockFileData {
const isBerry = !!lockFileData.lockFileMetadata?.__metadata;
const prunedDependencies = pruneDependencies(
lockFileData.dependencies,
packages
);
let prunedLockFileData: LockFileData;
if (isBerry) {
const { __metadata, workspacePackages } = lockFileData.lockFileMetadata;
prunedLockFileData = {
lockFileMetadata: {
__metadata,
workspacePackages: pruneWorkspacePackages(
workspacePackages,
prunedDependencies,
packages
),
},
dependencies: prunedDependencies,
hash: '',
};
} else {
prunedLockFileData = { dependencies: prunedDependencies, hash: '' };
}
prunedLockFileData.hash = hashString(JSON.stringify(prunedLockFileData));
return prunedLockFileData;
}
// iterate over packages to collect the affected tree of dependencies
function pruneDependencies(
dependencies: LockFileData['dependencies'],
packages: string[]
): LockFileData['dependencies'] {
const result: LockFileData['dependencies'] = {};
packages.forEach((packageName) => {
if (dependencies[packageName]) {
const [key, value] = Object.entries(dependencies[packageName]).find(
([, v]) => v.rootVersion
);
result[packageName] = result[packageName] || {};
result[packageName][key] = value;
pruneTransitiveDependencies(dependencies, result, value);
} else {
console.warn(
`Could not find ${packageName} in the lock file. Skipping...`
);
}
});
return result;
}
// find all transitive dependencies of already pruned packages
// and adds them to the collection
// recursively prunes their dependencies
function pruneTransitiveDependencies(
dependencies: LockFileData['dependencies'],
prunedDeps: LockFileData['dependencies'],
value: PackageDependency
): void {
if (!value.dependencies) {
return;
}
Object.entries(value.dependencies).forEach(([packageName, version]) => {
if (dependencies[packageName]) {
// check if package with given version exists in data
// if yes, return key, value and version expression from packageMeta
const dependencyTriplet = findDependencyTriplet(
dependencies[packageName],
packageName,
version
);
if (dependencyTriplet) {
const [key, { packageMeta, ...value }, metaVersion] = dependencyTriplet;
if (!prunedDeps[packageName]) {
prunedDeps[packageName] = {};
}
if (prunedDeps[packageName][key]) {
const packageMeta = prunedDeps[packageName][key].packageMeta;
if (packageMeta.indexOf(metaVersion) === -1) {
packageMeta.push(metaVersion);
packageMeta.sort();
}
} else {
prunedDeps[packageName][key] = {
...value,
packageMeta: [metaVersion],
};
// recurively collect dependencies
pruneTransitiveDependencies(
dependencies,
prunedDeps,
prunedDeps[packageName][key]
);
}
}
}
});
}
// prune dependencies of workspace packages from the lockFileMeta
function pruneWorkspacePackages(
workspacePackages: LockFileDependencies,
prunedDependencies: LockFileData['dependencies'],
packages: string[]
): LockFileDependencies {
const result: LockFileDependencies = {};
Object.entries(workspacePackages).forEach(
([packageKey, { dependencies, ...value }]) => {
const isRootPackage = packageKey.indexOf('@workspace:.') !== -1;
const prunedWorkspaceDependencies = pruneWorkspacePackageDependencies(
dependencies,
packages,
prunedDependencies,
isRootPackage
);
result[packageKey] = {
...value,
dependencies: sortObject(prunedWorkspaceDependencies),
};
}
);
return result;
}
function pruneWorkspacePackageDependencies(
dependencies: Record<string, string>,
packages: string[],
prunedDependencies: LockFileData['dependencies'],
isRoot: boolean
): Record<string, string> {
const result: Record<string, string> = {};
Object.entries(dependencies).forEach(
([packageName, packageVersion]: [string, string]) => {
if (
isPackageVersionMatch(
prunedDependencies[packageName],
packageName,
packageVersion
)
) {
result[packageName] = packageVersion;
}
}
);
// add all missing deps to root workspace package
if (isRoot) {
packages.forEach((p) => {
if (!result[p]) {
// extract first version expression from package's structure
const metaVersion = Object.values(prunedDependencies[p])[0]
.packageMeta[0] as string;
result[p] = metaVersion.split('@npm:')[1];
}
});
}
return result;
}
// check if package with given version exists in pruned dependencies
function isPackageVersionMatch(
packageVersions: PackageVersions,
packageName: string,
packageVersion: string
): boolean {
if (!packageVersions) {
return false;
}
const versionExpr = `${packageName}@${packageVersion}`;
const berryVersionExpr = `${packageName}@npm:${packageVersion}`;
const values = Object.values(packageVersions);
for (let i = 0; i < values.length; i++) {
if (
values[i].packageMeta.includes(versionExpr) ||
values[i].packageMeta.includes(berryVersionExpr)
) {
return true;
}
}
return false;
}
// find version of the package in LockFileData that matches given depVersion expression
// returns [package@version, packageValue, package@npm:version]
// for berry, the third parameter is different so we return it as well
function findDependencyTriplet(
dependency: PackageVersions,
packageName: string,
version: string
): [string, PackageDependency, string] {
const entries = Object.entries(dependency);
for (let i = 0; i < entries.length; i++) {
const [key, value] = entries[i];
let metaVersion = `${packageName}@${version}`;
if (value.packageMeta.includes(metaVersion)) {
return [key, value, metaVersion];
}
// for berry, meta version starts with 'npm:'
metaVersion = `${packageName}@npm:${version}`;
if (value.packageMeta.includes(metaVersion)) {
return [key, value, metaVersion];
}
}
return;
}