Clean up our to/from JSON implementations

- Remove anonymous credential/provider since they're not exposed and
don't do anything
- rename toPlainObject on User to toJSON per API spec
- relax restrictions around ProviderId & SignInMethod typing since they
 can sometimes have values outside of our enum

Author: avolkovi

packages-exp/auth-exp/src/api/account_management/account.ts

@@ -36,8 +36,8 @@ export async function deleteAccount(
 }
 
 export interface ProviderUserInfo {
+  providerId: string;
   rawId?: string;
-  providerId?: string;
   email?: string;
   displayName?: string;
   photoUrl?: string;

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

@@ -16,7 +16,6 @@
  */
 
 import { FirebaseApp } from '@firebase/app-types-exp';
-import * as externs from '@firebase/auth-types-exp';
 import { FirebaseError } from '@firebase/util';
 import { expect, use } from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
@@ -30,6 +29,7 @@ import { _getInstance } from '../util/instantiator';
 import * as navigator from '../util/navigator';
 import { ClientPlatform } from '../util/version';
 import { _castAuth, _initializeAuthForClientPlatform } from './auth_impl';
+import { Auth } from '../../model/auth';
 
 use(sinonChai);
 use(chaiAsPromised);
@@ -46,14 +46,16 @@ const FAKE_APP: FirebaseApp = {
 const initializeAuth = _initializeAuthForClientPlatform(ClientPlatform.BROWSER);
 
 describe('core/auth/auth_impl', () => {
-  let auth: externs.Auth;
+  let auth: Auth;
   let persistenceStub: sinon.SinonStubbedInstance<Persistence>;
 
   beforeEach(() => {
     persistenceStub = sinon.stub(_getInstance(inMemoryPersistence));
-    auth = initializeAuth(FAKE_APP, {
-      persistence: inMemoryPersistence
-    });
+    auth = _castAuth(
+      initializeAuth(FAKE_APP, {
+        persistence: inMemoryPersistence
+      })
+    );
   });
 
   afterEach(sinon.restore);
@@ -81,7 +83,7 @@ describe('core/auth/auth_impl', () => {
       for (let i = 0; i < 10; i++) {
         expect(persistenceStub.set.getCall(i)).to.have.been.calledWith(
           sinon.match.any,
-          users[i].toPlainObject()
+          users[i].toJSON()
         );
       }
     });
@@ -126,28 +128,28 @@ describe('core/auth/auth_impl', () => {
 
     it('immediately calls authStateChange if initialization finished', done => {
       const user = testUser(auth, 'uid');
-      _castAuth(auth).currentUser = user;
-      _castAuth(auth)._isInitialized = true;
-      auth.onAuthStateChanged(user => {
+      auth.currentUser = user;
+      auth._isInitialized = true;
+      auth._onAuthStateChanged(user => {
         expect(user).to.eq(user);
         done();
       });
     });
 
     it('immediately calls idTokenChange if initialization finished', done => {
       const user = testUser(auth, 'uid');
-      _castAuth(auth).currentUser = user;
-      _castAuth(auth)._isInitialized = true;
-      auth.onIdTokenChanged(user => {
+      auth.currentUser = user;
+      auth._isInitialized = true;
+      auth._onIdTokenChanged(user => {
         expect(user).to.eq(user);
         done();
       });
     });
 
     it('immediate callback is done async', () => {
-      _castAuth(auth)._isInitialized = true;
+      auth._isInitialized = true;
       let callbackCalled = false;
-      auth.onIdTokenChanged(() => {
+      auth._onIdTokenChanged(() => {
         callbackCalled = true;
       });
 
@@ -167,8 +169,8 @@ describe('core/auth/auth_impl', () => {
 
       context('initially currentUser is null', () => {
         beforeEach(async () => {
-          auth.onAuthStateChanged(authStateCallback);
-          auth.onIdTokenChanged(idTokenCallback);
+          auth._onAuthStateChanged(authStateCallback);
+          auth._onIdTokenChanged(idTokenCallback);
           await auth.updateCurrentUser(null);
           authStateCallback.resetHistory();
           idTokenCallback.resetHistory();
@@ -187,8 +189,8 @@ describe('core/auth/auth_impl', () => {
 
       context('initially currentUser is user', () => {
         beforeEach(async () => {
-          auth.onAuthStateChanged(authStateCallback);
-          auth.onIdTokenChanged(idTokenCallback);
+          auth._onAuthStateChanged(authStateCallback);
+          auth._onIdTokenChanged(idTokenCallback);
           await auth.updateCurrentUser(user);
           authStateCallback.resetHistory();
           idTokenCallback.resetHistory();
@@ -226,8 +228,8 @@ describe('core/auth/auth_impl', () => {
       it('onAuthStateChange works for multiple listeners', async () => {
         const cb1 = sinon.spy();
         const cb2 = sinon.spy();
-        auth.onAuthStateChanged(cb1);
-        auth.onAuthStateChanged(cb2);
+        auth._onAuthStateChanged(cb1);
+        auth._onAuthStateChanged(cb2);
         await auth.updateCurrentUser(null);
         cb1.resetHistory();
         cb2.resetHistory();
@@ -240,8 +242,8 @@ describe('core/auth/auth_impl', () => {
       it('onIdTokenChange works for multiple listeners', async () => {
         const cb1 = sinon.spy();
         const cb2 = sinon.spy();
-        auth.onIdTokenChanged(cb1);
-        auth.onIdTokenChanged(cb2);
+        auth._onIdTokenChanged(cb1);
+        auth._onIdTokenChanged(cb2);
         await auth.updateCurrentUser(null);
         cb1.resetHistory();
         cb2.resetHistory();

packages-exp/auth-exp/src/core/credentials/anonymous.test.ts

@@ -20,9 +20,26 @@ import * as externs from '@firebase/auth-types-exp';
 import { PhoneOrOauthTokenResponse } from '../../api/authentication/mfa';
 import { AuthCore } from '../../model/auth';
 import { IdTokenResponse } from '../../model/id_token';
+import { EmailAuthCredential } from './email';
+import { PhoneAuthCredential } from './phone';
+import { OAuthCredential } from './oauth';
 
 export abstract class AuthCredential extends externs.AuthCredential {
-  static fromJSON(json: object | string): AuthCredential | null;
+  static fromJSON(json: object | string): AuthCredential | null {
+    // const obj = (typeof json === 'string') ? JSON.parse(json) : json;
+    for (const initializer of [
+      /* SAMLAuthCredential.fromJSON, */
+      OAuthCredential.fromJSON,
+      EmailAuthCredential.fromJSON,
+      PhoneAuthCredential.fromJSON
+    ]) {
+      const credential = initializer(json);
+      if (credential) {
+        return credential;
+      }
+    }
+    return null;
+  }
 
   _getIdTokenResponse(auth: AuthCore): Promise<PhoneOrOauthTokenResponse>;
   _linkToIdToken(auth: AuthCore, idToken: string): Promise<IdTokenResponse>;

packages-exp/auth-exp/src/core/credentials/anonymous.ts

@@ -45,8 +45,8 @@ export interface OAuthCredentialParams {
   pendingToken?: string;
 
   // Utilities
-  providerId: externs.ProviderId;
-  signInMethod: externs.SignInMethod;
+  providerId: string;
+  signInMethod: string;
 }
 
 export class OAuthCredential
@@ -58,8 +58,8 @@ export class OAuthCredential
   private pendingToken: string | null = null;
 
   private constructor(
-    readonly providerId: externs.ProviderId,
-    readonly signInMethod: externs.SignInMethod
+    readonly providerId: string,
+    readonly signInMethod: string
   ) {}
 
   static _fromParams(params: OAuthCredentialParams): OAuthCredential {
@@ -106,7 +106,8 @@ export class OAuthCredential
     };
   }
 
-  static fromJSON(obj: object): externs.OAuthCredential | null {
+  static fromJSON(json: string | object): externs.OAuthCredential | null {
+    const obj = typeof json === 'string' ? JSON.parse(json) : json;
     const { providerId, signInMethod, ...rest }: Partial<OAuthCredential> = obj;
     if (!providerId || !signInMethod) {
       return null;

packages-exp/auth-exp/src/core/credentials/index.d.ts

@@ -17,7 +17,7 @@
 
 import { expect } from 'chai';
 
-import { testUser } from '../../../test/helpers/mock_auth';
+import { testUser, testAuth } from '../../../test/helpers/mock_auth';
 import { _getInstance } from '../util/instantiator';
 import { Persistence, PersistenceType } from './';
 import { inMemoryPersistence } from './in_memory';
@@ -38,11 +38,12 @@ describe('core/persistence/in_memory', () => {
 
   it('should work with user', async () => {
     const key = 'my-super-special-user';
-    const value = testUser({}, 'uid');
+    const auth = await testAuth();
+    const value = testUser(auth, 'uid');
 
     expect(await persistence.get(key)).to.be.null;
-    await persistence.set(key, value.toPlainObject());
-    expect(await persistence.get(key)).to.eql(value.toPlainObject());
+    await persistence.set(key, value.toJSON());
+    expect(await persistence.get(key)).to.eql(value.toJSON());
     expect(await persistence.get('other-key')).to.be.null;
     await persistence.remove(key);
     expect(await persistence.get(key)).to.be.null;

packages-exp/auth-exp/src/core/credentials/oauth.ts

@@ -21,9 +21,7 @@ export enum PersistenceType {
   NONE = 'NONE'
 }
 
-export interface PersistedBlob {
-  [key: string]: unknown;
-}
+export type PersistedBlob = Record<string, unknown>;
 
 export interface Instantiator<T> {
   (blob: PersistedBlob): T;