chore(firebase_in_app_messaging): migrate to new firebase_core plugin (#3102)

kroikie · Salakar · web-flow · commit 78511714c3dc · 2020-08-06T16:48:45.000+01:00
Co-authored-by: Mike Diarmid &lt;mike.diarmid@gmail.com&gt;
diff --git a/packages/firebase_in_app_messaging/CHANGELOG.md b/packages/firebase_in_app_messaging/CHANGELOG.md
@@ -1,3 +1,15 @@
+## 0.2.0-dev.1
+
+* Depend on `firebase_core` pre-release.
+* Firebase iOS SDK versions are now locked to use the same version defined in
+  `firebase_core`.
+* Firebase Android SDK versions are now using the Firebase Bill of Materials (BoM)
+  to specify individual SDK versions. BoM version is also sourced from
+  `firebase_core`.
+* Allow iOS to be imported as a module.
+* Updated package of Android from `com.example.firebase_in_app_messaging` to
+  `io.flutter.plugins.firebase.inappmessaging`.
+
 ## 0.1.2
 
 * Update lower bound of dart dependency to 2.0.0.
diff --git a/packages/firebase_in_app_messaging/android/build.gradle b/packages/firebase_in_app_messaging/android/build.gradle
@@ -8,7 +8,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.4.2'
+        classpath 'com.android.tools.build:gradle:3.5.0'
     }
 }
 
@@ -21,6 +21,19 @@ rootProject.allprojects {
 
 apply plugin: 'com.android.library'
 
+def firebaseCoreProject = findProject(':firebase_core')
+if (firebaseCoreProject == null) {
+  throw new GradleException('Could not find the firebase_core FlutterFire plugin, have you added it as a dependency in your pubspec?')
+} else if (!firebaseCoreProject.properties['FirebaseSDKVersion']) {
+  throw new GradleException('A newer version of the firebase_core FlutterFire plugin is required, please update your firebase_core pubspec dependency.')
+}
+
+def getRootProjectExtOrCoreProperty(name, firebaseCoreProject) {
+  if (!rootProject.ext.has('FlutterFire')) return firebaseCoreProject.properties[name]
+  if (!rootProject.ext.get('FlutterFire')[name]) return firebaseCoreProject.properties[name]
+  return rootProject.ext.get('FlutterFire').get(name)
+}
+
 android {
     compileSdkVersion 28
 
@@ -32,7 +45,9 @@ android {
         disable 'InvalidPackage'
     }
     dependencies {
-        api 'com.google.firebase:firebase-inappmessaging-display:18.0.2'
+      api firebaseCoreProject
+      implementation platform("com.google.firebase:firebase-bom:${getRootProjectExtOrCoreProperty("FirebaseSDKVersion", firebaseCoreProject)}")
+      implementation 'com.google.firebase:firebase-inappmessaging-display'
     }
 }
 
diff --git a/packages/firebase_in_app_messaging/android/src/main/AndroidManifest.xml b/packages/firebase_in_app_messaging/android/src/main/AndroidManifest.xml
@@ -1,3 +1,3 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-  package="com.example.firebase_in_app_messaging">
+  package="com.flutter.plugins.firebase.inappmessaging">
 </manifest>
diff --git a/packages/firebase_in_app_messaging/android/src/main/java/io/flutter/plugins/firebase/inappmessaging/FirebaseInAppMessagingPlugin.java b/packages/firebase_in_app_messaging/android/src/main/java/io/flutter/plugins/firebase/inappmessaging/FirebaseInAppMessagingPlugin.java
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-package com.example.firebase_in_app_messaging;
+package io.flutter.plugins.firebase.inappmessaging;
 
 import com.google.firebase.inappmessaging.FirebaseInAppMessaging;
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
diff --git a/packages/firebase_in_app_messaging/example/android/app/src/androidTest/java/com/example/firebase_in_app_messaging/EmbeddingV1ActivityTest.java b/packages/firebase_in_app_messaging/example/android/app/src/androidTest/java/com/example/firebase_in_app_messaging/EmbeddingV1ActivityTest.java
diff --git a/packages/firebase_in_app_messaging/example/android/app/src/androidTest/java/com/example/firebase_in_app_messaging/MainActivityTest.java b/packages/firebase_in_app_messaging/example/android/app/src/androidTest/java/com/example/firebase_in_app_messaging/MainActivityTest.java
diff --git a/packages/firebase_in_app_messaging/example/android/app/src/main/AndroidManifest.xml b/packages/firebase_in_app_messaging/example/android/app/src/main/AndroidManifest.xml
@@ -10,28 +10,19 @@
         android:name="io.flutter.app.FlutterApplication"
         android:label="firebase_in_app_messaging_example"
         android:icon="@mipmap/ic_launcher">
-        <activity
-            android:name=".EmbeddingV1Activity"
-            android:theme="@style/LaunchTheme"
-            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale"
-            android:hardwareAccelerated="true"
-            android:windowSoftInputMode="adjustResize">
-        </activity>
-        <activity
-            android:name=".MainActivity"
-            android:launchMode="singleTop"
-            android:theme="@style/LaunchTheme"
-            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
-            android:hardwareAccelerated="true"
-            android:windowSoftInputMode="adjustResize">
-            <!-- This keeps the window background of the activity showing
-                 until Flutter renders its first frame. It can be removed if
-                 there is no splash screen (such as the default splash screen
-                 defined in @style/LaunchTheme). -->
-            <intent-filter>
-                <action android:name="android.intent.action.MAIN"/>
-                <category android:name="android.intent.category.LAUNCHER"/>
-            </intent-filter>
-        </activity>
+      <activity android:name="io.flutter.embedding.android.FlutterActivity"
+        android:theme="@android:style/Theme.Black.NoTitleBar"
+        android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale"
+        android:hardwareAccelerated="true"
+        android:windowSoftInputMode="adjustResize">
+        <meta-data
+          android:name="io.flutter.app.android.SplashScreenUntilFirstFrame"
+          android:value="true" />
+        <intent-filter>
+          <action android:name="android.intent.action.MAIN"/>
+          <category android:name="android.intent.category.LAUNCHER"/>
+        </intent-filter>
+      </activity>
+      <meta-data android:name="flutterEmbedding" android:value="2"/>
     </application>
 </manifest>
diff --git a/packages/firebase_in_app_messaging/example/android/app/src/main/java/com/example/firebase_in_app_messaging_example/EmbeddingV1Activity.java b/packages/firebase_in_app_messaging/example/android/app/src/main/java/com/example/firebase_in_app_messaging_example/EmbeddingV1Activity.java
@@ -1,13 +1,20 @@
 package com.example.firebase_in_app_messaging_example;
 
 import android.os.Bundle;
+import dev.flutter.plugins.e2e.E2EPlugin;
 import io.flutter.app.FlutterActivity;
-import io.flutter.plugins.GeneratedPluginRegistrant;
+import io.flutter.plugins.firebase.core.FlutterFirebaseCorePlugin;
+import io.flutter.plugins.firebase.inappmessaging.FirebaseInAppMessagingPlugin;
 
 public class EmbeddingV1Activity extends FlutterActivity {
   @Override
   protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
-    GeneratedPluginRegistrant.registerWith(this);
+    FlutterFirebaseCorePlugin.registerWith(
+        registrarFor("io.flutter.plugins.firebase.core.FlutterFirebaseCorePlugin"));
+    // TODO(Salakar) rename as part of re-work FirebaseInAppMessagingPlugin -> FlutterFirebaseInAppMessagingPlugin
+    FirebaseInAppMessagingPlugin.registerWith(
+        registrarFor("io.flutter.plugins.firebase.inappmessaging.FirebaseInAppMessagingPlugin"));
+    E2EPlugin.registerWith(registrarFor("dev.flutter.plugins.e2e.E2EPlugin"));
   }
 }
