Merge pull request #6424 from jonalter/TIMOB-17327

[TIMOB-17327]: Add ceiling and floor to httpClient's onDataStream progress
tidev · Dec 5, 2014 · 60ec73f · 60ec73f
2 parents b24b52c + 88a14a2
commit 60ec73f
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 3 deletions.
diff --git a/android/modules/network/src/java/ti/modules/titanium/network/NetworkModule.java b/android/modules/network/src/java/ti/modules/titanium/network/NetworkModule.java
@@ -54,6 +54,8 @@ public class NetworkModule extends KrollModule {
 	@Kroll.constant public static final int TLS_VERSION_1_0 = 1;
 	@Kroll.constant public static final int TLS_VERSION_1_1 = 2;
 	@Kroll.constant public static final int TLS_VERSION_1_2 = 3;
+
+	@Kroll.constant public static final int PROGRESS_UNKNOWN = -1;
 
     public enum State {
         UNKNOWN,

diff --git a/android/modules/network/src/java/ti/modules/titanium/network/TiHTTPClient.java b/android/modules/network/src/java/ti/modules/titanium/network/TiHTTPClient.java
@@ -403,7 +403,12 @@ else if (contentLength > maxBufferSize) {
 
 			TiBlob blob = TiBlob.blobFromData(blobData, contentType);
 			callbackData.put("blob", blob);
-			callbackData.put("progress", ((double)totalSize)/((double)contentLength));
+			double progress = ((double)totalSize)/((double)contentLength);
+			// return progress as -1 if it is outside the valid range
+			if (progress > 1 || progress < 0) {
+				progress = NetworkModule.PROGRESS_UNKNOWN;
+			}
+			callbackData.put("progress", progress);
 
 			dispatchCallback("ondatastream", callbackData);
 		}

diff --git a/apidoc/Titanium/Network/HTTPClient.yml b/apidoc/Titanium/Network/HTTPClient.yml
@@ -345,7 +345,8 @@ properties:
         Must be set before calling `open`.
 
         The `progress` property of the event will contain a value from 0.0-1.0 with the progress of
-        the request.
+        the request. On iOS and Android as of 3.5.0, if the progress can not be calculated, 
+        the value will be [PROGRESS_UNKNOWN](Titanium.Network.PROGRESS_UNKNOWN).
     type: Callback<Object>
 
   - name: onerror

diff --git a/apidoc/Titanium/Network/Network.yml b/apidoc/Titanium/Network/Network.yml
@@ -552,6 +552,13 @@ properties:
     permission: read-only
     since: {android: "3.6.0", iphone: "1.8.0.1", ipad: "1.8.0.1"}
 
+  - name: PROGRESS_UNKNOWN
+    summary: Constant value specifying that the progress of a download can not be calculated.
+    type: Number
+    permission: read-only
+    platforms: [android, iphone, ipad]
+    since: "3.5.0"
+
   - name: allHTTPCookies
     summary: A list of all cookies in the cookie storage.
     type: Array<Titanium.Network.Cookie>

diff --git a/iphone/Classes/NetworkModule.m b/iphone/Classes/NetworkModule.m
@@ -210,6 +210,8 @@ -(NSNumber*)networkType
 MAKE_SYSTEM_PROP(TLS_VERSION_1_1, TLS_VERSION_1_1);
 MAKE_SYSTEM_PROP(TLS_VERSION_1_2, TLS_VERSION_1_2);
 
+MAKE_SYSTEM_NUMBER(PROGRESS_UNKNOWN, NUMINT(-1));
+
 #pragma mark Push Notifications 
 
 - (NSString*) remoteDeviceUUID

diff --git a/iphone/Classes/TiNetworkHTTPClientProxy.m b/iphone/Classes/TiNetworkHTTPClientProxy.m
@@ -283,7 +283,12 @@ -(void)request:(APSHTTPRequest *)request onDataStream:(APSHTTPResponse *)respons
         if(_downloadTime == 0 || diff > TI_HTTP_REQUEST_PROGRESS_INTERVAL || [response readyState] == APSHTTPResponseStateDone) {
             _downloadTime = 0;
             NSDictionary *eventDict = [NSMutableDictionary dictionary];
-            [eventDict setValue:[NSNumber numberWithFloat: [response downloadProgress]] forKey:@"progress"];
+            float downloadProgress = [response downloadProgress];
+            // return progress as -1 if it is outside the valid range
+            if (downloadProgress > 1 || downloadProgress < 0) {
+                downloadProgress = -1.0f;
+            }
+            [eventDict setValue:[NSNumber numberWithFloat: downloadProgress] forKey:@"progress"];
             [self fireCallback:@"ondatastream" withArg:eventDict withSource:self];
         }
         if(_downloadTime == 0) {