Merge pull request #388 from appwrite/refactor-on-progress

christyjacob4 · web-flow · commit 2db22f5be629 · 2022-03-01T13:45:39.000+04:00
Refactor on progress
diff --git a/src/SDK/Language/Android.php b/src/SDK/Language/Android.php
@@ -158,6 +158,12 @@ public function getFiles()
                 'template'      => '/android/library/src/main/java/io/appwrite/models/RealtimeModels.kt.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/library/src/main/java/{{ sdk.namespace | caseSlash }}/models/UploadProgress.kt',
+                'template'      => '/android/library/src/main/java/io/appwrite/models/UploadProgress.kt.twig',
+                'minify'        => false,
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => '/library/src/main/java/{{ sdk.namespace | caseSlash }}/WebAuthComponent.kt',
diff --git a/src/SDK/Language/Kotlin.php b/src/SDK/Language/Kotlin.php
@@ -390,6 +390,12 @@ public function getFiles()
                 'template'      => '/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/src/main/kotlin/{{ sdk.namespace | caseSlash }}/models/UploadProgress.kt',
+                'template'      => '/kotlin/src/main/kotlin/io/appwrite/models/UploadProgress.kt.twig',
+                'minify'        => false,
+            ],
             [
                 'scope'         => 'definition',
                 'destination'   => '/src/main/kotlin/{{ sdk.namespace | caseSlash }}/models/{{ definition.name | caseUcfirst }}.kt',
diff --git a/src/SDK/Language/Swift.php b/src/SDK/Language/Swift.php
@@ -163,6 +163,12 @@ public function getFiles()
                 'template'      => 'swift/Sources/Models/Query.swift.twig',
                 'minify'        => false,
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => '/Sources/{{ spec.title | caseUcfirst}}/Models/UploadProgress.swift',
+                'template'      => 'swift/Sources/Models/UploadProgress.swift.twig',
+                'minify'        => false,
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => '/Sources/{{ spec.title | caseUcfirst}}/Extensions/Codable+JSON.swift',
diff --git a/templates/android/library/src/main/java/io/appwrite/Client.kt.twig b/templates/android/library/src/main/java/io/appwrite/Client.kt.twig
@@ -8,6 +8,7 @@ import {{ sdk.namespace | caseDot }}.{{ spec.title | caseLower }}.BuildConfig
 import {{ sdk.namespace | caseDot }}.exceptions.{{ spec.title | caseUcfirst }}Exception
 import {{ sdk.namespace | caseDot }}.extensions.fromJson
 import {{ sdk.namespace | caseDot }}.json.PreciseNumberAdapter
+import {{ sdk.namespace | caseDot }}.models.UploadProgress
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
@@ -317,7 +318,7 @@ class Client @JvmOverloads constructor(
         responseType: Class<T>,
         convert: ((Map<String, Any,>) -> T),
         paramName: String,
-        onProgress: ((Double) -> Unit)? = null,
+        onProgress: ((UploadProgress) -> Unit)? = null,
     ): T {
         val file = params[paramName] as File
         val size = file.length()
@@ -371,7 +372,13 @@ class Client @JvmOverloads constructor(
 
             offset += CHUNK_SIZE
             headers["x-{{ spec.title | caseLower }}-id"] = result!!["\$id"].toString()
-            onProgress?.invoke(offset.coerceAtMost(size).toDouble()/size * 100)
+            onProgress?.invoke(UploadProgress(
+                id = result!!["\$id"].toString(),
+                progress = offset.coerceAtMost(size).toDouble()/size * 100,
+                sizeUploaded = offset.coerceAtMost(size),
+                chunksTotal = result!!["chunksTotal"].toString().toInt(),
+                chunksUploaded = result!!["chunksUploaded"].toString().toInt(),
+            ))
         }
 
         return convert(result as Map<String, Any>)
diff --git a/templates/android/library/src/main/java/io/appwrite/models/Error.kt.twig b/templates/android/library/src/main/java/io/appwrite/models/Error.kt.twig
diff --git a/templates/android/library/src/main/java/io/appwrite/models/UploadProgress.kt.twig b/templates/android/library/src/main/java/io/appwrite/models/UploadProgress.kt.twig
@@ -0,0 +1,9 @@
+package {{ sdk.namespace | caseDot }}.models
+
+data class UploadProgress(
+    val id: String,
+    val progress: Double,
+    val sizeUploaded: Long,
+    val chunksTotal: Int,
+    val chunksUploaded: Int
+)
diff --git a/templates/android/library/src/main/java/io/appwrite/services/ServiceTemplate.kt.twig b/templates/android/library/src/main/java/io/appwrite/services/ServiceTemplate.kt.twig
@@ -1,6 +1,6 @@
 {% macro parameter(parameter) %}{{ parameter.name | caseCamel }}: {{ parameter.type | typeName }}{% if not parameter.required %}? = null{% endif %}{% endmacro %}
 {% macro method_parameters(parameters, consumes) %}
-{% if parameters.all|length > 0 %}{% for parameter in parameters.all %}{{ '\n\t\t' }}{{ _self.parameter(parameter) }}{% if not loop.last %}{{ ',' }}{% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, onProgress: ((Double) -> Unit)? = null{% endif %}{% endif %}
+{% if parameters.all|length > 0 %}{% for parameter in parameters.all %}{{ '\n\t\t' }}{{ _self.parameter(parameter) }}{% if not loop.last %}{{ ',' }}{% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, onProgress: ((UploadProgress) -> Unit)? = null{% endif %}{% endif %}
 {% endmacro %}
 {% macro methodNeedsSecurityParameters(method) %}
 {% if (method.type == "webAuth" or method.type == "location") and method.security|length > 0 %}{{ true }}{% else %}{{false}}{% endif %}
diff --git a/templates/kotlin/src/main/kotlin/io/appwrite/Client.kt.twig b/templates/kotlin/src/main/kotlin/io/appwrite/Client.kt.twig
@@ -5,6 +5,7 @@ import com.google.gson.reflect.TypeToken
 import {{ sdk.namespace | caseDot }}.exceptions.{{ spec.title | caseUcfirst }}Exception
 import {{ sdk.namespace | caseDot }}.extensions.fromJson
 import {{ sdk.namespace | caseDot }}.json.PreciseNumberAdapter
+import {{ sdk.namespace | caseDot }}.models.UploadProgress
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
@@ -276,7 +277,7 @@ class Client @JvmOverloads constructor(
         responseType: Class<T>,
         convert: ((Map<String, Any,>) -> T),
         paramName: String,
-        onProgress: ((Double) -> Unit)? = null,
+        onProgress: ((UploadProgress) -> Unit)? = null,
     ): T {
         val file = params[paramName] as File
         val size = file.length()
@@ -330,7 +331,13 @@ class Client @JvmOverloads constructor(
 
             offset += CHUNK_SIZE
             headers["x-{{ spec.title | caseLower }}-id"] = result!!["\$id"].toString()
-            onProgress?.invoke(offset.coerceAtMost(size).toDouble()/size * 100)
+            onProgress?.invoke(UploadProgress(
+                id = result!!["\$id"].toString(),
+                progress = offset.coerceAtMost(size).toDouble()/size * 100,
+                sizeUploaded = offset.coerceAtMost(size),
+                chunksTotal = result!!["chunkTotal"].toString().toInt(),
+                chunksUploaded = result!!["chunkUploaded"].toString().toInt(),
+            ))
         }
 
         return convert(result as Map<String, Any>)
diff --git a/templates/kotlin/src/main/kotlin/io/appwrite/models/UploadProgress.kt.twig b/templates/kotlin/src/main/kotlin/io/appwrite/models/UploadProgress.kt.twig
@@ -0,0 +1,9 @@
+package {{ sdk.namespace | caseDot }}.models
+
+data class UploadProgress(
+    val id: String,
+    val progress: Double,
+    val sizeUploaded: Long,
+    val chunksTotal: Int,
+    val chunksUploaded: Int
+)
diff --git a/templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig b/templates/kotlin/src/main/kotlin/io/appwrite/services/ServiceTemplate.kt.twig
@@ -1,6 +1,6 @@
 {% macro parameter(parameter) %}{{ parameter.name | caseCamel }}: {{ parameter.type | typeName }}{% if not parameter.required %}? = null{% endif %}{% endmacro %}
 {% macro method_parameters(parameters, consumes) %}
-{% if parameters.all|length > 0 %}{% for parameter in parameters.all %}{{ '\n\t\t' }}{{ _self.parameter(parameter) }}{% if not loop.last %}{{ ',' }}{% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, onProgress: ((Double) -> Unit)? = null{% endif %}{% endif %}
+{% if parameters.all|length > 0 %}{% for parameter in parameters.all %}{{ '\n\t\t' }}{{ _self.parameter(parameter) }}{% if not loop.last %}{{ ',' }}{% endif %}{% endfor %}{% if 'multipart/form-data' in consumes %}, onProgress: ((UploadProgress) -> Unit)? = null{% endif %}{% endif %}
 {% endmacro %}
 {% macro methodNeedsSecurityParameters(method) %}
 {% if (method.type == "webAuth" or method.type == "location") and method.security|length > 0 %}{{ true }}{% else %}{{false}}{% endif %}
diff --git a/templates/ruby/lib/container/client.rb.twig b/templates/ruby/lib/container/client.rb.twig
@@ -140,9 +140,13 @@ module {{ spec.title | caseUcfirst }}
                     headers['x-{{ spec.title }}-id'] = result['$id']
                 end
 
-                unless on_progress.nil?
-                    on_progress(min(offset, size)/size * 100)
-                end
+                on_progress.call({
+                    id: result['$id'],
+                    progress: ([offset, size].min).to_f/size.to_f * 100.0,
+                    size_uploaded: [offset, size].min,
+                    chunks_total: result['chunks_total'],
+                    chunks_uploaded: result['chunks_uploaded']
+                }) unless on_progress.nil?
             end
 
             return result unless response_type.respond_to?("from")
diff --git a/templates/swift/Sources/Client.swift.twig b/templates/swift/Sources/Client.swift.twig
@@ -394,7 +394,7 @@ open class Client {
         params: inout [String: Any?],
         paramName: String,
         convert: (([String: Any]) -> T)? = nil,
-        onProgress: ((Double) -> Void)? = nil,
+        onProgress: ((UploadProgress) -> Void)? = nil,
         completion: ((Result<T, {{ spec.title | caseUcfirst }}Error>) -> Void)? = nil
     ) {
         let file = params[paramName] as! File
@@ -419,7 +419,7 @@ open class Client {
 
         while offset < size {
             let slice = input.readSlice(length: Client.chunkSize)
-                ?? input.readSlice(length: size - offset)
+                ?? input.readSlice(length: Int(size - offset))
             
             params[paramName] = File(
                 name: file.name,
@@ -451,7 +451,13 @@ open class Client {
 
             offset += Client.chunkSize
             headers["x-{{ spec.title | caseLower }}-id"] = result["$id"] as? String
-            onProgress?(Double(min(offset, size))/Double(size) * 100.0)
+            onProgress?(UploadProgress(
+                id: result["$id"] as? String ?? "",
+                progress: Double(min(offset, size))/Double(size) * 100.0,
+                sizeUploaded: min(offset, size),
+                chunksTotal: result["chunksTotal"] as? Int ?? -1,
+                chunksUploaded: result["chunksUploaded"] as? Int ?? -1
+            ))
         }
 
         completion?(.success(convert!(result)))
diff --git a/templates/swift/Sources/Models/UploadProgress.swift.twig b/templates/swift/Sources/Models/UploadProgress.swift.twig
@@ -0,0 +1,15 @@
+public class UploadProgress {
+    public let id: String
+    public let progress: Double
+    public let sizeUploaded: Int
+    public let chunksTotal: Int
+    public let chunksUploaded: Int
+
+    public init(id: String, progress: Double, sizeUploaded: Int, chunksTotal: Int, chunksUploaded: Int) {
+        self.id = id
+        self.progress = progress
+        self.sizeUploaded = sizeUploaded
+        self.chunksTotal = chunksTotal
+        self.chunksUploaded = chunksUploaded
+    }
+}
diff --git a/templates/swift/Sources/Services/Service.swift.twig b/templates/swift/Sources/Services/Service.swift.twig
@@ -32,7 +32,7 @@ open class {{ service.name | caseUcfirst }}: Service {
         {{ parameter.name | caseCamel | escapeKeyword }}: {{ parameter.type | typeName | raw }}{% if not parameter.required %}? = nil{% endif %},
 {% endfor %}
 {% if 'multipart/form-data' in method.consumes %}
-        onProgress: ((Double) -> Void)? = nil,
+        onProgress: ((UploadProgress) -> Void)? = nil,
 {% endif %}
         completion: ((Result<{{ _self.resultType(spec, method) }}, {{ spec.title | caseUcfirst}}Error>) -> Void)? = nil
     ) {
diff --git a/tests/SwiftClientTest.php b/tests/SwiftClientTest.php
@@ -11,7 +11,7 @@ class SwiftClientTest extends Base
         'cp tests/languages/swift-client/Tests.swift tests/sdks/swift-client/Tests/AppwriteTests/Tests.swift',
     ];
     protected array $envs = [
-        'swift-5.5' => 'docker run --rm -v $(pwd):/app -w /app/tests/sdks/swift-client swift:5.5 swift test',
+        'swift-5.5' => 'docker run --rm -v $(pwd):/app -w /app/tests/sdks/swift-client swiftarm/swift:5.5.2-focal-multi-arch swift test',
     ];
     protected array $expectedOutput = [
         ...Base::FOO_RESPONSES,
diff --git a/tests/SwiftServerTest.php b/tests/SwiftServerTest.php
@@ -11,7 +11,7 @@ class SwiftServerTest extends Base
         'cp tests/languages/swift-server/Tests.swift tests/sdks/swift-server/Tests/AppwriteTests/Tests.swift',
     ];
     protected array $envs = [
-        'swift-5.5' => 'docker run --rm -v $(pwd):/app -w /app/tests/sdks/swift-server swift:5.5 swift test',
+        'swift-5.5' => 'docker run --rm -v $(pwd):/app -w /app/tests/sdks/swift-server swiftarm/swift:5.5.2-focal-multi-arch swift test',
     ];
     protected array $expectedOutput = [
         ...Base::FOO_RESPONSES,
diff --git a/tests/languages/kotlin/ServiceTest.kt b/tests/languages/kotlin/ServiceTest.kt
@@ -71,7 +71,7 @@ class ServiceTest {
             mock = general.upload("string", 123, listOf("string in array"), File("../../resources/file.png"))
             writeToFile(mock.result)
 
-            mock = general.upload("string", 123, listOf("string in array"), File("../../resources/large_file.mp4")) 
+            mock = general.upload("string", 123, listOf("string in array"), File("../../resources/large_file.mp4"))
             writeToFile(mock.result)
 
             try {
