feat: remove figgy-pudding

BREAKING CHANGE: drop figgy-pudding and use canonical option names.

Author: claudiahdz

get.js

@@ -1,8 +1,6 @@
 'use strict'
 
 const util = require('util')
-
-const figgyPudding = require('figgy-pudding')
 const fs = require('fs')
 const index = require('./lib/entry-index')
 const memo = require('./lib/memoization')
@@ -14,25 +12,19 @@ const Pipeline = require('minipass-pipeline')
 
 const writeFile = util.promisify(fs.writeFile)
 
-const GetOpts = figgyPudding({
-  integrity: {},
-  memoize: {},
-  size: {}
-})
-
 module.exports = function get (cache, key, opts) {
   return getData(false, 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)
+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 && opts.memoize !== false) {
+  if (memoized && memoize !== false) {
     return Promise.resolve(
       byDigest
         ? memoized
@@ -50,23 +42,23 @@ function getData (byDigest, cache, key, opts) {
         throw new index.NotFoundError(cache, key)
       }
       return read(cache, byDigest ? key : entry.integrity, {
-        integrity: opts.integrity,
-        size: opts.size
+        integrity,
+        size
       })
         .then((data) =>
           byDigest
             ? data
             : {
+              data,
               metadata: entry.metadata,
-              data: data,
               size: entry.size,
               integrity: entry.integrity
             }
         )
         .then((res) => {
-          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
@@ -82,12 +74,12 @@ module.exports.sync.byDigest = function getByDigest (cache, digest, opts) {
   return getDataSync(true, cache, digest, opts)
 }
 
-function getDataSync (byDigest, cache, key, opts) {
-  opts = GetOpts(opts)
+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 && opts.memoize !== false) {
+  if (memoized && memoize !== false) {
     return byDigest
       ? memoized
       : {
@@ -102,8 +94,8 @@ function getDataSync (byDigest, cache, key, opts) {
     throw new index.NotFoundError(cache, key)
   }
   const data = read.sync(cache, byDigest ? key : entry.integrity, {
-    integrity: opts.integrity,
-    size: opts.size
+    integrity: integrity,
+    size: size
   })
   const res = byDigest
     ? data
@@ -113,9 +105,9 @@ 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
@@ -134,10 +126,10 @@ const getMemoizedStream = (memoized) => {
   return stream
 }
 
-function getStream (cache, key, opts) {
-  opts = GetOpts(opts)
+function getStream (cache, key, opts = {}) {
+  const { memoize, size } = opts
   const memoized = memo.get(cache, key, opts)
-  if (memoized && opts.memoize !== false) {
+  if (memoized && memoize !== false) {
     return getMemoizedStream(memoized)
   }
 
@@ -160,12 +152,10 @@ function getStream (cache, key, opts) {
       const src = read.readStream(
         cache,
         entry.integrity,
-        opts.concat({
-          size: opts.size == null ? entry.size : opts.size
-        })
+        { ...opts, size: typeof size !== 'number' ? entry.size : size }
       )
 
-      if (opts.memoize) {
+      if (memoize) {
         const memoStream = new Collect.PassThrough()
         memoStream.on('collect', data => memo.put(cache, entry, data, opts))
         stream.unshift(memoStream)
@@ -179,16 +169,16 @@ function getStream (cache, key, opts) {
 
 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) {
+  if (memoized && memoize !== false) {
     const stream = new Minipass()
     stream.end(memoized)
     return stream
   } else {
     const stream = read.readStream(cache, integrity, opts)
-    if (!opts.memoize) {
+    if (!memoize) {
       return stream
     }
     const memoStream = new Collect.PassThrough()
@@ -204,10 +194,10 @@ function getStreamDigest (cache, integrity, opts) {
 
 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) {
+  if (memoized && memoize !== false) {
     return Promise.resolve(memoized.entry)
   } else {
     return index.find(cache, key)
@@ -228,8 +218,7 @@ function cpDigest (cache, digest, dest, opts) {
 
 module.exports.copy.byDigest = cpDigest
 
-function copy (byDigest, cache, key, dest, opts) {
-  opts = GetOpts(opts)
+function copy (byDigest, cache, key, dest, opts = {}) {
   if (read.copy) {
     return (byDigest
       ? Promise.resolve(null)

lib/content/read.js

@@ -2,7 +2,6 @@
 
 const util = require('util')
 
-const figgyPudding = require('figgy-pudding')
 const fs = require('fs')
 const fsm = require('fs-minipass')
 const ssri = require('ssri')
@@ -12,21 +11,17 @@ const Pipeline = require('minipass-pipeline')
 const lstat = util.promisify(fs.lstat)
 const readFile = util.promisify(fs.readFile)
 
-const ReadOpts = figgyPudding({
-  size: {}
-})
-
 module.exports = read
 
 const MAX_SINGLE_READ_SIZE = 64 * 1024 * 1024
-function read (cache, integrity, opts) {
-  opts = ReadOpts(opts)
+function read (cache, integrity, opts = {}) {
+  const { size } = opts
   return withContentSri(cache, integrity, (cpath, sri) => {
     // get size
     return lstat(cpath).then(stat => ({ stat, cpath, sri }))
   }).then(({ stat, cpath, sri }) => {
-    if (typeof opts.size === 'number' && stat.size !== opts.size) {
-      throw sizeError(opts.size, stat.size)
+    if (typeof size === 'number' && stat.size !== size) {
+      throw sizeError(size, stat.size)
     }
     if (stat.size > MAX_SINGLE_READ_SIZE) {
       return readPipeline(cpath, stat.size, sri, new Pipeline()).concat()
@@ -57,12 +52,12 @@ const readPipeline = (cpath, size, sri, stream) => {
 
 module.exports.sync = readSync
 
-function readSync (cache, integrity, opts) {
-  opts = ReadOpts(opts)
+function readSync (cache, integrity, opts = {}) {
+  const { size } = 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)
+    if (typeof size === 'number' && size !== data.length) {
+      throw sizeError(size, data.length)
     }
 
     if (ssri.checkData(data, sri)) {
@@ -76,16 +71,15 @@ function readSync (cache, integrity, opts) {
 module.exports.stream = readStream
 module.exports.readStream = readStream
 
-function readStream (cache, integrity, opts) {
-  opts = ReadOpts(opts)
-
+function readStream (cache, integrity, opts = {}) {
+  const { size } = opts
   const stream = new Pipeline()
   withContentSri(cache, integrity, (cpath, sri) => {
     // just lstat to ensure it exists
     return lstat(cpath).then((stat) => ({ stat, cpath, sri }))
   }).then(({ stat, cpath, sri }) => {
-    if (typeof opts.size === 'number' && opts.size !== stat.size) {
-      return stream.emit('error', sizeError(opts.size, stat.size))
+    if (typeof size === 'number' && size !== stat.size) {
+      return stream.emit('error', sizeError(size, stat.size))
     }
     readPipeline(cpath, stat.size, sri, stream)
   }, er => stream.emit('error', er))
@@ -100,15 +94,13 @@ if (fs.copyFile) {
   copyFile = util.promisify(fs.copyFile)
 }
 
-function copy (cache, integrity, dest, opts) {
-  opts = ReadOpts(opts)
+function copy (cache, integrity, dest) {
   return withContentSri(cache, integrity, (cpath, sri) => {
     return copyFile(cpath, dest)
   })
 }
 
-function copySync (cache, integrity, dest, opts) {
-  opts = ReadOpts(opts)
+function copySync (cache, integrity, dest) {
   return withContentSriSync(cache, integrity, (cpath, sri) => {
     return fs.copyFileSync(cpath, dest)
   })

lib/content/write.js

@@ -20,19 +20,17 @@ const writeFile = util.promisify(fs.writeFile)
 
 module.exports = write
 
-function write (cache, data, opts) {
-  opts = opts || {}
-  if (opts.algorithms && opts.algorithms.length > 1) {
+function write (cache, data, opts = {}) {
+  const { algorithms, size, integrity } = opts
+  if (algorithms && algorithms.length > 1) {
     throw new Error('opts.algorithms only supports a single algorithm for now')
   }
-  if (typeof opts.size === 'number' && data.length !== opts.size) {
-    return Promise.reject(sizeError(opts.size, data.length))
+  if (typeof size === 'number' && data.length !== size) {
+    return Promise.reject(sizeError(size, data.length))
   }
-  const sri = ssri.fromData(data, {
-    algorithms: opts.algorithms
-  })
-  if (opts.integrity && !ssri.checkData(data, opts.integrity, opts)) {
-    return Promise.reject(checksumError(opts.integrity, sri))
+  const sri = ssri.fromData(data, { algorithms })
+  if (integrity && !ssri.checkData(data, integrity, opts)) {
+    return Promise.reject(checksumError(integrity, sri))
   }
 
   return disposer(makeTmp(cache, opts), makeTmpDisposer,
@@ -90,8 +88,7 @@ class CacacheWriteStream extends Flush {
   }
 }
 
-function writeStream (cache, opts) {
-  opts = opts || {}
+function writeStream (cache, opts = {}) {
   return new CacacheWriteStream(cache, opts)
 }
 

lib/entry-index.js

@@ -3,7 +3,6 @@
 const util = require('util')
 
 const crypto = require('crypto')
-const figgyPudding = require('figgy-pudding')
 const fs = require('fs')
 const Minipass = require('minipass')
 const path = require('path')
@@ -26,22 +25,17 @@ module.exports.NotFoundError = class NotFoundError extends Error {
   }
 }
 
-const IndexOpts = figgyPudding({
-  metadata: {},
-  size: {}
-})
-
 module.exports.insert = insert
 
-function insert (cache, key, integrity, opts) {
-  opts = IndexOpts(opts)
+function insert (cache, key, integrity, opts = {}) {
+  const { metadata, size } = opts
   const bucket = bucketPath(cache, key)
   const entry = {
     key,
     integrity: integrity && ssri.stringify(integrity),
     time: Date.now(),
-    size: opts.size,
-    metadata: opts.metadata
+    size,
+    metadata
   }
   return fixOwner
     .mkdirfix(cache, path.dirname(bucket))
@@ -75,15 +69,15 @@ function insert (cache, key, integrity, opts) {
 
 module.exports.insert.sync = insertSync
 
-function insertSync (cache, key, integrity, opts) {
-  opts = IndexOpts(opts)
+function insertSync (cache, key, integrity, opts = {}) {
+  const { metadata, size } = opts
   const bucket = bucketPath(cache, key)
   const entry = {
     key,
     integrity: integrity && ssri.stringify(integrity),
     time: Date.now(),
-    size: opts.size,
-    metadata: opts.metadata
+    size,
+    metadata
   }
   fixOwner.mkdirfix.sync(cache, path.dirname(bucket))
   const stringified = JSON.stringify(entry)

lib/util/tmp.js

@@ -2,22 +2,17 @@
 
 const util = require('util')
 
-const figgyPudding = require('figgy-pudding')
 const fixOwner = require('./fix-owner')
 const path = require('path')
 const rimraf = util.promisify(require('rimraf'))
 const uniqueFilename = require('unique-filename')
 const { disposer } = require('./disposer')
 
-const TmpOpts = figgyPudding({
-  tmpPrefix: {}
-})
-
 module.exports.mkdir = mktmpdir
 
-function mktmpdir (cache, opts) {
-  opts = TmpOpts(opts)
-  const tmpTarget = uniqueFilename(path.join(cache, 'tmp'), opts.tmpPrefix)
+function mktmpdir (cache, opts = {}) {
+  const { tmpPrefix } = opts
+  const tmpTarget = uniqueFilename(path.join(cache, 'tmp'), tmpPrefix)
   return fixOwner.mkdirfix(cache, tmpTarget).then(() => {
     return tmpTarget
   })
@@ -28,10 +23,8 @@ module.exports.withTmp = withTmp
 function withTmp (cache, opts, cb) {
   if (!cb) {
     cb = opts
-    opts = null
+    opts = {}
   }
-  opts = TmpOpts(opts)
-
   return disposer(mktmpdir(cache, opts), rimraf, cb)
 }
 

lib/verify.js

@@ -4,7 +4,6 @@ const util = require('util')
 
 const pMap = require('p-map')
 const contentPath = require('./content/path')
-const figgyPudding = require('figgy-pudding')
 const fixOwner = require('./util/fix-owner')
 const fs = require('fs')
 const fsm = require('fs-minipass')
@@ -22,20 +21,16 @@ const truncate = util.promisify(fs.truncate)
 const writeFile = util.promisify(fs.writeFile)
 const readFile = util.promisify(fs.readFile)
 
-const VerifyOpts = figgyPudding({
-  concurrency: {
-    default: 20
-  },
-  filter: {},
-  log: {
-    default: { silly () {} }
-  }
+const verifyOpts = (opts) => ({
+  concurrency: 20,
+  log: { silly () {} },
+  ...opts
 })
 
 module.exports = verify
 
 function verify (cache, opts) {
-  opts = VerifyOpts(opts)
+  opts = verifyOpts(opts)
   opts.log.silly('verify', 'verifying cache at', cache)
 
   const steps = [

package.json

@@ -58,10 +58,9 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "chownr": "^1.1.4",
-    "figgy-pudding": "^3.5.1",
-    "fs-minipass": "^2.1.0",
-    "glob": "^7.1.6",
+    "chownr": "^1.1.2",
+    "fs-minipass": "^2.0.0",
+    "glob": "^7.1.4",
     "infer-owner": "^1.0.4",
     "lru-cache": "^5.1.1",
     "minipass": "^3.1.1",

put.js

@@ -1,38 +1,27 @@
 'use strict'
 
-const figgyPudding = require('figgy-pudding')
 const index = require('./lib/entry-index')
 const memo = require('./lib/memoization')
 const write = require('./lib/content/write')
 const Flush = require('minipass-flush')
 const { PassThrough } = require('minipass-collect')
 const Pipeline = require('minipass-pipeline')
 
-const PutOpts = figgyPudding({
-  algorithms: {
-    default: ['sha512']
-  },
-  integrity: {},
-  memoize: {},
-  metadata: {},
-  pickAlgorithm: {},
-  size: {},
-  tmpPrefix: {},
-  single: {},
-  sep: {},
-  error: {},
-  strict: {}
+const putOpts = (opts) => ({
+  algorithms: ['sha512'],
+  ...opts
 })
 
 module.exports = putData
 
-function putData (cache, key, data, opts) {
-  opts = PutOpts(opts)
+function putData (cache, key, data, opts = {}) {
+  const { memoize } = opts
+  opts = putOpts(opts)
   return write(cache, data, opts).then((res) => {
     return index
-      .insert(cache, key, res.integrity, opts.concat({ size: res.size }))
+      .insert(cache, key, res.integrity, { ...opts, size: res.size })
       .then((entry) => {
-        if (opts.memoize) {
+        if (memoize) {
           memo.put(cache, entry, data, opts)
         }
         return res.integrity
@@ -42,16 +31,17 @@ function putData (cache, key, data, opts) {
 
 module.exports.stream = putStream
 
-function putStream (cache, key, opts) {
-  opts = PutOpts(opts)
+function putStream (cache, key, opts = {}) {
+  const { memoize } = opts
+  opts = putOpts(opts)
   let integrity
   let size
 
   let memoData
   const pipeline = new Pipeline()
   // first item in the pipeline is the memoizer, because we need
   // that to end first and get the collected data.
-  if (opts.memoize) {
+  if (memoize) {
     const memoizer = new PassThrough().on('collect', data => {
       memoData = data
     })
@@ -75,9 +65,9 @@ function putStream (cache, key, opts) {
   pipeline.push(new Flush({
     flush () {
       return index
-        .insert(cache, key, integrity, opts.concat({ size }))
+        .insert(cache, key, integrity, { ...opts, size })
         .then((entry) => {
-          if (opts.memoize && memoData) {
+          if (memoize && memoData) {
             memo.put(cache, entry, memoData, opts)
           }
           if (integrity) {