Progress bar for cli

examples/traverse-ipld-graphs/git.js

@@ -47,13 +47,13 @@ createNode((err, ipfs) => {
 
     const v1tag = 'z8mWaGfwSWLMPJ6Q2JdsAjGiXTf61Nbue'
 
-    function errOrLog(comment) {
+    function errOrLog (comment) {
       return (err, result) => {
         if (err) {
           throw err
         }
 
-        if (Buffer.isBuffer(result.value)) { //Blobs (files) are returned as buffer instance
+        if (Buffer.isBuffer(result.value)) { // Blobs (files) are returned as buffer instance
           result.value = result.value.toString()
         }
 
@@ -63,7 +63,6 @@ createNode((err, ipfs) => {
       }
     }
 
-
     ipfs.dag.get(v1tag + '/', errOrLog('Tag object:'))
     ipfs.dag.get(v1tag + '/object/message', errOrLog('Tagged commit message:'))
     ipfs.dag.get(v1tag + '/object/parents/0/message', errOrLog('Parent of tagged commit:'))

package.json

@@ -92,9 +92,11 @@
     "async": "^2.5.0",
     "bl": "^1.2.1",
     "boom": "^5.2.0",
+    "byteman": "^1.3.5",
     "cids": "~0.5.1",
     "debug": "^3.0.1",
     "fsm-event": "^2.1.0",
+    "get-folder-size": "^1.0.0",
     "glob": "^7.1.2",
     "hapi": "^16.5.2",
     "hapi-set-header": "^1.0.2",
@@ -134,6 +136,7 @@
     "peer-book": "~0.5.0",
     "peer-id": "~0.10.0",
     "peer-info": "~0.11.0",
+    "progress": "^2.0.0",
     "promisify-es6": "^1.0.3",
     "pull-file": "^1.0.0",
     "pull-paramap": "^1.2.2",

src/cli/commands/files/add.js

@@ -8,6 +8,10 @@ const pull = require('pull-stream')
 const paramap = require('pull-paramap')
 const zip = require('pull-zip')
 const toPull = require('stream-to-pull-stream')
+const Progress = require('progress')
+const getFolderSize = require('get-folder-size')
+const byteman = require('byteman')
+const waterfall = require('async/waterfall')
 const utils = require('../../utils')
 const print = require('../../utils').print
 
@@ -40,6 +44,27 @@ function checkPath (inPath, recursive) {
   return inPath
 }
 
+function getTotalBytes (path, recursive, cb) {
+  if (recursive) {
+    getFolderSize(path, cb)
+  } else {
+    fs.stat(path, (err, stat) => cb(err, stat.size))
+  }
+}
+
+function createProgressBar (totalBytes) {
+  const total = byteman(totalBytes, 2, 'MB')
+  const barFormat = `:progress / ${total} [:bar] :percent :etas`
+
+  // 16 MB / 34 MB [===========             ] 48% 5.8s //
+  return new Progress(barFormat, {
+    incomplete: ' ',
+    clear: true,
+    stream: process.stdout,
+    total: totalBytes
+  })
+}
+
 function addPipeline (index, addStream, list, wrapWithDirectory) {
   pull(
     zip(
@@ -92,6 +117,12 @@ module.exports = {
   describe: 'Add a file to IPFS using the UnixFS data format',
 
   builder: {
+    progress: {
+      alias: 'p',
+      type: 'boolean',
+      default: true,
+      describe: 'Stream progress data'
+    },
     recursive: {
       alias: 'r',
       type: 'boolean',
@@ -158,34 +189,45 @@ module.exports = {
     }
     const ipfs = argv.ipfs
 
-    // TODO: revist when interface-ipfs-core exposes pull-streams
-    let createAddStream = (cb) => {
-      ipfs.files.createAddStream(options, (err, stream) => {
-        cb(err, err ? null : toPull.transform(stream))
-      })
-    }
-
-    if (typeof ipfs.files.createAddPullStream === 'function') {
-      createAddStream = (cb) => {
-        cb(null, ipfs.files.createAddPullStream(options))
-      }
-    }
+    let list = []
+    let currentBytes = 0
+
+    waterfall([
+      (next) => glob(path.join(inPath, '/**/*'), next),
+      (globResult, next) => {
+        list = globResult.length === 0 ? [inPath] : globResult
+
+        getTotalBytes(inPath, argv.recursive, next)
+      },
+      (totalBytes, next) => {
+        if (argv.progress) {
+          const bar = createProgressBar(totalBytes)
+          options.progress = function (byteLength) {
+            currentBytes += byteLength
+            bar.tick(byteLength, {progress: byteman(currentBytes, 2, 'MB')})
+          }
+        }
 
-    createAddStream((err, addStream) => {
-      if (err) {
-        throw err
-      }
+        // TODO: revist when interface-ipfs-core exposes pull-streams
 
-      glob(path.join(inPath, '/**/*'), (err, list) => {
-        if (err) {
-          throw err
+        let createAddStream = (cb) => {
+          ipfs.files.createAddStream(options, (err, stream) => {
+            cb(err, err ? null : toPull.transform(stream))
+          })
         }
-        if (list.length === 0) {
-          list = [inPath]
+
+        if (typeof ipfs.files.createAddPullStream === 'function') {
+          createAddStream = (cb) => {
+            cb(null, ipfs.files.createAddPullStream(options))
+          }
         }
 
-        addPipeline(index, addStream, list, argv.wrapWithDirectory)
-      })
+        createAddStream(next)
+      }
+    ], (err, addStream) => {
+      if (err) throw err
+
+      addPipeline(index, addStream, list, argv.wrapWithDirectory)
     })
   }
 }