[firebase_analytics] Support Android v2 embedding (#1266)

* Support Android v2 embedding for firebase_analytics plugin.

Author: kroikie

packages/firebase_analytics/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.0.3
+
+* Support the v2 Android embedding.
+
 ## 5.0.2
 
 * Fixed `setAnalyticsCollectionEnabled` on iOS.

packages/firebase_analytics/android/build.gradle

@@ -50,4 +50,29 @@ android {
     }
 }
 
+// TODO(kroikie): Remove this hack once androidx.lifecycle is included on stable. https://github.com/flutter/flutter/issues/42348
+afterEvaluate {
+    def containsEmbeddingDependencies = false
+    for (def configuration : configurations.all) {
+        for (def dependency : configuration.dependencies) {
+            if (dependency.group == 'io.flutter' &&
+                    dependency.name.startsWith('flutter_embedding') &&
+                    dependency.isTransitive())
+            {
+                containsEmbeddingDependencies = true
+                break
+            }
+        }
+    }
+    if (!containsEmbeddingDependencies) {
+        android {
+            dependencies {
+                def lifecycle_version = "2.1.0"
+                api "androidx.lifecycle:lifecycle-common-java8:$lifecycle_version"
+                api "androidx.lifecycle:lifecycle-runtime:$lifecycle_version"
+            }
+        }
+    }
+}
+
 apply from: file("./user-agent.gradle")

packages/firebase_analytics/android/gradle.properties

@@ -1 +1,3 @@
 org.gradle.jvmargs=-Xmx1536M
+android.useAndroidX=true
+android.enableJetifier=true

packages/firebase_analytics/android/src/main/java/io/flutter/plugins/firebaseanalytics/FirebaseAnalyticsPlugin.java

@@ -5,9 +5,15 @@
 package io.flutter.plugins.firebaseanalytics;
 
 import android.app.Activity;
+import android.content.Context;
 import android.os.Bundle;
+import androidx.annotation.NonNull;
 import com.google.firebase.FirebaseApp;
 import com.google.firebase.analytics.FirebaseAnalytics;
+import io.flutter.embedding.engine.plugins.FlutterPlugin;
+import io.flutter.embedding.engine.plugins.activity.ActivityAware;
+import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
+import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
@@ -16,22 +22,54 @@
 import java.util.Map;
 
 /** Flutter plugin for Firebase Analytics. */
