add metadata to storage

Author: Bas Buijsen

firebase-storage/src/androidMain/kotlin/dev/gitlive/firebase/storage/storage.kt

@@ -10,6 +10,7 @@ import com.google.android.gms.tasks.OnCanceledListener
 import com.google.android.gms.tasks.OnCompleteListener
 import com.google.firebase.storage.OnPausedListener
 import com.google.firebase.storage.OnProgressListener
+import com.google.firebase.storage.StorageMetadata
 import com.google.firebase.storage.UploadTask
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
@@ -65,10 +66,20 @@ actual class StorageReference(val android: com.google.firebase.storage.StorageRe
 
     actual suspend fun listAll(): ListResult = ListResult(android.listAll().await())
 
-    actual suspend fun putFile(file: File) = android.putFile(file.uri).await().run {}
+    actual suspend fun putFile(file: File, metadata: FirebaseStorageMetadata?) {
+        if (metadata != null) {
+            android.putFile(file.uri, metadata.toStorageMetadata()).await().run {}
+        } else {
+            android.putFile(file.uri).await().run {}
+        }
+    }
 
-    actual fun putFileResumable(file: File): ProgressFlow {
-        val android = android.putFile(file.uri)
+    actual fun putFileResumable(file: File, metadata: FirebaseStorageMetadata?): ProgressFlow {
+        val android = if (metadata != null) {
+            android.putFile(file.uri, metadata.toStorageMetadata())
+        } else {
+            android.putFile(file.uri)
+        }
 
         val flow = callbackFlow {
             val onCanceledListener = OnCanceledListener { cancel() }
@@ -105,3 +116,18 @@ actual class ListResult(android: com.google.firebase.storage.ListResult) {
 actual class File(val uri: Uri)
 
 actual typealias FirebaseStorageException = com.google.firebase.storage.StorageException
+
+
+fun FirebaseStorageMetadata.toStorageMetadata(): StorageMetadata {
+    return StorageMetadata.Builder()
+        .setCacheControl(this.cacheControl)
+        .setContentDisposition(this.contentDisposition)
+        .setContentEncoding(this.contentEncoding)
+        .setContentLanguage(this.contentLanguage)
+        .setContentType(this.contentType)
+        .apply {
+            customMetadata?.entries?.forEach {
+                (key, value) -> setCustomMetadata(key, value)
+            }
+        }.build()
+}

firebase-storage/src/commonMain/kotlin/dev/gitlive/firebase/storage/storage.kt

@@ -40,9 +40,9 @@ expect class StorageReference {
 
     suspend fun listAll(): ListResult
 
-    suspend fun putFile(file: File)
+    suspend fun putFile(file: File, metadata: FirebaseStorageMetadata? = null)
 
-    fun putFileResumable(file: File): ProgressFlow
+    fun putFileResumable(file: File, metadata: FirebaseStorageMetadata? = null): ProgressFlow
 }
 
 expect class ListResult {
@@ -66,3 +66,13 @@ interface ProgressFlow : Flow<Progress> {
 
 
 expect class FirebaseStorageException : FirebaseException
+
+data class FirebaseStorageMetadata(
+    val md5Hash: String? = null,
+    val cacheControl: String? = null,
+    val contentDisposition: String? = null,
+    val contentEncoding: String? = null,
+    val contentLanguage: String? = null,
+    val contentType: String? = null,
+    val customMetadata: Map<String, String>? = null
+)

firebase-storage/src/iosMain/kotlin/dev/gitlive/firebase/storage/storage.kt

@@ -6,6 +6,7 @@ package dev.gitlive.firebase.storage
 
 import cocoapods.FirebaseStorage.FIRStorage
 import cocoapods.FirebaseStorage.FIRStorageListResult
+import cocoapods.FirebaseStorage.FIRStorageMetadata
 import cocoapods.FirebaseStorage.FIRStorageReference
 import cocoapods.FirebaseStorage.FIRStorageTaskStatusFailure
 import cocoapods.FirebaseStorage.FIRStorageTaskStatusPause
@@ -76,10 +77,10 @@ actual class StorageReference(val ios: FIRStorageReference) {
         }
     }
 
-    actual suspend fun putFile(file: File) = ios.awaitResult { putFile(file.url, null, completion = it) }.run {}
+    actual suspend fun putFile(file: File, metadata: FirebaseStorageMetadata?) = ios.awaitResult { putFile(file.url, metadata?.toFIRMetadata(), completion = it) }.run {}
 
-    actual fun putFileResumable(file: File): ProgressFlow {
-        val ios = ios.putFile(file.url)
+    actual fun putFileResumable(file: File, metadata: FirebaseStorageMetadata?): ProgressFlow {
+        val ios = ios.putFile(file.url, metadata?.toFIRMetadata())
 
         val flow = callbackFlow {
             ios.observeStatus(FIRStorageTaskStatusProgress) {
@@ -147,3 +148,20 @@ suspend inline fun <T, reified R> T.awaitResult(function: T.(callback: (R?, NSEr
     }
     return job.await() as R
 }
+
+fun FirebaseStorageMetadata.toFIRMetadata(): FIRStorageMetadata {
+    val metadata = FIRStorageMetadata()
+    val customMetadata: Map<Any?, String>? = this.customMetadata?.let {
+        it.mapKeys { entry ->
+            entry.key as Any to entry.value
+        }
+    }
+
+    metadata.setCustomMetadata(customMetadata)
+    metadata.setCacheControl(this.cacheControl)
+    metadata.setContentDisposition(this.contentDisposition)
+    metadata.setContentEncoding(this.contentEncoding)
+    metadata.setContentLanguage(this.contentLanguage)
+    metadata.setContentType(this.contentType)
+    return metadata
+}

firebase-storage/src/jsMain/kotlin/dev/gitlive/firebase/storage/externals/storage.kt

@@ -4,6 +4,7 @@
 package dev.gitlive.firebase.storage.externals
 
 import dev.gitlive.firebase.externals.FirebaseApp
+import dev.gitlive.firebase.storage.FirebaseStorageMetadata
 import kotlin.js.Promise
 
 external fun getStorage(app: FirebaseApp? = definedExternally): FirebaseStorage
@@ -13,9 +14,9 @@ external fun ref(ref: StorageReference, url: String? = definedExternally): Stora
 
 external fun getDownloadURL(ref: StorageReference): Promise<String>
 
-external fun uploadBytes(ref: StorageReference, file: dynamic): Promise<Unit>
+external fun uploadBytes(ref: StorageReference, file: dynamic, metadata: FirebaseStorageMetadata?): Promise<Unit>
 
-external fun uploadBytesResumable(ref: StorageReference, data: dynamic): UploadTask
+external fun uploadBytesResumable(ref: StorageReference, data: dynamic, metadata: FirebaseStorageMetadata?): UploadTask
 
 external fun deleteObject(ref: StorageReference): Promise<Unit>;
 

firebase-storage/src/jsMain/kotlin/dev/gitlive/firebase/storage/storage.kt

@@ -59,10 +59,10 @@ actual class StorageReference(val js: dev.gitlive.firebase.storage.externals.Sto
 
     actual suspend fun listAll(): ListResult = rethrow { ListResult(listAll(js).await()) }
 
-    actual suspend fun putFile(file: File): Unit = rethrow { uploadBytes(js, file).await() }
+    actual suspend fun putFile(file: File, metadata: FirebaseStorageMetadata?): Unit = rethrow { uploadBytes(js, file, metadata).await() }
 
-    actual fun putFileResumable(file: File): ProgressFlow = rethrow {
-        val uploadTask = uploadBytesResumable(js, file)
+    actual fun putFileResumable(file: File, metadata: FirebaseStorageMetadata?): ProgressFlow = rethrow {
+        val uploadTask = uploadBytesResumable(js, file, metadata)
 
         val flow = callbackFlow {
             val unsubscribe = uploadTask.on(

firebase-storage/src/jvmMain/kotlin/dev/gitlive/firebase/storage/storage.jvm.kt

@@ -66,11 +66,11 @@ actual class StorageReference {
         TODO("Not yet implemented")
     }
 
-    actual fun putFileResumable(file: File): ProgressFlow {
+    actual fun putFileResumable(file: File, metadata: FirebaseStorageMetadata?): ProgressFlow {
         TODO("Not yet implemented")
     }
 
-    actual suspend fun putFile(file: File) {
+    actual suspend fun putFile(file: File, metadata: FirebaseStorageMetadata?) {
     }
 
 }