Make WKWebView work again

Sources/SnapshotTesting/Common/View.swift

@@ -67,16 +67,13 @@
             let work = {
               if #available(iOS 11.0, macOS 10.13, *) {
                 inWindow {
-                  guard wkWebView.frame.width != 0, wkWebView.frame.height != 0 else {
-                    callback(Image())
-                    return
-                  }
-                  let configuration = WKSnapshotConfiguration()
-                  if #available(iOS 13, macOS 10.15, *) {
-                    configuration.afterScreenUpdates = false
-                  }
-                  wkWebView.takeSnapshot(with: configuration) { image, _ in
-                    callback(image!)
+                  wkWebView.takeSnapshot(with: nil) { image, error in
+                    guard let image else {
+                      debugPrint("No image taken. Error: \(error.description)")
+                      callback(Image())
+                      return
+                    }
+                    callback(image)
                   }
                 }
               } else {
@@ -185,33 +182,26 @@
         view: view,
         viewController: viewController
       )
-      // NB: Avoid safe area influence.
-      if config.safeArea == .zero { view.frame.origin = .init(x: offscreen, y: offscreen) }
-
-      return
-        (view.snapshot
-        ?? Async { callback in
-          addImagesForRenderedViews(view).sequence().run { views in
-            callback(
-              renderer(bounds: view.bounds, for: traits).image { ctx in
-                if drawHierarchyInKeyWindow {
-                  view.drawHierarchy(in: view.bounds, afterScreenUpdates: true)
-                } else {
-                  view.layer.render(in: ctx.cgContext)
-                }
+      return Async { callback in
+        addImagesForRenderedViews(view).sequence().run { views in
+          callback(
+            renderer(bounds: view.bounds, for: traits).image { ctx in
+              if drawHierarchyInKeyWindow {
+                view.drawHierarchy(in: view.bounds, afterScreenUpdates: true)
+              } else {
+                view.layer.render(in: ctx.cgContext)
               }
-            )
-            views.forEach { $0.removeFromSuperview() }
-            view.frame = initialFrame
-          }
-        }).map {
-          dispose()
-          return $0
+            }
+          )
+          views.forEach { $0.removeFromSuperview() }
+          view.frame = initialFrame
         }
+      }.map {
+        dispose()
+        return $0
+      }
     }
 
-    private let offscreen: CGFloat = 10_000
-
     func renderer(bounds: CGRect, for traits: UITraitCollection) -> UIGraphicsImageRenderer {
       let renderer: UIGraphicsImageRenderer
       if #available(iOS 11.0, tvOS 11.0, *) {
@@ -358,3 +348,13 @@ extension Array {
     }
   }
 }
+
+extension Optional {
+    var description: String {
+        if let value = self {
+            return String(describing: value)
+        } else {
+            return "nil"
+        }
+    }
+}

Tests/SnapshotTestingTests/SnapshotTestingTests.swift