diff --git a/packages/firebase_in_app_messaging/example/android/app/src/main/java/com/example/firebase_in_app_messaging_example/MainActivity.java b/packages/firebase_in_app_messaging/example/android/app/src/main/java/com/example/firebase_in_app_messaging_example/MainActivity.java
diff --git a/packages/firebase_in_app_messaging/example/pubspec.yaml b/packages/firebase_in_app_messaging/example/pubspec.yaml
@@ -9,6 +9,10 @@ dependencies:
   flutter:
     sdk: flutter
   cupertino_icons: ^0.1.2
+  firebase_in_app_messaging:
+    path: ../
+  firebase_core: ^0.5.0-dev.2
+  firebase_analytics: ^6.0.0-dev.1
 
 dev_dependencies:
   pedantic: ^1.8.0
@@ -19,10 +23,5 @@ dev_dependencies:
     sdk: flutter
   test: any
 
-  firebase_in_app_messaging:
-    path: ../
-  firebase_core: ^0.4.0+8
-  firebase_analytics: ^4.0.2
-
 flutter:
   uses-material-design: true
diff --git a/packages/firebase_in_app_messaging/ios/firebase_in_app_messaging.podspec b/packages/firebase_in_app_messaging/ios/firebase_in_app_messaging.podspec
@@ -1,24 +1,41 @@
 #
 # To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
 #
+firebase_sdk_version = '6.26.0'
+if defined?($FirebaseSDKVersion)
+  Pod::UI.puts "#{pubspec['name']}: Using user specified Firebase SDK version '#{$FirebaseSDKVersion}'"
+  firebase_sdk_version = $FirebaseSDKVersion
+else
+  firebase_core_script = File.join(File.expand_path('..', File.expand_path('..', File.dirname(__FILE__))), 'firebase_core/ios/firebase_sdk_version.rb')
+  if File.exist?(firebase_core_script)
+    require firebase_core_script
+    firebase_sdk_version = firebase_sdk_version!
+    Pod::UI.puts "#{pubspec['name']}: Using Firebase SDK version '#{firebase_sdk_version}' defined in 'firebase_core'"
+  end
+end
+
 Pod::Spec.new do |s|
