cacache 11.2.0 → 11.3.3

package/CHANGELOG.md

@@ -1,7 +1,50 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [11.3.3](https://github.com/zkat/cacache/compare/v11.3.2...v11.3.3) (2019-06-17)
+
+
+### Bug Fixes
+
+* **audit:** npm audit fix ([200a6d5](https://github.com/zkat/cacache/commit/200a6d5))
+* **config:** Add ssri config 'error' option ([#146](https://github.com/zkat/cacache/issues/146)) ([47de8f5](https://github.com/zkat/cacache/commit/47de8f5))
+* **deps:** npm audit fix ([481a7dc](https://github.com/zkat/cacache/commit/481a7dc))
+* **standard:** standard --fix ([7799149](https://github.com/zkat/cacache/commit/7799149))
+* **write:** avoid another cb never called situation ([5156561](https://github.com/zkat/cacache/commit/5156561))
+
+
+
+<a name="11.3.2"></a>
+## [11.3.2](https://github.com/zkat/cacache/compare/v11.3.1...v11.3.2) (2018-12-21)
+
+
+### Bug Fixes
+
+* **get:** make sure to handle errors in the .then ([b10bcd0](https://github.com/zkat/cacache/commit/b10bcd0))
+
+
+
+<a name="11.3.1"></a>
+## [11.3.1](https://github.com/zkat/cacache/compare/v11.3.0...v11.3.1) (2018-11-05)
+
+
+### Bug Fixes
+
+* **get:** export hasContent.sync properly ([d76c920](https://github.com/zkat/cacache/commit/d76c920))
+
+
+
+<a name="11.3.0"></a>
+# [11.3.0](https://github.com/zkat/cacache/compare/v11.2.0...v11.3.0) (2018-11-05)
+
+
+### Features
+
+* **get:** add sync API for reading ([db1e094](https://github.com/zkat/cacache/commit/db1e094))
+
+
+
 <a name="11.2.0"></a>
 # [11.2.0](https://github.com/zkat/cacache/compare/v11.1.0...v11.2.0) (2018-08-08)
 

package/README.es.md

@@ -287,7 +287,7 @@ entrada si existe.
 
 * `key` - Clave de la entrada. Igual al argumento `clave`.
 * `integrity` - [hacheo de Subresource Integrity](#integrity) del contenido al que se refiere esta entrada.
-* `path` - Dirección del fichero de datos almacenados, relativa al argumento `cache`.
+* `path` - Dirección del fichero de datos almacenados, unida al argumento `cache`.
 * `time` - Hora de creación de la entrada
 * `metadata` - Metadatos asignados a esta entrada por el usuario
 

package/README.md

@@ -290,7 +290,7 @@ one exists.
 
 * `key` - Key the entry was looked up under. Matches the `key` argument.
 * `integrity` - [Subresource Integrity hash](#integrity) for the content this entry refers to.
-* `path` - Filesystem path relative to `cache` argument where content is stored.
+* `path` - Filesystem path where content is stored, joined with `cache` argument.
 * `time` - Timestamp the entry was first added on.
 * `metadata` - User-assigned metadata associated with the entry/content.
 

package/get.js

@@ -63,6 +63,55 @@ function getData (byDigest, cache, key, opts) {
   })
 }
 
+module.exports.sync = function get (cache, key, opts) {
+  return getDataSync(false, cache, key, opts)
+}
+module.exports.sync.byDigest = function getByDigest (cache, digest, opts) {
+  return getDataSync(true, cache, digest, opts)
+}
+function getDataSync (byDigest, cache, key, opts) {
+  opts = GetOpts(opts)
+  const memoized = (
+    byDigest
+      ? memo.get.byDigest(cache, key, opts)
+      : memo.get(cache, key, opts)
+  )
+  if (memoized && opts.memoize !== false) {
+    return byDigest ? memoized : {
+      metadata: memoized.entry.metadata,
+      data: memoized.data,
+      integrity: memoized.entry.integrity,
+      size: memoized.entry.size
+    }
+  }
+  const entry = !byDigest && index.find.sync(cache, key, opts)
+  if (!entry && !byDigest) {
+    throw new index.NotFoundError(cache, key)
+  }
+  const data = read.sync(
+    cache,
+    byDigest ? key : entry.integrity,
+    {
+      integrity: opts.integrity,
+      size: opts.size
+    }
+  )
+  const res = byDigest
+    ? data
+    : {
+      metadata: entry.metadata,
+      data: data,
+      size: entry.size,
+      integrity: entry.integrity
+    }
+  if (opts.memoize && byDigest) {
+    memo.put.byDigest(cache, key, res, opts)
+  } else if (opts.memoize) {
+    memo.put(cache, entry, res.data, opts)
+  }
+  return res
+}
+
 module.exports.stream = getStream
 function getStream (cache, key, opts) {
   opts = GetOpts(opts)
@@ -113,7 +162,7 @@ function getStream (cache, key, opts) {
       memoStream,
       stream
     )
-  }, err => stream.emit('error', err))
+  }).catch(err => stream.emit('error', err))
   return stream
 }
 

package/lib/content/path.js

@@ -12,7 +12,7 @@ const ssri = require('ssri')
 //
 module.exports = contentPath
 function contentPath (cache, integrity) {
-  const sri = ssri.parse(integrity, {single: true})
+  const sri = ssri.parse(integrity, { single: true })
   // contentPath is the *strongest* algo given
   return path.join.apply(path, [
     contentDir(cache),

package/lib/content/read.js

@@ -54,8 +54,8 @@ function readStream (cache, integrity, opts) {
   opts = ReadOpts(opts)
   const stream = new PassThrough()
   withContentSri(cache, integrity, (cpath, sri) => {
-    return lstatAsync(cpath).then(stat => ({cpath, sri, stat}))
-  }).then(({cpath, sri, stat}) => {
+    return lstatAsync(cpath).then(stat => ({ cpath, sri, stat }))
+  }).then(({ cpath, sri, stat }) => {
     return pipe(
       fs.createReadStream(cpath),
       ssri.integrityStream({
@@ -95,7 +95,7 @@ module.exports.hasContent = hasContent
 function hasContent (cache, integrity) {
   if (!integrity) { return BB.resolve(false) }
   return withContentSri(cache, integrity, (cpath, sri) => {
-    return lstatAsync(cpath).then(stat => ({size: stat.size, sri, stat}))
+    return lstatAsync(cpath).then(stat => ({ size: stat.size, sri, stat }))
   }).catch(err => {
     if (err.code === 'ENOENT') { return false }
     if (err.code === 'EPERM') {
@@ -114,7 +114,7 @@ function hasContentSync (cache, integrity) {
   return withContentSriSync(cache, integrity, (cpath, sri) => {
     try {
       const stat = fs.lstatSync(cpath)
-      return {size: stat.size, sri, stat}
+      return { size: stat.size, sri, stat }
     } catch (err) {
       if (err.code === 'ENOENT') { return false }
       if (err.code === 'EPERM') {
@@ -141,12 +141,12 @@ function withContentSri (cache, integrity, fn) {
     } else {
       return BB.any(sri[sri.pickAlgorithm()].map(meta => {
         return withContentSri(cache, meta, fn)
-      }, {concurrency: 1}))
+      }, { concurrency: 1 }))
         .catch(err => {
           if ([].some.call(err, e => e.code === 'ENOENT')) {
             throw Object.assign(
               new Error('No matching content found for ' + sri.toString()),
-              {code: 'ENOENT'}
+              { code: 'ENOENT' }
             )
           } else {
             throw err[0]

package/lib/content/write.js

@@ -36,11 +36,11 @@ function write (cache, data, opts) {
   }
   return BB.using(makeTmp(cache, opts), tmp => (
     writeFileAsync(
-      tmp.target, data, {flag: 'wx'}
+      tmp.target, data, { flag: 'wx' }
     ).then(() => (
       moveToDestination(tmp, cache, sri, opts)
     ))
-  )).then(() => ({integrity: sri, size: data.length}))
+  )).then(() => ({ integrity: sri, size: data.length }))
 }
 
 module.exports.stream = writeStream
@@ -111,8 +111,8 @@ function pipeToTmp (inputStream, cache, tmpTarget, opts, errCheck) {
     })
     errCheck()
     return pipe(inputStream, hashStream, outStream).then(() => {
-      return {integrity, size}
-    }, err => {
+      return { integrity, size }
+    }).catch(err => {
       return rimraf(tmpTarget).then(() => { throw err })
     })
   })

package/lib/entry-index.js

@@ -64,7 +64,7 @@ function insert (cache, key, integrity, opts) {
     )
   }).then(
     () => fixOwner.chownr(bucket, opts.uid, opts.gid)
-  ).catch({code: 'ENOENT'}, () => {
+  ).catch({ code: 'ENOENT' }, () => {
     // There's a class of race conditions that happen when things get deleted
     // during fixOwner, or between the two mkdirfix/chownr calls.
     //
@@ -75,10 +75,36 @@ function insert (cache, key, integrity, opts) {
   })
 }
 
+module.exports.insert.sync = insertSync
+function insertSync (cache, key, integrity, opts) {
+  opts = IndexOpts(opts)
+  const bucket = bucketPath(cache, key)
+  const entry = {
+    key,
+    integrity: integrity && ssri.stringify(integrity),
+    time: Date.now(),
+    size: opts.size,
+    metadata: opts.metadata
+  }
+  fixOwner.mkdirfix.sync(path.dirname(bucket), opts.uid, opts.gid)
+  const stringified = JSON.stringify(entry)
+  fs.appendFileSync(
+    bucket, `\n${hashEntry(stringified)}\t${stringified}`
+  )
+  try {
+    fixOwner.chownr.sync(bucket, opts.uid, opts.gid)
+  } catch (err) {
+    if (err.code !== 'ENOENT') {
+      throw err
+    }
+  }
+  return formatEntry(cache, entry)
+}
+
 module.exports.find = find
 function find (cache, key) {
   const bucket = bucketPath(cache, key)
-  return bucketEntries(cache, bucket).then(entries => {
+  return bucketEntries(bucket).then(entries => {
     return entries.reduce((latest, next) => {
       if (next && next.key === key) {
         return formatEntry(cache, next)
@@ -95,11 +121,36 @@ function find (cache, key) {
   })
 }
 
+module.exports.find.sync = findSync
+function findSync (cache, key) {
+  const bucket = bucketPath(cache, key)
+  try {
+    return bucketEntriesSync(bucket).reduce((latest, next) => {
+      if (next && next.key === key) {
+        return formatEntry(cache, next)
+      } else {
+        return latest
+      }
+    }, null)
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return null
+    } else {
+      throw err
+    }
+  }
+}
+
 module.exports.delete = del
 function del (cache, key, opts) {
   return insert(cache, key, null, opts)
 }
 
+module.exports.delete.sync = delSync
+function delSync (cache, key, opts) {
+  return insertSync(cache, key, null, opts)
+}
+
 module.exports.lsStream = lsStream
 function lsStream (cache) {
   const indexDir = bucketDir(cache)
@@ -116,7 +167,6 @@ function lsStream (cache) {
       // "/cachename/<bucket 0xFF>/<bucket 0xFF>/*"
       return readdirOrEmpty(subbucketPath).map(entry => {
         const getKeyToEntry = bucketEntries(
-          cache,
           path.join(subbucketPath, entry)
         ).reduce((acc, entry) => {
           acc.set(entry.key, entry)
@@ -128,7 +178,7 @@ function lsStream (cache) {
             const formatted = formatEntry(cache, entry)
             formatted && stream.push(formatted)
           }
-        }).catch({code: 'ENOENT'}, nop)
+        }).catch({ code: 'ENOENT' }, nop)
       })
     })
   }).then(() => {
@@ -152,32 +202,39 @@ function ls (cache) {
   })
 }
 
-function bucketEntries (cache, bucket, filter) {
+function bucketEntries (bucket, filter) {
   return readFileAsync(
     bucket, 'utf8'
-  ).then(data => {
-    let entries = []
-    data.split('\n').forEach(entry => {
-      if (!entry) { return }
-      const pieces = entry.split('\t')
-      if (!pieces[1] || hashEntry(pieces[1]) !== pieces[0]) {
-        // Hash is no good! Corruption or malice? Doesn't matter!
-        // EJECT EJECT
-        return
-      }
-      let obj
-      try {
-        obj = JSON.parse(pieces[1])
-      } catch (e) {
-        // Entry is corrupted!
-        return
-      }
-      if (obj) {
-        entries.push(obj)
-      }
-    })
-    return entries
+  ).then(data => _bucketEntries(data, filter))
+}
+
+function bucketEntriesSync (bucket, filter) {
+  const data = fs.readFileSync(bucket, 'utf8')
+  return _bucketEntries(data, filter)
+}
+
+function _bucketEntries (data, filter) {
+  let entries = []
+  data.split('\n').forEach(entry => {
+    if (!entry) { return }
+    const pieces = entry.split('\t')
+    if (!pieces[1] || hashEntry(pieces[1]) !== pieces[0]) {
+      // Hash is no good! Corruption or malice? Doesn't matter!
+      // EJECT EJECT
+      return
+    }
+    let obj
+    try {
+      obj = JSON.parse(pieces[1])
+    } catch (e) {
+      // Entry is corrupted!
+      return
+    }
+    if (obj) {
+      entries.push(obj)
+    }
   })
+  return entries
 }
 
 module.exports._bucketDir = bucketDir
@@ -225,8 +282,8 @@ function formatEntry (cache, entry) {
 
 function readdirOrEmpty (dir) {
   return readdirAsync(dir)
-    .catch({code: 'ENOENT'}, () => [])
-    .catch({code: 'ENOTDIR'}, () => [])
+    .catch({ code: 'ENOENT' }, () => [])
+    .catch({ code: 'ENOTDIR' }, () => [])
 }
 
 function nop () {

package/lib/util/fix-owner.js

@@ -27,18 +27,64 @@ function fixOwner (filepath, uid, gid) {
       filepath,
       typeof uid === 'number' ? uid : process.getuid(),
       typeof gid === 'number' ? gid : process.getgid()
-    ).catch({code: 'ENOENT'}, () => null)
+    ).catch({ code: 'ENOENT' }, () => null)
   )
 }
 
+module.exports.chownr.sync = fixOwnerSync
+function fixOwnerSync (filepath, uid, gid) {
+  if (!process.getuid) {
+    // This platform doesn't need ownership fixing
+    return
+  }
+  if (typeof uid !== 'number' && typeof gid !== 'number') {
+    // There's no permissions override. Nothing to do here.
+    return
+  }
+  if ((typeof uid === 'number' && process.getuid() === uid) &&
+      (typeof gid === 'number' && process.getgid() === gid)) {
+    // No need to override if it's already what we used.
+    return
+  }
+  try {
+    chownr.sync(
+      filepath,
+      typeof uid === 'number' ? uid : process.getuid(),
+      typeof gid === 'number' ? gid : process.getgid()
+    )
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return null
+    }
+  }
+}
+
 module.exports.mkdirfix = mkdirfix
 function mkdirfix (p, uid, gid, cb) {
   return mkdirp(p).then(made => {
     if (made) {
       return fixOwner(made, uid, gid).then(() => made)
     }
-  }).catch({code: 'EEXIST'}, () => {
+  }).catch({ code: 'EEXIST' }, () => {
     // There's a race in mkdirp!
     return fixOwner(p, uid, gid).then(() => null)
   })
 }
+
+module.exports.mkdirfix.sync = mkdirfixSync
+function mkdirfixSync (p, uid, gid) {
+  try {
+    const made = mkdirp.sync(p)
+    if (made) {
+      fixOwnerSync(made, uid, gid)
+      return made
+    }
+  } catch (err) {
+    if (err.code === 'EEXIST') {
+      fixOwnerSync(p, uid, gid)
+      return null
+    } else {
+      throw err
+    }
+  }
+}

package/lib/verify.js

@@ -130,7 +130,7 @@ function garbageCollect (cache, opts) {
             })
           })
         }
-      }, {concurrency: opts.concurrency}))
+      }, { concurrency: opts.concurrency }))
     })
   })
 }
@@ -150,7 +150,7 @@ function verifyContent (filepath, sri) {
         contentInfo.valid = false
       })
     }).then(() => contentInfo)
-  }).catch({code: 'ENOENT'}, () => ({size: 0, valid: false}))
+  }).catch({ code: 'ENOENT' }, () => ({ size: 0, valid: false }))
 }
 
 function rebuildIndex (cache, opts) {
@@ -183,7 +183,7 @@ function rebuildIndex (cache, opts) {
     }
     return BB.map(Object.keys(buckets), key => {
       return rebuildBucket(cache, buckets[key], stats, opts)
-    }, {concurrency: opts.concurrency}).then(() => stats)
+    }, { concurrency: opts.concurrency }).then(() => stats)
   })
 }
 
