#187 Add allowCellular flag to Upload (#188)

lyio · web-flow · commit 874f6a442fe2 · 2021-07-26T09:29:33.000+01:00
#187 Add allowCellular flag to Upload
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Unreleased
+
+- Add flag to restrict uploads to wifi only
+
 ## 3.0.0-beta.2
 
 - Android: Restore concurrency setting for uploads (#174).
diff --git a/android/src/main/java/com/bluechilli/flutteruploader/MethodCallHandlerImpl.java b/android/src/main/java/com/bluechilli/flutteruploader/MethodCallHandlerImpl.java
@@ -92,6 +92,11 @@ private void enqueue(MethodCall call, MethodChannel.Result result) {
     Map<String, String> parameters = call.argument("data");
     Map<String, String> headers = call.argument("headers");
     String tag = call.argument("tag");
+    Boolean allowCellular = call.argument("allowCellular");
+    if (allowCellular == null) {
+      result.error("invalid_flag", "allowCellular must be set", null);
+      return;
+    }
 
     if (method == null) {
       method = "POST";
@@ -115,7 +120,17 @@ private void enqueue(MethodCall call, MethodChannel.Result result) {
 
     WorkRequest request =
         buildRequest(
-            new UploadTask(url, method, items, headers, parameters, connectionTimeout, false, tag));
+            new UploadTask(
+                url,
+                method,
+                items,
+                headers,
+                parameters,
+                connectionTimeout,
+                false,
+                tag,
+                allowCellular));
+
     WorkManager.getInstance(context)
         .enqueue(request)
         .getResult()
@@ -137,6 +152,12 @@ private void enqueueBinary(MethodCall call, MethodChannel.Result result) {
     String path = call.argument("path");
     Map<String, String> headers = call.argument("headers");
     String tag = call.argument("tag");
+    Boolean allowCellular = call.argument("allowCellular");
+
+    if (allowCellular == null) {
+      result.error("invalid_flag", "allowCellular must be set", null);
+      return;
+    }
 
     if (method == null) {
       method = "POST";
@@ -162,7 +183,9 @@ private void enqueueBinary(MethodCall call, MethodChannel.Result result) {
                 Collections.emptyMap(),
                 connectionTimeout,
                 true,
-                tag));
+                tag,
+                allowCellular));
+
     WorkManager.getInstance(context)
         .enqueue(request)
         .getResult()
@@ -231,9 +254,13 @@ private WorkRequest buildRequest(UploadTask task) {
       dataBuilder.putString(UploadWorker.ARG_DATA, parametersJson);
     }
 
+    Constraints constraints =
+        new Constraints.Builder()
+            .setRequiredNetworkType(
+                task.isAllowCellular() ? NetworkType.CONNECTED : NetworkType.UNMETERED)
+            .build();
     return new OneTimeWorkRequest.Builder(UploadWorker.class)
-        .setConstraints(
-            new Constraints.Builder().setRequiredNetworkType(NetworkType.CONNECTED).build())
+        .setConstraints(constraints)
         .addTag(FLUTTER_UPLOAD_WORK_TAG)
         .setBackoffCriteria(BackoffPolicy.EXPONENTIAL, 5, TimeUnit.SECONDS)
         .setInputData(dataBuilder.build())
diff --git a/android/src/main/java/com/bluechilli/flutteruploader/UploadTask.java b/android/src/main/java/com/bluechilli/flutteruploader/UploadTask.java
@@ -14,6 +14,7 @@ public class UploadTask {
   private int requestTimeoutInSeconds;
   private boolean binaryUpload;
   private String tag;
+  private boolean allowCellular;
 
   public UploadTask(
       String url,
@@ -23,7 +24,8 @@ public UploadTask(
       Map<String, String> data,
       int requestTimeoutInSeconds,
       boolean binaryUpload,
-      String tag) {
+      String tag,
+      boolean allowCellular) {
     this.url = url;
     this.method = method;
     this.files = files;
@@ -32,6 +34,7 @@ public UploadTask(
     this.requestTimeoutInSeconds = requestTimeoutInSeconds;
     this.binaryUpload = binaryUpload;
     this.tag = tag;
+    this.allowCellular = allowCellular;
   }
 
   public String getURL() {
@@ -69,4 +72,8 @@ public boolean isBinaryUpload() {
   public String getTag() {
     return tag;
   }
+
+  public boolean isAllowCellular() {
+    return allowCellular;
+  }
 }
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -117,6 +117,8 @@ class App extends StatefulWidget {
 class _AppState extends State<App> {
   int _currentIndex = 0;
 
+  bool allowCellular = true;
+
   @override
   void initState() {
     super.initState();
@@ -139,6 +141,16 @@ class _AppState extends State<App> {
       initializationSettings,
       onSelectNotification: (payload) async {},
     );
+
+    SharedPreferences.getInstance()
+        .then((sp) => sp.getBool('allowCellular') ?? true)
+        .then((result) {
+      if (mounted) {
+        setState(() {
+          allowCellular = result;
+        });
+      }
+    });
   }
 
   @override
@@ -149,6 +161,24 @@ class _AppState extends State<App> {
         primarySwatch: Colors.blue,
       ),
       home: Scaffold(
+        appBar: AppBar(
+          actions: [
+            IconButton(
+              icon: Icon(allowCellular
+                  ? Icons.signal_cellular_connected_no_internet_4_bar
+                  : Icons.wifi_outlined),
+              onPressed: () async {
+                final sp = await SharedPreferences.getInstance();
+                await sp.setBool('allowCellular', !allowCellular);
+                if (mounted) {
+                  setState(() {
+                    allowCellular = !allowCellular;
+                  });
+                }
+              },
+            ),
+          ],
+        ),
         body: _currentIndex == 0
             ? UploadScreen(
                 uploader: _uploader,
diff --git a/example/lib/upload_screen.dart b/example/lib/upload_screen.dart
@@ -199,16 +199,19 @@ class _UploadScreenState extends State<UploadScreen> {
   void _handleFileUpload(List<String?> paths) async {
     final prefs = await SharedPreferences.getInstance();
     final binary = prefs.getBool('binary') ?? false;
+    final allowCellular = prefs.getBool('allowCellular') ?? true;
 
     await widget.uploader.enqueue(_buildUpload(
       binary,
       paths.whereType<String>().toList(),
+      allowCellular,
     ));
 
     widget.onUploadStarted();
   }
 
-  Upload _buildUpload(bool binary, List<String> paths) {
+  Upload _buildUpload(bool binary, List<String> paths,
+      [bool allowCellular = true]) {
     final tag = 'upload';
 
     var url = binary
@@ -225,6 +228,7 @@ class _UploadScreenState extends State<UploadScreen> {
         path: paths.first,
         method: UploadMethod.POST,
         tag: tag,
+        allowCellular: allowCellular,
       );
     } else {
       return MultipartFormDataUpload(
@@ -233,6 +237,7 @@ class _UploadScreenState extends State<UploadScreen> {
         files: paths.map((e) => FileItem(path: e, field: 'file')).toList(),
         method: UploadMethod.POST,
         tag: tag,
+        allowCellular: allowCellular,
       );
     }
   }
diff --git a/ios/Classes/SwiftFlutterUploaderPlugin.swift b/ios/Classes/SwiftFlutterUploaderPlugin.swift
@@ -123,13 +123,19 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
             return
         }
 
+        guard let allowCellular = args["allowCellular"] as? Bool else {
+            result(FlutterError(code: "invalid_flag", message: "allowCellular must be set", details: nil))
+            return
+        }
+
         uploadTaskWithURLWithCompletion(
             url: url,
             files: files,
             method: method,
             headers: headers,
             parameters: data,
             tag: tag,
+            allowCellular: allowCellular,
             completion: { (task, error) in
                 if error != nil {
                     result(error!)
@@ -174,7 +180,12 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
             return
         }
 
-        binaryUploadTaskWithURLWithCompletion(url: url, file: fileUrl, method: method, headers: headers, tag: tag, completion: { (task, error) in
+        guard let allowCellular = args["allowCellular"] as? Bool else {
+            result(FlutterError(code: "invalid_flag", message: "allowCellular must be set", details: nil))
+            return
+        }
+
+        binaryUploadTaskWithURLWithCompletion(url: url, file: fileUrl, method: method, headers: headers, tag: tag, allowCellular: allowCellular, completion: { (task, error) in
             if error != nil {
                 result(error!)
             } else if let uploadTask = task {
@@ -203,6 +214,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
                                                        method: String,
                                                        headers: [String: Any?]?,
                                                        tag: String?,
+                                                       allowCellular: Bool,
                                                        completion completionHandler:@escaping (URLSessionUploadTask?, FlutterError?) -> Void) {
         let request = NSMutableURLRequest(url: url)
         request.httpMethod = method
@@ -214,7 +226,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
             }
         }
 
-        completionHandler(self.urlSessionUploader.enqueueUploadTask(request as URLRequest, path: file.path), nil)
+        completionHandler(self.urlSessionUploader.enqueueUploadTask(request as URLRequest, path: file.path, wifiOnly: !allowCellular), nil)
     }
 
     private func uploadTaskWithURLWithCompletion(
@@ -224,6 +236,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
         headers: [String: Any?]?,
         parameters data: [String: Any?]?,
         tag: String?,
+        allowCellular: Bool,
         completion completionHandler:@escaping (URLSessionUploadTask?, FlutterError?) -> Void) {
         var flutterError: FlutterError?
         let fileManager = FileManager.default
@@ -290,7 +303,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
             return
         }
 
-        self.makeRequest(path, url, method, headers, formData.contentType, formData.contentLength, completion: { (task, error) in
+        self.makeRequest(path, url, method, headers, formData.contentType, formData.contentLength, allowCellular: allowCellular, completion: { (task, error) in
             completionHandler(task, error)
         })
     }
@@ -302,6 +315,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
         _ headers: [String: Any?]? = [:],
         _ contentType: String,
         _ contentLength: UInt64,
+        allowCellular: Bool,
         completion completionHandler: (URLSessionUploadTask?, FlutterError?) -> Void) {
         let request = NSMutableURLRequest(url: url)
         request.httpMethod = method
@@ -324,7 +338,7 @@ public class SwiftFlutterUploaderPlugin: NSObject, FlutterPlugin {
             return
         }
 
-        completionHandler(urlSessionUploader.enqueueUploadTask(request as URLRequest, path: path), nil)
+        completionHandler(urlSessionUploader.enqueueUploadTask(request as URLRequest, path: path, wifiOnly: !allowCellular), nil)
     }
 }
 
diff --git a/ios/Classes/URLSessionUploader.swift b/ios/Classes/URLSessionUploader.swift
@@ -9,6 +9,7 @@ import Foundation
 
 struct Keys {
     static let backgroundSessionIdentifier = "chillisource.flutter_uploader.upload.background"
+    static let wifiBackgroundSessionIdentifier = "chillisource.flutter_uploader.upload.background.wifi"
     fileprivate static let maximumConcurrentTask = "FUMaximumConnectionsPerHost"
     fileprivate static let maximumConcurrentUploadOperation = "FUMaximumUploadOperation"
 
@@ -20,6 +21,7 @@ class URLSessionUploader: NSObject {
     static let shared = URLSessionUploader()
 
     var session: URLSession?
+    var wifiSession: URLSession?
     let queue = OperationQueue()
 
     // Accessing uploadedData & runningTaskById will require exclusive access
@@ -43,12 +45,17 @@ class URLSessionUploader: NSObject {
         delegates.append(delegate)
     }
 
-    func enqueueUploadTask(_ request: URLRequest, path: String) -> URLSessionUploadTask? {
-        guard let session = self.session else {
+    func enqueueUploadTask(_ request: URLRequest, path: String, wifiOnly: Bool) -> URLSessionUploadTask? {
+        guard let session = self.session,
+              let wifiSession = self.wifiSession else {
             return nil
         }
 
-        let uploadTask = session.uploadTask(with: request as URLRequest, fromFile: URL(fileURLWithPath: path))
+        let activeSession = wifiOnly ? wifiSession : session
+        let uploadTask = activeSession.uploadTask(
+                with: request as URLRequest,
+                fromFile: URL(fileURLWithPath: path)
+        )
 
         // Create a random UUID as task description (& ID).
         uploadTask.taskDescription = UUID().uuidString
@@ -138,6 +145,14 @@ class URLSessionUploader: NSObject {
 
         self.queue.maxConcurrentOperationCount = maxUploadOperation.intValue
 
+        // configure session for wifi only uploads
+        let wifiConfiguration = URLSessionConfiguration.background(withIdentifier: Keys.wifiBackgroundSessionIdentifier)
+        wifiConfiguration.httpMaximumConnectionsPerHost = maxConcurrentTasks.intValue
+        wifiConfiguration.timeoutIntervalForRequest = URLSessionUploader.determineTimeout()
+        wifiConfiguration.allowsCellularAccess = false
+        self.wifiSession = URLSession(configuration: wifiConfiguration, delegate: self, delegateQueue: queue)
+
+        // configure regular session
         let sessionConfiguration = URLSessionConfiguration.background(withIdentifier: Keys.backgroundSessionIdentifier)
         sessionConfiguration.httpMaximumConnectionsPerHost = maxConcurrentTasks.intValue
         sessionConfiguration.timeoutIntervalForRequest = URLSessionUploader.determineTimeout()
diff --git a/ios/Classes/UploadTask.swift b/ios/Classes/UploadTask.swift
@@ -16,11 +16,13 @@ struct UploadTask {
     let status: UploadTaskStatus
     let progress: Int
     let tag: String?
+    let allowCellular: Bool
 
-    init(taskId: String, status: UploadTaskStatus, progress: Int, tag: String? = nil) {
+    init(taskId: String, status: UploadTaskStatus, progress: Int, tag: String? = nil, allowCellular: Bool = true) {
         self.taskId = taskId
         self.status = status
         self.progress = progress
         self.tag = tag
+        self.allowCellular = allowCellular
     }
 }
diff --git a/lib/src/flutter_uploader.dart b/lib/src/flutter_uploader.dart
@@ -107,6 +107,7 @@ class FlutterUploader {
         'headers': upload.headers,
         'data': upload.data,
         'tag': upload.tag,
+        'allowCellular': upload.allowCellular,
       }))!;
     }
     if (upload is RawUpload) {
@@ -115,7 +116,8 @@ class FlutterUploader {
         'method': describeEnum(upload.method),
         'path': upload.path,
         'headers': upload.headers,
-        'tag': upload.tag
+        'tag': upload.tag,
+        'allowCellular': upload.allowCellular,
       }))!;
     }
 
diff --git a/lib/src/upload.dart b/lib/src/upload.dart
diff --git a/test/flutter_uploader_test.dart b/test/flutter_uploader_test.dart

Original file line number	Diff line number	Diff line change
`@@ -16,11 +16,13 @@ struct UploadTask {`
`16`	`16`	`let status: UploadTaskStatus`
`17`	`17`	`let progress: Int`
`18`	`18`	`let tag: String?`
	`19`	`+ let allowCellular: Bool`
`19`	`20`
`20`		`- init(taskId: String, status: UploadTaskStatus, progress: Int, tag: String? = nil) {`
	`21`	`+ init(taskId: String, status: UploadTaskStatus, progress: Int, tag: String? = nil, allowCellular: Bool = true) {`
`21`	`22`	`self.taskId = taskId`
`22`	`23`	`self.status = status`
`23`	`24`	`self.progress = progress`
`24`	`25`	`self.tag = tag`
	`26`	`+ self.allowCellular = allowCellular`
`25`	`27`	`}`
`26`	`28`	`}`