[API-844] Add support to return progress of upload (#116)

* Add support to return progress of upload

* Undo rename

* Add progress update to stream as well

Co-authored-by: Else ten Broeke <[email protected]>

Author: elseee

samples/upload.js

@@ -16,7 +16,7 @@ bynder.getBrands()
             brandId: brand.id,
             name: 'test asset'
           }
-        });
+        }, console.log);
     })
     .then(console.log)
     .catch((error) => {

src/bynder-js-sdk.js

@@ -874,9 +874,10 @@ class Bynder {
    * @param {Number} file.length - The length of the file to be uploaded
    * @param {string} endpoint - S3 endpoint url
    * @param {Object} init - Result from init upload
+   * @param {progressCallback} [progressCallback] - Function which is called anytime there is a progress update
    * @return {Promise}
    */
-  uploadFileInChunks(file, endpoint, init) {
+  uploadFileInChunks(file, endpoint, init, progressCallback) {
     const { body } = file;
     const bodyType = bodyTypes.get(body);
     const length = getLength(file);
@@ -918,6 +919,14 @@ class Bynder {
       });
     }
 
+    progressCallback({
+      action: 'Uploading file',
+      completed: 'Initializing',
+      chunksUploaded: 0,
+      chunks,
+    });
+
+
     // sequentially upload chunks to AWS, then register them
     function nextChunk(chunkNumber) {
       if (chunkNumber >= chunks) {
@@ -931,6 +940,12 @@ class Bynder {
           // our read stream is not done yet reading
           // let's wait for a while...
           return delay(50).then(() => {
+            progressCallback({
+              action: 'Uploading file',
+              completed: 'Initializing',
+              chunksUploaded: chunkNumber,
+              chunks,
+            });
             return nextChunk(chunkNumber);
           });
         }
@@ -946,12 +961,28 @@ class Bynder {
           return registerChunk(init, newChunkNumber);
         })
         .then(() => {
+          progressCallback({
+            action: 'Uploading file',
+            completed: 'Initializing',
+            chunksUploaded: chunkNumber,
+            chunks,
+          });
           return nextChunk(newChunkNumber);
         });
     }
     return nextChunk(0);
   }
 
+  /**
+ * Callback for adding two numbers.
+ *
+ * @callback progressCallback
+ * @param {Object} state={} - An object containing the progress state
+ * @param {String} state.action - The next action
+ * @param {String} [state.completed] - The last completed action
+ * @param {Number} [state.chunks] - Total amount of chunks
+ * @param {Number} state.chunksUploaded - Amount of chunks already uploaded
+ */
   /**
    * Uploads an arbitrarily sized buffer or stream file and returns the uploaded asset information
    * @see {@link https://bynder.docs.apiary.io/#reference/upload-assets}
@@ -961,9 +992,10 @@ class Bynder {
    * @param {Number} file.length - The length of the file to be uploaded
    * @param {Object} file.data={} - An object containing the assets' attributes
    * @param {Boolean} file.additional - Boolean that signals if the asset should be added as additional to an existing asset
+   * @param {progressCallback} [progressCallback] - Function which is called anytime there is a progress update
    * @return {Promise} The information of the uploaded file, including IDs and all final file urls.
    */
-  uploadFile(file) {
+  uploadFile(file, progressCallback = () => {}) {
     const { body, filename, data, additional } = file;
     const { brandId } = data;
     const bodyType = bodyTypes.get(body);
@@ -991,14 +1023,26 @@ class Bynder {
     const finaliseUpload = this.finaliseUpload.bind(this);
     const saveAsset = this.saveAsset.bind(this);
     const waitForUploadDone = this.waitForUploadDone.bind(this);
+    let totalChunks;
 
+    progressCallback({
+      action: 'Initializing',
+      chunksUploaded: 0,
+    });
     return Promise.all([getClosestUploadEndpoint(), initUpload(filename)])
       .then(res => {
         const [endpoint, init] = res;
-        return uploadFileInChunks(file, endpoint, init);
+        return uploadFileInChunks(file, endpoint, init, progressCallback);
       })
       .then(uploadResponse => {
         const { init, chunkNumber } = uploadResponse;
+        totalChunks = chunkNumber;
+        progressCallback({
+          action: 'Finalizing upload',
+          completed: 'Uploading file',
+          chunksUploaded: chunkNumber,
+          chunks: chunkNumber,
+        });
         return finaliseUpload(init, filename, chunkNumber, additional ? data.id : null);
       }).then(finalizeResponse => {
         if (additional) {
@@ -1013,6 +1057,12 @@ class Bynder {
         }
         const { itemsDone } = doneResponse;
         const importId = itemsDone[0];
+        progressCallback({
+          action: 'Saving asset',
+          completed: 'Finalizing upload',
+          chunksUploaded: totalChunks,
+          chunks: totalChunks,
+        });
         return saveAsset(Object.assign(data, { importId }));
       });
   }