@@ -200,7 +200,7 @@ function rebuildBucket (cache, bucket, stats, opts) {
           metadata: entry.metadata,
           size: entry.size
         }).then(() => { stats.totalEntries++ })
-      }).catch({code: 'ENOENT'}, () => {
+      }).catch({ code: 'ENOENT' }, () => {
         stats.rejectedEntries++
         stats.missingContent++
       })

package/locales/en.js

@@ -18,12 +18,15 @@ x.ls.stream = cache => ls.stream(cache)
 
 x.get = (cache, key, opts) => get(cache, key, opts)
 x.get.byDigest = (cache, hash, opts) => get.byDigest(cache, hash, opts)
+x.get.sync = (cache, key, opts) => get.sync(cache, key, opts)
+x.get.sync.byDigest = (cache, key, opts) => get.sync.byDigest(cache, key, opts)
 x.get.stream = (cache, key, opts) => get.stream(cache, key, opts)
 x.get.stream.byDigest = (cache, hash, opts) => get.stream.byDigest(cache, hash, opts)
 x.get.copy = (cache, key, dest, opts) => get.copy(cache, key, dest, opts)
 x.get.copy.byDigest = (cache, hash, dest, opts) => get.copy.byDigest(cache, hash, dest, opts)
 x.get.info = (cache, key) => get.info(cache, key)
 x.get.hasContent = (cache, hash) => get.hasContent(cache, hash)
