Migrate storage to component framework

Author: Feiyang1

packages/app-types/index.d.ts

@@ -102,4 +102,4 @@ export interface FirebaseNamespace {
 
   // The current SDK version.
   SDK_VERSION: string;
-}
+}

packages/app/index.ts

@@ -44,7 +44,7 @@ const initializeApp = firebaseNamespace.initializeApp;
 // TODO: This disable can be removed and the 'ignoreRestArgs' option added to
 // the no-explicit-any rule when ESlint releases it.
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-firebaseNamespace.initializeApp = function(...args: any) {
+firebaseNamespace.initializeApp = function (...args: any) {
   // Environment check before initializing app
   // Do the check in initializeApp, so people have a chance to disable it by setting logLevel
   // in @firebase/logger

packages/app/src/firebaseNamespaceCore.ts

@@ -213,7 +213,7 @@ export function createFirebaseNamespaceCore(
         // TODO: The eslint disable can be removed and the 'ignoreRestArgs'
         // option added to the no-explicit-any rule when ESlint releases it.
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        function(...args: any) {
+        function (...args: any) {
           const serviceFxn = this._getService.bind(this, componentName);
           return serviceFxn.apply(
             this,

packages/app/test/firebaseApp.test.ts

@@ -315,7 +315,7 @@ function firebaseAppTests(
 }
 
 class TestService implements FirebaseService {
-  constructor(private app_: FirebaseApp, public instanceIdentifier?: string) {}
+  constructor(private app_: FirebaseApp, public instanceIdentifier?: string) { }
 
   // TODO(koss): Shouldn't this just be an added method on
   // the service instance?
@@ -342,4 +342,4 @@ function createTestComponent(
   );
   component.setMultipleInstances(multiInstances);
   return component;
-}
+}

packages/auth/src/exports_auth.js

@@ -616,11 +616,11 @@ fireauth.exportlib.exportFunction(
     fireauth.ActionCodeURL.parseLink, [fireauth.args.string('link')]);
 
 
-(function() {
+(function () {
   if (typeof firebase === 'undefined' || !firebase.INTERNAL ||
       !firebase.INTERNAL.registerComponent) {
     throw new Error('Cannot find the firebase namespace; be sure to include ' +
-        'firebase-app.js before this library.');
+      'firebase-app.js before this library.');
   } else {
     var namespace = {
       // Exports firebase.auth.ActionCodeInfo.Operation.
@@ -637,36 +637,36 @@ fireauth.exportlib.exportFunction(
       'Error': fireauth.AuthError
     };
     fireauth.exportlib.exportFunction(namespace,
-        'EmailAuthProvider', fireauth.EmailAuthProvider, []);
+      'EmailAuthProvider', fireauth.EmailAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'FacebookAuthProvider', fireauth.FacebookAuthProvider, []);
+      'FacebookAuthProvider', fireauth.FacebookAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'GithubAuthProvider', fireauth.GithubAuthProvider, []);
+      'GithubAuthProvider', fireauth.GithubAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'GoogleAuthProvider', fireauth.GoogleAuthProvider, []);
+      'GoogleAuthProvider', fireauth.GoogleAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'TwitterAuthProvider', fireauth.TwitterAuthProvider, []);
+      'TwitterAuthProvider', fireauth.TwitterAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'OAuthProvider', fireauth.OAuthProvider, [
-          fireauth.args.string('providerId')
-        ]);
+      'OAuthProvider', fireauth.OAuthProvider, [
+      fireauth.args.string('providerId')
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'SAMLAuthProvider', fireauth.SAMLAuthProvider, [
-          fireauth.args.string('providerId')
-        ]);
+      'SAMLAuthProvider', fireauth.SAMLAuthProvider, [
+      fireauth.args.string('providerId')
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'PhoneAuthProvider', fireauth.PhoneAuthProvider, [
-          fireauth.args.firebaseAuth(true)
-        ]);
+      'PhoneAuthProvider', fireauth.PhoneAuthProvider, [
+      fireauth.args.firebaseAuth(true)
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'RecaptchaVerifier', fireauth.RecaptchaVerifier, [
-          fireauth.args.or(
-              fireauth.args.string(),
-              fireauth.args.element(),
-              'recaptchaContainer'),
-          fireauth.args.object('recaptchaParameters', true),
-          fireauth.args.firebaseApp(true)
-        ]);
+      'RecaptchaVerifier', fireauth.RecaptchaVerifier, [
+      fireauth.args.or(
+        fireauth.args.string(),
+        fireauth.args.element(),
+        'recaptchaContainer'),
+      fireauth.args.object('recaptchaParameters', true),
+      fireauth.args.firebaseApp(true)
+    ]);
     fireauth.exportlib.exportFunction(namespace,
         'ActionCodeURL', fireauth.ActionCodeURL, []);
 
@@ -709,4 +709,4 @@ fireauth.exportlib.exportFunction(
       'User': fireauth.AuthUser
     });
   }
-})();
+})();

