Add getBytes() to Storage v9

Author: schmidt-sebastian

packages/storage/exp/api.ts

@@ -47,7 +47,8 @@ import {
   getDownloadURL as getDownloadURLInternal,
   deleteObject as deleteObjectInternal,
   Reference,
-  _getChild as _getChildInternal
+  _getChild as _getChildInternal,
+  getBytesInternal
 } from '../src/reference';
 import { STORAGE_TYPE } from './constants';
 import { getModularInstance } from '@firebase/util';
@@ -62,6 +63,19 @@ export { UploadTask as _UploadTask } from '../src/task';
 export type { Reference as _Reference } from '../src/reference';
 export { FbsBlob as _FbsBlob } from '../src/implementation/blob';
 
+/**
+ * Download's the data at the object's location. Returns an error if the object
+ * is not found.
+ *
+ * @public
+ * @param ref - StorageReference where data should be download.
+ * @returns A Promise containing the object's bytes
+ */
+export function getBytes(ref: StorageReference): Promise<ArrayBuffer> {
+  ref = getModularInstance(ref);
+  return getBytesInternal(ref as Reference);
+}
+
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.

packages/storage/src/implementation/connection.ts

@@ -40,6 +40,8 @@ export interface Connection {
 
   getResponseText(): string;
 
+  getResponseData(): ArrayBuffer;
+
   /**
    * Abort the request.
    */

packages/storage/src/implementation/request.ts

@@ -28,7 +28,7 @@ import {
   canceled,
   retryLimitExceeded
 } from './error';
-import { RequestInfo } from './requestinfo';
+import {RequestHandler, RequestInfo} from './requestinfo';
 import { isJustDef } from './type';
 import { makeQueryString } from './url';
 import { Headers, Connection, ErrorCode } from './connection';
@@ -61,7 +61,7 @@ class NetworkRequest<T> implements Request<T> {
   private reject_!: (reason?: any) => void;
   private canceled_: boolean = false;
   private appDelete_: boolean = false;
-  private callback_: (p1: Connection, p2: string) => T;
+  private callback_: RequestHandler<T>;
   private errorCallback_:
     | ((p1: Connection, p2: FirebaseStorageError) => FirebaseStorageError)
     | null;
@@ -77,7 +77,7 @@ class NetworkRequest<T> implements Request<T> {
     body: string | Blob | Uint8Array | null,
     successCodes: number[],
     additionalRetryCodes: number[],
-    callback: (p1: Connection, p2: string) => T,
+    callback: RequestHandler<T>,
     errorCallback:
       | ((p1: Connection, p2: FirebaseStorageError) => FirebaseStorageError)
       | null,
@@ -169,7 +169,8 @@ class NetworkRequest<T> implements Request<T> {
         try {
           const result = self.callback_(
             connection,
-            connection.getResponseText()
+            connection.getResponseText(),
+            connection.getResponseData()
           );
           if (isJustDef(result)) {
             resolve(result);

packages/storage/src/implementation/requestinfo.ts

@@ -24,6 +24,8 @@ export interface UrlParams {
   [name: string]: string | number;
 }
 
+export type RequestHandler<T> = (connection: Connection, responseText: string, responseData:ArrayBuffer)=>T;
+
 export class RequestInfo<T> {
   urlParams: UrlParams = {};
   headers: Headers = {};
@@ -51,7 +53,7 @@ export class RequestInfo<T> {
      * Note: The XhrIo passed to this function may be reused after this callback
      * returns. Do not keep a reference to it in any way.
      */
-    public handler: (p1: Connection, p2: string) => T,
-    public timeout: number
+    public handler: RequestHandler<T>,
+    public timeout: number,
   ) {}
 }

packages/storage/src/implementation/requests.ts

@@ -41,7 +41,7 @@ import {
   toResourceString
 } from './metadata';
 import { fromResponseString } from './list';
-import { RequestInfo, UrlParams } from './requestinfo';
+import {RequestHandler, RequestInfo, UrlParams} from './requestinfo';
 import { isString } from './type';
 import { makeUrl } from './url';
 import { Connection } from './connection';
@@ -206,6 +206,28 @@ export function list(
   return requestInfo;
 }
 
+export function getBytes(
+  service: FirebaseStorageImpl,
+  location: Location
+): RequestInfo<ArrayBuffer> {
+  const urlPart = location.fullServerUrl();
+  const url = makeUrl(urlPart, service.host) + '?alt=media';
+  const method = 'GET';
+  const timeout = service.maxOperationRetryTime;
+  const requestInfo = new RequestInfo(
+    url,
+    method,
+    getBytesHandler(),
+    timeout
+  );
+  requestInfo.errorHandler = objectErrorHandler(location);
+  return requestInfo;
+}
+
+export function getBytesHandler(): RequestHandler<ArrayBuffer> {
+  return (xhr: Connection,_: string, data: ArrayBuffer) => data;
+}
+
 export function getDownloadUrl(
   service: FirebaseStorageImpl,
   location: Location,

packages/storage/src/platform/browser/connection.ts

@@ -113,6 +113,16 @@ export class XhrConnection implements Connection {
     return this.xhr_.responseText;
   }
 
+  /**
+   * @override
+   */
+  getResponseData(): ArrayBuffer {
+    if (!this.sent_) {
+      throw internalError('cannot .getResponseData() before sending');
+    }
+    return this.xhr_.response;
+  }
+
   /**
    * Aborts the request.
    * @override

packages/storage/src/platform/node/connection.ts

@@ -31,7 +31,7 @@ const fetch: typeof window.fetch = nodeFetch as any;
 export class FetchConnection implements Connection {
   private errorCode_: ErrorCode;
   private statusCode_: number | undefined;
-  private body_: string | undefined;
+  private body_: ArrayBuffer | undefined;
   private headers_: Headers | undefined;
   private sent_: boolean = false;
 
@@ -58,7 +58,7 @@ export class FetchConnection implements Connection {
       .then(resp => {
         this.headers_ = resp.headers;
         this.statusCode_ = resp.status;
-        return resp.text();
+        return resp.arrayBuffer();
       })
       .then(body => {
         this.body_ = body;
@@ -85,6 +85,15 @@ export class FetchConnection implements Connection {
         'cannot .getResponseText() before receiving response'
       );
     }
+    return new TextDecoder().decode(this.body_);
+  }
+
+  getResponseData(): ArrayBuffer {
+    if (this.body_ === undefined) {
+      throw internalError(
+        'cannot .getResponseData() before receiving response'
+      );
+    }
     return this.body_;
   }
 

packages/storage/src/reference.ts

@@ -29,7 +29,8 @@ import {
   updateMetadata as requestsUpdateMetadata,
   getDownloadUrl as requestsGetDownloadUrl,
   deleteObject as requestsDeleteObject,
-  multipartUpload
+  multipartUpload,
+  getBytes
 } from './implementation/requests';
 import { ListOptions } from '../exp/public-types';
 import { StringFormat, dataFromString } from './implementation/string';
@@ -143,6 +144,18 @@ export class Reference {
   }
 }
 
+/**
+ * Download the bytes at the object's location.
+ * @returns A Promise containing the downloaded bytes.
+ */
+export function getBytesInternal(ref: Reference): Promise<ArrayBuffer> {
+  ref._throwIfRoot('getBytes');
+  const requestInfo = getBytes(ref.storage, ref._location);
+  return ref.storage
+    .makeRequestWithTokens(requestInfo)
+    .then(request => request.getPromise());
+}
+
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.

packages/storage/test/integration/integration.exp.test.ts

@@ -29,7 +29,8 @@ import {
   deleteObject,
   getMetadata,
   updateMetadata,
-  listAll
+  listAll,
+  getBytes
 } from '../../exp/index';
 
 import { use, expect } from 'chai';
@@ -71,6 +72,27 @@ describe('FirebaseStorage Exp', () => {
     expect(snap.metadata.timeCreated).to.exist;
   });
 
+  it('can get bytes', async () => {
+    const reference = ref(storage, 'public/exp-bytes');
+    await uploadBytes(reference, new Uint8Array([0, 1, 3, 128, 255]));
+    const bytes = await getBytes(reference);
+    expect(new Uint8Array(bytes)).to.deep.equal(new Uint8Array([0, 1, 3, 128, 255]));
+  });
+
+  it('getBytes() throws for missing file', async () => {
+    const reference = ref(storage, 'public/exp-bytes-missing');
+    try {
+      await getBytes(reference, );
+      expect.fail();
+    } catch (e) {
+      expect(e.message).to.satisfy((v: string) =>
+        v.match(
+          /Object 'public\/exp-bytes-missing' does not exist/
+        )
+      );
+    }
+  });
+
   it('can upload bytes (resumable)', async () => {
     const reference = ref(storage, 'public/exp-bytesresumable');
     const snap = await uploadBytesResumable(

packages/storage/test/unit/connection.ts

@@ -45,6 +45,7 @@ export class TestingConnection implements Connection {
   private sendHook: SendHook | null;
   private status: number;
   private responseText: string;
+  private responseData: ArrayBuffer;
   private headers: Headers;
   private errorCode: ErrorCode;
 
@@ -56,6 +57,7 @@ export class TestingConnection implements Connection {
     this.sendHook = sendHook;
     this.status = -1;
     this.responseText = '';
+    this.responseData = new Uint8Array();
     this.headers = {};
     this.errorCode = ErrorCode.NO_ERROR;
   }
@@ -83,7 +85,7 @@ export class TestingConnection implements Connection {
 
   simulateResponse(
     status: number,
-    body: string,
+    body: string|Uint8Array,
     headers: { [key: string]: string }
   ): void {
     if (this.state !== State.SENT) {
@@ -94,7 +96,8 @@ export class TestingConnection implements Connection {
     }
 
     this.status = status;
-    this.responseText = body;
+    this.responseText = typeof body === 'string'?body:'';
+    this.responseData = typeof body === 'string'?new Uint8Array():body;
     this.headers = {};
     for (const [key, value] of Object.entries(headers)) {
       this.headers[key.toLowerCase()] = value.toString();
@@ -117,6 +120,10 @@ export class TestingConnection implements Connection {
     return this.responseText;
   }
 
+  getResponseData(): ArrayBuffer {
+    return this.responseData;
+  }
+
   abort(): void {
     this.state = State.START;
     this.errorCode = ErrorCode.NO_ERROR;