[webview_flutter]Support UserAgent setting for webview_flutter #968

YukiOya · 2018-12-07T07:47:11Z

It possible to get and set custom user agent to webview.

ened · 2018-12-07T12:54:25Z

packages/webview_flutter/ios/Classes/FlutterWebView.m

+               if (error) {
+                 result([FlutterError
+                     errorWithCode:@"getUserAgent_failed"
+                           message:@"Failed gettting UserAgent"


Fix it. cdc320c

ened · 2018-12-07T12:56:49Z

packages/webview_flutter/ios/Classes/FlutterWebView.m

+  if (@available(iOS 9.0, *)) {
+    [_webView setCustomUserAgent:userAgent];
+  } else if (userAgent) {
+    [[NSUserDefaults standardUserDefaults] registerDefaults:@{@"UserAgent" : userAgent}];


Why is this required? Where is the value read again?

Looks like WkWebView reads that value on construction, I did not find official documentation for this other than SO, but I did verify that it works.

In that case.. I’d recommend a short source code comment, perhaps a link to the relevant SO answer.

+1 we should definitely mention that in a comment if we end up using this trick(though I wouldn't link SO).

Sorry for forgetting that.

I implemented it referencing SO, and added the source code comment. 89e010b

amirh · 2018-12-07T23:07:38Z

packages/webview_flutter/ios/Classes/FlutterWebView.m

+  if (@available(iOS 9.0, *)) {
+    [_webView setCustomUserAgent:userAgent];
+  } else if (userAgent) {
+    [[NSUserDefaults standardUserDefaults] registerDefaults:@{@"UserAgent" : userAgent}];


Looks like WkWebView reads that value on construction, I did not find official documentation for this other than SO, but I did verify that it works.

amirh · 2018-12-07T23:45:29Z

packages/webview_flutter/ios/Classes/FlutterWebView.m

+  } else if (userAgent) {
+    [[NSUserDefaults standardUserDefaults] registerDefaults:@{@"UserAgent" : userAgent}];
+    WKWebViewConfiguration* configuration = _webView.configuration;
+    _webView = [[WKWebView alloc] initWithFrame:_webView.frame configuration:configuration];


We can't do this as it won't change the webview reference that the platform views controller is holding.
Even if we could update the engine's reference, doing this will lose any state the webview is currently in.

I think a better approach for iOS < 9 would be to do the user defaults trick prior to the construction of the webview in FLTWebViewController's initWithFrame (ohh I just noticed we have a typo there).

And just not support changing the userAgent for iOS < 9 (as WkWebView doesn't support it).

Note that we should make sure to restore the UserAgent value after constructing the webview.

Fix it.
360e733

YukiOya · 2018-12-21T05:18:45Z

@amirh Thanks for the review.
I fixed the issues, and added new commit to fix the accessor name like currentUrl.

msdk27 · 2019-01-10T13:53:51Z

Hey, thanks for the missing part in the webview plugin... my question is, how to use the own userAgent?! Is there a documentation?

YukiOya · 2019-01-11T02:37:12Z

@msdk27 Hi. Thank you for your question.
Now, the custom userAgent apply to webview only if it initialize with constructor argument like this.

WebView(userAgent: "custom useragent");

Perhaps, the interface will change by maintainer's reviews.

msdk27 · 2019-01-11T10:13:54Z

@msdk27 Hi. Thank you for your question.
Now, the custom userAgent apply to webview only if it initialize with constructor argument like this.
WebView(userAgent: "custom useragent");
Perhaps, the interface will change by maintainer's reviews.

Hi thank you for response. Do you have an example? it does not work for me.

amirh · 2019-03-29T22:42:52Z

Sorry for the delay getting to review this, we were trying to minimize adding new features before we had e2e tests.

The code has changed a bit since this PR was sent, this PR needs to be rebased, and add e2e tests should be added(see https://github.com/flutter/plugins/blob/master/packages/webview_flutter/example/test_driver/webview.dart).

amirh

Please rebase, and add e2e tests.

YukiOya · 2019-04-01T05:33:11Z

Hi, @amirh
Thank you for reply.
This PR is rebased, and added e2e tests.

amirh

Thanks for the update, left a few comments.

amirh · 2019-05-14T18:10:34Z

packages/webview_flutter/lib/webview_flutter.dart

  /// [WebViewController.evaluateJavascript] can assume this.
  final PageFinishedCallback onPageFinished;

+  /// The custom UserAgent.


We should have more information in this Dartdoc, some question I think I might be having if I were looking here:

What would be the user agent when this is null?

What happens when the widget is rebuild with a new userAgent? is it sending a new request with the new user agent?

What happens when goBack is called after a user agent was changed? is the new or previous user agent used?

In general I recommend reading the documentation section in the Flutter style guide which we should follow here.

amirh · 2019-05-14T18:14:29Z

packages/webview_flutter/lib/webview_flutter.dart

  }

+  /// Accessor the UserAgent.
+  Future<String> userAgent() async {


nit: getUserAgent

amirh · 2019-05-14T18:18:01Z

packages/webview_flutter/lib/webview_flutter.dart

    return _channel.invokeMethod("reload");
  }

+  /// Accessor the UserAgent.


Please follow the documentation section in the Flutter style guide, I'd suggest:

/// Returns the User-Agent value that will be used for subsequent HTTP requests.

amirh · 2019-05-14T18:18:46Z

packages/webview_flutter/example/test_driver/webview.dart

+    final String userAgent = await controller.userAgent();
+    expect(userAgent, 'UA');
+  });
 }


Please add a test that rebuilds a WebView with a different user agent.

timrijckaert · 2019-07-03T08:36:03Z

What needs to be done to get this merged?

aegis123 · 2019-07-05T15:08:10Z

@YukiOya any change you can get the last remarks fixed so this can be merged?

amirh · 2019-07-08T17:56:11Z

This PR needs more work before it can be merged, a rebase/merge of master is needed(a recent refactoring that was done requires moving some stuff around, and following up on the review comments is still needed).

I'm marking this PR as "needs love" and closing it, feel free to re-open or file a new PR.
Note that the priority of the feature(and of reviewing non trivial PRs) is determined by the number thumbs up on the issue(flutter/flutter#28256 in this case). See the review process section in the contributing guide.

googlebot added the cla: yes label Dec 7, 2018

ened reviewed Dec 7, 2018

View reviewed changes

amirh suggested changes Dec 7, 2018

View reviewed changes

amirh mentioned this pull request Jan 29, 2019

Add an UserAgent in webView_flutter Plugin #1131

Closed

cyanglaz changed the title ~~Support UserAgent setting for webview_flutter~~ [webview_flutter]Support UserAgent setting for webview_flutter Feb 22, 2019

amirh suggested changes Mar 29, 2019

View reviewed changes

amirh suggested changes May 14, 2019

View reviewed changes

YukiOya added 9 commits May 27, 2019 14:38

Add UserAgent setting

73551b8

Add UserAgent getter

d901714

Add test UserAgent

f527cbb

Fix support target for setting UserAgent

d1ff6c6

Add e2e test

9d10411

Fix getter docs

ec1a90a

Fix getter name

01dd5ad

Add rebuild test case

92a27f8

Fix format

7d40cd1

amirh added the needs love label Jul 8, 2019

amirh closed this Jul 8, 2019

LuisThein mentioned this pull request Jul 27, 2019

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

Merged

13 tasks

[webview_flutter]Support UserAgent setting for webview_flutter #968

[webview_flutter]Support UserAgent setting for webview_flutter #968

Uh oh!

Conversation

YukiOya commented Dec 7, 2018

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!

YukiOya Dec 10, 2018 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

YukiOya commented Dec 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

msdk27 commented Jan 10, 2019

Uh oh!

YukiOya commented Jan 11, 2019

Uh oh!

msdk27 commented Jan 11, 2019

Uh oh!

amirh commented Mar 29, 2019

Uh oh!

amirh left a comment

Choose a reason for hiding this comment

Uh oh!

YukiOya commented Apr 1, 2019

Uh oh!

amirh left a comment

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!

timrijckaert commented Jul 3, 2019

Uh oh!

aegis123 commented Jul 5, 2019

Uh oh!

amirh commented Jul 8, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

YukiOya Dec 10, 2018 •

edited

Loading

YukiOya commented Dec 21, 2018 •

edited

Loading