Add isTokenAutoRefreshEnabled setting

Author: hsubox76

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/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/factory.ts

@@ -16,7 +16,7 @@
  */
 
 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 {
@@ -28,8 +28,12 @@ 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)
   };
 }
 

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

@@ -295,6 +295,7 @@ describe('internal api', () => {
 
     it('starts proactively refreshing token after adding the first listener', () => {
       const listener = (): void => {};
+      setState(app, { ...getState(app), isTokenAutoRefreshEnabled: true });
       expect(getState(app).tokenListeners.length).to.equal(0);
       expect(getState(app).tokenRefresher).to.equal(undefined);
 
@@ -389,6 +390,7 @@ describe('internal api', () => {
 
     it('should stop proactively refreshing token after deleting the last listener', () => {
       const listener = (): void => {};
+      setState(app, { ...getState(app), isTokenAutoRefreshEnabled: true });
 
       addTokenListener(app, fakePlatformLoggingProvider, listener);
       expect(getState(app).tokenListeners.length).to.equal(1);

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

@@ -183,7 +183,12 @@ export function addTokenListener(
       newState.tokenRefresher = tokenRefresher;
     }
 
-    if (!newState.tokenRefresher.isRunning()) {
+    // Create the refresher but don't start it if `isTokenAutoRefreshEnabled`
+    // is not true.
+    if (
+      !newState.tokenRefresher.isRunning() &&
+      state.isTokenAutoRefreshEnabled === true
+    ) {
       newState.tokenRefresher.start();
     }
 

packages/app-check/src/state.ts

@@ -29,6 +29,7 @@ export interface AppCheckState {
   token?: AppCheckToken;
   tokenRefresher?: Refresher;
   reCAPTCHAState?: ReCAPTCHAState;
+  isTokenAutoRefreshEnabled?: boolean;
 }
 
 export interface ReCAPTCHAState {

packages/app-check/test/util.ts

@@ -27,7 +27,7 @@ import {
 
 export const FAKE_SITE_KEY = 'fake-site-key';
 
-export function getFakeApp(): FirebaseApp {
+export function getFakeApp(overrides: Record<string, any> = {}): FirebaseApp {
   return {
     name: 'appName',
     options: {
@@ -43,7 +43,8 @@ export function getFakeApp(): FirebaseApp {
     delete: async () => {},
     // This won't be used in tests.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    appCheck: null as any
+    appCheck: null as any,
+    ...overrides
   };
 }