-  s.name             = 'firebase_in_app_messaging'
-  s.version          = '0.0.1'
-  s.summary          = 'In-App Messaging Plugin for Firebase'
-  s.description      = <<-DESC
-Flutter plugin for Firebase In-App Messaging.
-                       DESC
-  s.homepage         = 'https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_in_app_messaging'
+  s.name             = pubspec['name']
+  s.version          = library_version
+  s.summary          = pubspec['description']
+  s.description      = pubspec['description']
+  s.homepage         = pubspec['homepage']
   s.license          = { :file => '../LICENSE' }
-  s.author           = { 'Flutter Team' => 'flutter-dev@googlegroups.com' }
+  s.author           = 'The Chromium Authors'
   s.source           = { :path => '.' }
   s.source_files = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
-  s.dependency 'Firebase'
-  s.dependency 'Firebase/InAppMessagingDisplay'
+  s.dependency 'firebase_core'
+  s.dependency 'Firebase/CoreOnly', "~> #{firebase_sdk_version}"
+  s.dependency 'Firebase/InAppMessaging', "~> #{firebase_sdk_version}"
   s.static_framework = true
 
   s.ios.deployment_target = '8.0'
-end
 
+  s.pod_target_xcconfig = {
+    # TODO(Salakar): Enable once plugin refactored to support.
+    # 'GCC_PREPROCESSOR_DEFINITIONS' => "LIBRARY_VERSION=\\@\\\"#{library_version}\\\" LIBRARY_NAME=\\@\\\"flutter-fire-fiam\\\"",
+    'DEFINES_MODULE' => 'YES'
+  }
+end
diff --git a/packages/firebase_in_app_messaging/pubspec.yaml b/packages/firebase_in_app_messaging/pubspec.yaml
@@ -1,6 +1,6 @@
 name: firebase_in_app_messaging
 description: Flutter plugin for Firebase In-App Messaging.
-version: 0.1.2
+version: 0.2.0-dev.1
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_in_app_messaging
 
 environment:
@@ -11,6 +11,7 @@ dependencies:
   meta: ^1.1.6
   flutter:
     sdk: flutter
+  firebase_core: ^0.5.0-dev.2
 
 dev_dependencies:
   pedantic: ^1.8.0
@@ -25,7 +26,7 @@ flutter:
   plugin:
     platforms:
       android:
-        package: com.example.firebase_in_app_messaging
+        package: io.flutter.plugins.firebase.inappmessaging
         pluginClass: FirebaseInAppMessagingPlugin
       ios:
         pluginClass: FirebaseInAppMessagingPlugin

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ buildscript {`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`dependencies {`
`11`		`- classpath 'com.android.tools.build:gradle:3.4.2'`
	`11`	`+ classpath 'com.android.tools.build:gradle:3.5.0'`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`@@ -21,6 +21,19 @@ rootProject.allprojects {`
`21`	`21`
`22`	`22`	`apply plugin: 'com.android.library'`
`23`	`23`
	`24`	`+def firebaseCoreProject = findProject(':firebase_core')`
	`25`	`+if (firebaseCoreProject == null) {`
	`26`	`+ throw new GradleException('Could not find the firebase_core FlutterFire plugin, have you added it as a dependency in your pubspec?')`
	`27`	`+} else if (!firebaseCoreProject.properties['FirebaseSDKVersion']) {`
	`28`	`+ throw new GradleException('A newer version of the firebase_core FlutterFire plugin is required, please update your firebase_core pubspec dependency.')`
	`29`	`+}`
	`30`	`+`
	`31`	`+def getRootProjectExtOrCoreProperty(name, firebaseCoreProject) {`
	`32`	`+ if (!rootProject.ext.has('FlutterFire')) return firebaseCoreProject.properties[name]`
	`33`	`+ if (!rootProject.ext.get('FlutterFire')[name]) return firebaseCoreProject.properties[name]`
	`34`	`+ return rootProject.ext.get('FlutterFire').get(name)`
	`35`	`+}`
	`36`	`+`
`24`	`37`	`android {`
`25`	`38`	`compileSdkVersion 28`
`26`	`39`
`@@ -32,7 +45,9 @@ android {`
`32`	`45`	`disable 'InvalidPackage'`
`33`	`46`	`}`
`34`	`47`	`dependencies {`
`35`		`- api 'com.google.firebase:firebase-inappmessaging-display:18.0.2'`
	`48`	`+ api firebaseCoreProject`
	`49`	`+ implementation platform("com.google.firebase:firebase-bom:${getRootProjectExtOrCoreProperty("FirebaseSDKVersion", firebaseCoreProject)}")`
	`50`	`+ implementation 'com.google.firebase:firebase-inappmessaging-display'`
`36`	`51`	`}`
`37`	`52`	`}`
`38`	`53`