Files
iOS/Sources/App/Settings/Connection/ConnectionSettingsViewModel.swift
Copilot 8aa8e728fc Migrate ConnectionSettingsViewController to SwiftUI with ViewModel (#3962)
## Summary

Migrates `ConnectionSettingsViewController` from UIKit+Eureka to SwiftUI
with proper business logic separation. The new implementation follows
established patterns in the codebase (`ClientEventsLogView`/`ViewModel`)
while preserving all existing functionality.

**Changes:**
- **ConnectionSettingsViewModel** - Extracted business logic: server
observation, state management, user actions (share/activate/delete).
Fixed NotificationCenter observer memory leak by properly storing and
removing observer token in deinit.
- **ConnectionSettingsView** - SwiftUI replacement with sections for
Status, Details, Privacy, and Actions. Uses `SFSafeSymbols` for
type-safe SF Symbol references. Includes convenience
`embedInHostingController()` extension for cleaner UIKit integration
syntax. Added error alert to display deletion failures to users.
- **SettingsViewController** - Updated to instantiate SwiftUI view via
`embeddedInHostingController()`
- **ConnectionURLViewController** - Added convenience initializer with
optional `row` parameter for SwiftUI navigation compatibility

The old `ConnectionSettingsViewController.swift` remains but is
unreferenced.

## Screenshots

N/A - Functional equivalence maintained

## Link to pull request in Documentation repository

Documentation: home-assistant/companion.home-assistant#

## Any other notes

All features preserved: connection status display, URL configuration,
privacy settings, server management (activate/share/delete). The
ViewModel uses `@MainActor` with proper lifecycle management and
reactive `@Published` properties. Code follows project conventions
including SFSafeSymbols usage and proper memory management.

Error handling improved: deletion failures are now displayed to users in
an alert with the error's localized description, providing better user
feedback compared to the original implementation which silently
suppressed errors with `.cauterize()`.

<!-- START COPILOT CODING AGENT SUFFIX -->



<details>

<summary>Original prompt</summary>

> Migrate ConnectionSettingsViewController to SwiftUI, extract business
logic to a separate viewModel


</details>



<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bgoncal <5808343+bgoncal@users.noreply.github.com>
2025-11-12 17:59:44 +00:00

237 lines
8.2 KiB
Swift

import Combine
import Foundation
import HAKit
import PromiseKit
import Shared
import UIKit
/// ViewModel for ConnectionSettingsView, managing server connection settings and state
@MainActor
final class ConnectionSettingsViewModel: ObservableObject {
// MARK: - Published Properties
@Published var serverName: String = ""
@Published var connectionPath: String = ""
@Published var version: String = ""
@Published var websocketState: HAConnectionState?
@Published var localPushStatus: String = ""
@Published var loggedInUser: String = ""
@Published var locationName: String = ""
@Published var deviceName: String = ""
@Published var internalURL: String = ""
@Published var externalURL: String = ""
@Published var securityLevel: ConnectionSecurityLevel = .mostSecure
@Published var locationPrivacy: ServerLocationPrivacy = .never
@Published var sensorPrivacy: ServerSensorPrivacy = .none
@Published var showDeleteConfirmation = false
@Published var isDeleting = false
// MARK: - Properties
let server: Server
private var tokens: [HACancellable] = []
private var localPushObserver: HACancellable?
private var notificationCenterObserver: NSObjectProtocol?
// MARK: - Computed Properties
var canShareServer: Bool {
server.info.connection.invitationURL() != nil
}
var hasMultipleServers: Bool {
Current.servers.all.count > 1
}
var versionRequiresLocationGPSOptional: Bool {
server.info.version <= .updateLocationGPSOptional
}
// MARK: - Initialization
init(server: Server) {
self.server = server
setupObservers()
loadInitialData()
}
deinit {
tokens.forEach { $0.cancel() }
localPushObserver?.cancel()
if let observer = notificationCenterObserver {
NotificationCenter.default.removeObserver(observer)
}
}
// MARK: - Setup
private func setupObservers() {
// Observe server info changes
tokens.append(server.observe { [weak self] info in
self?.updateFromServerInfo(info)
})
// Observe websocket connection
if let connection = Current.api(for: server)?.connection {
// Observe websocket state
notificationCenterObserver = NotificationCenter.default.addObserver(
forName: HAConnectionState.didTransitionToStateNotification,
object: nil,
queue: .main
) { [weak self] _ in
guard let self else { return }
Task { @MainActor [weak self] in
guard let self else { return }
self.websocketState = Current.api(for: self.server)?.connection.state
}
}
websocketState = connection.state
// Observe logged in user
tokens.append(connection.caches.user.subscribe { [weak self] _, user in
guard let self else { return }
Task { @MainActor [weak self] in
guard let self else { return }
self.loggedInUser = user.name ?? ""
}
})
}
// Observe local push notifications
let manager = Current.notificationManager.localPushManager
localPushObserver = manager.addObserver(for: server) { [weak self] _ in
self?.updateLocalPushStatus()
}
updateLocalPushStatus()
}
private func loadInitialData() {
updateFromServerInfo(server.info)
updateURLs()
}
private func updateFromServerInfo(_ info: ServerInfo) {
serverName = info.name
connectionPath = info.connection.activeURLType.description
version = info.version.description
locationName = info.setting(for: .localName) ?? ""
deviceName = info.setting(for: .overrideDeviceName) ?? ""
securityLevel = info.connection.connectionAccessSecurityLevel
locationPrivacy = info.setting(for: .locationPrivacy)
sensorPrivacy = info.setting(for: .sensorPrivacy)
updateURLs()
}
private func updateURLs() {
internalURL = server.info.connection.address(for: .internal)?.absoluteString ?? ""
if server.info.connection.useCloud, server.info.connection.canUseCloud {
externalURL = L10n.Settings.ConnectionSection.HomeAssistantCloud.title
} else {
externalURL = server.info.connection.address(for: .external)?.absoluteString ?? ""
}
}
private func updateLocalPushStatus() {
let manager = Current.notificationManager.localPushManager
switch manager.status(for: server) {
case .disabled:
localPushStatus = L10n.SettingsDetails.Notifications.LocalPush.Status.disabled
case .unsupported:
localPushStatus = L10n.SettingsDetails.Notifications.LocalPush.Status.unsupported
case let .allowed(state):
switch state {
case .unavailable:
localPushStatus = L10n.SettingsDetails.Notifications.LocalPush.Status.unavailable
case .establishing:
localPushStatus = L10n.SettingsDetails.Notifications.LocalPush.Status.establishing
case let .available(received: received):
let formatted = NumberFormatter.localizedString(
from: NSNumber(value: received),
number: .decimal
)
localPushStatus = L10n.SettingsDetails.Notifications.LocalPush.Status.available(formatted)
}
}
}
// MARK: - Actions
func updateLocationName(_ newName: String?) {
server.info.setSetting(value: newName, for: .localName)
locationName = newName ?? ""
}
func updateDeviceName(_ newName: String?) {
server.info.setSetting(value: newName, for: .overrideDeviceName)
deviceName = newName ?? ""
}
func updateSecurityLevel(_ level: ConnectionSecurityLevel) {
server.update { info in
info.connection.connectionAccessSecurityLevel = level
}
securityLevel = level
}
func updateLocationPrivacy(_ privacy: ServerLocationPrivacy) {
server.info.setSetting(value: privacy, for: .locationPrivacy)
locationPrivacy = privacy
HomeAssistantAPI.manuallyUpdate(
applicationState: UIApplication.shared.applicationState,
type: .programmatic
).cauterize()
}
func updateSensorPrivacy(_ privacy: ServerSensorPrivacy) {
server.info.setSetting(value: privacy, for: .sensorPrivacy)
sensorPrivacy = privacy
Current.api(for: server)?.registerSensors().cauterize()
}
func shareServer() -> UIActivityViewController? {
guard let invitationServerURL = server.info.connection.invitationURL() else {
Current.Log.error("Invitation button failed, no invitation URL found for server \(server.identifier)")
return nil
}
guard let invitationURL = AppConstants.invitationURL(serverURL: invitationServerURL) else {
Current.Log
.error("Invitation button failed, could not create invitation URL for server \(server.identifier)")
return nil
}
return UIActivityViewController(activityItems: [invitationURL], applicationActivities: nil)
}
func activateServer() {
if Current.isCatalyst, Current.settingsStore.macNativeFeaturesOnly {
if let url = server.info.connection.activeURL() {
UIApplication.shared.open(url)
}
} else {
Current.sceneManager.webViewWindowControllerPromise.done {
$0.open(server: self.server)
}
}
}
func deleteServer() async throws {
isDeleting = true
defer { isDeleting = false }
let waitAtLeast = after(seconds: 3.0)
await race(
when(resolved: Current.apis.map { $0.tokenManager.revokeToken() }).asVoid(),
after(seconds: 10.0)
).async()
await waitAtLeast.async()
Current.api(for: server)?.connection.disconnect()
Current.servers.remove(identifier: server.identifier)
Current.onboardingObservation.needed(.logout)
}
}