Merge pull request #9 from appfolio/api-for-wifi-only

Add the ability to limit uploads in cellular networks

Author: hojason117

README.md

@@ -223,6 +223,13 @@ Adds an event listener, possibly confined to a single upload.
 
 Returns an [EventSubscription](https://github.com/facebook/react-native/blob/master/Libraries/vendor/emitter/EmitterSubscription.js). To remove the listener, call `remove()` on the `EventSubscription`.
 
+### shouldLimitNetwork(limit)
+
+`limit` boolean, sets whether or not to limit network usage.
+
+On Android, this setting takes effect immediately and will be applied for the next upload. On iOS, this setting will be only applied for the next NSURLSession.
+
+
 ## Events
 
 ### progress

android/src/main/java/com/appfolio/extensions/UploadExtensions.kt

@@ -1,6 +1,8 @@
 package com.appfolio.extensions
 
+import androidx.work.Constraints
 import androidx.work.Data
+import androidx.work.NetworkType
 import androidx.work.OneTimeWorkRequest
 import com.google.gson.Gson
 import net.gotev.uploadservice.data.UploadFile
@@ -47,3 +49,9 @@ internal fun OneTimeWorkRequest.Builder.setData(uploadTaskParameters: UploadTask
   data.putString(PARAM_KEY_NOTIF_CONFIG, notificationConfig.toJson())
   setInputData(data.build())
 }
+
+internal fun OneTimeWorkRequest.Builder.shouldLimitNetwork(limit: Boolean) {
+  val network = if (limit) NetworkType.UNMETERED else NetworkType.CONNECTED
+  val constraints = Constraints.Builder().setRequiredNetworkType(network).build()
+  setConstraints(constraints)
+}

android/src/main/java/com/appfolio/uploader/ModifiedBinaryUploadRequest.kt

@@ -7,8 +7,8 @@ import net.gotev.uploadservice.protocols.binary.BinaryUploadTask
 import java.io.FileNotFoundException
 import java.io.IOException
 
-class ModifiedBinaryUploadRequest(context: Context, serverUrl: String) :
-    ModifiedHttpUploadRequest<ModifiedBinaryUploadRequest>(context, serverUrl) {
+class ModifiedBinaryUploadRequest(context: Context, serverUrl: String, limitNetwork: Boolean) :
+    ModifiedHttpUploadRequest<ModifiedBinaryUploadRequest>(context, serverUrl, limitNetwork) {
 
   override val taskClass: Class<out UploadTask>
     get() = BinaryUploadTask::class.java

android/src/main/java/com/appfolio/uploader/ModifiedHttpUploadRequest.kt

@@ -4,13 +4,14 @@ import android.content.Context
 import androidx.work.OneTimeWorkRequest
 import androidx.work.WorkManager
 import com.appfolio.extensions.setData
+import com.appfolio.extensions.shouldLimitNetwork
 import com.appfolio.work.UploadManager
 import com.appfolio.work.UploadWorker
 import net.gotev.uploadservice.HttpUploadRequest
 import net.gotev.uploadservice.data.UploadTaskParameters
 import java.util.*
 
-abstract class ModifiedHttpUploadRequest<B : HttpUploadRequest<B>>(context: Context, serverUrl: String) :
+abstract class ModifiedHttpUploadRequest<B : HttpUploadRequest<B>>(context: Context, serverUrl: String, private val limitNetwork: Boolean = false) :
     HttpUploadRequest<B>(context, serverUrl) {
 
   private var started: Boolean = false
@@ -40,6 +41,7 @@ abstract class ModifiedHttpUploadRequest<B : HttpUploadRequest<B>>(context: Cont
 
     val workManager: WorkManager = WorkManager.getInstance(context)
     val uploadRequest = OneTimeWorkRequest.Builder(UploadWorker::class.java)
+    uploadRequest.shouldLimitNetwork(limitNetwork)
     uploadRequest.setData(uploadTaskParameters, notificationConfig(context, uploadId))
     workManager.enqueue(uploadRequest.build())
 

android/src/main/java/com/appfolio/uploader/ModifiedMultipartUploadRequest.kt

@@ -9,8 +9,8 @@ import net.gotev.uploadservice.data.UploadFile
 import net.gotev.uploadservice.protocols.multipart.MultipartUploadTask
 import java.io.FileNotFoundException
 
-class ModifiedMultipartUploadRequest(context: Context, serverUrl: String)  :
-    ModifiedHttpUploadRequest<ModifiedMultipartUploadRequest>(context, serverUrl) {
+class ModifiedMultipartUploadRequest(context: Context, serverUrl: String, limitNetwork: Boolean)  :
+    ModifiedHttpUploadRequest<ModifiedMultipartUploadRequest>(context, serverUrl, limitNetwork) {
 
   override val taskClass: Class<out UploadTask>
     get() = MultipartUploadTask::class.java

android/src/main/java/com/appfolio/uploader/UploaderModule.kt

@@ -24,11 +24,20 @@ class UploaderModule(val reactContext: ReactApplicationContext) : ReactContextBa
   private val TAG = "UploaderBridge"
   private var notificationChannelID = "BackgroundUploadChannel"
   private var isGlobalRequestObserver = false
+  private var limitNetwork = false
 
   override fun getName(): String {
     return "RNFileUploader"
   }
 
+  /*
+    Sets uploading network limit to unmetered network.
+   */
+  @ReactMethod
+  fun shouldLimitNetwork(limit: Boolean) {
+    limitNetwork = limit;
+  }
+
   /*
   Gets file information for the path specified.  Example valid path is: /storage/extSdCard/DCIM/Camera/20161116_074726.mp4
   Returns an object such as: {extension: "mp4", size: "3804316", exists: true, mimeType: "video/mp4", name: "20161116_074726.mp4"}
@@ -185,7 +194,7 @@ class UploaderModule(val reactContext: ReactApplicationContext) : ReactContextBa
     val customUploadId = if (options.hasKey("customUploadId") && options.getType("method") == ReadableType.String) options.getString("customUploadId") else null
     try {
       val request = if (requestType == "raw") {
-        ModifiedBinaryUploadRequest(this.reactApplicationContext, url!!)
+        ModifiedBinaryUploadRequest(this.reactApplicationContext, url!!, limitNetwork)
                 .setFileToUpload(filePath!!)
       } else {
         if (!options.hasKey("field")) {
@@ -196,7 +205,7 @@ class UploaderModule(val reactContext: ReactApplicationContext) : ReactContextBa
           promise.reject(java.lang.IllegalArgumentException("field must be string."))
           return
         }
-        ModifiedMultipartUploadRequest(this.reactApplicationContext, url!!)
+        ModifiedMultipartUploadRequest(this.reactApplicationContext, url!!, limitNetwork)
                 .addFileToUpload(filePath!!, options.getString("field")!!)
       }
       request.setMethod(method!!)

index.d.ts

@@ -138,6 +138,7 @@ declare module '@appfolio/react-native-upload' {
     ): EventSubscription;
     static getFileInfo(path: string): Promise<FileInfo>;
     static cancelUpload(uploadId: uploadId): Promise<boolean>;
-    static canSuspendIfBackground(): Promise<void>;
+    static canSuspendIfBackground();
+    static shouldLimitNetwork(limit: boolean);
   }
 }

ios/VydiaRNFileUploader.m

@@ -17,6 +17,7 @@ @implementation VydiaRNFileUploader
 NSMutableDictionary *_responsesData;
 NSURLSession *_urlSession = nil;
 void (^backgroundSessionCompletionHandler)(void) = nil;
+BOOL limitNetwork = NO;
 
 + (BOOL)requiresMainQueueSetup {
     return YES;
@@ -54,12 +55,12 @@ - (void)startObserving {
     // JS side is ready to receive events; create the background url session if necessary
     // iOS will then deliver the tasks completed while the app was dead (if any)
     NSString *appGroup = nil;
-    double delayInSeconds = 0.5;
+    double delayInSeconds = 30;
     dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, delayInSeconds * NSEC_PER_SEC);
     dispatch_after(popTime, dispatch_get_main_queue(), ^(void){
         [self urlSession:appGroup];
     });
-}   
+}
 
 + (void)setCompletionHandlerWithIdentifier: (NSString *)identifier completionHandler: (void (^)())completionHandler {
     if ([BACKGROUND_SESSION_ID isEqualToString:identifier]) {
@@ -268,6 +269,10 @@ - (void)copyAssetToFile: (NSString *)assetUrl completionHandler: (void(^)(NSStri
     }
 }
 
+RCT_EXPORT_METHOD(shouldLimitNetwork: (BOOL) limit) {
+    limitNetwork = limit;
+}
+
 - (NSData *)createBodyWithBoundary:(NSString *)boundary
             path:(NSString *)path
             parameters:(NSDictionary *)parameters
@@ -314,6 +319,9 @@ - (NSURLSession *)urlSession: (NSString *) groupId {
         if (groupId != nil && ![groupId isEqualToString:@""]) {
             sessionConfiguration.sharedContainerIdentifier = groupId;
         }
+        if (limitNetwork) {
+            sessionConfiguration.allowsCellularAccess = NO;
+        }
         _urlSession = [NSURLSession sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:nil];
     }
 

lint-staged.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  '*.{js,jsx}': ['eslint --fix', 'jest --bail --findRelatedTests'],
+  '*.{js,jsx}': ['eslint --fix'],
 };

src/index.js

@@ -125,10 +125,15 @@ export const canSuspendIfBackground = () => {
   }
 };
 
+export const shouldLimitNetwork = (limit: boolean) => {
+  NativeModule.shouldLimitNetwork(limit);
+};
+
 export default {
   startUpload,
   cancelUpload,
   addListener,
   getFileInfo,
   canSuspendIfBackground,
+  shouldLimitNetwork,
 };