[webview_flutter] Add new entrypoint that uses hybrid composition on Android #2883

bparrishMines · 2020-07-17T03:38:59Z

Related Issues

Tests on stable will fail until hybrid views support moves to stable

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.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
No, this is not a breaking change.

packages/webview_flutter/lib/src/webview_android.dart

blasten · 2020-07-18T00:35:22Z

packages/webview_flutter/lib/webview_flutter.dart

+  /// This flag is temporary and is highly subject to removal. One should only
+  /// use this if they are willing to test [WebView] features that aren't
+  /// available in the standard version and acknowledges that it is possible
+  /// this can have slower performance and/or unpredictable bugs.


I don't think it has slower performance necessarily. It depends on what is being measured and how relevant that is.

For example, this mode makes the webview itself much faster. The Flutter UI might be slower, but only on devices below Android 10. Only while the webview is rendered, and Flutter is producing a ton of frames. e.g. animations. That's really it. For the most part, these are pretty good trade-off for webview.

I'd change this description to point out that it's an experimental feature that appends the webview to the Android view hierarchy for better performance and compatibility.

That's it for now. Let me know what you think.

Also, re: unpredictable bug. This is true for any new features, and it's definitely true for the current webview, which is the motivation behind this feature anyways. I think I will rephrase it as "this mode fixes many issues while interacting with the Android webview. For more, see flutter/flutter#61133"

blasten · 2020-07-18T00:51:10Z

packages/webview_flutter/lib/webview_flutter.dart

+  /// this can have slower performance and/or unpredictable bugs.
+  ///
+  /// Defaults to false.
+  final bool useExperimentalAndroidSurfaceView;


What do you think about a separate .dart file that has this feature on by default? This way, we have a BUILD target that automatically adds the metadata to the Android Manifest.

@mehmetf do you have any preference about how to add this feature?

I tried this out, but this file has a lot of private methods/constructors that needed to be copy pasted to the new file. I went with a different approach and decided just create to a new WebViewPlatform implementation that extends AndroidWebView. So, now all a user needs to do is: WebView.platform = SurfaceAndroidWebView(). What are your thoughts on that approach?

…ypoint

pichillilorenzo · 2020-08-05T12:41:42Z

When hybrid views support will move to stable? Thanks!

blasten · 2020-08-05T20:38:04Z

@pichillilorenzo It's on stable now

blasten · 2020-08-06T01:33:25Z

FYI, the documentation is available on https://github.com/flutter/flutter/wiki/Hybrid-Composition

blasten · 2020-08-06T04:38:22Z

This PR is waiting for dynamic thread merging. FYI @cyanglaz

Doflatango · 2020-08-06T10:40:08Z

@pichillilorenzo It's on stable now

So this PR has been released in 1.20.0?

blasten · 2020-09-01T01:14:50Z

packages/webview_flutter/CHANGELOG.md

+  `android/app/src/main/AndroidManifest.xml`:
+```xml
+<application>
+.
+.
+<meta-data
+    android:name="io.flutter.embedded_views_preview"
+    android:value="true" />
+.
+.
+</application>
+```


This won't be needed in 1.22.

blasten · 2020-09-01T01:18:47Z

@amirh would you mind reviewing this PR as well?

Here's what I had in mind so far:

Have this PR ready, and merge it when the 1.22 version comes out.
Decide if a separate entrypoint or feature flag is preferred. I don't have strong preference, but Maurice said that a flag is easier to implement.
Follow up on each issue fixed by this PR.

amirh

Code overall looks good, left a few nits mostly about documentation

amirh · 2020-09-02T19:28:31Z

packages/webview_flutter/lib/webview_flutter.dart

@@ -64,6 +67,60 @@ enum NavigationDecision {
  navigate,
 }

+/// Android [WebViewPlatform] that uses [AndroidViewSurface] to build the [WebView] widget.
+///
+/// To use this, set [WebView.platform] to an instance of this class.


Maybe add some guidance on when should one use it and what are the costs?

done. I added it below. @blasten What are your thoughts on the explanation below?

amirh · 2020-09-02T19:30:36Z

packages/webview_flutter/lib/webview_flutter.dart

