Support iOS universal links route deep linking #27874

jmagman · 2021-08-03T23:12:33Z

Support deep linking/route pushing via universal links, which are registered http and https scheme URLs, in addition to the already-supported custom schemes.

If the URL isn't handled by the life cycle delegate, and isn't from web browsing, send pushRoute to the app.
Share the open link/routing logic between -application:continueUserActivity:restorationHandler: and -application:openURL:options:.

Fixes flutter/flutter#82550

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide] and the [C++, Objective-C, Java style guides].
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See [testing the engine] for instructions on
writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the [CLA].
All existing and new tests are passing.

jmagman · 2021-08-03T23:13:40Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegate.mm

-            openURL:(NSURL*)url
-            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
-    infoPlistGetter:(NSDictionary* (^)())infoPlistGetter {
-  if ([_lifeCycleDelegate application:application openURL:url options:options]) {


This method is now shared between two app delegate methods. Move the method-specific _lifeCycleDelegate check up one level to -application:openURL:options:.

jmagman · 2021-08-03T23:14:41Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegate.mm

-           infoPlistGetter:^NSDictionary*() {
-             return [[NSBundle mainBundle] infoDictionary];
-           }];
+  if ([_lifeCycleDelegate application:application openURL:url options:options]) {


(it was moved here)

gaaclarke · 2021-08-04T18:25:57Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegate.mm

+  if (userActivity.activityType == NSUserActivityTypeBrowsingWeb) {
+    return NO;
+  }


I'm not catching why this is here. It sounds like NSUserActivityTypeBrowsingWeb is associated with universal links? Wouldn't you want this? I see this behavior matches what you want in your test so I assume it's true, I'm just not familiar with the API.

Maybe a few words as to why we return NO here?

Actually, this is a good question. @AlBlanc I noticed you did you did this in #25705 and meant to follow up. Why did you avoid this activity type?

I don't see a reason to not process NSUserActivityTypeBrowsingWeb so I removed this and the test.
https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app

We can always add it back later if there's some good reason to.

That sounds fine with me, we could wait a bit more to give @AlBlanc 24 hours to respond. He's probably celebrating the France basketball teams win =)

I was thinking I can merge this now and put the additional PR if should be excluded. Based on my reading of https://developer.apple.com/documentation/xcode/supporting-universal-links-in-your-app it shouldn't be.
But yeah I can wait too, it's not a rush...

I'm going to merge this. I'll change it if we hear we need to exclude NSUserActivityTypeBrowsingWeb for some reason.

gaaclarke · 2021-08-04T18:31:37Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegateTest.mm

+  OCMReject([navigationChannel invokeMethod:OCMOCK_ANY arguments:OCMOCK_ANY]);
+}
+
+- (void)testUniversalLinkPushRoute {


These 2 tests are very similar, maybe it's worth considering pulling out a helper function to remove some of the boilerplate so the differences are more apparent.

I pulled the boilderplate in all these tests up into setUp. Hopefully it's easier to read now.

jmagman · 2021-08-05T01:41:38Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegate_Test.h

- (BOOL)application:(UIApplication*)application
-            openURL:(NSURL*)url
-            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id>*)options
-    infoPlistGetter:(NSDictionary* (^)())infoPlistGetter;


I wound up getting rid of this test injection helper and mocking out -[NSBundle objectForInfoDictionaryKey:] instead.

jmagman · 2021-08-05T01:42:04Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegateTest.mm

+  OCMReject([navigationChannel invokeMethod:OCMOCK_ANY arguments:OCMOCK_ANY]);
+}
+
+- (void)testUniversalLinkPushRoute {


I pulled the boilderplate in all these tests up into setUp. Hopefully it's easier to read now.

jmagman · 2021-08-05T01:43:09Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegateTest.mm

+
+// Retain callback until the tests are done.
+// https://github.com/flutter/flutter/issues/74267
+@property(strong) id mockEngineFirstFrameCallback;


I only just landed #27854 but this is probably a better name than blockNoInvoker. Open to suggestions though!

jmagman · 2021-08-05T01:44:33Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegate.mm

-    return YES;
-  } else if (!IsDeepLinkingEnabled(infoPlistGetter())) {
+- (BOOL)openURL:(NSURL*)url {
+  NSNumber* isDeepLinkingEnabled =


I was able to get rid of the static function here. -[NSBundle objectForInfoDictionaryKey:] is now mocked in the tests.

jmagman · 2021-08-05T01:44:43Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegateTest.mm

+                                           arguments:@"/custom/route?query=test"]);
+}
+
+- (void)testLaunchUrlWithDeepLinkingNotSet {


jmagman · 2021-08-05T01:44:49Z

shell/platform/darwin/ios/framework/Source/FlutterAppDelegateTest.mm

+  OCMReject([self.mockNavigationChannel invokeMethod:OCMOCK_ANY arguments:OCMOCK_ANY]);
+}
+
+- (void)testLaunchUrlWithDeepLinkingDisabled {


…e#27874)

vasilich6107 · 2021-10-06T15:45:11Z

Hi @jmagman
Could you clarify what version of flutter includes this fix?

jmagman · 2021-10-06T17:26:30Z

Hi @jmagman Could you clarify what version of flutter includes this fix?

2.6.0-0.0.pre

vasilich6107 · 2021-10-07T13:55:16Z

Hi @jmagman
I installed 2.6.0 as you recommended.

The deep links works fine when I tap the link from email app.

The issue is if I attach the link to push notification and tap on incoming push message -> it still opens the webview.

Is this ok for current implementation?

jmagman · 2021-10-07T17:18:32Z

The issue is if I attach the link to push notification and tap on incoming push message -> it still opens the webview.

@vasilich6107 can you file a new issue with reproduction steps?

vasilich6107 · 2021-10-07T18:45:54Z

No problem. Will do

janjoosse · 2021-10-12T16:37:12Z

@vasilich6107 What setup and configuration did you do to get the deep links working (for links from an email)?

vasilich6107 · 2021-10-12T18:06:49Z

@janjoosse thanks for support
Will have time to fire properly described issue on Thursday

ikurek · 2021-11-15T17:49:03Z

@vasilich6107 Did you open the issue? I'm also having problems with deep links when they are in foreground, after deep link is fired (either from push notification or CLI) RouteInformationParser and RouteInformationProvider do not receive any kind of information about route change (although they do on Android). May be the same thing as in your case

dragouf · 2022-02-19T11:14:48Z

I'm using flutter 2.10.1 and when I request:
/usr/bin/xcrun simctl openurl booted "https://mydomain.com/mypath"

it open the app but the view is not push based on the path as expected (it works perfectly on android).

Is this still working in 2.10 ? FlutterDeepLinkingEnabled is set to true for ios. It's what I need to get the view automatically pushed right ? I use onGenerateRoute for named routes.

EDIT: by removing uni_links lib from my project it now works !

percula · 2022-02-21T12:55:20Z

@dragouf Are the instructions at https://docs.flutter.dev/development/ui/navigation/deep-linking#enable-deep-linking-on-ios still valid for universal links? I don't see why we need the custom scheme. Do we still need the CFBundleURLTypes entry for universal links?

dragouf · 2022-02-21T13:13:59Z

@percula what they call deep links is not universal links. Deep links use custom scheme when universal links (or app links for android) use https.

If you want to use https instead of custom scheme follow the readme of this library to activate it: https://pub.dev/packages/uni_links

but do not install the library if you want the view to be pushed automatically based on the link path (the library seems to conflicts with this mechanism).

so after I enabled universal links I use named routes with something like:

MaterialApp(onGenerateRoute: AppRouter.onGenerateRoute)

and

class AppRouter {
  static Route<dynamic> onGenerateRoute(RouteSettings settings) {
    if (settings.name != null && settings.name!.startsWith('/thepath/') {
      return CupertinoPageRoute(
        fullscreenDialog: true,
        builder: (_) => const MyWidgetView(),
      );
    }
}

settings.name will contain the path from your link.

jmagman added the platform-ios label Aug 3, 2021

jmagman self-assigned this Aug 3, 2021

google-cla bot added the cla: yes label Aug 3, 2021

jmagman force-pushed the universal-links branch from d9521e5 to 1e1786f Compare August 3, 2021 23:15

jmagman commented Aug 3, 2021

View reviewed changes

jmagman force-pushed the universal-links branch from 1e1786f to 3c1f65c Compare August 4, 2021 01:07

jmagman requested a review from gaaclarke August 4, 2021 17:17

gaaclarke approved these changes Aug 4, 2021

View reviewed changes

jmagman force-pushed the universal-links branch from 3c1f65c to bee48ca Compare August 5, 2021 01:39

jmagman commented Aug 5, 2021

View reviewed changes

jmagman added 3 commits August 5, 2021 10:35

Support iOS universal links route deep linking

dae79c8

Move more logic into test setup, remove infoPlistGetter helper

9989ab0

Remove browser exception

673d3eb

jmagman force-pushed the universal-links branch from bee48ca to 673d3eb Compare August 5, 2021 18:14

jmagman added the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label Aug 9, 2021

fluttergithubbot merged commit 266435d into flutter:master Aug 9, 2021

jmagman deleted the universal-links branch August 10, 2021 20:05

engine-flutter-autoroll mentioned this pull request Aug 11, 2021

Roll Engine from 4fef55db1031 to d8bbebed60a7 (45 revisions) flutter/flutter#88036

Merged

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

266435d Support iOS universal links route deep linking (flutter/engin…

de1ec80

…e#27874)

filmil pushed a commit to filmil/engine that referenced this pull request Apr 21, 2022

Support iOS universal links route deep linking (flutter#27874)

e0f5a5f

jmagman mentioned this pull request Feb 6, 2023

Opt-in to Flutter deep linking does not disable listening to deep links via plugins flutter/flutter#119938

Open

Support iOS universal links route deep linking #27874

Support iOS universal links route deep linking #27874

Uh oh!

Conversation

jmagman commented Aug 3, 2021 • 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!

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!

vasilich6107 commented Oct 6, 2021

Uh oh!

jmagman commented Oct 6, 2021

Uh oh!

vasilich6107 commented Oct 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jmagman commented Oct 7, 2021

Uh oh!

vasilich6107 commented Oct 7, 2021

Uh oh!

janjoosse commented Oct 12, 2021

Uh oh!

vasilich6107 commented Oct 12, 2021

Uh oh!

ikurek commented Nov 15, 2021

Uh oh!

dragouf commented Feb 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

percula commented Feb 21, 2022

Uh oh!

dragouf commented Feb 21, 2022

Uh oh!

Uh oh!

jmagman commented Aug 3, 2021 •

edited

Loading

vasilich6107 commented Oct 7, 2021 •

edited

Loading

dragouf commented Feb 19, 2022 •

edited

Loading