Merge pull request #28 from FleekHQ/feature/ch21234/add-progress-call…

…-to-open-file

Feature: Add progress callback to openFile and openFileByUuid

etc/sdk.api.md

@@ -230,6 +230,7 @@ export interface OpenFileRequest {
     bucket: string;
     // (undocumented)
     path: string;
+    progress?: (bytesRead?: number) => void;
 }
 
 // @public (undocumented)
@@ -241,6 +242,13 @@ export interface OpenFileResponse {
     stream: AsyncIterableIterator<Uint8Array>;
 }
 
+// @public (undocumented)
+export interface OpenUuidFileRequest {
+    progress?: (bytesRead?: number) => void;
+    // (undocumented)
+    uuid: string;
+}
+
 // @public (undocumented)
 export interface OpenUuidFileResponse {
     consumeStream: () => Promise<Uint8Array>;
@@ -361,7 +369,7 @@ export class UserStorage {
     initListener(): Promise<void>;
     listDirectory(request: ListDirectoryRequest): Promise<ListDirectoryResponse>;
     openFile(request: OpenFileRequest): Promise<OpenFileResponse>;
-    openFileByUuid(uuid: string): Promise<OpenUuidFileResponse>;
+    openFileByUuid(request: OpenUuidFileRequest): Promise<OpenUuidFileResponse>;
     txlSubscribe(): Promise<TxlSubscribeResponse>;
     }
 

integration_tests/storage_interactions.spec.ts

@@ -210,7 +210,7 @@ describe('Users storing data', () => {
     expect(file?.bucket).to.not.be.empty;
     expect(file?.dbId).to.not.be.empty;
 
-    const fileResponse = await storage.openFileByUuid(file?.uuid || '');
+    const fileResponse = await storage.openFileByUuid({ uuid: file?.uuid || '' });
     expect(fileResponse?.entry?.bucket).to.not.be.empty;
     expect(fileResponse?.entry?.dbId).to.not.be.empty;
     expect(fileResponse.entry.name).to.equal('top.txt');
@@ -221,7 +221,7 @@ describe('Users storing data', () => {
     const { user: unauthorizedUser } = await authenticateAnonymousUser();
     const unauthorizedStorage = new UserStorage(unauthorizedUser);
 
-    await expect(unauthorizedStorage.openFileByUuid(file?.uuid || ''))
+    await expect(unauthorizedStorage.openFileByUuid({ uuid: file?.uuid || '' }))
       .to.eventually.be.rejectedWith(FileNotFoundError);
   }).timeout(TestsDefaultTimeout);
 

packages/storage/src/types.ts

@@ -63,6 +63,22 @@ export interface ListDirectoryResponse {
 export interface OpenFileRequest {
   path: string;
   bucket: string;
+  /**
+   * progress callback if provided will be called with bytes read from
+   * remote while opening the file.
+   *
+   */
+  progress?: (bytesRead?: number) => void;
+}
+
+export interface OpenUuidFileRequest {
+  uuid: string;
+  /**
+   * progress callback if provided will be called with bytes read from
+   * remote while opening the file.
+   *
+   */
+  progress?: (bytesRead?: number) => void;
 }
 
 export interface OpenFileResponse {

packages/storage/src/userStorage.spec.ts

@@ -200,7 +200,7 @@ describe('UserStorage', () => {
 
     it('should throw if file is not found', async () => {
       const { storage, mockBuckets } = initStubbedStorage();
-      when(mockBuckets.pullPath('myBucketKey', '/file.txt')).thenThrow(
+      when(mockBuckets.pullPath('myBucketKey', '/file.txt', anything())).thenThrow(
         new Error('Error: no link named "file.txt" under QmVQWu2C3ZgdoAmBsffFASrgynAfgvYX8CCK4o9SxRvC4p'),
       );
 
@@ -212,7 +212,7 @@ describe('UserStorage', () => {
     it('should return a valid stream of files data', async () => {
       const { storage, mockBuckets } = initStubbedStorage();
       const actualFileContent = "file.txt's file content";
-      when(mockBuckets.pullPath('myBucketKey', '/file.txt')).thenReturn(
+      when(mockBuckets.pullPath('myBucketKey', '/file.txt', anything())).thenReturn(
         makeAsyncIterableString(actualFileContent) as AsyncIterableIterator<Uint8Array>,
       );
 
@@ -253,11 +253,11 @@ describe('UserStorage', () => {
         },
       });
 
-      when(mockBuckets.pullPath('myBucketKey', anyString())).thenReturn(
+      when(mockBuckets.pullPath('myBucketKey', anyString(), anything())).thenReturn(
         makeAsyncIterableString(actualFileContent) as AsyncIterableIterator<Uint8Array>,
       );
 
-      const result = await storage.openFileByUuid(fileUuid);
+      const result = await storage.openFileByUuid({ uuid: fileUuid });
       const filesData = await result.consumeStream();
 
       expect(new TextDecoder('utf8').decode(filesData)).to.equal(actualFileContent);

packages/storage/src/userStorage.ts

@@ -10,7 +10,8 @@ import { DirEntryNotFoundError, FileNotFoundError, UnauthenticatedError } from '
 import { Listener } from './listener/listener';
 import { GundbMetadataStore } from './metadata/gundbMetadataStore';
 import { BucketMetadata, FileMetadata, UserMetadataStore } from './metadata/metadataStore';
-import { AddItemsRequest,
+import {
+  AddItemsRequest,
   AddItemsResponse,
   AddItemsResultSummary,
   AddItemsStatus,
@@ -19,10 +20,12 @@ import { AddItemsRequest,
   FileMember,
   ListDirectoryRequest,
   ListDirectoryResponse,
+  OpenUuidFileRequest,
   OpenFileRequest,
   OpenFileResponse,
   OpenUuidFileResponse,
-  TxlSubscribeResponse } from './types';
+  TxlSubscribeResponse,
+} from './types';
 import { filePathFromIpfsPath,
   getParentPath,
   isTopLevelPath,
@@ -271,7 +274,7 @@ export class UserStorage {
     const fileMetadata = await metadataStore.findFileMetadata(bucket.slug, bucket.dbId, path);
 
     try {
-      const fileData = client.pullPath(bucket.root?.key || '', path);
+      const fileData = client.pullPath(bucket.root?.key || '', path, { progress: request.progress });
       return {
         stream: fileData,
         consumeStream: () => consumeStream(fileData),
@@ -296,7 +299,9 @@ export class UserStorage {
    * ```typescript
    * const spaceStorage = new UserStorage(spaceUser);
    *
-   * const response = await spaceStorage.openFileByUuid('file-uu-id');
+   * const response = await spaceStorage.openFileByUuid({
+   *    uuid: 'file-uu-id',
+   * });
    * const filename = response.entry.name;
    *
    * // response.stream is an async iterable
@@ -308,12 +313,11 @@ export class UserStorage {
    * const fileBytes = await response.consumeStream();
    *```
    *
-   * @param uuid - Uuid of file to be open
    */
-  public async openFileByUuid(uuid: string): Promise<OpenUuidFileResponse> {
+  public async openFileByUuid(request: OpenUuidFileRequest): Promise<OpenUuidFileResponse> {
     const metadataStore = await this.getMetadataStore();
     const client = this.getUserBucketsClient();
-    const fileMetadata = await metadataStore.findFileMetadataByUuid(uuid);
+    const fileMetadata = await metadataStore.findFileMetadataByUuid(request.uuid);
     if (!fileMetadata) {
       throw new FileNotFoundError();
     }
@@ -326,9 +330,14 @@ export class UserStorage {
     try {
       // fetch entry information
       const existingFile = await client.listPath(existingRoot.key, fileMetadata.path);
-      const [fileEntry] = UserStorage.parsePathItems([existingFile.item!], { [fileMetadata.path]: fileMetadata }, fileMetadata.bucketSlug, fileMetadata.dbId);
-
-      const fileData = client.pullPath(existingRoot.key, fileMetadata.path);
+      const [fileEntry] = UserStorage.parsePathItems(
+        [existingFile.item!],
+        { [fileMetadata.path]: fileMetadata },
+        fileMetadata.bucketSlug,
+        fileMetadata.dbId,
+      );
+
+      const fileData = client.pullPath(existingRoot.key, fileMetadata.path, { progress: request.progress });
       return {
         stream: fileData,
         consumeStream: () => consumeStream(fileData),