+x.get.hasContent.sync = (cache, hash) => get.hasContent.sync(cache, hash)
 
 x.put = (cache, key, data, opts) => put(cache, key, data, opts)
 x.put.stream = (cache, key, opts) => put.stream(cache, key, opts)

package/locales/en.json

@@ -2,5 +2,6 @@
   "No cache entry for `%s` found in `%s`": "No cache entry for %s found in %s",
   "Integrity verification failed for %s (%s)": "Integrity verification failed for %s (%s)",
   "Bad data size: expected inserted data to be %s bytes, but got %s instead": "Bad data size: expected inserted data to be %s bytes, but got %s instead",
-  "Cache input stream was empty": "Cache input stream was empty"
-}
+  "Cache input stream was empty": "Cache input stream was empty",
+  "Integrity check failed:\n  Wanted: %s\n   Found: %s": "Integrity check failed:\n  Wanted: %s\n   Found: %s"
+}

package/locales/es.js

@@ -18,12 +18,15 @@ x.ls.flujo = cache => ls.stream(cache)
 
 x.saca = (cache, clave, ops) => get(cache, clave, ops)
 x.saca.porHacheo = (cache, hacheo, ops) => get.byDigest(cache, hacheo, ops)
+x.saca.sinc = (cache, clave, ops) => get.sync(cache, clave, ops)
+x.saca.sinc.porHacheo = (cache, hacheo, ops) => get.sync.byDigest(cache, hacheo, ops)
 x.saca.flujo = (cache, clave, ops) => get.stream(cache, clave, ops)
 x.saca.flujo.porHacheo = (cache, hacheo, ops) => get.stream.byDigest(cache, hacheo, ops)
 x.sava.copia = (cache, clave, destino, opts) => get.copy(cache, clave, destino, opts)
 x.sava.copia.porHacheo = (cache, hacheo, destino, opts) => get.copy.byDigest(cache, hacheo, destino, opts)
 x.saca.info = (cache, clave) => get.info(cache, clave)
 x.saca.tieneDatos = (cache, hacheo) => get.hasContent(cache, hacheo)
