support uri intent launcher in android #21275

chunhtai · 2020-09-18T22:59:26Z

Description

Adds support to uri launch intent that is recommended in https://developer.android.com/training/app-links/verify-site-associations

With this patch, in order to set up deep link, the developer will need to add the intent filter in their AndroidManifest.xml
path/to/flutter_app/android/app/src/main/AndroidManifest.xml

<activity ...>

    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="http" android:host="www.example.com" />
        <data android:scheme="https" />
    </intent-filter>

</activity>

This will catch intents such as http://www.example.com/relative/path, and the string will be stored in window.defaultRouteName when app launch

Related Issues

Fixes flutter/flutter#66148

Tests

I added the following tests:

see files

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

I read the contributor guide and followed the process outlined there for submitting PRs.
I signed the CLA.
I read and followed the C++, Objective-C, Java style guides for the engine.
I read the tree hygiene wiki page, which explains my responsibilities.
I updated/added relevant documentation.
All existing and new tests are passing.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read handling breaking changes.

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.
- I wrote a design doc: https://flutter.dev/go/template Replace this with a link to your design doc's short link
- I got input from the developer relations team, specifically from: Replace with the names of who gave advice
- I wrote a migration guide: https://flutter.dev/go/breaking-changes-template Replace this with a link to a pull request that adds the migration guide to https://flutter.dev/docs/release/breaking-changes

chunhtai · 2020-09-18T23:18:46Z

shell/platform/android/io/flutter/embedding/android/FlutterActivity.java

