Help me get my TabContentScript working again

[gutley]

Hi, I have a subclass of TabContentScript that I use to be notified of any DOM modifications. This worked fine until USE_NEW_SANDBOX_APIS was enabled in WKWebViewExtensions.swift. Nowadays though I get the following error when trying to call back into the native code from the js: "ReferenceError: Can't find variable: webkit".

Setting USE_NEW_SANDBOX_APIS back to false works as expected. I am sure its an easy fix to get it to work but my knowledge of JavaScript is just about good enough for me to get my script working in the first place.

Anyway, here is my class:

class DOMMutationHelper: TabContentScript {
    fileprivate weak var tab: Tab?
    fileprivate static let marker : String = UUID().uuidString
    
    init(tab: Tab) {
        self.tab = tab
    }
    
    static func name() -> String {
        return "com_my_mutation"
    }
    
    func scriptMessageHandlerName() -> String? {
        return "myMutationHelper"
    }
    
    func userContentController(_ userContentController: WKUserContentController,
                               didReceiveScriptMessage message: WKScriptMessage) {
        guard let data = message.body as? [String: Any?]
              , let callMarker = data["marker"] as? String, callMarker == DOMMutationHelper.marker
              , let innerHTML = (data["innerHTML"] as? String)?.nonEmpty
              , let webView = tab?.currentWebView()
        else {
            return
        }
        // Call down to our custom func in BrowserViewController
        tab?.browserViewController?.innerHTMLDidChange(innerHTML, inWebView: webView)
    }
    
    static func associatedUserScript() -> WKUserScript {
        let endScript = """
        const observer = new MutationObserver(list => {
            console.log("mutation list", list);
            
            if (["http:", "https:"].includes(window.location.protocol)) {
                webkit.messageHandlers.myMutationHelper.postMessage({
                    "marker": "\(marker)",
                    "mutations": list.length,
                    "innerHTML": document.documentElement.innerHTML,
                });
            } else {
                console.log("Ignoring mutation for protocol:", window.location.protocol);
            }
        });
        observer.observe(document.body, {
            attributes: false,
            childList: true,
            characterData: true,
            subtree: true
        });
        console.log("mutation observer installed");
        """

        return WKUserScript(source: endScript, injectionTime: .atDocumentEnd, forMainFrameOnly: true)
    }
}

The script gets added to the current tab just after the FocusHelper script in BrowserViewController.tab(...):

        tab.addContentScript(FocusHelper(tab: tab), name: FocusHelper.name())
        tab.addContentScript(DOMMutationHelper(tab: tab), name: DOMMutationHelper.name())

and it gets installed into the web view in UserScriptManager.injectUserScriptsIntoTab(...) at the end:

        if noImageMode {
            tab.webView?.configuration.userContentController.addUserScript(noImageModeUserScript)
        }
        
        let script = DOMMutationHelper.associatedUserScript()
        tab.webView?.configuration.userContentController.addUserScript(script)

Thanks in advance.

[boek]

Hey @gutley

Could you try and replace

return WKUserScript(source: endScript, injectionTime: .atDocumentEnd, forMainFrameOnly: true)

with

return WKUserScript.createInDefaultContentWorld(source: endScript, injectionTime: .atDocumentEnd, forMainFrameOnly: true)

If that doesn't work you could try

return WKUserScript.createInPageContentWorld(source: endScript, injectionTime: .atDocumentEnd, forMainFrameOnly: true)

[gutley]

Thanks, the first suggestion worked.