Merge branch 'master' into ys/webdriver-strict

Author: yuchenshi

.changeset/clever-apricots-look.md

@@ -0,0 +1,10 @@
+---
+"@firebase/component": minor
+"@firebase/database": patch
+"@firebase/firestore": patch
+"@firebase/functions": patch
+"@firebase/remote-config": patch
+"@firebase/storage": patch
+---
+
+Component facotry now takes an options object. And added `Provider.initialize()` that can be used to pass an options object to the component factory.

.changeset/config.json

@@ -24,6 +24,7 @@
     "@firebase/installations-compat",
     "@firebase/messaging-exp",
     "@firebase/performance-exp",
+    "@firebase/performance-compat",
     "@firebase/remote-config-exp",
     "@firebase/remote-config-compat",
     "firebase-exp",

packages-exp/analytics-compat/src/index.ts

@@ -41,16 +41,13 @@ declare module '@firebase/component' {
 }
 
 const factory: InstanceFactory<'analytics-compat'> = (
-  container: ComponentContainer,
-  regionOrCustomDomain?: string
+  container: ComponentContainer
 ) => {
   // Dependencies
   const app = container.getProvider('app-compat').getImmediate();
   const analyticsServiceExp = container
     .getProvider('analytics-exp')
-    .getImmediate({
-      identifier: regionOrCustomDomain
-    });
+    .getImmediate();
 
   return new AnalyticsService(app as FirebaseApp, analyticsServiceExp);
 };

packages-exp/app-compat/src/index.ts

@@ -47,4 +47,4 @@ registerCoreComponents();
 export default firebase;
 
 export { _FirebaseNamespace, _FirebaseService } from './types';
-export { FirebaseApp } from './public-types';
+export { FirebaseApp, FirebaseNamespace } from './public-types';

packages-exp/auth-compat-exp/index.ts

@@ -24,6 +24,7 @@ import {
   InstantiationMode
 } from '@firebase/component';
 
+import { FirebaseAuth } from '@firebase/auth-types';
 import { version } from './package.json';
 import { Auth } from './src/auth';
 import { Persistence } from './src/persistence';
@@ -33,6 +34,23 @@ import { RecaptchaVerifier } from './src/recaptcha_verifier';
 
 const AUTH_TYPE = 'auth';
 
+declare module '@firebase/component' {
+  interface NameServiceMapping {
+    'auth-compat': FirebaseAuth;
+  }
+}
+
+declare module '@firebase/app-compat' {
+  interface FirebaseNamespace {
+    auth: {
+      (app?: FirebaseApp): FirebaseAuth;
+    };
+  }
+  interface FirebaseApp {
+    auth?(): FirebaseAuth;
+  }
+}
+
 // Create auth components to register with firebase.
 // Provides Auth public APIs.
 function registerAuthCompat(instance: _FirebaseNamespace): void {

packages-exp/auth-exp/src/core/auth/initialize.ts

@@ -34,8 +34,7 @@ export function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth {
     _fail(auth, AuthErrorCode.ALREADY_INITIALIZED);
   }
 
-  const auth = provider.getImmediate() as AuthImpl;
-  _initializeAuthInstance(auth, deps);
+  const auth = provider.initialize({ options: deps }) as AuthImpl;
 
   return auth;
 }

packages-exp/auth-exp/src/core/auth/register.ts

@@ -25,6 +25,8 @@ import { _assert } from '../util/assert';
 import { _getClientVersion, ClientPlatform } from '../util/version';
 import { _castAuth, AuthImpl, DefaultConfig } from './auth_impl';
 import { AuthInterop } from './firebase_internal';
