Merge ee67537 into 4d747b1

Author: schmidt-sebastian

common/api-review/storage.api.md

@@ -65,6 +65,12 @@ export interface FullMetadata extends UploadMetadata {
     updated: string;
 }
 
+// @public
+export function getBlob(ref: StorageReference): Promise<Blob>;
+
+// @public
+export function getBytes(ref: StorageReference): Promise<ArrayBuffer>;
+
 // @internal (undocumented)
 export function _getChild(ref: StorageReference, childPath: string): _Reference;
 

packages/storage/exp/api.browser.ts

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  StorageReference,
+} from './public-types';
+import {
+  Reference,
+  getBlobInternal
+} from '../src/reference';
+import {  getModularInstance } from '@firebase/util';
+
+/**
+ * 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 download.
+ * @returns A Promise that resolves with a Blob containing the object's bytes
+ */
+export function getBlob(ref: StorageReference): Promise<Blob> {
+  ref = getModularInstance(ref);
+  return getBlobInternal(ref as Reference);
+}
+

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 { EmulatorMockTokenOptions, getModularInstance } from '@firebase/util';
@@ -62,6 +63,23 @@ export { UploadTask as _UploadTask } from '../src/task';
 export type { Reference as _Reference } from '../src/reference';
 export { FbsBlob as _FbsBlob } from '../src/implementation/blob';
 
+/**
+ * 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 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/exp/index.node.ts

@@ -0,0 +1,76 @@
+/**
+ * Cloud Storage for Firebase
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+import {
+  _registerComponent,
+  registerVersion,
+  SDK_VERSION
+} from '@firebase/app-exp';
+
+import { FirebaseStorageImpl } from '../src/service';
+import {
+  Component,
+  ComponentType,
+  ComponentContainer,
+  InstanceFactoryOptions
+} from '@firebase/component';
+
+import { name, version } from '../package.json';
+
+import { FirebaseStorage } from './public-types';
+import { STORAGE_TYPE } from './constants';
+
+export { StringFormat } from '../src/implementation/string';
+export * from './api';
+
+function factory(
+  container: ComponentContainer,
+  { instanceIdentifier: url }: InstanceFactoryOptions
+): FirebaseStorage {
+  const app = container.getProvider('app-exp').getImmediate();
+  const authProvider = container.getProvider('auth-internal');
+  const appCheckProvider = container.getProvider('app-check-internal');
+
+  return new FirebaseStorageImpl(
+    app,
+    authProvider,
+    appCheckProvider,
+    url,
+    SDK_VERSION
+  );
+}
+
+function registerStorage(): void {
+  _registerComponent(
+    new Component(
+      STORAGE_TYPE,
+      factory,
+      ComponentType.PUBLIC
+    ).setMultipleInstances(true)
+  );
+
+  registerVersion(name, version);
+}
+
+registerStorage();

packages/storage/exp/index.ts

@@ -27,7 +27,6 @@ import {
   SDK_VERSION
 } from '@firebase/app-exp';
 
-import { ConnectionPool } from '../src/implementation/connectionPool';
 import { FirebaseStorageImpl } from '../src/service';
 import {
   Component,
@@ -43,6 +42,7 @@ import { STORAGE_TYPE } from './constants';
 
 export { StringFormat } from '../src/implementation/string';
 export * from './api';
+export * from './api.browser';
 
 function factory(
   container: ComponentContainer,
@@ -56,7 +56,6 @@ function factory(
     app,
     authProvider,
     appCheckProvider,
-    new ConnectionPool(),
     url,
     SDK_VERSION
   );

packages/storage/index.ts

@@ -20,7 +20,6 @@ import { _FirebaseNamespace } from '@firebase/app-types/private';
 import { StringFormat } from './src/implementation/string';
 import { TaskEvent, TaskState } from './src/implementation/taskenums';
 
-import { ConnectionPool } from './src/implementation/connectionPool';
 import { ReferenceCompat } from './compat/reference';
 import { StorageServiceCompat } from './compat/service';
 import { FirebaseStorageImpl } from './src/service';
@@ -59,7 +58,6 @@ function factory(
       app,
       authProvider,
       appCheckProvider,
-      new ConnectionPool(),
       url,
       firebase.SDK_VERSION
     )

packages/storage/karma.conf.js

@@ -44,7 +44,7 @@ function getTestFiles(argv) {
     );
     integrationTestFiles = ['test/integration/*compat*'];
   } else {
-    integrationTestFiles = ['test/integration/*'];
+    integrationTestFiles = ['test/integration/*', 'test/browser/*'];
   }
   if (argv.unit) {
     return unitTestFiles;

packages/storage/rollup.config.exp.js

@@ -76,7 +76,7 @@ const es2017Plugins = [
 const es2017Builds = [
   // Node
   {
-    input: './exp/index.ts',
+    input: './exp/index.node.ts',
     output: {
       file: path.resolve('./exp', pkgExp.main),
       format: 'cjs',

packages/storage/src/implementation/connection.ts

@@ -15,18 +15,18 @@
  * limitations under the License.
  */
 
-/**
- * Network headers
- */
-export interface Headers {
-  [name: string]: string;
-}
+/** Network headers */
+export type Headers = Record<string, string>;
 
 /**
  * A lightweight wrapper around XMLHttpRequest with a
  * goog.net.XhrIo-like interface.
+ *
+ * ResponseType is generally either `string` or `ArrayBuffer`. You can create
+ * a new connection by invoking `newTextConnection()` or
+ * `newBytesConnection()`.
  */
-export interface Connection {
+export interface Connection<ResponseType> {
   send(
     url: string,
     method: string,
@@ -38,6 +38,8 @@ export interface Connection {
 
   getStatus(): number;
 
+  getResponse(): ResponseType;
+
   getResponseText(): string;
 
   /**