Adding app-check entry point

angular · jamesdaniels · Sep 11, 2021 · Sep 10, 2021 · Sep 11, 2021 · Sep 11, 2021
commit 0f70c554297069c39e15deaef95bae3501b75a42
diff --git a/src/app-check/app-check.module.ts b/src/app-check/app-check.module.ts
@@ -0,0 +1,65 @@
+import { NgModule, Optional, NgZone, InjectionToken, ModuleWithProviders, PLATFORM_ID } from '@angular/core';
+import { AppCheck as FirebaseAppCheck } from 'firebase/app-check';
+import { ɵgetDefaultInstanceOf, ɵmemoizeInstance, ɵAngularFireSchedulers, VERSION } from '@angular/fire';
+import { AppCheck, AppCheckInstances, APP_CHECK_PROVIDER_NAME } from './app-check';
+import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
+import { registerVersion } from 'firebase/app';
+
+export const PROVIDED_APP_CHECK_INSTANCES = new InjectionToken<AppCheck[]>('angularfire2.app-check-instances');
+
+export function defaultAppCheckInstanceFactory(provided: FirebaseAppCheck[]|undefined, defaultApp: FirebaseApp) {
+  const defaultAppCheck = ɵgetDefaultInstanceOf<FirebaseAppCheck>(APP_CHECK_PROVIDER_NAME, provided, defaultApp);
+  return new AppCheck(defaultAppCheck);
+}
+
+export function appCheckInstanceFactory(fn: () => FirebaseAppCheck) {
+  return (zone: NgZone) => {
+    return ɵmemoizeInstance<FirebaseAppCheck>(fn, zone);
+  };
+}
+
+const APP_CHECK_INSTANCES_PROVIDER = {
+  provide: AppCheckInstances,
+  deps: [
+    [new Optional(), PROVIDED_APP_CHECK_INSTANCES ],
+  ]
+};
+
+const DEFAULT_APP_CHECK_INSTANCE_PROVIDER = {
+  provide: AppCheck,
+  useFactory: defaultAppCheckInstanceFactory,
+  deps: [
+    [new Optional(), PROVIDED_APP_CHECK_INSTANCES ],
+    FirebaseApp,
+    PLATFORM_ID,
+  ]
+};
+
+@NgModule({
+  providers: [
+    DEFAULT_APP_CHECK_INSTANCE_PROVIDER,
+    APP_CHECK_INSTANCES_PROVIDER,
+  ]
+})
+export class AppCheckModule {
+  constructor() {
+    registerVersion('angularfire', VERSION.full, 'app-check');
+  }
+}
+
+export function provideAppCheck(fn: () => FirebaseAppCheck): ModuleWithProviders<AppCheckModule> {
+  return {
+    ngModule: AppCheckModule,
+    providers: [{
+      provide: PROVIDED_APP_CHECK_INSTANCES,
+      useFactory: appCheckInstanceFactory(fn),
+      multi: true,
+      deps: [
+        NgZone,
+        PLATFORM_ID,
+        ɵAngularFireSchedulers,
+        FirebaseApps,
+      ]
+    }]
+  };
+}
diff --git a/src/app-check/app-check.ts b/src/app-check/app-check.ts
@@ -0,0 +1,31 @@
+import { AppCheck as FirebaseAppCheck } from 'firebase/app-check';
+import { ɵgetAllInstancesOf } from '@angular/fire';
+import { from, timer } from 'rxjs';
+import { concatMap, distinct } from 'rxjs/operators';
+
+export const APP_CHECK_PROVIDER_NAME = 'app-check';
+
+// see notes in core/firebase.app.module.ts for why we're building the class like this
+// tslint:disable-next-line:no-empty-interface
+export interface AppCheck extends FirebaseAppCheck {}
+
+export class AppCheck {
+  constructor(appCheck: FirebaseAppCheck) {
+    return appCheck;
+  }
+}
+
+// tslint:disable-next-line:no-empty-interface
+export interface AppCheckInstances extends Array<FirebaseAppCheck> {}
+
+export class AppCheckInstances {
+  // tslint:disable-next-line:ban-types
+  constructor() {
+    return ɵgetAllInstancesOf<FirebaseAppCheck>(APP_CHECK_PROVIDER_NAME);
+  }
+}
+
+export const appCheckInstance$ = timer(0, 300).pipe(
+  concatMap(() => from(ɵgetAllInstancesOf<FirebaseAppCheck>(APP_CHECK_PROVIDER_NAME))),
+  distinct(),
+);
diff --git a/src/app-check/firebase.ts b/src/app-check/firebase.ts
diff --git a/src/app-check/package.json b/src/app-check/package.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "../../node_modules/ng-packagr/package.schema.json",
+  "ngPackage": {
+    "lib": {
+      "umdModuleIds": {
+        "firebase/app-check": "firebase-app-check"
+      },
+      "entryFile": "public_api.ts"
+    }
+  }
+}
diff --git a/src/app-check/public_api.ts b/src/app-check/public_api.ts
@@ -0,0 +1,3 @@
+export { AppCheck, AppCheckInstances, appCheckInstance$ } from './app-check';
+export { provideAppCheck, AppCheckModule } from './app-check.module';
+export * from './firebase';
diff --git a/src/auth/auth.module.ts b/src/auth/auth.module.ts
@@ -4,6 +4,7 @@ import { ɵgetDefaultInstanceOf, ɵmemoizeInstance, ɵAngularFireSchedulers, VER
 import { Auth, AuthInstances, AUTH_PROVIDER_NAME } from './auth';
 import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
 import { registerVersion } from 'firebase/app';
+import { AppCheckInstances } from '@angular/fire/app-check';
 
 export const PROVIDED_AUTH_INSTANCES = new InjectionToken<Auth[]>('angularfire2.auth-instances');
 
@@ -59,6 +60,7 @@ export function provideAuth(fn: () => FirebaseAuth): ModuleWithProviders<AuthMod
         PLATFORM_ID,
         ɵAngularFireSchedulers,
         FirebaseApps,
+        [new Optional(), AppCheckInstances ],
       ]
     }]
   };

