/
index.ts
419 lines (385 loc) · 14.6 KB
/
index.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
import path from 'path'
import { WANTED_LOCKFILE } from '@pnpm/constants'
import PnpmError from '@pnpm/error'
import {
packageManifestLogger,
} from '@pnpm/core-loggers'
import {
Lockfile,
ProjectSnapshot,
} from '@pnpm/lockfile-types'
import {
getAllDependenciesFromManifest,
getSpecFromPackageManifest,
PinnedVersion,
} from '@pnpm/manifest-utils'
import { safeReadPackageFromDir as safeReadPkgFromDir } from '@pnpm/read-package-json'
import {
DEPENDENCIES_FIELDS,
DependencyManifest,
ProjectManifest,
Registries,
} from '@pnpm/types'
import promiseShare from 'promise-share'
import difference from 'ramda/src/difference'
import getWantedDependencies, { WantedDependency } from './getWantedDependencies'
import depPathToRef from './depPathToRef'
import resolveDependencyTree, {
Importer,
LinkedDependency,
ResolveDependenciesOptions,
ResolvedDirectDependency,
ResolvedPackage,
} from './resolveDependencyTree'
import resolvePeers, {
GenericDependenciesGraph,
GenericDependenciesGraphNode,
} from './resolvePeers'
import toResolveImporter from './toResolveImporter'
import updateLockfile from './updateLockfile'
import updateProjectManifest from './updateProjectManifest'
export type DependenciesGraph = GenericDependenciesGraph<ResolvedPackage>
export type DependenciesGraphNode = GenericDependenciesGraphNode & ResolvedPackage
export {
getWantedDependencies,
LinkedDependency,
ResolvedPackage,
PinnedVersion,
WantedDependency,
}
interface ProjectToLink {
binsDir: string
directNodeIdsByAlias: {[alias: string]: string}
id: string
linkedDependencies: LinkedDependency[]
manifest: ProjectManifest
modulesDir: string
rootDir: string
topParents: Array<{name: string, version: string}>
}
export type ImporterToResolve = Importer<{
isNew?: boolean
nodeExecPath?: string
pinnedVersion?: PinnedVersion
raw: string
updateSpec?: boolean
}>
& {
binsDir: string
manifest: ProjectManifest
originalManifest?: ProjectManifest
updatePackageManifest: boolean
}
export default async function (
importers: ImporterToResolve[],
opts: ResolveDependenciesOptions & {
defaultUpdateDepth: number
preserveWorkspaceProtocol: boolean
saveWorkspaceProtocol: 'rolling' | boolean
lockfileIncludeTarballUrl?: boolean
}
) {
const _toResolveImporter = toResolveImporter.bind(null, {
defaultUpdateDepth: opts.defaultUpdateDepth,
lockfileOnly: opts.dryRun,
preferredVersions: opts.preferredVersions,
updateAll: Boolean(opts.updateMatching),
virtualStoreDir: opts.virtualStoreDir,
workspacePackages: opts.workspacePackages,
})
const projectsToResolve = await Promise.all(importers.map(async (project) => _toResolveImporter(project)))
const {
dependenciesTree,
outdatedDependencies,
resolvedImporters,
resolvedPackagesByDepPath,
wantedToBeSkippedPackageIds,
appliedPatches,
time,
} = await resolveDependencyTree(projectsToResolve, opts)
// We only check whether patches were applied in cases when the whole lockfile was reanalyzed.
if (
opts.patchedDependencies &&
(opts.forceFullResolution || !opts.wantedLockfile.packages?.length) &&
Object.keys(opts.wantedLockfile.importers).length === importers.length
) {
verifyPatches(Object.keys(opts.patchedDependencies), appliedPatches)
}
const linkedDependenciesByProjectId: Record<string, LinkedDependency[]> = {}
const projectsToLink = await Promise.all<ProjectToLink>(projectsToResolve.map(async (project, index) => {
const resolvedImporter = resolvedImporters[project.id]
linkedDependenciesByProjectId[project.id] = resolvedImporter.linkedDependencies
let updatedManifest: ProjectManifest | undefined = project.manifest
let updatedOriginalManifest: ProjectManifest | undefined = project.originalManifest
if (project.updatePackageManifest) {
const manifests = await updateProjectManifest(project, {
directDependencies: resolvedImporter.directDependencies,
preserveWorkspaceProtocol: opts.preserveWorkspaceProtocol,
saveWorkspaceProtocol: opts.saveWorkspaceProtocol,
})
updatedManifest = manifests[0]
updatedOriginalManifest = manifests[1]
} else {
packageManifestLogger.debug({
prefix: project.rootDir,
updated: project.manifest,
})
}
if (updatedManifest != null) {
if (opts.autoInstallPeers) {
if (updatedManifest.peerDependencies) {
const allDeps = getAllDependenciesFromManifest(updatedManifest)
for (const [peerName, peerRange] of Object.entries(updatedManifest.peerDependencies)) {
if (allDeps[peerName]) continue
updatedManifest.dependencies ??= {}
updatedManifest.dependencies[peerName] = peerRange
}
}
}
const projectSnapshot = opts.wantedLockfile.importers[project.id]
opts.wantedLockfile.importers[project.id] = addDirectDependenciesToLockfile(
updatedManifest,
projectSnapshot,
resolvedImporter.linkedDependencies,
resolvedImporter.directDependencies,
opts.registries,
opts.autoInstallPeers
)
}
const topParents: Array<{ name: string, version: string, linkedDir?: string }> = project.manifest
? await getTopParents(
difference(
Object.keys(getAllDependenciesFromManifest(project.manifest)),
resolvedImporter.directDependencies
.filter((dep, index) => project.wantedDependencies[index]?.isNew === true)
.map(({ alias }) => alias) || []
),
project.modulesDir
)
: []
resolvedImporter.linkedDependencies.forEach((linkedDependency) => {
topParents.push({
name: linkedDependency.alias,
version: linkedDependency.version,
linkedDir: `link:${path.relative(opts.lockfileDir, linkedDependency.resolution.directory)}`,
})
})
const manifest = updatedOriginalManifest ?? project.originalManifest ?? project.manifest
importers[index].manifest = manifest
return {
binsDir: project.binsDir,
directNodeIdsByAlias: resolvedImporter.directNodeIdsByAlias,
id: project.id,
linkedDependencies: resolvedImporter.linkedDependencies,
manifest: project.manifest,
modulesDir: project.modulesDir,
rootDir: project.rootDir,
topParents,
}
}))
const {
dependenciesGraph,
dependenciesByProjectId,
peerDependencyIssuesByProjects,
} = resolvePeers({
dependenciesTree,
lockfileDir: opts.lockfileDir,
projects: projectsToLink,
virtualStoreDir: opts.virtualStoreDir,
})
for (const { id, manifest } of projectsToLink) {
for (const [alias, depPath] of Object.entries(dependenciesByProjectId[id])) {
const projectSnapshot = opts.wantedLockfile.importers[id]
if (manifest.dependenciesMeta != null) {
projectSnapshot.dependenciesMeta = manifest.dependenciesMeta
}
const depNode = dependenciesGraph[depPath]
const ref = depPathToRef(depPath, {
alias,
realName: depNode.name,
registries: opts.registries,
resolution: depNode.resolution,
})
if (projectSnapshot.dependencies?.[alias]) {
projectSnapshot.dependencies[alias] = ref
} else if (projectSnapshot.devDependencies?.[alias]) {
projectSnapshot.devDependencies[alias] = ref
} else if (projectSnapshot.optionalDependencies?.[alias]) {
projectSnapshot.optionalDependencies[alias] = ref
}
}
}
const { newLockfile, pendingRequiresBuilds } = updateLockfile({
dependenciesGraph,
lockfile: opts.wantedLockfile,
prefix: opts.virtualStoreDir,
registries: opts.registries,
lockfileIncludeTarballUrl: opts.lockfileIncludeTarballUrl,
})
if (time) {
newLockfile.time = {
...opts.wantedLockfile.time,
...time,
}
}
if (opts.forceFullResolution && opts.wantedLockfile != null) {
for (const [depPath, pkg] of Object.entries(dependenciesGraph)) {
if (
(opts.allowBuild != null && !opts.allowBuild(pkg.name)) ||
(opts.wantedLockfile.packages?.[depPath] == null) ||
pkg.requiresBuild === true
) continue
pendingRequiresBuilds.push(depPath)
}
}
// waiting till package requests are finished
const waitTillAllFetchingsFinish = async () => Promise.all(Object.values(resolvedPackagesByDepPath).map(async ({ finishing }) => finishing?.()))
return {
dependenciesByProjectId,
dependenciesGraph,
finishLockfileUpdates: promiseShare(finishLockfileUpdates(dependenciesGraph, pendingRequiresBuilds, newLockfile)),
outdatedDependencies,
linkedDependenciesByProjectId,
newLockfile,
peerDependencyIssuesByProjects,
waitTillAllFetchingsFinish,
wantedToBeSkippedPackageIds,
}
}
function verifyPatches (patchedDependencies: string[], appliedPatches: Set<string>) {
const nonAppliedPatches: string[] = patchedDependencies.filter((patchKey) => !appliedPatches.has(patchKey))
if (nonAppliedPatches.length) {
throw new PnpmError('PATCH_NOT_APPLIED', `The following patches were not applied: ${nonAppliedPatches.join(', ')}`, {
hint: 'Either remove them from "patchedDependencies" or update them to match packages in your dependencies.',
})
}
}
async function finishLockfileUpdates (
dependenciesGraph: DependenciesGraph,
pendingRequiresBuilds: string[],
newLockfile: Lockfile
) {
return Promise.all(pendingRequiresBuilds.map(async (depPath) => {
const depNode = dependenciesGraph[depPath]
let requiresBuild!: boolean
if (depNode.optional) {
// We assume that all optional dependencies have to be built.
// Optional dependencies are not always downloaded, so there is no way to know whether they need to be built or not.
requiresBuild = true
} else if (depNode.fetchingBundledManifest != null) {
const filesResponse = await depNode.fetchingFiles()
// The npm team suggests to always read the package.json for deciding whether the package has lifecycle scripts
const pkgJson = await depNode.fetchingBundledManifest()
requiresBuild = Boolean(
pkgJson?.scripts != null && (
Boolean(pkgJson.scripts.preinstall) ||
Boolean(pkgJson.scripts.install) ||
Boolean(pkgJson.scripts.postinstall)
) ||
filesResponse.filesIndex['binding.gyp'] ||
Object.keys(filesResponse.filesIndex).some((filename) => !(filename.match(/^[.]hooks[\\/]/) == null)) // TODO: optimize this
)
} else {
// This should never ever happen
throw new Error(`Cannot create ${WANTED_LOCKFILE} because raw manifest (aka package.json) wasn't fetched for "${depPath}"`)
}
if (typeof depNode.requiresBuild === 'function') {
depNode.requiresBuild['resolve'](requiresBuild)
}
// TODO: try to cover with unit test the case when entry is no longer available in lockfile
// It is an edge that probably happens if the entry is removed during lockfile prune
if (requiresBuild && newLockfile.packages![depPath]) {
newLockfile.packages![depPath].requiresBuild = true
}
}))
}
function addDirectDependenciesToLockfile (
newManifest: ProjectManifest,
projectSnapshot: ProjectSnapshot,
linkedPackages: Array<{alias: string}>,
directDependencies: ResolvedDirectDependency[],
registries: Registries,
autoInstallPeers?: boolean
): ProjectSnapshot {
const newProjectSnapshot: ProjectSnapshot & Required<Pick<ProjectSnapshot, 'dependencies' | 'devDependencies' | 'optionalDependencies'>> = {
dependencies: {},
devDependencies: {},
optionalDependencies: {},
specifiers: {},
}
if (newManifest.publishConfig?.directory) {
newProjectSnapshot.publishDirectory = newManifest.publishConfig.directory
}
linkedPackages.forEach((linkedPkg) => {
newProjectSnapshot.specifiers[linkedPkg.alias] = getSpecFromPackageManifest(newManifest, linkedPkg.alias)
})
const directDependenciesByAlias = directDependencies.reduce((acc, directDependency) => {
acc[directDependency.alias] = directDependency
return acc
}, {})
const allDeps = Array.from(new Set(Object.keys(getAllDependenciesFromManifest(newManifest))))
for (const alias of allDeps) {
if (directDependenciesByAlias[alias]) {
const dep = directDependenciesByAlias[alias]
const ref = depPathToRef(dep.pkgId, {
alias: dep.alias,
realName: dep.name,
registries,
resolution: dep.resolution,
})
if (dep.dev) {
newProjectSnapshot.devDependencies[dep.alias] = ref
} else if (dep.optional) {
newProjectSnapshot.optionalDependencies[dep.alias] = ref
} else {
newProjectSnapshot.dependencies[dep.alias] = ref
}
newProjectSnapshot.specifiers[dep.alias] = getSpecFromPackageManifest(newManifest, dep.alias)
} else if (projectSnapshot.specifiers[alias]) {
newProjectSnapshot.specifiers[alias] = projectSnapshot.specifiers[alias]
if (projectSnapshot.dependencies?.[alias]) {
newProjectSnapshot.dependencies[alias] = projectSnapshot.dependencies[alias]
} else if (projectSnapshot.optionalDependencies?.[alias]) {
newProjectSnapshot.optionalDependencies[alias] = projectSnapshot.optionalDependencies[alias]
} else if (projectSnapshot.devDependencies?.[alias]) {
newProjectSnapshot.devDependencies[alias] = projectSnapshot.devDependencies[alias]
}
}
}
alignDependencyTypes(newManifest, newProjectSnapshot)
return newProjectSnapshot
}
function alignDependencyTypes (manifest: ProjectManifest, projectSnapshot: ProjectSnapshot) {
const depTypesOfAliases = getAliasToDependencyTypeMap(manifest)
// Aligning the dependency types in pnpm-lock.yaml
for (const depType of DEPENDENCIES_FIELDS) {
if (projectSnapshot[depType] == null) continue
for (const alias of Object.keys(projectSnapshot[depType] ?? {})) {
if (depType === depTypesOfAliases[alias] || !depTypesOfAliases[alias]) continue
projectSnapshot[depTypesOfAliases[alias]][alias] = projectSnapshot[depType]![alias]
delete projectSnapshot[depType]![alias]
}
}
}
function getAliasToDependencyTypeMap (manifest: ProjectManifest) {
const depTypesOfAliases = {}
for (const depType of DEPENDENCIES_FIELDS) {
if (manifest[depType] == null) continue
for (const alias of Object.keys(manifest[depType] ?? {})) {
if (!depTypesOfAliases[alias]) {
depTypesOfAliases[alias] = depType
}
}
}
return depTypesOfAliases
}
async function getTopParents (pkgNames: string[], modules: string) {
const pkgs = await Promise.all(
pkgNames.map((pkgName) => path.join(modules, pkgName)).map(safeReadPkgFromDir)
)
return (
pkgs
.filter(Boolean) as DependencyManifest[]
)
.map(({ name, version }: DependencyManifest) => ({ name, version }))
}