cacache 11.0.3 → 11.3.1

package/CHANGELOG.md

@@ -2,6 +2,46 @@
 
 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.
 
+<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)
+
+
+### Features
+
+* **read:** add sync support to other internal read.js fns ([fe638b6](https://github.com/zkat/cacache/commit/fe638b6))
+
+
+
+<a name="11.1.0"></a>
+# [11.1.0](https://github.com/zkat/cacache/compare/v11.0.3...v11.1.0) (2018-08-01)
+
+
+### Features
+
+* **read:** add sync support for low-level content read ([b43af83](https://github.com/zkat/cacache/commit/b43af83))
+
+
+
 <a name="11.0.3"></a>
 ## [11.0.3](https://github.com/zkat/cacache/compare/v11.0.2...v11.0.3) (2018-08-01)
 

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)

package/lib/content/read.js

@@ -33,6 +33,21 @@ function read (cache, integrity, opts) {
   })
 }
 
+module.exports.sync = readSync
+function readSync (cache, integrity, opts) {
+  opts = ReadOpts(opts)
+  return withContentSriSync(cache, integrity, (cpath, sri) => {
+    const data = fs.readFileSync(cpath)
+    if (typeof opts.size === 'number' && opts.size !== data.length) {
+      throw sizeError(opts.size, data.length)
+    } else if (ssri.checkData(data, sri)) {
+      return data
+    } else {
+      throw integrityError(sri, cpath)
+    }
+  })
+}
+
 module.exports.stream = readStream
 module.exports.readStream = readStream
 function readStream (cache, integrity, opts) {
@@ -58,8 +73,10 @@ function readStream (cache, integrity, opts) {
 let copyFileAsync
 if (fs.copyFile) {
   module.exports.copy = copy
+  module.exports.copy.sync = copySync
   copyFileAsync = BB.promisify(fs.copyFile)
 }
+
 function copy (cache, integrity, dest, opts) {
   opts = ReadOpts(opts)
   return withContentSri(cache, integrity, (cpath, sri) => {
@@ -67,11 +84,18 @@ function copy (cache, integrity, dest, opts) {
   })
 }
 
+function copySync (cache, integrity, dest, opts) {
+  opts = ReadOpts(opts)
+  return withContentSriSync(cache, integrity, (cpath, sri) => {
+    return fs.copyFileSync(cpath, dest)
+  })
+}
+
 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}))
+    return lstatAsync(cpath).then(stat => ({size: stat.size, sri, stat}))
   }).catch(err => {
     if (err.code === 'ENOENT') { return false }
     if (err.code === 'EPERM') {
@@ -84,6 +108,26 @@ function hasContent (cache, integrity) {
   })
 }
 
+module.exports.hasContent.sync = hasContentSync
+function hasContentSync (cache, integrity) {
+  if (!integrity) { return false }
+  return withContentSriSync(cache, integrity, (cpath, sri) => {
+    try {
+      const stat = fs.lstatSync(cpath)
+      return {size: stat.size, sri, stat}
+    } catch (err) {
+      if (err.code === 'ENOENT') { return false }
+      if (err.code === 'EPERM') {
+        if (process.platform !== 'win32') {
+          throw err
+        } else {
+          return false
+        }
+      }
+    }
+  })
+}
+
 function withContentSri (cache, integrity, fn) {
   return BB.try(() => {
     const sri = ssri.parse(integrity)
@@ -112,6 +156,28 @@ function withContentSri (cache, integrity, fn) {
   })
 }
 
+function withContentSriSync (cache, integrity, fn) {
+  const sri = ssri.parse(integrity)
+  // If `integrity` has multiple entries, pick the first digest
+  // with available local data.
+  const algo = sri.pickAlgorithm()
+  const digests = sri[algo]
+  if (digests.length <= 1) {
+    const cpath = contentPath(cache, digests[0])
+    return fn(cpath, digests[0])
+  } else {
+    let lastErr = null
+    for (const meta of sri[sri.pickAlgorithm()]) {
+      try {
+        return withContentSriSync(cache, meta, fn)
+      } catch (err) {
+        lastErr = err
+      }
+    }
+    if (lastErr) { throw lastErr }
+  }
+}
+
 function sizeError (expected, found) {
   var err = new Error(Y`Bad data size: expected inserted data to be ${expected} bytes, but got ${found} instead`)
   err.expected = expected

package/lib/entry-index.js

@@ -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)
@@ -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

package/lib/util/fix-owner.js

@@ -31,6 +31,34 @@ function fixOwner (filepath, uid, gid) {
   )
 }
 
+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 => {
@@ -42,3 +70,21 @@ function mkdirfix (p, uid, gid, cb) {
     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/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/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.0.3",
+  "version": "11.3.1",
   "cache-version": {
     "content": "2",
     "index": "5"