Propagate error for ListAll (#713)

Author: schmidt-sebastian

firebase-storage/CHANGELOG.md

@@ -1,13 +1,19 @@
-# Unreleased (17.1.0)
+# 19.0.1
+- [fixed] `listAll()` now propagates the error messages if the List operation
+  was denied by a Security Rule.
+
+# 19.0.0
+- [changed] Added missing nullability annotations for better Kotlin interop.
+- [internal] Removed ``@PublicApi` annotations as they are no longer enforced
+  and have no semantic meaning.
+
+# 18.1.0
 - [feature] Added `StorageReference.list()` and `StorageReference.listAll()`,
   which allows developers to list the files and folders under the given
   StorageReference.
 - [changed] Added validation to `StorageReference.getDownloadUrl()` and
   `StorageReference.getMetadata()` to return an error if the reference is the
   root of the bucket.
-- [changed] Added missing nullability annotations for better Kotlin interop.
-- [internal] Removed ``@PublicApi` annotations as they are no longer enforced
-  and have no semantic meaning.
 
 # 17.0.0
 - [internal] Updated the SDK initialization process and removed usages of

firebase-storage/src/main/java/com/google/firebase/storage/StorageReference.java

@@ -626,15 +626,20 @@ public Task<ListResult> listAll() {
         new Continuation<ListResult, Task<Void>>() {
           @Override
           public Task<Void> then(@NonNull Task<ListResult> currentPage) {
-            ListResult result = currentPage.getResult();
-            prefixes.addAll(result.getPrefixes());
-            items.addAll(result.getItems());
-
-            if (result.getPageToken() != null) {
-              Task<ListResult> nextPage = listHelper(/* maxResults= */ null, result.getPageToken());
-              nextPage.continueWithTask(executor, this);
+            if (currentPage.isSuccessful()) {
+              ListResult result = currentPage.getResult();
+              prefixes.addAll(result.getPrefixes());
+              items.addAll(result.getItems());
+
+              if (result.getPageToken() != null) {
+                Task<ListResult> nextPage =
+                    listHelper(/* maxResults= */ null, result.getPageToken());
+                nextPage.continueWithTask(executor, this);
+              } else {
+                pendingResult.setResult(new ListResult(prefixes, items, /* pageToken= */ null));
+              }
             } else {
-              pendingResult.setResult(new ListResult(prefixes, items, /* pageToken= */ null));
+              pendingResult.setException(currentPage.getException());
             }
 
             return Tasks.forResult(null);

firebase-storage/src/test/java/com/google/firebase/storage/ListTest.java

@@ -103,6 +103,18 @@ public void listResultsWithMultiplePages() throws InterruptedException {
     TestUtil.verifyTaskStateChanges("listMultiplePages", task.getResult().toString());
   }
 
+  @Test
+  public void listFailure() throws InterruptedException {
+    MockConnectionFactory factory =
+        NetworkLayerMock.ensureNetworkMock("listSinglePageFailed", false);
+    Task<StringBuilder> task = TestCommandHelper.listFiles(/* pageSize= */ 10, /* pageCount= */ 1);
+
+    TestUtil.await(task);
+
+    factory.verifyOldMock();
+    TestUtil.verifyTaskStateChanges("listSinglePageFailed", task.getResult().toString());
+  }
+
   @Test
   public void listAll() throws InterruptedException {
     MockConnectionFactory factory = NetworkLayerMock.ensureNetworkMock("listAll", true);
@@ -113,4 +125,15 @@ public void listAll() throws InterruptedException {
     factory.verifyOldMock();
     TestUtil.verifyTaskStateChanges("listAll", task.getResult().toString());
   }
+
+  @Test
+  public void listAllWithFailure() throws InterruptedException {
+    MockConnectionFactory factory = NetworkLayerMock.ensureNetworkMock("listAllFailed", false);
+    Task<StringBuilder> task = TestCommandHelper.listAllFiles();
+
+    TestUtil.await(task);
+
+    factory.verifyOldMock();
+    TestUtil.verifyTaskStateChanges("listAllFailed", task.getResult().toString());
+  }
 }

firebase-storage/src/test/resources/activitylogs/listAllFailed_network.txt

@@ -0,0 +1,29 @@
+
+<new>
+Url:https://firebasestorage.googleapis.com/v0/b/fooey.appspot.com/o?prefix=largeDirectory%2F&delimiter=%2F
+setRequestMethod:GET
+setRequestProperty:X-Firebase-Storage-Version,Android/[No Gmscore]
+setRequestProperty:x-firebase-gmpid,fooey
+setRequestProperty:Content-Length,0
+setUseCaches:false
+setDoInput:true
+getResponseCode:403
+getHeaderFields:
+ null:[HTTP/1.1 403 Forbidden]
+ Access-Control-Allow-Origin:[*]
+ Access-Control-Expose-Headers:[Content-Range, X-Firebase-Storage-XSRF]
+ Alt-Svc:[quic=":443"; ma=2592000; v="46,43,39"]
+ Cache-Control:[private, max-age=0]
+ Content-Length:[106]
+ Content-Type:[application/json; charset=UTF-8]
+ Date:[Fri, 16 Aug 2019 17:51:19 GMT]
+ Expires:[Fri, 16 Aug 2019 17:51:19 GMT]
+ Server:[UploadServer]
+ X-Android-Received-Millis:[1565977885114]
+ X-Android-Response-Source:[NETWORK 403]
+ X-Android-Selected-Protocol:[http/1.1]
+ X-Android-Sent-Millis:[1565977884943]
+ X-Content-Type-Options:[nosniff]
+ X-GUploader-UploadID:[AEnB2Up1Fu4ZwtUsQe7mXrzuQ_S2KZvRwUttfOYcrQsZm4kuJcUJFvMzTRxkmydO8ErBV1bI_Ku_B7xqFBp5r4bt-hEu4a2JBQ]
+getErrorStream:{  "error": {    "code": 403,    "message": "Permission denied. Could not perform this operation"  }}
+disconnect:

firebase-storage/src/test/resources/activitylogs/listAllFailed_task.txt

@@ -0,0 +1,4 @@
+
+listAll:
+  onComplete:Success=false
+done.

firebase-storage/src/test/resources/activitylogs/listSinglePageFailed_network.txt

@@ -0,0 +1,29 @@
+
+<new>
+Url:https://firebasestorage.googleapis.com/v0/b/fooey.appspot.com/o?prefix=smallDirectory%2F&delimiter=%2F&maxResults=10
+setRequestMethod:GET
+setRequestProperty:X-Firebase-Storage-Version,Android/[No Gmscore]
+setRequestProperty:x-firebase-gmpid,fooey
+setRequestProperty:Content-Length,0
+setUseCaches:false
+setDoInput:true
+getResponseCode:403
+getHeaderFields:
+ null:[HTTP/1.1 403 Forbidden]
+ Access-Control-Allow-Origin:[*]
+ Access-Control-Expose-Headers:[Content-Range, X-Firebase-Storage-XSRF]
+ Alt-Svc:[quic=":443"; ma=2592000; v="46,43,39"]
+ Cache-Control:[private, max-age=0]
+ Content-Length:[106]
+ Content-Type:[application/json; charset=UTF-8]
+ Date:[Fri, 16 Aug 2019 17:51:19 GMT]
+ Expires:[Fri, 16 Aug 2019 17:51:19 GMT]
+ Server:[UploadServer]
+ X-Android-Received-Millis:[1565977885114]
+ X-Android-Response-Source:[NETWORK 403]
+ X-Android-Selected-Protocol:[http/1.1]
+ X-Android-Sent-Millis:[1565977884943]
+ X-Content-Type-Options:[nosniff]
+ X-GUploader-UploadID:[AEnB2Up1Fu4ZwtUsQe7mXrzuQ_S2KZvRwUttfOYcrQsZm4kuJcUJFvMzTRxkmydO8ErBV1bI_Ku_B7xqFBp5r4bt-hEu4a2JBQ]
+getErrorStream:{  "error": {    "code": 403,    "message": "Permission denied. Could not perform this operation"  }}
+disconnect:

firebase-storage/src/test/resources/activitylogs/listSinglePageFailed_task.txt

@@ -0,0 +1,4 @@
+
+list:
+  onComplete:Success=false
+done.

firebase-storage/src/testUtil/java/com/google/firebase/storage/TestCommandHelper.java

@@ -242,12 +242,12 @@ public static Task<StringBuilder> listFiles(int pageSize, int pageCount) {
           public void onComplete(@NonNull Task<ListResult> task) {
             ++pagesReceived[0];
 
-            ListResult listResult = task.getResult();
-
             builder.append("\nlist:");
             builder.append("\n  onComplete:Success=").append(task.isSuccessful());
 
             if (task.isSuccessful()) {
+              ListResult listResult = task.getResult();
+
               builder.append("\n  Received Prefixes:");
               for (StorageReference prefix : listResult.getPrefixes()) {
                 builder.append("\n    ").append(prefix.getPath());
@@ -257,12 +257,14 @@ public void onComplete(@NonNull Task<ListResult> task) {
                 builder.append("\n    ").append(item.getPath());
               }
               builder.append("\n  Page Token:").append(listResult.getPageToken());
-            }
 
-            if (pagesReceived[0] == pageCount) {
-              result.setResult(builder);
+              if (pagesReceived[0] == pageCount) {
+                result.setResult(builder);
+              } else {
+                reference.list(pageSize, listResult.getPageToken()).addOnCompleteListener(this);
+              }
             } else {
-              reference.list(pageSize, listResult.getPageToken()).addOnCompleteListener(this);
+              result.setResult(builder);
             }
           }
         });
@@ -280,12 +282,11 @@ public static Task<StringBuilder> listAllFiles() {
     listFiles.addOnCompleteListener(
         executor,
         task -> {
-          ListResult listResult = task.getResult();
-
           builder.append("\nlistAll:");
           builder.append("\n  onComplete:Success=").append(task.isSuccessful());
 
           if (task.isSuccessful()) {
+            ListResult listResult = task.getResult();
             builder.append("\n  Received Prefixes:");
             for (StorageReference prefix : listResult.getPrefixes()) {
               builder.append("\n    ").append(prefix.getPath());

firebase-storage/test-app/src/main/java/com/example/storage/MainActivity.java

@@ -40,6 +40,7 @@
 import com.google.android.gms.tasks.Continuation;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
+import com.google.firebase.FirebaseApp;
 import com.google.firebase.auth.FirebaseAuth;
 import com.google.firebase.storage.FirebaseStorage;
 import com.google.firebase.storage.TestCommandHelper;
@@ -104,6 +105,7 @@ protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     setContentView(R.layout.activity_main);
 
+    FirebaseApp.initializeApp(getApplicationContext());
     FirebaseAuth.getInstance().signInAnonymously();
 
     Button clickButton = findViewById(R.id.streamDownload);

firebase-storage/test-app/test-app.gradle

@@ -67,4 +67,4 @@ dependencies {
 // androidTest integration tests.
 // ==========================================================================
 ext.packageName = "com.example.storage"
-apply from: '../../gradle/googleServices.gradle'
+apply from: '../../gradle/googleServices.gradle'