Added WKWebView extensions

[hamtiko]

I have copied old UIWebView extensions and added them as a WKWebview extensions with small compatibility changes.

Checklist

• I checked the Contributing Guidelines before creating this request.
• New extensions are written in Swift 5.0.
• New extensions support iOS 10.0+ / tvOS 9.0+ / macOS 10.10+ / watchOS 2.0+, or use @available if not.
• I have added tests for new extensions, and they passed.
• All extensions have a clear comments explaining their functionality, all parameters and return type in English.
• All extensions are declared as public.
• I have added a changelog entry describing my changes.

[codecov]

Codecov Report

Merging #851 into master will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #851      +/-   ##
==========================================
+ Coverage   92.80%   92.81%   +0.01%     
==========================================
  Files          99      100       +1     
  Lines        3403     3408       +5     
==========================================
+ Hits         3158     3163       +5     
  Misses        245      245              

Flag	Coverage Δ
#ios	95.70% <100.00%> (+<0.01%)	⬆️
#macos	83.06% <100.00%> (+0.03%)	⬆️
#tvos	95.75% <ø> (ø)

Impacted Files	Coverage Δ
...rces/SwifterSwift/WebKit/WKWebViewExtensions.swift	100.00% <100.00%> (ø)

---

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 b027022...0eb5a89. Read the comment docs.

[SwifterSwiftBot]

	4 Messages
📖	Thank you for submitting a pull request to SwifterSwift. The team will review your submission as soon as possible.
📖	iOS: Executed 680 tests, with 0 failures (0 unexpected) in 15.730 (16.707) seconds
📖	tvOS: Executed 645 tests, with 0 failures (0 unexpected) in 2.264 (2.713) seconds
📖	macOS: Executed 512 tests, with 0 failures (0 unexpected) in 1.720 (1.908) seconds

Generated by 🚫 Danger

[hamtiko]

It seems there is some problem with SwiftLint check. I have tried to rerun but it fails again.

It is failing with following message:

No runner matching the specified labels was found: macos.

I am assuming GitHub removes macos yaml label for runners.

[LucianoPAlmeida]

I tried to adjust, can you rebase with master and try again :)

[guykogus]

Thanks for adding these. There's a problem with your tests, however. Adding those 2 second delays is actually quite long and also unnecessary. You need to check 1) the return value from calling those functions, and 2) use the web view's navigationDelegate to get the expected responses that can later call successExpectation.fulfill()

[guykogus]

You still need to fulfil the expectation so that the test knows to continue. Just assert that the url is not nil.

Suggested change

	guard self.webView.url != nil else {
	XCTFail("No URL in webView")
	return
	}
	XCTAssertNotNil(self.webView.url)

[guykogus]

The same comment applies to the other tests.

[LucianoPAlmeida]

+1

[hamtiko]

@guykogus thanks for you comments.

I have refactored tests based on your suggestions.

[LucianoPAlmeida]

LGTM!

[guykogus]

Can you please rename the tests folder (see comment)?
You also need to add an entry into the README.md file for WebKit extensions, as well as update the podspec to provide a WebKit subspec.

[guykogus]

Rename the folder to WebKitTests

[hamtiko]

@guykogus done. I have increased test expectation timeout as well.

[hamtiko]

It seems 3 seconds of timeout is not enough. What you will suggest? Is it worth to increase timeout more?

[guykogus]

Maybe use a simpler website to load, like http://example.com. Although I wonder if it will fail because it's not https 🤔
I think it might be enough to consider the expectation fulfilled as soon as webView(_:didStartProvisionalNavigation:) is called. You don't need to wait for the entire website to finish loading. Check that this fails when you have a dead URL, like https://invalidurl.com.
At the same time, you should respond to the WKNavigationDelegate error callbacks to fail on errors and fulfil the expectation.

[guykogus]

Please add a test for a valid URL string that fails to load. I suggested previously https://invalidurl.com

[hamtiko]

@guykogus When I am trying to add test for dead url the webView(_:didStartProvisionalNavigation:) delegate function is calling and expectation fulfills before getting fail function called.

Is it ok? or you suggest to go back to use webView(_:didFinish:) function?

[guykogus]

@guykogus When I am trying to add test for dead url the webView(_:didStartProvisionalNavigation:) delegate function is calling and expectation fulfills before getting fail function called.

Is it ok? or you suggest to go back to use webView(_:didFinish:) function?

@hamtiko you should actually be waiting for a failure expectation in this case. I think what might be better is to use custom XCTestExpectation classes. Try using these:

class WebViewSuccessExpectation: XCTestExpectation, WKNavigationDelegate {
    init(description: String, webView: WKWebView) {
        super.init(description: description)
        webView.navigationDelegate = self
    }

    func webView(_ webView: WKWebView, didCommit navigation: WKNavigation!) {
        fulfill()
    }
}

class WebViewFailureExpectation: XCTestExpectation, WKNavigationDelegate {
    init(description: String, webView: WKWebView) {
        super.init(description: description)
        webView.navigationDelegate = self
    }

    func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: Error) {
        fulfill()
    }

    func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: Error) {
        fulfill()
    }
}

This way each test can use the appropriate expectation. Notice that for the success I changed to using webView(_:didCommit:), because as you pointed out even on failure didStartProvisionalNavigation is called. This way we don't wait for the entire website to load, we just wait till loading starts to succeed.

[hamtiko]

@guykogus Great idea! Thanks for your advice.