breaking (UserAgent): Drop CDVUserAgentUtil and Implement for WKWebView

[erisu]

Motivation and Context

• Drop CDVUserAgentUtil which handled managing the User Agent string for UIWebView.
• Add alternative implementation for WKWebView.

Description

• Remove all existing UserAgent code that uses or associated with CDVUserAgentUtil.
• Add to the WKWebView Engine configuration setup to set the user agent string.

Testing

• npm t
• cordova platform add
• cordova build
• Run in Simulator
• Tested below test cases in config.xml

Test Cases

• AppendUserAgent
• AppendUserAgent w/ OverrideUserAgent
• OverrideUserAgent

Checklist

• I've run the tests to see all new and existing tests pass

[codecov-io]

Codecov Report

Merging #801 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #801   +/-   ##
======================================
  Coverage    74.2%   74.2%           
======================================
  Files          13      13           
  Lines        1849    1849           
======================================
  Hits         1372    1372           
  Misses        477     477

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2922437...703fbdc. Read the comment docs.

[jcesarmobile]

You can override the whole user agent if using wkWebView.customUserAgent = userAgent;

[erisu]

@jcesarmobile I re-added back the wkWebView.customUserAgent for the OverrideUserAgent preference.

• left the comment for OverrideUserAgent with the other configurations so they are gathered in one area.
• updated the condition in the configuration setup method to still skip the append preference when override is set.
• add the OverrideUserAgent condition in the pluginInitialize method where the wkWebView instance is created and availabe.

[jcesarmobile]

I've made a comment about something I think should not be removed.

Other than that, the changes look good to me.

[jcesarmobile]

LGTM

[CVeniamin]

Went ahead and checked which plugins might be affected by this change.
I found that both cordova-plugin-file-transfer and cordova-plugin-wkwebview-engine depend on the previous API.

Although cordova-plugin-wkwebview-engine should now be "deprecated" and the change should not affect it as much since the WKWebview is the default engine.

[jcesarmobile]

cordova-plugin-file-transfer is deprecated too

about cordova-plugin-wkwebview-engine, we were going to recommend using it for those who want to use file urls instead of the custom schemes, so maybe should be fixed to work on cordova-ios 6

[CVeniamin]

@jcesarmobile, thanks for the feedback!
I know that there are some use cases of cordova-plugin-file-transfer being used to play tracks offline combined with cordova-plugin-media for music players, that is why I have mentioned it.

[tryhardest]

Hopefully we can still use these plugins and upgrade specifically file transfer plugin. Sure would love to see anyone with authority release a new version of Ionic WKwebview plugin.

[vitto32]

about cordova-plugin-wkwebview-engine, we were going to recommend using it for those who want to use file urls instead of the custom schemes, so maybe should be fixed to work on cordova-ios 6

I'm in that situation. #783 and this one are making things complicated.

I've spent a lot of time in the past replacing cordova-plugin-file-transfer, and I came up to a solution using cordova-plugin-wkwebview-file-xhr.

Now I'm trying to remove wkwebview-engine and wkwebview-file-xhr but I'm facing CORS issues when trying (in developement mode) to access file:// or app:// locations.