packages/storage/index.ts

@@ -16,31 +16,36 @@
  */
 
 import firebase from '@firebase/app';
-import { FirebaseApp } from '@firebase/app-types';
-import {
-  FirebaseServiceFactory,
-  _FirebaseNamespace
-} from '@firebase/app-types/private';
+import { _FirebaseNamespace } from '@firebase/app-types/private';
 import { StringFormat } from './src/implementation/string';
 import { TaskEvent, TaskState } from './src/implementation/taskenums';
 
 import { XhrIoPool } from './src/implementation/xhriopool';
 import { Reference } from './src/reference';
 import { Service } from './src/service';
 import * as types from '@firebase/storage-types';
+import {
+  Component,
+  ComponentType,
+  ComponentContainer
+} from '@firebase/component';
 
 /**
  * Type constant for Firebase Storage.
  */
 const STORAGE_TYPE = 'storage';
 
 function factory(
-  app: FirebaseApp,
-  unused: unknown,
+  container: ComponentContainer,
   url?: string
 ): types.FirebaseStorage {
+  // Dependencies
+  const app = container.getProvider('app').getImmediate();
+  const authProvider = container.getProvider('auth-internal');
+
   return (new Service(
     app,
+    authProvider,
     new XhrIoPool(),
     url
   ) as unknown) as types.FirebaseStorage;
@@ -55,13 +60,10 @@ export function registerStorage(instance: _FirebaseNamespace): void {
     Storage: Service,
     Reference
   };
-  instance.INTERNAL.registerService(
-    STORAGE_TYPE,
-    factory as FirebaseServiceFactory,
-    namespaceExports,
-    undefined,
-    // Allow multiple storage instances per app.
-    true
+  instance.INTERNAL.registerComponent(
+    new Component(STORAGE_TYPE, factory, ComponentType.PUBLIC)
+      .setServiceProps(namespaceExports)
+      .setMultipleInstances(true)
   );
 }
 

packages/storage/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@firebase/storage-types": "0.3.5",
     "@firebase/util": "0.2.31",
+    "@firebase/component": "0.1.0",
     "tslib": "1.10.0"
   },
   "peerDependencies": {

packages/storage/src/implementation/authwrapper.ts

@@ -31,6 +31,8 @@ import {
   _FirebaseApp,
   FirebaseAuthTokenData
 } from '@firebase/app-types/private';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
 
 /**
  * @param app If null, getAuthToken always resolves with null.
@@ -40,6 +42,7 @@ import {
  */
 export class AuthWrapper {
   private app_: FirebaseApp | null;
+  private authProvider: Provider<FirebaseAuthInternal>;
   private bucket_: string | null = null;
 
   private storageRefMaker_: (p1: AuthWrapper, p2: Location) => Reference;
@@ -53,6 +56,7 @@ export class AuthWrapper {
 
   constructor(
     app: FirebaseApp | null,
+    authProvider: Provider<FirebaseAuthInternal>,
     maker: (p1: AuthWrapper, p2: Location) => Reference,
     requestMaker: requestMaker,
     service: Service,
@@ -65,6 +69,7 @@ export class AuthWrapper {
         this.bucket_ = AuthWrapper.extractBucket_(options);
       }
     }
+    this.authProvider = authProvider;
     this.storageRefMaker_ = maker;
     this.requestMaker_ = requestMaker;
     this.pool_ = pool;
@@ -84,14 +89,9 @@ export class AuthWrapper {
   }
 
   getAuthToken(): Promise<string | null> {
-    // TODO(andysoto): remove ifDef checks after firebase-app implements stubs
-    // (b/28673818).
-    if (
-      this.app_ !== null &&
-      type.isDef((this.app_ as _FirebaseApp).INTERNAL) &&
-      type.isDef((this.app_ as _FirebaseApp).INTERNAL.getToken)
-    ) {
-      return (this.app_ as _FirebaseApp).INTERNAL.getToken().then(
+    const auth = this.authProvider.getImmediate(undefined, { optional: true });
+    if (auth) {
+      return auth.getToken().then(
         (response: FirebaseAuthTokenData | null): string | null => {
           if (response !== null) {
             return response.accessToken;

packages/storage/src/service.ts

@@ -22,6 +22,8 @@ import { Location } from './implementation/location';
 import * as RequestExports from './implementation/request';
 import { XhrIoPool } from './implementation/xhriopool';
 import { Reference } from './reference';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
 
 /**
  * A service that provides firebaseStorage.Reference instances.
@@ -35,12 +37,18 @@ export class Service {
   private bucket_: Location | null = null;
   private internals_: ServiceInternals;
 
-  constructor(app: FirebaseApp, pool: XhrIoPool, url?: string) {
+  constructor(
+    app: FirebaseApp,
+    authProvider: Provider<FirebaseAuthInternal>,
+    pool: XhrIoPool,
+    url?: string
+  ) {
     function maker(authWrapper: AuthWrapper, loc: Location): Reference {
       return new Reference(authWrapper, loc);
     }
     this.authWrapper_ = new AuthWrapper(
       app,
+      authProvider,
       maker,
       RequestExports.makeRequest,
       this,

packages/storage/test/reference.test.ts

@@ -26,9 +26,16 @@ import { Service } from '../src/service';
 import * as testShared from './testshared';
 import { SendHook, TestingXhrIo } from './xhrio';
 import { DEFAULT_HOST } from '../src/implementation/constants';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
+
 /* eslint-disable @typescript-eslint/no-floating-promises */
-function makeFakeService(app: FirebaseApp, sendHook: SendHook): Service {
-  return new Service(app, testShared.makePool(sendHook));
+function makeFakeService(
+  app: FirebaseApp,
+  authProvider: Provider<FirebaseAuthInternal>,
+  sendHook: SendHook
+): Service {
+  return new Service(app, authProvider, testShared.makePool(sendHook));
 }
 
 function makeStorage(url: string): Reference {
@@ -38,6 +45,7 @@ function makeStorage(url: string): Reference {
 
   const authWrapper = new AuthWrapper(
     null,
+    testShared.emptyAuthProvider,
     maker,
     makeRequest,
     ({} as any) as Service,
@@ -190,7 +198,11 @@ describe('Firebase Storage > Reference', () => {
       done();
     }
 
-    const service = makeFakeService(testShared.fakeAppNoAuth, newSend);
+    const service = makeFakeService(
+      testShared.fakeApp,
+      testShared.emptyAuthProvider,
+      newSend
+    );
     const ref = service.refFromURL('gs://test-bucket');
     ref.child('foo').getMetadata();
   });
@@ -212,7 +224,11 @@ describe('Firebase Storage > Reference', () => {
       done();
     }
 
-    const service = makeFakeService(testShared.fakeApp, newSend);
+    const service = makeFakeService(
+      testShared.fakeApp,
+      testShared.fakeAuthProvider,
+      newSend
+    );
     const ref = service.refFromURL('gs://test-bucket');
     ref.child('foo').getMetadata();
   });

packages/storage/test/requests.test.ts

@@ -28,7 +28,11 @@ import { XhrIoPool } from '../src/implementation/xhriopool';
 import { Metadata } from '../src/metadata';
 import { Reference } from '../src/reference';
 import { Service } from '../src/service';
-import { assertObjectIncludes, fakeXhrIo } from './testshared';
+import {
+  assertObjectIncludes,
+  fakeXhrIo,
+  fakeAuthProvider
+} from './testshared';
 import {
   DEFAULT_HOST,
   CONFIG_STORAGE_BUCKET_KEY
@@ -61,6 +65,7 @@ describe('Firebase Storage > Requests', () => {
 
   const authWrapper = new AuthWrapper(
     mockApp,
+    fakeAuthProvider,
     (authWrapper, loc) => {
       return new Reference(authWrapper, loc);
     },