fix: Renaming service functions to getAuth and getInstanceId (#1142)

Author: hiranya911

etc/firebase-admin.api.md

@@ -84,7 +84,7 @@ export class Auth extends BaseAuth {
     }
 
 // @public
-export function auth(app?: App): Auth;
+export function auth(app?: App): auth.Auth;
 
 // @public (undocumented)
 export namespace auth {
@@ -400,6 +400,12 @@ export function getApp(name?: string): App;
 // @public (undocumented)
 export function getApps(): App[];
 
+// @public (undocumented)
+export function getAuth(app?: App): Auth;
+
+// @public (undocumented)
+export function getInstanceId(app?: App): InstanceId;
+
 // @public
 export interface GetUsersResult {
     notFound: UserIdentifier[];
@@ -427,7 +433,7 @@ export class InstanceId {
     }
 
 // @public
-export function instanceId(app?: App): InstanceId;
+export function instanceId(app?: App): instanceId.InstanceId;
 
 // @public (undocumented)
 export namespace instanceId {

src/app/firebase-app.ts

@@ -277,7 +277,7 @@ export class FirebaseApp implements app.App {
    * @return The Auth service instance of this app.
    */
   public auth(): Auth {
-    const fn = require('../auth/index').auth;
+    const fn = require('../auth/index').getAuth;
     return fn(this);
   }
 
@@ -332,7 +332,7 @@ export class FirebaseApp implements app.App {
    * @return The InstanceId service instance of this app.
    */
   public instanceId(): InstanceId {
-    const fn = require('../instance-id/index').instanceId;
+    const fn = require('../instance-id/index').getInstanceId;
     return fn(this);
   }
 

src/auth/auth-namespace.ts

@@ -95,6 +95,15 @@ import {
   UserRecord as TUserRecord,
 } from './user-record';
 
+export function getAuth(app?: App): Auth {
+  if (typeof app === 'undefined') {
+    app = getApp();
+  }
+
+  const firebaseApp: FirebaseApp = app as FirebaseApp;
+  return firebaseApp.getOrInitService('auth', (app) => new Auth(app));
+}
+
 /**
  * Gets the {@link auth.Auth `Auth`} service for the default app or a
  * given app.
@@ -116,14 +125,7 @@ import {
  * ```
  *
  */
-export function auth(app?: App): Auth {
-  if (typeof app === 'undefined') {
-    app = getApp();
-  }
-
-  const firebaseApp: FirebaseApp = app as FirebaseApp;
-  return firebaseApp.getOrInitService('auth', (app) => new Auth(app));
-}
+export declare function auth(app?: App): auth.Auth;
 
 /* eslint-disable @typescript-eslint/no-namespace */
 export namespace auth {

src/auth/index.ts

@@ -91,4 +91,4 @@ export {
   UserRecord,
 } from './user-record';
 
-export { auth } from './auth-namespace';
+export { getAuth, auth } from './auth-namespace';

src/instance-id/index.ts

@@ -20,6 +20,15 @@ import { InstanceId } from './instance-id';
 
 export { InstanceId };
 
+export function getInstanceId(app?: App): InstanceId {
+  if (typeof app === 'undefined') {
+    app = getApp();
+  }
+
+  const firebaseApp: FirebaseApp = app as FirebaseApp;
+  return firebaseApp.getOrInitService('instanceId', (app) => new InstanceId(app));
+}
+
 /**
  * Gets the {@link instanceId.InstanceId `InstanceId`} service for the
  * default app or a given app.
@@ -50,14 +59,7 @@ export { InstanceId };
  *   no app is provided or the `InstanceId` service associated with the
  *   provided app.
  */
-export function instanceId(app?: App): InstanceId {
-  if (typeof app === 'undefined') {
-    app = getApp();
-  }
-
-  const firebaseApp: FirebaseApp = app as FirebaseApp;
-  return firebaseApp.getOrInitService('instanceId', (app) => new InstanceId(app));
-}
+export declare function instanceId(app?: App): instanceId.InstanceId;
 
 import { InstanceId as TInstanceId } from './instance-id';
 

test/unit/auth/index.spec.ts

@@ -0,0 +1,75 @@
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * 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.
+ */
+
+'use strict';
+
+import * as chai from 'chai';
+import * as sinonChai from 'sinon-chai';
+import * as chaiAsPromised from 'chai-as-promised';
+
+import * as mocks from '../../resources/mocks';
+import { App } from '../../../src/app/index';
+import { getAuth, Auth } from '../../../src/auth/index';
+
+chai.should();
+chai.use(sinonChai);
+chai.use(chaiAsPromised);
+
+const expect = chai.expect;
+
+describe('InstanceId', () => {
+  let mockApp: App;
+  let mockCredentialApp: App;
+
+  const noProjectIdError = 'Failed to determine project ID for Auth. Initialize the SDK '
+  + 'with service account credentials or set project ID as an app option. Alternatively set the '
+  + 'GOOGLE_CLOUD_PROJECT environment variable.';
+
+  beforeEach(() => {
+    mockApp = mocks.app();
+    mockCredentialApp = mocks.mockCredentialApp();
+  });
+
+  describe('getAuth()', () => {
+    it('should throw when default app is not available', () => {
+      expect(() => {
+        return getAuth();
+      }).to.throw('The default Firebase app does not exist.');
+    });
+
+    it('should reject given an invalid credential without project ID', () => {
+      // Project ID not set in the environment.
+      delete process.env.GOOGLE_CLOUD_PROJECT;
+      delete process.env.GCLOUD_PROJECT;
+      const auth = getAuth(mockCredentialApp);
+      return auth.getUser('uid')
+        .should.eventually.rejectedWith(noProjectIdError);
+    });
+
+    it('should not throw given a valid app', () => {
+      expect(() => {
+        return getAuth(mockApp);
+      }).not.to.throw();
+    });
+
+    it('should return the same instance for a given app instance', () => {
+      const auth1: Auth = getAuth(mockApp);
+      const auth2: Auth = getAuth(mockApp);
+      expect(auth1).to.equal(auth2);
+    });
+  });
+});

test/unit/index.spec.ts

@@ -30,6 +30,7 @@ import './utils/api-request.spec';
 
 // Auth
 import './auth/auth.spec';
+import './auth/index.spec';
 import './auth/user-record.spec';
 import './auth/token-generator.spec';
 import './auth/token-verifier.spec';

test/unit/instance-id/index.spec.ts

@@ -23,7 +23,7 @@ import * as chaiAsPromised from 'chai-as-promised';
 
 import * as mocks from '../../resources/mocks';
 import { App } from '../../../src/app/index';
-import { instanceId, InstanceId } from '../../../src/instance-id/index';
+import { getInstanceId, InstanceId } from '../../../src/instance-id/index';
 
 chai.should();
 chai.use(sinonChai);
@@ -44,31 +44,31 @@ describe('InstanceId', () => {
     mockCredentialApp = mocks.mockCredentialApp();
   });
 
-  describe('instanceId()', () => {
+  describe('getInstanceId()', () => {
     it('should throw when default app is not available', () => {
       expect(() => {
-        return instanceId();
+        return getInstanceId();
       }).to.throw('The default Firebase app does not exist.');
     });
 
     it('should reject given an invalid credential without project ID', () => {
       // Project ID not set in the environment.
       delete process.env.GOOGLE_CLOUD_PROJECT;
       delete process.env.GCLOUD_PROJECT;
-      const iid = instanceId(mockCredentialApp);
+      const iid = getInstanceId(mockCredentialApp);
       return iid.deleteInstanceId('iid')
         .should.eventually.rejectedWith(noProjectIdError);
     });
 
     it('should not throw given a valid app', () => {
       expect(() => {
-        return instanceId(mockApp);
+        return getInstanceId(mockApp);
       }).not.to.throw();
     });
 
     it('should return the same instance for a given app instance', () => {
-      const iid1: InstanceId = instanceId(mockApp);
-      const iid2: InstanceId = instanceId(mockApp);
+      const iid1: InstanceId = getInstanceId(mockApp);
+      const iid2: InstanceId = getInstanceId(mockApp);
       expect(iid1).to.equal(iid2);
     });
   });