Merge branch 'master' into fei-firestore-wait

Author: Feiyang1

.changeset/lemon-ligers-protect.md

@@ -0,0 +1,7 @@
+---
+'@firebase/firestore-types': minor
+'@firebase/firestore': minor
+'firebase': minor
+---
+
+Add mockUserToken support for Firestore.

.changeset/loud-bears-rule.md

@@ -0,0 +1,5 @@
+---
+'@firebase/app': patch
+---
+
+Add AppCheck platform logging string.

packages/app-check-types/index.d.ts

@@ -18,9 +18,17 @@
 export interface FirebaseAppCheck {
   /**
    * Activate AppCheck
-   * @param siteKeyOrOrovider - reCAPTCHA sitekey or custom token provider
+   * @param siteKeyOrProvider - reCAPTCHA sitekey or custom token provider
+   * @param isTokenAutoRefreshEnabled - If true, enables SDK to automatically
+   * refresh AppCheck token as needed. If undefined, the value will default
+   * to the value of `app.automaticDataCollectionEnabled`. That property
+   * defaults to false and can be set in the app config.
    */
-  activate(siteKeyOrProvider: string | AppCheckProvider): void;
+  activate(
+    siteKeyOrProvider: string | AppCheckProvider,
+    isTokenAutoRefreshEnabled?: boolean
+  ): void;
+  setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
 }
 
 interface AppCheckProvider {

packages/app-check/package.json

@@ -52,7 +52,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/src/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages/app-check/src/api.test.ts

@@ -17,7 +17,7 @@
 import '../test/setup';
 import { expect } from 'chai';
 import { stub } from 'sinon';
-import { activate } from './api';
+import { activate, setTokenAutoRefreshEnabled } from './api';
 import {
   FAKE_SITE_KEY,
   getFakeApp,
@@ -41,6 +41,18 @@ describe('api', () => {
       expect(getState(app).activated).to.equal(true);
     });
 
+    it('isTokenAutoRefreshEnabled value defaults to global setting', () => {
+      app = getFakeApp({ automaticDataCollectionEnabled: false });
+      activate(app, FAKE_SITE_KEY);
+      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(false);
+    });
+
+    it('sets isTokenAutoRefreshEnabled correctly, overriding global setting', () => {
+      app = getFakeApp({ automaticDataCollectionEnabled: false });
+      activate(app, FAKE_SITE_KEY, true);
+      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(true);
+    });
+
     it('can only be called once', () => {
       activate(app, FAKE_SITE_KEY);
       expect(() => activate(app, FAKE_SITE_KEY)).to.throw(
@@ -67,4 +79,11 @@ describe('api', () => {
       expect(initReCAPTCHAStub).to.have.not.been.called;
     });
   });
+  describe('setTokenAutoRefreshEnabled()', () => {
+    it('sets isTokenAutoRefreshEnabled correctly', () => {
+      const app = getFakeApp({ automaticDataCollectionEnabled: false });
+      setTokenAutoRefreshEnabled(app, true);
+      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(true);
+    });
+  });
 });

packages/app-check/src/api.ts

@@ -24,11 +24,15 @@ import { getState, setState, AppCheckState } from './state';
 /**
  *
  * @param app
- * @param provider - optional custom attestation provider
+ * @param siteKeyOrProvider - optional custom attestation provider
+ * or reCAPTCHA siteKey
+ * @param isTokenAutoRefreshEnabled - if true, enables auto refresh
+ * of appCheck token.
  */
 export function activate(
   app: FirebaseApp,
-  siteKeyOrProvider: string | AppCheckProvider
+  siteKeyOrProvider: string | AppCheckProvider,
+  isTokenAutoRefreshEnabled?: boolean
 ): void {
   const state = getState(app);
   if (state.activated) {
@@ -44,6 +48,14 @@ export function activate(
     newState.customProvider = siteKeyOrProvider;
   }
 
+  // Use value of global `automaticDataCollectionEnabled` (which
+  // itself defaults to false if not specified in config) if
+  // `isTokenAutoRefreshEnabled` param was not provided by user.
+  newState.isTokenAutoRefreshEnabled =
+    isTokenAutoRefreshEnabled === undefined
+      ? app.automaticDataCollectionEnabled
+      : isTokenAutoRefreshEnabled;
+
   setState(app, newState);
 
   // initialize reCAPTCHA if siteKey is provided
@@ -53,3 +65,20 @@ export function activate(
     });
   }
 }