-    if (getIntent().hasExtra(EXTRA_INITIAL_ROUTE)) {
-      return getIntent().getStringExtra(EXTRA_INITIAL_ROUTE);
+    Intent intent = getIntent();
+    Uri data = intent.getData();


The developer still need to manually modify the AndroidManifest to add an intent filter. I wonder if we can automatically generate the intent filter for them so it will be much simpler for flutter beginner to work with deeplink.

You can change the default create template's AndroidManifest if I understood

xster · 2020-09-19T07:16:40Z

shell/platform/android/io/flutter/embedding/android/FlutterActivity.java

-    if (getIntent().hasExtra(EXTRA_INITIAL_ROUTE)) {
-      return getIntent().getStringExtra(EXTRA_INITIAL_ROUTE);
+    Intent intent = getIntent();
+    Uri data = intent.getData();


You can change the default create template's AndroidManifest if I understood

shell/platform/android/io/flutter/embedding/android/FlutterActivity.java

gaaclarke · 2020-09-22T20:56:30Z

shell/platform/android/test/io/flutter/embedding/android/FlutterActivityTest.java

+  @Test
+  public void itCreatesNewEngineIntentWithLaunchUri() {
+    Intent intent = FlutterActivity.createDefaultIntent(RuntimeEnvironment.application);
+    intent.setData(Uri.parse("http://myApp/custom/route"));


Hey @chunhtai what is up with the myApp portion of the URL? It seems to be ignored.

yes, currently it only returns URI.path.
I will change to return full URI per our discussion.

goderbauer · 2020-09-29T18:01:21Z

With this change in place, what do I need to do (e.g. add to the manifest) to make it work?

chunhtai · 2020-09-29T18:15:15Z

With this patch, developer only need to add intent-filter in manifest, and the Windows.defaultRouteName will have the url string from the deeplink.

chunhtai · 2020-09-29T18:17:09Z

One thing i am still not certain is that whether we should add the api (maybe through plugin) to override this behavior. For example if user want to do a preprocess on the URL

goderbauer · 2020-09-29T18:24:52Z

With this patch, developer only need to add intent-filter in manifest, and the Windows.defaultRouteName will have the url string from the deeplink.

Can you post an example of what that looks like into the PR description so we have it all in one place?

chunhtai · 2020-09-30T21:53:31Z

This is ready for another look!

xster · 2020-10-01T04:36:21Z

Is this support meant for full-Flutter apps only? i.e. what happens with custom engines? What happens on onNewIntent if the activity is already open and you get another notification (with another deep link)?

chunhtai · 2020-10-01T16:25:05Z

Ah yes, we should deal with on newIntent too

gaaclarke · 2020-10-01T16:44:21Z

We talked about this offline, but is this the correct behavior we want for an app that is already running? Is there a way to navigate back to the way the app was before launching the url? The physical back button? It seems like the back button would take you to what you are looking at before you launched the url, like the web browser.

goderbauer · 2020-10-01T16:46:39Z

We talked about this offline, but is this the correct behavior we want for an app that is already running? Is there a way to navigate back to the way the app was before launching the url? The physical back button? It seems like the back button would take you to what you are looking at before you launched the url, like the web browser.

That would be up to the developer to decide. In the Router, when a new URL is given to you, you can decide whether you want to put a new page on top of what's already visible (and provide a back button in the app) or whether you want to send the user to a different location in the app "loosing" their old state.

chunhtai · 2020-10-01T18:47:22Z

Is this support meant for full-Flutter apps only? i.e. what happens with custom engines? What happens on onNewIntent if the activity is already open and you get another notification (with another deep link)?

I am not quite sure about custom engines. Did you mean developer modify the engine code and compile? I don't think that is within the scope of this change.

xster · 2020-10-01T19:16:45Z

I am not quite sure about custom engines. Did you mean developer modify the engine code and compile? I don't think that is within the scope of this change.

Sorry, that's not what I meant. I meant creating a FlutterActivity with a self-supplied engine instance which is the primary recommendation for add-to-app users. i.e. do you intend to make deep links on Android (where the users filtered the intent to the Flutter activity in their add-to-app AndroidManifest) work in add-to-app scenarios?

chunhtai · 2020-10-01T19:34:57Z

@xster yes, I think we should support this use case too. I am not too familiar with this workflow, does it go through FlutterFragmentActivity? If I added the getinitialroute on the FlutterFragmentActivity it should work as expected?

gaaclarke · 2020-10-01T20:20:12Z

That would be up to the developer to decide. In the Router, when a new URL is given to you, you can decide whether you want to put a new page on top of what's already visible (and provide a back button in the app) or whether you want to send the user to a different location in the app "loosing" their old state.

Isn't the way it is implemented right now always create a new Activity? There is no sending of a message to Flutter that allows the developer to decide how to handle it.

chunhtai · 2020-10-01T20:32:55Z

That would be up to the developer to decide. In the Router, when a new URL is given to you, you can decide whether you want to put a new page on top of what's already visible (and provide a back button in the app) or whether you want to send the user to a different location in the app "loosing" their old state.

Isn't the way it is implemented right now always create a new Activity? There is no sending of a message to Flutter that allows the developer to decide how to handle it.

No I just double check, it just bring the existing activity to the front. Sorry for the confusing earlier

xster · 2020-10-09T17:17:40Z

shell/platform/android/io/flutter/embedding/android/FlutterActivity.java

@@ -782,8 +783,13 @@ public String getDartEntrypointFunctionName() {
   */
  @NonNull
  public String getInitialRoute() {
-    if (getIntent().hasExtra(EXTRA_INITIAL_ROUTE)) {
-      return getIntent().getStringExtra(EXTRA_INITIAL_ROUTE);
+    Intent intent = getIntent();


how did you decide on the order? of whether to take the data string of the intent vs reading from the extra flag?

I make uri launch takes priority with no specific reason. Is there a desired order here?

if EXTRA_INITIAL_ROUTE is present, it means the users had very specifically instructed it. I would have it take precedence.

String data in an intent could theoretically be anything and the engine doesn't do any validation here. Does the framework react in the right way if one just sends adb shell am start --es "blah blah"?

--es will send the string to extra so it will not affect the intent.getData();

the getData always returns an URI and it must pass the intent filter, so I think we should be fine.

xster · 2020-10-09T17:21:46Z

shell/platform/android/io/flutter/embedding/android/FlutterActivityAndFragmentDelegate.java

      flutterEngine.getActivityControlSurface().onNewIntent(intent);
+      Uri data = intent.getData();


there's a little bit of inconsistently between here and the getinitialroute

Have stuff in flutteractivity/fragment if you expect subclass developers to actively decide whether they want to keep or override this behavior.

If the same behavior's in both activity and fragment, just move them to the delegate (and make sure to document what the default behavior is in the javadoc).

xster

The rest LG

chinmaygarde · 2020-10-15T21:32:14Z

Is there a blocker to landing this?

chunhtai · 2020-10-15T22:08:00Z

No, I will get to this by the end of this week

chunhtai · 2020-10-19T22:35:22Z

Hi @xster I refactor the getinitialroute to delegate, can you take another look to see if it still looks good?

chinmaygarde · 2020-10-22T22:04:07Z

@xster Can you take another look? Let's land this now that the tree is open.

xster · 2020-10-22T22:44:27Z

LGTM, thanks

* 000bf4b Roll Skia from 2d2f82c00aeb to 5c7bb326a7b3 (33 revisions) (flutter/engine#22059) * ae92dbf Roll Fuchsia Linux SDK from lPMs_KwnU... to gqS_DIjN4... (flutter/engine#22057) * 92cd74e Roll Fuchsia Mac SDK from pZ9FgVZTK... to WLxBkBnZa... (flutter/engine#22055) * e51c710 Roll Dart SDK from a3d902d8598e to 9f907e198970 (2 revisions) (flutter/engine#22058) * 326b202 Reland fuchsia external view embedder will be shared with platform view (flutter/engine#22008) * a9a9a2f Roll Skia from 5c7bb326a7b3 to 65674e4c2e56 (3 revisions) (flutter/engine#22060) * 1233fe4 Revert "Revert "Explicitly make the X connection for EGL. (#21831)" (#21851)" (flutter/engine#21871) * aed8e01 Fixes Edge trigger route change announcement (flutter/engine#21975) * 6bc70e4 Reland: Migration to PlatformDispatcher and multi-window (flutter/engine#21932) * 5ca5e26 Add FlEventChannel (flutter/engine#21316) * 77b0052 Roll Skia from 65674e4c2e56 to 01b05e5b830b (3 revisions) (flutter/engine#22062) * 3d27fd5 Support loading assets from Android dynamic feature modules (flutter/engine#21504) * 742dfbe support uri intent launcher in android (flutter/engine#21275) * cde1e3f Auto detect mode to determine which rendering backend to use. (flutter/engine#21852) * 329ccf7 Roll Skia from 01b05e5b830b to 53281c712159 (1 revision) (flutter/engine#22065) * cde78c1 Add a golden scenario test for fallback font rendering on iOS take 2 (flutter/engine#22033) * 4f4599b Roll Dart SDK from 9f907e198970 to 37ccceacad41 (3 revisions) (flutter/engine#22069) * f0b10c5 [web] Prevent using DOM nodes for canvas with large number of draws (flutter/engine#22064) * a86ba57 Roll Fuchsia Mac SDK from WLxBkBnZa... to zDfaxkqlv... (flutter/engine#22073) * 645198a Roll Fuchsia Linux SDK from gqS_DIjN4... to vuKxZmSVj... (flutter/engine#22074) * 0b26570 Revert dart rolls (flutter/engine#22078)

mehmetf · 2020-11-04T16:20:55Z

One thing i am still not certain is that whether we should add the api (maybe through plugin) to override this behavior. For example if user want to do a preprocess on the URL.

There should be a way to migrate to this capability since this is a breaking change. Some older apps already implement their own custom intent handling mechanism. customer: fun (g3) got affected by this. See b/172394233

This reverts commit 742dfbe.

…" (flutter#22298)" This reverts commit f61cbc0.

* Revert "Revert "support uri intent launcher in android (#21275)" (#22298)" This reverts commit f61cbc0. * reland support uri launch for android * refactor * update * fix test * addressing comments * addressing comments * revert throw error

* support uri intent launcher in android * fix comment

…ter#22298)

* Revert "Revert "support uri intent launcher in android (flutter#21275)" (flutter#22298)" This reverts commit f61cbc0. * reland support uri launch for android * refactor * update * fix test * addressing comments * addressing comments * revert throw error

flutter-dashboard bot added the platform-android label Sep 18, 2020

googlebot added the cla: yes label Sep 18, 2020

auto-assign bot requested a review from chinmaygarde September 18, 2020 22:59

chunhtai commented Sep 18, 2020

View reviewed changes

xster reviewed Sep 19, 2020

View reviewed changes

gaaclarke reviewed Sep 22, 2020

View reviewed changes

chunhtai force-pushed the issues/66148 branch from 3909e53 to 5e0dffd Compare September 30, 2020 21:47

chunhtai requested review from xster and gaaclarke September 30, 2020 21:53

chunhtai added the Work in progress (WIP) Not ready (yet) for review! label Oct 1, 2020

chunhtai removed the Work in progress (WIP) Not ready (yet) for review! label Oct 1, 2020

chunhtai force-pushed the issues/66148 branch from 5f9f17a to cfb085c Compare October 2, 2020 21:31

xster reviewed Oct 9, 2020

View reviewed changes

xster approved these changes Oct 9, 2020

View reviewed changes

support uri intent launcher in android

f7b7af9

chunhtai force-pushed the issues/66148 branch from cfb085c to f7b7af9 Compare October 19, 2020 22:33

fix comment

ed96df0

chunhtai requested a review from xster October 19, 2020 22:34

chunhtai merged commit 742dfbe into flutter:master Oct 22, 2020

engine-flutter-autoroll mentioned this pull request Oct 23, 2020

Roll Engine from defa8be2b106 to cde1e3fca8dc (14 revisions) flutter/flutter#68849

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 23, 2020

742dfbe support uri intent launcher in android (flutter/engine#21275)

5af0d5b

engine-flutter-autoroll mentioned this pull request Oct 23, 2020

Roll Engine from defa8be2b106 to 4f4599b269c5 (17 revisions) flutter/flutter#68852

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 23, 2020

742dfbe support uri intent launcher in android (flutter/engine#21275)

a2bcacc

engine-flutter-autoroll mentioned this pull request Oct 23, 2020

Roll Engine from defa8be2b106 to f0b10c54bf68 (18 revisions) flutter/flutter#68859

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 23, 2020

742dfbe support uri intent launcher in android (flutter/engine#21275)

8d775db

engine-flutter-autoroll mentioned this pull request Oct 23, 2020

Roll Engine from defa8be2b106 to 645198aa72c1 (20 revisions) flutter/flutter#68863

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 23, 2020

742dfbe support uri intent launcher in android (flutter/engine#21275)

2dd62a0

engine-flutter-autoroll mentioned this pull request Oct 23, 2020

Roll Engine from defa8be2b106 to 0b26570e933f (21 revisions) flutter/flutter#68897

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 23, 2020

742dfbe support uri intent launcher in android (flutter/engine#21275)

2609599

chunhtai mentioned this pull request Nov 4, 2020

Ability to turn off Android deeplink flutter/flutter#69786

Closed

chunhtai added a commit to chunhtai/engine that referenced this pull request Nov 4, 2020

Revert "support uri intent launcher in android (flutter#21275)"

1320b9f

This reverts commit 742dfbe.

fluttergithubbot pushed a commit that referenced this pull request Nov 4, 2020

Revert "support uri intent launcher in android (#21275)" (#22298)

f61cbc0

chunhtai added a commit to chunhtai/engine that referenced this pull request Nov 6, 2020

Revert "Revert "support uri intent launcher in android (flutter#21275)…

6b91104

…" (flutter#22298)" This reverts commit f61cbc0.

chunhtai added a commit to chunhtai/engine that referenced this pull request Nov 10, 2020

Revert "Revert "support uri intent launcher in android (flutter#21275)…

cda2c3b

…" (flutter#22298)" This reverts commit f61cbc0.

chaselatta pushed a commit to chaselatta/engine that referenced this pull request Nov 30, 2020

support uri intent launcher in android (flutter#21275)

b0a68cd

* support uri intent launcher in android * fix comment

chaselatta pushed a commit to chaselatta/engine that referenced this pull request Nov 30, 2020

Revert "support uri intent launcher in android (flutter#21275)" (flut…

b1ce13c

…ter#22298)

		flutterEngine.getActivityControlSurface().onNewIntent(intent);
		Uri data = intent.getData();

support uri intent launcher in android #21275

support uri intent launcher in android #21275

Uh oh!

Conversation

chunhtai commented Sep 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer commented Sep 29, 2020

Uh oh!

chunhtai commented Sep 29, 2020

Uh oh!

chunhtai commented Sep 29, 2020

Uh oh!

goderbauer commented Sep 29, 2020

Uh oh!

chunhtai commented Sep 30, 2020

Uh oh!

xster commented Oct 1, 2020

Uh oh!

chunhtai commented Oct 1, 2020

Uh oh!

gaaclarke commented Oct 1, 2020

Uh oh!

goderbauer commented Oct 1, 2020

Uh oh!

chunhtai commented Oct 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xster commented Oct 1, 2020

Uh oh!

chunhtai commented Oct 1, 2020

Uh oh!

gaaclarke commented Oct 1, 2020

Uh oh!

chunhtai commented Oct 1, 2020

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!

chunhtai Oct 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xster left a comment

Choose a reason for hiding this comment

Uh oh!

chinmaygarde commented Oct 15, 2020

Uh oh!

chunhtai commented Oct 15, 2020

Uh oh!

chunhtai commented Oct 19, 2020

Uh oh!

chinmaygarde commented Oct 22, 2020

Uh oh!

xster commented Oct 22, 2020

Uh oh!

mehmetf commented Nov 4, 2020

Uh oh!

Uh oh!

chunhtai commented Sep 18, 2020 •

edited

Loading

chunhtai commented Oct 1, 2020 •

edited

Loading

chunhtai Oct 19, 2020 •

edited

Loading