Add getBytes() (#5672)

Author: schmidt-sebastian

.changeset/clever-eggs-relate.md

@@ -0,0 +1,6 @@
+---
+"@firebase/storage": minor
+"firebase": minor
+---
+
+Adds `getBytes()`, `getStream()` and `getBlob()`, which allow direct file downloads from the SDK.

common/api-review/storage.api.md

@@ -77,14 +77,15 @@ export class _FirebaseStorageImpl implements FirebaseStorage {
     _getAuthToken(): Promise<string | null>;
     get host(): string;
     set host(host: string);
+    // Warning: (ae-forgotten-export) The symbol "ConnectionType" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "RequestInfo" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "Connection" needs to be exported by the entry point index.d.ts
     // Warning: (ae-forgotten-export) The symbol "Request" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
-    _makeRequest<T>(requestInfo: RequestInfo_2<T>, requestFactory: () => Connection, authToken: string | null, appCheckToken: string | null): Request_2<T>;
+    _makeRequest<I extends ConnectionType, O>(requestInfo: RequestInfo_2<I, O>, requestFactory: () => Connection<I>, authToken: string | null, appCheckToken: string | null): Request_2<O>;
     // (undocumented)
-    makeRequestWithTokens<T>(requestInfo: RequestInfo_2<T>, requestFactory: () => Connection): Promise<T>;
+    makeRequestWithTokens<I extends ConnectionType, O>(requestInfo: RequestInfo_2<I, O>, requestFactory: () => Connection<I>): Promise<O>;
     _makeStorageReference(loc: _Location): _Reference;
     get maxOperationRetryTime(): number;
     set maxOperationRetryTime(time: number);
@@ -112,6 +113,12 @@ export interface FullMetadata extends UploadMetadata {
     updated: string;
 }
 
+// @public
+export function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;
+
+// @public
+export function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;
+
 // @internal (undocumented)
 export function _getChild(ref: StorageReference, childPath: string): _Reference;
 
@@ -124,6 +131,9 @@ export function getMetadata(ref: StorageReference): Promise<FullMetadata>;
 // @public
 export function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
 
+// @public
+export function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): NodeJS.ReadableStream;
+
 // Warning: (ae-forgotten-export) The symbol "StorageError" needs to be exported by the entry point index.d.ts
 //
 // @internal (undocumented)

packages/storage/.run/All Tests.run.xml

@@ -11,9 +11,9 @@
       <env name="TS_NODE_CACHE" value="NO" />
     </envs>
     <ui>bdd</ui>
-    <extra-mocha-options>--require ts-node/register/type-check --require index.node.ts</extra-mocha-options>
+    <extra-mocha-options>--require ts-node/register/type-check --require src/index.node.ts</extra-mocha-options>
     <test-kind>PATTERN</test-kind>
     <test-pattern>test/{,!(browser)/**/}*.test.ts</test-pattern>
     <method v="2" />
   </configuration>
-</component>
+</component>

packages/storage/src/api.browser.ts

@@ -16,6 +16,8 @@
  */
 
 import { StorageReference } from './public-types';
+import { Reference, getBlobInternal } from './reference';
+import { getModularInstance } from '@firebase/util';
 
 /**
  * Downloads the data at the object's location. Returns an error if the object
@@ -28,17 +30,17 @@ import { StorageReference } from './public-types';
  * This API is not available in Node.
  *
  * @public
- * @param ref - StorageReference where data should be download.
+ * @param ref - StorageReference where data should be downloaded.
  * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
  * retrieve.
  * @returns A Promise that resolves with a Blob containing the object's bytes
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function getBlob(
+export function getBlob(
   ref: StorageReference,
   maxDownloadSizeBytes?: number
 ): Promise<Blob> {
-  throw new Error('Not implemented');
+  ref = getModularInstance(ref);
+  return getBlobInternal(ref as Reference, maxDownloadSizeBytes);
 }
 
 /**
@@ -48,19 +50,14 @@ function getBlob(
  * This API is only available in Node.
  *
  * @public
- * @param ref - StorageReference where data should be download.
+ * @param ref - StorageReference where data should be downloaded.
  * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
  * retrieve.
  * @returns A stream with the object's data as bytes
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function getStream(
+export function getStream(
   ref: StorageReference,
   maxDownloadSizeBytes?: number
 ): NodeJS.ReadableStream {
   throw new Error('getStream() is only supported by NodeJS builds');
 }
-
-// TODO(getbytes): Export getBlob/getStream
-
-export {};

packages/storage/src/api.node.ts

@@ -16,6 +16,8 @@
  */
 
 import { StorageReference } from './public-types';
+import { Reference, getStreamInternal } from './reference';
+import { getModularInstance } from '@firebase/util';
 
 /**
  * Downloads the data at the object's location. Returns an error if the object
@@ -28,13 +30,13 @@ import { StorageReference } from './public-types';
  * This API is not available in Node.
  *
  * @public
- * @param ref - StorageReference where data should be download.
+ * @param ref - StorageReference where data should be downloaded.
  * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
  * retrieve.
  * @returns A Promise that resolves with a Blob containing the object's bytes
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-function getBlob(
+export function getBlob(
   ref: StorageReference,
   maxDownloadSizeBytes?: number
 ): Promise<Blob> {
@@ -48,19 +50,15 @@ function getBlob(
  * This API is only available in Node.
  *
  * @public
- * @param ref - StorageReference where data should be download.
+ * @param ref - StorageReference where data should be downloaded.
  * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
  * retrieve.
  * @returns A stream with the object's data as bytes
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function getStream(
+export function getStream(
   ref: StorageReference,
   maxDownloadSizeBytes?: number
 ): NodeJS.ReadableStream {
-  throw new Error('Not implemented');
+  ref = getModularInstance(ref);
+  return getStreamInternal(ref as Reference, maxDownloadSizeBytes);
 }
-
-// TODO(getbytes): Export getBlob/getStream
-
-export {};

packages/storage/src/api.ts

@@ -47,7 +47,8 @@ import {
   getDownloadURL as getDownloadURLInternal,
   deleteObject as deleteObjectInternal,
   Reference,
-  _getChild as _getChildInternal
+  _getChild as _getChildInternal,
+  getBytesInternal
 } from './reference';
 import { STORAGE_TYPE } from './constants';
 import { EmulatorMockTokenOptions, getModularInstance } from '@firebase/util';
@@ -76,6 +77,28 @@ export {
 } from './implementation/taskenums';
 export { StringFormat };
 
+/**
+ * Downloads the data at the object's location. Returns an error if the object
+ * is not found.
+ *
+ * To use this functionality, you have to whitelist your app's origin in your
+ * Cloud Storage bucket. See also
+ * https://cloud.google.com/storage/docs/configuring-cors
+ *
+ * @public
+ * @param ref - StorageReference where data should be downloaded.
+ * @param maxDownloadSizeBytes - If set, the maximum allowed size in bytes to
+ * retrieve.
+ * @returns A Promise containing the object's bytes
+ */
+export function getBytes(
+  ref: StorageReference,
+  maxDownloadSizeBytes?: number
+): Promise<ArrayBuffer> {
+  ref = getModularInstance(ref);
+  return getBytesInternal(ref as Reference, maxDownloadSizeBytes);
+}
+
 /**
  * Uploads data to this object's location.
  * The upload is not resumable.

packages/storage/src/implementation/connection.ts

@@ -18,14 +18,27 @@
 /** Network headers */
 export type Headers = Record<string, string>;
 
+/** Response type exposed by the networking APIs. */
+export type ConnectionType =
+  | string
+  | ArrayBuffer
+  | Blob
+  | NodeJS.ReadableStream;
+
 /**
  * A lightweight wrapper around XMLHttpRequest with a
  * goog.net.XhrIo-like interface.
+ *
+ * You can create a new connection by invoking `newTextConnection()`,
+ * `newBytesConnection()` or `newStreamConnection()`.
  */
-export interface Connection {
+export interface Connection<T extends ConnectionType> {
   /**
-   * This method should never reject. In case of encountering an error, set an error code internally which can be accessed
-   * by calling getErrorCode() by callers.
+   * Sends a request to the provided URL.
+   *
+   * This method never rejects its promise. In case of encountering an error,
+   * it sets an error code internally which can be accessed by calling
+   * getErrorCode() by callers.
    */
   send(
     url: string,
@@ -38,7 +51,9 @@ export interface Connection {
 
   getStatus(): number;
 
-  getResponseText(): string;
+  getResponse(): T;
+
+  getErrorText(): string;
 
   /**
    * Abort the request.

packages/storage/src/implementation/request.ts

@@ -20,18 +20,12 @@
  * abstract representations.
  */
 
-import { start, stop, id as backoffId } from './backoff';
-import {
-  StorageError,
-  unknown,
-  appDeleted,
-  canceled,
-  retryLimitExceeded
-} from './error';
-import { RequestHandler, RequestInfo } from './requestinfo';
+import { id as backoffId, start, stop } from './backoff';
+import { appDeleted, canceled, retryLimitExceeded, unknown } from './error';
+import { ErrorHandler, RequestHandler, RequestInfo } from './requestinfo';
 import { isJustDef } from './type';
 import { makeQueryString } from './url';
-import { Headers, Connection, ErrorCode } from './connection';
+import { Connection, ErrorCode, Headers, ConnectionType } from './connection';
 
 export interface Request<T> {
   getPromise(): Promise<T>;
@@ -46,15 +40,23 @@ export interface Request<T> {
   cancel(appDelete?: boolean): void;
 }
 
-class NetworkRequest<T> implements Request<T> {
-  private pendingConnection_: Connection | null = null;
+/**
+ * Handles network logic for all Storage Requests, including error reporting and
+ * retries with backoff.
+ *
+ * @param I - the type of the backend's network response.
+ * @param - O the output type used by the rest of the SDK. The conversion
+ * happens in the specified `callback_`.
+ */
+class NetworkRequest<I extends ConnectionType, O> implements Request<O> {
+  private pendingConnection_: Connection<I> | null = null;
   private backoffId_: backoffId | null = null;
-  private resolve_!: (value?: T | PromiseLike<T>) => void;
+  private resolve_!: (value?: O | PromiseLike<O>) => void;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   private reject_!: (reason?: any) => void;
   private canceled_: boolean = false;
   private appDelete_: boolean = false;
-  promise_: Promise<T>;
+  private promise_: Promise<O>;
 
   constructor(
     private url_: string,
@@ -63,14 +65,14 @@ class NetworkRequest<T> implements Request<T> {
     private body_: string | Blob | Uint8Array | null,
     private successCodes_: number[],
     private additionalRetryCodes_: number[],
-    private callback_: RequestHandler<string, T>,
-    private errorCallback_: RequestHandler<StorageError, StorageError> | null,
+    private callback_: RequestHandler<I, O>,
+    private errorCallback_: ErrorHandler | null,
     private timeout_: number,
     private progressCallback_: ((p1: number, p2: number) => void) | null,
-    private connectionFactory_: () => Connection
+    private connectionFactory_: () => Connection<I>
   ) {
     this.promise_ = new Promise((resolve, reject) => {
-      this.resolve_ = resolve as (value?: T | PromiseLike<T>) => void;
+      this.resolve_ = resolve as (value?: O | PromiseLike<O>) => void;
       this.reject_ = reject;
       this.start_();
     });
@@ -135,17 +137,14 @@ class NetworkRequest<T> implements Request<T> {
      */
     const backoffDone: (
       requestWentThrough: boolean,
-      status: RequestEndStatus
+      status: RequestEndStatus<I>
     ) => void = (requestWentThrough, status) => {
       const resolve = this.resolve_;
       const reject = this.reject_;
-      const connection = status.connection as Connection;
+      const connection = status.connection as Connection<I>;
       if (status.wasSuccessCode) {
         try {
-          const result = this.callback_(
-            connection,
-            connection.getResponseText()
-          );
+          const result = this.callback_(connection, connection.getResponse());
           if (isJustDef(result)) {
             resolve(result);
           } else {
@@ -157,7 +156,7 @@ class NetworkRequest<T> implements Request<T> {
       } else {
         if (connection !== null) {
           const err = unknown();
-          err.serverResponse = connection.getResponseText();
+          err.serverResponse = connection.getErrorText();
           if (this.errorCallback_) {
             reject(this.errorCallback_(connection, err));
           } else {
@@ -182,7 +181,7 @@ class NetworkRequest<T> implements Request<T> {
   }
 
   /** @inheritDoc */
-  getPromise(): Promise<T> {
+  getPromise(): Promise<O> {
     return this.promise_;
   }
 
@@ -219,15 +218,15 @@ class NetworkRequest<T> implements Request<T> {
  * A collection of information about the result of a network request.
  * @param opt_canceled - Defaults to false.
  */
-export class RequestEndStatus {
+export class RequestEndStatus<I extends ConnectionType> {
   /**
    * True if the request was canceled.
    */
   canceled: boolean;
 
   constructor(
     public wasSuccessCode: boolean,
-    public connection: Connection | null,
+    public connection: Connection<I> | null,
     canceled?: boolean
   ) {
     this.canceled = !!canceled;
@@ -266,22 +265,22 @@ export function addAppCheckHeader_(
   }
 }
 
-export function makeRequest<T>(
-  requestInfo: RequestInfo<T>,
+export function makeRequest<I extends ConnectionType, O>(
+  requestInfo: RequestInfo<I, O>,
   appId: string | null,
   authToken: string | null,
   appCheckToken: string | null,
-  requestFactory: () => Connection,
+  requestFactory: () => Connection<I>,
   firebaseVersion?: string
-): Request<T> {
+): Request<O> {
   const queryPart = makeQueryString(requestInfo.urlParams);
   const url = requestInfo.url + queryPart;
   const headers = Object.assign({}, requestInfo.headers);
   addGmpidHeader_(headers, appId);
   addAuthHeader_(headers, authToken);
   addVersionHeader_(headers, firebaseVersion);
   addAppCheckHeader_(headers, appCheckToken);
-  return new NetworkRequest<T>(
+  return new NetworkRequest<I, O>(
     url,
     requestInfo.method,
     headers,