Bug 313542 – Inconsistent customUserAgent behaviours with WKWebView when 302-server-side redirect link is tapped vs loaded directly

• Status: RESOLVED
• Resolution: FIXED
• Component: Page Loading

Created attachment 479352 [details]
A small sample project containing a WKWebView and 2 links to load that show different behaviours of 302-redirects and customUserAgent property

When updating a WKWebView customUserAgent in WKNavigationDelegate method

```
optional func webView(
    _ webView: WKWebView,
    decidePolicyFor navigationAction: WKNavigationAction,
    decisionHandler: @escaping @MainActor @Sendable (WKNavigationActionPolicy) -> Void
)```

The URLRequest header for `User-Agent` field is only modified when a 302-server-side redirect link is tapped in the web view. If the WKWebView loads the same URL/URLRequest directly, and the customUserAgent is updated the same way in webView(_:decidePolicyFor:decisionHandler:), then WKWebView does NOT update the header as expected before sending the request.

I attached a sample project that shows the difference between the two loads. 
First, build & run the project. The WKWebView will load https://test-website-a.pages.dev/server-redirect/. Tap `Navigate to header inspector via server-side 302 redirect` link. You will see `Desktop` in the `user-agent` field for `HTTP Request Headers` section.

Next, comment out line 37 in ViewController.swift. Uncomment line 40 for loading `https://test-website-a.pages.dev/server-redirect/go`. Rebuild & run the project. You will see `Mobile` in the `user-agent` field for `HTTP Request Headers` section despite loading the same link as above.


Both of these tests load the same `https://test-website-a.pages.dev/server-redirect/go` link, which is a 302-server-side redirect to `https://test-website-b.pages.dev/server-redirect/headers` but the `User-Agent` field of the HTTP Request Header only updates correctly when the link is tapped on.

This is also an issue when using the `WKWebpagePreferences` private `_customUserAgent` / `setCustomUserAgent:` property/setter when updating the `WKWebpagePreferences` in the WKNavigationDelegate method
```
optional func webView(
    _ webView: WKWebView,
    decidePolicyFor navigationAction: WKNavigationAction,
    preferences: WKWebpagePreferences,
    decisionHandler: @escaping @MainActor @Sendable (WKNavigationActionPolicy, WKWebpagePreferences) -> Void
)```

For example, replacing the existing WKNavigationDelegate method in the sample project with:
```
  func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, preferences: WKWebpagePreferences, decisionHandler: @escaping @MainActor (WKNavigationActionPolicy, WKWebpagePreferences) -> Void) {
    if navigationAction.request.url?.host() == "test-website-b.pages.dev" {
      if preferences.responds(to: Selector(("_setCustomUserAgent:"))) {
        preferences.perform(Selector(("_setCustomUserAgent:")), with: "Desktop")
      }
    }
    decisionHandler(.allow, preferences)
  }
```

Will reproduce the same bug.

[Radar WebKit Bug Importer]

<rdar://problem/176265326>

[Brent Fulgham]

Do you feel like this is something that has regressed recently? If so, can you share an OS version where it worked as expected? That can help us try to isolate what changed, and how to repair this.

No I don't believe it's regressed too recently, it reproduces on iOS 17.0 simulators. We've just noticed it recently after some logic changes relating to user agent in our app with some sites using the unexpected user agent from the request headers.

[Basuke Suzuki]

Pull request: https://github.com/WebKit/WebKit/pull/64787

[EWS]

Committed 313127@main (9a2a1a1b6932): <https://commits.webkit.org/313127@main>

Reviewed commits have been landed. Closing PR #64787 and removing active labels.