+
+export function setTokenAutoRefreshEnabled(
+  app: FirebaseApp,
+  isTokenAutoRefreshEnabled: boolean
+): void {
+  const state = getState(app);
+  // This will exist if any product libraries have called
+  // `addTokenListener()`
+  if (state.tokenRefresher) {
+    if (isTokenAutoRefreshEnabled === true) {
+      state.tokenRefresher.start();
+    } else {
+      state.tokenRefresher.stop();
+    }
+  }
+  setState(app, { ...state, isTokenAutoRefreshEnabled });
+}

packages/app-check/src/client.test.ts

@@ -19,7 +19,7 @@ import '../test/setup';
 import { expect } from 'chai';
 import { stub, SinonStub, useFakeTimers } from 'sinon';
 import { FirebaseApp } from '@firebase/app-types';
-import { getFakeApp } from '../test/util';
+import { getFakeApp, getFakePlatformLoggingProvider } from '../test/util';
 import { getExchangeRecaptchaTokenRequest, exchangeToken } from './client';
 import { FirebaseError } from '@firebase/util';
 import { ERROR_FACTORY, AppCheckError } from './errors';
@@ -64,12 +64,18 @@ describe('client', () => {
     );
 
     const response = await exchangeToken(
-      getExchangeRecaptchaTokenRequest(app, 'fake-custom-token')
+      getExchangeRecaptchaTokenRequest(app, 'fake-custom-token'),
+      getFakePlatformLoggingProvider('a/1.2.3 fire-app-check/2.3.4')
     );
 
+    expect(
+      (fetchStub.args[0][1]?.['headers'] as any)['X-Firebase-Client']
+    ).to.equal('a/1.2.3 fire-app-check/2.3.4');
+
     expect(response).to.deep.equal({
       token: 'fake-appcheck-token',
-      expireTimeMillis: 3600
+      expireTimeMillis: 3600,
+      issuedAtTimeMillis: 0
     });
   });
 
