feat: provide real standalone providers (#3503)

* feat: provide real standalone providers usage before `importProvidersFrom(provideFirebaseApp(() => initializeApp(...)))` usage now `provideFirebaseApp(() => initializeApp(...))` * test: fixed failed tests * fix: update the missed lite.module.ts
angular · May 14, 2024 · 4d322f9 · 4d322f9
1 parent 35ab9cc
commit 4d322f9
Show file tree

Hide file tree

Showing 25 changed files with 249 additions and 103 deletions.
diff --git a/src/analytics/analytics.module.ts b/src/analytics/analytics.module.ts
@@ -1,4 +1,13 @@
-import { APP_INITIALIZER, InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional } from '@angular/core';
+import {
+  APP_INITIALIZER,
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
 import { Analytics as FirebaseAnalytics } from 'firebase/analytics';
@@ -60,10 +69,18 @@ export class AnalyticsModule {
   }
 }
 
-export function provideAnalytics(fn: (injector: Injector) => FirebaseAnalytics, ...deps: any[]): ModuleWithProviders<AnalyticsModule> {
-  return {
-    ngModule: AnalyticsModule,
-    providers: [{
+export function provideAnalytics(fn: (injector: Injector) => FirebaseAnalytics, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'analytics');
+
+  return makeEnvironmentProviders([
+    DEFAULT_ANALYTICS_INSTANCE_PROVIDER,
+    ANALYTICS_INSTANCES_PROVIDER,
+    {
+      provide: APP_INITIALIZER,
+      useValue: isAnalyticsSupportedFactory.async,
+      multi: true,
+    },
+    {
       provide: PROVIDED_ANALYTICS_INSTANCES,
       useFactory: analyticsInstanceFactory(fn),
       multi: true,
@@ -73,7 +90,7 @@ export function provideAnalytics(fn: (injector: Injector) => FirebaseAnalytics,
         ɵAngularFireSchedulers,
         FirebaseApps,
         ...deps,
-      ]
-    }]
-  };
+      ],
+    },
+  ]);
 }
