Reading projectId from GOOGLE_CLOUD_PROJECT (#296)

* Reading projectId from GOOGLE_CLOUD_PROJECT

* Updated changelog

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
--
+- [changed] Admin SDK can now read the Firebase/GCP project ID from both
+  `GCLOUD_PROJECT` and `GOOGLE_CLOUD_PROJECT` environment variables.
 
 # v5.12.1
 

src/auth/auth.ts

@@ -15,7 +15,6 @@
  */
 
 import {UserRecord, CreateRequest, UpdateRequest} from './user-record';
-import {Certificate} from './credential';
 import {FirebaseApp} from '../firebase-app';
 import {FirebaseTokenGenerator} from './token-generator';
 import {FirebaseAuthRequestHandler} from './auth-api-request';
@@ -25,6 +24,7 @@ import {
   UserImportOptions, UserImportRecord, UserImportResult,
 } from './user-import-builder';
 
+import * as utils from '../utils/index';
 import * as validator from '../utils/validator';
 
 
@@ -99,6 +99,7 @@ export class Auth implements FirebaseServiceInterface {
     }
 
     this.app_ = app;
+    const projectId = utils.getProjectId(app);
 
     // TODO (inlined): plumb this into a factory method for tokenGenerator_ once we
     // can generate custom tokens from access tokens.
@@ -110,12 +111,12 @@ export class Auth implements FirebaseServiceInterface {
       // Cert credentials and Application Default Credentials created from a service account file
       // provide a certificate we can use to mint custom tokens and verify ID tokens.
       this.tokenGenerator_ = new FirebaseTokenGenerator(serviceAccount);
-    } else if (validator.isNonEmptyString(process.env.GCLOUD_PROJECT)) {
+    } else if (validator.isNonEmptyString(projectId)) {
       // Google infrastructure like GAE, GCE, and GCF store the GCP / Firebase project ID in an
       // environment variable that we can use to get verifyIdToken() to work. createCustomToken()
       // still won't work since it requires a private key and client email which we do not have.
       const cert: any = {
-        projectId: process.env.GCLOUD_PROJECT,
+        projectId,
       };
       this.tokenGenerator_ = new FirebaseTokenGenerator(cert);
     }
@@ -168,7 +169,7 @@ export class Auth implements FirebaseServiceInterface {
       throw new FirebaseAuthError(
         AuthClientErrorCode.INVALID_CREDENTIAL,
         'Must initialize app with a cert credential or set your Firebase project ID as the ' +
-        'GCLOUD_PROJECT environment variable to call auth().verifyIdToken().',
+        'GOOGLE_CLOUD_PROJECT environment variable to call auth().verifyIdToken().',
       );
     }
     return this.tokenGenerator_.verifyIdToken(idToken)
@@ -404,7 +405,7 @@ export class Auth implements FirebaseServiceInterface {
       throw new FirebaseAuthError(
         AuthClientErrorCode.INVALID_CREDENTIAL,
         'Must initialize app with a cert credential or set your Firebase project ID as the ' +
-        'GCLOUD_PROJECT environment variable to call auth().verifySessionCookie().',
+        'GOOGLE_CLOUD_PROJECT environment variable to call auth().verifySessionCookie().',
       );
     }
     return this.tokenGenerator_.verifySessionCookie(sessionCookie)

src/firestore/firestore.ts

@@ -83,7 +83,7 @@ export function getFirestoreOptions(app: FirebaseApp): any {
         code: 'no-project-id',
         message: 'Failed to determine project ID for Firestore. Initialize the '
           + 'SDK with service account credentials or set project ID as an app option. '
-          + 'Alternatively set the GCLOUD_PROJECT environment variable.',
+          + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.',
       });
     }
     return {
@@ -96,7 +96,7 @@ export function getFirestoreOptions(app: FirebaseApp): any {
   } else if (app.options.credential instanceof ApplicationDefaultCredential) {
     // Try to use the Google application default credentials.
     // If an explicit project ID is not available, let Firestore client discover one from the
-    // environment. This prevents the users from having to set GCLOUD_PROJECT in GCP runtimes.
+    // environment. This prevents the users from having to set GOOGLE_CLOUD_PROJECT in GCP runtimes.
     return validator.isNonEmptyString(projectId) ? {projectId} : {};
   }
 

src/instance-id/instance-id.ts

@@ -62,7 +62,7 @@ export class InstanceId implements FirebaseServiceInterface {
         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 GCLOUD_PROJECT environment variable.',
+        + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.',
       );
     }
 

src/messaging/messaging.ts

