Merge pull request #129 from tjholm/list-files

Storage: Add ability to list files in a bucket.

Author: tjholm

package.json

@@ -27,7 +27,7 @@
   ],
   "dependencies": {
     "@grpc/grpc-js": "^1.5.9",
-    "@nitric/api": "0.15.0",
+    "@nitric/api": "0.16.0",
     "google-protobuf": "3.14.0",
     "tslib": "^2.1.0"
   },

src/api/storage/v0/storage.test.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 import { FileMode, Storage } from './storage';
 import { StorageServiceClient as GrpcStorageClient } from '@nitric/api/proto/storage/v1/storage_grpc_pb';
-import { StorageWriteResponse, StorageReadResponse, StorageDeleteResponse, StoragePreSignUrlResponse, StoragePreSignUrlRequest } from '@nitric/api/proto/storage/v1/storage_pb';
+import { StorageWriteResponse, StorageReadResponse, StorageDeleteResponse, StoragePreSignUrlResponse, StoragePreSignUrlRequest, StorageListFilesResponse, File } from '@nitric/api/proto/storage/v1/storage_pb';
 import { UnimplementedError } from '../../errors';
 
 describe('Storage Client Tests', () => {
@@ -321,7 +321,7 @@ describe('Storage Client Tests', () => {
         preSignUrlMock.mockClear();
         const client = new Storage().bucket('test_bucket').file('test/item');
         signUrl = await client.getDownloadUrl()
-      })
+      });
 
       test('Then file.signUrl should delete the bytes from the bucket', () => {
         expect(signUrl).toEqual("testingUrl");
@@ -341,4 +341,75 @@ describe('Storage Client Tests', () => {
       });
     });
   });
+
+  describe('Given nitric.api.storage.StorageClient.ListFiles throws an error', () => {
+    const MOCK_ERROR = {
+      code: 2,
+      message: 'UNIMPLEMENTED',
+    };
+
+    let listFilesMock;
+
+    beforeAll(() => {
+      listFilesMock = jest
+        .spyOn(GrpcStorageClient.prototype, 'listFiles')
+        .mockImplementation((_, callback: any) => {
+          callback(MOCK_ERROR, null);
+
+          return null as any;
+        });
+    });
+
+    afterAll(() => {
+      jest.resetAllMocks();
+    });
+
+    test('Then StorageClient.listFiles should reject', async () => {
+      const client = new Storage();
+      await expect(client.bucket('test').files()).rejects.toEqual(
+        new UnimplementedError("UNIMPLEMENTED")
+      );
+    });
+
+    test('The Grpc client for Storage.listFiles should have been called exactly once', () => {
+      expect(listFilesMock).toBeCalledTimes(1);
+    });
+  });
+
+  describe('Given nitric.api.storage.StorageClient.ListFiles succeeds', () => {
+    const MOCK_REPLY = new StorageListFilesResponse();
+    MOCK_REPLY.setFilesList(["test/test.txt"].map((k) => { 
+      const f = new File();
+      f.setKey(k);
+      return f; 
+    }));
+
+    let listFilesMock;
+
+    beforeAll(() => {
+      listFilesMock = jest
+        .spyOn(GrpcStorageClient.prototype, 'listFiles')
+        .mockImplementation((_, callback: any) => {
+          callback(null, MOCK_REPLY);
+
+          return null as any;
+        });
+    });
+
+    afterAll(() => {
+      jest.resetAllMocks();
+    });
+
+    test('Then StorageClient.listFiles should return files', async () => {
+      const client = new Storage();
+      const files = await client.bucket('test').files();
+
+      expect(files).toHaveLength(1);
+      expect(files[0].name).toBe('test/test.txt')
+    });
+
+    test('The Grpc client for Storage.listFiles should have been called exactly once', () => {
+      expect(listFilesMock).toBeCalledTimes(1);
+    });
+  });
 });

src/api/storage/v0/storage.ts

@@ -18,6 +18,7 @@ import {
   StorageReadRequest,
   StorageDeleteRequest,
   StoragePreSignUrlRequest,
+  StorageListFilesRequest,
 } from '@nitric/api/proto/storage/v1/storage_pb';
 import * as grpc from '@grpc/grpc-js';
 import { fromGrpcError, InvalidArgumentError } from '../../errors';
@@ -63,6 +64,28 @@ export class Bucket {
     this.name = name;
   }
 
+  /**
+   * Retrieve a list of files on the bucket
+   * @returns An array of file references
+   */
+  public async files(): Promise<File[]> {
+    const request = new StorageListFilesRequest();
+
+    request.setBucketName(this.name);
+
+    return await new Promise<File[]>((res, rej) => {
+      this.storage.StorageServiceClient.listFiles(request, (err, data) => {
+        if (err) {
+          rej(fromGrpcError(err));
+        }
+
+        res(data.getFilesList().map(f => {
+          return new File(this.storage, this, f.getKey());
+        }));
+      });
+    });
+  }
+
   public file(name: string) {
     if (!name) {
       throw new InvalidArgumentError(

yarn.lock

@@ -531,10 +531,10 @@
     "@types/yargs" "^15.0.0"
     chalk "^4.0.0"
 
-"@nitric/api@0.15.0":
-  version "0.15.0"
-  resolved "https://registry.yarnpkg.com/@nitric/api/-/api-0.15.0.tgz#4e8825dd0fda21437b477e6c81ab2bb1f15a22e6"
-  integrity sha512-xxldlWIAZHhkrfHsueEcZ9zaoSLTSAtHlrrZaodF5bKIJigbXkI3GLhSLm1hOcFGerguUx1y8l+Pc/slPI+s6g==
+"@nitric/api@0.16.0":
+  version "0.16.0"
+  resolved "https://registry.yarnpkg.com/@nitric/api/-/api-0.16.0.tgz#233a1aa3cb4ef29188b5336c0e70d067e027cb26"
+  integrity sha512-dXJfPlAe/G35nSVn4IIvjB0TqWYJPyYNOqu1TdjV14vy++L7ALkabVJtKULQQ94+71okvfmO4kMHQeKsYYS/Mw==
   dependencies:
     google-protobuf "3.14.0"
     tslib "^2.1.0"