diff --git a/src/analytics/analytics.spec.ts b/src/analytics/analytics.spec.ts
@@ -23,7 +23,7 @@ describe('Analytics', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG_TOO, appName)),
                 provideAnalytics(() => {
                     providedAnalytics = getAnalytics(getApp(appName));

diff --git a/src/app-check/app-check.module.ts b/src/app-check/app-check.module.ts
@@ -1,5 +1,15 @@
 import { isPlatformServer } from '@angular/common';
-import { InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional, PLATFORM_ID, isDevMode } from '@angular/core';
+import {
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  PLATFORM_ID,
+  isDevMode,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAPP_CHECK_PROVIDER_NAME, ɵAngularFireSchedulers, ɵAppCheckInstances, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
 import { registerVersion } from 'firebase/app';
@@ -56,10 +66,12 @@ export class AppCheckModule {
   }
 }
 
-export function provideAppCheck(fn: (injector: Injector) => FirebaseAppCheck, ...deps: any[]): ModuleWithProviders<AppCheckModule> {
-  return {
-    ngModule: AppCheckModule,
-    providers: [{
+export function provideAppCheck(fn: (injector: Injector) => FirebaseAppCheck, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'app-check');
+  return makeEnvironmentProviders([
+    DEFAULT_APP_CHECK_INSTANCE_PROVIDER,
+    APP_CHECK_INSTANCES_PROVIDER,
+    {
       provide: PROVIDED_APP_CHECK_INSTANCES,
       useFactory: appCheckInstanceFactory(fn),
       multi: true,
@@ -71,6 +83,6 @@ export function provideAppCheck(fn: (injector: Injector) => FirebaseAppCheck, ..
         FirebaseApps,
         ...deps,
       ]
-    }]
-  };
+    }
+  ]);
 }
diff --git a/src/app-check/app-check.spec.ts b/src/app-check/app-check.spec.ts
@@ -15,7 +15,7 @@ describe('Auth', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+          providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
                 provideAuth(() => {
                     providedAuth = getAuth(getApp(appName));

diff --git a/src/app/app.module.ts b/src/app/app.module.ts
@@ -1,13 +1,14 @@
 import {
+  EnvironmentProviders,
   Inject,
   InjectionToken,
   Injector,
-  ModuleWithProviders,
   VERSION as NG_VERSION,
   NgModule,
   NgZone,
   Optional,
   PLATFORM_ID,
+  makeEnvironmentProviders,
 } from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers } from '@angular/fire';
 import { FirebaseApp as IFirebaseApp, getApp, registerVersion } from 'firebase/app';
@@ -44,6 +45,12 @@ const FIREBASE_APPS_PROVIDER = {
 
 export function firebaseAppFactory(fn: (injector: Injector) => IFirebaseApp) {
   return (zone: NgZone, injector: Injector) => {
+    const platformId = injector.get(PLATFORM_ID);
+    registerVersion('angularfire', VERSION.full, 'core');
+    registerVersion('angularfire', VERSION.full, 'app');
+    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+    registerVersion('angular', NG_VERSION.full, platformId.toString());
+
     const app = zone.runOutsideAngular(() => fn(injector));
     return new FirebaseApp(app);
   };
@@ -68,10 +75,11 @@ export class FirebaseAppModule {
 // Calling initializeApp({ ... }, 'name') multiple times will add more FirebaseApps into the FIREBASE_APPS
 // injection scope. This allows developers to more easily work with multiple Firebase Applications. Downside
 // is that DI for app name and options doesn't really make sense anymore.
-export function provideFirebaseApp(fn: (injector: Injector) => IFirebaseApp, ...deps: any[]): ModuleWithProviders<FirebaseAppModule> {
-  return {
-    ngModule: FirebaseAppModule,
-    providers: [{
+export function provideFirebaseApp(fn: (injector: Injector) => IFirebaseApp, ...deps: any[]): EnvironmentProviders {
+  return makeEnvironmentProviders([
+    DEFAULT_FIREBASE_APP_PROVIDER,
+    FIREBASE_APPS_PROVIDER,
+    {
       provide: PROVIDED_FIREBASE_APPS,
       useFactory: firebaseAppFactory(fn),
       multi: true,
@@ -81,6 +89,6 @@ export function provideFirebaseApp(fn: (injector: Injector) => IFirebaseApp, ...
         ɵAngularFireSchedulers,
         ...deps,
       ],
-    }],
-  };
+    }
+  ])
 }
diff --git a/src/app/app.spec.ts b/src/app/app.spec.ts
@@ -13,7 +13,7 @@ describe('FirebaseApp', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => {
                     providedApp = initializeApp(COMMON_CONFIG, appName);
                     return providedApp;

diff --git a/src/auth-guard/auth-guard.spec.ts b/src/auth-guard/auth-guard.spec.ts
@@ -17,18 +17,18 @@ describe('AuthGuard', () => {
     appName = rando();
     TestBed.configureTestingModule({
       imports: [
-        provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
-        provideAuth(() => {
-          const auth = getAuth(getApp(appName));
-          connectAuthEmulator(auth, 'http://localhost:9098');
-          return auth;
-        }),
         AuthGuardModule,
         RouterModule.forRoot([
           { path: 'a', component: TestComponent, canActivate: [AuthGuard] }
         ])
       ],
       providers: [
+        provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
+        provideAuth(() => {
+          const auth = getAuth(getApp(appName));
+          connectAuthEmulator(auth, 'http://localhost:9098');
+          return auth;
+        }),
         { provide: APP_BASE_HREF, useValue: 'http://localhost:4200/' }
       ]
     });

diff --git a/src/auth/auth.module.ts b/src/auth/auth.module.ts
@@ -1,4 +1,12 @@
-import { InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional } from '@angular/core';
+import {
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { ɵAppCheckInstances } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
@@ -48,10 +56,12 @@ export class AuthModule {
   }
 }
 
-export function provideAuth(fn: (injector: Injector) => FirebaseAuth, ...deps: any[]): ModuleWithProviders<AuthModule> {
-  return {
-    ngModule: AuthModule,
-    providers: [{
+export function provideAuth(fn: (injector: Injector) => FirebaseAuth, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'auth');
+  return makeEnvironmentProviders([
+    DEFAULT_AUTH_INSTANCE_PROVIDER,
+    AUTH_INSTANCES_PROVIDER,
+    {
       provide: PROVIDED_AUTH_INSTANCES,
       useFactory: authInstanceFactory(fn),
       multi: true,
@@ -63,6 +73,6 @@ export function provideAuth(fn: (injector: Injector) => FirebaseAuth, ...deps: a
         [new Optional(), ɵAppCheckInstances ],
         ...deps,
       ]
-    }]
-  };
+    }
+  ]);
 }
diff --git a/src/auth/auth.spec.ts b/src/auth/auth.spec.ts
@@ -15,7 +15,7 @@ describe('Auth', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
                 provideAuth(() => {
                     providedAuth = getAuth(getApp(appName));

diff --git a/src/database/database.module.ts b/src/database/database.module.ts
@@ -1,4 +1,12 @@
-import { InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional } from '@angular/core';
+import {
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { ɵAppCheckInstances } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
@@ -49,10 +57,12 @@ export class DatabaseModule {
   }
 }
 
-export function provideDatabase(fn: (injector: Injector) => FirebaseDatabase, ...deps: any[]): ModuleWithProviders<DatabaseModule> {
-  return {
-    ngModule: DatabaseModule,
-    providers: [{
+export function provideDatabase(fn: (injector: Injector) => FirebaseDatabase, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'rtdb');
+  return makeEnvironmentProviders([
+    DEFAULT_DATABASE_INSTANCE_PROVIDER,
+    DATABASE_INSTANCES_PROVIDER,
+    {
       provide: PROVIDED_DATABASE_INSTANCES,
       useFactory: databaseInstanceFactory(fn),
       multi: true,
@@ -66,6 +76,6 @@ export function provideDatabase(fn: (injector: Injector) => FirebaseDatabase, ..
         [new Optional(), ɵAppCheckInstances ],
         ...deps,
       ]
-    }]
-  };
+    }
+  ]);
 }
diff --git a/src/database/database.spec.ts b/src/database/database.spec.ts
@@ -15,7 +15,7 @@ describe('Database', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
                 provideDatabase(() => {
                     providedDatabase = getDatabase(getApp(appName));

diff --git a/src/firestore/firestore.module.ts b/src/firestore/firestore.module.ts
@@ -1,4 +1,12 @@
-import { InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional } from '@angular/core';
+import {
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { ɵAppCheckInstances } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
@@ -49,10 +57,13 @@ export class FirestoreModule {
   }
 }
 
-export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore, ...deps: any[]): ModuleWithProviders<FirestoreModule> {
-  return {
-    ngModule: FirestoreModule,
-    providers: [{
+export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'fst');
+
+  return makeEnvironmentProviders([
+    DEFAULT_FIRESTORE_INSTANCE_PROVIDER,
+    FIRESTORE_INSTANCES_PROVIDER,
+    {
       provide: PROVIDED_FIRESTORE_INSTANCES,
       useFactory: firestoreInstanceFactory(fn),
       multi: true,
@@ -66,6 +77,6 @@ export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore,
         [new Optional(), ɵAppCheckInstances ],
         ...deps,
       ]
-    }]
-  };
+    }
+  ]);
 }
diff --git a/src/firestore/firestore.spec.ts b/src/firestore/firestore.spec.ts
@@ -15,7 +15,7 @@ describe('Firestore', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
                 provideFirestore(() => {
                     providedFirestore = getFirestore(getApp(appName));

diff --git a/src/firestore/lite/lite.module.ts b/src/firestore/lite/lite.module.ts
@@ -1,4 +1,12 @@
-import { InjectionToken, Injector, ModuleWithProviders, NgModule, NgZone, Optional } from '@angular/core';
+import {
+  EnvironmentProviders,
+  InjectionToken,
+  Injector,
+  NgModule,
+  NgZone,
+  Optional,
+  makeEnvironmentProviders,
+} from '@angular/core';
 import { VERSION, ɵAngularFireSchedulers, ɵAppCheckInstances, ɵgetDefaultInstanceOf } from '@angular/fire';
 import { FirebaseApp, FirebaseApps } from '@angular/fire/app';
 import { AuthInstances  } from '@angular/fire/auth';
@@ -48,10 +56,13 @@ export class FirestoreModule {
   }
 }
 
-export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore, ...deps: any[]): ModuleWithProviders<FirestoreModule> {
-  return {
-    ngModule: FirestoreModule,
-    providers: [{
+export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore, ...deps: any[]): EnvironmentProviders {
+  registerVersion('angularfire', VERSION.full, 'lite');
+
+  return makeEnvironmentProviders([
+    DEFAULT_FIRESTORE_INSTANCE_PROVIDER,
+    FIRESTORE_INSTANCES_PROVIDER,
+    {
       provide: PROVIDED_FIRESTORE_INSTANCES,
       useFactory: firestoreInstanceFactory(fn),
       multi: true,
@@ -65,6 +76,6 @@ export function provideFirestore(fn: (injector: Injector) => FirebaseFirestore,
         [new Optional(), ɵAppCheckInstances ],
         ...deps,
       ]
-    }]
-  };
+    }
+  ]);
 }
diff --git a/src/firestore/lite/lite.spec.ts b/src/firestore/lite/lite.spec.ts
@@ -15,7 +15,7 @@ describe('Firestore-lite', () => {
     beforeEach(() => {
         appName = rando();
         TestBed.configureTestingModule({
-            imports: [
+            providers: [
                 provideFirebaseApp(() => initializeApp(COMMON_CONFIG, appName)),
                 provideFirestore(() => {
                     providedFirestore = getFirestore(getApp(appName));