add listAll

Author: fredzqm

packages/storage/src/implementation/list.ts

@@ -105,7 +105,7 @@ export function listOptionsValidator(p: any) {
         throw `Expected maxResults to be less than or equal to ${MAX_MAX_RESULTS}.`;
       }
     } else if (key === PAGE_TOKEN_KEY) {
-      if (!type.isString(p[PAGE_TOKEN_KEY])) {
+      if (p[PAGE_TOKEN_KEY] && !type.isString(p[PAGE_TOKEN_KEY])) {
         throw 'Expected pageToken to be string.';
       }
     } else {

packages/storage/src/reference.ts

@@ -204,7 +204,45 @@ export class Reference {
   }
 
   /**
-   * List items and sub-directories within this directory.
+   * List all items and prefixes under the current storage reference.
+   *
+   * It is a helper method for calling list() recursively until there is no
+   * more results. The default pagination size is 200.
+   *
+   * Note: the results may not be a consistent snapshot if objects are changed
+   * between paginating requests.
+   *
+   * Warning: If there are
+   *
+   * @return A promise that resolves with all the items and prefixes under
+   *      the current storage reference. `prefixes` contains references to
+   *      sub-directories and `items` contains references to objects in this
+   *      folder. `nextPageToken` is never returned.
+   */
+  listAll(): Promise<ListResult> {
+    args.validate('listAll', [], arguments);
+    const accumulator = {
+      prefixes: [],
+      items: [],
+    };
+    return this.listAllHelper(accumulator, null).then(() => accumulator);
+  }
+
+  private async listAllHelper(accumulator: ListResult, pageToken?: string): Promise<void> {
+    let opt: ListOptions  = {
+      maxResults: 1,
+      pageToken,
+    };
+    const nextPage =  await this.list(opt);
+    Array.prototype.push.apply(accumulator.prefixes, nextPage.prefixes);
+    Array.prototype.push.apply(accumulator.items, nextPage.items);
+    if (nextPage.nextPageToken) {
+      await this.listAllHelper(accumulator, nextPage.nextPageToken);
+    }
+  }
+
+  /**
+   * List items and prefixes within this directory.
    *
    * "/" is treated as a path delimiter. Firebase storage does not support
    * invalid object path that ends with "/" or contains two consecutive "//".
@@ -214,8 +252,8 @@ export class Reference {
    *      and `items` to return.
    * @param options.pageToken The `nextPageToken` from a previous call to
    *      list(). If provided, listing is resumed from the previous position.
-   * @return A promise that resolves with the items and sub-directories.
-   *      `prefixes` contains references to sub-directories and `items`
+   * @return A promise that resolves with the items and prefixes.
+   *      `prefixes` contains references to prefixes and `items`
    *      contains references to objects in this folder. `nextPageToken`
    *      can be passed as `options.pageToken` to get the rest of results.
    */

packages/storage/test/reference.test.ts

@@ -35,6 +35,7 @@ function makeStorage(url: string) {
   function maker(wrapper, loc) {
     return ({} as any) as Reference;
   }
+
   const authWrapper = new AuthWrapper(
     null,
     maker,
@@ -56,14 +57,14 @@ describe('Firebase Storage > Reference', () => {
       const s = makeStorage('gs://test-bucket/this/ismyobject?hello');
       assert.equal(s.toString(), 'gs://test-bucket/this/ismyobject?hello');
     });
-    it("doesn't URL-decode on a gs:// string", () => {
+    it('doesn\'t URL-decode on a gs:// string', () => {
       const s = makeStorage('gs://test-bucket/%3F');
       assert.equal(s.toString(), 'gs://test-bucket/%3F');
     });
     it('ignores URL params and fragments on an http URL', () => {
       const s = makeStorage(
         `http://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` +
-          '?ignoreme#please'
+        '?ignoreme#please'
       );
       assert.equal(s.toString(), 'gs://test-bucket/my/object.txt');
     });
@@ -77,7 +78,7 @@ describe('Firebase Storage > Reference', () => {
     it('ignores URL params and fragments on an https URL', () => {
       const s = makeStorage(
         `https://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` +
-          '?ignoreme#please'
+        '?ignoreme#please'
       );
       assert.equal(s.toString(), 'gs://test-bucket/my/object.txt');
     });
@@ -91,7 +92,7 @@ describe('Firebase Storage > Reference', () => {
   });
 
   describe('toString', () => {
-    it("Doesn't add trailing slash", () => {
+    it('Doesn\'t add trailing slash', () => {
       const s = makeStorage('gs://test-bucket/foo');
       assert.equal(s.toString(), 'gs://test-bucket/foo');
     });
@@ -176,7 +177,7 @@ describe('Firebase Storage > Reference', () => {
     });
   });
 
-  it("Doesn't send Authorization on null auth token", done => {
+  it('Doesn\'t send Authorization on null auth token', done => {
     function newSend(
       xhrio: TestingXhrIo,
       url: string,
@@ -301,7 +302,7 @@ describe('Firebase Storage > Reference', () => {
           'storage/invalid-argument'
         );
       });
-      it("doesn't throw on good metadata", () => {
+      it('doesn\'t throw on good metadata', () => {
         const goodMetadata = {
           md5Hash: 'a',
           cacheControl: 'done',
@@ -396,6 +397,15 @@ describe('Firebase Storage > Reference', () => {
       });
     });
 
+    describe('listAll', () => {
+      it('throws on number arg', () => {
+        testShared.assertThrows(
+          testShared.bind(child.listAll, child, 1),
+          'storage/invalid-argument-count'
+        );
+      });
+    });
+
     describe('list', () => {
       it('throws on invalid option', () => {
         testShared.assertThrows(
@@ -479,14 +489,14 @@ describe('Firebase Storage > Reference', () => {
   });
 
   describe('non-root operations', () => {
-    it("put doesn't throw", () => {
+    it('put doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.put(new Blob(['a']));
         child.put(new Uint8Array(10));
         child.put(new ArrayBuffer(10));
       });
     });
-    it("putString doesn't throw", () => {
+    it('putString doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.putString('raw', StringFormat.RAW);
         child.putString('aaaa', StringFormat.BASE64);
@@ -497,17 +507,22 @@ describe('Firebase Storage > Reference', () => {
         );
       });
     });
-    it("delete doesn't throw", () => {
+    it('delete doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.delete();
       });
     });
-    it("getMetadata doesn't throw", () => {
+    it('getMetadata doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.getMetadata();
       });
     });
-    it("list doesn't throw", () => {
+    it('listAll doesn\'t throw', () => {
+      assert.doesNotThrow(() => {
+        child.listAll();
+      });
+    });
+    it('list doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.list();
       });
@@ -520,13 +535,16 @@ describe('Firebase Storage > Reference', () => {
       assert.doesNotThrow(() => {
         child.list({ maxResults: 4 });
       });
+      assert.doesNotThrow(() => {
+        child.list({ maxResults: 4, pageToken: null });
+      });
     });
-    it("updateMetadata doesn't throw", () => {
+    it('updateMetadata doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.updateMetadata({} as Metadata);
       });
     });
-    it("getDownloadURL doesn't throw", () => {
+    it('getDownloadURL doesn\'t throw', () => {
       assert.doesNotThrow(() => {
         child.getDownloadURL();
       });
@@ -558,12 +576,17 @@ describe('Firebase Storage > Reference', () => {
         'storage/invalid-root-operation'
       );
     });
-    it("list doesn't throws", () => {
+    it('listAll doesn\'t throws', () => {
       assert.doesNotThrow(() => {
-        child.list();
+        root.listAll();
       });
+    });
+    it('list doesn\'t throws', () => {
       assert.doesNotThrow(() => {
-        child.list({ pageToken: 'xxx', maxResults: 4 });
+        root.list();
+      });
+      assert.doesNotThrow(() => {
+        root.list({ pageToken: 'xxx', maxResults: 4 });
       });
     });
     it('updateMetadata throws', () => {