@@ -683,7 +683,7 @@ export class Messaging implements FirebaseServiceInterface {
         MessagingClientErrorCode.INVALID_ARGUMENT,
         'Failed to determine project ID for Messaging. Initialize the '
         + 'SDK with service account credentials or set project ID as an app option. '
-        + 'Alternatively set the GCLOUD_PROJECT environment variable.',
+        + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.',
       );
     }
 

src/utils/index.ts

@@ -74,7 +74,7 @@ export function getProjectId(app: FirebaseApp): string {
     return cert.projectId;
   }
 
-  const projectId = process.env.GCLOUD_PROJECT;
+  const projectId = process.env.GOOGLE_CLOUD_PROJECT || process.env.GCLOUD_PROJECT;
   if (validator.isNonEmptyString(projectId)) {
     return projectId;
   }

test/unit/auth/auth.spec.ts

@@ -166,6 +166,7 @@ describe('Auth', () => {
 
     oldProcessEnv = process.env;
     // Project ID not set in the environment.
+    delete process.env.GOOGLE_CLOUD_PROJECT;
     delete process.env.GCLOUD_PROJECT;
   });
 
@@ -305,6 +306,16 @@ describe('Auth', () => {
       });
     });
 
+    it('should work with a non-cert credential when the GOOGLE_CLOUD_PROJECT environment variable is present', () => {
+      process.env.GOOGLE_CLOUD_PROJECT = mocks.projectId;
+
+      const mockCredentialAuth = new Auth(mocks.mockCredentialApp());
+
+      return mockCredentialAuth.verifyIdToken(mockIdToken).then(() => {
+        expect(stub).to.have.been.calledOnce.and.calledWith(mockIdToken);
+      });
+    });
+
     it('should work with a non-cert credential when the GCLOUD_PROJECT environment variable is present', () => {
       process.env.GCLOUD_PROJECT = mocks.projectId;
 
@@ -494,6 +505,16 @@ describe('Auth', () => {
       });
     });
 
