- Make resume(), pause(), cancel(), removeFile(), and retry() async since these

  deal with async operations under the hood.
- Remove the need to call readFinished() from the `readFileFn`

Author: Raphaël Droz

README.md

@@ -168,17 +168,17 @@ parameter must be adjusted together with `progressCallbacksInterval` parameter.
     * `.off(event)` Remove all callbacks of specific event.
     * `.off(event, callback)` Remove specific callback of event. `callback` should be a `Function`.
 * `.upload()` [async] Start or resume uploading.
-* `.pause()` Pause uploading.
-* `.resume()` Resume uploading.
-* `.cancel()` Cancel upload of all `FlowFile` objects and remove them from the list.
+* `.pause()` [async] Pause uploading.
+* `.resume()` [async] Resume uploading.
+* `.cancel()` [asyc] Cancel upload of all `FlowFile` objects and remove them from the list.
 * `.progress()` Returns a float between 0 and 1 indicating the current upload progress of all files.
 * `.isUploading()` Returns a boolean indicating whether or not the instance is currently uploading anything.
 * `.addFile(file, event = null, initFileFn = undefined)` [async] Add a HTML5 File object to the list of files.
     * Accept the same `event` and `initFileFn` parameters thant `addFiles` which is used under the hood.
 * `.addFiles([files], event = null, initFileFn = undefined)` [async] Add multiple File objects to the list of files and returns the promise of the corresponding FlowFiles.
     * `event` The optional event that trigger the addition (for internal purposes)
     * `initFileFn` An [async] override of Flow.initFileFn
-* `.removeFile(file)` Cancel upload of a specific `FlowFile` object on the list from the list.
+* `.removeFile(file)` [asyc] Cancel upload of a specific `FlowFile` object on the list from the list.
 * `.getFromUniqueIdentifier(uniqueIdentifier)` Look up a `FlowFile` object by its unique identifier.
 * `.getSize()` Returns the total size of the upload in bytes.
 * `.sizeUploaded()` Returns the total size uploaded of all files in bytes.
@@ -234,7 +234,7 @@ FlowFile constructor can be accessed in `Flow.FlowFile`.
 * `.progress(relative)` Returns a float between 0 and 1 indicating the current upload progress of the file. If `relative` is `true`, the value is returned relative to all files in the Flow.js instance.
 * `.pause()` Pause uploading the file.
 * `.resume()` [async] Resume uploading the file.
-* `.cancel()` Abort uploading the file and delete it from the list of files to upload.
+* `.cancel()` [async] Abort uploading the file and delete it from the list of files to upload.
 * `.retry()` [async] Retry uploading the file.
 * `.bootstrap()` [async / internal use only] Rebuild the state of a `FlowFile` object, including reassigning chunks and XMLHttpRequest instances.
 * `.isUploading()` Returns a boolean indicating whether file chunks is uploading.

src/Flow.js

@@ -4,7 +4,7 @@
 
 import Eventizer from './Eventizer';
 import FlowFile from './FlowFile';
-import {each, webAPIFileRead} from './tools';
+import {each} from './tools';
 
 /**
  * Flow.js is a library providing multiple simultaneous, stable and
@@ -33,7 +33,6 @@ import {each, webAPIFileRead} from './tools';
  * @param {Array.<number>} [opts.successStatuses]
  * @param {Function} [opts.initFileFn]
  * @param {Function} [opts.readFileFn]
- * @param {Function} [opts.asyncReadFileFn]
  * @param {Function} [opts.generateUniqueIdentifier]
  * @constructor
  */
