[webview_flutter] get/set a custom User Agent #1920

LuisThein · 2019-07-27T12:24:05Z

Description

Based on this pull request #968 that was closed, I added the functionality to set a custom User Agent and get the current User Agent in the current WebView version.

Related Issues

flutter/flutter#28256

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.

- Added userAgent field to WebView - Added userAgent getter to WebViewController - Updated CreationParams and WebViewSettings - Added MethodChannel for 'getUserAgent'

- added updateUserAgent Method - added getUserAgent Method - userAgent gets set in flutter example

- added onGetUserAgent Method - added updateUserAgent Method - updated applySettings Method

- added tests for get/set User Agent - allow currentValue.userAgent/newValue.userAgent to be null in _clearUnchangedWebSettings

googlebot · 2019-07-27T12:24:08Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and have the pull request author add another comment and the bot will run again. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

LuisThein · 2019-07-27T12:54:40Z

Updated emails for CLA.

googlebot · 2019-07-27T12:54:47Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

tp · 2019-07-30T14:57:36Z

Thank you @LuisThein, we're already making use of this as we had the same requirement to change the user agent :)

packages/webview_flutter/example/test_driver/webview.dart

packages/webview_flutter/lib/webview_flutter.dart

amirh · 2019-08-02T21:22:08Z

packages/webview_flutter/lib/src/webview_method_channel.dart

    _addIfNonNull('jsMode', settings.javascriptMode?.index);
    _addIfNonNull('hasNavigationDelegate', settings.hasNavigationDelegate);
    _addIfNonNull('debuggingEnabled', settings.debuggingEnabled);
+    _addIfNonNull('userAgent', settings.userAgent);


What happens if we rebuild a WebView that had an explicitly set userAgent and set the userAgent to null. IIUC the way this currently propagates will lead to preserving the previous user agent. I'd expect it to go back to the platform's default user agent.

We should add an test for this scenario as well (build with an explicitly set user agent, rebuild with user agent set to null)

Makes sense. I changed it so that the user agent can be set to null and the default platform user agent is used after a rebuild. Additionally I adapted the same logic for the FakePlatformWebView unit tests.

Thanks!
I think we should avoid updating the user agent each time the widget is rebuilt.
It seems like we're lacking the ability to express presence/absence of a setting that may be null. One way to do it would be to use some kind of an optional type.

I pushed 7976151 with a proposal on how to do that, let me know whether that makes sense to you.

I think that is a nice way to handle nullable settings and I agree that updating the user agent every rebuild is unnecessary.

packages/webview_flutter/lib/platform_interface.dart

packages/webview_flutter/ios/Classes/FlutterWebView.m

- Updated Dartdoc comments - Changed tests to reuse one globalkey - Added test for rebuilding the webView with no user agent after setting the user agent

- Added comment to _webSettingsToMap regarding nullability of user agent - Changed handling of null user agent in FakePlatformWebView according to changes in WebviewMethodChannel

LuisThein · 2019-08-11T09:54:48Z

Added requested changes and updated branch.

.../webview_flutter/android/src/main/java/io/flutter/plugins/webviewflutter/FlutterWebView.java

amirh · 2019-08-14T19:39:40Z

@LuisThein I pushed a few changes to your branch.
I'm ok with the current state of this PR.
Let me know whether the updates I pushed makes sense to you as well.

amirh

LGTM

I pushed a few changes to the branch, let me know if these make sense to you.

packages/webview_flutter/ios/Classes/FlutterWebView.m

- Renoved functions involved in getting the user agent - Updated tests to inject javascript to get the current user agent - updated changelog

…/plugins into feature/set_user_agent

.../webview_flutter/android/src/main/java/io/flutter/plugins/webviewflutter/FlutterWebView.java

amirh

LGTM

flutter/flutter#28256

LuisThein and others added 6 commits July 26, 2019 13:09

Flutter implementation

953e220

- Added userAgent field to WebView - Added userAgent getter to WebViewController - Updated CreationParams and WebViewSettings - Added MethodChannel for 'getUserAgent'

Added Android implementation + updated example

9478588

- added updateUserAgent Method - added getUserAgent Method - userAgent gets set in flutter example

iOS implementation

45e915d

- added onGetUserAgent Method - added updateUserAgent Method - updated applySettings Method

Added Widget Test

ae81a98

Added unit tests for User Agent

de27c90

- added tests for get/set User Agent - allow currentValue.userAgent/newValue.userAgent to be null in _clearUnchangedWebSettings

Updated CHANGELOG.md