+/// Android [WebViewPlatform] that uses [AndroidViewSurface] to build the [WebView] widget.
+///
+/// To use this, set [WebView.platform] to an instance of this class.
+class SurfaceAndroidWebView extends AndroidWebView {


Is the AndroidManifest change required? if so we should probably mention it here

This change is no longer required, so I removed it from the changelog and example

packages/webview_flutter/example/test_driver/webview_flutter_e2e.dart

fddsocool · 2020-09-03T07:47:50Z

This change worked well for my problem. When will the webview_flutter be updated? Thanks!

…ypoint

blasten · 2020-09-21T18:18:51Z

packages/webview_flutter/lib/webview_flutter.dart

+/// This implementation uses Hybrid Composition to render the [WebView] on
+/// Android. It solves multiple issues related to accessibility and interaction
+/// with the [WebView] at the cost of some performance on Android versions below
+/// 10. See https://github.com/flutter/flutter/issues/61133 for more


flutter/flutter#6113 -> https://github.com/flutter/flutter/wiki/Hybrid-Composition

blasten · 2020-09-21T18:19:21Z

packages/webview_flutter/lib/webview_flutter.dart

+///
+/// To use this, set [WebView.platform] to an instance of this class.
+///
+/// This implementation uses Hybrid Composition to render the [WebView] on


Hybrid Composition -> hybrid composition

blasten · 2020-09-21T18:28:44Z

packages/webview_flutter/CHANGELOG.md

+* Add support for building `WebView` widget with Android hybrid views. To use this feature, set
+  `WebView.platform` to an instance of `SurfaceAndroidWebView`.


What about this (note the link to hybrid composition and example):

Add support for building WebView widget with Android hybrid views.
To use this feature, set WebView.platform to an instance of SurfaceAndroidWebView. For example:

class WebViewExample extends StatefulWidget { @override void initState() { super.initState(); WebView.platform = SurfaceAndroidWebView(); } @override Widget build(BuildContext context) { return WebView( initialUrl: 'https://flutter.dev', ); } }

blasten

LGTM + nits

…tion on Android (#2883)" This reverts commit 0d7a605.

…tion on Android (#2883)" (#3066) This reverts commit 0d7a605.

blasten · 2020-09-21T21:01:49Z

Offline chat: let's revert this PR and bump the Flutter SDK in pubspec.yaml to 1.22.

bparrishMines · 2020-09-21T21:03:47Z

Moved to #3067

…Android (flutter#2883)

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

…Android (flutter#2883)

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

…Android (flutter#2883)

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

bparrishMines added 2 commits July 16, 2020 20:33

Add surface view

e8f8ad8

Add test for scrolling hybrid view

6a5927d

bparrishMines requested a review from amirh as a code owner July 17, 2020 03:38

googlebot added the cla: yes label Jul 17, 2020

bparrishMines changed the title ~~[webview_flutter] Add WebView entrypoint~~ [webview_flutter] Add new entrypoint that uses hybrid composition on Android Jul 17, 2020

bparrishMines requested a review from blasten July 17, 2020 20:56

blasten reviewed Jul 18, 2020

View reviewed changes

packages/webview_flutter/lib/src/webview_android.dart Outdated Show resolved Hide resolved

blasten reviewed Jul 18, 2020

View reviewed changes

packages/webview_flutter/lib/src/webview_android.dart Outdated Show resolved Hide resolved

blasten reviewed Jul 18, 2020

View reviewed changes

bparrishMines added 2 commits July 19, 2020 19:00

Create a custom platform for android surface view

8e90cc3

Formatting and changelog

da2a0b9

plateaukao mentioned this pull request Jul 27, 2020

Use PlatformViewLink widget for Android WebView pichillilorenzo/flutter_inappwebview#462

Merged

3 tasks

Merge branch 'master' of github.com:flutter/plugins into webview_entr…

bdd7f2e

…ypoint

blasten reviewed Sep 1, 2020

View reviewed changes

amirh reviewed Sep 2, 2020

View reviewed changes

rahuldange09 mentioned this pull request Sep 7, 2020

[webview_flutter] Add new entrypoint that uses hybrid composition on Android flutter/flutter#61133

Closed

bparrishMines added 5 commits September 14, 2020 20:35

Merge branch 'master' of github.com:flutter/plugins into webview_entr…

1cef7c0

…ypoint

Merge branch 'master' of github.com:flutter/plugins into webview_entr…

24533ed

…ypoint

test reformat and better documentation

29d2b88

slight doc change

7c30a7e

Merge branch 'master' of github.com:flutter/plugins into webview_entr…

6185138

…ypoint

blasten reviewed Sep 21, 2020

View reviewed changes

blasten approved these changes Sep 21, 2020

View reviewed changes

bparrishMines added 2 commits September 21, 2020 12:50

update docs/changelog and hopefully fix ios

c82be0a

fix ios test

28faa1a

bparrishMines merged commit 0d7a605 into flutter:master Sep 21, 2020

bparrishMines deleted the webview_entrypoint branch September 21, 2020 20:54

bparrishMines restored the webview_entrypoint branch September 21, 2020 20:59

bparrishMines added a commit that referenced this pull request Sep 21, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composi…

65dcb12

…tion on Android (#2883)" This reverts commit 0d7a605.

bparrishMines mentioned this pull request Sep 21, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composition on Android" #3066

Merged

bparrishMines added a commit that referenced this pull request Sep 21, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composi…

fdbae3f

…tion on Android (#2883)" (#3066) This reverts commit 0d7a605.

danielroek pushed a commit to Baseflow/flutter-plugins that referenced this pull request Oct 1, 2020

[webview_flutter] Add new entrypoint that uses hybrid composition on …

e7cf00b

…Android (flutter#2883)

danielroek pushed a commit to Baseflow/flutter-plugins that referenced this pull request Oct 1, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composi…

88fb06e

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

jorgefspereira pushed a commit to jorgefspereira/plugins_flutter that referenced this pull request Oct 10, 2020

[webview_flutter] Add new entrypoint that uses hybrid composition on …

c71cc96

…Android (flutter#2883)

jorgefspereira pushed a commit to jorgefspereira/plugins_flutter that referenced this pull request Oct 10, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composi…

b9d969f

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

FlutterSu pushed a commit to FlutterSu/flutter-plugins that referenced this pull request Nov 20, 2020

[webview_flutter] Add new entrypoint that uses hybrid composition on …

3648c08

…Android (flutter#2883)

FlutterSu pushed a commit to FlutterSu/flutter-plugins that referenced this pull request Nov 20, 2020

Revert "[webview_flutter] Add new entrypoint that uses hybrid composi…

9318d1b

…tion on Android (flutter#2883)" (flutter#3066) This reverts commit 0d7a605.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[webview_flutter] Add new entrypoint that uses hybrid composition on Android #2883

[webview_flutter] Add new entrypoint that uses hybrid composition on Android #2883

bparrishMines commented Jul 17, 2020 •

edited

Loading

blasten Jul 18, 2020

blasten Jul 18, 2020

blasten Jul 18, 2020

bparrishMines Jul 20, 2020 •

edited

Loading

pichillilorenzo commented Aug 5, 2020

blasten commented Aug 5, 2020

blasten commented Aug 6, 2020

blasten commented Aug 6, 2020

Doflatango commented Aug 6, 2020

blasten Sep 1, 2020

blasten commented Sep 1, 2020 •

edited

Loading

amirh left a comment

amirh Sep 2, 2020

bparrishMines Sep 18, 2020

amirh Sep 2, 2020

bparrishMines Sep 18, 2020

fddsocool commented Sep 3, 2020

blasten Sep 21, 2020

blasten Sep 21, 2020

blasten Sep 21, 2020

blasten left a comment

blasten commented Sep 21, 2020

bparrishMines commented Sep 21, 2020

		* Add support for building `WebView` widget with Android hybrid views. To use this feature, set
		`WebView.platform` to an instance of `SurfaceAndroidWebView`.

[webview_flutter] Add new entrypoint that uses hybrid composition on Android #2883

[webview_flutter] Add new entrypoint that uses hybrid composition on Android #2883

Conversation

bparrishMines commented Jul 17, 2020 • edited Loading

Related Issues

Checklist

Breaking Change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bparrishMines Jul 20, 2020 • edited Loading

Choose a reason for hiding this comment

pichillilorenzo commented Aug 5, 2020

blasten commented Aug 5, 2020

blasten commented Aug 6, 2020

blasten commented Aug 6, 2020

Doflatango commented Aug 6, 2020

Choose a reason for hiding this comment

blasten commented Sep 1, 2020 • edited Loading

amirh left a 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

fddsocool commented Sep 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blasten left a comment

Choose a reason for hiding this comment

blasten commented Sep 21, 2020

bparrishMines commented Sep 21, 2020

bparrishMines commented Jul 17, 2020 •

edited

Loading

bparrishMines Jul 20, 2020 •

edited

Loading

blasten commented Sep 1, 2020 •

edited

Loading