Add persistence events to indexed DB

Author: avolkovi

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

@@ -102,6 +102,32 @@ export class AuthImplCompat<T extends User> implements Auth {
     });
   }
 
+  /**
+   * If the persistence is changed in another window, the user manager will let us know
+   */
+  async _onStorageEvent(): Promise<void> {
+    const user = await this.persistenceManager!.getCurrentUser();
+
+    // If the same user is to be synchronized.
+    if (this.currentUser && user && this.currentUser.uid === user.uid) {
+      // Data update, simply copy data changes.
+      this.currentUser._copy(user);
+      // If tokens changed from previous user tokens, this will trigger
+      // notifyAuthListeners_.
+      await this.currentUser.getIdToken();
+      return;
+    } else if (!this.currentUser && !user) {
+      // No change, do nothing (was signed out and remained signed out).
+      return;
+    } else {
+      // Update current Auth state. Either a new login or logout.
+      await this.updateCurrentUser(user);
+      // TODO: If a new user is signed in, enabled popup and redirect on that user.
+      // Notify external Auth changes of Auth change event.
+      this.notifyAuthListeners();
+    }
+  }
+
   _createUser(params: UserParameters): T {
     return new this._userProvider(params);
   }

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

@@ -23,7 +23,7 @@ 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 { Persistence, PersistenceType } from './';
+import { Persistence, PersistenceType, StorageEventListener } from './';
 import { inMemoryPersistence } from './in_memory';
 import { PersistenceUserManager } from './persistence_user_manager';
 
@@ -42,7 +42,9 @@ function makePersistence(
     get() {
       return Promise.resolve(null);
     },
-    remove: async () => {}
+    remove: async () => {},
+    addListener(_key: string, _listener: StorageEventListener) {},
+    removeListener(_key: string, _listener: StorageEventListener) {}
   };
 
   const stub = sinon.stub(persistence);

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

@@ -17,10 +17,8 @@
 
 import { ApiKey, AppName, Auth } from '../../model/auth';
 import { User } from '../../model/user';
-import { AuthErrorCode } from '../errors';
-import { PersistedBlob, Persistence, PersistenceValue } from '../persistence';
+import { PersistedBlob, Persistence } from '../persistence';
 import { UserImpl } from '../user/user_impl';
-import { assert } from '../util/assert';
 import { _getInstance } from '../util/instantiator';
 import { inMemoryPersistence } from './in_memory';
 
@@ -37,14 +35,9 @@ function _persistenceKeyName(
   return `${PERSISTENCE_NAMESPACE}:${key}:${apiKey}:${appName}`;
 }
 
