Upgrade Flutter Android APIs #74

vegaro · 2020-06-25T20:21:21Z

As of the 1.12 release, new plugin APIs are available for the Android platform. The old APIs based on PluginRegistry.Registrar won’t be immediately deprecated, but we encourage you to migrate to the new APIs based on FlutterPlugin.

I followed the steps here https://flutter.dev/docs/development/packages-and-plugins/plugin-api-migration#testing-your-plugin

vegaro · 2020-06-26T01:37:06Z

android/src/main/java/com/revenuecat/purchases_flutter/PurchasesFlutterPlugin.java

+    public static void registerWith(Registrar registrar) {
+        PurchasesFlutterPlugin instance = new PurchasesFlutterPlugin();
+        instance.onAttachedToEngine(registrar.messenger(), registrar.context());
+        instance.registrar = registrar;
        registrar.addViewDestroyListener(new PluginRegistry.ViewDestroyListener() {


I am not sure we need this, but I don't think it would hurt to keep it since we already have it.

vegaro · 2020-06-26T01:37:21Z

android/src/main/java/com/revenuecat/purchases_flutter/PurchasesFlutterPlugin.java

+    /**
+     * Plugin registration.
+     */
+    public static void registerWith(Registrar registrar) {


This is the old API, but we still need to support it

vegaro · 2020-06-26T01:38:22Z

android/src/main/java/com/revenuecat/purchases_flutter/PurchasesFlutterPlugin.java

-        channel.setMethodCallHandler(new PurchasesFlutterPlugin(registrar, channel));
+    @Override
+    public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
+        onAttachedToEngine(binding.getBinaryMessenger(), binding.getApplicationContext());


This is the new API

vegaro · 2020-06-26T01:41:09Z

android/src/main/java/com/revenuecat/purchases_flutter/PurchasesFlutterPlugin.java

+    }
+
+    public Activity getActivity() {
+        return registrar != null ? registrar.activity() : activity;


This is how they do in https://github.com/flutter/plugins/blob/88e85c6a48063cfab9111689179e2582a99b77ff/packages/google_sign_in/google_sign_in/android/src/main/java/io/flutter/plugins/googlesignin/GoogleSignInPlugin.java

Since we still need to support the old API for apps that haven't updated yet, we need to check if the registrar is not null. registrar will be null for apps that use the new API and in that case the activity will be the one saved when onAttachedToActivity gets called.

vegaro · 2020-06-26T01:43:31Z

...droid/app/src/androidTest/java/com/revenuecat/purchases_flutter/EmbeddingV1ActivityTest.java

+    public ActivityTestRule<EmbeddingV1Activity> rule =
+            new ActivityTestRule<>(EmbeddingV1Activity.class);
+
+}


This test makes sure the old APIs are still supported. I copied this from migration docs https://flutter.dev/docs/development/packages-and-plugins/plugin-api-migration#testing-your-plugin

vegaro · 2020-06-26T01:43:49Z

example/android/app/src/androidTest/java/com/revenuecat/purchases_flutter/MainActivityTest.java

+public class MainActivityTest {
+    @Rule
+    public ActivityTestRule<FlutterActivity> rule = new ActivityTestRule<>(FlutterActivity.class);
+}


This test makes sure the new APIs are supported and the plugin is registered successfully. I copied this from migration docs https://flutter.dev/docs/development/packages-and-plugins/plugin-api-migration#testing-your-plugin

vegaro · 2020-06-26T01:44:08Z

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

@@ -11,10 +11,9 @@
        android:label="purchases_flutter_example"
        android:icon="@mipmap/ic_launcher">
        <activity
-            android:name=".MainActivity"
-            android:launchMode="singleTop"
+            android:name="io.flutter.embedding.android.FlutterActivity"


We don't need a MainActivity anymore

vegaro · 2020-06-26T01:45:18Z

.../android/app/src/main/java/com/revenuecat/purchases_flutter_example/EmbeddingV1Activity.java

+        super.onCreate(savedInstanceState);
+        PurchasesFlutterPlugin.registerWith(registrarFor("com.revenuecat.purchases_flutter"));
+    }
+}


EmbeddingV1Activity.java uses the v1 embedding for the example project in the same folder as MainActivity to keep testing the v1 embedding’s compatibility with your plugin. Note that we have to manually register all the plugins instead of using GeneratedPluginRegistrant, as MainActivity used to do. Also copied from the upgrading docs.

vegaro · 2020-06-26T01:45:32Z

example/lib/main.dart

@@ -30,7 +30,7 @@ class _MyAppState extends State<InitialScreen> {
  Future<void> initPlatformState() async {
    await Purchases.setDebugLogsEnabled(true);
    await Purchases.setup("api_key");
-    Purchases.addAttributionData({}, PurchasesAttributionNetwork.facebook);
+    await Purchases.addAttributionData({}, PurchasesAttributionNetwork.facebook);


pedantic told me this was missing

vegaro · 2020-06-26T01:45:46Z

example/pubspec.yaml

@@ -20,6 +20,11 @@ dev_dependencies:
  purchases_flutter:
    path: ../

+  pedantic: ^1.8.0


I saw most plugins use this linter tool so I added it

vegaro · 2020-06-26T01:46:21Z

example/pubspec.yaml

+  pedantic: ^1.8.0
+  e2e: ^0.2.1
+  flutter_driver:
+    sdk: flutter


This was mentioned in the upgrading docs, it's used to create end to end tests.

vegaro · 2020-06-26T01:46:38Z

lib/purchases_flutter.dart

@@ -13,7 +13,7 @@ class Purchases {
  static final Set<PurchaserInfoUpdateListener> _purchaserInfoUpdateListeners =
      Set();

-  static final _channel = new MethodChannel('purchases_flutter')
+  static final _channel = MethodChannel('purchases_flutter')


pedantic told me new is not required

vegaro · 2020-06-26T01:47:01Z

pubspec.yaml

@@ -8,15 +8,19 @@ documentation: https://docs.revenuecat.com/

 environment:
  sdk: ">=2.1.0 <3.0.0"
-  flutter: ">=1.12.0 <2.0.0"
+  flutter: ">=1.12.13+hotfix.6 <2.0.0"


Also taken from the upgrading docs, this is the minimum version they offer support for.

vegaro · 2020-06-26T01:53:30Z

test/purchases_flutter_e2e.dart

+    expect(future, completes);
+  });
+
+}


Also copied from the upgrading docs. I ran it by doing ./gradlew app:connectedAndroidTest -Ptarget=pwd/../../test/purchases_flutter_e2e.dartinside example/android and it works. In Android Studio, it doesn't run I don't know why.

Also saw another example here https://github.com/FirebaseExtended/flutterfire/blob/master/packages/firebase_core/firebase_core/test/firebase_core_e2e.dart

This test actually runs in an emulator, so my understanding is we could test a bunch of stuff this way. It only works in Android though. I tried making a purchase and I could see the purchase dialog popping up :)

