chore: Make instance-id use new modularization pattern (#977)

Author: MathBunny

src/firebase-app.ts

@@ -30,7 +30,6 @@ import { DatabaseService } from './database/database';
 import { Firestore } from '@google-cloud/firestore';
 import { FirestoreService } from './firestore/firestore';
 import { InstanceId } from './instance-id/instance-id';
-import { InstanceIdImpl } from './instance-id/instance-id-internal';
 
 import { ProjectManagement } from './project-management/project-management';
 import { SecurityRules } from './security-rules/security-rules';
@@ -353,7 +352,7 @@ export class FirebaseApp {
    */
   public instanceId(): InstanceId {
     return this.ensureService_('iid', () => {
-      const iidService: typeof InstanceIdImpl = require('./instance-id/instance-id-internal').InstanceIdImpl;
+      const iidService: typeof InstanceId = require('./instance-id/instance-id').InstanceId;
       return new iidService(this);
     });
   }

src/firebase-namespace.ts

@@ -425,7 +425,7 @@ export class FirebaseNamespace {
     const fn: FirebaseServiceNamespace<InstanceId> = (app?: FirebaseApp) => {
       return this.ensureApp(app).instanceId();
     };
-    const instanceId = require('./instance-id/instance-id-internal').InstanceIdImpl;
+    const instanceId = require('./instance-id/instance-id').InstanceId;
     return Object.assign(fn, { InstanceId: instanceId });
   }
 

src/instance-id/index.ts

@@ -37,5 +37,7 @@ export namespace admin.instanceId {
   // See https://github.com/microsoft/TypeScript/issues/4336
   /* eslint-disable @typescript-eslint/no-unused-vars */
   // See https://github.com/typescript-eslint/typescript-eslint/issues/363
-  export import InstanceId = instanceIdApi.InstanceId;
+  // Allows for exposing classes as interfaces in typings
+  /* eslint-disable @typescript-eslint/no-empty-interface */
+  export interface InstanceId extends instanceIdApi.InstanceId {}
 }

src/instance-id/instance-id-internal.ts

@@ -15,6 +15,26 @@
  */
 
 import { FirebaseApp } from '../firebase-app';
+import { FirebaseServiceInterface, FirebaseServiceInternalsInterface } from '../firebase-service';
+import { FirebaseInstanceIdError, InstanceIdClientErrorCode } from '../utils/error';
+import { FirebaseInstanceIdRequestHandler } from './instance-id-request-internal';
+
+import * as validator from '../utils/validator';
+
+/**
+ * Internals of an InstanceId service instance.
+ */
+class InstanceIdInternals implements FirebaseServiceInternalsInterface {
+  /**
+   * Deletes the service and its associated resources.
+   *
+   * @return {Promise<()>} An empty Promise that will be fulfilled when the service is deleted.
+   */
+  public delete(): Promise<void> {
+    // There are no resources to clean up
+    return Promise.resolve(undefined);
+  }
+}
 
 /**
  * Gets the {@link InstanceId `InstanceId`} service for the
@@ -30,8 +50,27 @@ import { FirebaseApp } from '../firebase-app';
  * @return The `InstanceId` service for the
  *   current app.
  */
-export interface InstanceId {
-  app: FirebaseApp;
+export class InstanceId implements FirebaseServiceInterface {
+  public INTERNAL: InstanceIdInternals = new InstanceIdInternals();
+
+  private app_: FirebaseApp;
+  private requestHandler: FirebaseInstanceIdRequestHandler;
+
+  /**
+   * @param {FirebaseApp} app The app for this InstanceId service.
+   * @constructor
+   */
+  constructor(app: FirebaseApp) {
+    if (!validator.isNonNullObject(app) || !('options' in app)) {
+      throw new FirebaseInstanceIdError(
+        InstanceIdClientErrorCode.INVALID_ARGUMENT,
+        'First argument passed to admin.instanceId() must be a valid Firebase app instance.',
+      );
+    }
+
+    this.app_ = app;
+    this.requestHandler = new FirebaseInstanceIdRequestHandler(app);
+  }
 
   /**
    * Deletes the specified instance ID and the associated data from Firebase.
@@ -46,5 +85,19 @@ export interface InstanceId {
    *
    * @return A promise fulfilled when the instance ID is deleted.
    */
-  deleteInstanceId(instanceId: string): Promise<void>;
+  public deleteInstanceId(instanceId: string): Promise<void> {
+    return this.requestHandler.deleteInstanceId(instanceId)
+      .then(() => {
+        // Return nothing on success
+      });
+  }
+
+  /**
+   * Returns the app associated with this InstanceId instance.
+   *
+   * @return {FirebaseApp} The app associated with this InstanceId instance.
+   */
+  get app(): FirebaseApp {
+    return this.app_;
+  }
 }

src/instance-id/instance-id-request.ts renamed to src/instance-id/instance-id-request-internal.ts

@@ -49,7 +49,6 @@ import {
   setLogFunction,
 } from '@google-cloud/firestore';
 import { InstanceId } from '../../src/instance-id/instance-id';
-import { InstanceIdImpl } from '../../src/instance-id/instance-id-internal';
 import { ProjectManagement } from '../../src/project-management/project-management';
 import { SecurityRules } from '../../src/security-rules/security-rules';
 import { RemoteConfig } from '../../src/remote-config/remote-config';
@@ -624,7 +623,7 @@ describe('FirebaseNamespace', () => {
     });
 
     it('should return a reference to InstanceId type', () => {
-      expect(firebaseNamespace.instanceId.InstanceId).to.be.deep.equal(InstanceIdImpl);
+      expect(firebaseNamespace.instanceId.InstanceId).to.be.deep.equal(InstanceId);
     });
   });
 

src/instance-id/instance-id.ts

@@ -27,7 +27,7 @@ import * as mocks from '../../resources/mocks';
 
 import { FirebaseApp } from '../../../src/firebase-app';
 import { HttpClient } from '../../../src/utils/api-request';
-import { FirebaseInstanceIdRequestHandler } from '../../../src/instance-id/instance-id-request';
+import { FirebaseInstanceIdRequestHandler } from '../../../src/instance-id/instance-id-request-internal';
 
 chai.should();
 chai.use(sinonChai);

test/unit/firebase-namespace.spec.ts

@@ -26,8 +26,7 @@ import * as utils from '../utils';
 import * as mocks from '../../resources/mocks';
 
 import { InstanceId } from '../../../src/instance-id/instance-id';
-import { InstanceIdImpl } from '../../../src/instance-id/instance-id-internal';
-import { FirebaseInstanceIdRequestHandler } from '../../../src/instance-id/instance-id-request';
+import { FirebaseInstanceIdRequestHandler } from '../../../src/instance-id/instance-id-request-internal';
 import { FirebaseApp } from '../../../src/firebase-app';
 import { FirebaseInstanceIdError, InstanceIdClientErrorCode } from '../../../src/utils/error';
 
@@ -58,14 +57,14 @@ describe('InstanceId', () => {
     mockApp = mocks.app();
     getTokenStub = utils.stubGetAccessToken(undefined, mockApp);
     mockCredentialApp = mocks.mockCredentialApp();
-    iid = new InstanceIdImpl(mockApp);
+    iid = new InstanceId(mockApp);
 
     googleCloudProject = process.env.GOOGLE_CLOUD_PROJECT;
     gcloudProject = process.env.GCLOUD_PROJECT;
 
-    nullAccessTokenClient = new InstanceIdImpl(mocks.appReturningNullAccessToken());
-    malformedAccessTokenClient = new InstanceIdImpl(mocks.appReturningMalformedAccessToken());
-    rejectedPromiseAccessTokenClient = new InstanceIdImpl(mocks.appRejectedWhileFetchingAccessToken());
+    nullAccessTokenClient = new InstanceId(mocks.appReturningNullAccessToken());
+    malformedAccessTokenClient = new InstanceId(mocks.appReturningMalformedAccessToken());
+    rejectedPromiseAccessTokenClient = new InstanceId(mocks.appRejectedWhileFetchingAccessToken());
   });
 
   afterEach(() => {
@@ -81,15 +80,15 @@ describe('InstanceId', () => {
     invalidApps.forEach((invalidApp) => {
       it('should throw given invalid app: ' + JSON.stringify(invalidApp), () => {
         expect(() => {
-          const iidAny: any = InstanceIdImpl;
+          const iidAny: any = InstanceId;
           return new iidAny(invalidApp);
         }).to.throw('First argument passed to admin.instanceId() must be a valid Firebase app instance.');
       });
     });
 
     it('should throw given no app', () => {
       expect(() => {
-        const iidAny: any = InstanceIdImpl;
+        const iidAny: any = InstanceId;
         return new iidAny();
       }).to.throw('First argument passed to admin.instanceId() must be a valid Firebase app instance.');
     });
@@ -98,14 +97,14 @@ describe('InstanceId', () => {
       // Project ID not set in the environment.
       delete process.env.GOOGLE_CLOUD_PROJECT;
       delete process.env.GCLOUD_PROJECT;
-      const instanceId = new InstanceIdImpl(mockCredentialApp);
+      const instanceId = new InstanceId(mockCredentialApp);
       return instanceId.deleteInstanceId('iid')
         .should.eventually.rejectedWith(noProjectIdError);
     });
 
     it('should not throw given a valid app', () => {
       expect(() => {
-        return new InstanceIdImpl(mockApp);
+        return new InstanceId(mockApp);
       }).not.to.throw();
     });
   });
@@ -119,7 +118,7 @@ describe('InstanceId', () => {
     it('is read-only', () => {
       expect(() => {
         (iid as any).app = mockApp;
-      }).to.throw('Cannot set property app of #<InstanceIdImpl> which has only a getter');
+      }).to.throw('Cannot set property app of #<InstanceId> which has only a getter');
     });
   });