-public class FirebaseAnalyticsPlugin implements MethodCallHandler {
-  private final PluginRegistry.Registrar registrar;
-  private final FirebaseAnalytics firebaseAnalytics;
+public class FirebaseAnalyticsPlugin implements MethodCallHandler, FlutterPlugin, ActivityAware {
+  private FirebaseAnalytics firebaseAnalytics;
+  private MethodChannel methodChannel;
+  private Activity activity;
 
   public static void registerWith(PluginRegistry.Registrar registrar) {
-    final MethodChannel channel =
-        new MethodChannel(registrar.messenger(), "plugins.flutter.io/firebase_analytics");
-    channel.setMethodCallHandler(new FirebaseAnalyticsPlugin(registrar));
+    FirebaseAnalyticsPlugin instance = new FirebaseAnalyticsPlugin();
+    instance.setActivity(registrar.activity());
+    instance.onAttachedToEngine(registrar.context(), registrar.messenger());
   }
 
-  private FirebaseAnalyticsPlugin(PluginRegistry.Registrar registrar) {
-    this.registrar = registrar;
-    FirebaseApp.initializeApp(registrar.context());
-    this.firebaseAnalytics = FirebaseAnalytics.getInstance(registrar.context());
+  @Override
+  public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
+    onAttachedToEngine(
+        binding.getApplicationContext(), binding.getFlutterEngine().getDartExecutor());
+  }
+
+  private void onAttachedToEngine(Context applicationContext, BinaryMessenger binaryMessenger) {
+    FirebaseApp.initializeApp(applicationContext);
+    firebaseAnalytics = FirebaseAnalytics.getInstance(applicationContext);
+    methodChannel = new MethodChannel(binaryMessenger, "plugins.flutter.io/firebase_analytics");
+    methodChannel.setMethodCallHandler(this);
+  }
+
+  @Override
+  public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
+    firebaseAnalytics = null;
+    methodChannel = null;
   }
 
+  @Override
+  public void onAttachedToActivity(@NonNull ActivityPluginBinding binding) {
+    setActivity(binding.getActivity());
+  }
+
+  @Override
+  public void onDetachedFromActivityForConfigChanges() {
+    setActivity(null);
+  }
+
+  @Override
+  public void onReattachedToActivityForConfigChanges(@NonNull ActivityPluginBinding binding) {
+    setActivity(binding.getActivity());
+  }
+
+  @Override
+  public void onDetachedFromActivity() {}
+
   @Override
   public void onMethodCall(MethodCall call, Result result) {
     switch (call.method) {
@@ -62,6 +100,10 @@ public void onMethodCall(MethodCall call, Result result) {
     }
   }
 
+  private void setActivity(Activity activity) {
+    this.activity = activity;
+  }
+
   private void handleLogEvent(MethodCall call, Result result) {
 
     final String eventName = call.argument("name");
@@ -78,7 +120,6 @@ private void handleSetUserId(MethodCall call, Result result) {
   }
 
   private void handleSetCurrentScreen(MethodCall call, Result result) {
-    Activity activity = registrar.activity();
     if (activity == null) {
       result.error("no_activity", "handleSetCurrentScreen requires a foreground activity", null);
       return;

packages/firebase_analytics/example/android/app/build.gradle

@@ -54,6 +54,9 @@ flutter {
 }
 
 dependencies {
+    androidTestImplementation 'androidx.test:runner:1.2.0'
+    androidTestImplementation 'androidx.test:rules:1.2.0'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
 }
 
 apply plugin: 'com.google.gms.google-services'

packages/firebase_analytics/example/android/app/src/androidTest/java/io/flutter/plugins/firebaseanalyticsexample/EmbeddingV1ActivityTest.java

@@ -0,0 +1,17 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.firebaseanalyticsexample;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import org.junit.Rule;
+import org.junit.runner.RunWith;
+
+@RunWith(FlutterRunner.class)
+public class EmbeddingV1ActivityTest {
+  @Rule
+  public ActivityTestRule<EmbeddingV1Activity> rule =
+      new ActivityTestRule<>(EmbeddingV1Activity.class);
+}

packages/firebase_analytics/example/android/app/src/androidTest/java/io/flutter/plugins/firebaseanalyticsexample/MainActivityTest.java

@@ -0,0 +1,15 @@
+// Copyright 2019 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package io.flutter.plugins.firebaseanalyticsexample;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import org.junit.Rule;
+import org.junit.runner.RunWith;
+
+@RunWith(FlutterRunner.class)
+public class MainActivityTest {
+  @Rule public ActivityTestRule<MainActivity> rule = new ActivityTestRule<>(MainActivity.class);
+}

packages/firebase_analytics/example/android/app/src/main/AndroidManifest.xml

@@ -15,5 +15,16 @@
                 <category android:name="android.intent.category.LAUNCHER"/>
             </intent-filter>
         </activity>
+        <activity android:name=".EmbeddingV1Activity"
+            android:launchMode="singleTop"
+            android:theme="@android:style/Theme.Black.NoTitleBar"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN"/>
+                <category android:name="android.intent.category.LAUNCHER"/>
+            </intent-filter>
+        </activity>
     </application>
 </manifest>

packages/firebase_analytics/example/android/app/src/main/java/io/flutter/plugins/firebaseanalyticsexample/EmbeddingV1Activity.java

@@ -0,0 +1,13 @@
+package io.flutter.plugins.firebaseanalyticsexample;
+
+import android.os.Bundle;
+import io.flutter.app.FlutterActivity;
+import io.flutter.plugins.GeneratedPluginRegistrant;
+
+public class EmbeddingV1Activity extends FlutterActivity {
+  @Override
+  protected void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+    GeneratedPluginRegistrant.registerWith(this);
+  }
+}

packages/firebase_analytics/example/android/app/src/main/java/io/flutter/plugins/firebaseanalyticsexample/MainActivity.java

@@ -4,14 +4,15 @@
 
 package io.flutter.plugins.firebaseanalyticsexample;
 
-import android.os.Bundle;
-import io.flutter.app.FlutterActivity;
-import io.flutter.plugins.GeneratedPluginRegistrant;
+import dev.flutter.plugins.e2e.E2EPlugin;
+import io.flutter.embedding.android.FlutterActivity;
+import io.flutter.embedding.engine.FlutterEngine;
+import io.flutter.plugins.firebaseanalytics.FirebaseAnalyticsPlugin;
 
 public class MainActivity extends FlutterActivity {
   @Override
-  protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    GeneratedPluginRegistrant.registerWith(this);
+  public void configureFlutterEngine(FlutterEngine flutterEngine) {
+    flutterEngine.getPlugins().add(new FirebaseAnalyticsPlugin());
+    flutterEngine.getPlugins().add(new E2EPlugin());
   }
 }

packages/firebase_analytics/example/android/gradle.properties

@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableR8=true

packages/firebase_analytics/example/pubspec.yaml

@@ -7,6 +7,7 @@ dependencies:
   firebase_analytics:
     path: ../
   firebase_core: ^0.4.0
+  e2e: ^0.2.1
 
 dev_dependencies:
   flutter_test:

packages/firebase_analytics/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for Google Analytics for Firebase, an app measuremen
   solution that provides insight on app usage and user engagement on Android and iOS.
 author: Flutter Team <[email protected]>
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_analytics
-version: 5.0.2
+version: 5.0.3
 
 flutter:
   plugin:
@@ -17,6 +17,7 @@ dependencies:
     sdk: flutter
 
 dev_dependencies:
+  e2e: ^0.2.1
   mockito: 3.0.0
   flutter_test:
     sdk: flutter
@@ -26,4 +27,4 @@ dev_dependencies:
 
 environment:
   sdk: ">=2.0.0-dev.28.0 <3.0.0"
-  flutter: ">=1.5.0 <2.0.0"
+  flutter: ">=1.9.1+hotfix.4 <2.0.0"

packages/firebase_analytics/test/firebase_analytics_e2e.dart

@@ -0,0 +1,13 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:e2e/e2e.dart';
+
+import 'package:firebase_analytics/firebase_analytics.dart';
+
+void main() {
+  E2EWidgetsFlutterBinding.ensureInitialized();
+
+  testWidgets('Can log event', (WidgetTester tester) async {
+    final Future<void> future = FirebaseAnalytics().logEvent(name: "foo_event");
+    expect(future, completes);
+  });
+}