[quick_actions] Extract the Android implementation into a separate package #4698

mvanbeusekom · 2022-01-26T13:55:06Z

Moves the native Android implementation from the quick_actions package into its own quick_actions_android package. I also duplicated the method channel implementation as suggested in issue flutter/flutter#94224.

Temporarily marks quick_actions as unpublishable to allow the implementations to be moved, rather than copied and deleted, in order to better preserve git history. A follow-up PR will restore it to publishable form.

Pre-launch Checklist

stuartmorgan-g · 2022-02-07T21:33:02Z

packages/quick_actions/quick_actions/pubspec.yaml

@@ -15,12 +19,16 @@ flutter:
      android:
        package: io.flutter.plugins.quickactions
        pluginClass: QuickActionsPlugin


Remove these two lines.

stuartmorgan-g · 2022-02-07T21:37:59Z

...ndroid/app/src/androidTest/java/io/flutter/plugins/quickactionsexample/QuickActionsTest.java

+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+


I believe this file is for native unit tests, in which case it should be a move.

(Actually... is this even used? Java unit tests should be in the main source, not the example, and it looks like we already have that. So this file is likely a mistake. Try making it always fail and see if anything actually fails, and if not—which I expect is the case—you can just remove this, both here and the original.)

This is an interesting one. First of all the test is indeed run and will fail the tree if I force it to fail. Inside this file there is only one test that seems to verify if the QuickActions plugin is part of the engine.getPlugins() collection:

public void imagePickerPluginIsAdded() { final ActivityScenario<QuickActionsTestActivity> scenario = ActivityScenario.launch(QuickActionsTestActivity.class); scenario.onActivity( activity -> { assertTrue(activity.engine.getPlugins().has(QuickActionsPlugin.class)); }); }

Not sure if this test has a lot of value, I assume that loading the plugin it self is widely tested in the engine code it self, so the only thing it verifies now is that the plugin is added to the pubspec.yaml file (which I this doesn't really need a test).

If this test does have value, it should remain part of the example App since it tests if the plugin is loaded as part of the example App. It doesn't test any logic that is part of the native Java implementation. And doesn't it also make sense to keep the test in both the quick_actions_android and quick_actions example Apps? Both package contain their own example Apps which load the Android plugin in a slightly different way (meaning the registration in the pubspec.yaml is different).

Would like to hear your opinion on this issue.

Sorry, I misremembered the file locations for different kinds of tests. This is the harness for running native Android UI (espresso) tests. So we do want this file to exist, but it should be a move since we want native integration tests to only be in the implementation package.

Not sure if this test has a lot of value

It's a placeholder, from the project to make sure we had test harnesses in place for all the kinds of tests we want to be running (so that we'd stop having PRs blocked on tests that couldn't be written without someone first learning how to set up the infrastructure for that kind of test).

stuartmorgan-g · 2022-02-07T21:39:43Z

packages/quick_actions/quick_actions_android/example/integration_test/quick_actions_test.dart

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// @dart = 2.9


As with iOS, can we remove this?

stuartmorgan-g · 2022-02-07T21:40:03Z

packages/quick_actions/quick_actions_android/example/lib/main.dart

+        icon: 'AppIcon',
+      ),
+      // NOTE: This second action icon will only work on Android.
+      // In a real world project keep the same file name for both platforms.


Same comments here as for iOS but reversed.

stuartmorgan-g · 2022-02-07T21:40:14Z

packages/quick_actions/quick_actions_android/example/pubspec.yaml

+    sdk: flutter
+  quick_actions_android:
+    # When depending on this package from a real application you should use:
+    #   quick_actions: ^x.y.z


quick_actions_android

stuartmorgan-g · 2022-02-07T21:40:51Z

packages/quick_actions/quick_actions_android/pubspec.yaml

+  integration_test:
+    sdk: flutter
+  mockito: ^5.0.0
+  pedantic: ^1.11.0


stuartmorgan-g · 2022-02-07T21:41:26Z

packages/quick_actions/quick_actions_android/pubspec.yaml