@@ -1101,27 +1101,6 @@ final class SnapshotTestingTests: XCTestCase {
       """.utf8)
   }
 
-  func testWebView() throws {
-    #if os(iOS)
-      XCTExpectFailure("WebView snapshotting needs to be fixed")
-    #endif
-    #if os(iOS) || os(macOS)
-      let fixtureUrl = URL(fileURLWithPath: String(#file), isDirectory: false)
-        .deletingLastPathComponent()
-        .appendingPathComponent("__Fixtures__/pointfree.html")
-      let html = try String(contentsOf: fixtureUrl)
-      let webView = WKWebView()
-      webView.loadHTMLString(html, baseURL: nil)
-      if !ProcessInfo.processInfo.environment.keys.contains("GITHUB_WORKFLOW") {
-        assertSnapshot(
-          of: webView,
-          as: .image(size: .init(width: 800, height: 600)),
-          named: platform
-        )
-      }
-    #endif
-  }
-
   func testViewWithZeroHeightOrWidth() {
     #if os(iOS) || os(tvOS)
       var rect = CGRect(x: 0, y: 0, width: 350, height: 0)
@@ -1152,95 +1131,6 @@ final class SnapshotTestingTests: XCTestCase {
     #endif
   }
 
-  func testEmbeddedWebView() throws {
-    #if os(iOS)
-      let label = UILabel()
-      label.text = "Hello, Blob!"
-
-      let fixtureUrl = URL(fileURLWithPath: String(#file), isDirectory: false)
-        .deletingLastPathComponent()
-        .appendingPathComponent("__Fixtures__/pointfree.html")
-      let html = try String(contentsOf: fixtureUrl)
-      let webView = WKWebView()
-      webView.loadHTMLString(html, baseURL: nil)
-      webView.isHidden = true
-
-      let stackView = UIStackView(arrangedSubviews: [label, webView])
-      stackView.axis = .vertical
-
-      if !ProcessInfo.processInfo.environment.keys.contains("GITHUB_WORKFLOW") {
-        assertSnapshot(
-          of: stackView,
-          as: .image(size: .init(width: 800, height: 600)),
-          named: platform
-        )
-      }
-    #endif
-  }
-
-  #if os(iOS) || os(macOS)
-    final class ManipulatingWKWebViewNavigationDelegate: NSObject, WKNavigationDelegate {
-      func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
-        webView.evaluateJavaScript("document.body.children[0].classList.remove(\"hero\")")  // Change layout
-      }
-    }
-    func testWebViewWithManipulatingNavigationDelegate() throws {
-      #if os(iOS)
-        XCTExpectFailure("WebView snapshotting needs to be fixed")
-      #endif
-      let manipulatingWKWebViewNavigationDelegate = ManipulatingWKWebViewNavigationDelegate()
-      let webView = WKWebView()
-      webView.navigationDelegate = manipulatingWKWebViewNavigationDelegate
-
-      let fixtureUrl = URL(fileURLWithPath: String(#file), isDirectory: false)
-        .deletingLastPathComponent()
-        .appendingPathComponent("__Fixtures__/pointfree.html")
-      let html = try String(contentsOf: fixtureUrl)
-      webView.loadHTMLString(html, baseURL: nil)
-      if !ProcessInfo.processInfo.environment.keys.contains("GITHUB_WORKFLOW") {
-        assertSnapshot(
-          of: webView,
-          as: .image(size: .init(width: 800, height: 600)),
-          named: platform
-        )
-      }
-      _ = manipulatingWKWebViewNavigationDelegate
-    }
-
-    final class CancellingWKWebViewNavigationDelegate: NSObject, WKNavigationDelegate {
-      func webView(
-        _ webView: WKWebView,
-        decidePolicyFor navigationAction: WKNavigationAction,
-        decisionHandler: @escaping (WKNavigationActionPolicy) -> Void
-      ) {
-        decisionHandler(.cancel)
-      }
-    }
-
-    func testWebViewWithCancellingNavigationDelegate() throws {
-      #if os(iOS)
-        XCTExpectFailure("WebView snapshotting needs to be fixed")
-      #endif
-      let cancellingWKWebViewNavigationDelegate = CancellingWKWebViewNavigationDelegate()
-      let webView = WKWebView()
-      webView.navigationDelegate = cancellingWKWebViewNavigationDelegate
-
-      let fixtureUrl = URL(fileURLWithPath: String(#file), isDirectory: false)
-        .deletingLastPathComponent()
-        .appendingPathComponent("__Fixtures__/pointfree.html")
-      let html = try String(contentsOf: fixtureUrl)
-      webView.loadHTMLString(html, baseURL: nil)
-      if !ProcessInfo.processInfo.environment.keys.contains("GITHUB_WORKFLOW") {
-        assertSnapshot(
-          of: webView,
-          as: .image(size: .init(width: 800, height: 600)),
-          named: platform
-        )
-      }
-      _ = cancellingWKWebViewNavigationDelegate
-    }
-  #endif
-
   #if os(iOS)
     @available(iOS 13.0, *)
     func testSwiftUIView_iOS() {

Tests/SnapshotTestingTests/Snapshotting/WKWebViewTests.swift

@@ -0,0 +1,110 @@
+import Foundation
+import XCTest
+
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+
+#if canImport(WebKit)
+import WebKit
+#endif
+
+#if canImport(UIKit)
+import UIKit.UIView
+#endif
+
+@testable import SnapshotTesting
+
+final class WKWebViewTests: XCTestCase {
+    override func setUp() {
+        super.setUp()
+        diffTool = "ksdiff"
+//        isRecording = true
+    }
+
+    override func tearDown() {
+        isRecording = false
+        super.tearDown()
+    }
+
+#if os(iOS) || os(macOS)
+    func testWebView() throws {
+        let webView = WKWebView()
+        webView.load(.init(url: .htmlFixture))
+        assertSnapshot(
+            of: webView,
+            as: .image(precision: 0.99, perceptualPrecision: 0.99, size: .init(width: 800, height: 600)),
+            named: platform
+        )
+    }
+
+    func testWebViewWithManipulatingNavigationDelegate() throws {
+        final class ManipulatingWKWebViewNavigationDelegate: NSObject, WKNavigationDelegate {
+            func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
+                webView.evaluateJavaScript("document.body.children[0].classList.remove(\"hero\")")  // Change layout
+            }
+        }
+        let manipulatingWKWebViewNavigationDelegate = ManipulatingWKWebViewNavigationDelegate()
+        let webView = WKWebView()
+        webView.navigationDelegate = manipulatingWKWebViewNavigationDelegate
+        webView.load(.init(url: .htmlFixture))
+        assertSnapshot(
+            of: webView,
+            as: .image(precision: 0.99, perceptualPrecision: 0.99, size: .init(width: 800, height: 600)),
+            named: platform
+        )
+        _ = manipulatingWKWebViewNavigationDelegate
+    }
+
+    func testWebViewWithCancellingNavigationDelegate() throws {
+        final class CancellingWKWebViewNavigationDelegate: NSObject, WKNavigationDelegate {
+            func webView(
+                _ webView: WKWebView,
+                decidePolicyFor navigationAction: WKNavigationAction,
+                decisionHandler: @escaping (WKNavigationActionPolicy) -> Void
+            ) {
+                decisionHandler(.cancel)
+            }
+        }
+        let cancellingWKWebViewNavigationDelegate = CancellingWKWebViewNavigationDelegate()
+        let webView = WKWebView()
+        webView.navigationDelegate = cancellingWKWebViewNavigationDelegate
+        webView.load(.init(url: .htmlFixture))
+        assertSnapshot(
+            of: webView,
+            as: .image(size: .init(width: 800, height: 600)),
+            named: platform
+        )
+        _ = cancellingWKWebViewNavigationDelegate
+    }
+#endif
+
+#if os(iOS)
+    func testEmbeddedWebView() throws {
+        let label = UILabel()
+        label.text = "Hello, Blob!"
+
+        let webView = WKWebView()
+        webView.load(.init(url: .htmlFixture))
+        webView.isHidden = true
+
+        let stackView = UIStackView(arrangedSubviews: [label, webView])
+        stackView.axis = .vertical
+
+        assertSnapshot(
+            of: stackView,
+            as: .image(precision: 0.99, perceptualPrecision: 0.99, size: .init(width: 800, height: 600)),
+            named: platform
+        )
+    }
+#endif
+}
+
+private extension URL {
+    static var htmlFixture: URL {
+        URL(fileURLWithPath: String(#file), isDirectory: false)
+            .deletingLastPathComponent()
+            .deletingLastPathComponent()
+            .appendingPathComponent("__Fixtures__/pointfree.html")
+    }
+}