[firebase_performance] support v2 android embedding (#266)

Author: bparrishMines

packages/firebase_performance/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.1
+
+* Support v2 embedding. This will remain compatible with the original embedding and won't require
+app migration.
+
 ## 0.3.0+5
 
 * Update documentation to reflect new repository location.

packages/firebase_performance/android/build.gradle

@@ -50,4 +50,30 @@ android {
     }
 }
 
+// TODO(bparrishMines): 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 = "1.1.1"
+                compileOnly "android.arch.lifecycle:runtime:$lifecycle_version"
+                compileOnly "android.arch.lifecycle:common:$lifecycle_version"
+                compileOnly "android.arch.lifecycle:common-java8:$lifecycle_version"
+            }
+        }
+    }
+}
+
 apply from: file("./user-agent.gradle")

packages/firebase_performance/android/gradle.properties

@@ -5,26 +5,55 @@
 package io.flutter.plugins.firebaseperformance;
 
 import android.util.SparseArray;
+import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.PluginRegistry.Registrar;
 
-/** FirebasePerformancePlugin */
-public class FirebasePerformancePlugin implements MethodChannel.MethodCallHandler {
+/**
+ * Flutter plugin accessing Firebase Performance API.
+ *
+ * <p>Instantiate this in an add to app scenario to gracefully handle activity and context changes.
+ */
+public class FirebasePerformancePlugin implements FlutterPlugin, MethodChannel.MethodCallHandler {
   private static final String CHANNEL_NAME = "plugins.flutter.io/firebase_performance";
 
-  private static final SparseArray<MethodChannel.MethodCallHandler> handlers = new SparseArray<>();
+  private final SparseArray<MethodChannel.MethodCallHandler> handlers = new SparseArray<>();
+  private MethodChannel channel;
 
+  /**
+   * Registers a plugin with the v1 embedding api {@code io.flutter.plugin.common}.
+   *
+   * <p>Calling this will register the plugin with the passed registrar. However, plugins
+   * initialized this way won't react to changes in activity or context.
+   *
+   * @param registrar connects this plugin's {@link
+   *     io.flutter.plugin.common.MethodChannel.MethodCallHandler} to its {@link
+   *     io.flutter.plugin.common.BinaryMessenger}.
+   */
   public static void registerWith(Registrar registrar) {
     final MethodChannel channel = new MethodChannel(registrar.messenger(), CHANNEL_NAME);
     channel.setMethodCallHandler(new FirebasePerformancePlugin());
   }
 
+  @Override
+  public void onAttachedToEngine(FlutterPluginBinding binding) {
+    channel = new MethodChannel(binding.getFlutterEngine().getDartExecutor(), CHANNEL_NAME);
+    channel.setMethodCallHandler(this);
+  }
+
+  @Override
+  public void onDetachedFromEngine(FlutterPluginBinding binding) {
+    channel.setMethodCallHandler(null);
+  }
+
   @Override
   public void onMethodCall(MethodCall call, MethodChannel.Result result) {
     if (call.method.equals("FirebasePerformance#instance")) {
       handlers.clear();
-      FlutterFirebasePerformance.getInstance(call, result);
+      final Integer handle = call.argument("handle");
+      addHandler(handle, new FlutterFirebasePerformance(this));
+      result.success(null);
     } else {
       final MethodChannel.MethodCallHandler handler = getHandler(call);
 
@@ -36,7 +65,7 @@ public void onMethodCall(MethodCall call, MethodChannel.Result result) {
     }
   }
 
-  static void addHandler(final int handle, final MethodChannel.MethodCallHandler handler) {
+  void addHandler(final int handle, final MethodChannel.MethodCallHandler handler) {
     if (handlers.get(handle) != null) {
       final String message = String.format("Object for handle already exists: %s", handle);
       throw new IllegalArgumentException(message);
@@ -45,11 +74,11 @@ static void addHandler(final int handle, final MethodChannel.MethodCallHandler h
     handlers.put(handle, handler);
   }
 
-  static void removeHandler(final int handle) {
+  void removeHandler(final int handle) {
     handlers.remove(handle);
   }
 
-  private static MethodChannel.MethodCallHandler getHandler(final MethodCall call) {
+  private MethodChannel.MethodCallHandler getHandler(final MethodCall call) {
     final Integer handle = call.argument("handle");
 
     if (handle == null) return null;

packages/firebase_performance/android/src/main/java/io/flutter/plugins/firebaseperformance/FirebasePerformancePlugin.java

@@ -10,7 +10,7 @@
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 
-public class FlutterFirebasePerformance implements MethodChannel.MethodCallHandler {
+class FlutterFirebasePerformance implements MethodChannel.MethodCallHandler {
   private static String parseHttpMethod(String httpMethod) {
     switch (httpMethod) {
       case "HttpMethod.Connect":
@@ -36,16 +36,11 @@ private static String parseHttpMethod(String httpMethod) {
     }
   }
 
+  private final FirebasePerformancePlugin plugin;
   private final FirebasePerformance performance;
 
-  @SuppressWarnings("ConstantConditions")
-  static void getInstance(MethodCall call, MethodChannel.Result result) {
-    final Integer handle = call.argument("handle");
-    FirebasePerformancePlugin.addHandler(handle, new FlutterFirebasePerformance());
-    result.success(null);
-  }
-
-  private FlutterFirebasePerformance() {
+  FlutterFirebasePerformance(FirebasePerformancePlugin plugin) {
+    this.plugin = plugin;
     this.performance = FirebasePerformance.getInstance();
   }
 
@@ -87,7 +82,7 @@ private void newTrace(MethodCall call, MethodChannel.Result result) {
     final Trace trace = performance.newTrace(name);
 
     final Integer handle = call.argument("traceHandle");
-    FirebasePerformancePlugin.addHandler(handle, new FlutterTrace(trace));
+    plugin.addHandler(handle, new FlutterTrace(plugin, trace));
 
     result.success(null);
   }
@@ -100,7 +95,7 @@ private void newHttpMetric(MethodCall call, MethodChannel.Result result) {
     final HttpMetric metric = performance.newHttpMetric(url, parseHttpMethod(httpMethod));
 
     final Integer handle = call.argument("httpMetricHandle");
-    FirebasePerformancePlugin.addHandler(handle, new FlutterHttpMetric(metric));
+    plugin.addHandler(handle, new FlutterHttpMetric(plugin, metric));
 
     result.success(null);
   }

packages/firebase_performance/android/src/main/java/io/flutter/plugins/firebaseperformance/FlutterFirebasePerformance.java

@@ -8,10 +8,12 @@
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 
-public class FlutterHttpMetric implements MethodChannel.MethodCallHandler {
+class FlutterHttpMetric implements MethodChannel.MethodCallHandler {
+  private final FirebasePerformancePlugin plugin;
   private final HttpMetric httpMetric;
 
-  FlutterHttpMetric(final HttpMetric metric) {
+  FlutterHttpMetric(FirebasePerformancePlugin plugin, final HttpMetric metric) {
+    this.plugin = plugin;
     this.httpMetric = metric;
   }
 
@@ -60,7 +62,7 @@ private void stop(MethodCall call, MethodChannel.Result result) {
     httpMetric.stop();
 
     final Integer handle = call.argument("handle");
-    FirebasePerformancePlugin.removeHandler(handle);
+    plugin.removeHandler(handle);
 
     result.success(null);
   }

packages/firebase_performance/android/src/main/java/io/flutter/plugins/firebaseperformance/FlutterHttpMetric.java

@@ -8,10 +8,12 @@
 import io.flutter.plugin.common.MethodCall;
 import io.flutter.plugin.common.MethodChannel;
 
-public class FlutterTrace implements MethodChannel.MethodCallHandler {
+class FlutterTrace implements MethodChannel.MethodCallHandler {
+  private final FirebasePerformancePlugin plugin;
   private final Trace trace;
 
-  FlutterTrace(final Trace trace) {
+  FlutterTrace(FirebasePerformancePlugin plugin, final Trace trace) {
+    this.plugin = plugin;
     this.trace = trace;
   }
 
@@ -57,7 +59,7 @@ private void stop(MethodCall call, MethodChannel.Result result) {
     trace.stop();
 
     final Integer handle = call.argument("handle");
-    FirebasePerformancePlugin.removeHandler(handle);
+    plugin.removeHandler(handle);
 
     result.success(null);
   }

packages/firebase_performance/android/src/main/java/io/flutter/plugins/firebaseperformance/FlutterTrace.java

@@ -52,6 +52,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_performance/example/android/app/build.gradle

@@ -0,0 +1,14 @@
+package io.flutter.plugins.firebaseperformance;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import io.flutter.plugins.firebaseperformanceexample.EmbeddingV1Activity;
+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_performance/example/android/app/src/androidTest/java/io/flutter/plugins/firebaseperformance/EmbeddingV1ActivityTest.java

@@ -0,0 +1,12 @@
+package io.flutter.plugins.firebaseperformance;
+
+import androidx.test.rule.ActivityTestRule;
+import dev.flutter.plugins.e2e.FlutterRunner;
+import io.flutter.plugins.firebaseperformanceexample.MainActivity;
+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_performance/example/android/app/src/androidTest/java/io/flutter/plugins/firebaseperformance/MainActivityTest.java

@@ -8,7 +8,7 @@
         android:label="firebase_performance_example"
         android:icon="@mipmap/ic_launcher">
         <activity
-            android:name=".MainActivity"
+            android:name=".EmbeddingV1Activity"
             android:launchMode="singleTop"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density"
@@ -17,6 +17,13 @@
             <meta-data
                 android:name="io.flutter.app.android.SplashScreenUntilFirstFrame"
                 android:value="true" />
+        </activity>
+        <activity
+            android:name=".MainActivity"
+            android:theme="@style/LaunchTheme"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale|screenLayout|density"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN"/>
                 <category android:name="android.intent.category.LAUNCHER"/>

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

@@ -0,0 +1,13 @@
+package io.flutter.plugins.firebaseperformanceexample;
+
+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_performance/example/android/app/src/main/java/io/flutter/plugins/firebaseperformanceexample/EmbeddingV1Activity.java

@@ -1,13 +1,13 @@
 package io.flutter.plugins.firebaseperformanceexample;
 
-import android.os.Bundle;
-import io.flutter.app.FlutterActivity;
-import io.flutter.plugins.GeneratedPluginRegistrant;
+import io.flutter.embedding.android.FlutterActivity;
+import io.flutter.embedding.engine.FlutterEngine;
+import io.flutter.plugins.firebaseperformance.FirebasePerformancePlugin;
 
 public class MainActivity extends FlutterActivity {
+  // TODO(bparrishMines): Remove this once v2 of GeneratedPluginRegistrant rolls to stable. https://github.com/flutter/flutter/issues/42694
   @Override
-  protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    GeneratedPluginRegistrant.registerWith(this);
+  public void configureFlutterEngine(FlutterEngine flutterEngine) {
+    flutterEngine.getPlugins().add(new FirebasePerformancePlugin());
   }
 }

packages/firebase_performance/example/android/app/src/main/java/io/flutter/plugins/firebaseperformanceexample/MainActivity.java

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

packages/firebase_performance/example/android/gradle.properties

@@ -11,10 +11,14 @@ dependencies:
   firebase_core: ^0.4.0
 
 dev_dependencies:
+  e2e: ^0.2.1
   flutter_test:
     sdk: flutter
   flutter_driver:
     sdk: flutter
 
 flutter:
   uses-material-design: true
+
+environment:
+  sdk: ">=2.0.0-dev.28.0 <3.0.0"

packages/firebase_performance/example/pubspec.yaml

@@ -4,13 +4,14 @@ description: Flutter plugin for Google Performance Monitoring for Firebase, an a
   iOS.
 author: Flutter Team <[email protected]>
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/firebase_performance
-version: 0.3.0+5
+version: 0.3.1
 
 dependencies:
   flutter:
     sdk: flutter
 
 dev_dependencies:
+  e2e: ^0.2.1
   http: ^0.12.0
   flutter_test:
     sdk: flutter
@@ -27,4 +28,4 @@ flutter:
 
 environment:
   sdk: ">=2.0.0-dev.28.0 <3.0.0"
-  flutter: ">=0.2.4 <2.0.0"
+  flutter: ">=1.9.1+hotfix.5 <2.0.0"

packages/firebase_performance/pubspec.yaml

@@ -0,0 +1,13 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:firebase_performance/firebase_performance.dart';
+import 'package:e2e/e2e.dart';
+
+void main() {
+  E2EWidgetsFlutterBinding.ensureInitialized();
+
+  testWidgets('Enable performance collection', (WidgetTester tester) async {
+    final FirebasePerformance performance = FirebasePerformance.instance;
+    await performance.setPerformanceCollectionEnabled(true);
+    expect(performance.isPerformanceCollectionEnabled(), completion(isTrue));
+  });
+}