[url_launcher] Add an `inAppBrowserView` mode #5155

stuartmorgan · 2023-10-16T14:23:30Z

url_launcher_android recently switched from an in-app webview to an Android Custom Tab (when supported), which was intended to be an in-place upgrade. However, this broke closeInAppWebView, and that couldn't be fixed directly because Android Custom Tab has no mechanism for programatic close. To address the regression, this adds a new inAppBrowserView launch mode which is distinct from inAppWebView, so that use cases that require programatic close can specifically request inAppWebView instead. The default for web links is the new inAppBrowserView since that gives better results in most cases.

Since whether closeInAppWebView will work in any given case is now non-trivial (on iOS, both in-app modes are supported, but on Android it's only the web view mode), this adds a new support API to query it, in keeping with the relatively new guidance of https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#api-support-queries. It also adds API to query for support for being able to use specific launch modes, since there wasn't a good way to understand which modes worked in general on different platforms.

Since there are new APIs, this adds support for those APIs to all of our implementations to ensure that they give accurate responses.

Fixes flutter/flutter#134208

Pre-launch Checklist

stuartmorgan · 2023-10-16T14:34:42Z

packages/url_launcher/url_launcher/lib/src/link.dart

@@ -126,7 +126,7 @@ class DefaultLinkDelegate extends StatelessWidget {
      success = await launchUrl(
        url,
        mode: _useWebView
-            ? LaunchMode.inAppWebView
+            ? LaunchMode.inAppBrowserView


I changed this since on Android we generally want to use Custom Tabs when possible, and it'll automatically fall back to webview when support isn't available.

stuartmorgan · 2023-10-16T14:36:47Z

packages/url_launcher/url_launcher/lib/src/url_launcher_uri.dart

+/// required. The default behavior of [LaunchMode.platformDefault] is up to each
+/// platform, and its behavior for a given platform may change over time as new
+/// modes are supported, so clients that want a specific mode should request it
+/// rather than rely on any currently observed default behavior.


This makes the documentation federation-friendly and evergreen. If we find that people want docs about specific platform behaviors, we can add it to the platform package READMEs later.

Per-platform docs are the way, agreed!

stuartmorgan · 2023-10-16T14:39:16Z

packages/url_launcher/url_launcher_android/lib/url_launcher_android.dart

+  }
+
+  @override
+  Future<bool> launchUrl(String url, LaunchOptions options) async {


The reason there's so much change here is that we never went back and implemented launchUrl, so we only had the legacy launch platform interface method. This adds the entire method so that we can support inAppBrowserView.

(That could be done as a prequel without the new mode, but it didn't seem worth splitting out just that small piece; if anyone would prefer that let me know.)

stuartmorgan · 2023-10-16T14:41:33Z

packages/url_launcher/url_launcher_android/lib/url_launcher_android.dart

          url,
+          // Prefer custom tabs unless a webview was specifically requested.
+          options.mode != PreferredLaunchMode.inAppWebView,


I don't distinguish between inAppBrowserView and platformDefault here because I don't know of a use case for trying to force Custom Tabs (which would, e.g., prevent the current "fall back if custom headers are set" logic). If anyone ever actually requests that we can change this to an enum (only web view, only Custom Tab, or whichever works).

stuartmorgan · 2023-10-16T14:43:15Z

packages/url_launcher/url_launcher_android/test/url_launcher_android_test.dart

+      expect(launched, true);
+      expect(api.usedWebView, false);
+    });
+  });


Everything from here up is pretty much copies of the existing legacy (launch) tests, but using launchUrl.

stuartmorgan · 2023-10-16T14:44:14Z

packages/url_launcher/url_launcher_ios/lib/url_launcher_ios.dart

+  }
+
+  @override
+  Future<bool> launchUrl(String url, LaunchOptions options) async {


Technically this isn't required for this PR, but it seemed like a good opportunity to add launchUrl since it's very similar to the Android version. I can make this a separate PR later if preferred.

stuartmorgan · 2023-10-16T14:44:55Z

packages/url_launcher/url_launcher_ios/test/url_launcher_ios_test.dart

+      expect(api.usedSafariViewController, false);
+      expect(api.passedUniversalLinksOnly, false);
+    });
+  });


As with Android tests, the above is copies of the existing tests but with the non-deprecated API.

stuartmorgan · 2023-10-16T14:46:43Z

packages/url_launcher/url_launcher_linux/lib/url_launcher_linux.dart

@@ -51,4 +51,16 @@ class UrlLauncherLinux extends UrlLauncherPlatform {
      },
    ).then((bool? value) => value ?? false);
  }
+


I didn't add launchUrl to the desktop platforms in this PR because they don't currently support any mode switches, so it didn't seem as useful. (Someday I'll update them just so we can deprecate launch.)

ditman

Web bits LGTM!

ditman · 2023-10-16T21:06:36Z

packages/url_launcher/url_launcher_web/lib/url_launcher_web.dart