-export interface UserEventListener {
-  (): void;
-}
-
 export class PersistenceUserManager {
   private readonly fullUserKey: string;
   private readonly fullPersistenceKey: string;
-  private listener: UserEventListener | null = null;
 
   private constructor(
     public persistence: Persistence,
@@ -58,6 +51,7 @@ export class PersistenceUserManager {
       config.apiKey,
       name
     );
+    this.persistence.addListener(this.fullUserKey, auth._onStorageEvent);
   }
 
   setCurrentUser(user: User): Promise<void> {
@@ -92,27 +86,11 @@ export class PersistenceUserManager {
     }
   }
 
-  _onStorageEvent(_value: PersistenceValue | null): void {
-    assert(this.listener, AuthErrorCode.INTERNAL_ERROR, {
-      appName: this.auth.name
-    });
-    this.listener();
-  }
-
-  async addListener(listener: UserEventListener): Promise<void> {
-    assert(!this.listener, AuthErrorCode.INTERNAL_ERROR, {
-      appName: this.auth.name
-    });
-    this.listener = listener;
-    this.persistence.addListener(this.fullUserKey, this._onStorageEvent);
-  }
-
-  removeListener(listener: UserEventListener): void {
-    assert(this.listener === listener, AuthErrorCode.INTERNAL_ERROR, {
-      appName: this.auth.name
-    });
-    this.persistence.removeListener(this.fullUserKey, this._onStorageEvent);
-    this.listener = null;
+  delete(): void {
+    this.persistence.removeListener(
+      this.fullUserKey,
+      this.auth._onStorageEvent
+    );
   }
 
   static async create(

packages-exp/auth-exp/src/core/user/reload.ts

@@ -22,7 +22,7 @@ import {
   ProviderUserInfo
 } from '../../api/account_management/account';
 import { User } from '../../model/user';
-import { UserMetadata } from './user_impl';
+import { UserMetadata } from './user_metadata';
 import { assert } from '../util/assert';
 import { AuthErrorCode } from '../errors';
 

packages-exp/auth-exp/src/core/user/token_manager.ts

@@ -141,6 +141,12 @@ export class StsTokenManager {
     };
   }
 
+  _copy(stsTokenManager: StsTokenManager): void {
+    this.accessToken = stsTokenManager.accessToken;
+    this.refreshToken = stsTokenManager.refreshToken;
+    this.expirationTime = stsTokenManager.expirationTime;
+  }
+
   _performRefresh(): never {
     return debugFail('not implemented');
   }

packages-exp/auth-exp/src/core/user/user_impl.ts

@@ -17,22 +17,21 @@
 
 import * as externs from '@firebase/auth-types-exp';
 import { NextFn } from '@firebase/util';
-
 import {
   APIUserInfo,
   deleteAccount
 } from '../../api/account_management/account';
 import { FinalizeMfaResponse } from '../../api/authentication/mfa';
+import { Auth } from '../../model/auth';
 import { IdTokenResponse } from '../../model/id_token';
-import { User, UserParameters, MutableUserInfo } from '../../model/user';
+import { MutableUserInfo, User, UserParameters } from '../../model/user';
+import { AuthErrorCode } from '../errors';
 import { PersistedBlob } from '../persistence';
 import { assert } from '../util/assert';
 import { getIdTokenResult } from './id_token_result';
 import { reload, _reloadWithoutSaving } from './reload';
 import { StsTokenManager } from './token_manager';
-import { Auth } from '../../model/auth';
-import { utcTimestampToDateString } from '../util/time';
-import { AuthErrorCode } from '../errors';
+import { UserMetadata } from './user_metadata';
 
 function assertStringOrUndefined(
   assertion: unknown,
@@ -45,26 +44,6 @@ function assertStringOrUndefined(
   );
 }
 
-export class UserMetadata implements externs.UserMetadata {
-  readonly creationTime?: string;
-  readonly lastSignInTime?: string;
-
-  constructor(
-    private readonly createdAt?: string | number,
-    private readonly lastLoginAt?: string | number
-  ) {
-    this.lastSignInTime = utcTimestampToDateString(lastLoginAt);
-    this.creationTime = utcTimestampToDateString(createdAt);
-  }
-
-  toJSON(): object {
-    return {
-      createdAt: this.createdAt,
-      lastLoginAt: this.lastLoginAt
-    };
-  }
-}
-
 export class UserImpl implements User {
   // For the user object, provider is always Firebase.
   readonly providerId = externs.ProviderId.FIREBASE;
@@ -74,7 +53,7 @@ export class UserImpl implements User {
   auth: Auth;
   emailVerified = false;
   isAnonymous = false;
-  tenantId = null;
+  tenantId: string | null = null;
   readonly metadata: UserMetadata;
   providerData: MutableUserInfo[] = [];
 
@@ -123,6 +102,25 @@ export class UserImpl implements User {
   private reloadUserInfo: APIUserInfo | null = null;
   private reloadListener: NextFn<APIUserInfo> | null = null;
 
+  _copy(user: User): void {
+    if (this === user) {
+      return;
+    }
+    assert(this.uid === user.uid, AuthErrorCode.INTERNAL_ERROR, {
+      appName: this.auth.name
+    });
+    this.displayName = user.displayName;
+    this.photoURL = user.photoURL;
+    this.email = user.email;
+    this.emailVerified = user.emailVerified;
+    this.phoneNumber = user.phoneNumber;
+    this.isAnonymous = user.isAnonymous;
+    this.tenantId = user.tenantId;
+    this.providerData = user.providerData.map(userInfo => ({ ...userInfo }));
+    this.metadata._copy(user.metadata);
+    this.stsTokenManager._copy(user.stsTokenManager);
+  }
+
   _onReload(callback: NextFn<APIUserInfo>): void {
     // There should only ever be one listener, and that is a single instance of MultiFactorUser
     assert(!this.reloadListener, AuthErrorCode.INTERNAL_ERROR, {

packages-exp/auth-exp/src/core/user/user_metadata.ts

@@ -0,0 +1,50 @@
+/**
+ * @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 * as externs from '@firebase/auth-types-exp';
+
+import { utcTimestampToDateString } from '../util/time';
+
+export class UserMetadata implements externs.UserMetadata {
+  creationTime?: string;
+  lastSignInTime?: string;
+
+  constructor(
+    private createdAt?: string | number,
+    private lastLoginAt?: string | number
+  ) {
+    this._initializeTime();
+  }
+
+  private _initializeTime(): void {
+    this.lastSignInTime = utcTimestampToDateString(this.lastLoginAt);
+    this.creationTime = utcTimestampToDateString(this.createdAt);
+  }
+
+  _copy(metadata: UserMetadata): void {
+    this.createdAt = metadata.createdAt;
+    this.lastLoginAt = metadata.lastLoginAt;
+    this._initializeTime();
+  }
+
+  toJSON(): object {
+    return {
+      createdAt: this.createdAt,
+      lastLoginAt: this.lastLoginAt
+    };
+  }
+}

packages-exp/auth-exp/src/model/auth.d.ts

@@ -45,6 +45,7 @@ export interface Auth extends AuthCore {
   _isInitialized: boolean;
   updateCurrentUser(user: User | null): Promise<void>;
 
+  _onStorageEvent(): void;
   _createUser(params: UserParameters): User;
   _setPersistence(persistence: externs.Persistence): void;
   _onAuthStateChanged(

packages-exp/auth-exp/src/model/user.d.ts

@@ -24,6 +24,7 @@ import { PersistedBlob } from '../core/persistence';
 import { Auth } from './auth';
 import { IdTokenResponse, TaggedWithTokenResponse } from './id_token';
 import { StsTokenManager } from '../core/user/token_manager';
+import { UserMetadata } from '../core/user/user_metadata';
 
 type MutableUserInfo = {
   -readonly [K in keyof externs.UserInfo]: externs.UserInfo[K];
@@ -58,7 +59,7 @@ export interface User extends externs.User {
   emailVerified: boolean;
   tenantId: string | null;
   providerData: MutableUserInfo[];
-  metadata: externs.UserMetadata;
+  metadata: UserMetadata;
 
   stsTokenManager: StsTokenManager;
   _redirectEventId?: string;
@@ -68,6 +69,7 @@ export interface User extends externs.User {
     reload?: boolean
   ): Promise<void>;
 
+  _copy(user: User): void;
   _onReload: (cb: NextFn<APIUserInfo>) => void;
   _notifyReloadListener: NextFn<APIUserInfo>;
 

packages-exp/auth-exp/src/platform_browser/auth.test.ts

@@ -28,10 +28,8 @@ import { testUser, testAuth } from '../../test/helpers/mock_auth';
 import { browserPopupRedirectResolver } from './popup_redirect';
 import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../core/errors';
 import { Persistence } from '../core/persistence';
-import {
-  browserLocalPersistence,
-  browserSessionPersistence
-} from './persistence/browser';
+import { browserLocalPersistence } from './persistence/local_storage';
+import { browserSessionPersistence } from './persistence/session_storage';
 import { inMemoryPersistence } from '../core/persistence/in_memory';
 import { PersistenceUserManager } from '../core/persistence/persistence_user_manager';
 import * as reload from '../core/user/reload';