@@ -85,7 +91,8 @@ describe('client', () => {
 
     try {
       await exchangeToken(
-        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token')
+        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token'),
+        getFakePlatformLoggingProvider()
       );
     } catch (e) {
       expect(e).instanceOf(FirebaseError);
@@ -113,7 +120,8 @@ describe('client', () => {
 
     try {
       await exchangeToken(
-        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token')
+        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token'),
+        getFakePlatformLoggingProvider()
       );
     } catch (e) {
       expect(e).instanceOf(FirebaseError);
@@ -140,7 +148,8 @@ describe('client', () => {
 
     try {
       await exchangeToken(
-        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token')
+        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token'),
+        getFakePlatformLoggingProvider()
       );
     } catch (e) {
       expect(e).instanceOf(FirebaseError);
@@ -173,7 +182,8 @@ describe('client', () => {
 
     try {
       await exchangeToken(
-        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token')
+        getExchangeRecaptchaTokenRequest(app, 'fake-custom-token'),
+        getFakePlatformLoggingProvider()
       );
     } catch (e) {
       expect(e).instanceOf(FirebaseError);

packages/app-check/src/client.ts

@@ -22,8 +22,8 @@ import {
 } from './constants';
 import { FirebaseApp } from '@firebase/app-types';
 import { ERROR_FACTORY, AppCheckError } from './errors';
-import { AppCheckToken } from '@firebase/app-check-types';
-import { version } from '../package.json';
+import { Provider } from '@firebase/component';
+import { AppCheckTokenInternal } from './state';
 
 /**
  * Response JSON returned from AppCheck server endpoint.
@@ -39,18 +39,24 @@ interface AppCheckRequest {
   body: { [key: string]: string };
 }
 
-export async function exchangeToken({
-  url,
-  body
-}: AppCheckRequest): Promise<AppCheckToken> {
-  const options = {
+export async function exchangeToken(
+  { url, body }: AppCheckRequest,
+  platformLoggerProvider: Provider<'platform-logger'>
+): Promise<AppCheckTokenInternal> {
+  const headers: HeadersInit = {
+    'Content-Type': 'application/json'
+  };
+  // If platform logger exists, add the platform info string to the header.
+  const platformLogger = platformLoggerProvider.getImmediate({
+    optional: true
+  });
+  if (platformLogger) {
+    headers['X-Firebase-Client'] = platformLogger.getPlatformInfoString();
+  }
+  const options: RequestInit = {
     method: 'POST',
     body: JSON.stringify(body),
-    headers: {
-      'Content-Type': 'application/json',
-      // JS platform identifier + appCheck version only
-      'X-Firebase-Client': `fire-js/ fire-app-check/${version}`
-    }
+    headers
   };
   let response;
   try {
@@ -89,9 +95,11 @@ export async function exchangeToken({
   }
   const timeToLiveAsNumber = Number(match[1]) * 1000;
 
+  const now = Date.now();
   return {
     token: responseBody.attestationToken,
-    expireTimeMillis: Date.now() + timeToLiveAsNumber
+    expireTimeMillis: now + timeToLiveAsNumber,
+    issuedAtTimeMillis: now
   };
 }
 

packages/app-check/src/factory.ts

@@ -16,26 +16,36 @@
  */
 
 import { FirebaseAppCheck, AppCheckProvider } from '@firebase/app-check-types';
-import { activate } from './api';
+import { activate, setTokenAutoRefreshEnabled } from './api';
 import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
 import {
   getToken,
   addTokenListener,
   removeTokenListener
 } from './internal-api';
+import { Provider } from '@firebase/component';
 
 export function factory(app: FirebaseApp): FirebaseAppCheck {
   return {
-    activate: (siteKeyOrProvider: string | AppCheckProvider) =>
-      activate(app, siteKeyOrProvider)
+    activate: (
+      siteKeyOrProvider: string | AppCheckProvider,
+      isTokenAutoRefreshEnabled?: boolean
+    ) => activate(app, siteKeyOrProvider, isTokenAutoRefreshEnabled),
+    setTokenAutoRefreshEnabled: (isTokenAutoRefreshEnabled: boolean) =>
+      setTokenAutoRefreshEnabled(app, isTokenAutoRefreshEnabled)
   };
 }
 
-export function internalFactory(app: FirebaseApp): FirebaseAppCheckInternal {
+export function internalFactory(
+  app: FirebaseApp,
+  platformLoggerProvider: Provider<'platform-logger'>
+): FirebaseAppCheckInternal {
   return {
-    getToken: forceRefresh => getToken(app, forceRefresh),
-    addTokenListener: listener => addTokenListener(app, listener),
+    getToken: forceRefresh =>
+      getToken(app, platformLoggerProvider, forceRefresh),
+    addTokenListener: listener =>
+      addTokenListener(app, platformLoggerProvider, listener),
     removeTokenListener: listener => removeTokenListener(app, listener)
   };
 }

packages/app-check/src/index.ts

@@ -24,6 +24,7 @@ import {
 import { factory, internalFactory } from './factory';
 import { initializeDebugMode } from './debug';
 import { AppCheckInternalComponentName } from '@firebase/app-check-interop-types';
+import { name, version } from '../package.json';
 
 const APP_CHECK_NAME: AppCheckComponentName = 'appCheck';
 const APP_CHECK_NAME_INTERNAL: AppCheckInternalComponentName =
@@ -49,13 +50,14 @@ function registerAppCheck(firebase: _FirebaseNamespace): void {
       container => {
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();
-        return internalFactory(app);
+        const platformLoggerProvider = container.getProvider('platform-logger');
+        return internalFactory(app, platformLoggerProvider);
       },
       ComponentType.PUBLIC
     )
   );
 
-  // TODO: register AppCheck version with firebase.registerVersion() before BETA. We don't want to report version in EAP
+  firebase.registerVersion(name, version);
 }
 
 registerAppCheck(firebase as _FirebaseNamespace);

packages/app-check/src/indexeddb.ts

@@ -15,9 +15,9 @@
  * limitations under the License.
  */
 
-import { AppCheckToken } from '@firebase/app-check-types';
 import { FirebaseApp } from '@firebase/app-types';
 import { ERROR_FACTORY, AppCheckError } from './errors';
+import { AppCheckTokenInternal } from './state';
 const DB_NAME = 'firebase-app-check-database';
 const DB_VERSION = 1;
 const STORE_NAME = 'firebase-app-check-store';
@@ -74,13 +74,13 @@ function getDBPromise(): Promise<IDBDatabase> {
 
 export function readTokenFromIndexedDB(
   app: FirebaseApp
-): Promise<AppCheckToken | undefined> {
-  return read(computeKey(app)) as Promise<AppCheckToken | undefined>;
+): Promise<AppCheckTokenInternal | undefined> {
+  return read(computeKey(app)) as Promise<AppCheckTokenInternal | undefined>;
 }
 
 export function writeTokenToIndexedDB(
   app: FirebaseApp,
-  token: AppCheckToken
+  token: AppCheckTokenInternal
 ): Promise<void> {
   return write(computeKey(app), token);
 }