getAccountByFederatedId -> getAccountByProviderId

src/auth/auth.ts

@@ -201,20 +201,29 @@ export class BaseAuth<T extends AbstractAuthRequestHandler> {
   }
 
   /**
-   * Gets the user data for the user corresponding to a given federated id.
+   * Gets the user data for the user corresponding to a given provider id.
    *
    * See [Retrieve user data](/docs/auth/admin/manage-users#retrieve_user_data)
    * for code samples and detailed documentation.
    *
-   * @param federatedId The provider ID, for example, "google.com" for the
+   * @param providerId The provider ID, for example, "google.com" for the
    *   Google provider.
-   * @param federatedUid The user identifier for the given provider.
+   * @param providerUid The user identifier for the given provider.
    *
    * @return A promise fulfilled with the user data corresponding to the
-   *   provided federated id.
-   */
-  public getUserByFederatedId(federatedId: string, federatedUid: string): Promise<UserRecord> {
-    return this.authRequestHandler.getAccountInfoByFederatedId(federatedId, federatedUid)
+   *   given provider id.
+   */
+  public getUserByProviderId(providerId: string, providerUid: string): Promise<UserRecord> {
+    // Although we don't really advertise it, we want to also handle
+    // non-federated idps with this call. So if we detect one of them, we'll
+    // reroute this request appropriately.
+    if (providerId === 'phone') {
+      return this.getUserByPhoneNumber(providerUid);
+    } else if (providerId === 'email') {
+      return this.getUserByEmail(providerUid);
+    }
+
+    return this.authRequestHandler.getAccountInfoByFederatedId(providerId, providerUid)
       .then((response: any) => {
         // Returns the user record populated with server response.
         return new UserRecord(response.users[0]);

src/index.d.ts

@@ -1531,19 +1531,19 @@ declare namespace admin.auth {
     getUserByPhoneNumber(phoneNumber: string): Promise<admin.auth.UserRecord>;
 
     /**
-     * Gets the user data for the user corresponding to a given federated id.
+     * Gets the user data for the user corresponding to a given provider id.
      *
      * See [Retrieve user data](/docs/auth/admin/manage-users#retrieve_user_data)
      * for code samples and detailed documentation.
      *
-     * @param federatedId The provider ID, for example, "google.com" for the
+     * @param providerId The provider ID, for example, "google.com" for the
      *   Google provider.
-     * @param federatedUid The user identifier for the given provider.
+     * @param providerUid The user identifier for the given provider.
      *
      * @return A promise fulfilled with the user data corresponding to the
-     *   provided federated id.
+     *   given provider id.
      */
-    getUserByFederatedId(federatedId: string, federatedUid: string): Promise<admin.auth.UserRecord>;
+    getUserByProviderId(providerId: string, providerUid: string): Promise<admin.auth.UserRecord>;
 
     /**
      * Retrieves a list of users (single batch only) with a size of `maxResults`

test/integration/auth.spec.ts

@@ -169,7 +169,7 @@ describe('admin.auth', () => {
       });
   });
 
-  it('getUserByFederatedId() returns a user record with the matching federated id', async () => {
+  it('getUserByProviderId() returns a user record with the matching provider id', async () => {
     // TODO(rsgowman): Once we can link a provider id with a user, just do that
     // here instead of creating a new user.
     const importUser: admin.auth.UserImportRecord = {
@@ -198,7 +198,7 @@ describe('admin.auth', () => {
     await admin.auth().importUsers([importUser]);
 
     try {
-      await admin.auth().getUserByFederatedId('google.com', 'google_uid')
+      await admin.auth().getUserByProviderId('google.com', 'google_uid')
         .then((userRecord) => {
           expect(userRecord.uid).to.equal(importUser.uid);
         });
@@ -395,8 +395,8 @@ describe('admin.auth', () => {
       .should.eventually.be.rejected.and.have.property('code', 'auth/user-not-found');
   });
 
-  it('getUserByFederatedId() fails when called with a non-existing federated id', () => {
-    return admin.auth().getUserByFederatedId('google.com', nonexistentUid)
+  it('getUserByProviderId() fails when called with a non-existing federated id', () => {
+    return admin.auth().getUserByProviderId('google.com', nonexistentUid)
       .should.eventually.be.rejected.and.have.property('code', 'auth/user-not-found');
   });
 

test/unit/auth/auth.spec.ts

@@ -1130,7 +1130,7 @@ AUTH_CONFIGS.forEach((testConfig) => {
       });
     });
 
-    describe('getUserByFederatedId()', () => {
+    describe('getUserByProviderId()', () => {
       const federatedId = 'google.com';
       const federatedUid = 'google_uid';
       const tenantId = testConfig.supportsTenantManagement ? undefined : TENANT_ID;
@@ -1148,35 +1148,35 @@ AUTH_CONFIGS.forEach((testConfig) => {
       });
 
       it('should be rejected given no federated id', () => {
-        expect(() => (auth as any).getUserByFederatedId())
+        expect(() => (auth as any).getUserByProviderId())
           .to.throw(FirebaseAuthError)
           .with.property('code', 'auth/invalid-provider-id');
       });
 
       it('should be rejected given an invalid federated id', () => {
-        expect(() => auth.getUserByFederatedId('', 'uid'))
+        expect(() => auth.getUserByProviderId('', 'uid'))
           .to.throw(FirebaseAuthError)
           .with.property('code', 'auth/invalid-provider-id');
       });
 
       it('should be rejected given an invalid federated uid', () => {
-        expect(() => auth.getUserByFederatedId('id', ''))
+        expect(() => auth.getUserByProviderId('id', ''))
           .to.throw(FirebaseAuthError)
           .with.property('code', 'auth/invalid-provider-id');
       });
 
       it('should be rejected given an app which returns null access tokens', () => {
-        return nullAccessTokenAuth.getUserByFederatedId(federatedId, federatedUid)
+        return nullAccessTokenAuth.getUserByProviderId(federatedId, federatedUid)
           .should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
       });
 
       it('should be rejected given an app which returns invalid access tokens', () => {
-        return malformedAccessTokenAuth.getUserByFederatedId(federatedId, federatedUid)
+        return malformedAccessTokenAuth.getUserByProviderId(federatedId, federatedUid)
           .should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
       });
 
       it('should be rejected given an app which fails to generate access tokens', () => {
-        return rejectedPromiseAccessTokenAuth.getUserByFederatedId(federatedId, federatedUid)
+        return rejectedPromiseAccessTokenAuth.getUserByProviderId(federatedId, federatedUid)
           .should.eventually.be.rejected.and.have.property('code', 'app/invalid-credential');
       });
 
@@ -1185,7 +1185,7 @@ AUTH_CONFIGS.forEach((testConfig) => {
         const stub = sinon.stub(testConfig.RequestHandler.prototype, 'getAccountInfoByFederatedId')
           .resolves(expectedGetAccountInfoResult);
         stubs.push(stub);
-        return auth.getUserByFederatedId(federatedId, federatedUid)
+        return auth.getUserByProviderId(federatedId, federatedUid)
           .then((userRecord) => {
             // Confirm underlying API called with expected parameters.
             expect(stub).to.have.been.calledOnce.and.calledWith(federatedId, federatedUid);
@@ -1194,12 +1194,45 @@ AUTH_CONFIGS.forEach((testConfig) => {
           });
       });
 
+      describe('non-federated providers', () => {
+        let invokeRequestHandlerStub: sinon.SinonStub;
+        beforeEach(() => {
+          invokeRequestHandlerStub = sinon.stub(testConfig.RequestHandler.prototype, 'invokeRequestHandler')
+            .resolves({
+              // nothing here is checked; we just need enough to not crash.
+              users: [{
+                localId: 1,
+              }],
+            });
+
+        });
+        afterEach(() => {
+          invokeRequestHandlerStub.restore();
+        });
+
+        it('phone lookups should use phoneNumber field', async () => {
+          await auth.getUserByProviderId('phone', '+15555550001');
+          expect(invokeRequestHandlerStub).to.have.been.calledOnce.and.calledWith(
+            sinon.match.any, sinon.match.any, {
+              phoneNumber: ['+15555550001'],
+            });
+        });
+
+        it('email lookups should use email field', async () => {
+          await auth.getUserByProviderId('email', '[email protected]');
+          expect(invokeRequestHandlerStub).to.have.been.calledOnce.and.calledWith(
+            sinon.match.any, sinon.match.any, {
+              email: ['[email protected]'],
+            });
+        });
+      });
+
       it('should throw an error when the backend returns an error', () => {
         // Stub getAccountInfoByFederatedId to throw a backend error.
         const stub = sinon.stub(testConfig.RequestHandler.prototype, 'getAccountInfoByFederatedId')
           .rejects(expectedError);
         stubs.push(stub);
-        return auth.getUserByFederatedId(federatedId, federatedUid)
+        return auth.getUserByProviderId(federatedId, federatedUid)
           .then((userRecord) => {
             throw new Error('Unexpected success');
           }, (error) => {