[quick_actions] handle cold start on iOS correctly #3811

mvanbeusekom · 2021-04-16T11:55:47Z

According to Apple's documentation (see the "Discussion" section here) the application:performActionForShortcutItem: method is not executed when the willFinishLaunchingWithOptions: or the didFinishLaunchingWithOptions: return NO. In these cases the willFinishLaunchingWithOptions: or didFinishLaunchingWithOptions: method are responsible for handling quick actions.

Basic Flutter applications will always return YES for the willFinishLaunchingWithOptions: and didFinishLaunchingWithOptions: methods, however in more advanced cases developers might override these methods and provide custom implementations which might result in one of these method to return NO. In these situations the current implementation of the quick_actions plugin will not work.

This PR will solve the problem and correctly handle quick actions in the didFinishLaunchingWithOptions: delegate of the plugin. It also contains an additional XCUITest to proof this method is working correctly. To be able to simulate the situation the didFinishLaunchingWithOptions: method in the example/ios/Runner/AppDelegate.m is updated to always return NO.

Running the XCUITest on the current codebase will fail if you update the didFinishLaunchingWithOptions: method in the example/ios/Runner/AppDelegate.m to return NO. Running the same test on the code modified in this PR the test will succeed.

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

cyanglaz · 2021-04-17T02:40:22Z

packages/quick_actions/quick_actions/ios/Classes/FLTQuickActionsPlugin.m

@@ -10,7 +10,9 @@ @interface FLTQuickActionsPlugin ()
 @property(nonatomic, retain) FlutterMethodChannel *channel;
 @end

