fix: remove format and/or codec options (ipfs#69)

IPFS is all `dag-pb` yet we allow passing `dag-cbor` as the format of IPLD node to use. This is likely to break anything that uses it as tools expect IPFS stuff to be `dag-pb`, possibly with `raw` leaves. Closes ipfs#67 BREAKING CHANGE: `--format` and/or `--codec` option has been removed from the CLI, the HTTP API and the core API.
galtproject · Jan 9, 2020 · 009fb98 · 009fb98
1 parent 38a8b51
commit 009fb98
Show file tree

Hide file tree

Showing 39 changed files with 14 additions and 383 deletions.
diff --git a/package.json b/package.json
@@ -73,7 +73,7 @@
     "ipfs-multipart": "^0.3.0",
     "ipfs-unixfs": "^0.3.0",
     "ipfs-unixfs-exporter": "^0.40.0",
-    "ipfs-unixfs-importer": "^0.43.0",
+    "ipfs-unixfs-importer": "^0.43.1",
     "ipfs-utils": "^0.4.2",
     "ipld-dag-pb": "^0.18.0",
     "it-last": "^1.0.1",

diff --git a/src/cli/chmod.js b/src/cli/chmod.js
@@ -27,12 +27,6 @@ module.exports = {
       coerce: asBoolean,
       describe: 'Whether to change modes recursively'
     },
-    codec: {
-      alias: 'c',
-      type: 'string',
-      default: 'dag-pb',
-      describe: 'If intermediate directories are created, use this codec to create them (experimental)'
-    },
     'hash-alg': {
       alias: 'h',
       type: 'string',
@@ -59,7 +53,6 @@ module.exports = {
       mode,
       getIpfs,
       recursive,
-      codec,
       hashAlg,
       flush,
       shardSplitThreshold
@@ -70,7 +63,6 @@ module.exports = {
 
       return ipfs.files.chmod(path, mode, {
         recursive,
-        format: codec,
         hashAlg,
         flush,
         shardSplitThreshold

diff --git a/src/cli/cp.js b/src/cli/cp.js
@@ -17,12 +17,6 @@ module.exports = {
       coerce: asBoolean,
       describe: 'Create any non-existent intermediate directories'
     },
-    codec: {
-      alias: 'c',
-      type: 'string',
-      default: 'dag-pb',
-      describe: 'If intermediate directories are created, use this codec to create them (experimental)'
-    },
     'hash-alg': {
       alias: 'h',
       type: 'string',
@@ -49,7 +43,6 @@ module.exports = {
       dest,
       getIpfs,
       parents,
-      codec,
       flush,
       hashAlg,
       shardSplitThreshold
@@ -59,7 +52,6 @@ module.exports = {
       const ipfs = await getIpfs()
       return ipfs.files.cp(source, dest, {
         parents,
-        format: codec,
         flush,
         hashAlg,
         shardSplitThreshold

diff --git a/src/cli/mkdir.js b/src/cli/mkdir.js
@@ -25,12 +25,6 @@ module.exports = {
       default: 0,
       describe: 'Cid version to use. (experimental).'
     },
-    codec: {
-      alias: 'c',
-      type: 'string',
-      default: 'dag-pb',
-      describe: 'If intermediate directories are created, use this codec to create them (experimental)'
-    },
     'hash-alg': {
       alias: 'h',
       type: 'string',
@@ -67,7 +61,6 @@ module.exports = {
       getIpfs,
       parents,
       cidVersion,
-      codec,
       hashAlg,
       flush,
       shardSplitThreshold,
@@ -81,7 +74,6 @@ module.exports = {
       return ipfs.files.mkdir(path, {
         parents,
         cidVersion,
-        format: codec,
         hashAlg,
         flush,
         shardSplitThreshold,

diff --git a/src/cli/mv.js b/src/cli/mv.js
@@ -30,12 +30,6 @@ module.exports = {
       default: 0,
       describe: 'Cid version to use. (experimental).'
     },
-    codec: {
-      alias: 'c',
-      type: 'string',
-      default: 'dag-pb',
-      describe: 'If intermediate directories are created, use this codec to create them (experimental)'
-    },
     'hash-alg': {
       alias: 'h',
       type: 'string',
@@ -64,7 +58,6 @@ module.exports = {
       parents,
       recursive,
       cidVersion,
-      codec,
       hashAlg,
       flush,
       shardSplitThreshold
@@ -77,7 +70,6 @@ module.exports = {
         parents,
         recursive,
         cidVersion,
-        format: codec,
         hashAlg,
         flush,
         shardSplitThreshold

diff --git a/src/cli/touch.js b/src/cli/touch.js
@@ -31,12 +31,6 @@ module.exports = {
       default: 0,
       describe: 'Cid version to use. (experimental).'
     },
-    codec: {
-      alias: 'c',
-      type: 'string',
-      default: 'dag-pb',
-      describe: 'If intermediate directories are created, use this codec to create them (experimental)'
-    },
     'hash-alg': {
       alias: 'h',
       type: 'string',
@@ -56,7 +50,6 @@ module.exports = {
       getIpfs,
       flush,
       cidVersion,
-      codec,
       hashAlg,
       shardSplitThreshold,
       mtime
@@ -69,7 +62,6 @@ module.exports = {
         mtime,
         flush,
         cidVersion,
-        format: codec,
         hashAlg,
         shardSplitThreshold
       })

diff --git a/src/cli/write.js b/src/cli/write.js
@@ -78,11 +78,6 @@ module.exports = {
       type: 'string',
       default: 'sha2-256'
     },
-    codec: {
-      alias: ['c'],
-      type: 'string',
-      default: 'dag-pb'
-    },
     'shard-split-threshold': {
       type: 'number',
       default: 1000,
@@ -114,7 +109,6 @@ module.exports = {
       reduceSingleLeafToSelf,
       cidVersion,
       hashAlg,
-      codec,
       parents,
       progress,
       strategy,
@@ -136,7 +130,6 @@ module.exports = {
         reduceSingleLeafToSelf,
         cidVersion,
         hashAlg,
-        format: codec,
         parents,
         progress,
         strategy,

diff --git a/src/core/chmod.js b/src/core/chmod.js
@@ -16,7 +16,6 @@ const mh = require('multihashes')
 const defaultOptions = {
   flush: true,
   shardSplitThreshold: 1000,
-  format: 'dag-pb',
   hashAlg: 'sha2-256',
   cidVersion: 0,
   recursive: false
@@ -174,7 +173,7 @@ module.exports = (context) => {
 
     const updatedCid = await context.ipld.put(node, mc.DAG_PB, {
       cidVersion: cid.version,
-      hashAlg: mh.names['sha2-256'],
+      hashAlg: mh.names[options.hashAlg],
       onlyHash: !options.flush
     })
 
@@ -188,8 +187,7 @@ module.exports = (context) => {
       cid: updatedCid,
       size: node.serialize().length,
       flush: options.flush,
-      format: 'dag-pb',
-      hashAlg: 'sha2-256',
+      hashAlg: options.hashAlg,
       cidVersion: cid.version
     })
 

diff --git a/src/core/cp.js b/src/core/cp.js
@@ -15,7 +15,6 @@ const toTrail = require('./utils/to-trail')
 const defaultOptions = {
   parents: false,
   flush: true,
-  format: 'dag-pb',
   hashAlg: 'sha2-256',
   cidVersion: 0,
   shardSplitThreshold: 1000
@@ -150,7 +149,6 @@ const addSourceToParent = async (context, source, childName, parent, options) =>
     size: sourceBlock.data.length,
     cid: source.cid,
     name: childName,
-    format: options.format,
     hashAlg: options.hashAlg,
     cidVersion: options.cidVersion,
     flush: options.flush

diff --git a/src/core/mkdir.js b/src/core/mkdir.js
@@ -19,7 +19,6 @@ const defaultOptions = {
   hashAlg: 'sha2-256',
   cidVersion: 0,
   shardSplitThreshold: 1000,
-  format: 'dag-pb',
   flush: true,
   mode: null,
   mtime: null
@@ -116,7 +115,6 @@ const addEmptyDir = async (context, childName, emptyDir, parent, trail, options)
     size: emptyDir.node.size,
     cid: emptyDir.cid,
     name: childName,
-    format: options.format,
     hashAlg: options.hashAlg,
     cidVersion: options.cidVersion,
     mode: options.mode,

diff --git a/src/core/mv.js b/src/core/mv.js
@@ -10,7 +10,6 @@ const defaultOptions = {
   recursive: false,
   flush: true,
   cidVersion: 0,
-  format: 'dag-pb',
   hashAlg: 'sha2-256',
   shardSplitThreshold: 1000
 }

diff --git a/src/core/rm.js b/src/core/rm.js
@@ -16,7 +16,6 @@ const defaultOptions = {
   recursive: false,
   cidVersion: 0,
   hashAlg: 'sha2-256',
-  format: 'dag-pb',
   flush: true
 }
 
@@ -64,7 +63,6 @@ const removePath = async (context, path, options) => {
   } = await removeLink(context, {
     parentCid: parent.cid,
     name: child.name,
-    format: options.format,
     hashAlg: options.hashAlg,
     cidVersion: options.cidVersion,
     flush: options.flush

diff --git a/src/core/touch.js b/src/core/touch.js
@@ -18,7 +18,6 @@ const defaultOptions = {
   flush: true,
   shardSplitThreshold: 1000,
   cidVersion: 0,
-  format: 'dag-pb',
   hashAlg: 'sha2-256'
 }
 
@@ -85,7 +84,6 @@ module.exports = (context) => {
       size: node.serialize().length,
       flush: options.flush,
       shardSplitThreshold: options.shardSplitThreshold,
-      format: 'dag-pb',
       hashAlg: 'sha2-256',
       cidVersion
     })

diff --git a/src/core/utils/add-link.js b/src/core/utils/add-link.js
@@ -99,11 +99,10 @@ const addToDirectory = async (context, options) => {
   node.mtime = new Date()
   options.parent = new DAGNode(node.marshal(), options.parent.Links)
 
-  const format = mc[options.format.toUpperCase().replace(/-/g, '_')]
   const hashAlg = mh.names[options.hashAlg]
 
   // Persist the new parent DAGNode
-  const cid = await context.ipld.put(options.parent, format, {
+  const cid = await context.ipld.put(options.parent, mc.DAG_PB, {
     cidVersion: options.cidVersion,
     hashAlg,
     onlyHash: !options.flush

diff --git a/src/core/utils/apply-default-options.js b/src/core/utils/apply-default-options.js
@@ -17,13 +17,6 @@ module.exports = (options = {}, defaults) => {
     }
   }
 
-  const format = output.format || output.codec
-
-  if (format && isNaN(format)) {
-    output.format = format
-    delete output.codec
-  }
-
   // support legacy go arguments
   if (options.count !== undefined) {
     output.length = options.count

diff --git a/src/core/utils/create-node.js b/src/core/utils/create-node.js
@@ -8,7 +8,6 @@ const mc = require('multicodec')
 const mh = require('multihashes')
 
 const createNode = async (context, type, options) => {
-  const format = mc[options.format.toUpperCase().replace(/-/g, '_')]
   const hashAlg = mh.names[options.hashAlg]
   const metadata = new UnixFS({
     type,
@@ -17,7 +16,7 @@ const createNode = async (context, type, options) => {
   })
 
   const node = new DAGNode(metadata.marshal())
-  const cid = await context.ipld.put(node, format, {
+  const cid = await context.ipld.put(node, mc.DAG_PB, {
     cidVersion: options.cidVersion,
     hashAlg,
     onlyHash: !options.flush

diff --git a/src/core/utils/hamt-utils.js b/src/core/utils/hamt-utils.js
@@ -24,11 +24,9 @@ const updateHamtDirectory = async (context, links, bucket, options) => {
     mtime: node.mtime
   })
 
-  const format = mc[options.format.toUpperCase().replace(/-/g, '_')]
   const hashAlg = mh.names[options.hashAlg]
-
   const parent = new DAGNode(dir.marshal(), links)
-  const cid = await context.ipld.put(parent, format, {
+  const cid = await context.ipld.put(parent, mc.DAG_PB, {
     cidVersion: options.cidVersion,
     hashAlg,
     onlyHash: !options.flush
@@ -184,7 +182,10 @@ const createShard = async (context, contents, options) => {
     flat: false,
     mtime: options.mtime,
     mode: options.mode
-  }, options)
+  }, {
+    ...options,
+    codec: 'dag-pb'
+  })
 
   for (let i = 0; i < contents.length; i++) {
     await shard._bucket.put(contents[i].name, {

diff --git a/src/core/utils/remove-link.js b/src/core/utils/remove-link.js
@@ -48,11 +48,10 @@ const removeLink = async (context, options) => {
 }
 
 const removeFromDirectory = async (context, options) => {
-  const format = mc[options.format.toUpperCase().replace(/-/g, '_')]
   const hashAlg = mh.names[options.hashAlg]
 
   options.parent.rmLink(options.name)
-  const cid = await context.ipld.put(options.parent, format, {
+  const cid = await context.ipld.put(options.parent, mc.DAG_PB, {
     cidVersion: options.cidVersion,
     hashAlg
   })
@@ -79,7 +78,6 @@ const removeFromShardedDirectory = async (context, options) => {
     cid: options.cid,
     size: options.size,
     hashAlg: options.hashAlg,
-    format: options.format,
     cidVersion: options.cidVersion,
     flush: options.flush
   }, options)

diff --git a/src/core/utils/update-tree.js b/src/core/utils/update-tree.js
@@ -39,7 +39,6 @@ const updateTree = async (context, trail, options) => {
       size: child.size,
       flush: options.flush,
       shardSplitThreshold: options.shardSplitThreshold,
-      format: options.format,
       hashAlg: options.hashAlg,
       cidVersion: options.cidVersion
     })

diff --git a/src/core/write.js b/src/core/write.js
@@ -28,7 +28,6 @@ const defaultOptions = {
   reduceSingleLeafToSelf: false,
   cidVersion: 0,
   hashAlg: 'sha2-256',
-  format: 'dag-pb',
   parents: false, // whether to create intermediate directories if they do not exist
   progress: () => {},
   strategy: 'trickle',
@@ -104,7 +103,6 @@ const updateOrImport = async (context, path, source, destination, options) => {
       size: child.size,
       flush: options.flush,
       shardSplitThreshold: options.shardSplitThreshold,
-      format: options.format,
       hashAlg: options.hashAlg,
       cidVersion: options.cidVersion
     })