Files
iOS/Sources/App/WebView/WebViewController+WKScriptMessageHandler.swift
Bruno Pantaleão Gonçalves dbd4dfa0f0 Avoid WKUserContentController messages if app is in background (#3561)
<!-- Thank you for submitting a Pull Request and helping to improve Home
Assistant. Please complete the following sections to help the processing
and review of your changes. Please do not delete anything from this
template. -->

## Summary
<!-- Provide a brief summary of the changes you have made and most
importantly what they aim to achieve -->

## Screenshots
<!-- If this is a user-facing change not in the frontend, please include
screenshots in light and dark mode. -->

## Link to pull request in Documentation repository
<!-- Pull requests that add, change or remove functionality must have a
corresponding pull request in the Companion App Documentation repository
(https://github.com/home-assistant/companion.home-assistant). Please add
the number of this pull request after the "#" -->
Documentation: home-assistant/companion.home-assistant#

## Any other notes
<!-- If there is any other information of note, like if this Pull
Request is part of a bigger change, please include it here. -->
2025-04-23 14:02:56 +02:00

99 lines
4.0 KiB
Swift

import Foundation
import PromiseKit
import Shared
import WebKit
enum WKUserContentControllerMessage: String, CaseIterable {
case externalBus
case updateThemeColors
case getExternalAuth
case revokeExternalAuth
case logError
}
extension WebViewController: WKScriptMessageHandler {
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
guard let messageBody = message.body as? [String: Any] else {
Current.Log.error("received message for \(message.name) but of type: \(type(of: message.body))")
return
}
Current.Log.verbose("message \(message.body)".replacingOccurrences(of: "\n", with: " "))
guard UIApplication.shared.applicationState != .background else {
Current.Log.verbose("Ignoring WKUserContentController message \(message.name) because app is in background")
return
}
switch WKUserContentControllerMessage(rawValue: message.name) {
case .externalBus:
webViewExternalMessageHandler.handleExternalMessage(messageBody)
case .updateThemeColors:
handleThemeUpdate(messageBody)
case .getExternalAuth:
guard let callbackName = messageBody["callback"] else { return }
let force = messageBody["force"] as? Bool ?? false
Current.Log.verbose("getExternalAuth called, forced: \(force)")
firstly {
Current.api(for: server)?.tokenManager
.authDictionaryForWebView(forceRefresh: force) ??
.init(error: HomeAssistantAPI.APIError.noAPIAvailable)
}.done { dictionary in
let jsonData = try? JSONSerialization.data(withJSONObject: dictionary)
if let jsonString = String(data: jsonData!, encoding: .utf8) {
let script = "\(callbackName)(true, \(jsonString))"
self.webView.evaluateJavaScript(script, completionHandler: { result, error in
if let error {
Current.Log.error("Failed to trigger getExternalAuth callback: \(error)")
}
Current.Log.verbose("Success on getExternalAuth callback: \(String(describing: result))")
})
}
}.catch { error in
self.webView.evaluateJavaScript("\(callbackName)(false, 'Token unavailable')")
Current.Log.error("Failed to authenticate webview: \(error)")
}
case .revokeExternalAuth:
guard let callbackName = messageBody["callback"] else { return }
Current.Log.warning("Revoking access token")
firstly {
Current.api(for: server)?.tokenManager
.revokeToken() ?? .init(error: HomeAssistantAPI.APIError.noAPIAvailable)
}.done { [server] _ in
Current.servers.remove(identifier: server.identifier)
let script = "\(callbackName)(true)"
Current.Log.verbose("Running revoke external auth callback \(script)")
self.webView.evaluateJavaScript(script, completionHandler: { _, error in
Current.onboardingObservation.needed(.logout)
if let error {
Current.Log.error("Failed calling sign out callback: \(error)")
}
Current.Log.verbose("Successfully informed web client of log out.")
})
}.catch { error in
Current.Log.error("Failed to revoke token: \(error)")
}
case .logError:
Current.Log.error("WebView error: \(messageBody.description.replacingOccurrences(of: "\n", with: " "))")
default:
Current.Log.error("unknown message: \(message.name)")
}
}
func handleThemeUpdate(_ messageBody: [String: Any]) {
ThemeColors.updateCache(with: messageBody, for: traitCollection)
styleUI()
}
}