Merge branch 'develop' into lintWarnings20240918

openhab · Sep 18, 2024 · a5a4cbf · a5a4cbf
2 parents db7df0e + e0069b4
commit a5a4cbf
Show file tree

Hide file tree

Showing 13 changed files with 541 additions and 431 deletions.
diff --git a/.github/workflows/deployTest.yml b/.github/workflows/deployTest.yml
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -21,7 +21,7 @@ jobs:
     steps:
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: latest-stable
+          xcode-version: '15.4'
 
       - uses: actions/checkout@v4
         with:

diff --git a/OpenHABCore/Sources/OpenHABCore/Util/NetworkTracker.swift b/OpenHABCore/Sources/OpenHABCore/Util/NetworkTracker.swift
@@ -19,7 +19,6 @@ public enum NetworkStatus: String {
     case notConnected = "Not Connected"
     case connecting = "Connecting"
     case connected = "Connected"
-    case connectionFailed = "Connection Failed"
 }
 
 // Anticipating supporting more robust configuration options where we allow multiple url/user/pass options for users
@@ -31,23 +30,23 @@ public struct ConnectionObject: Equatable {
         self.url = url
         self.priority = priority
     }
-
-    public static func == (lhs: ConnectionObject, rhs: ConnectionObject) -> Bool {
-        lhs.url == rhs.url && lhs.priority == rhs.priority
-    }
 }
 
 public final class NetworkTracker: ObservableObject {
     public static let shared = NetworkTracker()
 
     @Published public private(set) var activeServer: ConnectionObject?
-    @Published public private(set) var status: NetworkStatus = .notConnected
+    @Published public private(set) var status: NetworkStatus = .connecting
 
-    private var monitor: NWPathMonitor
-    private var monitorQueue = DispatchQueue.global(qos: .background)
+    private let monitor: NWPathMonitor
+    private let monitorQueue = DispatchQueue.global(qos: .background)
     private var connectionObjects: [ConnectionObject] = []
 
     private var retryTimer: DispatchSourceTimer?
+    private let timerQueue = DispatchQueue(label: "com.openhab.networktracker.timerQueue")
+
+    private let connectedRetryInterval: TimeInterval = 60 // amount of time we scan for better connections when connected
+    private let disconnectedRetryInterval: TimeInterval = 30 // amount of time we scan when not connected
 
     private init() {
         monitor = NWPathMonitor()
@@ -57,7 +56,7 @@ public final class NetworkTracker: ObservableObject {
                 self?.checkActiveServer()
             } else {
                 os_log("Network status: Disconnected", log: OSLog.default, type: .info)
-                self?.updateStatus(.notConnected)
+                self?.setActiveServer(nil)
                 self?.startRetryTimer(10) // try every 10 seconds connect
             }
         }
@@ -69,19 +68,18 @@ public final class NetworkTracker: ObservableObject {
         attemptConnection()
     }
 
+    // This gets called periodically when we have an active server to make sure its still the best choice
     private func checkActiveServer() {
         guard let activeServer, activeServer.priority == 0 else {
             // No primary active server, proceed with the normal connection attempt
             attemptConnection()
             return
         }
-        // Check if the last active server is reachable
+        // Check if the primary (priority = 0)  active server is reachable if thats what is currenty connected.
         NetworkConnection.tracker(openHABRootUrl: activeServer.url) { [weak self] response in
             switch response.result {
             case .success:
                 os_log("Network status: Active server is reachable: %{PUBLIC}@", log: OSLog.default, type: .info, activeServer.url)
-                self?.updateStatus(.connected) // If reachable, we're done
-                self?.cancelRetryTimer()
             case .failure:
                 os_log("Network status: Active server is not reachable: %{PUBLIC}@", log: OSLog.default, type: .error, activeServer.url)
                 self?.attemptConnection() // If not reachable, run the connection logic
@@ -92,7 +90,7 @@ public final class NetworkTracker: ObservableObject {
     private func attemptConnection() {
         guard !connectionObjects.isEmpty else {
             os_log("Network status: No connection objects available.", log: OSLog.default, type: .error)
-            updateStatus(.notConnected)
+            setActiveServer(nil)
             return
         }
         os_log("Network status: checking available servers....", log: OSLog.default, type: .error)
@@ -114,7 +112,7 @@ public final class NetworkTracker: ObservableObject {
                 os_log("Network status: No server responded in 2 seconds, waiting for checks to finish.", log: OSLog.default, type: .info)
             } else {
                 os_log("Network status: No server responded in 2 seconds and no checks are outstanding.", log: OSLog.default, type: .error)
-                updateStatus(.connectionFailed)
+                setActiveServer(nil)
             }
         }
 
@@ -176,36 +174,43 @@ public final class NetworkTracker: ObservableObject {
                 os_log("Network status: First available connection established with %{PUBLIC}@", log: OSLog.default, type: .info, firstAvailableConnection.url)
             } else {
                 os_log("Network status: No server responded, connection failed.", log: OSLog.default, type: .error)
-                updateStatus(.connectionFailed)
+                setActiveServer(nil)
             }
         }
     }
 
     // Start the retry timer to attempt connection every N seconds
     private func startRetryTimer(_ retryInterval: TimeInterval) {
         cancelRetryTimer()
-        retryTimer = DispatchSource.makeTimerSource(queue: DispatchQueue.global())
-        retryTimer?.schedule(deadline: .now() + retryInterval, repeating: retryInterval)
-        retryTimer?.setEventHandler { [weak self] in
-            os_log("Network status: Retry timer firing", log: OSLog.default, type: .info)
-            self?.attemptConnection()
+        timerQueue.sync {
+            retryTimer = DispatchSource.makeTimerSource(queue: timerQueue)
+            retryTimer?.schedule(deadline: .now() + retryInterval, repeating: retryInterval)
+            retryTimer?.setEventHandler { [weak self] in
+                os_log("Network status: Retry timer firing", log: OSLog.default, type: .info)
+                self?.attemptConnection()
+            }
+            retryTimer?.resume()
         }
-        retryTimer?.resume()
     }
 
-    // Cancel the retry timer
     private func cancelRetryTimer() {
-        retryTimer?.cancel()
-        retryTimer = nil
+        timerQueue.sync {
+            retryTimer?.cancel()
+            retryTimer = nil
+        }
     }
 
-    private func setActiveServer(_ server: ConnectionObject) {
-        os_log("Network status: setActiveServer: %{PUBLIC}@", log: OSLog.default, type: .info, server.url)
-        if activeServer != server {
-            activeServer = server
+    private func setActiveServer(_ server: ConnectionObject?) {
+        os_log("Network status: setActiveServer: %{PUBLIC}@", log: OSLog.default, type: .info, server?.url ?? "no server")
+        guard activeServer != server else { return }
+        activeServer = server
+        if activeServer != nil {
+            updateStatus(.connected)
+            startRetryTimer(connectedRetryInterval)
+        } else {
+            updateStatus(.notConnected)
+            startRetryTimer(disconnectedRetryInterval)
         }
-        updateStatus(.connected)
-        startRetryTimer(60) // check every 60 seconds to see if a better server is available.
     }
 
     private func updateStatus(_ newStatus: NetworkStatus) {