Large File Chunked Upload support on Flutter

src/SDK/Language/Dart.php

@@ -128,7 +128,7 @@ public function getTypeName($type)
                 return 'String';
             break;
             case self::TYPE_FILE:
-                return 'http.MultipartFile';
+                return 'InputFile';
             break;
             case self::TYPE_BOOLEAN:
                 return 'bool';
@@ -408,6 +408,24 @@ public function getFiles()
                 'template'      => 'dart/.travis.yml.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/input_file.dart',
+                'template'      => 'dart/lib/src/input_file.dart.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/chunked_upload_io.dart',
+                'template'      => 'dart/lib/src/chunked_upload_io.dart.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/chunked_upload_stub.dart',
+                'template'      => 'dart/lib/src/chunked_upload_stub.dart.twig',
+                'minify'        => false,
+            ],
         ];
     }
 }

src/SDK/Language/Flutter.php

@@ -277,6 +277,24 @@ public function getFiles()
                 'template'      => 'flutter/.travis.yml.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/input_file.dart',
+                'template'      => 'flutter/lib/src/input_file.dart.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/chunked_upload_io.dart',
+                'template'      => 'flutter/lib/src/chunked_upload_io.dart.twig',
+                'minify'        => false,
+            ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'lib/src/chunked_upload_stub.dart',
+                'template'      => 'flutter/lib/src/chunked_upload_stub.dart.twig',
+                'minify'        => false,
+            ],
         ];
     }
 }

templates/dart/lib/package.dart.twig

@@ -2,15 +2,18 @@ library {{ language.params.packageName }};
 
 import 'dart:async';
 import 'dart:typed_data';
-import 'package:http/http.dart' as http;
+import 'src/chunked_upload_stub.dart'
+    if (dart.library.io) 'src/chunked_upload_io.dart';
 import 'src/enums.dart';
 import 'src/client.dart';
 import 'src/service.dart';
+import 'src/input_file.dart';
 import 'models.dart' as models;
 
 export 'src/response.dart';
 export 'src/client.dart';
 export 'src/exception.dart';
+export 'src/input_file.dart';
 export 'package:http/http.dart' show MultipartFile;
 
 part 'query.dart';

templates/dart/lib/services/service.dart.twig

@@ -1,8 +1,8 @@
 part of {{ language.params.packageName }};
 {% macro parameter(parameter) %}
 {% if parameter.required %}required {{ parameter.type | typeName }}{% else %}{{ parameter.type | typeName }}?{% endif %} {{ parameter.name | caseCamel | escapeKeyword }}{% endmacro %}
