Fix up tests

Author: hsubox76

common/api-review/app-check-exp.api.md

@@ -6,9 +6,6 @@
 
 import { FirebaseApp } from '@firebase/app-exp';
 
-// @public
-export function activate(app: FirebaseApp, siteKeyOrProvider: string | AppCheckProvider, isTokenAutoRefreshEnabled?: boolean): void;
-
 // @public
 export interface AppCheck {
     app: FirebaseApp;
@@ -20,6 +17,12 @@ export type _AppCheckComponentName = 'app-check-exp';
 // @internal (undocumented)
 export type _AppCheckInternalComponentName = 'app-check-internal';
 
+// @public
+export interface AppCheckOptions {
+    isTokenAutoRefreshEnabled?: boolean;
+    provider: AppCheckProvider;
+}
+
 // @public
 export interface AppCheckProvider {
     getToken(): Promise<AppCheckToken>;
@@ -33,7 +36,13 @@ export interface AppCheckToken {
 }
 
 // @public
-export function getAppCheck(app?: FirebaseApp): AppCheck;
+export function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
+
+// @public
+export class ReCaptchaV3Provider implements AppCheckProvider {
+    constructor(siteKey: string);
+    getToken(): Promise<AppCheckToken>;
+}
 
 // @public
 export function setTokenAutoRefreshEnabled(app: FirebaseApp, isTokenAutoRefreshEnabled: boolean): void;

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

@@ -17,54 +17,81 @@
 import '../test/setup';
 import { expect } from 'chai';
 import { stub } from 'sinon';
-import { activate, setTokenAutoRefreshEnabled } from './api';
+import {
+  _activate as activate,
+  setTokenAutoRefreshEnabled,
+  initializeAppCheck
+} from './api';
 import {
   FAKE_SITE_KEY,
   getFakeApp,
-  getFakeCustomTokenProvider
+  getFakeCustomTokenProvider,
+  getFakePlatformLoggingProvider
 } from '../test/util';
 import { getState } from './state';
 import * as reCAPTCHA from './recaptcha';
-import { FirebaseApp } from '@firebase/app-exp';
+import {
+  deleteApp,
+  FirebaseApp,
+  initializeApp,
+  _registerComponent
+} from '@firebase/app-exp';
+import { Component, ComponentType } from '@firebase/component';
+import { AppCheckService } from './factory';
+import { ReCaptchaV3Provider } from './providers';
+import { PlatformLoggerService } from '@firebase/app-exp/dist/packages-exp/app-exp/src/types';
 
 describe('api', () => {
-  describe('activate()', () => {
-    let app: FirebaseApp;
-
-    beforeEach(() => {
-      app = getFakeApp();
-    });
-
-    it('sets activated to true', () => {
-      expect(getState(app).activated).to.equal(false);
-      activate(app, FAKE_SITE_KEY);
-      expect(getState(app).activated).to.equal(true);
-    });
+  let app: FirebaseApp;
 
-    it('isTokenAutoRefreshEnabled value defaults to global setting', () => {
-      app = getFakeApp({ automaticDataCollectionEnabled: false });
-      activate(app, FAKE_SITE_KEY);
-      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(false);
-    });
+  beforeEach(() => {
+    app = initializeApp(
+      { apiKey: 'fdsa', appId: 'fdsafg' },
+      'initializeAppCheckTests'
+    );
+    _registerComponent(
+      new Component(
+        'platform-logger',
+        () => {
+          return {} as PlatformLoggerService;
+        },
+        ComponentType.PUBLIC
+      )
+    );
+    _registerComponent(
+      new Component(
+        'app-check-exp',
+        () => {
+          return {} as AppCheckService;
+        },
+        ComponentType.PUBLIC
+      )
+    );
+  });
 
-    it('sets isTokenAutoRefreshEnabled correctly, overriding global setting', () => {
-      app = getFakeApp({ automaticDataCollectionEnabled: false });
-      activate(app, FAKE_SITE_KEY, true);
-      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(true);
-    });
+  afterEach(() => {
+    return deleteApp(app);
+  });
 
+  describe('initializeAppCheck()', () => {
     it('can only be called once', () => {
-      activate(app, FAKE_SITE_KEY);
-      expect(() => activate(app, FAKE_SITE_KEY)).to.throw(
-        /AppCheck can only be activated once/
-      );
+      initializeAppCheck(app, {
+        provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
+      });
+      expect(() =>
+        initializeAppCheck(app, {
+          provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
+        })
+      ).to.throw(/appCheck\/already-initialized/);
     });
 
     it('initialize reCAPTCHA when a sitekey is provided', () => {
       const initReCAPTCHAStub = stub(reCAPTCHA, 'initialize').returns(
         Promise.resolve({} as any)
       );
-      activate(app, FAKE_SITE_KEY);
+      initializeAppCheck(app, {
+        provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
+      });
       expect(initReCAPTCHAStub).to.have.been.calledWithExactly(
         app,
         FAKE_SITE_KEY
@@ -74,11 +101,51 @@ describe('api', () => {
     it('does NOT initialize reCAPTCHA when a custom token provider is provided', () => {
       const fakeCustomTokenProvider = getFakeCustomTokenProvider();
       const initReCAPTCHAStub = stub(reCAPTCHA, 'initialize');
-      activate(app, fakeCustomTokenProvider);
-      expect(getState(app).customProvider).to.equal(fakeCustomTokenProvider);
+      initializeAppCheck(app, {
+        provider: fakeCustomTokenProvider
+      });
+      expect(getState(app).provider).to.equal(fakeCustomTokenProvider);
       expect(initReCAPTCHAStub).to.have.not.been.called;
     });
   });
+  describe('activate()', () => {
+    let app: FirebaseApp;
+
+    beforeEach(() => {
+      app = getFakeApp();
+    });
+
+    it('sets activated to true', () => {
+      expect(getState(app).activated).to.equal(false);
+      activate(
+        app,
+        new ReCaptchaV3Provider(FAKE_SITE_KEY),
+        getFakePlatformLoggingProvider()
+      );
+      expect(getState(app).activated).to.equal(true);
+    });
+
+    it('isTokenAutoRefreshEnabled value defaults to global setting', () => {
+      app.automaticDataCollectionEnabled = false;
+      activate(
+        app,
+        new ReCaptchaV3Provider(FAKE_SITE_KEY),
+        getFakePlatformLoggingProvider()
+      );
+      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(false);
+    });
+
+    it('sets isTokenAutoRefreshEnabled correctly, overriding global setting', () => {
+      app.automaticDataCollectionEnabled = false;
+      activate(
+        app,
+        new ReCaptchaV3Provider(FAKE_SITE_KEY),
+        getFakePlatformLoggingProvider(),
+        true
+      );
+      expect(getState(app).isTokenAutoRefreshEnabled).to.equal(true);
+    });
+  });
   describe('setTokenAutoRefreshEnabled()', () => {
     it('sets isTokenAutoRefreshEnabled correctly', () => {
       const app = getFakeApp({ automaticDataCollectionEnabled: false });

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

@@ -15,14 +15,15 @@
  * limitations under the License.
  */
 
-import { AppCheck, AppCheckProvider } from './public-types';
+import { AppCheck, AppCheckOptions, AppCheckProvider } from './public-types';
 import { ERROR_FACTORY, AppCheckError } from './errors';
 import { initialize as initializeRecaptcha } from './recaptcha';
 import { getState, setState, AppCheckState } from './state';
 import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
-import { Provider } from '@firebase/component';
 import { getModularInstance } from '@firebase/util';
 import { AppCheckService } from './factory';
+import { ReCaptchaV3Provider } from './providers';
+import { Provider } from '@firebase/component';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
@@ -31,37 +32,18 @@ declare module '@firebase/component' {
 }
 
 /**
- * Returns a Firebase AppCheck instance for the given app.
- *
+ * Activate AppCheck for the given app. Can be called only once per app.
+ * @param app - the FirebaseApp to activate AppCheck for
+ * @param options - Provider implementation that can return an AppCheck token
  * @public
- *
- * @param app - The FirebaseApp to use.
  */
-export function getAppCheck(app: FirebaseApp = getApp()): AppCheck {
-  app = getModularInstance(app);
-  // Dependencies
-  const appCheckProvider: Provider<'app-check-exp'> = _getProvider(
-    app,
-    'app-check-exp'
-  );
-
-  if (appCheckProvider.isInitialized()) {
-    return appCheckProvider.getImmediate();
-  }
-  return initializeAppCheck(app);
-}
-
-interface AppCheckOptions {
-  provider: AppCheckProvider;
-  isTokenAutoRefreshEnabled?: boolean;
-}
-
 export function initializeAppCheck(
   app: FirebaseApp = getApp(),
-  options?: AppCheckOptions
+  options: AppCheckOptions
 ): AppCheck {
   app = getModularInstance(app);
   const provider = _getProvider(app, 'app-check-exp');
+  const platformLoggerProvider = _getProvider(app, 'platform-logger');
 
   if (provider.isInitialized()) {
     throw ERROR_FACTORY.create(AppCheckError.ALREADY_INITIALIZED, {
@@ -70,39 +52,38 @@ export function initializeAppCheck(
   }
 
   const appCheck = provider.initialize({ options });
+  _activate(
+    app,
+    options.provider,
+    platformLoggerProvider,
+    options.isTokenAutoRefreshEnabled
+  );
 
   return appCheck;
 }
 
 /**
  * Activate AppCheck
  * @param app - Firebase app to activate AppCheck for.
- * @param siteKeyOrProvider - reCAPTCHA v3 site key (public key) or
+ * @param provider - reCAPTCHA v3 provider or
  * custom token provider.
  * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
  * refreshes App Check tokens as needed. If undefined, defaults to the
  * value of `app.automaticDataCollectionEnabled`, which defaults to
  * false and can be set in the app config.
- * @public
+ *
+ * @internal
  */
-export function activate(
+export function _activate(
   app: FirebaseApp,
-  siteKeyOrProvider: string | AppCheckProvider,
+  provider: AppCheckProvider,
+  platformLoggerProvider: Provider<'platform-logger'>,
   isTokenAutoRefreshEnabled?: boolean
 ): void {
   const state = getState(app);
-  if (state.activated) {
-    throw ERROR_FACTORY.create(AppCheckError.ALREADY_ACTIVATED, {
-      appName: app.name
-    });
-  }
 
   const newState: AppCheckState = { ...state, activated: true };
-  if (typeof siteKeyOrProvider === 'string') {
-    newState.siteKey = siteKeyOrProvider;
-  } else {
-    newState.customProvider = siteKeyOrProvider;
-  }
+  newState.provider = provider;
 
   // Use value of global `automaticDataCollectionEnabled` (which
   // itself defaults to false if not specified in config) if
@@ -115,8 +96,10 @@ export function activate(
   setState(app, newState);
 
   // initialize reCAPTCHA if siteKey is provided
-  if (newState.siteKey) {
-    initializeRecaptcha(app, newState.siteKey).catch(() => {
+  if (newState.provider instanceof ReCaptchaV3Provider) {
+    // These need to be injected for ReCaptchaV3Provider's getToken() to work.
+    newState.provider.initialize(app, platformLoggerProvider);
+    initializeRecaptcha(app, newState.provider.siteKey).catch(() => {
       /* we don't care about the initialization result in activate() */
     });
   }
@@ -126,7 +109,7 @@ export function activate(
  *
  * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
  * refreshes App Check tokens as needed. This overrides any value set
- * during `activate()`.
+ * during `initializeAppCheck()`.
  * @public
  */
 export function setTokenAutoRefreshEnabled(

packages-exp/app-check-exp/src/errors.ts

@@ -18,7 +18,6 @@
 import { ErrorFactory, ErrorMap } from '@firebase/util';
 
 export const enum AppCheckError {
-  ALREADY_ACTIVATED = 'already-activated',
   ALREADY_INITIALIZED = 'already-initialized',
   USE_BEFORE_ACTIVATION = 'use-before-activation',
   FETCH_NETWORK_ERROR = 'fetch-network-error',
@@ -31,16 +30,12 @@ export const enum AppCheckError {
 }
 
 const ERRORS: ErrorMap<AppCheckError> = {
-  [AppCheckError.ALREADY_ACTIVATED]:
-    'You are trying to activate AppCheck for FirebaseApp {$appName}, ' +
-    'while it is already activated. ' +
-    'AppCheck can only be activated once.',
   [AppCheckError.ALREADY_INITIALIZED]:
     'You have already called initializeAppCheck() for FirebaseApp {$appName}, ' +
     'initializeAppCheck() can only be called once.',
   [AppCheckError.USE_BEFORE_ACTIVATION]:
-    'AppCheck is being used before activate() is called for FirebaseApp {$appName}. ' +
-    'Please make sure you call activate() before instantiating other Firebase services.',
+    'AppCheck is being used before initializeAppCheck() is called for FirebaseApp {$appName}. ' +
+    'Please make sure you call initializeAppCheck() before instantiating other Firebase services.',
   [AppCheckError.FETCH_NETWORK_ERROR]:
     'Fetch failed to connect to a network. Check Internet connection. ' +
     'Original error: {$originalErrorMessage}.',
@@ -59,7 +54,6 @@ const ERRORS: ErrorMap<AppCheckError> = {
 };
 
 interface ErrorParams {
-  [AppCheckError.ALREADY_ACTIVATED]: { appName: string };
   [AppCheckError.ALREADY_INITIALIZED]: { appName: string };
   [AppCheckError.USE_BEFORE_ACTIVATION]: { appName: string };
   [AppCheckError.FETCH_NETWORK_ERROR]: { originalErrorMessage: string };

packages-exp/app-check-exp/src/index.ts

@@ -27,6 +27,7 @@ export { _AppCheckInternalComponentName };
 
 export * from './api';
 export * from './public-types';
+export * from './providers';
 
 const APP_CHECK_NAME: _AppCheckComponentName = 'app-check-exp';
 const APP_CHECK_NAME_INTERNAL: _AppCheckInternalComponentName =