I am not even adding it to circleci for now, but I am going to leave it since it's part of the upgrading docs.

maybe we could have either a comment or something documenting how to actually run this test so we don't forget? or even a gradle task that wraps the command

vegaro · 2020-06-26T02:17:20Z

example/test_driver/purchases_flutter_e2e_test.dart

+  await driver.requestData(null, timeout: const Duration(minutes: 1));
+  await driver.close();
+  exit(result == 'pass' ? 0 : 1);
+}


I am still not sure what this flutter driver is but I saw a lot of plugins have it (https://github.com/flutter/plugins/tree/master/packages/google_sign_in/google_sign_in/test_driver)

It's also referenced in the docs of e2e https://pub.dev/packages/e2e#using-flutter-driver-to-run-tests

Running flutter drive --driver=test_driver/purchases_flutter_e2e_test.dart ../test/purchases_flutter_e2e.dart inside the example will run the e2e test in the emulator

I guess it provides for a way to do UI tests or integration tests with a simulator

yes, and I think e2e is to run flutter tests in a simulator (using flutter drive), or something like that. Alternatively, someone could write UI tests on the example app in order to test the same

vegaro · 2020-06-26T02:33:04Z

I am a little bit confused with e2e y flutter_driver, but I don't think it's a blocker for this PR.

aboedo · 2020-06-26T14:13:17Z

example/lib/main.dart

@@ -30,7 +30,7 @@ class _MyAppState extends State<InitialScreen> {
  Future<void> initPlatformState() async {
    await Purchases.setDebugLogsEnabled(true);
    await Purchases.setup("api_key");
-    Purchases.addAttributionData({}, PurchasesAttributionNetwork.facebook);
+    await Purchases.addAttributionData({}, PurchasesAttributionNetwork.facebook);


aboedo · 2020-06-26T14:15:53Z

example/test_driver/purchases_flutter_e2e_test.dart

+  await driver.requestData(null, timeout: const Duration(minutes: 1));
+  await driver.close();
+  exit(result == 'pass' ? 0 : 1);
+}


I guess it provides for a way to do UI tests or integration tests with a simulator

aboedo · 2020-06-26T17:30:32Z

test/purchases_flutter_e2e.dart

+    expect(future, completes);
+  });
+
+}


maybe we could have either a comment or something documenting how to actually run this test so we don't forget? or even a gradle task that wraps the command

updates to new Android APIs

0b6d056

vegaro linked an issue Jun 25, 2020 that may be closed by this pull request

Upgrade to new Android plugins APIs #29

Closed

vegaro marked this pull request as draft June 25, 2020 22:05

vegaro added 3 commits June 25, 2020 18:24

fixes activity being null in old API

96665c8

adds tests

6b9416e

adds pedantic

9f5bae9

vegaro commented Jun 26, 2020

View reviewed changes

moves function around

90aeee3

vegaro commented Jun 26, 2020

View reviewed changes

vegaro added 2 commits June 25, 2020 19:12

missing await

da8768f

adds test_driver

fba6c5b

vegaro commented Jun 26, 2020

View reviewed changes

vegaro marked this pull request as ready for review June 26, 2020 02:32

vegaro requested a review from aboedo June 26, 2020 02:32

aboedo approved these changes Jun 26, 2020

View reviewed changes

adds comment

2981196

vegaro merged commit da374da into develop Jun 26, 2020

vegaro deleted the cesardelavega/ch132/upgrade-flutter-android-apis branch June 26, 2020 20:15

vegaro mentioned this pull request Jun 26, 2020

Release 1.2.0 #76

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Flutter Android APIs #74

Upgrade Flutter Android APIs #74

vegaro commented Jun 25, 2020 •

edited

Loading

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020 •

edited

Loading

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

aboedo Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020

vegaro Jun 26, 2020 •

edited

Loading

aboedo Jun 26, 2020

vegaro Jun 26, 2020

aboedo Jun 26, 2020

vegaro Jun 26, 2020

vegaro commented Jun 26, 2020

aboedo Jun 26, 2020

aboedo Jun 26, 2020

aboedo Jun 26, 2020

Upgrade Flutter Android APIs #74

Upgrade Flutter Android APIs #74

Conversation

vegaro commented Jun 25, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro Jun 26, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro Jun 26, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro commented Jun 26, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vegaro commented Jun 25, 2020 •

edited

Loading

vegaro Jun 26, 2020 •

edited

Loading

vegaro Jun 26, 2020 •

edited

Loading