All files / lib cache.js

100% Statements 56/56
100% Branches 32/32
100% Functions 8/8
100% Lines 54/54

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 1221x 1x 1x 1x 1x 1x 1x 1x   1x   1x                   1x 4x 4x 1x     3x       3x       9x   1x 9x 9x   3x   3x   2x   1x         1x 3x 1x   2x 2x 1x                             1x             1x 3x         3x 3x     3x 1x   2x 2x         2x 2x 2x       1x 2x 2x     2x 2x 2x 2x 2x 2x 2x 2x     1x  
const cacache = require('cacache')
const { promisify } = require('util')
const log = require('npmlog')
const npm = require('./npm.js')
const output = require('./utils/output.js')
const pacote = require('pacote')
const path = require('path')
const rimraf = promisify(require('rimraf'))
 
const usageUtil = require('./utils/usage.js')
 
const usage = usageUtil('cache',
  'npm cache add <tarball file>' +
  '\nnpm cache add <folder>' +
  '\nnpm cache add <tarball url>' +
  '\nnpm cache add <git url>' +
  '\nnpm cache add <name>@<version>' +
  '\nnpm cache clean' +
  '\nnpm cache verify'
)
 
const completion = (opts, cb) => {
  const argv = opts.conf.argv.remain
  if (argv.length === 2)
    return cb(null, ['add', 'clean', 'verify'])
 
  // TODO - eventually...
  switch (argv[2]) {
    case 'verify':
    case 'clean':
    case 'add':
      return cb(null, [])
  }
}
 
const cmd = (args, cb) => cache(args).then(() => cb()).catch(cb)
 
const cache = async (args) => {
  const cmd = args.shift()
  switch (cmd) {
    case 'rm': case 'clear': case 'clean':
      return await clean(args)
    case 'add':
      return await add(args)
    case 'verify': case 'check':
      return await verify()
    default:
      throw Object.assign(new Error(usage), { code: 'EUSAGE' })
  }
}
 
// npm cache clean [pkg]*
const clean = async (args) => {
  if (args.length)
    throw new Error('npm cache clear does not accept arguments')
 
  const cachePath = path.join(npm.cache, '_cacache')
  if (!npm.flatOptions.force) {
    throw new Error(`As of npm@5, the npm cache self-heals from corruption issues
by treating integrity mismatches as cache misses.  As a result,
data extracted from the cache is guaranteed to be valid.  If you
want to make sure everything is consistent, use \`npm cache verify\`
instead.  Deleting the cache can only make npm go slower, and is
not likely to correct any problems you may be encountering!
 
On the other hand, if you're debugging an issue with the installer,
or race conditions that depend on the timing of writing to an empty
cache, you can use \`npm install --cache /tmp/empty-cache\` to use a
temporary cache instead of nuking the actual one.
 
If you're sure you want to delete the entire cache, rerun this command
with --force.`)
  }
  return rimraf(cachePath)
}
 
// npm cache add <tarball-url>
// npm cache add <pkg> <ver>
// npm cache add <tarball>
// npm cache add <folder>
const add = async (args) => {
  const usage = 'Usage:\n' +
    '    npm cache add <tarball-url>\n' +
    '    npm cache add <pkg>@<ver>\n' +
    '    npm cache add <tarball>\n' +
    '    npm cache add <folder>\n'
  log.silly('cache add', 'args', args)
  const spec = args[0] && args[0] +
    (args[1] === undefined || args[1] === null ? '' : `@${args[1]}`)
 
  if (!spec)
    throw Object.assign(new Error(usage), { code: 'EUSAGE' })
 
  log.silly('cache add', 'spec', spec)
  const opts = { ...npm.flatOptions }
 
  // we ask pacote for the thing, and then just throw the data
  // away so that it tee-pipes it into the cache like it does
  // for a normal request.
  await pacote.tarball.stream(spec, stream => {
    stream.resume()
    return stream.promise()
  }, opts)
}
 
const verify = async () => {
  const cache = path.join(npm.cache, '_cacache')
  const prefix = cache.indexOf(process.env.HOME) === 0
    ? `~${cache.substr(process.env.HOME.length)}`
    : cache
  const stats = await cacache.verify(cache)
  output(`Cache verified and compressed (${prefix})`)
  output(`Content verified: ${stats.verifiedContent} (${stats.keptSize} bytes)`)
  stats.badContentCount && output(`Corrupted content removed: ${stats.badContentCount}`)
  stats.reclaimedCount && output(`Content garbage-collected: ${stats.reclaimedCount} (${stats.reclaimedSize} bytes)`)
  stats.missingContent && output(`Missing content: ${stats.missingContent}`)
  output(`Index entries: ${stats.totalEntries}`)
  output(`Finished in ${stats.runTime.total / 1000}s`)
}
 
module.exports = Object.assign(cmd, { completion, usage })