+import { Dependencies } from '../../model/auth';
+import { _initializeAuthInstance } from './initialize';
 
 export const enum _ComponentName {
   AUTH = 'auth-exp',
@@ -53,7 +55,7 @@ export function registerAuth(clientPlatform: ClientPlatform): void {
   _registerComponent(
     new Component(
       _ComponentName.AUTH,
-      container => {
+      (container, { options: deps }: { options?: Dependencies }) => {
         const app = container.getProvider('app-exp').getImmediate()!;
         const { apiKey, authDomain } = app.options;
         return (app => {
@@ -66,7 +68,11 @@ export function registerAuth(clientPlatform: ClientPlatform): void {
             apiScheme: DefaultConfig.API_SCHEME,
             sdkClientVersion: _getClientVersion(clientPlatform)
           };
-          return new AuthImpl(app, config);
+
+          const authInstance = new AuthImpl(app, config);
+          _initializeAuthInstance(authInstance, deps);
+
+          return authInstance;
         })(app);
       },
       ComponentType.PUBLIC

packages-exp/auth-exp/src/core/persistence/persistence_user_manager.test.ts

@@ -23,7 +23,12 @@ import * as sinonChai from 'sinon-chai';
 import { testAuth, testUser, TestAuth } from '../../../test/helpers/mock_auth';
 import { UserImpl } from '../user/user_impl';
 import { _getInstance } from '../util/instantiator';
-import { PersistenceInternal, PersistenceType, StorageEventListener } from './';
+import {
+  PersistenceInternal,
+  PersistenceType,
+  PersistenceValue,
+  StorageEventListener
+} from './';
 import { inMemoryPersistence } from './in_memory';
 import { KeyName, PersistenceUserManager } from './persistence_user_manager';
 
@@ -64,19 +69,78 @@ describe('core/persistence/persistence_user_manager', () => {
       expect(manager.persistence).to.eq(_getInstance(inMemoryPersistence));
     });
 
-    it('searches in order for a user', async () => {
+    it('chooses the first one available', async () => {
       const a = makePersistence();
       const b = makePersistence();
       const c = makePersistence();
       const search = [a.persistence, b.persistence, c.persistence];
       const auth = await testAuth();
-      b.stub._get.returns(Promise.resolve(testUser(auth, 'uid').toJSON()));
+      a.stub._isAvailable.resolves(false);
+      a.stub._get.onFirstCall().resolves(testUser(auth, 'uid').toJSON());
+      b.stub._isAvailable.resolves(true);
 
       const out = await PersistenceUserManager.create(auth, search);
+      expect(a.stub._isAvailable).to.have.been.calledOnce;
+      expect(b.stub._isAvailable).to.have.been.calledOnce;
+      expect(c.stub._isAvailable).to.not.have.been.called;
+
+      // a should not be chosen since it is not available (despite having a user).
       expect(out.persistence).to.eq(b.persistence);
+    });
+
+    it('searches in order for a user', async () => {
+      const a = makePersistence();
+      const b = makePersistence();
+      const c = makePersistence();
+      const search = [a.persistence, b.persistence, c.persistence];
+      const auth = await testAuth();
+      const user = testUser(auth, 'uid');
+      a.stub._isAvailable.resolves(true);
+      a.stub._get.resolves(user.toJSON());
+      b.stub._get.resolves(testUser(auth, 'wrong-uid').toJSON());
+
+      const out = await PersistenceUserManager.create(auth, search);
       expect(a.stub._get).to.have.been.calledOnce;
-      expect(b.stub._get).to.have.been.calledOnce;
+      expect(b.stub._get).not.to.have.been.called;
       expect(c.stub._get).not.to.have.been.called;
+
+      expect(out.persistence).to.eq(a.persistence);
+      expect((await out.getCurrentUser())!.uid).to.eq(user.uid);
+    });
+
+    it('migrate found user to the selected persistence and clear others', async () => {
+      const a = makePersistence();
+      const b = makePersistence();
+      const c = makePersistence();
+      const search = [a.persistence, b.persistence, c.persistence];
+      const auth = await testAuth();
+      const user = testUser(auth, 'uid');
+      a.stub._isAvailable.resolves(true);
+      b.stub._get.resolves(user.toJSON());
+      c.stub._get.resolves(testUser(auth, 'wrong-uid').toJSON());
+
+      let persistedUserInA: PersistenceValue | null = null;
+      a.stub._set.callsFake(async (_, value) => {
+        persistedUserInA = value;
+      });
+      a.stub._get.callsFake(async () => persistedUserInA);
+
+      const out = await PersistenceUserManager.create(auth, search);
+      expect(a.stub._set).to.have.been.calledOnceWith(
+        'firebase:authUser:test-api-key:test-app',
+        user.toJSON()
+      );
+      expect(b.stub._set).to.not.have.been.called;
+      expect(c.stub._set).to.not.have.been.called;
+      expect(b.stub._remove).to.have.been.calledOnceWith(
+        'firebase:authUser:test-api-key:test-app'
+      );
+      expect(c.stub._remove).to.have.been.calledOnceWith(
+        'firebase:authUser:test-api-key:test-app'
+      );
+
+      expect(out.persistence).to.eq(a.persistence);
+      expect((await out.getCurrentUser())!.uid).to.eq(user.uid);
     });
 
     it('uses default user key if none provided', async () => {
@@ -99,13 +163,17 @@ describe('core/persistence/persistence_user_manager', () => {
       );
     });
 
-    it('returns zeroth persistence if all else fails', async () => {
+    it('returns in-memory persistence if all else fails', async () => {
       const a = makePersistence();
       const b = makePersistence();
       const c = makePersistence();
       const search = [a.persistence, b.persistence, c.persistence];
+      a.stub._isAvailable.resolves(false);
+      b.stub._isAvailable.resolves(false);
+      c.stub._isAvailable.resolves(false);
+
       const out = await PersistenceUserManager.create(auth, search);
-      expect(out.persistence).to.eq(a.persistence);
+      expect(out.persistence).to.eq(_getInstance(inMemoryPersistence));
       expect(a.stub._get).to.have.been.calledOnce;
       expect(b.stub._get).to.have.been.calledOnce;
       expect(c.stub._get).to.have.been.called;
@@ -118,6 +186,7 @@ describe('core/persistence/persistence_user_manager', () => {
 
     beforeEach(async () => {
       const { persistence, stub } = makePersistence(PersistenceType.SESSION);
+      stub._isAvailable.resolves(true);
       persistenceStub = stub;
       manager = await PersistenceUserManager.create(auth, [persistence]);
     });

packages-exp/functions-exp/src/config.ts

@@ -30,7 +30,7 @@ export const DEFAULT_REGION = 'us-central1';
 export function registerFunctions(fetchImpl: typeof fetch): void {
   const factory: InstanceFactory<'functions'> = (
     container: ComponentContainer,
-    regionOrCustomDomain?: string
+    { instanceIdentifier: regionOrCustomDomain }
   ) => {
     // Dependencies
     const app = container.getProvider('app-exp').getImmediate();

packages-exp/performance-compat/.eslintrc.js

@@ -0,0 +1,26 @@
+/**
+ * @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.
+ */
+
+module.exports = {
+  extends: '../../config/.eslintrc.js',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  }
+};

packages-exp/performance-compat/README.md

@@ -0,0 +1,5 @@
+# @firebase/performance-compat
+
+This is the compat package that recreates the  v8 APIs.
+
+**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**

packages-exp/performance-compat/karma.conf.js

@@ -0,0 +1,35 @@
+/**
+ * @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.
+ */
+
+const karmaBase = require('../../config/karma.base');
+
+const files = ['test/**/*', 'src/**/*.test.ts'];
+
+module.exports = function (config) {
+  const karmaConfig = Object.assign({}, karmaBase, {
+    // files to load into karma
+    files: files,
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    preprocessors: { '**/*.ts': ['webpack', 'sourcemap'] },
+    frameworks: ['mocha']
+  });
+
+  config.set(karmaConfig);
+};
+
+module.exports.files = files;

packages-exp/performance-compat/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@firebase/performance-compat",
+  "version": "0.0.900",
+  "description": "The compatibility package of Firebase Performance",
+  "author": "Firebase <[email protected]> (https://firebase.google.com/)",
+  "private": true,
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm5.js",
+  "module": "dist/index.esm5.js",
+  "esm2017": "dist/index.esm2017.js",
+  "files": ["dist"],
+  "scripts": {
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts'  --ignore-path '../../.gitignore'",
+    "build": "rollup -c",
+    "build:release": "rollup -c rollup.config.release.js",
+    "build:deps": "lerna run --scope @firebase/performance-compat --include-dependencies build",
+    "dev": "rollup -c -w",
+    "test": "run-p lint test:all",
+    "test:all": "run-p test:browser",
+    "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all",
+    "test:browser": "karma start --single-run",
+    "test:browser:debug": "karma start --browsers Chrome --auto-watch",
+    "prettier": "prettier --write '{src,test}/**/*.{js,ts}'"
+  },
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "@firebase/app-compat": "0.x",
+    "@firebase/app-types": "0.x"
+  },
+  "dependencies": {
+    "@firebase/performance-exp": "0.0.900", 
+    "@firebase/util": "0.4.0",
+    "@firebase/logger": "0.2.6",
+    "@firebase/component": "0.2.1",
+    "tslib": "^2.0.0"
+  },
+  "devDependencies": {
+    "rollup": "2.35.1",
+    "@rollup/plugin-json": "4.1.0",
+    "rollup-plugin-replace": "2.2.0",
+    "rollup-plugin-typescript2": "0.29.0",
+    "typescript": "4.2.2",
+    "@firebase/app-compat": "0.0.900"
+  },
+  "repository": {
+    "directory": "packages-exp/performance-compat",
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "typings": "dist/src/index.d.ts",
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "reportDir": "./coverage/node"
+  }
+}