iOS/Sources/App/Notifications/NotificationManagerLocalPushInterfaceExtension.swift
Zac West 5c104f76e9
Multi-server (#1906)
## Summary
Most, but not all, of the changes necessary to support multi-server throughout the app and all its features.

## Screenshots
| Light | Dark |
| ----- | ---- |
| ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 24](https://user-images.githubusercontent.com/74188/143670011-9b9905ac-1b5b-4a82-b9f3-1490465c4ec5.png) | ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 26](https://user-images.githubusercontent.com/74188/143670012-0080230a-8f68-4f34-9691-db9f5e825a83.png) |
| ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 30](https://user-images.githubusercontent.com/74188/143670015-ceeac558-e039-4639-a186-b5001ab418b8.png) | ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 29](https://user-images.githubusercontent.com/74188/143670016-d72bb69d-83f5-4197-a742-59d208467258.png) |
| ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 47](https://user-images.githubusercontent.com/74188/143670021-6c90c40f-c2f1-4a33-aad9-da6626e99d9d.png) | ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 52 45](https://user-images.githubusercontent.com/74188/143670024-e99de69d-61d8-4e12-be73-a172242806a0.png) |
| ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 53 05](https://user-images.githubusercontent.com/74188/143670033-1a41ac7e-d4d1-458b-974e-2efdaf8e2288.png) | ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 53 03](https://user-images.githubusercontent.com/74188/143670049-baf4db64-64db-4bfb-88cf-4930f9e5661b.png) |
| ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 53 21](https://user-images.githubusercontent.com/74188/143670053-7ec794f1-857c-4ef6-a92a-5318e90ac6b6.png) | ![Simulator Screen Shot - iPhone 13 Pro - 2021-11-26 at 21 53 19](https://user-images.githubusercontent.com/74188/143670056-a6a5207c-3bba-49fc-b5c6-fc6fa8141f9c.png) |

## Any other notes
- Encapsulates all connectivity, token & server-specific knowledge in a Server model object which gets passed around.
- Updates various places throughout the app to know about and use Server rather than accessing said information through non-server-specific methods.
- Visually requests/notes server in places where it's ambiguous. For example, the Open Page widget will gain a subtitle if multiple servers are set up.
- Allows switching which server is shown in the WebViews. Note that this doesn't take into account multi-window support on iPad/macOS yet.

Most things will migrate successfully however adding an additional server causes things like Shortcuts to start erroring requiring you specify which to use in the particular Shortcut.

Future work necessary:
- Model objects currently clobber each other if their identifiers match. For example, both servers having a zone named `home` means one of them wins the fight for which is known to the app.
- Being remotely logged out on any account causes the app to require onboarding again, when instead it should only do that if the last known server is logged out.
2021-11-27 12:33:46 -08:00

230 lines
7.9 KiB
Swift

import Foundation
import HAKit
import NetworkExtension
import PromiseKit
import Shared
@available(iOS 14, *)
final class NotificationManagerLocalPushInterfaceExtension: NSObject, NotificationManagerLocalPushInterface {
private var observers = [Observer]()
private var syncStates: PerServerContainer<LocalPushStateSync>!
private var managers = [Identifier<Server>: [NEAppPushManager]]()
private var tokens: [NSKeyValueObservation] = [] {
didSet {
for token in oldValue where !tokens.contains(where: { $0 === token }) {
token.invalidate()
}
}
}
func status(for server: Server) -> NotificationManagerLocalPushStatus {
if managers[server.identifier, default: []].contains(where: \.isActive) {
if let state = syncStates[server].value {
// manager is running and we have a value synced
return .allowed(state)
} else {
// manager claims to be running but push provider didn't set sync status
return .disabled
}
} else {
// manager isn't running
return .disabled
}
}
func addObserver(
for server: Server,
handler: @escaping (NotificationManagerLocalPushStatus) -> Void
) -> HACancellable {
let observer = Observer(server: server, handler: handler)
observers.append(observer)
return HABlockCancellable { [weak self] in
self?.observers.removeAll(where: { $0 == observer })
}
}
private struct Observer: Equatable {
var identifier = UUID()
var server: Server
var handler: (NotificationManagerLocalPushStatus) -> Void
static func == (lhs: Observer, rhs: Observer) -> Bool {
lhs.identifier == rhs.identifier
}
}
private func notifyObservers(for servers: [Server] = Current.servers.all) {
for observer in observers where servers.contains(observer.server) {
let status = status(for: observer.server)
observer.handler(status)
}
}
override init() {
super.init()
syncStates = PerServerContainer<LocalPushStateSync>(constructor: { server in
let sync = LocalPushStateSync(settingsKey: PushProviderConfiguration.defaultSettingsKey(for: server))
let token = sync.observe { [weak self] _ in
self?.notifyObservers(for: [server])
}
return .init(sync, destructor: { _, _ in token.cancel() })
})
Current.servers.add(observer: self)
updateManagers()
}
private func updateManagers() {
Current.Log.info()
NEAppPushManager.loadAllFromPreferences { [self] managers, error in
guard error == nil else {
Current.Log.error("failed to load local push managers: \(error!)")
return
}
let encoder = JSONEncoder()
var updatedManagers = [ConfigureManager]()
var usedManagers = Set<NEAppPushManager>()
// update or create managers for the servers we have
for (ssid, servers) in serversBySSID() {
Current.Log.info("configuring push for \(ssid): \(servers)")
let existing = managers?.first(where: { $0.matchSSIDs == [ssid] })
if let existing = existing {
usedManagers.insert(existing)
}
updatedManagers.append(updateManager(
existingManager: existing,
ssid: ssid,
servers: servers,
encoder: encoder
))
}
// remove any existing managers that didn't match
for manager in managers ?? [] where !usedManagers.contains(manager) {
manager.removeFromPreferences { error in
Current.Log.info("remove unused manager \(manager) result: \(String(describing: error))")
}
}
configure(managers: updatedManagers)
}
}
struct ConfigureManager {
var ssid: String
var manager: NEAppPushManager
var servers: [Server]
}
private func configure(managers configureManagers: [ConfigureManager]) {
tokens.removeAll()
managers = configureManagers.reduce(into: [Identifier<Server>: [NEAppPushManager]]()) { result, value in
// notify on active state changes
tokens.append(value.manager.observe(\.isActive) { [weak self, servers = value.servers] manager, _ in
Current.Log.info("manager \(value.ssid) is active: \(manager.isActive)")
self?.notifyObservers(for: servers)
})
for server in value.servers {
result[server.identifier, default: []].append(value.manager)
}
value.manager.delegate = self
}
Current.Log.verbose("computed managers: \(managers)")
notifyObservers()
}
private func updateManager(
existingManager: NEAppPushManager?,
ssid: String,
servers: [Server],
encoder: JSONEncoder
) -> ConfigureManager {
let manager = existingManager ?? NEAppPushManager()
// just toggling isEnabled doesn't seem to kill off the extension reliably, so we remove when unwanted
var isDirty = false
func updateAndDirty<T: Equatable>(_ keyPath: ReferenceWritableKeyPath<NEAppPushManager, T>, _ value: T) {
if manager[keyPath: keyPath] != value {
Current.Log.info(keyPath)
manager[keyPath: keyPath] = value
isDirty = true
}
}
updateAndDirty(\.isEnabled, true)
updateAndDirty(\.localizedDescription, "HomeAssistant for \(ssid)")
updateAndDirty(\.providerBundleIdentifier, Constants.BundleID + ".PushProvider")
updateAndDirty(\.matchSSIDs, [ssid])
let configurations: [PushProviderConfiguration] = servers.map {
.init(serverIdentifier: $0.identifier, settingsKey: PushProviderConfiguration.defaultSettingsKey(for: $0))
}
do {
let existing = manager.providerConfiguration[PushProviderConfiguration.providerConfigurationKey] as? Data
let new = try encoder.encode(configurations)
if existing != new {
isDirty = true
manager.providerConfiguration = [
PushProviderConfiguration.providerConfigurationKey: new,
]
}
} catch {
Current.Log.error("failed to create config for push: \(error)")
manager.providerConfiguration = [:]
}
if isDirty {
manager.saveToPreferences { error in
Current.Log.info("manager \(manager) saved, error: \(String(describing: error))")
}
}
return ConfigureManager(ssid: ssid, manager: manager, servers: servers)
}
private func serversBySSID() -> [String: [Server]] {
Current.servers.all.reduce(into: [String: [Server]]()) { result, server in
let connection = server.info.connection
guard connection.isLocalPushEnabled, connection.address(for: .internal) != nil else {
return
}
for ssid in server.info.connection.internalSSIDs ?? [] {
result[ssid, default: []].append(server)
}
}
}
}
@available(iOS 14, *)
extension NotificationManagerLocalPushInterfaceExtension: ServerObserver {
func serversDidChange(_ serverManager: ServerManager) {
updateManagers()
}
}
@available(iOS 14, *)
extension NotificationManagerLocalPushInterfaceExtension: NEAppPushDelegate {
func appPushManager(
_ manager: NEAppPushManager,
didReceiveIncomingCallWithUserInfo userInfo: [AnyHashable: Any] = [:]
) {
// we do not have calls
}
}