This repository has been archived by the owner on Aug 11, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
install.js
371 lines (342 loc) · 12.1 KB
/
install.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
// npm install <pkg> <pkg> <pkg>
// npm install <pkg@version> <pkg@"1.0.0 - 1.99.99"> <pkg[@latest]> <pkg@tagname>
// ALGORITHM 1: Deeper, more repetition, easier to update, faster runtime lookups
// install(where, what, previously)
// fetch what, unpack into where/node_modules
// for each dep in what.dependencies
// resolve dep to precise version
// for each dep@version in what.dependencies
// not in previously
// and not in where/node_modules/what/node_modules
// install(where/node_modules/what, dep, previously + what)
//
// ALGORITHM 2: Disk efficient, less repetition, more sharing.
// install(where, what, previously)
// fetch what, unpack into where/node_modules
// for each dep in what.dependencies
// resolve dep to precise version
// for each dep@version in what.dependencies
// not in where/nm/what/nm/*
// and not in previously
// install(where/node_modules/what, dep, previously+precise version deps)
//
// ALGORITHM 3: Most disk efficient, minimum repetition. "Squash left"
// install(where, what, previously)
// fetch what, unpack into where/node_modules
// for each dep in what.dependencies
// resolve dep to precise version
// list1 = [], list2 = []
// for each dep@version in what.dependencies
// and not in where/nm/what/nm/*
// and not in previously
// if dep not in where/node_modules
// add dep to list1
// else add dep to list2
// for each dep@version in list1
// install(where, dep@version, previously+list1)
// for each dep@version in list2
// install(where, dep@version, previously+list1+list2)
//
// For package{dep} structure: A{B,C}, B{C}, C{D}
//
// Algorithm 1 produces:
// A
// +-- B
// | `-- C
// | `-- D
// `-- C
// `-- D
//
// Algorithm 2 produces:
// A
// +-- B
// `-- C
// `-- D
//
// Algorithm 3 produces:
//
// A
// +-- B
// +-- C
// `-- D
//
// At first glance, 2 is clearly better. However, if A wants to update to
// C', which conflicts with B's dependency on C, then the update algorithm
// must be clever enough to detect this, and install C directly in B. With
// installation algorithm 1, the update process simply detects that B will
// not be satisfied by C', and leave it alone.
//
// Even though it makes updating slightly more complicated, that complication
// is unavoidable. `npm update` should always be smart enough to detect
// and prevent contract breakage, even if it was the result of some manual
// intervention.
//
// Algorithm 3 looks nice but is obnoxious. It's very likely that old deps
// will be left behind when things are removed, even if they're no longer
// necessary, and detecting that will be tricky. With algo2, however,
// removing C will require a check to make sure that no other packages
// are depending on it.
//
// Conclusion: Use algorithm 1. Switching is easy anyway.
//
// Managing "previously" lists...
// every time we dive into a deeper node_modules folder, the "previously"
// list that gets passed along uses the previous "previously" list as
// it's __proto__. Any "resolved precise dependency" things that aren't
// already on this object get added, and then that's passed to the next
// generation of installation.
module.exports = install
install.usage = "npm install <tarball file>"
+ "\nnpm install <tarball url>"
+ "\nnpm install <folder>"
+ "\nnpm install <pkg>"
+ "\nnpm install <pkg>@<tag>"
+ "\nnpm install <pkg>@<version>"
+ "\nnpm install <pkg>@<version range>"
+ "\n\nCan specify one or more: npm install ./foo.tgz bar@stable /some/folder"
+ "\nInstalls dependencies in ./package.json if no argument supplied"
install.completion = function (opts, cb) {
// install can complete to a folder with a package.json, or any package.
// if it has a slash, then it's gotta be a folder
// if it starts with https?://, then just give up, because it's a url
// for now, not yet implemented.
var registry = require("./utils/npm-registry-client")
registry.get("/-/short", function (er, pkgs) {
if (er) return cb()
if (!opts.partialWord) return cb(null, pkgs)
var name = opts.partialWord.split("@").shift()
pkgs = pkgs.filter(function (p) {
return p.indexOf(name) === 0
})
if (pkgs.length !== 1 && opts.partialWord === name) return cb(null, pkgs)
registry.get(pkgs[0], function (er, d) {
if (er) return cb()
return cb(null, Object.keys(d["dist-tags"] || {})
.concat(Object.keys(d.versions || {}))
.map(function (t) {
return pkgs[0] + "@" + t
}))
})
})
}
var npm = require("../npm")
, semver = require("semver")
, readJson = require("./utils/read-json")
, log = require("./utils/log")
, path = require("path")
, fs = require("./utils/graceful-fs")
, cache = require("./cache")
, asyncMap = require("./utils/async-map")
, chain = require("./utils/chain")
, relativize = require("./utils/relativize")
, output
, url = require("url")
, mkdir = require("./utils/mkdir-p")
function install (args, cb) {
var where = npm.prefix
if (npm.config.get("global")) where = path.resolve(where, "lib")
// internal api: install(where, what, cb)
if (arguments.length === 3) {
where = args
args = [cb]
cb = arguments[2]
log([where, args], "install(where, what)")
}
if (!npm.config.get("global")) {
args = args.filter(function (a) {
return path.resolve(a) !== where
})
}
mkdir(where, function (er) {
if (er) return cb(er)
// install dependencies locally by default,
// or install current folder globally
if (!args.length) {
if (npm.config.get("global")) args = ["."]
else return readJson( path.resolve("package.json")
, function (er, data) {
if (er) return log.er(cb, "Couldn't read dependencies.")(er)
var deps = Object.keys(data.dependencies || {})
if (!deps.length) return log("Nothing to do", "install", cb)
var previously = {}
previously[data.name] = data.version
installMany(deps.map(function (dep) {
var target = data.dependencies[dep]
if (!url.parse(target).protocol) {
target = dep + "@" + target
}
return target
}), where, previously, false, cb)
})
}
// initial "previously" is the name:version of the root, if it's got
// a pacakge.json file.
readJson(path.resolve(where, "package.json"), function (er, data) {
if (er) data = null
var previously = {}
if (data) previously[data.name] = data.version
installMany(args, where, previously, true, cb)
})
})
}
function installMany (what, where, previously, explicit, cb) {
log.info(what, "into "+where)
// what is a list of things.
// resolve each one.
asyncMap(what, targetResolver(where, previously, explicit)
,function (er, targets) {
if (er) return cb(er)
// each target will be a data object corresponding
// to a package, folder, or whatever that is in the cache now.
log.silly(targets, "resolved")
log.info(targets.map(function (t) { return t && t._id})
, "(resolved) into "+where)
asyncMap(targets, function (target, cb) {
log(target._id, "installOne")
installOne(target, where, previously, cb)
}, cb)
})
}
function targetResolver (where, previously, explicit) {
var alreadyInstalledManually = explicit ? [] : null
, nm = path.resolve(where, "node_modules")
if (!explicit) fs.readdir(nm, function (er, inst) {
if (er) return alreadyInstalledManually = []
alreadyInstalledManually = inst
})
var to = 0
return function resolver (what, cb) {
if (!alreadyInstalledManually) return setTimeout(function () {
resolver(what, cb)
}, to++)
// now we know what's been installed here manually,
// or tampered with in some way that npm doesn't want to overwrite.
if (alreadyInstalledManually.indexOf(what.split("@").shift()) !== -1) {
log("skipping "+what, "already installed manually in "+where)
return cb(null, [])
}
cache.add(what, function (er, data) {
if (!er && data && previously[data.name] === data.version) {
return cb(null, [])
}
return cb(er, data)
})
}
}
// we've already decided to install this. if anything's in the way,
// then uninstall it first.
function installOne (target, where, previously, cb) {
var nm = path.resolve(where, "node_modules")
, targetFolder = path.resolve(nm, target.name)
chain
( [checkEngine, target]
, [checkCycle, target, previously]
, [checkGit, targetFolder]
, [write, target, targetFolder, previously]
, function (er) {
log.info(target._id, "installOne cb")
if (er) return cb(er)
if (!npm.config.get("global")) {
// print out the folder relative to where we are right now.
// relativize isn't really made for dirs, so you need this hack
targetFolder = relativize(targetFolder, process.cwd()+"/x")
}
output = output || require("./utils/output")
output.write(target._id+" "+targetFolder, cb)
}
)
}
function checkEngine (target, cb) {
var npmv = npm.version
, nodev = process.version
, eng = target.engines
if (!eng) return cb()
if (eng.node && !semver.satisfies(nodev, eng.node)
|| eng.npm && !semver.satisfies(npmv, eng.npm)) {
var er = new Error("Unsupported")
er.errno = npm.EENGINE
er.required = eng
er.pkgid = target._id
return cb(er)
}
return cb()
}
function checkCycle (target, previously, cb) {
// there are some very rare and pathological edge-cases where
// a cycle can cause npm to try to install a never-ending tree
// of stuff.
// Simplest:
//
// A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...
//
// Solution: Simply flat-out refuse to install any name@version
// that is already in the prototype tree of the previously object.
var p = previously
, name = target.name
, version = target.version
while (p && p !== Object.prototype && p[name] !== version) {
p = Object.getPrototypeOf(p)
}
if (p[name] !== version) return cb()
var er = new Error("Unresolveable cycle detected")
er.pkgid = target._id
er.errno = npm.ECYCLE
return cb(er)
}
function checkGit (folder, cb) {
// if it's a git repo then don't touch it!
fs.lstat(folder, function (er, s) {
if (er || !s.isDirectory()) return cb()
else checkGit_(folder, cb)
})
}
function checkGit_ (folder, cb) {
fs.stat(path.resolve(folder, ".git"), function (er, s) {
if (!er && s.isDirectory()) {
var e = new Error("Appears to be a git repo or submodule.")
e.path = folder
e.errno = npm.EISGIT
return cb(e)
}
cb()
})
}
function write (target, targetFolder, previously, cb_) {
var up = !npm.config.get("global") || npm.config.get("unsafe-perm")
, user = up ? null : npm.config.get("user")
, group = up ? null : npm.config.get("group")
function cb (er, data) {
if (!er) return cb_(er, data)
log.error(er, "error installing "+target._id)
npm.commands.unbuild([targetFolder], function (er2) {
if (er2) log.error(er2, "error rolling back "+target._id)
return cb_(er, data)
})
}
chain
( [ npm.commands.unbuild, [targetFolder] ]
, [ cache.unpack, target.name, target.version, targetFolder
, null, null, user, group ]
, function (cb) {
var deps = Object.keys(target.dependencies || {})
, newPrev = Object.create(previously)
newPrev[target.name] = target.version
installMany(deps.filter(function (d) {
// prefer to not install things that are satisfied by
// something in the "previously" list.
return !semver.satisfies(previously[d], target.dependencies[d])
}).map(function (d) {
var t = target.dependencies[d]
if (!url.parse(t).protocol) {
t = d + "@" + t
}
return t
return d + "@" + target.dependencies[d]
}), targetFolder, newPrev, false, function (er) {
log.verbose(targetFolder, "about to build")
if (er) return cb(er)
npm.commands.build([targetFolder], cb)
})
}
, cb )
}