install.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. 'use strict'
  2. const fs = require('graceful-fs')
  3. const os = require('os')
  4. const tar = require('tar')
  5. const path = require('path')
  6. const util = require('util')
  7. const stream = require('stream')
  8. const crypto = require('crypto')
  9. const log = require('npmlog')
  10. const semver = require('semver')
  11. const fetch = require('make-fetch-happen')
  12. const processRelease = require('./process-release')
  13. const win = process.platform === 'win32'
  14. const streamPipeline = util.promisify(stream.pipeline)
  15. /**
  16. * @param {typeof import('graceful-fs')} fs
  17. */
  18. async function install (fs, gyp, argv) {
  19. const release = processRelease(argv, gyp, process.version, process.release)
  20. // Determine which node dev files version we are installing
  21. log.verbose('install', 'input version string %j', release.version)
  22. if (!release.semver) {
  23. // could not parse the version string with semver
  24. throw new Error('Invalid version number: ' + release.version)
  25. }
  26. if (semver.lt(release.version, '0.8.0')) {
  27. throw new Error('Minimum target version is `0.8.0` or greater. Got: ' + release.version)
  28. }
  29. // 0.x.y-pre versions are not published yet and cannot be installed. Bail.
  30. if (release.semver.prerelease[0] === 'pre') {
  31. log.verbose('detected "pre" node version', release.version)
  32. if (!gyp.opts.nodedir) {
  33. throw new Error('"pre" versions of node cannot be installed, use the --nodedir flag instead')
  34. }
  35. log.verbose('--nodedir flag was passed; skipping install', gyp.opts.nodedir)
  36. return
  37. }
  38. // flatten version into String
  39. log.verbose('install', 'installing version: %s', release.versionDir)
  40. // the directory where the dev files will be installed
  41. const devDir = path.resolve(gyp.devDir, release.versionDir)
  42. // If '--ensure' was passed, then don't *always* install the version;
  43. // check if it is already installed, and only install when needed
  44. if (gyp.opts.ensure) {
  45. log.verbose('install', '--ensure was passed, so won\'t reinstall if already installed')
  46. try {
  47. await fs.promises.stat(devDir)
  48. } catch (err) {
  49. if (err.code === 'ENOENT') {
  50. log.verbose('install', 'version not already installed, continuing with install', release.version)
  51. try {
  52. return await go()
  53. } catch (err) {
  54. return rollback(err)
  55. }
  56. } else if (err.code === 'EACCES') {
  57. return eaccesFallback(err)
  58. }
  59. throw err
  60. }
  61. log.verbose('install', 'version is already installed, need to check "installVersion"')
  62. const installVersionFile = path.resolve(devDir, 'installVersion')
  63. let installVersion = 0
  64. try {
  65. const ver = await fs.promises.readFile(installVersionFile, 'ascii')
  66. installVersion = parseInt(ver, 10) || 0
  67. } catch (err) {
  68. if (err.code !== 'ENOENT') {
  69. throw err
  70. }
  71. }
  72. log.verbose('got "installVersion"', installVersion)
  73. log.verbose('needs "installVersion"', gyp.package.installVersion)
  74. if (installVersion < gyp.package.installVersion) {
  75. log.verbose('install', 'version is no good; reinstalling')
  76. try {
  77. return await go()
  78. } catch (err) {
  79. return rollback(err)
  80. }
  81. }
  82. log.verbose('install', 'version is good')
  83. } else {
  84. try {
  85. return await go()
  86. } catch (err) {
  87. return rollback(err)
  88. }
  89. }
  90. async function go () {
  91. log.verbose('ensuring nodedir is created', devDir)
  92. // first create the dir for the node dev files
  93. try {
  94. const created = await fs.promises.mkdir(devDir, { recursive: true })
  95. if (created) {
  96. log.verbose('created nodedir', created)
  97. }
  98. } catch (err) {
  99. if (err.code === 'EACCES') {
  100. return eaccesFallback(err)
  101. }
  102. throw err
  103. }
  104. // now download the node tarball
  105. const tarPath = gyp.opts.tarball
  106. let extractCount = 0
  107. const contentShasums = {}
  108. const expectShasums = {}
  109. // checks if a file to be extracted from the tarball is valid.
  110. // only .h header files and the gyp files get extracted
  111. function isValid (path) {
  112. const isValid = valid(path)
  113. if (isValid) {
  114. log.verbose('extracted file from tarball', path)
  115. extractCount++
  116. } else {
  117. // invalid
  118. log.silly('ignoring from tarball', path)
  119. }
  120. return isValid
  121. }
  122. // download the tarball and extract!
  123. if (tarPath) {
  124. await tar.extract({
  125. file: tarPath,
  126. strip: 1,
  127. filter: isValid,
  128. cwd: devDir
  129. })
  130. } else {
  131. try {
  132. const res = await download(gyp, release.tarballUrl)
  133. if (res.status !== 200) {
  134. throw new Error(`${res.status} response downloading ${release.tarballUrl}`)
  135. }
  136. await streamPipeline(
  137. res.body,
  138. // content checksum
  139. new ShaSum((_, checksum) => {
  140. const filename = path.basename(release.tarballUrl).trim()
  141. contentShasums[filename] = checksum
  142. log.verbose('content checksum', filename, checksum)
  143. }),
  144. tar.extract({
  145. strip: 1,
  146. cwd: devDir,
  147. filter: isValid
  148. })
  149. )
  150. } catch (err) {
  151. // something went wrong downloading the tarball?
  152. if (err.code === 'ENOTFOUND') {
  153. throw new Error('This is most likely not a problem with node-gyp or the package itself and\n' +
  154. 'is related to network connectivity. In most cases you are behind a proxy or have bad \n' +
  155. 'network settings.')
  156. }
  157. throw err
  158. }
  159. }
  160. // invoked after the tarball has finished being extracted
  161. if (extractCount === 0) {
  162. throw new Error('There was a fatal problem while downloading/extracting the tarball')
  163. }
  164. log.verbose('tarball', 'done parsing tarball')
  165. const installVersionPath = path.resolve(devDir, 'installVersion')
  166. await Promise.all([
  167. // need to download node.lib
  168. ...(win ? downloadNodeLib() : []),
  169. // write the "installVersion" file
  170. fs.promises.writeFile(installVersionPath, gyp.package.installVersion + '\n'),
  171. // Only download SHASUMS.txt if we downloaded something in need of SHA verification
  172. ...(!tarPath || win ? [downloadShasums()] : [])
  173. ])
  174. log.verbose('download contents checksum', JSON.stringify(contentShasums))
  175. // check content shasums
  176. for (const k in contentShasums) {
  177. log.verbose('validating download checksum for ' + k, '(%s == %s)', contentShasums[k], expectShasums[k])
  178. if (contentShasums[k] !== expectShasums[k]) {
  179. throw new Error(k + ' local checksum ' + contentShasums[k] + ' not match remote ' + expectShasums[k])
  180. }
  181. }
  182. async function downloadShasums () {
  183. log.verbose('check download content checksum, need to download `SHASUMS256.txt`...')
  184. log.verbose('checksum url', release.shasumsUrl)
  185. const res = await download(gyp, release.shasumsUrl)
  186. if (res.status !== 200) {
  187. throw new Error(`${res.status} status code downloading checksum`)
  188. }
  189. for (const line of (await res.text()).trim().split('\n')) {
  190. const items = line.trim().split(/\s+/)
  191. if (items.length !== 2) {
  192. return
  193. }
  194. // 0035d18e2dcf9aad669b1c7c07319e17abfe3762 ./node-v0.11.4.tar.gz
  195. const name = items[1].replace(/^\.\//, '')
  196. expectShasums[name] = items[0]
  197. }
  198. log.verbose('checksum data', JSON.stringify(expectShasums))
  199. }
  200. function downloadNodeLib () {
  201. log.verbose('on Windows; need to download `' + release.name + '.lib`...')
  202. const archs = ['ia32', 'x64', 'arm64']
  203. return archs.map(async (arch) => {
  204. const dir = path.resolve(devDir, arch)
  205. const targetLibPath = path.resolve(dir, release.name + '.lib')
  206. const { libUrl, libPath } = release[arch]
  207. const name = `${arch} ${release.name}.lib`
  208. log.verbose(name, 'dir', dir)
  209. log.verbose(name, 'url', libUrl)
  210. await fs.promises.mkdir(dir, { recursive: true })
  211. log.verbose('streaming', name, 'to:', targetLibPath)
  212. const res = await download(gyp, libUrl)
  213. if (res.status === 403 || res.status === 404) {
  214. if (arch === 'arm64') {
  215. // Arm64 is a newer platform on Windows and not all node distributions provide it.
  216. log.verbose(`${name} was not found in ${libUrl}`)
  217. } else {
  218. log.warn(`${name} was not found in ${libUrl}`)
  219. }
  220. return
  221. } else if (res.status !== 200) {
  222. throw new Error(`${res.status} status code downloading ${name}`)
  223. }
  224. return streamPipeline(
  225. res.body,
  226. new ShaSum((_, checksum) => {
  227. contentShasums[libPath] = checksum
  228. log.verbose('content checksum', libPath, checksum)
  229. }),
  230. fs.createWriteStream(targetLibPath)
  231. )
  232. })
  233. } // downloadNodeLib()
  234. } // go()
  235. /**
  236. * Checks if a given filename is "valid" for this installation.
  237. */
  238. function valid (file) {
  239. // header files
  240. const extname = path.extname(file)
  241. return extname === '.h' || extname === '.gypi'
  242. }
  243. async function rollback (err) {
  244. log.warn('install', 'got an error, rolling back install')
  245. // roll-back the install if anything went wrong
  246. await util.promisify(gyp.commands.remove)([release.versionDir])
  247. throw err
  248. }
  249. /**
  250. * The EACCES fallback is a workaround for npm's `sudo` behavior, where
  251. * it drops the permissions before invoking any child processes (like
  252. * node-gyp). So what happens is the "nobody" user doesn't have
  253. * permission to create the dev dir. As a fallback, make the tmpdir() be
  254. * the dev dir for this installation. This is not ideal, but at least
  255. * the compilation will succeed...
  256. */
  257. async function eaccesFallback (err) {
  258. const noretry = '--node_gyp_internal_noretry'
  259. if (argv.indexOf(noretry) !== -1) {
  260. throw err
  261. }
  262. const tmpdir = os.tmpdir()
  263. gyp.devDir = path.resolve(tmpdir, '.node-gyp')
  264. let userString = ''
  265. try {
  266. // os.userInfo can fail on some systems, it's not critical here
  267. userString = ` ("${os.userInfo().username}")`
  268. } catch (e) {}
  269. log.warn('EACCES', 'current user%s does not have permission to access the dev dir "%s"', userString, devDir)
  270. log.warn('EACCES', 'attempting to reinstall using temporary dev dir "%s"', gyp.devDir)
  271. if (process.cwd() === tmpdir) {
  272. log.verbose('tmpdir == cwd', 'automatically will remove dev files after to save disk space')
  273. gyp.todo.push({ name: 'remove', args: argv })
  274. }
  275. return util.promisify(gyp.commands.install)([noretry].concat(argv))
  276. }
  277. }
  278. class ShaSum extends stream.Transform {
  279. constructor (callback) {
  280. super()
  281. this._callback = callback
  282. this._digester = crypto.createHash('sha256')
  283. }
  284. _transform (chunk, _, callback) {
  285. this._digester.update(chunk)
  286. callback(null, chunk)
  287. }
  288. _flush (callback) {
  289. this._callback(null, this._digester.digest('hex'))
  290. callback()
  291. }
  292. }
  293. async function download (gyp, url) {
  294. log.http('GET', url)
  295. const requestOpts = {
  296. headers: {
  297. 'User-Agent': `node-gyp v${gyp.version} (node ${process.version})`,
  298. Connection: 'keep-alive'
  299. },
  300. proxy: gyp.opts.proxy,
  301. noProxy: gyp.opts.noproxy
  302. }
  303. const cafile = gyp.opts.cafile
  304. if (cafile) {
  305. requestOpts.ca = await readCAFile(cafile)
  306. }
  307. const res = await fetch(url, requestOpts)
  308. log.http(res.status, res.url)
  309. return res
  310. }
  311. async function readCAFile (filename) {
  312. // The CA file can contain multiple certificates so split on certificate
  313. // boundaries. [\S\s]*? is used to match everything including newlines.
  314. const ca = await fs.promises.readFile(filename, 'utf8')
  315. const re = /(-----BEGIN CERTIFICATE-----[\S\s]*?-----END CERTIFICATE-----)/g
  316. return ca.match(re)
  317. }
  318. module.exports = function (gyp, argv, callback) {
  319. install(fs, gyp, argv).then(callback.bind(undefined, null), callback)
  320. }
  321. module.exports.test = {
  322. download,
  323. install,
  324. readCAFile
  325. }
  326. module.exports.usage = 'Install node development files for the specified node version.'