@@ -101,8 +100,7 @@ export default class Flow extends Eventizer {
       successStatuses: [200, 201, 202],
       onDropStopPropagation: false,
       initFileFn: null,
-      readFileFn: webAPIFileRead,
-      asyncReadFileFn: null
+      readFileFn: (fileObj, startByte, endByte, fileType, chunk) => fileObj.file.slice(startByte, endByte, fileType)
     };
 
     /**
@@ -450,34 +448,29 @@ export default class Flow extends Eventizer {
 
   /**
    * Resume uploading.
+   * @return [<Promise>]
    * @function
    */
   resume() {
-    each(this.files, function (file) {
-      if (!file.isComplete()) {
-        file.resume();
-      }
-    });
+    return Promise.all(this.files.filter(file => !file.isComplete()).map(file => file.resume()));
   }
 
   /**
    * Pause uploading.
+   * @return [<Promise>]
    * @function
    */
   pause() {
-    each(this.files, function (file) {
-      file.pause();
-    });
+    return Promise.all(this.files.map(file => file.pause()));
   }
 
   /**
    * Cancel upload of all FlowFile objects and remove them from the list.
+   * @return [<Promise>]
    * @function
    */
   cancel() {
-    for (var i = this.files.length - 1; i >= 0; i--) {
-      this.files[i].cancel();
-    }
+    return Promise.all(this.files.reverse().map(file => file.cancel()));
   }
 
   /**
@@ -568,7 +561,7 @@ export default class Flow extends Eventizer {
     flowfiles = flowfiles.filter(e => e && e.file);
     for (let file of flowfiles) {
       if (this.opts.singleFile && this.files.length > 0) {
-        this.removeFile(this.files[0]);
+        await this.removeFile(this.files[0]);
       }
       this.files.push(file);
     }
@@ -582,11 +575,11 @@ export default class Flow extends Eventizer {
    * @function
    * @param {FlowFile} file
    */
