Add FXIOS-8087 [v124] find in page web engine

BrowserKit/Sources/WebEngine/EngineSession.swift

@@ -7,6 +7,7 @@ import Foundation
 /// Protocol representing a single engine session. In browsers usually a session corresponds to a tab.
 public protocol EngineSession {
     var delegate: EngineSessionDelegate? { get set }
+    var findInPageDelegate: FindInPageHelperDelegate? { get set }
 
     /// The engine received a request to load a URL.
     /// - Parameter url: The URL string that is requested
@@ -24,9 +25,18 @@ public protocol EngineSession {
     /// Navigates forward in the history of this session.
     func goForward()
 
-    /// Scroll the session to the top
+    /// Scroll the session to the top.
     func scrollToTop()
 
+    /// Find a text selection in this session.
+    /// - Parameters:
+    ///   - text: The text to search
+    ///   - function: The functionality the find in page should search with
+    func findInPage(text: String, function: FindInPageFunction)
+
+    /// Called whenever the find in page session should be ended.
+    func findInPageDone()
+
     /// Navigates to the specified index in the history of this session. The current index of
     /// this session's history  will be updated but the items within it will be unchanged.
     /// Invalid index values are ignored.

BrowserKit/Sources/WebEngine/WKWebview/Scripts/FindInPageContentScript.swift

@@ -0,0 +1,60 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import Common
+import Foundation
+import WebKit
+
+public enum FindInPageFunction: String {
+    /// Find all the occurences of this text in the page
+    case find
+
+    /// Find the next occurence of this text in the page
+    case findNext
+
+    /// Find the previous occurence of this text in the page
+    case findPrevious
+}
+
+public protocol FindInPageHelperDelegate: AnyObject {
+    func findInPageHelper(didUpdateCurrentResult currentResult: Int)
+    func findInPageHelper(didUpdateTotalResults totalResults: Int)
+}
+
+class FindInPageContentScript: WKContentScript {
+    weak var delegate: FindInPageHelperDelegate?
+    private var logger: Logger
+
+    init(logger: Logger = DefaultLogger.shared) {
+        self.logger = logger
+    }
+
+    class func name() -> String {
+        return "FindInPage"
+    }
+
+    func scriptMessageHandlerNames() -> [String] {
+        return ["findInPageHandler"]
+    }
+
+    func userContentController(
+        didReceiveMessage message: Any
+    ) {
+        guard let parameters = message as? [String: Int] else {
+            // TODO: FXIOS-6463 - Integrate message handler check
+            logger.log("FindInPage.js sent wrong type of message",
+                       level: .warning,
+                       category: .webview)
+            return
+        }
+
+        if let currentResult = parameters["currentResult"] {
+            delegate?.findInPageHelper(didUpdateCurrentResult: currentResult)
+        }
+
+        if let totalResults = parameters["totalResults"] {
+            delegate?.findInPageHelper(didUpdateTotalResults: totalResults)
+        }
+    }
+}

BrowserKit/Sources/WebEngine/WKWebview/Scripts/WKContentScript.swift

@@ -12,10 +12,7 @@ protocol WKContentScript {
 
     func scriptMessageHandlerNames() -> [String]
 
-    func userContentController(
-        _ userContentController: WKUserContentController,
-        didReceiveScriptMessage message: WKScriptMessage
-    )
+    func userContentController(didReceiveMessage message: Any)
 
     func prepareForDeinit()
 }

BrowserKit/Sources/WebEngine/WKWebview/Scripts/WKContentScriptManager.swift

@@ -7,6 +7,8 @@ import WebKit
 
 /// Manager used to add and remove scripts inside a WKEngineSession
 protocol WKContentScriptManager: WKScriptMessageHandler {
+    var scripts: [String: WKContentScript] { get }
+
     func addContentScript(_ script: WKContentScript,
                           name: String,
                           forSession session: WKEngineSession)
@@ -19,12 +21,12 @@ protocol WKContentScriptManager: WKScriptMessageHandler {
 }
 
 class DefaultContentScriptManager: NSObject, WKContentScriptManager {
-    var scripts = [String: WKContentScript]()
+    private(set) var scripts = [String: WKContentScript]()
 
     func addContentScript(_ script: WKContentScript,
                           name: String,
                           forSession session: WKEngineSession) {
-        // If a script already exists on a tab, skip adding this duplicate.
+        // If a script already exists on a session, skip adding this duplicate.
         guard scripts[name] == nil else { return }
 
         scripts[name] = script
@@ -58,7 +60,7 @@ class DefaultContentScriptManager: NSObject, WKContentScriptManager {
     func userContentController(_ userContentController: WKUserContentController,
                                didReceive message: WKScriptMessage) {
         for script in scripts.values where script.scriptMessageHandlerNames().contains(message.name) {
-            script.userContentController(userContentController, didReceiveScriptMessage: message)
+            script.userContentController(didReceiveMessage: message.body)
             return
         }
     }

BrowserKit/Sources/WebEngine/WKWebview/WKEngineSession.swift

@@ -12,6 +12,14 @@ class WKEngineSession: NSObject,
                         WKNavigationDelegate,
                         WKEngineWebViewDelegate {
     weak var delegate: EngineSessionDelegate?
+    weak var findInPageDelegate: FindInPageHelperDelegate? {
+        didSet {
+            let script = contentScriptManager.scripts[FindInPageContentScript.name()]
+            guard let findInPage = script as? FindInPageContentScript else { return }
+            findInPage.delegate = findInPageDelegate
+        }
+    }
+
     private(set) var webView: WKEngineWebView
     private var logger: Logger
     var sessionData: WKEngineSessionData
@@ -45,6 +53,7 @@ class WKEngineSession: NSObject,
         webView.navigationDelegate = self
         webView.delegate = self
         userScriptManager.injectUserScriptsIntoWebView(webView)
+        addContentScripts()
     }
 
     // TODO: FXIOS-7903 #17648 no return from this load(url:), we need a way to recordNavigationInTab
@@ -116,6 +125,15 @@ class WKEngineSession: NSObject,
         webView.engineScrollView.setContentOffset(CGPoint.zero, animated: true)
     }
 
+    func findInPage(text: String, function: FindInPageFunction) {
+        let sanitizedInput = text.replacingOccurrences(of: "\\", with: "\\\\").replacingOccurrences(of: "\"", with: "\\\"")
+        webView.evaluateJavascriptInDefaultContentWorld("__firefox__.\(function.rawValue)(\"\(sanitizedInput)\")")
+    }
+
+    func findInPageDone() {
+        webView.evaluateJavascriptInDefaultContentWorld("__firefox__.findDone()")
+    }
+
     func goToHistory(index: Int) {
         // TODO: FXIOS-7907 #17651 Handle goToHistoryIndex in WKEngineSession (equivalent to goToBackForwardListItem)
     }
@@ -221,6 +239,14 @@ class WKEngineSession: NSObject,
         }
     }
 
+    // MARK: - Content scripts
+
+    private func addContentScripts() {
+        contentScriptManager.addContentScript(FindInPageContentScript(),
+                                              name: FindInPageContentScript.name(),
+                                              forSession: self)
+    }
+
     // MARK: - WKUIDelegate
 
     func webView(_ webView: WKWebView,

BrowserKit/Tests/WebEngineTests/FindInPageContentScriptTests.swift

@@ -0,0 +1,78 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import XCTest
+@testable import WebEngine
+
+final class FindInPageContentScriptTests: XCTestCase {
+    private var findInPageDelegate: MockFindInPageHelperDelegate!
+
+    override func setUp() {
+        super.setUp()
+        findInPageDelegate = MockFindInPageHelperDelegate()
+    }
+
+    override func tearDown() {
+        super.tearDown()
+        findInPageDelegate = nil
+    }
+
+    func testDidReceiveMessageGivenEmptyMessageThenNoDelegateCalled() {
+        let subject = FindInPageContentScript()
+        subject.delegate = findInPageDelegate
+
+        subject.userContentController(didReceiveMessage: [])
+
+        XCTAssertEqual(findInPageDelegate.didUpdateCurrentResultCalled, 0)
+        XCTAssertEqual(findInPageDelegate.didUpdateTotalResultsCalled, 0)
+    }
+
+    func testDidReceiveMessageGivenStringMessageThenNoDelegateCalled() {
+        let subject = FindInPageContentScript()
+        subject.delegate = findInPageDelegate
+
+        subject.userContentController(didReceiveMessage: ["": ""])
+
+        XCTAssertEqual(findInPageDelegate.didUpdateCurrentResultCalled, 0)
+        XCTAssertEqual(findInPageDelegate.didUpdateTotalResultsCalled, 0)
+    }
+
+    func testDidReceiveMessageGivenCurrentResultMessageThenDelegateCalled() {
+        let subject = FindInPageContentScript()
+        subject.delegate = findInPageDelegate
+        let currentResult = 1
+
+        subject.userContentController(didReceiveMessage: ["currentResult": currentResult])
+
+        XCTAssertEqual(findInPageDelegate.didUpdateCurrentResultCalled, 1)
+        XCTAssertEqual(findInPageDelegate.savedCurrentResult, currentResult)
+        XCTAssertEqual(findInPageDelegate.didUpdateTotalResultsCalled, 0)
+    }
+
+    func testDidReceiveMessageGivenTotalResultMessageThenDelegateCalled() {
+        let subject = FindInPageContentScript()
+        subject.delegate = findInPageDelegate
+        let totalResult = 10
+
+        subject.userContentController(didReceiveMessage: ["totalResults": totalResult])
+
+        XCTAssertEqual(findInPageDelegate.didUpdateCurrentResultCalled, 0)
+        XCTAssertEqual(findInPageDelegate.didUpdateTotalResultsCalled, 1)
+        XCTAssertEqual(findInPageDelegate.savedTotalResults, totalResult)
+    }
+
+    func testDidReceiveMessageGivenTotalAndCurrentResultsMessageThenDelegateCalled() {
+        let subject = FindInPageContentScript()
+        subject.delegate = findInPageDelegate
+        let totalResult = 15
+        let currentResult = 20
+
+        subject.userContentController(didReceiveMessage: ["totalResults": totalResult, "currentResult": currentResult])
+
+        XCTAssertEqual(findInPageDelegate.didUpdateCurrentResultCalled, 1)
+        XCTAssertEqual(findInPageDelegate.savedCurrentResult, currentResult)
+        XCTAssertEqual(findInPageDelegate.didUpdateTotalResultsCalled, 1)
+        XCTAssertEqual(findInPageDelegate.savedTotalResults, totalResult)
+    }
+}

BrowserKit/Tests/WebEngineTests/Mock/MockFindInPageDelegate.swift

@@ -0,0 +1,23 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/
+
+import Foundation
+@testable import WebEngine
+
+class MockFindInPageHelperDelegate: FindInPageHelperDelegate {
+    var didUpdateCurrentResultCalled = 0
+    var didUpdateTotalResultsCalled = 0
+    var savedCurrentResult = 0
+    var savedTotalResults = 0
+
+    func findInPageHelper(didUpdateCurrentResult currentResult: Int) {
+        savedCurrentResult = currentResult
+        didUpdateCurrentResultCalled += 1
+    }
+
+    func findInPageHelper(didUpdateTotalResults totalResults: Int) {
+        savedTotalResults = totalResults
+        didUpdateTotalResultsCalled += 1
+    }
+}

BrowserKit/Tests/WebEngineTests/Mock/MockWKContentScript.swift

@@ -3,7 +3,6 @@
 // file, You can obtain one at http://mozilla.org/MPL/2.0/
 
 import Foundation
-import WebKit
 @testable import WebEngine
 
 class MockWKContentScript: WKContentScript {
@@ -20,8 +19,7 @@ class MockWKContentScript: WKContentScript {
         return ["MockWKContentScriptHandler"]
     }
 
-    func userContentController(_ userContentController: WKUserContentController,
-                               didReceiveScriptMessage message: WKScriptMessage) {
+    func userContentController(didReceiveMessage message: Any) {
         userContentControllerCalled += 1
     }
 

BrowserKit/Tests/WebEngineTests/Mock/MockWKContentScriptManager.swift

@@ -7,20 +7,28 @@ import WebKit
 @testable import WebEngine
 
 class MockWKContentScriptManager: NSObject, WKContentScriptManager {
+    var scripts = [String: WKContentScript]()
     var addContentScriptCalled = 0
     var addContentScriptToPageCalled = 0
     var uninstallCalled = 0
     var userContentControllerCalled = 0
 
+    var savedContentScriptNames = [String]()
+    var savedContentScriptPageNames = [String]()
+
     func addContentScript(_ script: WKContentScript,
                           name: String,
                           forSession session: WKEngineSession) {
+        scripts[name] = script
+        savedContentScriptNames.append(name)
         addContentScriptCalled += 1
     }
 
     func addContentScriptToPage(_ script: WKContentScript,
                                 name: String,
                                 forSession session: WKEngineSession) {
+        scripts[name] = script
+        savedContentScriptPageNames.append(name)
         addContentScriptToPageCalled += 1
     }
 

BrowserKit/Tests/WebEngineTests/Mock/MockWKEngineWebView.swift

@@ -36,6 +36,8 @@ class MockWKEngineWebView: UIView, WKEngineWebView {
     var removeFromSuperviewCalled = 0
     var addObserverCalled = 0
     var removeObserverCalled = 0
+    var evaluateJavaScriptCalled = 0
+    var savedJavaScript: String?
 
     var loadFileReadAccessURL: URL?
 
@@ -105,4 +107,12 @@ class MockWKEngineWebView: UIView, WKEngineWebView {
                                  forKeyPath keyPath: String) {
         removeObserverCalled += 1
     }
+
+    func evaluateJavaScript(_ javaScript: String,
+                            in frame: WKFrameInfo?,
+                            in contentWorld: WKContentWorld,
+                            completionHandler: ((Result<Any, Error>) -> Void)?) {
+        evaluateJavaScriptCalled += 1
+        savedJavaScript = javaScript
+    }
 }