+x.saca.tieneDatos.sinc = (cache, hacheo) => get.hasContent.sync(cache, hacheo)
 
 x.mete = (cache, clave, datos, ops) => put(cache, clave, datos, ops)
 x.mete.flujo = (cache, clave, ops) => put.stream(cache, clave, ops)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cacache",
-  "version": "11.2.0",
+  "version": "11.3.3",
   "cache-version": {
     "content": "2",
     "index": "5"
@@ -58,32 +58,32 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "bluebird": "^3.5.1",
-    "chownr": "^1.0.1",
-    "figgy-pudding": "^3.1.0",
-    "glob": "^7.1.2",
-    "graceful-fs": "^4.1.11",
-    "lru-cache": "^4.1.3",
+    "bluebird": "^3.5.5",
+    "chownr": "^1.1.1",
+    "figgy-pudding": "^3.5.1",
+    "glob": "^7.1.4",
+    "graceful-fs": "^4.1.15",
+    "lru-cache": "^5.1.1",
     "mississippi": "^3.0.0",
     "mkdirp": "^0.5.1",
     "move-concurrently": "^1.0.1",
     "promise-inflight": "^1.0.1",
-    "rimraf": "^2.6.2",
-    "ssri": "^6.0.0",
-    "unique-filename": "^1.1.0",
+    "rimraf": "^2.6.3",
+    "ssri": "^6.0.1",
+    "unique-filename": "^1.1.1",
     "y18n": "^4.0.0"
   },
   "devDependencies": {
     "benchmark": "^2.1.4",
-    "chalk": "^2.3.2",
+    "chalk": "^2.4.2",
     "cross-env": "^5.1.4",
-    "require-inject": "^1.4.2",
-    "standard": "^11.0.1",
-    "standard-version": "^4.4.0",
-    "tacks": "^1.2.7",
-    "tap": "^12.0.1",
+    "require-inject": "^1.4.4",
+    "standard": "^12.0.1",
+    "standard-version": "^6.0.1",
+    "tacks": "^1.3.0",
+    "tap": "^12.7.0",
     "weallbehave": "^1.2.0",
-    "weallcontribute": "^1.0.8"
+    "weallcontribute": "^1.0.9"
   },
   "config": {
     "nyc": {

package/put.js

@@ -20,6 +20,7 @@ const PutOpts = figgyPudding({
   gid: {},
   single: {},
   sep: {},
+  error: {},
   strict: {}
 })
 
@@ -28,7 +29,7 @@ function putData (cache, key, data, opts) {
   opts = PutOpts(opts)
   return write(cache, data, opts).then(res => {
     return index.insert(
-      cache, key, res.integrity, opts.concat({size: res.size})
+      cache, key, res.integrity, opts.concat({ size: res.size })
     ).then(entry => {
       if (opts.memoize) {
         memo.put(cache, entry, data, opts)
@@ -63,7 +64,7 @@ function putStream (cache, key, opts) {
     })
   }, cb => {
     contentStream.end(() => {
-      index.insert(cache, key, integrity, opts.concat({size})).then(entry => {
+      index.insert(cache, key, integrity, opts.concat({ size })).then(entry => {
         if (opts.memoize) {
           memo.put(cache, entry, Buffer.concat(memoData, memoTotal), opts)
         }