Using async project ID discovery in ProjectManagement and InstanceId (#728)

hiranya911 · web-flow · commit 050cc5956357 · 2019-12-16T11:59:22.000-08:00
* Using async project ID discovery API in Auth and FCM

* Async project ID discovery mechanism for ProjectManagement and InstanceId APIs
diff --git a/src/instance-id/instance-id-request.ts b/src/instance-id/instance-id-request.ts
@@ -20,6 +20,7 @@ import {
   ApiSettings, AuthorizedHttpClient, HttpRequestConfig, HttpError,
 } from '../utils/api-request';
 
+import * as utils from '../utils/index';
 import * as validator from '../utils/validator';
 
 /** Firebase IID backend host. */
@@ -49,17 +50,15 @@ export class FirebaseInstanceIdRequestHandler {
   private readonly host: string = FIREBASE_IID_HOST;
   private readonly timeout: number = FIREBASE_IID_TIMEOUT;
   private readonly httpClient: AuthorizedHttpClient;
-  private readonly path: string;
+  private path: string;
 
   /**
    * @param {FirebaseApp} app The app used to fetch access tokens to sign API requests.
-   * @param {string} projectId A Firebase project ID string.
    *
    * @constructor
    */
-  constructor(app: FirebaseApp, projectId: string) {
+  constructor(private readonly app: FirebaseApp) {
     this.httpClient = new AuthorizedHttpClient(app);
-    this.path = FIREBASE_IID_PATH + `project/${projectId}/instanceId/`;
   }
 
   public deleteInstanceId(instanceId: string): Promise<void> {
@@ -79,11 +78,10 @@ export class FirebaseInstanceIdRequestHandler {
    * @return {Promise<void>} A promise that resolves when the request is complete.
    */
   private invokeRequestHandler(apiSettings: ApiSettings): Promise<void> {
-    const path: string = this.path + apiSettings.getEndpoint();
-    return Promise.resolve()
-      .then(() => {
+    return this.getPathPrefix()
+      .then((path) => {
         const req: HttpRequestConfig = {
-          url: `https://${this.host}${path}`,
+          url: `https://${this.host}${path}${apiSettings.getEndpoint()}`,
           method: apiSettings.getHttpMethod(),
           timeout: this.timeout,
         };
@@ -107,4 +105,26 @@ export class FirebaseInstanceIdRequestHandler {
         throw err;
       });
   }
+
+  private getPathPrefix(): Promise<string> {
+    if (this.path) {
+      return Promise.resolve(this.path);
+    }
+
+    return utils.findProjectId(this.app)
+      .then((projectId) => {
+        if (!validator.isNonEmptyString(projectId)) {
+          // Assert for an explicit projct ID (either via AppOptions or the cert itself).
+          throw new FirebaseInstanceIdError(
+            InstanceIdClientErrorCode.INVALID_PROJECT_ID,
+            'Failed to determine project ID for InstanceId. Initialize the '
+            + 'SDK with service account credentials or set project ID as an app option. '
+            + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.',
+          );
+        }
+
+        this.path = FIREBASE_IID_PATH + `project/${projectId}/instanceId/`;
+        return this.path;
+      });
+  }
 }
diff --git a/src/instance-id/instance-id.ts b/src/instance-id/instance-id.ts
@@ -19,7 +19,6 @@ import {FirebaseInstanceIdError, InstanceIdClientErrorCode} from '../utils/error
 import {FirebaseServiceInterface, FirebaseServiceInternalsInterface} from '../firebase-service';
 import {FirebaseInstanceIdRequestHandler} from './instance-id-request';
 
-import * as utils from '../utils/index';
 import * as validator from '../utils/validator';
 
 /**
@@ -55,19 +54,8 @@ export class InstanceId implements FirebaseServiceInterface {
       );
     }
 
-    const projectId: string | null = utils.getProjectId(app);
-    if (!validator.isNonEmptyString(projectId)) {
-      // Assert for an explicit projct ID (either via AppOptions or the cert itself).
-      throw new FirebaseInstanceIdError(
-        InstanceIdClientErrorCode.INVALID_PROJECT_ID,
-        'Failed to determine project ID for InstanceId. Initialize the '
-        + 'SDK with service account credentials or set project ID as an app option. '
-        + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.',
-      );
-    }
-
     this.app_ = app;
-    this.requestHandler = new FirebaseInstanceIdRequestHandler(app, projectId);
+    this.requestHandler = new FirebaseInstanceIdRequestHandler(app);
   }
 
   /**
diff --git a/src/project-management/project-management.ts b/src/project-management/project-management.ts
@@ -43,11 +43,11 @@ class ProjectManagementInternals implements FirebaseServiceInternalsInterface {
  * ProjectManagement service bound to the provided app.
  */
 export class ProjectManagement implements FirebaseServiceInterface {
+
   public readonly INTERNAL: ProjectManagementInternals = new ProjectManagementInternals();
 
-  private readonly resourceName: string;
-  private readonly projectId: string;
   private readonly requestHandler: ProjectManagementRequestHandler;
+  private projectId: string;
 
   /**
    * @param {object} app The app for this ProjectManagement service.
@@ -61,18 +61,6 @@ export class ProjectManagement implements FirebaseServiceInterface {
               + 'instance.');
     }
 
-    // Assert that a specific project ID was provided within the app.
-    const projectId = utils.getProjectId(app);
-    if (!validator.isNonEmptyString(projectId)) {
-      throw new FirebaseProjectManagementError(
-          'invalid-project-id',
-          'Failed to determine project ID. Initialize the SDK with service account credentials, or '
-              + 'set project ID as an app option. Alternatively, set the GOOGLE_CLOUD_PROJECT '
-              + 'environment variable.');
-    }
-    this.projectId = projectId;
-    this.resourceName = `projects/${this.projectId}`;
-
     this.requestHandler = new ProjectManagementRequestHandler(app);
   }
 
@@ -115,56 +103,73 @@ export class ProjectManagement implements FirebaseServiceInterface {
    * Creates a new Firebase Android app, associated with this Firebase project.
    */
   public createAndroidApp(packageName: string, displayName?: string): Promise<AndroidApp> {
-    return this.requestHandler.createAndroidApp(this.resourceName, packageName, displayName)
-        .then((responseData: any) => {
-          assertServerResponse(
-              validator.isNonNullObject(responseData),
-              responseData,
-              'createAndroidApp()\'s responseData must be a non-null object.');
+    return this.getResourceName()
+      .then((resourceName) => {
+        return this.requestHandler.createAndroidApp(resourceName, packageName, displayName);
+      })
+      .then((responseData: any) => {
+        assertServerResponse(
+            validator.isNonNullObject(responseData),
+            responseData,
+            'createAndroidApp()\'s responseData must be a non-null object.');
 
-          assertServerResponse(
-              validator.isNonEmptyString(responseData.appId),
-              responseData,
-              `"responseData.appId" field must be present in createAndroidApp()'s response data.`);
-          return new AndroidApp(responseData.appId, this.requestHandler);
-        });
+        assertServerResponse(
+            validator.isNonEmptyString(responseData.appId),
+            responseData,
+            `"responseData.appId" field must be present in createAndroidApp()'s response data.`);
+        return new AndroidApp(responseData.appId, this.requestHandler);
+      });
   }
 
   /**
    * Creates a new Firebase iOS app, associated with this Firebase project.
    */
   public createIosApp(bundleId: string, displayName?: string): Promise<IosApp> {
-    return this.requestHandler.createIosApp(this.resourceName, bundleId, displayName)
-        .then((responseData: any) => {
-          assertServerResponse(
-              validator.isNonNullObject(responseData),
-              responseData,
-              'createIosApp()\'s responseData must be a non-null object.');
+    return this.getResourceName()
+      .then((resourceName) => {
+        return this.requestHandler.createIosApp(resourceName, bundleId, displayName);
+      })
+      .then((responseData: any) => {
+        assertServerResponse(
+            validator.isNonNullObject(responseData),
+            responseData,
+            'createIosApp()\'s responseData must be a non-null object.');
 
-          assertServerResponse(
-              validator.isNonEmptyString(responseData.appId),
-              responseData,
-              `"responseData.appId" field must be present in createIosApp()'s response data.`);
-          return new IosApp(responseData.appId, this.requestHandler);
-        });
+        assertServerResponse(
+            validator.isNonEmptyString(responseData.appId),
+            responseData,
+            `"responseData.appId" field must be present in createIosApp()'s response data.`);
+        return new IosApp(responseData.appId, this.requestHandler);
+      });
   }
 
   /**
    * Lists up to 100 Firebase apps associated with this Firebase project.
    */
   public listAppMetadata(): Promise<AppMetadata[]> {
-    return this.requestHandler.listAppMetadata(this.resourceName)
-      .then((responseData) => this.transformResponseToAppMetadata(responseData));
+    return this.getResourceName()
+      .then((resourceName) => {
+        return this.requestHandler.listAppMetadata(resourceName);
+      })
+      .then((responseData) => {
+        return this.getProjectId()
+          .then((projectId) => {
+            return this.transformResponseToAppMetadata(responseData, projectId);
+          });
+      });
   }
 
   /**
    * Update display name of the project
    */
   public setDisplayName(newDisplayName: string): Promise<void> {
-    return this.requestHandler.setDisplayName(this.resourceName, newDisplayName);
+    return this.getResourceName()
+      .then((resourceName) => {
+        return this.requestHandler.setDisplayName(resourceName, newDisplayName);
+      });
   }
 
-  private transformResponseToAppMetadata(responseData: any): AppMetadata[] {
+  private transformResponseToAppMetadata(responseData: any, projectId: string): AppMetadata[] {
     this.assertListAppsResponseData(responseData, 'listAppMetadata()');
 
     if (!responseData.apps) {
@@ -183,7 +188,7 @@ export class ProjectManagement implements FirebaseServiceInterface {
       const metadata: AppMetadata = {
         appId: appJson.appId,
         platform: (AppPlatform as any)[appJson.platform] || AppPlatform.PLATFORM_UNKNOWN,
-        projectId: this.projectId,
+        projectId,
         resourceName: appJson.name,
       };
       if (appJson.displayName) {
@@ -193,34 +198,63 @@ export class ProjectManagement implements FirebaseServiceInterface {
     });
   }
 
+  private getResourceName(): Promise<string> {
+    return this.getProjectId()
+      .then((projectId) => {
+        return `projects/${projectId}`;
+      });
+  }
+
+  private getProjectId(): Promise<string> {
+    if (this.projectId) {
+      return Promise.resolve(this.projectId);
+    }
+
+    return utils.findProjectId(this.app)
+      .then((projectId) => {
+        // Assert that a specific project ID was provided within the app.
+        if (!validator.isNonEmptyString(projectId)) {
+          throw new FirebaseProjectManagementError(
+              'invalid-project-id',
+              'Failed to determine project ID. Initialize the SDK with service account credentials, or '
+                + 'set project ID as an app option. Alternatively, set the GOOGLE_CLOUD_PROJECT '
+                + 'environment variable.');
+        }
+
+        this.projectId = projectId;
+        return this.projectId;
+      });
+  }
+
   /**
    * Lists up to 100 Firebase apps for a specified platform, associated with this Firebase project.
    */
   private listPlatformApps<T>(platform: 'android' | 'ios', callerName: string): Promise<T[]> {
-    const listPromise: Promise<object> = (platform === 'android') ?
-        this.requestHandler.listAndroidApps(this.resourceName)
-        : this.requestHandler.listIosApps(this.resourceName);
+    return this.getResourceName()
+      .then((resourceName) => {
+        return (platform === 'android') ?
+          this.requestHandler.listAndroidApps(resourceName)
+          : this.requestHandler.listIosApps(resourceName);
+      })
+      .then((responseData: any) => {
+        this.assertListAppsResponseData(responseData, callerName);
 
-    return listPromise
-        .then((responseData: any) => {
-          this.assertListAppsResponseData(responseData, callerName);
+        if (!responseData.apps) {
+          return [];
+        }
 
-          if (!responseData.apps) {
-            return [];
+        return responseData.apps.map((appJson: any) => {
+          assertServerResponse(
+              validator.isNonEmptyString(appJson.appId),
+              responseData,
+              `"apps[].appId" field must be present in the ${callerName} response data.`);
+          if (platform === 'android') {
+            return new AndroidApp(appJson.appId, this.requestHandler);
+          } else {
+            return new IosApp(appJson.appId, this.requestHandler);
           }
-
-          return responseData.apps.map((appJson: any) => {
-            assertServerResponse(
-                validator.isNonEmptyString(appJson.appId),
-                responseData,
-                `"apps[].appId" field must be present in the ${callerName} response data.`);
-            if (platform === 'android') {
-              return new AndroidApp(appJson.appId, this.requestHandler);
-            } else {
-              return new IosApp(appJson.appId, this.requestHandler);
-            }
-          });
         });
+      });
   }
 
   private assertListAppsResponseData(responseData: any, callerName: string): void {
diff --git a/test/unit/instance-id/instance-id-request.spec.ts b/test/unit/instance-id/instance-id-request.spec.ts
@@ -36,7 +36,7 @@ chai.use(chaiAsPromised);
 const expect = chai.expect;
 
 describe('FirebaseInstanceIdRequestHandler', () => {
-  const projectId: string = 'test-project-id';
+  const projectId: string = 'project_id';
   const mockAccessToken: string = utils.generateRandomAccessToken();
   let stubs: sinon.SinonStub[] = [];
   let getTokenStub: sinon.SinonStub;
@@ -68,7 +68,7 @@ describe('FirebaseInstanceIdRequestHandler', () => {
   describe('Constructor', () => {
     it('should succeed with a FirebaseApp instance', () => {
       expect(() => {
-        return new FirebaseInstanceIdRequestHandler(mockApp, projectId);
+        return new FirebaseInstanceIdRequestHandler(mockApp);
       }).not.to.throw(Error);
     });
   });
@@ -84,7 +84,7 @@ describe('FirebaseInstanceIdRequestHandler', () => {
         .resolves(utils.responseFrom(''));
       stubs.push(stub);
 
-      const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp, projectId);
+      const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp);
       return requestHandler.deleteInstanceId('test-iid')
         .then(() => {
           expect(stub).to.have.been.calledOnce.and.calledWith({
@@ -101,7 +101,7 @@ describe('FirebaseInstanceIdRequestHandler', () => {
           .rejects(utils.errorFrom({}, 404));
         stubs.push(stub);
 
-        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp, projectId);
+        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp);
         return requestHandler.deleteInstanceId('test-iid')
           .then(() => {
             throw new Error('Unexpected success');
@@ -117,7 +117,7 @@ describe('FirebaseInstanceIdRequestHandler', () => {
           .rejects(utils.errorFrom({}, 409));
         stubs.push(stub);
 
-        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp, projectId);
+        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp);
         return requestHandler.deleteInstanceId('test-iid')
           .then(() => {
             throw new Error('Unexpected success');
@@ -134,7 +134,7 @@ describe('FirebaseInstanceIdRequestHandler', () => {
           .rejects(utils.errorFrom(expectedResult, 511));
         stubs.push(stub);
 
-        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp, projectId);
+        const requestHandler = new FirebaseInstanceIdRequestHandler(mockApp);
         return requestHandler.deleteInstanceId('test-iid')
           .then(() => {
             throw new Error('Unexpected success');
diff --git a/test/unit/instance-id/instance-id.spec.ts b/test/unit/instance-id/instance-id.spec.ts
@@ -93,13 +93,13 @@ describe('InstanceId', () => {
       }).to.throw('First argument passed to admin.instanceId() must be a valid Firebase app instance.');
     });
 
-    it('should throw given an invalid credential without project ID', () => {
+    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;
-      expect(() => {
-        return new InstanceId(mockCredentialApp);
-      }).to.throw(noProjectIdError);
+      const instanceId = new InstanceId(mockCredentialApp);
+      return instanceId.deleteInstanceId('iid')
+        .should.eventually.rejectedWith(noProjectIdError);
     });
 
     it('should not throw given a valid app', () => {
diff --git a/test/unit/project-management/project-management.spec.ts b/test/unit/project-management/project-management.spec.ts