-{% macro method_parameters(parameters) %}
-{% if parameters.all|length > 0 %}{{ '{' }}{% for parameter in parameters.all %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{{ '}' }}{% endif %}
+{% macro method_parameters(parameters, consumes) %}
+{% if parameters.all|length > 0 %}{{ '{' }}{% for parameter in parameters.all %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, Function(double)? onProgress{% endif %}{{ '}' }}{% endif %}
 {% endmacro %}
 {% macro map_parameter(parameter) %}'{{ parameter.name }}': {{ parameter.name | caseCamel | escapeKeyword }},{% endmacro %}
 
@@ -13,10 +13,10 @@ class {{ service.name | caseUcfirst }} extends Service {
      /// {{ method.title }}
 {% if method.description %}
      ///
-{{ method.description|dartComment }}
+{{ method.description | dartComment }}
      ///
 {% endif %}
-    {% if method.type == 'webAuth' %}Future{% elseif method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst | overrideIdentifier}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters) }}) async {
+    {% if method.type == 'webAuth' %}Future{% elseif method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst | overrideIdentifier}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters, method.consumes) }}) async {
         final String path = '{{ method.path }}'{% for parameter in method.parameters.path %}.replaceAll('{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
 
         final Map<String, dynamic> params = {
@@ -51,7 +51,34 @@ class {{ service.name | caseUcfirst }} extends Service {
 {% endfor %}
         };
 
+
+{% if 'multipart/form-data' in method.consumes %}
+        dynamic res;
+        if(identical(0, 0.0)) {
+{% for parameter in method.parameters.all %}
+{% if parameter.type == 'file' %}
+          params['{{ parameter.name }}'] = {{ parameter.name }}.file;
+{% endif %}
+{% endfor %}
+          res = await client.call(HttpMethod.{{ method.method | caseLower }}, path: path, params: params, headers: headers);
+        } else {
+{% for parameter in method.parameters.all %}
+{% if parameter.type == 'file' %}
+          final paramName = '{{ parameter.name }}';
+{% endif %}
+{% endfor %}
+          res = await chunkedUpload(
+            client: client,
+            path: path,
+            params: params,
+            paramName: paramName,
+            headers: headers,
+            onProgress: onProgress,
+          );
+        }
+{% else %}
         final res = await client.call(HttpMethod.{{ method.method | caseLower }}, path: path, params: params, headers: headers);
+{% endif %}
         return {% if method.responseModel and method.responseModel != 'any' %}models.{{method.responseModel | caseUcfirst | overrideIdentifier}}.fromMap(res.data){% else %} res.data{% endif %};
 {% endif %}
     }

templates/dart/lib/src/chunked_upload_io.dart.twig

@@ -0,0 +1,54 @@
+import 'client.dart';
+import 'dart:io' as io;
+import 'enums.dart';
+import 'package:http/http.dart' as http;
+import 'response.dart';
+import 'dart:math';
+import 'input_file.dart';
+import 'exception.dart';
+
+Future<Response> chunkedUpload({
+  required Client client,
+  required String path,
+  required Map<String, dynamic> params,
+  required String paramName,
+  required Map<String, String> headers,
+  Function(double)? onProgress,
+}) async {
+  InputFile file = params[paramName];
+  if (file.path == null) {
+    throw AppwriteException("File path must be provided for dart:io");
+  }
+  io.File iofile = io.File(file.path!);
+  final size = await iofile.length();
+
+  late Response res;
+  if (size <= Client.CHUNK_SIZE) {
+    params[paramName] = await http.MultipartFile.fromPath(paramName, file.path!, filename: file.fileName);
+    return client.call(
+      HttpMethod.post,
+      path: path,
+      params: params,
+      headers: headers,
+    );
+  }
+  // read chunk and upload each chunk
+  var offset = 0;
+  final raf = iofile.openSync(mode: io.FileMode.read);
+
+  while (offset < size) {
+    final chunk = raf.readSync(Client.CHUNK_SIZE);
+    params[paramName] =
+        http.MultipartFile.fromBytes(paramName, chunk, filename: iofile.path);
+    headers['content-range'] =
+        'bytes $offset-${min<int>(((offset + Client.CHUNK_SIZE) - 1), size)}/$size';
+    res = await client.call(HttpMethod.post,
+        path: path, headers: headers, params: params);
+    offset += Client.CHUNK_SIZE;
+    if(offset < size) {
+      headers['x-appwrite-id'] = res.data['\$id'];
+    }
+    onProgress?.call(min(offset,size)/size * 100);
+  }
+  return res;
+}

templates/dart/lib/src/chunked_upload_stub.dart.twig

@@ -0,0 +1,12 @@
+import 'response.dart';
+import 'client.dart';
+
+Future<Response> chunkedUpload({
+  required Client client,
+  required String path,
+  required Map<String, dynamic> params,
+  required String paramName,
+  required Map<String, String> headers,
+  Function(double)? onProgress
+}) =>
+    throw UnsupportedError('Cannot redirect to url without dart:html');

templates/dart/lib/src/client.dart.twig

@@ -5,6 +5,7 @@ import 'client_stub.dart'
 import 'response.dart';
 
 abstract class Client {
+  static const int CHUNK_SIZE = 5*1024*1024;
   late Map<String, String> config;
   late String _endPoint;
 

templates/dart/lib/src/input_file.dart.twig

@@ -0,0 +1,9 @@
+import 'package:http/http.dart' show MultipartFile;
+
+class InputFile {
+  final MultipartFile? file;
+  final String? path;
+  final String? fileName;
+
+  InputFile({this.file, this.path, this.fileName});
+}

templates/flutter/lib/package.dart.twig

@@ -2,13 +2,15 @@ library {{ language.params.packageName }};
 
 import 'dart:async';
 import 'dart:typed_data';
-import 'package:http/http.dart' as http;
 import 'package:flutter/foundation.dart';
 import 'src/redirect_stub.dart'
     if (dart.library.html) 'src/redirect_browser.dart';
+import 'src/chunked_upload_stub.dart'
+    if (dart.library.io) 'src/chunked_upload_io.dart';
 import 'src/enums.dart';
 import 'src/client.dart';
 import 'src/service.dart';
+import 'src/input_file.dart';
 import 'models.dart' as models;
 
 export 'src/response.dart';
@@ -17,6 +19,7 @@ export 'src/exception.dart';
 export 'src/realtime.dart';
 export 'src/realtime_subscription.dart';
 export 'src/realtime_message.dart';
+export 'src/input_file.dart';
 export 'package:http/http.dart' show MultipartFile;
 
 part 'query.dart';

templates/flutter/lib/services/service.dart.twig

@@ -1,8 +1,8 @@
 part of {{ language.params.packageName }};
 
 {% macro parameter(parameter) %}{% if parameter.required %}required {{ parameter.type | typeName }}{% else %}{{ parameter.type | typeName }}?{% endif %} {{ parameter.name | caseCamel | escapeKeyword }}{% endmacro %}
-{% macro method_parameters(parameters) %}
-{% if parameters.all|length > 0 %}{{ '{' }}{% for parameter in parameters.all %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{{ '}' }}{% endif %}
+{% macro method_parameters(parameters, consumes) %}
+{% if parameters.all|length > 0 %}{{ '{' }}{% for parameter in parameters.all %}{{ _self.parameter(parameter) }}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, Function(double)? onProgress{% endif %}{{ '}' }}{% endif %}
 {% endmacro %}
 {% macro map_parameter(parameter) %}'{{ parameter.name }}': {{ parameter.name | caseCamel | escapeKeyword }},{% endmacro %}
 class {{ service.name | caseUcfirst }} extends Service {
@@ -15,7 +15,7 @@ class {{ service.name | caseUcfirst }} extends Service {
 {{ method.description|dartComment }}
      ///
 {% endif %}
-    {% if method.type == 'webAuth' %}Future{% elseif method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters) }}) async {
+    {% if method.type == 'webAuth' %}Future{% elseif method.type == 'location' %} Future<Uint8List> {% else %} {% if method.responseModel and method.responseModel != 'any' %}Future<models.{{method.responseModel | caseUcfirst}}>{% else %}Future{% endif %}{% endif %} {{ method.name | caseCamel }}({{ _self.method_parameters(method.parameters, method.consumes) }}) async {
         final String path = '{{ method.path }}'{% for parameter in method.parameters.path %}.replaceAll('{{ '{' }}{{ parameter.name | caseCamel }}{{ '}' }}', {{ parameter.name | caseCamel | escapeKeyword }}){% endfor %};
 
         final Map<String, dynamic> params = {
@@ -74,7 +74,33 @@ class {{ service.name | caseUcfirst }} extends Service {
 {% endfor %}
         };
 
+{% if 'multipart/form-data' in method.consumes %}
+        dynamic res;
+        if(kIsWeb) {
+{% for parameter in method.parameters.all %}
+{% if parameter.type == 'file' %}
+          params['{{ parameter.name }}'] = {{ parameter.name }}.file;
+{% endif %}
+{% endfor %}
+          res = await client.call(HttpMethod.{{ method.method | caseLower }}, path: path, params: params, headers: headers);
+        } else {
+{% for parameter in method.parameters.all %}
+{% if parameter.type == 'file' %}
+          final paramName = '{{ parameter.name }}';
+{% endif %}
+{% endfor %}
+          res = await chunkedUpload(
+            client: client,
+            path: path,
+            params: params,
+            paramName: paramName,
+            headers: headers,
+            onProgress: onProgress,
+          );
+        }
+{% else %}
         final res = await client.call(HttpMethod.{{ method.method | caseLower }}, path: path, params: params, headers: headers);
+{% endif %}
         return {% if method.responseModel and method.responseModel != 'any' %}models.{{method.responseModel | caseUcfirst}}.fromMap(res.data){% else %} res.data{% endif %};
 {% endif %}
     }

templates/flutter/lib/src/chunked_upload_io.dart.twig

@@ -0,0 +1,54 @@
+import 'client.dart';
+import 'dart:io' as io;
+import 'enums.dart';
+import 'package:http/http.dart' as http;
+import 'response.dart';
+import 'dart:math';
+import 'input_file.dart';
+import 'exception.dart';
+
+Future<Response> chunkedUpload({
+  required Client client,
+  required String path,
+  required Map<String, dynamic> params,
+  required String paramName,
+  required Map<String, String> headers,
+  Function(double)? onProgress,
+}) async {
+  InputFile file = params[paramName];
+  if (file.path == null) {
+    throw AppwriteException("File path must be provided for dart:io");
+  }
+  io.File iofile = io.File(file.path!);
+  final size = await iofile.length();
+
+  late Response res;
+  if (size <= Client.CHUNK_SIZE) {
+    params[paramName] = await http.MultipartFile.fromPath(paramName, file.path!, filename: file.fileName);
+    return client.call(
+      HttpMethod.post,
+      path: path,
+      params: params,
+      headers: headers,
+    );
+  }
+  // read chunk and upload each chunk
+  var offset = 0;
+  final raf = iofile.openSync(mode: io.FileMode.read);
+
+  while (offset < size) {
+    final chunk = raf.readSync(Client.CHUNK_SIZE);
+    params[paramName] =
+        http.MultipartFile.fromBytes(paramName, chunk, filename: iofile.path);
+    headers['content-range'] =
+        'bytes $offset-${min<int>(((offset + Client.CHUNK_SIZE) - 1), size)}/$size';
+    res = await client.call(HttpMethod.post,
+        path: path, headers: headers, params: params);
+    offset += Client.CHUNK_SIZE;
+    if(offset < size) {
+      headers['x-appwrite-id'] = res.data['\$id'];
+    }
+    onProgress?.call(min(offset,size)/size * 100);
+  }
+  return res;
+}

templates/flutter/lib/src/chunked_upload_stub.dart.twig

@@ -0,0 +1,12 @@
+import 'response.dart';
+import 'client.dart';
+
+Future<Response> chunkedUpload({
+  required Client client,
+  required String path,
+  required Map<String, dynamic> params,
+  required String paramName,
+  required Map<String, String> headers,
+  Function(double)? onProgress,
+}) =>
+    throw UnsupportedError('Cannot redirect to url without dart:html');

templates/flutter/lib/src/client.dart.twig

@@ -5,6 +5,7 @@ import 'client_stub.dart'
 import 'response.dart';
 
 abstract class Client {
+  static const int CHUNK_SIZE = 5*1024*1024;
   late Map<String, String> config;
   late String _endPoint;
   late String? _endPointRealtime;

templates/flutter/lib/src/input_file.dart.twig

@@ -0,0 +1,9 @@
+import 'package:http/http.dart' show MultipartFile;
+
+class InputFile {
+  final MultipartFile? file;
+  final String? path;
+  final String? fileName;
+
+  InputFile({this.file, this.path, this.fileName});
+}