fix: a bug with the demoProjectId arg to Firebase.initializeApp()

If platform specific configuration files exist for the project (i.e.
GoogleService-Info.plist for iOS), the default `MethodChannelFirebaseApp` is
initialized using the configuration it specifies. This is fine since multiple
`FirebaseApp` instances can exist, however when
`MethodChannelFirebase.initializeApp()` is called it uses the default app name
(`[DEFAULT]`, from the code) if no name is passed as an argument. Since the
default app is initialized using the platform specific configuration before
`initializeApp()` is called, the user provided options are ignored.

The solution is to ensure a non-null app name is passed to `initializeApp()` to
avoid conflicts with platform specific configuration files when the user intends
to use a "demo-" project for testing.

Since we should be providing a distinct app name for the demo app, the
allowance for mismatched options between the specified options and the existing
options for demo apps is also removed.

Author: emesterhazy

packages/firebase_core/firebase_core/lib/src/firebase.dart

@@ -28,8 +28,14 @@ class Firebase {
     return _delegate.apps.map(FirebaseApp._).toList(growable: false);
   }
 
-  /// Initializes a new [FirebaseApp] instance by [name] and [options] and returns
-  /// the created app. This method should be called before any usage of FlutterFire plugins.
+  /// Initializes a new [FirebaseApp] instance by [name] and [options] and
+  /// returns the created app. This method should be called before any usage of
+  /// FlutterFire plugins.
+  ///
+  /// If a [demoProjectId] is provided, a new [FirebaseApp] instance will be
+  /// initialized with a set of default options for demo projects, overriding
+  /// the [options] argument. If no [name] is provided alongside a
+  /// [demoProjectId], the [demoProjectId] will be used as the app name.
   ///
   /// The default app instance can be initialized here simply by passing no "name" as an argument
   /// in both Dart & manual initialization flows.
@@ -52,16 +58,21 @@ class Firebase {
         // We use 'web' as the default platform for unknown platforms.
         platformString = 'web';
       }
-      FirebaseAppPlatform app = await _delegate.initializeApp(
-        options: FirebaseOptions(
-          apiKey: '',
-          appId: '1:1:$platformString:1',
-          messagingSenderId: '',
-          projectId: demoProjectId,
-        ),
+      // A name must be set, otherwise [DEFAULT] will be used and the options
+      // we've provided will be ignored if any platform specific configuration
+      // files exist (i.e. GoogleService-Info.plist for iOS).
+      name ??= demoProjectId;
+      // The user should not set any options if they specify a demo project
+      // id, but it was allowed when this API was first added, so we allow it
+      // for backwards compatibility and simply override the user-provided
+      // options.
+      options = FirebaseOptions(
+        apiKey: '',
+        appId: '1:1:$platformString:1',
+        messagingSenderId: '',
+        projectId: demoProjectId,
       );
-
-      return FirebaseApp._(app);
+      // Now fall through to the normal initialization logic.
     }
     FirebaseAppPlatform app = await _delegate.initializeApp(
       name: name,

packages/firebase_core/firebase_core/test/firebase_core_test.dart

@@ -65,6 +65,45 @@ void main() {
       ]);
     });
   });
+
+  test('.initializeApp() with demoProjectId', () async {
+    const String demoProjectId = 'demo-project-id';
+    const String expectedName = demoProjectId;
+    const FirebaseOptions expectedOptions = FirebaseOptions(
+      apiKey: '',
+      // Flutter tests use android as the default platform.
+      appId: '1:1:android:1',
+      messagingSenderId: '',
+      projectId: demoProjectId,
+    );
+
+    final mock = MockFirebaseCore();
+    Firebase.delegatePackingProperty = mock;
+
+    final FirebaseAppPlatform platformApp =
+        FirebaseAppPlatform(expectedName, expectedOptions);
+
+    when(mock.apps).thenReturn([platformApp]);
+    when(mock.app(expectedName)).thenReturn(platformApp);
+    when(mock.initializeApp(name: expectedName, options: expectedOptions))
+        .thenAnswer((_) => Future.value(platformApp));
+
+    // Initialize the app with only a demo project id. The implementation will
+    // set the name and options accordingly.
+    FirebaseApp initializedApp = await Firebase.initializeApp(
+      demoProjectId: demoProjectId,
+    );
+    FirebaseApp app = Firebase.app(expectedName);
+
+    expect(initializedApp, app);
+    verifyInOrder([
+      mock.initializeApp(
+        name: expectedName,
+        options: expectedOptions,
+      ),
+      mock.app(expectedName),
+    ]);
+  });
 }
 
 class MockFirebaseCore extends Mock

packages/firebase_core/firebase_core_platform_interface/lib/src/method_channel/method_channel_firebase.dart

@@ -121,9 +121,7 @@ class MethodChannelFirebase extends FirebasePlatform {
       // check to see if options are roughly identical (so we don't unnecessarily
       // throw on minor differences such as platform specific keys missing
       // e.g. hot reloads/restarts).
-      if (defaultApp != null &&
-          _options != null &&
-          !_options.projectId.startsWith('demo-')) {
+      if (defaultApp != null && _options != null) {
         if (_options.apiKey != defaultApp.options.apiKey ||
             (_options.databaseURL != null &&
                 _options.databaseURL != defaultApp.options.databaseURL) ||