Profile management

Author: sam-gc

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

@@ -203,13 +203,13 @@ describe('core/auth/auth_impl', () => {
         });
 
         it('onAuthStateChange does not trigger for user props change', async () => {
-          user.refreshToken = 'hey look I changed';
+          user.photoURL = 'blah';
           await auth.updateCurrentUser(user);
           expect(authStateCallback).not.to.have.been.called;
         });
 
         it('onIdTokenChange triggers for user props change', async () => {
-          user.refreshToken = 'hey look I changed';
+          user.photoURL = 'hey look I changed';
           await auth.updateCurrentUser(user);
           expect(idTokenCallback).to.have.been.calledWith(user);
         });

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

@@ -122,6 +122,12 @@ export class AuthImpl implements Auth {
     );
   }
 
+  async _persistAndNotifyIfCurrent(user: User): Promise<void> {
+    if (user === this.currentUser) {
+      return this.updateCurrentUser(user);
+    }
+  }
+
   _notifyStateListeners(): void {
     if (!this._isInitialized) {
       return;

packages-exp/auth-exp/src/core/user/account_info.test.ts

@@ -0,0 +1,131 @@
+/**
+ * @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 { expect, use } from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import * as sinon from 'sinon';
+import * as sinonChai from 'sinon-chai';
+
+import { UserInfo } from '@firebase/auth-types-exp';
+
+// import { UserInfo } from '@firebase/auth-types-exp';
+import { mockEndpoint } from '../../../test/api/helper';
+import { testUser } from '../../../test/mock_auth';
+import * as fetch from '../../../test/mock_fetch';
+import { Endpoint } from '../../api';
+import { User } from '../../model/user';
+import { ProviderId } from '../providers';
+// import { ProviderId } from '../providers';
+import { updateProfile } from './account_info';
+
+use(chaiAsPromised);
+use(sinonChai);
+
+const PASSWORD_PROVIDER: UserInfo = {
+  providerId: ProviderId.PASSWORD,
+  uid: 'uid',
+  email: 'email',
+  displayName: 'old-name',
+  phoneNumber: 'phone-number',
+  photoURL: 'old-url'
+};
+
+describe('core/user/profile', () => {
+  let user: User;
+
+  beforeEach(() => {
+    user = testUser('uid', '', true);
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  beforeEach(fetch.setUp);
+  afterEach(fetch.tearDown);
+
+  it('returns immediately if profile object is empty', async () => {
+    const ep = mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {});
+    await updateProfile(user, {});
+    expect(ep.calls).to.be.empty;
+  });
+
+  it('calls the setAccountInfo endpoint', async () => {
+    const ep =mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {});
+
+    await updateProfile(user, {displayName: 'displayname', photoURL: 'photo'});
+    expect(ep.calls[0].request).to.eql({
+      idToken: 'access-token',
+      displayName: 'displayname',
+      photoUrl: 'photo',
+    });
+  });
+
+  it('sets the fields on the user based on the response', async () => {
+    mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {
+      displayName: 'response-name',
+      photoUrl: 'response-photo',
+    });
+
+    await updateProfile(user, {displayName: 'displayname', photoURL: 'photo'});
+    expect(user.displayName).to.eq('response-name');
+    expect(user.photoURL).to.eq('response-photo');
+  });
+
+  it('sets the fields on the passwd provider', async () => {
+    mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {
+      displayName: 'response-name',
+      photoUrl: 'response-photo',
+    });
+    user.providerData = [{...PASSWORD_PROVIDER}];
+
+    await updateProfile(user, {displayName: 'displayname', photoURL: 'photo'});
+    const provider = user.providerData[0];
+    expect(provider.displayName).to.eq('response-name');
+    expect(provider.photoURL).to.eq('response-photo');
+  });
+
+  describe('notifications', () => {
+    beforeEach(() => {
+      user.auth.currentUser = user;
+    });
+
+    it('triggers a token update if necessary', async () => {
+      mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {
+        idToken: 'new-id-token',
+        refreshToken: 'new-refresh-token',
+        expiresIn: 300,
+      });
+
+      const notifySpy = sinon.stub(user.auth, '_notifyStateListeners');
+      await updateProfile(user, {displayName: 'd'});
+      expect(notifySpy).to.have.been.called;
+    });
+
+    it('does NOT trigger a token update if unnecessary', async () => {
+      mockEndpoint(Endpoint.SET_ACCOUNT_INFO, {
+        idToken: 'access-token',
+        refreshToken: 'refresh-token',
+        expiresIn: 300,
+      });
+
+      const notifySpy = sinon.stub(user.auth, '_notifyStateListeners');
+      await updateProfile(user, {displayName: 'd'});
+      expect(notifySpy).not.to.have.been.called;
+    });
+  });
+});

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

@@ -0,0 +1,67 @@
+/**
+ * @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 {
+    updateEmailPassword as apiUpdateEmailPassword
+} from '../../api/account_management/email_and_password';
+import { updateProfile as apiUpdateProfile } from '../../api/account_management/profile';
+import { User } from '../../model/user';
+import { ProviderId } from '../providers';
+import { _reloadWithoutSaving } from './reload';
+
+interface Profile {
+  displayName?: string|null;
+  photoURL?: string|null;
+}
+
+export async function updateProfile(externUser: externs.User, {displayName, photoURL: photoUrl}: Profile): Promise<void> {
+  if (displayName === undefined && photoUrl === undefined) {
+    return;
+  }
+
+  const user = externUser as User;
+  const idToken = await user.getIdToken();
+  const profileRequest = {idToken, displayName, photoUrl};
+  const response = await apiUpdateProfile(user.auth, profileRequest);
+
+  user.displayName = response.displayName || null;
+  user.photoURL = response.photoUrl || null;
+
+  // Update the password provider as well
+  const passwordProvider = user.providerData.find(p => p.providerId === ProviderId.PASSWORD);
+  if (passwordProvider) {
+    passwordProvider.displayName = user.displayName;
+    passwordProvider.photoURL = user.photoURL;
+  }
+
+  user._updateTokensIfNecessary(response);
+  return user.auth._persistAndNotifyIfCurrent(user);
+}
+
+export async function updateEmail(externUser: externs.User, newEmail: string): Promise<void> {
+  const user = externUser as User;
+  const {auth} = user;
+  const idToken = await user.getIdToken();
+  const response = await apiUpdateEmailPassword(auth, {idToken, email: newEmail});
+  user._updateTokensIfNecessary(response);
+
+  // To update 
+  await _reloadWithoutSaving(user);
+  return auth._persistAndNotifyIfCurrent(user);
+}

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

@@ -17,10 +17,7 @@
 
 import * as externs from '@firebase/auth-types-exp';
 
-import {
-  getAccountInfo,
-  ProviderUserInfo
-} from '../../api/account_management/account';
+import { getAccountInfo, ProviderUserInfo } from '../../api/account_management/account';
 import { User } from '../../model/user';
 import { ProviderId } from '../providers';
 import { assert } from '../util/assert';
@@ -61,7 +58,7 @@ export async function reload(externUser: externs.User): Promise<void> {
   // Even though the current user hasn't changed, update
   // current user will trigger a persistence update w/ the
   // new info.
-  return user.auth.updateCurrentUser(user);
+  return user.auth._persistAndNotifyIfCurrent(user);
 }
 
 function mergeProviderData(

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

@@ -19,6 +19,7 @@ import { IdTokenResult } from '@firebase/auth-types-exp';
 
 import { deleteAccount } from '../../api/account_management/account';
 import { Auth } from '../../model/auth';
+import { IdTokenResponse } from '../../model/id_token';
 import { User } from '../../model/user';
 import { PersistedBlob } from '../persistence';
 import { ProviderId } from '../providers';
@@ -52,7 +53,6 @@ export class UserImpl implements User {
   // For the user object, provider is always Firebase.
   readonly providerId = ProviderId.FIREBASE;
   stsTokenManager: StsTokenManager;
-  refreshToken = '';
 
   uid: string;
   auth: Auth;
@@ -82,11 +82,10 @@ export class UserImpl implements User {
     const tokens = await this.stsTokenManager.getToken(this.auth, forceRefresh);
     assert(tokens, this.auth.name);
 
-    const { refreshToken, accessToken, wasRefreshed } = tokens;
-    this.refreshToken = refreshToken || '';
+    const { accessToken, wasRefreshed } = tokens;
 
-    if (wasRefreshed && this.auth.currentUser === this) {
-      this.auth._notifyStateListeners();
+    if (wasRefreshed) {
+      await this.auth._persistAndNotifyIfCurrent(this);
     }
 
     return accessToken;
@@ -100,6 +99,12 @@ export class UserImpl implements User {
     return reload(this);
   }
 
+  _updateTokensIfNecessary(response: IdTokenResponse): void {
+    if (response.idToken && response.idToken !== this.stsTokenManager.accessToken) {
+      this.stsTokenManager.updateFromServerResponse(response);
+    }
+  }
+
   async delete(): Promise<void> {
     const idToken = await this.getIdToken();
     await deleteAccount(this.auth, { idToken });
@@ -122,6 +127,10 @@ export class UserImpl implements User {
     };
   }
 
+  get refreshToken(): string {
+    return this.stsTokenManager.refreshToken || '';
+  }
+
   static fromPlainObject(auth: Auth, object: PersistedBlob): User {
     const {
       uid,

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

@@ -46,6 +46,7 @@ export interface Auth extends externs.Auth {
     completed?: CompleteFn
   ): Unsubscribe;
   _notifyStateListeners(): void;
+  _persistAndNotifyIfCurrent(user: User): Promise<void>;
 }
 
 export interface Dependencies {

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

@@ -20,6 +20,11 @@ import * as externs from '@firebase/auth-types-exp';
 import { PersistedBlob } from '../core/persistence';
 import { ProviderId } from '../core/providers';
 import { Auth } from './auth';
+import { IdTokenResponse } from './id_token';
+
+type ModifiableUserInfo = {
+  -readonly [K in keyof externs.UserInfo]: externs.UserInfo[K];
+};
 
 export interface User extends externs.User {
   uid: string;
@@ -33,8 +38,9 @@ export interface User extends externs.User {
   refreshToken: string;
   emailVerified: boolean;
   tenantId: string | null;
-  providerData: externs.UserInfo[];
+  providerData: ModifiableUserInfo[];
   metadata: externs.UserMetadata;
+  _updateTokensIfNecessary(response: IdTokenResponse): void;
 
   getIdToken(forceRefresh?: boolean): Promise<string>;
   getIdTokenResult(forceRefresh?: boolean): Promise<externs.IdTokenResult>;

packages-exp/auth-types-exp/index.d.ts

@@ -153,4 +153,4 @@ type ActionCodeOperationType =
  | 'EMAIL_SIGNIN'
  | 'VERIFY_EMAIL'
  | 'VERIFY_AND_CHANGE_EMAIL'
- | 'REVERT_SECOND_FACTOR_ADDITION'
+ | 'REVERT_SECOND_FACTOR_ADDITION';