+    sdk: flutter
+  integration_test:
+    sdk: flutter
+  mockito: ^5.0.0


I missed this on the iOS side... are we actually using mockito anywhere in this package?

stuartmorgan-g · 2022-02-07T21:42:40Z

packages/quick_actions/quick_actions_android/test/quick_actions_android_test.dart

+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  group('$QuickActionsAndroid', () {
+    final QuickActionsAndroid quickActions = QuickActionsAndroid();


I missed this on the iOS side, but probably applies there too: please put this line in each test. Having the object under test be stateful across the tests is an antipattern and leads to a variety of problems (including tests passing when they shouldn't).

stuartmorgan-g · 2022-02-07T21:43:07Z

packages/quick_actions/quick_actions_android/test/quick_actions_android_test.dart

+  group('$QuickActionsAndroid', () {
+    final QuickActionsAndroid quickActions = QuickActionsAndroid();
+
+    final List<MethodCall> log = <MethodCall>[];


Prefer making this late and created in setUp instead of being final and cleared in setUp, to reduce statefulness.

stuartmorgan-g · 2022-02-07T21:43:25Z

script/configs/exclude_all_plugins_app.yaml

+# TODO(mvanbeusekom): Remove the exclusion of the quick_actions_android and 
+#                     once the native implementation is removed from the 
+#                     quick_actions package.
+- quick_actions_android


This shouldn't be necessary now.

Creates a new `quick_actions_android` directory and adds the following meta-data files: - `AUTHORS`: copied from the `quick_actions` package and added my name; - `CHANGELOG.md`: new file adding description for release 0.6.0+9; - `LICENSE`: copied from the `quick_actions` package; - `README.md`: new file adding the standard platform implementation description; - `pubspec.yaml`: new file adding package meta-data for the `quick_actions_android` package.

A one to one copy of the `quick_actions/android` folder to `quick_actions_android/` using the following command: ``` cp -R ./quick_actions/android ./quick_actions_android/ ```

This commit makes a direct copy of the `quick_actions/example` app to the `quick_actions_android` package. After the copy the `example/ios` folder is removed as it doesn't serve a purpose in the Android specific package. Commands run where: ``` cp -R ./quick_actions/example ./quick_actions_android/ rm -rf ./quick_actions_android/example/ios ```

This commit updates the example App and integration tests so they directly use the Android specific quick_actions_android package.

Duplicates the method channel implementation in the platform interface package into the Android specific package (see issue flutter/flutter#94224). Also updated the example project and renamed the channels on native and Dart side.

Duplicates the method channel implementation tests and update them so they test the `QuickActionsAndroid` class (see also issue flutter/flutter#94224).

Exclude the quick_actions_android package from the build all plugins app CI step as it currently conflicts with the android implementation that is still part of the quick_actions package.

stuartmorgan-g

LGTM once QuickActionsTest.java is converted to a move.

mvanbeusekom · 2022-02-08T16:35:45Z

LGTM once QuickActionsTest.java is converted to a move.

Done, added waiting for tree to go green label.

fluttergithubbot · 2022-02-08T17:35:23Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite android-platform_tests has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite android-platform_tests has failed. Please fix the issues identified (or deflake) before re-applying this label.
This commit is not mergeable and has conflicts. Please rebase your PR and fix all the conflicts.

…eparate package (flutter/plugins#4698)

mvanbeusekom requested a review from stuartmorgan-g January 26, 2022 13:55

github-actions bot added p: quick_actions platform-android labels Jan 26, 2022

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 8a8b20a to 64c79c7 Compare January 27, 2022 09:00

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 64c79c7 to 6bb9d11 Compare February 4, 2022 15:24

stuartmorgan-g suggested changes Feb 7, 2022

View reviewed changes

mvanbeusekom added 10 commits February 8, 2022 13:46

Direct copy of "android" folder.

89ecb61

A one to one copy of the `quick_actions/android` folder to `quick_actions_android/` using the following command: ``` cp -R ./quick_actions/android ./quick_actions_android/ ```

Update example App and integration tests to Android specific code.

25172fb

This commit updates the example App and integration tests so they directly use the Android specific quick_actions_android package.

Add method channel implementation to platform package.

4a25adb

Duplicates the method channel implementation in the platform interface package into the Android specific package (see issue flutter/flutter#94224). Also updated the example project and renamed the channels on native and Dart side.

Copy method channel test.

0be6530

Duplicates the method channel implementation tests and update them so they test the `QuickActionsAndroid` class (see also issue flutter/flutter#94224).

Exclude quick_actions_android from build all plugins app step.

de87116

Exclude the quick_actions_android package from the build all plugins app CI step as it currently conflicts with the android implementation that is still part of the quick_actions package.

Register dartPluginClass in pubspec.yaml.

acd9446

Rename method channel in native test

7608978

Fail QuickActionsTest.imagePickerPluginIsAdded test

104af9c

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 6bb9d11 to 104af9c Compare February 8, 2022 13:02

Apply feedback from PR

9803ea7

stuartmorgan-g approved these changes Feb 8, 2022

View reviewed changes

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 5e34739 to 7cc4fe4 Compare February 8, 2022 16:32

mvanbeusekom added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Feb 8, 2022

fluttergithubbot removed the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Feb 8, 2022

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 7cc4fe4 to 6a2f1c8 Compare February 9, 2022 07:48

Rollback forced failing test

5d7671f

mvanbeusekom force-pushed the issue/94224_quick_actions_android branch from 39938e2 to 5d7671f Compare February 9, 2022 07:59

Merge branch 'main' into issue/94224_quick_actions_android

2bf7e91

mvanbeusekom added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Feb 9, 2022

fluttergithubbot merged commit 049ae07 into flutter:main Feb 9, 2022

engine-flutter-autoroll mentioned this pull request Feb 10, 2022

Roll Plugins from 9d32c83af9af to aa36a8a606e1 (10 revisions) flutter/flutter#98198

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 10, 2022

049ae071e [quick_actions] Extract the Android implementation into a s…

ffa0575

…eparate package (flutter/plugins#4698)

engine-flutter-autoroll mentioned this pull request Feb 11, 2022

Roll Plugins from 9d32c83af9af to f6495091d470 (18 revisions) flutter/flutter#98261

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 11, 2022

049ae071e [quick_actions] Extract the Android implementation into a s…

3045dd1

…eparate package (flutter/plugins#4698)

engine-flutter-autoroll mentioned this pull request Feb 11, 2022

Roll Plugins from 9d32c83af9af to f45bf32f9f53 (19 revisions) flutter/flutter#98266

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 11, 2022

049ae071e [quick_actions] Extract the Android implementation into a s…

13a68be

…eparate package (flutter/plugins#4698)

engine-flutter-autoroll mentioned this pull request Feb 14, 2022

Roll Plugins from 9d32c83af9af to 6b0d4549eaa5 (30 revisions) flutter/flutter#98410

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 14, 2022

049ae071e [quick_actions] Extract the Android implementation into a s…

f61970a

…eparate package (flutter/plugins#4698)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[quick_actions] Extract the Android implementation into a separate package #4698

[quick_actions] Extract the Android implementation into a separate package #4698

Uh oh!

mvanbeusekom commented Jan 26, 2022 •

edited

Loading

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

mvanbeusekom Feb 8, 2022

Uh oh!

stuartmorgan-g Feb 8, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g Feb 7, 2022

Uh oh!

stuartmorgan-g left a comment

Uh oh!

mvanbeusekom commented Feb 8, 2022

Uh oh!

fluttergithubbot commented Feb 8, 2022

Uh oh!

Uh oh!

[quick_actions] Extract the Android implementation into a separate package #4698

[quick_actions] Extract the Android implementation into a separate package #4698

Uh oh!

Conversation

mvanbeusekom commented Jan 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

mvanbeusekom commented Feb 8, 2022

Uh oh!

fluttergithubbot commented Feb 8, 2022

Uh oh!

Uh oh!

mvanbeusekom commented Jan 26, 2022 •

edited

Loading