feat: pass chunk as last event argument

Author: AidasK

src/flow.js

@@ -786,43 +786,44 @@
      * For internal usage only.
      * Callback when something happens within the chunk.
      * @function
+     * @param {FlowChunk} chunk
      * @param {string} event can be 'progress', 'success', 'error' or 'retry'
      * @param {string} [message]
      */
-    chunkEvent: function (event, message) {
+    chunkEvent: function (chunk, event, message) {
       switch (event) {
         case 'progress':
           if (Date.now() - this._lastProgressCallback <
             this.flowObj.opts.progressCallbacksInterval) {
             break;
           }
           this.measureSpeed();
-          this.flowObj.fire('fileProgress', this);
+          this.flowObj.fire('fileProgress', this, chunk);
           this.flowObj.fire('progress');
           this._lastProgressCallback = Date.now();
           break;
         case 'error':
           this.error = true;
           this.abort(true);
-          this.flowObj.fire('fileError', this, message);
-          this.flowObj.fire('error', message, this);
+          this.flowObj.fire('fileError', this, message, chunk);
+          this.flowObj.fire('error', message, this, chunk);
           break;
         case 'success':
           if (this.error) {
             return;
           }
           this.measureSpeed();
-          this.flowObj.fire('fileProgress', this);
+          this.flowObj.fire('fileProgress', this, chunk);
           this.flowObj.fire('progress');
           this._lastProgressCallback = Date.now();
           if (this.isComplete()) {
             this.currentSpeed = 0;
             this.averageSpeed = 0;
-            this.flowObj.fire('fileSuccess', this, message);
+            this.flowObj.fire('fileSuccess', this, message, chunk);
           }
           break;
         case 'retry':
-          this.flowObj.fire('fileRetry', this);
+          this.flowObj.fire('fileRetry', this, chunk);
           break;
       }
     },
@@ -1121,6 +1122,17 @@
 
     var $ = this;
 
+
+    /**
+     * Send chunk event
+     * @param event
+     * @param {...} args arguments of a callback
+     */
+    this.event = function (event, args) {
+      args = Array.prototype.slice.call(arguments);
+      args.unshift($);
+      $.fileObj.chunkEvent.apply($.fileObj, args);
+    };
     /**
      * Catch progress event
      * @param {ProgressEvent} event
@@ -1130,7 +1142,7 @@
         $.loaded = event.loaded ;
         $.total = event.total;
       }
-      $.fileObj.chunkEvent('progress');
+      $.event('progress', event);
     };
 
     /**
@@ -1156,10 +1168,10 @@
     this.doneHandler = function(event) {
       var status = $.status();
       if (status === 'success' || status === 'error') {
-        $.fileObj.chunkEvent(status, $.message());
+        $.event(status, $.message());
         $.flowObj.uploadNextChunk();
       } else {
-        $.fileObj.chunkEvent('retry', $.message());
+        $.event('retry', $.message());
         $.pendingRetry = true;
         $.abort();
         $.retries++;

test/uploadSpec.js

@@ -211,13 +211,15 @@ describe('upload file', function() {
     flow.addFile(new Blob(['12']));
     var file = flow.files[0];
     expect(file.chunks.length).toBe(2);
-    expect(file.chunks[0].status()).toBe('pending');
-    expect(file.chunks[1].status()).toBe('pending');
+    var firstChunk = file.chunks[0];
+    var secondChunk = file.chunks[1];
+    expect(firstChunk.status()).toBe('pending');
+    expect(secondChunk.status()).toBe('pending');
 
     flow.upload();
     expect(requests.length).toBe(1);
-    expect(file.chunks[0].status()).toBe('uploading');
-    expect(file.chunks[1].status()).toBe('pending');
+    expect(firstChunk.status()).toBe('uploading');
+    expect(secondChunk.status()).toBe('pending');
 
     expect(error).not.toHaveBeenCalled();
     expect(progress).not.toHaveBeenCalled();
@@ -226,8 +228,8 @@ describe('upload file', function() {
 
     requests[0].respond(400);
     expect(requests.length).toBe(2);
-    expect(file.chunks[0].status()).toBe('uploading');
-    expect(file.chunks[1].status()).toBe('pending');
+    expect(firstChunk.status()).toBe('uploading');
+    expect(secondChunk.status()).toBe('pending');
 
     expect(error).not.toHaveBeenCalled();
     expect(progress).not.toHaveBeenCalled();
@@ -236,8 +238,8 @@ describe('upload file', function() {
 
     requests[1].respond(200);
     expect(requests.length).toBe(3);
-    expect(file.chunks[0].status()).toBe('success');
-    expect(file.chunks[1].status()).toBe('uploading');
+    expect(firstChunk.status()).toBe('success');
+    expect(secondChunk.status()).toBe('uploading');
 
     expect(error).not.toHaveBeenCalled();
     expect(progress.callCount).toBe(1);
@@ -246,8 +248,8 @@ describe('upload file', function() {
 
     requests[2].respond(400);
     expect(requests.length).toBe(4);
-    expect(file.chunks[0].status()).toBe('success');
-    expect(file.chunks[1].status()).toBe('uploading');
+    expect(firstChunk.status()).toBe('success');
+    expect(secondChunk.status()).toBe('uploading');
 
     expect(error).not.toHaveBeenCalled();
     expect(progress.callCount).toBe(1);
@@ -259,7 +261,7 @@ describe('upload file', function() {
     expect(file.chunks.length).toBe(0);
 
     expect(error.callCount).toBe(1);
-    expect(error).toHaveBeenCalledWith(file, 'Err');
+    expect(error).toHaveBeenCalledWith(file, 'Err', secondChunk);
     expect(progress.callCount).toBe(1);
     expect(success).not.toHaveBeenCalled();
     expect(retry.callCount).toBe(2);
@@ -384,7 +386,7 @@ describe('upload file', function() {
     file.chunks[0].preprocessFinished();
     expect(requests.length).toBe(1);
     requests[0].respond(200, [], "response");
-    expect(success).wasCalledWith(file, "response");
+    expect(success).wasCalledWith(file, "response", file.chunks[0]);
     expect(error).not.toHaveBeenCalled();
   });
 
@@ -407,6 +409,16 @@ describe('upload file', function() {
     expect(preprocess).wasNotCalledWith(secondFile.chunks[0]);
   });
 
+  it('should set chunk as a third event parameter', function () {
+    var success = jasmine.createSpy('success');
+    flow.on('fileSuccess', success);
+    flow.addFile(new Blob(['abc']));
+    var file = flow.files[0];
+    flow.upload();
+    requests[0].respond(200, [], "response");
+    expect(success).wasCalledWith(file, "response", file.chunks[0]);
+  });
+
   it('should have upload speed', function() {
     var clock = sinon.useFakeTimers();
     flow.opts.testChunks = false;