+    it('should work with a non-cert credential when the GOOGLE_CLOUD_PROJECT environment variable is present', () => {
+      process.env.GOOGLE_CLOUD_PROJECT = mocks.projectId;
+
+      const mockCredentialAuth = new Auth(mocks.mockCredentialApp());
+
+      return mockCredentialAuth.verifySessionCookie(mockSessionCookie).then(() => {
+        expect(stub).to.have.been.calledOnce.and.calledWith(mockSessionCookie);
+      });
+    });
+
     it('should work with a non-cert credential when the GCLOUD_PROJECT environment variable is present', () => {
       process.env.GCLOUD_PROJECT = mocks.projectId;
 

test/unit/firestore/firestore.spec.ts

@@ -19,6 +19,7 @@
 import path = require('path');
 import * as _ from 'lodash';
 import {expect} from 'chai';
+import * as utils from '../../../src/utils/index';
 
 import * as mocks from '../../resources/mocks';
 import {FirebaseApp} from '../../../src/firebase-app';
@@ -33,6 +34,7 @@ describe('Firestore', () => {
   let firestore: any;
 
   let appCredentials: string;
+  let googleCloudProject: string;
   let gcloudProject: string;
 
   const invalidCredError = 'Failed to initialize Google Cloud Firestore client with the available '
@@ -43,6 +45,7 @@ describe('Firestore', () => {
 
   beforeEach(() => {
     appCredentials = process.env.GOOGLE_APPLICATION_CREDENTIALS;
+    googleCloudProject = process.env.GOOGLE_CLOUD_PROJECT;
     gcloudProject = process.env.GCLOUD_PROJECT;
     delete process.env.GOOGLE_APPLICATION_CREDENTIALS;
 
@@ -60,7 +63,16 @@ describe('Firestore', () => {
 
   afterEach(() => {
     process.env.GOOGLE_APPLICATION_CREDENTIALS = appCredentials;
-    process.env.GCLOUD_PROJECT = gcloudProject;
+    if (googleCloudProject) {
+      process.env.GOOGLE_CLOUD_PROJECT = googleCloudProject;
+    } else {
+      delete process.env.GOOGLE_CLOUD_PROJECT;
+    }
+    if (gcloudProject) {
+      process.env.GCLOUD_PROJECT = gcloudProject;
+    } else {
+      delete process.env.GCLOUD_PROJECT;
+    }
     return mockApp.delete();
   });
 
@@ -84,14 +96,15 @@ describe('Firestore', () => {
 
     it('should throw given an invalid credential with project ID', () => {
       // Project ID is read from the environment variable, but the credential is unsupported.
-      process.env.GCLOUD_PROJECT = 'project_id';
+      process.env.GOOGLE_CLOUD_PROJECT = 'project_id';
       expect(() => {
         return new FirestoreService(mockCredentialApp);
       }).to.throw(invalidCredError);
     });
 
     it('should throw 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 FirestoreService(mockCredentialApp);
@@ -106,6 +119,7 @@ describe('Firestore', () => {
 
     it('should not throw given application default credentials without project ID', () => {
       // Project ID not set in the environment.
+      delete process.env.GOOGLE_CLOUD_PROJECT;
       delete process.env.GCLOUD_PROJECT;
       process.env.GOOGLE_APPLICATION_CREDENTIALS = mockServiceAccount;
       expect(() => {
@@ -151,7 +165,14 @@ describe('Firestore', () => {
       expect(options.projectId).to.equal('explicit-project-id');
     });
 
-    it('should return a string when project ID is present in environment', () => {
+    it('should return a string when GOOGLE_CLOUD_PROJECT is set', () => {
+      process.env.GOOGLE_CLOUD_PROJECT = 'env-project-id';
+      process.env.GOOGLE_APPLICATION_CREDENTIALS = mockServiceAccount;
+      const options = getFirestoreOptions(defaultCredentialApp);
+      expect(options.projectId).to.equal('env-project-id');
+    });
+
+    it('should return a string when GCLOUD_PROJECT is set', () => {
       process.env.GCLOUD_PROJECT = 'env-project-id';
       process.env.GOOGLE_APPLICATION_CREDENTIALS = mockServiceAccount;
       const options = getFirestoreOptions(defaultCredentialApp);

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

@@ -48,11 +48,12 @@ describe('InstanceId', () => {
   let malformedAccessTokenClient: InstanceId;
   let rejectedPromiseAccessTokenClient: InstanceId;
 
+  let googleCloudProject: string;
   let gcloudProject: string;
 
   const noProjectIdError = '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 '
-  + 'GCLOUD_PROJECT environment variable.';
+  + 'GOOGLE_CLOUD_PROJECT environment variable.';
 
   before(() => utils.mockFetchAccessTokenRequests());
 
@@ -63,6 +64,7 @@ describe('InstanceId', () => {
     mockCredentialApp = mocks.mockCredentialApp();
     iid = new InstanceId(mockApp);
 
+    googleCloudProject = process.env.GOOGLE_CLOUD_PROJECT;
     gcloudProject = process.env.GCLOUD_PROJECT;
 
     nullAccessTokenClient = new InstanceId(mocks.appReturningNullAccessToken());
@@ -71,6 +73,7 @@ describe('InstanceId', () => {
   });
 
   afterEach(() => {
+    process.env.GOOGLE_CLOUD_PROJECT = googleCloudProject;
     process.env.GCLOUD_PROJECT = gcloudProject;
     return mockApp.delete();
   });
@@ -96,6 +99,7 @@ describe('InstanceId', () => {
 
     it('should throw 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);

test/unit/utils/index.spec.ts

@@ -64,13 +64,21 @@ describe('toWebSafeBase64()', () => {
 });
 
 describe('getProjectId()', () => {
+  let googleCloudProject: string;
   let gcloudProject: string;
 
   before(() => {
+    googleCloudProject = process.env.GOOGLE_CLOUD_PROJECT;
     gcloudProject = process.env.GCLOUD_PROJECT;
   });
 
   after(() => {
+    if (isNonEmptyString(googleCloudProject)) {
+      process.env.GOOGLE_CLOUD_PROJECT = googleCloudProject;
+    } else {
+      delete process.env.GOOGLE_CLOUD_PROJECT;
+    }
+
     if (isNonEmptyString(gcloudProject)) {
       process.env.GCLOUD_PROJECT = gcloudProject;
     } else {
@@ -92,13 +100,20 @@ describe('getProjectId()', () => {
     expect(getProjectId(app)).to.equal('project_id');
   });
 
-  it('should return the project ID set in environment', () => {
+  it('should return the project ID set in GOOGLE_CLOUD_PROJECT environment variable', () => {
+    process.env.GOOGLE_CLOUD_PROJECT = 'env-var-project-id';
+    const app: FirebaseApp = mocks.mockCredentialApp();
+    expect(getProjectId(app)).to.equal('env-var-project-id');
+  });
+
+  it('should return the project ID set in GCLOUD_PROJECT environment variable', () => {
     process.env.GCLOUD_PROJECT = 'env-var-project-id';
     const app: FirebaseApp = mocks.mockCredentialApp();
     expect(getProjectId(app)).to.equal('env-var-project-id');
   });
 
   it('should return null when project ID is not set', () => {
+    delete process.env.GOOGLE_CLOUD_PROJECT;
     delete process.env.GCLOUD_PROJECT;
     const app: FirebaseApp = mocks.mockCredentialApp();
     expect(getProjectId(app)).to.be.null;