Add Android upload and download progress debounce mechanism #140

Author: wkh237

src/android/src/main/java/com/RNFetchBlob/RNFetchBlob.java

@@ -236,13 +236,15 @@ public void slice(String src, String dest, int start, int end, Promise promise)
     }
 
     @ReactMethod
-    public void enableProgressReport(String taskId) {
-        RNFetchBlobReq.progressReport.put(taskId, true);
+    public void enableProgressReport(String taskId, int interval, int count) {
+        RNFetchBlobProgressConfig config = new RNFetchBlobProgressConfig(true, interval, count, RNFetchBlobProgressConfig.ReportType.Download);
+        RNFetchBlobReq.progressReport.put(taskId, config);
     }
 
     @ReactMethod
-    public void enableUploadProgressReport(String taskId) {
-        RNFetchBlobReq.uploadProgressReport.put(taskId, true);
+    public void enableUploadProgressReport(String taskId, int interval, int count) {
+        RNFetchBlobProgressConfig config = new RNFetchBlobProgressConfig(true, interval, count, RNFetchBlobProgressConfig.ReportType.Upload);
+        RNFetchBlobReq.uploadProgressReport.put(taskId, config);
     }
 
     @ReactMethod

src/android/src/main/java/com/RNFetchBlob/RNFetchBlobBody.java

@@ -31,6 +31,7 @@ public class RNFetchBlobBody extends RequestBody{
     RNFetchBlobReq.RequestType requestType;
     MediaType mime;
     File bodyCache;
+    int reported = 0;
     Boolean chunkedEncoding = false;
 
 
@@ -370,7 +371,8 @@ public FormField(ReadableMap rawData) {
      * @param written
      */
     private void emitUploadProgress(int written) {
-        if(!RNFetchBlobReq.isReportUploadProgress(mTaskId))
+        RNFetchBlobProgressConfig config = RNFetchBlobReq.getReportUploadProgress(mTaskId);
+        if(!config.enable)
             return;
         WritableMap args = Arguments.createMap();
         args.putString("taskId", mTaskId);

src/android/src/main/java/com/RNFetchBlob/RNFetchBlobProgressConfig.java

@@ -0,0 +1,41 @@
+package com.RNFetchBlob;
+
+/**
+ * Created by wkh237 on 2016/9/24.
+ */
+public class RNFetchBlobProgressConfig {
+
+    public boolean shouldReport() {
+        boolean checkCount = true;
+        if(count > 0)
+            checkCount = Math.floor(progress*100/count)> tick;
+        return (lastTick - System.currentTimeMillis() > interval) && enable && checkCount;
+    }
+
+    public void tick(float progress) {
+        this.progress = progress;
+        this.tick ++;
+        this.lastTick = System.currentTimeMillis();
+    }
+
+    public enum ReportType {
+        Upload,
+        Download
+    };
+
+    long lastTick = 0;
+    float progress = 0;
+    int tick = 0;
+    int count = -1;
+    public int interval = -1;
+    public boolean enable = false;
+    public ReportType type = ReportType.Download;
+
+    RNFetchBlobProgressConfig(boolean report, int interval, int count, ReportType type) {
+        this.enable = report;
+        this.interval = interval;
+        this.type = type;
+        this.count = count;
+    }
+
+}

src/android/src/main/java/com/RNFetchBlob/RNFetchBlobReq.java

@@ -70,8 +70,8 @@ enum ResponseFormat {
     }
 
     public static HashMap<String, Call> taskTable = new HashMap<>();
-    static HashMap<String, Boolean> progressReport = new HashMap<>();
-    static HashMap<String, Boolean> uploadProgressReport = new HashMap<>();
+    static HashMap<String, RNFetchBlobProgressConfig> progressReport = new HashMap<>();
+    static HashMap<String, RNFetchBlobProgressConfig> uploadProgressReport = new HashMap<>();
     static ConnectionPool pool = new ConnectionPool();
 
     ReactApplicationContext ctx;
@@ -508,8 +508,8 @@ private void done(Response resp) {
      * @param taskId Task ID of the HTTP task.
      * @return Task ID of the target task
      */
-    public static boolean isReportProgress(String taskId) {
-        if(!progressReport.containsKey(taskId)) return false;
+    public static RNFetchBlobProgressConfig getReportProgress(String taskId) {
+        if(!progressReport.containsKey(taskId)) return null;
         return progressReport.get(taskId);
     }
 
@@ -518,8 +518,8 @@ public static boolean isReportProgress(String taskId) {
      * @param taskId Task ID of the HTTP task.
      * @return Task ID of the target task
      */
-    public static boolean isReportUploadProgress(String taskId) {
-        if(!uploadProgressReport.containsKey(taskId)) return false;
+    public static RNFetchBlobProgressConfig getReportUploadProgress(String taskId) {
+        if(!uploadProgressReport.containsKey(taskId)) return null;
         return uploadProgressReport.get(taskId);
     }
 

src/android/src/main/java/com/RNFetchBlob/Response/RNFetchBlobDefaultResp.java

@@ -1,7 +1,7 @@
 package com.RNFetchBlob.Response;
 
-import com.RNFetchBlob.RNFetchBlob;
 import com.RNFetchBlob.RNFetchBlobConst;
+import com.RNFetchBlob.RNFetchBlobProgressConfig;
 import com.RNFetchBlob.RNFetchBlobReq;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.ReactApplicationContext;
@@ -10,14 +10,10 @@
 
 import java.io.IOException;
 
-import okhttp3.Call;
-import okhttp3.Callback;
 import okhttp3.MediaType;
-import okhttp3.Response;
 import okhttp3.ResponseBody;
 import okio.Buffer;
 import okio.BufferedSource;
-import okio.ForwardingSource;
 import okio.Okio;
 import okio.Source;
 import okio.Timeout;
@@ -66,7 +62,9 @@ public long read(Buffer sink, long byteCount) throws IOException {
 
             long read =  mOriginalSource.read(sink, byteCount);
             bytesRead += read > 0 ? read : 0;
-            if(RNFetchBlobReq.isReportProgress(mTaskId)) {
+            RNFetchBlobProgressConfig reportConfig = RNFetchBlobReq.getReportProgress(mTaskId);
+            if(reportConfig != null && reportConfig.shouldReport()) {
+                reportConfig.tick(bytesRead/contentLength());
                 WritableMap args = Arguments.createMap();
                 args.putString("taskId", mTaskId);
                 args.putString("written", String.valueOf(bytesRead));

src/android/src/main/java/com/RNFetchBlob/Response/RNFetchBlobFileResp.java

@@ -3,6 +3,7 @@
 import android.util.Log;
 
 import com.RNFetchBlob.RNFetchBlobConst;
+import com.RNFetchBlob.RNFetchBlobProgressConfig;
 import com.RNFetchBlob.RNFetchBlobReq;
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.ReactApplicationContext;
@@ -75,7 +76,9 @@ public long read(Buffer sink, long byteCount) throws IOException {
             if(read > 0 ) {
                 ofStream.write(bytes, 0, (int) read);
             }
-            if(RNFetchBlobReq.isReportProgress(mTaskId)) {
+            RNFetchBlobProgressConfig reportConfig = RNFetchBlobReq.getReportProgress(mTaskId);
+            if(reportConfig != null && reportConfig.shouldReport()) {
+                reportConfig.tick(bytesDownloaded/contentLength());
                 WritableMap args = Arguments.createMap();
                 args.putString("taskId", mTaskId);
                 args.putString("written", String.valueOf(bytesDownloaded));

src/index.js

@@ -193,14 +193,15 @@ function fetch(...args:any):Promise {
 
   // extend Promise object, add `progress`, `uploadProgress`, and `cancel`
   // method for register progress event handler and cancel request.
-  promise.progress = (fn) => {
+  // Add second parameter for performance purpose #140
+  promise.progress = (fn, interval:number=250, count:number=-1) => {
     promise.onProgress = fn
-    RNFetchBlob.enableProgressReport(taskId)
+    RNFetchBlob.enableProgressReport(taskId, interval, count)
     return promise
   }
-  promise.uploadProgress = (fn) => {
+  promise.uploadProgress = (fn, interval:number=250, count:number=-1) => {
     promise.onUploadProgress = fn
-    RNFetchBlob.enableUploadProgressReport(taskId)
+    RNFetchBlob.enableUploadProgressReport(taskId, interval, count)
     return promise
   }
   promise.stateChange = (fn) => {