-@implementation FLTQuickActionsPlugin
+@implementation FLTQuickActionsPlugin {
+  NSString *shortcutType;


nits: Let's make this a property instead of ivar to match the code style of this file.

cyanglaz · 2021-04-17T02:41:54Z

packages/quick_actions/quick_actions/ios/Classes/FLTQuickActionsPlugin.m

 #pragma mark Private functions

+- (void)_handleShortcut:(NSString *)shortcut {


nits: OBJC method should not start with handleShortcut is fine.

cyanglaz · 2021-04-17T02:46:01Z

packages/quick_actions/quick_actions/ios/Classes/FLTQuickActionsPlugin.m

+- (BOOL)application:(UIApplication *)application
+    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+  if (@available(iOS 9.0, *)) {
+    UIApplicationShortcutItem *shortcutItem =


Why don't we directly call handleShortcut here?

We have to wait here for the application to become fully active before the method channel are fully initialised. When we directly call the handleShortcut in the didFinishLaunchingWithOptions method the channels on the Dart side are not initialised yet and the invokeMethod:@"launch" isn't processed.

Ah makes sense. Let's add a comment here for future reference.

Why do we return No below?

According to Apple's documentation you should return NO if you already handled the shortcut action which will make sure the application:performActionFor: method and not handle the same action again.

The explanation can be found in the last alinea of the "Discussion" section of this article: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623032-application

OK. Let's also add comment here too. Then I think we are good to go!

Thanks @cyanglaz, I have added comments as explanation.

mvanbeusekom · 2021-04-17T07:12:52Z

@cyanglaz thank you very much for your feedback. I corrected the "nits" and answered the question regarding why not to call the handleShortcut directly from thedidFinishLaunchingWithOptions method. Would appreciate it if you could have another look.

cyanglaz

LGTM

…lugins#3811)

* master: (397 commits) [in_app_purchase] Implementation of platform interface (flutter#3781) [google_sign_in] Add todo WRT correctly setting X-Goog-AuthUser header (flutter#3819) [tools] fix version check command not working for new packages (flutter#3818) [camera] android-rework part 1: Base classes to support Android Camera features (flutter#3795) fix MD (flutter#3815) Path provider windows crash fix (flutter#3814) [local_auth] docs update (flutter#3103) Update PULL_REQUEST_TEMPLATE.md (flutter#3801) [quick_actions] handle cold start on iOS correctly (flutter#3811) Replace path_provider_linux widget tests with simple unit tests (flutter#3812) [sensors] format dart code based on the new dart formatter (flutter#3809) [google_sign_in] Fix "pick account" on iOS (flutter#3805) [image_picker_platform_interface] Added pickMultiImage (flutter#3782) [in_app_purchase] Added currency code and numerical price to product detail model. (flutter#3794) [local_auth] Fix iOS crash when no localizedReason (flutter#3780) Fix and update version checks (flutter#3792) [in_app_purchase] Configured example app to use StoreKit Testing on iOS 14 (flutter#3772) [local_auth] Unnecessary reassignment in example removed (flutter#2983) [flutter_webview] Fix `allowsInlineMediaPlayback` ignored on iOS (flutter#3791) Switch script/tools over to the new analysis options (flutter#3777) ...

* master: (79 commits) Fix grammatical error in contributing guide (flutter#3217) [google_sign_in_web] fix README typos. [tool] combine run and runAndExitOnError (flutter#3827) [camera] android-rework part 2: Android auto focus feature (flutter#3796) [in_app_purchase_platform_interface] Added additional fields to ProductDetails (flutter#3826) Move all null safety packages' min dart sdk to 2.12.0 (flutter#3822) [path_provider_*] code cleanup: sort directives (flutter#3823) [in_app_purchase] Implementation of platform interface (flutter#3781) [google_sign_in] Add todo WRT correctly setting X-Goog-AuthUser header (flutter#3819) [tools] fix version check command not working for new packages (flutter#3818) [camera] android-rework part 1: Base classes to support Android Camera features (flutter#3795) fix MD (flutter#3815) Path provider windows crash fix (flutter#3814) [local_auth] docs update (flutter#3103) Update PULL_REQUEST_TEMPLATE.md (flutter#3801) [quick_actions] handle cold start on iOS correctly (flutter#3811) Replace path_provider_linux widget tests with simple unit tests (flutter#3812) [sensors] format dart code based on the new dart formatter (flutter#3809) [google_sign_in] Fix "pick account" on iOS (flutter#3805) [image_picker_platform_interface] Added pickMultiImage (flutter#3782) ...

mvanbeusekom requested a review from cyanglaz April 16, 2021 11:55

google-cla bot added the cla: yes label Apr 16, 2021

github-actions bot added p: quick_actions platform-ios labels Apr 16, 2021

cyanglaz reviewed Apr 17, 2021

View reviewed changes

mvanbeusekom added 2 commits April 17, 2021 09:10

XCUITest to verify iOS quick_actions in cold start

0d2debf

Handle complete iOS lifecycle

2bf782e

mvanbeusekom force-pushed the issue/13634 branch from 2a04f4e to 88a0f88 Compare April 17, 2021 07:11

Processed feedback on PR

49067dc

mvanbeusekom force-pushed the issue/13634 branch from 88a0f88 to 49067dc Compare April 17, 2021 07:17

Added comments to explain code

8b38c46

cyanglaz approved these changes Apr 18, 2021

View reviewed changes

cyanglaz 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 Apr 18, 2021

fluttergithubbot merged commit e2844d2 into flutter:master Apr 19, 2021

github-actions bot added the needs-publishing label Apr 19, 2021

engine-flutter-autoroll mentioned this pull request Apr 19, 2021

Roll Plugins from 0892a2d292c2 to e2844d2373c6 (2 revisions) flutter/flutter#80744

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 19, 2021

e2844d2 [quick_actions] handle cold start on iOS correctly (flutter/p…

8dc433e

…lugins#3811)

cyanglaz removed the needs-publishing label Apr 20, 2021

stuartmorgan mentioned this pull request May 27, 2021

quick_actions testQuickActionWithFreshStart XCUITest is flaky flutter/flutter#83483

Closed

fotiDim pushed a commit to fotiDim/plugins that referenced this pull request Sep 13, 2021

[quick_actions] handle cold start on iOS correctly (flutter#3811)

4e5ba91

mvanbeusekom deleted the issue/13634 branch September 21, 2021 09:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[quick_actions] handle cold start on iOS correctly #3811

[quick_actions] handle cold start on iOS correctly #3811

mvanbeusekom commented Apr 16, 2021

cyanglaz Apr 17, 2021

mvanbeusekom Apr 17, 2021

cyanglaz Apr 17, 2021

mvanbeusekom Apr 17, 2021

cyanglaz Apr 17, 2021

mvanbeusekom Apr 17, 2021

cyanglaz Apr 17, 2021

mvanbeusekom Apr 17, 2021

cyanglaz Apr 18, 2021

mvanbeusekom Apr 18, 2021

mvanbeusekom commented Apr 17, 2021

cyanglaz left a comment

		#pragma mark Private functions

		- (void)_handleShortcut:(NSString *)shortcut {

[quick_actions] handle cold start on iOS correctly #3811

[quick_actions] handle cold start on iOS correctly #3811

Conversation

mvanbeusekom commented Apr 16, 2021

Pre-launch Checklist

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

mvanbeusekom commented Apr 17, 2021

cyanglaz left a comment

Choose a reason for hiding this comment