-
-
Notifications
You must be signed in to change notification settings - Fork 931
/
index.ts
373 lines (347 loc) · 12.4 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
import path from 'path'
import {
LAYOUT_VERSION,
WANTED_LOCKFILE,
} from '@pnpm/constants'
import { skippedOptionalDependencyLogger } from '@pnpm/core-loggers'
import { PnpmError } from '@pnpm/error'
import { getContext, type PnpmContext } from '@pnpm/get-context'
import {
runLifecycleHooksConcurrently,
runPostinstallHooks,
} from '@pnpm/lifecycle'
import { linkBins } from '@pnpm/link-bins'
import {
type Lockfile,
nameVerFromPkgSnapshot,
packageIsIndependent,
type PackageSnapshots,
} from '@pnpm/lockfile-utils'
import { lockfileWalker, type LockfileWalkerStep } from '@pnpm/lockfile-walker'
import { logger, streamParser } from '@pnpm/logger'
import { writeModulesManifest } from '@pnpm/modules-yaml'
import { createOrConnectStoreController } from '@pnpm/store-connection-manager'
import { type ProjectManifest } from '@pnpm/types'
import * as dp from '@pnpm/dependency-path'
import { hardLinkDir } from '@pnpm/fs.hard-link-dir'
import runGroups from 'run-groups'
import graphSequencer from '@pnpm/graph-sequencer'
import npa from '@pnpm/npm-package-arg'
import pLimit from 'p-limit'
import semver from 'semver'
import {
extendRebuildOptions,
type RebuildOptions,
type StrictRebuildOptions,
} from './extendRebuildOptions'
export type { RebuildOptions }
function findPackages (
packages: PackageSnapshots,
searched: PackageSelector[],
opts: {
prefix: string
}
): string[] {
return Object.keys(packages)
.filter((relativeDepPath) => {
const pkgLockfile = packages[relativeDepPath]
const pkgInfo = nameVerFromPkgSnapshot(relativeDepPath, pkgLockfile)
if (!pkgInfo.name) {
logger.warn({
message: `Skipping ${relativeDepPath} because cannot get the package name from ${WANTED_LOCKFILE}.
Try to run run \`pnpm update --depth 100\` to create a new ${WANTED_LOCKFILE} with all the necessary info.`,
prefix: opts.prefix,
})
return false
}
return matches(searched, pkgInfo)
})
}
// TODO: move this logic to separate package as this is also used in dependencies-hierarchy
function matches (
searched: PackageSelector[],
manifest: { name: string, version?: string }
) {
return searched.some((searchedPkg) => {
if (typeof searchedPkg === 'string') {
return manifest.name === searchedPkg
}
return searchedPkg.name === manifest.name && !!manifest.version &&
semver.satisfies(manifest.version, searchedPkg.range)
})
}
type PackageSelector = string | {
name: string
range: string
}
export async function rebuildSelectedPkgs (
projects: Array<{ buildIndex: number, manifest: ProjectManifest, rootDir: string }>,
pkgSpecs: string[],
maybeOpts: RebuildOptions
) {
const reporter = maybeOpts?.reporter
if ((reporter != null) && typeof reporter === 'function') {
streamParser.on('data', reporter)
}
const opts = await extendRebuildOptions(maybeOpts)
const ctx = await getContext({ ...opts, allProjects: projects })
if (!ctx.currentLockfile || (ctx.currentLockfile.packages == null)) return
const packages = ctx.currentLockfile.packages
const searched: PackageSelector[] = pkgSpecs.map((arg) => {
const { fetchSpec, name, raw, type } = npa(arg)
if (raw === name) {
return name
}
if (type !== 'version' && type !== 'range') {
throw new Error(`Invalid argument - ${arg}. Rebuild can only select by version or range`)
}
return {
name,
range: fetchSpec,
}
})
let pkgs = [] as string[]
for (const { rootDir } of projects) {
pkgs = [
...pkgs,
...findPackages(packages, searched, { prefix: rootDir }),
]
}
await _rebuild(
{
pkgsToRebuild: new Set(pkgs),
...ctx,
},
opts
)
}
export async function rebuildProjects (
projects: Array<{ buildIndex: number, manifest: ProjectManifest, rootDir: string }>,
maybeOpts: RebuildOptions
) {
const reporter = maybeOpts?.reporter
if ((reporter != null) && typeof reporter === 'function') {
streamParser.on('data', reporter)
}
const opts = await extendRebuildOptions(maybeOpts)
const ctx = await getContext({ ...opts, allProjects: projects })
let idsToRebuild: string[] = []
if (opts.pending) {
idsToRebuild = ctx.pendingBuilds
} else if ((ctx.currentLockfile?.packages) != null) {
idsToRebuild = Object.keys(ctx.currentLockfile.packages)
}
const pkgsThatWereRebuilt = await _rebuild(
{
pkgsToRebuild: new Set(idsToRebuild),
...ctx,
},
opts
)
ctx.pendingBuilds = ctx.pendingBuilds.filter((depPath) => !pkgsThatWereRebuilt.has(depPath))
const store = await createOrConnectStoreController(opts)
const scriptsOpts = {
extraBinPaths: ctx.extraBinPaths,
extraEnv: opts.extraEnv,
rawConfig: opts.rawConfig,
scriptsPrependNodePath: opts.scriptsPrependNodePath,
scriptShell: opts.scriptShell,
shellEmulator: opts.shellEmulator,
storeController: store.ctrl,
unsafePerm: opts.unsafePerm || false,
}
await runLifecycleHooksConcurrently(
['preinstall', 'install', 'postinstall', 'prepublish', 'prepare'],
Object.values(ctx.projects),
opts.childConcurrency || 5,
scriptsOpts
)
for (const { id, manifest } of Object.values(ctx.projects)) {
if (((manifest?.scripts) != null) && (!opts.pending || ctx.pendingBuilds.includes(id))) {
ctx.pendingBuilds.splice(ctx.pendingBuilds.indexOf(id), 1)
}
}
await writeModulesManifest(ctx.rootModulesDir, {
prunedAt: new Date().toUTCString(),
...ctx.modulesFile,
hoistedDependencies: ctx.hoistedDependencies,
hoistPattern: ctx.hoistPattern,
included: ctx.include,
layoutVersion: LAYOUT_VERSION,
packageManager: `${opts.packageManager.name}@${opts.packageManager.version}`,
pendingBuilds: ctx.pendingBuilds,
publicHoistPattern: ctx.publicHoistPattern,
registries: ctx.registries,
skipped: Array.from(ctx.skipped),
storeDir: ctx.storeDir,
virtualStoreDir: ctx.virtualStoreDir,
})
}
function getSubgraphToBuild (
step: LockfileWalkerStep,
nodesToBuildAndTransitive: Set<string>,
opts: {
pkgsToRebuild: Set<string>
}
) {
let currentShouldBeBuilt = false
for (const { depPath, next } of step.dependencies) {
if (nodesToBuildAndTransitive.has(depPath)) {
currentShouldBeBuilt = true
}
const childShouldBeBuilt = getSubgraphToBuild(next(), nodesToBuildAndTransitive, opts) ||
opts.pkgsToRebuild.has(depPath)
if (childShouldBeBuilt) {
nodesToBuildAndTransitive.add(depPath)
currentShouldBeBuilt = true
}
}
for (const depPath of step.missing) {
// It might make sense to fail if the depPath is not in the skipped list from .modules.yaml
// However, the skipped list currently contains package IDs, not dep paths.
logger.debug({ message: `No entry for "${depPath}" in ${WANTED_LOCKFILE}` })
}
return currentShouldBeBuilt
}
const limitLinking = pLimit(16)
async function _rebuild (
ctx: {
pkgsToRebuild: Set<string>
skipped: Set<string>
virtualStoreDir: string
rootModulesDir: string
currentLockfile: Lockfile
projects: Record<string, { id: string, rootDir: string }>
extraBinPaths: string[]
extraNodePaths: string[]
} & Pick<PnpmContext, 'modulesFile'>,
opts: StrictRebuildOptions
) {
const pkgsThatWereRebuilt = new Set()
const graph = new Map()
const pkgSnapshots: PackageSnapshots = ctx.currentLockfile.packages ?? {}
const nodesToBuildAndTransitive = new Set<string>()
getSubgraphToBuild(
lockfileWalker(
ctx.currentLockfile,
Object.values(ctx.projects).map(({ id }) => id),
{
include: {
dependencies: opts.production,
devDependencies: opts.development,
optionalDependencies: opts.optional,
},
}
).step,
nodesToBuildAndTransitive,
{ pkgsToRebuild: ctx.pkgsToRebuild }
)
const nodesToBuildAndTransitiveArray = Array.from(nodesToBuildAndTransitive)
for (const depPath of nodesToBuildAndTransitiveArray) {
const pkgSnapshot = pkgSnapshots[depPath]
graph.set(depPath, Object.entries({ ...pkgSnapshot.dependencies, ...pkgSnapshot.optionalDependencies })
.map(([pkgName, reference]) => dp.refToRelative(reference, pkgName))
.filter((childRelDepPath) => childRelDepPath && nodesToBuildAndTransitive.has(childRelDepPath)))
}
const graphSequencerResult = graphSequencer({
graph,
groups: [nodesToBuildAndTransitiveArray],
})
const chunks = graphSequencerResult.chunks as string[][]
const warn = (message: string) => {
logger.info({ message, prefix: opts.dir })
}
const groups = chunks.map((chunk) => chunk.filter((depPath) => ctx.pkgsToRebuild.has(depPath) && !ctx.skipped.has(depPath)).map((depPath) =>
async () => {
const pkgSnapshot = pkgSnapshots[depPath]
const pkgInfo = nameVerFromPkgSnapshot(depPath, pkgSnapshot)
const pkgRoots = opts.nodeLinker === 'hoisted'
? (ctx.modulesFile?.hoistedLocations?.[depPath] ?? []).map((hoistedLocation) => path.join(opts.lockfileDir, hoistedLocation))
: [path.join(ctx.virtualStoreDir, dp.depPathToFilename(depPath), 'node_modules', pkgInfo.name)]
if (pkgRoots.length === 0) {
if (pkgSnapshot.optional) return
throw new PnpmError('MISSING_HOISTED_LOCATIONS', `${depPath} is not found in hoistedLocations inside node_modules/.modules.yaml`, {
hint: 'If you installed your node_modules with pnpm older than v7.19.0, you may need to remove it and run "pnpm install"',
})
}
const pkgRoot = pkgRoots[0]
try {
const extraBinPaths = ctx.extraBinPaths
if (opts.nodeLinker !== 'hoisted') {
const modules = path.join(ctx.virtualStoreDir, dp.depPathToFilename(depPath), 'node_modules')
const binPath = path.join(pkgRoot, 'node_modules', '.bin')
await linkBins(modules, binPath, { extraNodePaths: ctx.extraNodePaths, warn })
} else {
extraBinPaths.push(...binDirsInAllParentDirs(pkgRoot, opts.lockfileDir))
}
await runPostinstallHooks({
depPath,
extraBinPaths,
extraEnv: opts.extraEnv,
optional: pkgSnapshot.optional === true,
pkgRoot,
rawConfig: opts.rawConfig,
rootModulesDir: ctx.rootModulesDir,
scriptsPrependNodePath: opts.scriptsPrependNodePath,
shellEmulator: opts.shellEmulator,
unsafePerm: opts.unsafePerm || false,
})
pkgsThatWereRebuilt.add(depPath)
} catch (err: any) { // eslint-disable-line
if (pkgSnapshot.optional) {
// TODO: add parents field to the log
skippedOptionalDependencyLogger.debug({
details: err.toString(),
package: {
id: pkgSnapshot.id ?? depPath,
name: pkgInfo.name,
version: pkgInfo.version,
},
prefix: opts.dir,
reason: 'build_failure',
})
return
}
throw err
}
if (pkgRoots.length > 1) {
await hardLinkDir(pkgRoot, pkgRoots.slice(1))
}
}
))
await runGroups(opts.childConcurrency || 5, groups)
// It may be optimized because some bins were already linked before running lifecycle scripts
await Promise.all(
Object
.keys(pkgSnapshots)
.filter((depPath) => !packageIsIndependent(pkgSnapshots[depPath]))
.map(async (depPath) => limitLinking(async () => {
const pkgSnapshot = pkgSnapshots[depPath]
const pkgInfo = nameVerFromPkgSnapshot(depPath, pkgSnapshot)
const modules = path.join(ctx.virtualStoreDir, dp.depPathToFilename(depPath), 'node_modules')
const binPath = path.join(modules, pkgInfo.name, 'node_modules', '.bin')
return linkBins(modules, binPath, { warn })
}))
)
await Promise.all(Object.values(ctx.projects).map(async ({ rootDir }) => limitLinking(async () => {
const modules = path.join(rootDir, 'node_modules')
const binPath = path.join(modules, '.bin')
return linkBins(modules, binPath, {
allowExoticManifests: true,
warn,
})
})))
return pkgsThatWereRebuilt
}
function binDirsInAllParentDirs (pkgRoot: string, lockfileDir: string): string[] {
const binDirs: string[] = []
let dir = pkgRoot
do {
if (!path.dirname(dir).startsWith('@')) {
binDirs.push(path.join(dir, 'node_modules/.bin'))
}
dir = path.dirname(dir)
} while (path.relative(dir, lockfileDir) !== '')
binDirs.push(path.join(lockfileDir, 'node_modules/.bin'))
return binDirs
}