Rename authHeaders->headers. Add a test for empty AppCheck token.

Author: ehsannas

packages/firestore/lite/register.ts

@@ -46,7 +46,9 @@ export function registerFirestore(): void {
         const app = container.getProvider('app').getImmediate()!;
         const firestoreInstance = new Firestore(
           app,
-          new LiteAuthCredentialsProvider(container.getProvider('auth-internal')),
+          new LiteAuthCredentialsProvider(
+            container.getProvider('auth-internal')
+          ),
           new LiteAppCheckTokenProvider(
             container.getProvider('app-check-internal')
           )

packages/firestore/src/api/credentials.ts

@@ -69,16 +69,16 @@ export interface Token {
   user?: User;
 
   /** Extra header values to be passed along with a request */
-  authHeaders: { [header: string]: string };
+  headers: { [header: string]: string };
 }
 
 export class OAuthToken implements Token {
   type = 'OAuth' as TokenType;
-  authHeaders: { [header: string]: string };
+  headers: { [header: string]: string };
   constructor(value: string, public user: User) {
-    this.authHeaders = {};
+    this.headers = {};
     // Set the headers using Object Literal notation to avoid minification
-    this.authHeaders['Authorization'] = `Bearer ${value}`;
+    this.headers['Authorization'] = `Bearer ${value}`;
   }
 }
 
@@ -144,7 +144,9 @@ export class EmptyAuthCredentialsProvider implements CredentialsProvider<User> {
  * A CredentialsProvider that always returns a constant token. Used for
  * emulator token mocking.
  */
-export class EmulatorAuthCredentialsProvider implements CredentialsProvider<User> {
+export class EmulatorAuthCredentialsProvider
+  implements CredentialsProvider<User>
+{
   constructor(private token: Token) {}
 
   /**
@@ -219,7 +221,9 @@ export class LiteAuthCredentialsProvider implements CredentialsProvider<User> {
   shutdown(): void {}
 }
 
-export class FirebaseAuthCredentialsProvider implements CredentialsProvider<User> {
+export class FirebaseAuthCredentialsProvider
+  implements CredentialsProvider<User>
+{
   /**
    * The auth token listener registered with FirebaseApp, retained here so we
    * can unregister it.
@@ -399,19 +403,19 @@ export class FirstPartyToken implements Token {
     private iamToken: string | null
   ) {}
 
-  get authHeaders(): { [header: string]: string } {
-    const headers: { [header: string]: string } = {
+  get headers(): { [header: string]: string } {
+    const result: { [header: string]: string } = {
       'X-Goog-AuthUser': this.sessionIndex
     };
     // Use array notation to prevent minification
     const authHeader = this.gapi['auth']['getAuthHeaderValueForFirstParty']([]);
     if (authHeader) {
-      headers['Authorization'] = authHeader;
+      result['Authorization'] = authHeader;
     }
     if (this.iamToken) {
-      headers['X-Goog-Iam-Authorization-Token'] = this.iamToken;
+      result['X-Goog-Iam-Authorization-Token'] = this.iamToken;
     }
-    return headers;
+    return result;
   }
 }
 
@@ -450,13 +454,13 @@ export class FirstPartyAuthCredentialsProvider
 
 export class AppCheckToken implements Token {
   type = 'AppCheck' as TokenType;
-  authHeaders: { [header: string]: string };
+  headers: { [header: string]: string };
 
   constructor(value: string) {
-    this.authHeaders = {};
+    this.headers = {};
     if (value && value.length > 0) {
       // Set the headers using Object Literal notation to avoid minification
-      this.authHeaders['x-firebase-appcheck'] = value;
+      this.headers['x-firebase-appcheck'] = value;
     }
   }
 }

packages/firestore/src/platform/node/grpc_connection.ts

@@ -52,9 +52,9 @@ function createMetadata(
   const metadata = new Metadata();
   for (const token of [authToken, appCheckToken]) {
     if (token) {
-      for (const header in token.authHeaders) {
-        if (token.authHeaders.hasOwnProperty(header)) {
-          metadata.set(header, token.authHeaders[header]);
+      for (const header in token.headers) {
+        if (token.headers.hasOwnProperty(header)) {
+          metadata.set(header, token.headers[header]);
         }
       }
     }

packages/firestore/src/remote/rest_connection.ts

@@ -145,9 +145,9 @@ export abstract class RestConnection implements Connection {
     }
     for (const token of [authToken, appCheckToken]) {
       if (token) {
-        for (const header in token.authHeaders) {
-          if (token.authHeaders.hasOwnProperty(header)) {
-            headers[header] = token.authHeaders[header];
+        for (const header in token.headers) {
+          if (token.headers.hasOwnProperty(header)) {
+            headers[header] = token.headers[header];
           }
         }
       }

packages/firestore/test/integration/remote/stream.test.ts

@@ -17,7 +17,10 @@
 
 import { expect } from 'chai';
 
-import { EmptyAuthCredentialsProvider, Token } from '../../../src/api/credentials';
+import {
+  EmptyAuthCredentialsProvider,
+  Token
+} from '../../../src/api/credentials';
 import { SnapshotVersion } from '../../../src/core/snapshot_version';
 import { MutationResult } from '../../../src/model/mutation';
 import {

packages/firestore/test/unit/remote/rest_connection.test.ts

@@ -17,7 +17,7 @@
 
 import { expect } from 'chai';
 
-import { Token } from '../../../src/api/credentials';
+import { AppCheckToken, Token } from '../../../src/api/credentials';
 import { User } from '../../../src/auth/user';
 import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
 import { SDK_VERSION } from '../../../src/core/version';
@@ -90,11 +90,11 @@ describe('RestConnection', () => {
       {
         user: User.UNAUTHENTICATED,
         type: 'OAuth',
-        authHeaders: { 'Authorization': 'Bearer owner' }
+        headers: { 'Authorization': 'Bearer owner' }
       },
       {
         type: 'AppCheck',
-        authHeaders: { 'x-firebase-appcheck': 'some-app-check-token' }
+        headers: { 'x-firebase-appcheck': 'some-app-check-token' }
       }
     );
     expect(connection.lastHeaders).to.deep.equal({
@@ -106,6 +106,22 @@ describe('RestConnection', () => {
     });
   });
 
+  it('empty app check token is not added to headers', async () => {
+    await connection.invokeRPC(
+      'RunQuery',
+      'projects/testproject/databases/(default)/documents/foo',
+      {},
+      null,
+      new AppCheckToken('')
+    );
+    expect(connection.lastHeaders).to.deep.equal({
+      'Content-Type': 'text/plain',
+      'X-Firebase-GMPID': 'test-app-id',
+      'X-Goog-Api-Client': `gl-js/ fire/${SDK_VERSION}`
+      // Note: AppCheck token should not exist here.
+    });
+  });
+
   it('returns success', async () => {
     connection.nextResponse = Promise.resolve({ response: true });
     const response = await connection.invokeRPC(