cacache 12.0.4 → 15.0.0

package/get.js

@@ -1,21 +1,16 @@
 'use strict'
 
-const BB = require('bluebird')
-
-const figgyPudding = require('figgy-pudding')
+const util = require('util')
 const fs = require('fs')
 const index = require('./lib/entry-index')
 const memo = require('./lib/memoization')
-const pipe = require('mississippi').pipe
-const pipeline = require('mississippi').pipeline
 const read = require('./lib/content/read')
-const through = require('mississippi').through
 
-const GetOpts = figgyPudding({
-  integrity: {},
-  memoize: {},
-  size: {}
-})
+const Minipass = require('minipass')
+const Collect = require('minipass-collect')
+const Pipeline = require('minipass-pipeline')
+
+const writeFile = util.promisify(fs.writeFile)
 
 module.exports = function get (cache, key, opts) {
   return getData(false, cache, key, opts)
@@ -23,44 +18,53 @@ module.exports = function get (cache, key, opts) {
 module.exports.byDigest = function getByDigest (cache, digest, opts) {
   return getData(true, cache, digest, opts)
 }
-function getData (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 BB.resolve(byDigest ? memoized : {
-      metadata: memoized.entry.metadata,
-      data: memoized.data,
-      integrity: memoized.entry.integrity,
-      size: memoized.entry.size
-    })
+
+function getData (byDigest, cache, key, opts = {}) {
+  const { integrity, memoize, size } = opts
+  const memoized = byDigest
+    ? memo.get.byDigest(cache, key, opts)
+    : memo.get(cache, key, opts)
+  if (memoized && memoize !== false) {
+    return Promise.resolve(
+      byDigest
+        ? memoized
+        : {
+          metadata: memoized.entry.metadata,
+          data: memoized.data,
+          integrity: memoized.entry.integrity,
+          size: memoized.entry.size
+        }
+    )
   }
-  return (
-    byDigest ? BB.resolve(null) : index.find(cache, key, opts)
-  ).then(entry => {
-    if (!entry && !byDigest) {
-      throw new index.NotFoundError(cache, key)
-    }
-    return read(cache, byDigest ? key : entry.integrity, {
-      integrity: opts.integrity,
-      size: opts.size
-    }).then(data => byDigest ? data : {
-      metadata: entry.metadata,
-      data: data,
-      size: entry.size,
-      integrity: entry.integrity
-    }).then(res => {
-      if (opts.memoize && byDigest) {
-        memo.put.byDigest(cache, key, res, opts)
-      } else if (opts.memoize) {
-        memo.put(cache, entry, res.data, opts)
+  return (byDigest ? Promise.resolve(null) : index.find(cache, key, opts)).then(
+    (entry) => {
+      if (!entry && !byDigest) {
+        throw new index.NotFoundError(cache, key)
       }
-      return res
-    })
-  })
+      return read(cache, byDigest ? key : entry.integrity, {
+        integrity,
+        size
+      })
+        .then((data) =>
+          byDigest
+            ? data
+            : {
+              data,
+              metadata: entry.metadata,
+              size: entry.size,
+              integrity: entry.integrity
+            }
+        )
+        .then((res) => {
+          if (memoize && byDigest) {
+            memo.put.byDigest(cache, key, res, opts)
+          } else if (memoize) {
+            memo.put(cache, entry, res.data, opts)
+          }
+          return res
+        })
+    }
+  )
 }
 
 module.exports.sync = function get (cache, key, opts) {
@@ -69,33 +73,30 @@ module.exports.sync = function get (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
-    }
+
+function getDataSync (byDigest, cache, key, opts = {}) {
+  const { integrity, memoize, size } = opts
+  const memoized = byDigest
+    ? memo.get.byDigest(cache, key, opts)
+    : memo.get(cache, key, opts)
+  if (memoized && 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 data = read.sync(cache, byDigest ? key : entry.integrity, {
+    integrity: integrity,
+    size: size
+  })
   const res = byDigest
     ? data
     : {
@@ -104,106 +105,100 @@ function getDataSync (byDigest, cache, key, opts) {
       size: entry.size,
       integrity: entry.integrity
     }
-  if (opts.memoize && byDigest) {
+  if (memoize && byDigest) {
     memo.put.byDigest(cache, key, res, opts)
-  } else if (opts.memoize) {
+  } else if (memoize) {
     memo.put(cache, entry, res.data, opts)
   }
   return res
 }
 
 module.exports.stream = getStream
-function getStream (cache, key, opts) {
-  opts = GetOpts(opts)
-  let stream = through()
+
+const getMemoizedStream = (memoized) => {
+  const stream = new Minipass()
+  stream.on('newListener', function (ev, cb) {
+    ev === 'metadata' && cb(memoized.entry.metadata)
+    ev === 'integrity' && cb(memoized.entry.integrity)
+    ev === 'size' && cb(memoized.entry.size)
+  })
+  stream.end(memoized.data)
+  return stream
+}
+
+function getStream (cache, key, opts = {}) {
+  const { memoize, size } = opts
   const memoized = memo.get(cache, key, opts)
-  if (memoized && opts.memoize !== false) {
-    stream.on('newListener', function (ev, cb) {
-      ev === 'metadata' && cb(memoized.entry.metadata)
-      ev === 'integrity' && cb(memoized.entry.integrity)
-      ev === 'size' && cb(memoized.entry.size)
-    })
-    stream.write(memoized.data, () => stream.end())
-    return stream
+  if (memoized && memoize !== false) {
+    return getMemoizedStream(memoized)
   }
-  index.find(cache, key).then(entry => {
-    if (!entry) {
-      return stream.emit(
-        'error', new index.NotFoundError(cache, key)
-      )
-    }
-    let memoStream
-    if (opts.memoize) {
-      let memoData = []
-      let memoLength = 0
-      memoStream = through((c, en, cb) => {
-        memoData && memoData.push(c)
-        memoLength += c.length
-        cb(null, c, en)
-      }, cb => {
-        memoData && memo.put(cache, entry, Buffer.concat(memoData, memoLength), opts)
-        cb()
+
+  const stream = new Pipeline()
+  index
+    .find(cache, key)
+    .then((entry) => {
+      if (!entry) {
+        throw new index.NotFoundError(cache, key)
+      }
+      stream.emit('metadata', entry.metadata)
+      stream.emit('integrity', entry.integrity)
+      stream.emit('size', entry.size)
+      stream.on('newListener', function (ev, cb) {
+        ev === 'metadata' && cb(entry.metadata)
+        ev === 'integrity' && cb(entry.integrity)
+        ev === 'size' && cb(entry.size)
       })
-    } else {
-      memoStream = through()
-    }
-    stream.emit('metadata', entry.metadata)
-    stream.emit('integrity', entry.integrity)
-    stream.emit('size', entry.size)
-    stream.on('newListener', function (ev, cb) {
-      ev === 'metadata' && cb(entry.metadata)
-      ev === 'integrity' && cb(entry.integrity)
-      ev === 'size' && cb(entry.size)
+
+      const src = read.readStream(
+        cache,
+        entry.integrity,
+        { ...opts, size: typeof size !== 'number' ? entry.size : size }
+      )
+
+      if (memoize) {
+        const memoStream = new Collect.PassThrough()
+        memoStream.on('collect', data => memo.put(cache, entry, data, opts))
+        stream.unshift(memoStream)
+      }
+      stream.unshift(src)
     })
-    pipe(
-      read.readStream(cache, entry.integrity, opts.concat({
-        size: opts.size == null ? entry.size : opts.size
-      })),
-      memoStream,
-      stream
-    )
-  }).catch(err => stream.emit('error', err))
+    .catch((err) => stream.emit('error', err))
+
   return stream
 }
 
 module.exports.stream.byDigest = getStreamDigest
-function getStreamDigest (cache, integrity, opts) {
-  opts = GetOpts(opts)
+
+function getStreamDigest (cache, integrity, opts = {}) {
+  const { memoize } = opts
   const memoized = memo.get.byDigest(cache, integrity, opts)
-  if (memoized && opts.memoize !== false) {
-    const stream = through()
-    stream.write(memoized, () => stream.end())
+  if (memoized && memoize !== false) {
+    const stream = new Minipass()
+    stream.end(memoized)
     return stream
   } else {
-    let stream = read.readStream(cache, integrity, opts)
-    if (opts.memoize) {
-      let memoData = []
-      let memoLength = 0
-      const memoStream = through((c, en, cb) => {
-        memoData && memoData.push(c)
-        memoLength += c.length
-        cb(null, c, en)
-      }, cb => {
-        memoData && memo.put.byDigest(
-          cache,
-          integrity,
-          Buffer.concat(memoData, memoLength),
-          opts
-        )
-        cb()
-      })
-      stream = pipeline(stream, memoStream)
+    const stream = read.readStream(cache, integrity, opts)
+    if (!memoize) {
+      return stream
     }
-    return stream
+    const memoStream = new Collect.PassThrough()
+    memoStream.on('collect', data => memo.put.byDigest(
+      cache,
+      integrity,
+      data,
+      opts
+    ))
+    return new Pipeline(stream, memoStream)
   }
 }
 
 module.exports.info = info
-function info (cache, key, opts) {
-  opts = GetOpts(opts)
+
+function info (cache, key, opts = {}) {
+  const { memoize } = opts
   const memoized = memo.get(cache, key, opts)
-  if (memoized && opts.memoize !== false) {
-    return BB.resolve(memoized.entry)
+  if (memoized && memoize !== false) {
+    return Promise.resolve(memoized.entry)
   } else {
     return index.find(cache, key)
   }
@@ -211,37 +206,50 @@ function info (cache, key, opts) {
 
 module.exports.hasContent = read.hasContent
 
-module.exports.copy = function cp (cache, key, dest, opts) {
+function cp (cache, key, dest, opts) {
   return copy(false, cache, key, dest, opts)
 }
-module.exports.copy.byDigest = function cpDigest (cache, digest, dest, opts) {
+
+module.exports.copy = cp
+
+function cpDigest (cache, digest, dest, opts) {
   return copy(true, cache, digest, dest, opts)
 }
-function copy (byDigest, cache, key, dest, opts) {
-  opts = GetOpts(opts)
+
+module.exports.copy.byDigest = cpDigest
+
+function copy (byDigest, cache, key, dest, opts = {}) {
   if (read.copy) {
-    return (
-      byDigest ? BB.resolve(null) : index.find(cache, key, opts)
-    ).then(entry => {
+    return (byDigest
+      ? Promise.resolve(null)
+      : index.find(cache, key, opts)
+    ).then((entry) => {
       if (!entry && !byDigest) {
         throw new index.NotFoundError(cache, key)
       }
-      return read.copy(
-        cache, byDigest ? key : entry.integrity, dest, opts
-      ).then(() => byDigest ? key : {
-        metadata: entry.metadata,
-        size: entry.size,
-        integrity: entry.integrity
-      })
+      return read
+        .copy(cache, byDigest ? key : entry.integrity, dest, opts)
+        .then(() => {
+          return byDigest
+            ? key
+            : {
+              metadata: entry.metadata,
+              size: entry.size,
+              integrity: entry.integrity
+            }
+        })
     })
-  } else {
-    return getData(byDigest, cache, key, opts).then(res => {
-      return fs.writeFileAsync(dest, byDigest ? res : res.data)
-        .then(() => byDigest ? key : {
+  }
+
+  return getData(byDigest, cache, key, opts).then((res) => {
+    return writeFile(dest, byDigest ? res : res.data).then(() => {
+      return byDigest
+        ? key
+        : {
           metadata: res.metadata,
           size: res.size,
           integrity: res.integrity
-        })
+        }
     })
-  }
+  })
 }

package/index.js

@@ -1,3 +1,41 @@
 'use strict'
 
-module.exports = require('./locales/en.js')
+const ls = require('./ls.js')
+const get = require('./get.js')
+const put = require('./put.js')
+const rm = require('./rm.js')
+const verify = require('./verify.js')
+const { clearMemoized } = require('./lib/memoization.js')
+const tmp = require('./lib/util/tmp.js')
+
+module.exports.ls = ls
+module.exports.ls.stream = ls.stream
+
+module.exports.get = get
+module.exports.get.byDigest = get.byDigest
+module.exports.get.sync = get.sync
+module.exports.get.sync.byDigest = get.sync.byDigest
+module.exports.get.stream = get.stream
+module.exports.get.stream.byDigest = get.stream.byDigest
+module.exports.get.copy = get.copy
+module.exports.get.copy.byDigest = get.copy.byDigest
+module.exports.get.info = get.info
+module.exports.get.hasContent = get.hasContent
+module.exports.get.hasContent.sync = get.hasContent.sync
+
+module.exports.put = put
+module.exports.put.stream = put.stream
+
+module.exports.rm = rm.entry
+module.exports.rm.all = rm.all
+module.exports.rm.entry = module.exports.rm
+module.exports.rm.content = rm.content
+
+module.exports.clearMemoized = clearMemoized
+
+module.exports.tmp = {}
+module.exports.tmp.mkdir = tmp.mkdir
+module.exports.tmp.withTmp = tmp.withTmp
+
+module.exports.verify = verify
+module.exports.verify.lastRun = verify.lastRun

package/lib/content/path.js

@@ -11,16 +11,19 @@ const ssri = require('ssri')
 // ~/.my-cache/content-v2/sha512/ba/da/55deadbeefc0ffee
 //
 module.exports = contentPath
+
 function contentPath (cache, integrity) {
   const sri = ssri.parse(integrity, { single: true })
   // contentPath is the *strongest* algo given
-  return path.join.apply(path, [
+  return path.join(
     contentDir(cache),
-    sri.algorithm
-  ].concat(hashToSegments(sri.hexDigest())))
+    sri.algorithm,
+    ...hashToSegments(sri.hexDigest())
+  )
 }
 
-module.exports._contentDir = contentDir
+module.exports.contentDir = contentDir
+
 function contentDir (cache) {
   return path.join(cache, `content-v${contentVer}`)
 }