All files / lib owner.js

100% Statements 128/128
100% Branches 65/65
100% Functions 18/18
100% Lines 124/124

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 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    1x 1x 1x 1x   1x 1x 1x 1x 1x   1x             1x 8x 8x 1x   7x 1x   7x 1x 1x       6x 3x       3x   3x 1x   2x 2x     3x 4x   2x     3x     3x     1x 6x   21x   1x 21x 21x     5x   9x     6x   1x       1x 5x 3x 3x 1x   2x     4x   4x 4x 4x 3x 1x   8x   3x   1x 1x       1x 5x 5x 14x 1x       1x     4x           1x 9x 1x   8x 2x 2x 1x   1x   7x   7x 7x     1x 4x 4x 13x 13x 13x     4x 1x 1x     3x 1x               2x     1x 6x 1x   5x 3x 3x 1x   2x   4x   4x 4x     1x 11x 11x   11x 11x   1x 1x     10x 1x                 9x   9x     9x   9x 8x 2x   6x         6x 6x 6x             6x 5x 2x   3x   1x         5x     1x  
'use strict'
 
const log = require('npmlog')
const npa = require('npm-package-arg')
const npmFetch = require('npm-registry-fetch')
const pacote = require('pacote')
 
const npm = require('./npm.js')
const output = require('./utils/output.js')
const otplease = require('./utils/otplease.js')
const readLocalPkg = require('./utils/read-local-package.js')
const usageUtil = require('./utils/usage.js')
 
const usage = usageUtil(
  'owner',
  'npm owner add <user> [<@scope>/]<pkg>' +
  '\nnpm owner rm <user> [<@scope>/]<pkg>' +
  '\nnpm owner ls [<@scope>/]<pkg>'
)
 
const completion = function (opts, cb) {
  const argv = opts.conf.argv.remain
  if (argv.length > 3)
    return cb(null, [])
 
  if (argv[1] !== 'owner')
    argv.unshift('owner')
 
  if (argv.length === 2) {
    var subs = ['add', 'rm', 'ls']
    return cb(null, subs)
  }
 
  // reaches registry in order to autocomplete rm
  if (argv[2] === 'rm') {
    const opts = {
      ...npm.flatOptions,
      fullMetadata: true,
    }
    readLocalPkg()
      .then(pkgName => {
        if (!pkgName)
          return null
 
        const spec = npa(pkgName)
        return pacote.packument(spec, opts)
      })
      .then(data => {
        if (data && data.maintainers && data.maintainers.length)
          return data.maintainers.map(m => m.name)
 
        return []
      })
      .then(owners => {
        return cb(null, owners)
      })
  } else
    cb(null, [])
}
 
const UsageError = () =>
  Object.assign(new Error(usage), { code: 'EUSAGE' })
 
const cmd = (args, cb) => owner(args).then(() => cb()).catch(cb)
 
const owner = async ([action, ...args]) => {
  const opts = npm.flatOptions
  switch (action) {
    case 'ls':
    case 'list':
      return ls(args[0], opts)
    case 'add':
      return add(args[0], args[1], opts)
    case 'rm':
    case 'remove':
      return rm(args[0], args[1], opts)
    default:
      throw UsageError()
  }
}
 
const ls = async (pkg, opts) => {
  if (!pkg) {
    const pkgName = await readLocalPkg()
    if (!pkgName)
      throw UsageError()
 
    pkg = pkgName
  }
 
  const spec = npa(pkg)
 
  try {
    const packumentOpts = { ...opts, fullMetadata: true }
    const { maintainers } = await pacote.packument(spec, packumentOpts)
    if (!maintainers || !maintainers.length)
      output('no admin found')
    else
      output(maintainers.map(o => `${o.name} <${o.email}>`).join('\n'))
 
    return maintainers
  } catch (err) {
    log.error('owner ls', "Couldn't get owner data", pkg)
    throw err
  }
}
 
const validateAddOwner = (newOwner, owners) => {
  owners = owners || []
  for (const o of owners) {
    if (o.name === newOwner.name) {
      log.info(
        'owner add',
        'Already a package owner: ' + o.name + ' <' + o.email + '>'
      )
      return false
    }
  }
  return [
    ...owners,
    newOwner,
  ]
}
 
const add = async (user, pkg, opts) => {
  if (!user)
    throw UsageError()
 
  if (!pkg) {
    const pkgName = await readLocalPkg()
    if (!pkgName)
      throw UsageError()
 
    pkg = pkgName
  }
  log.verbose('owner add', '%s to %s', user, pkg)
 
  const spec = npa(pkg)
  return putOwners(spec, user, opts, validateAddOwner)
}
 
const validateRmOwner = (rmOwner, owners) => {
  let found = false
  const m = owners.filter(function (o) {
    var match = (o.name === rmOwner.name)
    found = found || match
    return !match
  })
 
  if (!found) {
    log.info('owner rm', 'Not a package owner: ' + rmOwner.name)
    return false
  }
 
  if (!m.length) {
    throw Object.assign(
      new Error(
        'Cannot remove all owners of a package. Add someone else first.'
      ),
      { code: 'EOWNERRM' }
    )
  }
 
  return m
}
 
const rm = async (user, pkg, opts) => {
  if (!user)
    throw UsageError()
 
  if (!pkg) {
    const pkgName = await readLocalPkg()
    if (!pkgName)
      throw UsageError()
 
    pkg = pkgName
  }
  log.verbose('owner rm', '%s from %s', user, pkg)
 
  const spec = npa(pkg)
  return putOwners(spec, user, opts, validateRmOwner)
}
 
const putOwners = async (spec, user, opts, validation) => {
  const uri = `/-/user/org.couchdb.user:${encodeURIComponent(user)}`
  let u = ''
 
  try {
    u = await npmFetch.json(uri, opts)
  } catch (err) {
    log.error('owner mutate', `Error getting user data for ${user}`)
    throw err
  }
 
  if (user && (!u || !u.name || u.error)) {
    throw Object.assign(
      new Error(
        "Couldn't get user data for " + user + ': ' + JSON.stringify(u)
      ),
      { code: 'EOWNERUSER' }
    )
  }
 
  // normalize user data
  u = { name: u.name, email: u.email }
 
  const data = await pacote.packument(spec, { ...opts, fullMetadata: true })
 
  // save the number of maintainers before validation for comparison
  const before = data.maintainers ? data.maintainers.length : 0
 
  const m = validation(u, data.maintainers)
  if (!m)
    return // invalid owners
 
  const body = {
    _id: data._id,
    _rev: data._rev,
    maintainers: m,
  }
  const dataPath = `/${spec.escapedName}/-rev/${encodeURIComponent(data._rev)}`
  const res = await otplease(opts, opts =>
    npmFetch.json(dataPath, {
      ...opts,
      method: 'PUT',
      body,
      spec,
    }))
 
  if (!res.error) {
    if (m.length < before)
      output(`- ${user} (${spec.name})`)
    else
      output(`+ ${user} (${spec.name})`)
  } else {
    throw Object.assign(
      new Error('Failed to update package: ' + JSON.stringify(res)),
      { code: 'EOWNERMUTATE' }
    )
  }
  return res
}
 
module.exports = Object.assign(cmd, { usage, completion })