+  Future<bool> supportsMode(PreferredLaunchMode mode) async {
+    // Web doesn't allow any control over the destination beyond
+    // webOnlyWindowName, so don't claim support for any mode beyond default.
+    return mode == PreferredLaunchMode.platformDefault;


These are good defaults for the web platform. This maybe could be expanded more (if you use window.open, and keep a reference to the window that you opened, it can be closed, for example), but so far I have never heard from anybody wanting the "close" feature on the web.

cbracken · 2023-10-21T01:30:46Z

packages/url_launcher/url_launcher_linux/example/pubspec.yaml

+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins
+dependency_overrides:
+   {url_launcher_platform_interface: {path: ../../../url_launcher/url_launcher_platform_interface}}


Here and elsewhere, I assume this will be backed out?

Yes, this is the combo PR. Once it's approved I'll break it into three and land them in order, and these become constraint updates on the new version.

cbracken

lgtm modulo removal of FOR TESTING AND INITIAL REVIEW bits.

stuartmorgan · 2023-10-23T14:07:29Z

#5205 splits out the first part for landing.

Platform interface portion of #5155. Adds the `inAppBrowserView` launch mode, as well as the `supportsMode` and `supportsCloseForMode` support query APIs.

This reverts commit 50efebc.

Implementation package portion of #5155 This adds: - Android support for the new `inAppBrowserView` launch mode which is distinct from `inAppWebView`, so that use cases that require programatic close can specifically request `inAppWebView` instead. - The default for web links is the new `inAppBrowserView` since that gives better results in most cases. - `inAppBrowserView` will still automatically fall back to `inAppBrowserView` in cases where it's not supported. (In the future, we might want to tune that based on feedback. We could instead have three modes: the webview-only mode we now have, the dynamic mode we now have iff the user requested `platformDefault`, and a new Android Custom Tabs-only if it was explicitly requested which would fail if it doesn't work.) - iOS support for treating `inAppBrowserView` as identical to `inAppWebView`, since in practice that's what its `inAppWebView` mode has always been. - Support on all platforms for the new `supportsMode` and `supportsCloseForMode` support query methods. Fixes flutter/flutter#134208

stuartmorgan · 2023-10-24T18:08:36Z

The sub-PRs have landed and published, and this has been updated to set the implementation package constraints to require versions that have the implementations of the new methods.

…es#5155)

flutter/packages@2faf992...f751ffb 2023-10-25 [email protected] [ci] Enable legacy Android emulator tests (flutter/packages#5190) 2023-10-25 49699333+dependabot[bot]@users.noreply.github.com Bump ossf/scorecard-action from 2.3.0 to 2.3.1 (flutter/packages#5209) 2023-10-25 [email protected] Replace gems dependency with ruby. (flutter/packages#5219) 2023-10-25 [email protected] Update the ftl hardware version. (flutter/packages#5224) 2023-10-25 [email protected] [ci] Disable Windows Arm64 stable CI (flutter/packages#5217) 2023-10-24 [email protected] [webview_flutter_wkwebview] Only set `limitsNavigationsToAppBoundDomains` when it is set to true (flutter/packages#5137) 2023-10-24 [email protected] [url_launcher] Add an `inAppBrowserView` mode (flutter/packages#5155) 2023-10-24 [email protected] [Android] Introduces API 34 emulators for subset of tests (flutter/packages#5105) 2023-10-24 [email protected] [url_launcher] Add an `inAppBrowserView` mode in implementations (flutter/packages#5211) 2023-10-24 [email protected] [ci] Fix legacy Android task names (flutter/packages#5191) 2023-10-24 [email protected] Update annotations deps to 1.7 (flutter/packages#4935) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Platform interface portion of flutter#5155. Adds the `inAppBrowserView` launch mode, as well as the `supportsMode` and `supportsCloseForMode` support query APIs.

…tter#5211) Implementation package portion of flutter#5155 This adds: - Android support for the new `inAppBrowserView` launch mode which is distinct from `inAppWebView`, so that use cases that require programatic close can specifically request `inAppWebView` instead. - The default for web links is the new `inAppBrowserView` since that gives better results in most cases. - `inAppBrowserView` will still automatically fall back to `inAppBrowserView` in cases where it's not supported. (In the future, we might want to tune that based on feedback. We could instead have three modes: the webview-only mode we now have, the dynamic mode we now have iff the user requested `platformDefault`, and a new Android Custom Tabs-only if it was explicitly requested which would fail if it doesn't work.) - iOS support for treating `inAppBrowserView` as identical to `inAppWebView`, since in practice that's what its `inAppWebView` mode has always been. - Support on all platforms for the new `supportsMode` and `supportsCloseForMode` support query methods. Fixes flutter/flutter#134208

`url_launcher_android` recently switched from an in-app webview to an Android Custom Tab (when supported), which was intended to be an in-place upgrade. However, this broke `closeInAppWebView`, and that couldn't be fixed directly because Android Custom Tab has no mechanism for programatic close. To address the regression, this adds a new `inAppBrowserView` launch mode which is distinct from `inAppWebView`, so that use cases that require programatic close can specifically request `inAppWebView` instead. The default for web links is the new `inAppBrowserView` since that gives better results in most cases. Since whether `closeInAppWebView` will work in any given case is now non-trivial (on iOS, both in-app modes are supported, but on Android it's only the web view mode), this adds a new support API to query it, in keeping with the relatively new guidance of https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#api-support-queries. It also adds API to query for support for being able to use specific launch modes, since there wasn't a good way to understand which modes worked in general on different platforms. Since there are new APIs, this adds support for those APIs to all of our implementations to ensure that they give accurate responses. Fixes flutter/flutter#134208

stuartmorgan added 12 commits October 12, 2023 13:25

Add new mode and query methods

7ea59ee

Pathify

50efebc

Add desktop implementations of new methods

d155a01

App-facing updates

177207d

Implement for Android

49c4594

Implement iOS

1334828

Add web support for new methos

f70a5ee

Handle new mode in backwards compat call

3cbffcd

Version bumps

4704684

Update README

8762abe

Update Android example to test Custom Tab

1f70e21

Autoformat generated code

ed562cd

stuartmorgan requested review from cbracken, gmackall and ditman as code owners October 16, 2023 14:23

github-actions bot added platform-android platform-ios platform-linux platform-macos platform-web platform-windows p: url_launcher labels Oct 16, 2023

stuartmorgan commented Oct 16, 2023

View reviewed changes

Add query support to example to match README

28f0553

ditman approved these changes Oct 16, 2023

View reviewed changes

stuartmorgan mentioned this pull request Oct 19, 2023

[url_launcher] Add support for setting show title on Chrome Custom Tabs #5166

Closed

11 tasks

cbracken reviewed Oct 21, 2023

View reviewed changes

cbracken approved these changes Oct 21, 2023

View reviewed changes

stuartmorgan added the federated: all_changes PR that contains changes for all packages for a federated plugin change label Oct 23, 2023

stuartmorgan mentioned this pull request Oct 23, 2023

[url_launcher] Add an inAppBrowserView mode #5205

Merged

11 tasks

auto-submit bot pushed a commit that referenced this pull request Oct 23, 2023

[url_launcher] Add an inAppBrowserView mode (#5205)

d5053b5

Platform interface portion of #5155. Adds the `inAppBrowserView` launch mode, as well as the `supportsMode` and `supportsCloseForMode` support query APIs.

stuartmorgan added 3 commits October 24, 2023 10:16

Merge branch 'main' into url-launcher-in-app-browser

6ceb1fb

Revert "Pathify"

1646161

This reverts commit 50efebc.

Update platform interface constraints

825df8e

stuartmorgan mentioned this pull request Oct 24, 2023

[url_launcher] Add an inAppBrowserView mode in implementations #5211

Merged

11 tasks

stuartmorgan added 2 commits October 24, 2023 13:50

Merge branch 'main' into url-launcher-in-app-browser

e8e2dfc

Update constraints

f89bc12

github-actions bot removed platform-ios platform-linux platform-macos platform-web platform-windows labels Oct 24, 2023

stuartmorgan added 2 commits October 24, 2023 14:03

Adjust example to use browser view for simple case

78bcf3e

Fix changelog typo

d97e911

Bump SDK requirements to match latest url_launcher_web

1104b6e

stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 24, 2023

auto-submit bot merged commit c6821f9 into flutter:main Oct 24, 2023
74 checks passed

stuartmorgan deleted the url-launcher-in-app-browser branch October 24, 2023 19:25

engine-flutter-autoroll mentioned this pull request Oct 25, 2023

Roll Packages from 2faf992a0589 to f751ffb7d3cf (11 revisions) flutter/flutter#137254

Merged

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

c6821f9 [url_launcher] Add an inAppBrowserView mode (flutter/packag…

503b714

…es#5155)

reidbaker mentioned this pull request Jan 12, 2024

Dialog Debug #5881

Closed

reidbaker mentioned this pull request Jan 19, 2024

[in_app_purchase] Add play country code api #5941

Merged

12 tasks

reidbaker mentioned this pull request Feb 19, 2024

[in_app_purchase_android] Add UserChoiceBilling mode. #6162

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[url_launcher] Add an `inAppBrowserView` mode #5155

[url_launcher] Add an `inAppBrowserView` mode #5155

stuartmorgan commented Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

ditman Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

stuartmorgan Oct 16, 2023

ditman left a comment

ditman Oct 16, 2023

cbracken Oct 21, 2023

stuartmorgan Oct 21, 2023 •

edited

Loading

cbracken left a comment

stuartmorgan commented Oct 23, 2023

stuartmorgan commented Oct 24, 2023

[url_launcher] Add an inAppBrowserView mode #5155

[url_launcher] Add an inAppBrowserView mode #5155

Conversation

stuartmorgan commented Oct 16, 2023

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

ditman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stuartmorgan Oct 21, 2023 • edited Loading

Choose a reason for hiding this comment

cbracken left a comment

Choose a reason for hiding this comment

stuartmorgan commented Oct 23, 2023

stuartmorgan commented Oct 24, 2023

[url_launcher] Add an `inAppBrowserView` mode #5155

[url_launcher] Add an `inAppBrowserView` mode #5155

stuartmorgan Oct 21, 2023 •

edited

Loading