cbcc808

LuisThein requested a review from amirh as a code owner July 27, 2019 12:24

googlebot added the cla: no label Jul 27, 2019

Merge branch 'master' into feature/set_user_agent

4141cf2

googlebot added cla: yes and removed cla: no labels Jul 27, 2019

LuisThein added 2 commits July 27, 2019 15:47

Fixed format error in FlutterwebView.m

d54e0bc

Fixed another format error

86d44ca

Merge branch 'master' into feature/set_user_agent

7959989

amirh suggested changes Aug 2, 2019

View reviewed changes

amirh added the in review label Aug 2, 2019

LuisThein and others added 5 commits August 5, 2019 10:35

Changed files according to pull request review

7b26a41

- Updated Dartdoc comments - Changed tests to reuse one globalkey - Added test for rebuilding the webView with no user agent after setting the user agent

Minor changes

7fed032

- Added comment to _webSettingsToMap regarding nullability of user agent - Changed handling of null user agent in FakePlatformWebView according to changes in WebviewMethodChannel

Updated dartdoc for WebView.userAgent

c5cc6a7

Merged branch master into feature/set_user_agent

c99c8f2

Resolved nerge conflicts.

c931307

Use a WebSetting<T> type to allow representing absence of a null value.

7976151

amirh reviewed Aug 14, 2019

View reviewed changes

.../webview_flutter/android/src/main/java/io/flutter/plugins/webviewflutter/FlutterWebView.java Show resolved Hide resolved

amirh added 2 commits August 14, 2019 12:25

review fixes

4c0d2f3

Merge branch 'master' into feature/set_user_agent

de4d1df

bump version

5be86ef

amirh approved these changes Aug 14, 2019

View reviewed changes

amirh added 2 commits August 14, 2019 13:45

Merge branch 'master' into feature/set_user_agent

5887b33

remove extra blank line from changelog

bf8b74c

amirh suggested changes Aug 14, 2019

View reviewed changes

packages/webview_flutter/ios/Classes/FlutterWebView.m Outdated Show resolved Hide resolved

LuisThein added 4 commits August 15, 2019 12:05

Removed getUserAgent

ebe699d

- Renoved functions involved in getting the user agent - Updated tests to inject javascript to get the current user agent - updated changelog

Merge branch 'feature/set_user_agent' of https://github.com/LuisThein…

ee693fd

…/plugins into feature/set_user_agent

Fixed formatting issue

641537b

Fixed _getUserAgent in webview.dart

db3cfb9

amirh reviewed Aug 15, 2019

View reviewed changes

LuisThein added 3 commits August 16, 2019 18:52

Reverted unrelated reformatting

974c16e

Resolved merge conflicts.

c13245a

Fixed another formatting issue.

3282117

amirh approved these changes Aug 16, 2019

View reviewed changes

amirh merged commit 61c39d1 into flutter:master Aug 16, 2019

amirh mentioned this pull request Aug 16, 2019

webview_flutter-0.3.3.1 user-agent missing flutter/flutter#28256

Closed

sungmin-park pushed a commit to sungmin-park/flutter-plugins that referenced this pull request Dec 17, 2019

[webview_flutter] Allow setting a custom HTTP User-Agent (flutter#1920)

7d65857

flutter/flutter#28256

jackyq2015 mentioned this pull request May 9, 2020

Any way to set user agent from Android default browser flutter/flutter#56741

Closed

stuartmorgan-g mentioned this pull request Apr 17, 2023

Webview_flutter: Proposal to add Custom User Agent flutter/flutter#78177

Closed

[webview_flutter] get/set a custom User Agent #1920

[webview_flutter] get/set a custom User Agent #1920

Uh oh!

Conversation

LuisThein commented Jul 27, 2019

Description

Related Issues

Checklist

Breaking Change

Uh oh!

googlebot commented Jul 27, 2019

Uh oh!

LuisThein commented Jul 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

googlebot commented Jul 27, 2019

Uh oh!

tp commented Jul 30, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

amirh Aug 2, 2019

Choose a reason for hiding this comment

Uh oh!

LuisThein Aug 5, 2019

Choose a reason for hiding this comment

Uh oh!

amirh Aug 14, 2019

Choose a reason for hiding this comment

Uh oh!

LuisThein Aug 14, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LuisThein commented Aug 11, 2019

Uh oh!

Uh oh!

amirh commented Aug 14, 2019

Uh oh!

amirh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

amirh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

LuisThein commented Jul 27, 2019 •

edited

Loading