-  removeFile(file) {
+  async removeFile(file) {
     for (var i = this.files.length - 1; i >= 0; i--) {
       if (this.files[i] === file) {
         this.files.splice(i, 1);
-        file.abort();
+        await file.abort();
         this.emit('file-removed', file);
 
         if (!this.opts.allowDuplicateUploads) {

src/FlowChunk.js

@@ -396,7 +396,8 @@ export default class FlowChunk {
     switch (this.readState) {
       case 0:
         this.readState = 1;
-        read(this.fileObj, this.startByte, this.endByte, this.fileObj.file.type, this);
+        const data = read(this.fileObj, this.startByte, this.endByte, this.fileObj.file.type, this);
+        this.readFinished(data);
         return;
       case 1:
         return;

src/FlowFile.js

@@ -173,16 +173,18 @@ export default class FlowFile {
 
   /**
    * Pause file upload
+   * @return Promise
    * @function
    */
   pause() {
     this.paused = true;
-    this.abort();
+    return this.abort();
   }
 
   /**
    * Resume file upload
    * @return Promise
+   * @function
    */
   resume() {
     this.paused = false;
@@ -193,7 +195,7 @@ export default class FlowFile {
    * Abort current upload
    * @function
    */
-  abort(reset) {
+  async abort(reset) {
     this.currentSpeed = 0;
     this.averageSpeed = 0;
     if (reset) {
@@ -203,26 +205,28 @@ export default class FlowFile {
       if (c.status() === 'uploading') {
         c.abort();
         c.pendingRetry = true;
-        this.flowObj.uploadNextChunk();
+        await this.flowObj.uploadNextChunk();
       }
     }
   }
 
   /**
    * Cancel current upload and remove from a list
+   * @return Promise
    * @function
    */
   cancel() {
-    this.flowObj.removeFile(this);
+    return this.flowObj.removeFile(this);
   }
 
   /**
    * Retry aborted file upload
+   * @return Promise
    * @function
    */
   async retry() {
     await this.bootstrap('retry');
-    return await this.flowObj.upload();
+    return this.flowObj.upload();
   }
 
   async bootstrap(event = null, initFileFn = this.flowObj.opts.initFileFn) {

src/tools.js

@@ -1,22 +1,3 @@
-/**
- * Default read function using the webAPI
- *
- * @function webAPIFileRead(fileObj, startByte, endByte, fileType, chunk)
- *
- */
-function webAPIFileRead(fileObj, startByte, endByte, fileType, chunk) {
-  var function_name = 'slice';
-
-  if (fileObj.file.slice)
-    function_name =  'slice';
-  else if (fileObj.file.mozSlice)
-    function_name = 'mozSlice';
-  else if (fileObj.file.webkitSlice)
-    function_name = 'webkitSlice';
-
-  chunk.readFinished(fileObj.file[function_name](startByte, endByte, fileType));
-}
-
 /**
  * If option is a function, evaluate it with given params
  * @param {*} data
@@ -72,6 +53,5 @@ g.evalOpts = evalOpts;
 
 export {
   each,
-  evalOpts,
-  webAPIFileRead
+  evalOpts
 };

test/asyncSpec.js

@@ -170,12 +170,12 @@ describe('upload stream', function() {
     expect(customFunction).toHaveBeenCalledTimes(1);
 
     // But if removed, then the function is run again
-    flow.removeFile(flowfiles[0]);
+    await flow.removeFile(flowfiles[0]);
     flowfiles = await flow.addFiles([sample_file], null, initFileFunction);
     expect(customFunction).toHaveBeenCalledTimes(2);
 
     // It should work with addFile() too.
-    flow.removeFile(flowfiles[0]);
+    await flow.removeFile(flowfiles[0]);
     flowfiles = await flow.addFile(sample_file, null, initFileFunction);
     expect(customFunction).toHaveBeenCalledTimes(3);
   });
@@ -335,7 +335,7 @@ describe('upload stream', function() {
     // Next two chunks from file[0] were read but we abort() their
     // corresponding `xhr`. They will get back to pending.
     // Flow should start uploading second file now
-    files[0].pause();
+    await files[0].pause();
     await waitFor(() => xhr_server.requests.length == 6);
 
     /*
@@ -364,7 +364,7 @@ describe('upload stream', function() {
       [ooR]
     */
     // Should resume file after second file chunks is uploaded
-    files[0].resume();
+    await files[0].resume();
     await sleep(1);
 
     /*

test/fileRemoveSpec.js

@@ -22,7 +22,7 @@ describe('file-removed event', function() {
     });
     await flow.addFile(new Blob(['file part']));
     var addedFile = flow.files[0];
-    flow.removeFile(addedFile);
+    await flow.removeFile(addedFile);
     expect(removedFile).toBe(addedFile);
     expect(valid).toBeTruthy();
   });
@@ -37,7 +37,7 @@ describe('file-removed event', function() {
     });
     await flow.addFile(new Blob(['file part']));
     var addedFile = flow.files[0];
-    addedFile.cancel();
+    await addedFile.cancel();
     expect(removedFile).toBe(addedFile);
     expect(valid).toBeTruthy();
   });

test/uploadSpec.js

@@ -139,7 +139,7 @@ describe('upload file', function() {
     expect(xhr.requests[0].aborted).toBeUndefined();
     expect(xhr.requests[1].aborted).toBeUndefined();
     // should start upload second file
-    files[0].pause();
+    await files[0].pause();
     expect(files[0].isUploading()).toBeFalsy();
     expect(files[1].isUploading()).toBeTruthy();
     expect(xhr.requests.length).toBe(4);
@@ -148,7 +148,7 @@ describe('upload file', function() {
     expect(xhr.requests[2].aborted).toBeUndefined();
     expect(xhr.requests[3].aborted).toBeUndefined();
     // Should resume file after second file chunks is uploaded
-    files[0].resume();
+    await files[0].resume();
     expect(files[0].isUploading()).toBeFalsy();
     expect(xhr.requests.length).toBe(4);
     xhr.requests[2].respond(200);// second file chunk
@@ -440,8 +440,8 @@ describe('upload file', function() {
     for(var i=0; i<file.chunks.length; i++) {
       expect(preprocess).toHaveBeenCalledWith(file.chunks[i]);
       file.chunks[i].preprocessFinished();
-      file.pause();
-      file.resume();
+      await file.pause();
+      await file.resume();
       xhr.requests[xhr.requests.length-1].respond(200, [], "response");
     }
     expect(success).toHaveBeenCalledWith(asCustomEvent(file, "response", file.chunks[file.chunks.length-1]));
@@ -515,10 +515,10 @@ describe('upload file', function() {
     xhr.requests[2].uploadProgress({loaded: 10, total: 15});
     expect(fileThird.timeRemaining()).toBe(1);
     expect(flow.timeRemaining()).toBe(1);
-    fileThird.pause();
+    await fileThird.pause();
     expect(fileThird.timeRemaining()).toBe(0);
     expect(flow.timeRemaining()).toBe(0);
-    fileThird.resume();
+    await fileThird.resume();
     expect(fileThird.timeRemaining()).toBe(Number.POSITIVE_INFINITY);
     expect(flow.timeRemaining()).toBe(Number.POSITIVE_INFINITY);
     clock.tick(1000);
@@ -558,9 +558,7 @@ describe('upload file', function() {
       flowObj.size = flowObj.file.size;
     }
 
-    flow.opts.readFileFn = function(fileObj, startByte, endByte, fileType, chunk) {
-      chunk.readFinished('X');
-    }
+    flow.opts.readFileFn = (fileObj, startByte, endByte, fileType, chunk) => 'X';
 
     await flow.addFile(new Blob(['0123456789']));