Refactored networking logic out into RCTDownloadTask

Author: nicklockwood

Libraries/Network/RCTDownloadTask.h

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "RCTURLRequestDelegate.h"
+#import "RCTURLRequestHandler.h"
+
+typedef void (^RCTURLRequestCompletionBlock)(NSURLResponse *response, NSData *data, NSError *error);
+typedef void (^RCTURLRequestCancellationBlock)(void);
+typedef void (^RCTURLRequestIncrementalDataBlock)(NSData *data);
+typedef void (^RCTURLRequestProgressBlock)(double progress, double total);
+typedef void (^RCTURLRequestResponseBlock)(NSURLResponse *response);
+
+@interface RCTDownloadTask : NSObject <RCTURLRequestDelegate>
+
+@property (nonatomic, readonly) NSURLRequest *request;
+@property (nonatomic, readonly) NSNumber *requestID;
+@property (nonatomic, readonly) id requestToken;
+@property (nonatomic, readonly) NSURLResponse *response;
+@property (nonatomic, readonly) RCTURLRequestCompletionBlock completionBlock;
+
+@property (nonatomic, copy) RCTURLRequestProgressBlock downloadProgressBlock;
+@property (nonatomic, copy) RCTURLRequestIncrementalDataBlock incrementalDataBlock;
+@property (nonatomic, copy) RCTURLRequestResponseBlock responseBlock;
+@property (nonatomic, copy) RCTURLRequestProgressBlock uploadProgressBlock;
+
+- (instancetype)initWithRequest:(NSURLRequest *)request
+                        handler:(id<RCTURLRequestHandler>)handler
+                completionBlock:(RCTURLRequestCompletionBlock)completionBlock NS_DESIGNATED_INITIALIZER;
+
+- (void)cancel;
+
+@end

Libraries/Network/RCTDownloadTask.m

@@ -0,0 +1,102 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "RCTDownloadTask.h"
+
+#import "RCTAssert.h"
+
+@implementation RCTDownloadTask
+{
+  NSMutableData *_data;
+  id<RCTURLRequestHandler> _handler;
+  RCTDownloadTask *_selfReference;
+}
+
+- (instancetype)initWithRequest:(NSURLRequest *)request
+                        handler:(id<RCTURLRequestHandler>)handler
+                completionBlock:(RCTURLRequestCompletionBlock)completionBlock
+{
+  RCTAssertParam(request);
+  RCTAssertParam(handler);
+  RCTAssertParam(completionBlock);
+
+  static NSUInteger requestID = 0;
+
+  if ((self = [super init])) {
+    if (!(_requestToken = [handler sendRequest:request withDelegate:self])) {
+      return nil;
+    }
+    _requestID = @(requestID++);
+    _request = request;
+    _handler = handler;
+    _completionBlock = completionBlock;
+    _selfReference = self;
+  }
+  return self;
+}
+
+- (void)invalidate
+{
+  _selfReference = nil;
+  _completionBlock = nil;
+  _downloadProgressBlock = nil;
+  _incrementalDataBlock = nil;
+  _responseBlock = nil;
+  _uploadProgressBlock = nil;
+}
+
+RCT_NOT_IMPLEMENTED(-init)
+
+- (void)cancel
+{
+  if ([_handler respondsToSelector:@selector(cancelRequest:)]) {
+    [_handler cancelRequest:_requestToken];
+  }
+  [self invalidate];
+}
+
+- (void)URLRequest:(id)requestToken didSendDataWithProgress:(int64_t)bytesSent
+{
+  RCTAssert([requestToken isEqual:_requestToken], @"Unrecognized request token: %@", requestToken);
+  if (_uploadProgressBlock) {
+    _uploadProgressBlock(bytesSent, _request.HTTPBody.length);
+  }
+}
+
+- (void)URLRequest:(id)requestToken didReceiveResponse:(NSURLResponse *)response
+{
+  RCTAssert([requestToken isEqual:_requestToken], @"Unrecognized request token: %@", requestToken);
+  _response = response;
+  if (_responseBlock) {
+    _responseBlock(response);
+  }
+}
+
+- (void)URLRequest:(id)requestToken didReceiveData:(NSData *)data
+{
+  RCTAssert([requestToken isEqual:_requestToken], @"Unrecognized request token: %@", requestToken);
+  if (!_data) {
+    _data = [[NSMutableData alloc] init];
+  }
+  [_data appendData:data];
+  if (_incrementalDataBlock) {
+    _incrementalDataBlock(data);
+  }
+  if (_downloadProgressBlock && _response.expectedContentLength > 0) {
+    _downloadProgressBlock(_data.length, _response.expectedContentLength);
+  }
+}
+
+- (void)URLRequest:(id)requestToken didCompleteWithError:(NSError *)error
+{
+  _completionBlock(_response, _data, error);
+  [self invalidate];
+}
+
+@end

Libraries/Network/RCTHTTPRequestHandler.h

@@ -10,6 +10,9 @@
 #import "RCTURLRequestHandler.h"
 #import "RCTInvalidating.h"
 
