#119 Feature Request: Upload Progress

Author: EddyVerbruggen

CHANGELOG.md

@@ -11,6 +11,8 @@ If version numbers __changed__, clean your platform folders to avoid build error
 - Android: 9.4.0
 
 ### New
+- [#119](#119) Upload Progress
+- [#120](#120) Chaining range types for `.query`
 - [#125](#125) Analytics API
 
 

docs/STORAGE.md

@@ -50,7 +50,12 @@ You can either pass in a full local path to a file, or (as a convenience) use th
     // option 1: a file-system module File object
     localFile: fs.File.fromPath(logoPath),
     // option 2: a full file path (ignored if 'localFile' is set)
-    localFullPath: logoPath
+    localFullPath: logoPath,
+    // get notified of file upload progress
+    onProgress: function(status) {
+      console.log("Uploaded fraction: " + status.fractionCompleted);
+      console.log("Percentage complete: " + status.percentageCompleted);
+    }
   }).then(
       function (uploadedFile) 
         console.log("File uploaded: " + JSON.stringify(uploadedFile));

firebase.android.js

@@ -1067,6 +1067,18 @@ firebase.uploadFile = function (arg) {
         }
       });
 
+      var onProgressListener = new com.google.firebase.storage.OnProgressListener({
+        onProgress: function (snapshot) {
+          if (typeof(arg.onProgress) === "function") {
+            var fractionCompleted = snapshot.getBytesTransferred() / snapshot.getTotalByteCount();
+            arg.onProgress({
+              fractionCompleted: fractionCompleted,
+              percentageCompleted: Math.round(fractionCompleted * 100)
+            });
+          }
+        }
+      });
+
       if (arg.localFile) {
         if (typeof(arg.localFile) != "object") {
           reject("localFile argument must be a File object; use file-system module to create one");
@@ -1083,7 +1095,8 @@ firebase.uploadFile = function (arg) {
 
         var uploadDataTask = storageReference.putBytes(contents)
             .addOnFailureListener(onFailureListener)
-            .addOnSuccessListener(onSuccessListener);
+            .addOnSuccessListener(onSuccessListener)
+            .addOnProgressListener(onProgressListener);
 
       } else if (arg.localFullPath) {
 
@@ -1096,11 +1109,11 @@ firebase.uploadFile = function (arg) {
         var localFileUrl = android.net.Uri.fromFile(new java.io.File(arg.localFullPath));
         var uploadFileTask = storageReference.putFile(localFileUrl)
             .addOnFailureListener(onFailureListener)
-            .addOnSuccessListener(onSuccessListener);
+            .addOnSuccessListener(onSuccessListener)
+            .addOnProgressListener(onProgressListener);
 
       } else {
         reject("One of localFile or localFullPath is required");
-        return;
       }
 
     } catch (ex) {

firebase.d.ts

@@ -276,7 +276,17 @@ declare module "nativescript-plugin-firebase" {
         /**
          * Option 2: a full file path (ignored if 'localFile' is set)
          */
-        localFullPath?: string
+        localFullPath?: string;
+
+        /**
+         * You can get updates during upload by passing a function, example:
+         * 
+         * onProgress: function(status) {
+         *   console.log("Uploaded fraction: " + status.fractionCompleted);
+         *   console.log("Percentage complete: " + status.percentageCompleted);
+         * }
+         */
+        onProgress?: Function;
     }
 
     export interface UploadFileResult {

firebase.ios.js

@@ -1095,6 +1095,7 @@ firebase.uploadFile = function (arg) {
       }
 
       var fIRStorageReference = storageRef.child(arg.remoteFullPath);
+      var fIRStorageUploadTask = null;
 
       if (arg.localFile) {
         if (typeof(arg.localFile) != "object") {
@@ -1110,17 +1111,29 @@ firebase.uploadFile = function (arg) {
           return;
         }
 
-        var fIRStorageUploadDataTask = fIRStorageReference.putDataMetadataCompletion(contents, null, onCompletion);
+        fIRStorageUploadTask = fIRStorageReference.putDataMetadataCompletion(contents, null, onCompletion);
 
       } else if (arg.localFullPath) {
         var localFileUrl = NSURL.fileURLWithPath(arg.localFullPath);
-        var fIRStorageUploadFileTask = fIRStorageReference.putFileMetadataCompletion(localFileUrl, null, onCompletion);
+        fIRStorageUploadTask = fIRStorageReference.putFileMetadataCompletion(localFileUrl, null, onCompletion);
 
       } else {
         reject("One of localFile or localFullPath is required");
         return;
       }
 
+      if (fIRStorageUploadTask !== null) {
+        // Add a progress observer to an upload task
+        var fIRStorageHandle = fIRStorageUploadTask.observeStatusHandler(FIRStorageTaskStatusProgress, function(snapshot) {
+          if (!snapshot.error && typeof(arg.onProgress) === "function") {
+            arg.onProgress({
+              fractionCompleted: snapshot.progress.fractionCompleted,
+              percentageCompleted: Math.round(snapshot.progress.fractionCompleted * 100)
+            });
+          }
+        });
+      }
+
     } catch (ex) {
       console.log("Error in firebase.uploadFile: " + ex);
       reject(ex);