Add CustomProvider public class

Author: hsubox76

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

@@ -5,10 +5,6 @@
 ```ts
 
 import { FirebaseApp } from '@firebase/app-exp';
-import { Provider } from '@firebase/component';
-
-// @internal
-export function _activate(app: FirebaseApp, provider: AppCheckProvider, platformLoggerProvider: Provider<'platform-logger'>, isTokenAutoRefreshEnabled?: boolean): void;
 
 // @public
 export interface AppCheck {
@@ -29,7 +25,7 @@ export interface AppCheckOptions {
 
 // @public
 export interface AppCheckProvider {
-    getToken(): Promise<AppCheckToken>;
+    getToken: () => Promise<AppCheckToken>;
 }
 
 // @public
@@ -39,18 +35,31 @@ export interface AppCheckToken {
     readonly token: string;
 }
 
+// @public
+export class CustomProvider implements AppCheckProvider {
+    constructor(_customProviderOptions: CustomProviderOptions);
+    // @internal (undocumented)
+    getToken(): Promise<AppCheckToken>;
+    // @internal (undocumented)
+    initialize(app: FirebaseApp): void;
+}
+
+// @public
+export interface CustomProviderOptions {
+    getToken(): Promise<AppCheckToken>;
+}
+
 // @public
 export function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
 
 // @public
 export class ReCaptchaV3Provider implements AppCheckProvider {
-    constructor(siteKey: string);
-    // Warning: (ae-forgotten-export) The symbol "ReCaptchaV3ProviderImpl" needs to be exported by the entry point index.d.ts
-    //
-    // @internal (undocumented)
-    _delegate: ReCaptchaV3ProviderImpl;
+    constructor(_siteKey: string);
+    // @internal
     getToken(): Promise<AppCheckToken>;
-}
+    // @internal (undocumented)
+    initialize(app: FirebaseApp): void;
+    }
 
 // @public
 export function setTokenAutoRefreshEnabled(app: FirebaseApp, isTokenAutoRefreshEnabled: boolean): void;

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

@@ -17,56 +17,23 @@
 import '../test/setup';
 import { expect } from 'chai';
 import { stub } from 'sinon';
-import {
-  _activate as activate,
-  setTokenAutoRefreshEnabled,
-  initializeAppCheck
-} from './api';
+import { setTokenAutoRefreshEnabled, initializeAppCheck } from './api';
 import {
   FAKE_SITE_KEY,
+  getFullApp,
   getFakeApp,
-  getFakeCustomTokenProvider,
-  getFakePlatformLoggingProvider
+  getFakeCustomTokenProvider
 } from '../test/util';
 import { getState } from './state';
 import * as reCAPTCHA from './recaptcha';
-import {
-  deleteApp,
-  FirebaseApp,
-  initializeApp,
-  _registerComponent
-} from '@firebase/app-exp';
-import { Component, ComponentType } from '@firebase/component';
-import { AppCheckService } from './factory';
+import { deleteApp, FirebaseApp } from '@firebase/app-exp';
 import { ReCaptchaV3Provider } from './providers';
-import { PlatformLoggerService } from '@firebase/app-exp/dist/packages-exp/app-exp/src/types';
 
 describe('api', () => {
   let app: FirebaseApp;
 
   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
-      )
-    );
+    app = getFullApp();
   });
 
   afterEach(() => {
@@ -107,42 +74,29 @@ describe('api', () => {
       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()
-      );
+      initializeAppCheck(app, {
+        provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
+      });
       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()
-      );
+      initializeAppCheck(app, {
+        provider: new ReCaptchaV3Provider(FAKE_SITE_KEY)
+      });
       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
-      );
+      initializeAppCheck(app, {
+        provider: new ReCaptchaV3Provider(FAKE_SITE_KEY),
+        isTokenAutoRefreshEnabled: true
+      });
       expect(getState(app).isTokenAutoRefreshEnabled).to.equal(true);
     });
   });

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

@@ -15,15 +15,13 @@
  * limitations under the License.
  */
 
-import { AppCheck, AppCheckOptions, AppCheckProvider } from './public-types';
+import { AppCheck, AppCheckOptions } 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 { getModularInstance } from '@firebase/util';
 import { AppCheckService } from './factory';
-import { ReCaptchaV3Provider } from './providers';
-import { Provider } from '@firebase/component';
+import { AppCheckProviderInternal } from './types';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
@@ -43,7 +41,6 @@ export function initializeAppCheck(
 ): 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, {
@@ -54,8 +51,7 @@ export function initializeAppCheck(
   const appCheck = provider.initialize({ options });
   _activate(
     app,
-    options.provider,
-    platformLoggerProvider,
+    options.provider as AppCheckProviderInternal,
     options.isTokenAutoRefreshEnabled
   );
 
@@ -74,10 +70,9 @@ export function initializeAppCheck(
  *
  * @internal
  */
-export function _activate(
+function _activate(
   app: FirebaseApp,
-  provider: AppCheckProvider,
-  platformLoggerProvider: Provider<'platform-logger'>,
+  provider: AppCheckProviderInternal,
   isTokenAutoRefreshEnabled?: boolean
 ): void {
   const state = getState(app);
@@ -95,17 +90,9 @@ export function _activate(
 
   setState(app, newState);
 
-  // initialize reCAPTCHA if siteKey is provided
-  if (newState.provider instanceof ReCaptchaV3Provider) {
-    const providerImpl = newState.provider._delegate;
-    setState(app, { ...newState, provider: providerImpl });
-    // These need to be injected for ReCaptchaV3Provider's getToken() to work.
-    providerImpl.initialize(app, platformLoggerProvider);
-    initializeRecaptcha(app, providerImpl.siteKey).catch(() => {
-      /* we don't care about the initialization result in activate() */
-    });
-  }
+  (newState.provider as AppCheckProviderInternal).initialize(app);
 }
+
 /**
  * Set whether App Check will automatically refresh tokens as needed.
  *

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

@@ -23,7 +23,7 @@ import {
 import { FirebaseApp } from '@firebase/app-exp';
 import { ERROR_FACTORY, AppCheckError } from './errors';
 import { Provider } from '@firebase/component';
-import { AppCheckTokenInternal } from './state';
+import { AppCheckTokenInternal } from './types';
 
 /**
  * Response JSON returned from AppCheck server endpoint.

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

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

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

@@ -17,7 +17,7 @@
 
 import { FirebaseApp } from '@firebase/app-exp';
 import { ERROR_FACTORY, AppCheckError } from './errors';
-import { AppCheckTokenInternal } from './state';
+import { AppCheckTokenInternal } from './types';
 const DB_NAME = 'firebase-app-check-database';
 const DB_VERSION = 1;
 const STORE_NAME = 'firebase-app-check-store';