feat: introduce async Firebase interfaces and restructure FirebaseApp, add projectId getter on FirebaseApp

Author: alextekartik

firebase/lib/firebase.dart

@@ -1,75 +1,11 @@
-import 'dart:async';
-
-import 'firebase_mixin.dart';
-import 'src/app_options.dart';
-import 'src/firebase_product_service.dart';
 export 'package:tekartik_firebase/src/app_options.dart'
     show AppOptions, FirebaseAppOptions, FirebaseAppOptionsMixin;
-
-export 'package:tekartik_firebase/src/firebase.dart'
-    show firebaseAppNameDefault;
 export 'package:tekartik_firebase/src/firebase_app_product.dart'
     show FirebaseAppProductService, FirebaseAppProduct;
 export 'package:tekartik_firebase/src/firebase_mixin.dart'
     show FirebaseProductServiceMixin;
-export 'src/firebase_product_service.dart' show FirebaseProductService;
-
-/// Async interface, needed for flutter.
-abstract class FirebaseAsync {
-  /// Initialize the app with the given options.
-  Future<App> initializeAppAsync({AppOptions? options, String? name});
-
-  /// Retrieves an existing instance of an App.
-  Future<App> appAsync({String? name});
-}
-
-/// Firebase interface.
-abstract class Firebase extends FirebaseAsync {
-  /// Initialize the app with the given options.
-  // @deprecated use async version
-  App initializeApp({AppOptions? options, String? name});
-
-  /// Retrieves an existing instance of an App.
-  App app({String? name});
-
-  /// True if firebase is local (i.e. FirebaseLocal, not rest, nor node, nor flutter
-  bool get isLocal;
-}
-
-/// This is the new type, App will be deprecated in the future
-typedef App = FirebaseApp;
 
-/// Firebase app.
-abstract class FirebaseApp {
-  /// The app name
-  String get name;
-
-  /// The app options
-  AppOptions get options;
-
-  /// Deletes this app and frees up system resources.
-  ///
-  /// Once deleted, any plugin functionality using this app instance will throw
-  /// an error.
-  ///
-  /// Deleting the default app is not possible and throws an exception.
-  Future<void> delete();
-
-  /// Add a service and calls its init method.
-  ///
-  /// Upon delete, close will be called
-  Future<void> addService(FirebaseProductService service);
-
-  /// Get firebase
-  Firebase get firebase;
-
-  /// True if local (nor node, nor rest, nor flutter)
-  bool get isLocal;
-
-  /// True if it has admin credentials
-  bool get hasAdminCredentials;
-
-  /// The latest initialized firebase app instance.
-  static FirebaseApp get instance =>
-      FirebaseMixin.latestFirebaseInstanceOrNull!;
-}
+export 'src/firebase.dart' show Firebase, FirebaseAsync;
+export 'src/firebase_app.dart'
+    show firebaseAppNameDefault, FirebaseApp, App, TekartikFirebaseAppExt;
+export 'src/firebase_product_service.dart' show FirebaseProductService;

firebase/lib/src/firebase.dart

@@ -1,4 +1,23 @@
 import 'package:tekartik_firebase/firebase.dart';
 
-/// The default [FirebaseApp] name.
-const firebaseAppNameDefault = '[DEFAULT]';
+/// Async interface, needed for flutter.
+abstract class FirebaseAsync {
+  /// Initialize the app with the given options.
+  Future<App> initializeAppAsync({AppOptions? options, String? name});
+
+  /// Retrieves an existing instance of an App.
+  Future<App> appAsync({String? name});
+}
+
+/// Firebase interface.
+abstract class Firebase extends FirebaseAsync {
+  /// Initialize the app with the given options.
+  // @deprecated use async version
+  App initializeApp({AppOptions? options, String? name});
+
+  /// Retrieves an existing instance of an App.
+  App app({String? name});
+
+  /// True if firebase is local (i.e. FirebaseLocal, not rest, nor node, nor flutter
+  bool get isLocal;
+}

firebase/lib/src/firebase_app.dart

@@ -0,0 +1,51 @@
+import 'app_options.dart';
+import 'firebase.dart';
+import 'firebase_mixin.dart';
+import 'firebase_product_service.dart';
+
+/// The default [FirebaseApp] name.
+const firebaseAppNameDefault = '[DEFAULT]';
+
+/// This is the new type, App will be deprecated in the future
+typedef App = FirebaseApp;
+
+/// Firebase app.
+abstract class FirebaseApp {
+  /// The app name
+  String get name;
+
+  /// The app options
+  FirebaseAppOptions get options;
+
+  /// Deletes this app and frees up system resources.
+  ///
+  /// Once deleted, any plugin functionality using this app instance will throw
+  /// an error.
+  ///
+  /// Deleting the default app is not possible and throws an exception.
+  Future<void> delete();
+
+  /// Add a service and calls its init method.
+  ///
+  /// Upon delete, close will be called
+  Future<void> addService(FirebaseProductService service);
+
+  /// Get firebase
+  Firebase get firebase;
+
+  /// True if local (nor node, nor rest, nor flutter)
+  bool get isLocal;
+
+  /// True if it has admin credentials
+  bool get hasAdminCredentials;
+
+  /// The latest initialized firebase app instance.
+  static FirebaseApp get instance =>
+      FirebaseMixin.latestFirebaseInstanceOrNull!;
+}
+
+/// Firebase app extensions
+extension TekartikFirebaseAppExt on FirebaseApp {
+  /// Project id should never be null!
+  String get projectId => options.projectId!;
+}

firebase/test/firebase_mixin_test.dart

@@ -126,6 +126,7 @@ void main() {
     test('service', () async {
       var firebase = FirebaseMock();
       var app = firebase.initializeApp();
+      expect(app.projectId, _defaultProjectId);
       expect(app.hasAdminCredentials, isFalse);
       expect(FirebaseApp.instance, app);
 

firebase_local/test/firebase_local_test.dart

@@ -19,6 +19,8 @@ void main() {
       var firebase = FirebaseLocal();
       var app = firebase.initializeApp(options: AppOptions(projectId: 'test'));
       expect(FirebaseMixin.latestFirebaseInstanceOrNull, app);
+      expect(app.name, '[DEFAULT]');
+      expect(app.projectId, 'test');
     });
     test('projectId', () async {
       var firebase = FirebaseLocal();

firebase_sim/test/firebase_app_sim_test.dart

@@ -26,6 +26,8 @@ void run(TestContext testContext) {
     setUpAll(() {
       app = testContext.firebase.initializeApp(name: 'test_sim') as AppSim;
       expect(FirebaseApp.instance, app);
+      expect(app.name, 'test_sim');
+      expect(app.projectId, 'sim');
     });
     tearDownAll(() async {
       await app.delete();

firebase_test/lib/firebase_app_test.dart

@@ -12,5 +12,6 @@ void runFirebaseAppTests(
     var firebaseApp = getFirebaseApp();
     expect(firebaseApp.isLocal, firebaseApp.isLocal);
     expect(firebaseApp.options.projectId, isNotNull);
+    expect(firebaseApp.projectId, firebaseApp.options.projectId);
   });
 }