diff --git a/src/database/database.module.ts b/src/database/database.module.ts
@@ -1,11 +1,11 @@
 import { NgModule, Optional, NgZone, InjectionToken, ModuleWithProviders } from '@angular/core';
 import { Database as FirebaseDatabase } from 'firebase/database';
-
 import { AuthInstances } from '@angular/fire/auth';
 import { ɵgetDefaultInstanceOf, ɵmemoizeInstance, ɵAngularFireSchedulers, VERSION } from '@angular/fire';
 import { Database, DatabaseInstances, DATABASE_PROVIDER_NAME } from './database';
 import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
 import { registerVersion } from 'firebase/app';
+import { AppCheckInstances } from '@angular/fire/app-check';
 
 export const PROVIDED_DATABASE_INSTANCES = new InjectionToken<Database[]>('angularfire2.database-instances');
 
@@ -62,6 +62,7 @@ export function provideDatabase(fn: () => FirebaseDatabase): ModuleWithProviders
         FirebaseApps,
         // Database+Auth work better if Auth is loaded first
         [new Optional(), AuthInstances ],
+        [new Optional(), AppCheckInstances ],
       ]
     }]
   };

diff --git a/src/firestore/firestore.module.ts b/src/firestore/firestore.module.ts
@@ -5,6 +5,7 @@ import { ɵmemoizeInstance, ɵgetDefaultInstanceOf, ɵAngularFireSchedulers, VER
 import { Firestore, FirestoreInstances, FIRESTORE_PROVIDER_NAME } from './firestore';
 import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
 import { registerVersion } from 'firebase/app';
+import { AppCheckInstances } from '@angular/fire/app-check';
 
 export const PROVIDED_FIRESTORE_INSTANCES = new InjectionToken<Firestore[]>('angularfire2.firestore-instances');
 
@@ -63,6 +64,7 @@ export function provideFirestore(fn: () => FirebaseFirestore): ModuleWithProvide
         FirebaseApps,
         // Firestore+Auth work better if Auth is loaded first
         [new Optional(), AuthInstances ],
+        [new Optional(), AppCheckInstances ],
       ]
     }]
   };

diff --git a/src/functions/functions.module.ts b/src/functions/functions.module.ts
@@ -5,6 +5,7 @@ import { Functions, FunctionsInstances, FUNCTIONS_PROVIDER_NAME } from './functi
 import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
 import { AuthInstances } from '@angular/fire/auth';
 import { registerVersion } from 'firebase/app';
+import { AppCheckInstances } from '@angular/fire/app-check';
 
 export const PROVIDED_FUNCTIONS_INSTANCES = new InjectionToken<Functions[]>('angularfire2.functions-instances');
 
@@ -61,6 +62,7 @@ export function provideFunctions(fn: () => FirebaseFunctions): ModuleWithProvide
         FirebaseApps,
         // Defensively load Auth first, if provided
         [new Optional(), AuthInstances ],
+        [new Optional(), AppCheckInstances ],
       ]
     }]
   };

diff --git a/src/storage/storage.module.ts b/src/storage/storage.module.ts
@@ -5,6 +5,7 @@ import { Storage, StorageInstances, STORAGE_PROVIDER_NAME } from './storage';
 import { FirebaseApps, FirebaseApp } from '@angular/fire/app';
 import { AuthInstances } from '@angular/fire/auth';
 import { registerVersion } from 'firebase/app';
+import { AppCheckInstances } from '@angular/fire/app-check';
 
 export const PROVIDED_STORAGE_INSTANCES = new InjectionToken<Storage[]>('angularfire2.storage-instances');
 
@@ -61,6 +62,7 @@ export function provideStorage(fn: () => FirebaseStorage): ModuleWithProviders<S
         FirebaseApps,
         // Defensively load Auth first, if provided
         [new Optional(), AuthInstances ],
+        [new Optional(), AppCheckInstances ],
       ]
     }]
   };

diff --git a/tools/build.ts b/tools/build.ts
@@ -9,7 +9,7 @@ import * as glob from 'glob';
 
 // TODO infer these from the package.json
 const MODULES = [
-  'core', 'app', 'compat', 'analytics', 'auth', 'database', 'firestore', 'functions',
+  'core', 'app', 'app-check', 'compat', 'analytics', 'auth', 'database', 'firestore', 'functions',
   'remote-config', 'storage', 'messaging', 'performance', 'compat/analytics',
   'compat/auth-guard', 'compat/auth', 'compat/database', 'compat/firestore',
   'compat/functions', 'compat/remote-config', 'compat/storage', 'compat/messaging',
@@ -60,6 +60,7 @@ ${zoneWrapped.map(([importName, exportName]) => `export const ${exportName} = ɵ
   return Promise.all([
     reexport('analytics', 'firebase', 'firebase/analytics', tsKeys<typeof import('firebase/analytics')>()),
     reexport('app', 'firebase', 'firebase/app', tsKeys<typeof import('firebase/app')>()),
+    reexport('app-check', 'firebase', 'firebase/app-check', tsKeys<typeof import('firebase/app-check')>()),
     reexport('auth', 'rxfire', 'rxfire/auth', tsKeys<typeof import('rxfire/auth')>()),
     reexport('auth', 'firebase', 'firebase/auth', tsKeys<typeof import('firebase/auth')>(), {
       debugErrorMap: null,