+/**
+ * This is the default RCTURLRequestHandler implementation for HTTP requests.
+ */
 @interface RCTHTTPRequestHandler : NSObject <RCTURLRequestHandler, RCTInvalidating>
 
 @end

Libraries/Network/RCTHTTPRequestHandler.m

@@ -50,8 +50,8 @@ - (BOOL)canHandleRequest:(NSURLRequest *)request
   return [@[@"http", @"https", @"file"] containsObject:[request.URL.scheme lowercaseString]];
 }
 
-- (id)sendRequest:(NSURLRequest *)request
-     withDelegate:(id<RCTURLRequestDelegate>)delegate
+- (NSURLSessionDataTask *)sendRequest:(NSURLRequest *)request
+                         withDelegate:(id<RCTURLRequestDelegate>)delegate
 {
   // Lazy setup
   if (!_session && [self isValid]) {
@@ -68,9 +68,10 @@ - (id)sendRequest:(NSURLRequest *)request
   return task;
 }
 
-- (void)cancelRequest:(NSURLSessionDataTask *)requestToken
+- (void)cancelRequest:(NSURLSessionDataTask *)task
 {
-  [requestToken cancel];
+  [task cancel];
+  [_delegates removeObjectForKey:task];
 }
 
 #pragma mark - NSURLSession delegate
@@ -81,10 +82,9 @@ - (void)URLSession:(NSURLSession *)session
     totalBytesSent:(int64_t)totalBytesSent
 totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
 {
-  [[_delegates objectForKey:task] URLRequest:task didUploadProgress:(double)totalBytesSent total:(double)totalBytesExpectedToSend];
+  [[_delegates objectForKey:task] URLRequest:task didSendDataWithProgress:totalBytesSent];
 }
 
-
 - (void)URLSession:(NSURLSession *)session
           dataTask:(NSURLSessionDataTask *)task
 didReceiveResponse:(NSURLResponse *)response

Libraries/Network/RCTNetwork.xcodeproj/project.pbxproj

@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		1372B7371AB03E7B00659ED6 /* RCTReachability.m in Sources */ = {isa = PBXBuildFile; fileRef = 1372B7361AB03E7B00659ED6 /* RCTReachability.m */; };
+		13D6D66A1B5FCF8200883BE9 /* RCTDownloadTask.m in Sources */ = {isa = PBXBuildFile; fileRef = 13D6D6691B5FCF8200883BE9 /* RCTDownloadTask.m */; };
 		352DA0BA1B17855800AA15A8 /* RCTHTTPRequestHandler.m in Sources */ = {isa = PBXBuildFile; fileRef = 352DA0B81B17855800AA15A8 /* RCTHTTPRequestHandler.m */; };
 		58B512081A9E6CE300147676 /* RCTNetworking.m in Sources */ = {isa = PBXBuildFile; fileRef = 58B512071A9E6CE300147676 /* RCTNetworking.m */; };
 /* End PBXBuildFile section */
@@ -27,6 +28,8 @@
 /* Begin PBXFileReference section */
 		1372B7351AB03E7B00659ED6 /* RCTReachability.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTReachability.h; sourceTree = "<group>"; };
 		1372B7361AB03E7B00659ED6 /* RCTReachability.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTReachability.m; sourceTree = "<group>"; };
+		13D6D6681B5FCF8200883BE9 /* RCTDownloadTask.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTDownloadTask.h; sourceTree = "<group>"; };
+		13D6D6691B5FCF8200883BE9 /* RCTDownloadTask.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTDownloadTask.m; sourceTree = "<group>"; };
 		352DA0B71B17855800AA15A8 /* RCTHTTPRequestHandler.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTHTTPRequestHandler.h; sourceTree = "<group>"; };
 		352DA0B81B17855800AA15A8 /* RCTHTTPRequestHandler.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTHTTPRequestHandler.m; sourceTree = "<group>"; };
 		58B511DB1A9E6C8500147676 /* libRCTNetwork.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libRCTNetwork.a; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -48,6 +51,8 @@
 		58B511D21A9E6C8500147676 = {
 			isa = PBXGroup;
 			children = (
+				13D6D6681B5FCF8200883BE9 /* RCTDownloadTask.h */,
+				13D6D6691B5FCF8200883BE9 /* RCTDownloadTask.m */,
 				352DA0B71B17855800AA15A8 /* RCTHTTPRequestHandler.h */,
 				352DA0B81B17855800AA15A8 /* RCTHTTPRequestHandler.m */,
 				58B512061A9E6CE300147676 /* RCTNetworking.h */,
@@ -124,6 +129,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				13D6D66A1B5FCF8200883BE9 /* RCTDownloadTask.m in Sources */,
 				1372B7371AB03E7B00659ED6 /* RCTReachability.m in Sources */,
 				58B512081A9E6CE300147676 /* RCTNetworking.m in Sources */,
 				352DA0BA1B17855800AA15A8 /* RCTHTTPRequestHandler.m in Sources */,

Libraries/Network/RCTNetworking.h

@@ -14,4 +14,3 @@
 @interface RCTNetworking : NSObject <RCTBridgeModule>
 
 @end
-