Merge pull request #1361 from liveview-native/macos-disconnected-view

Add separate `setup` and `disconnected` states

Author: bcardarella

Sources/LiveViewNative/Coordinators/LiveSessionCoordinator.swift

@@ -33,7 +33,7 @@ private let logger = Logger(subsystem: "LiveViewNative", category: "LiveSessionC
 @MainActor
 public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
     /// The current state of the live view connection.
-    @Published public private(set) var state = LiveSessionState.notConnected
+    @Published public private(set) var state = LiveSessionState.setup
 
     /// The current URL this live view is connected to.
     public private(set) var url: URL
@@ -103,11 +103,11 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
 
         $navigationPath.scan(([LiveNavigationEntry<R>](), [LiveNavigationEntry<R>]()), { ($0.1, $1) }).sink { [weak self] prev, next in
             guard let self else { return }
-            let isDisconnected: Bool
-            if case .notConnected = next.last!.coordinator.state {
-                isDisconnected = true
-            } else {
-                isDisconnected = false
+            let isDisconnected = switch next.last!.coordinator.state {
+            case .setup, .disconnected:
+                true
+            default:
+                false
             }
             if next.last!.coordinator.url != next.last!.url || isDisconnected {
                 Task {
@@ -151,15 +151,15 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
     ///
     /// You generally do not call this function yourself. It is called automatically when the ``LiveView`` appears.
     ///
-    /// This function is a no-op unless ``state`` is ``LiveSessionState/notConnected``.
+    /// This function is a no-op unless ``state`` is ``LiveSessionState/setup`` or ``LiveSessionState/disconnected`` or ``LiveSessionState/connectionFailed(_:)``.
     ///
     /// This is an async function which completes when the connection has been established or failed.
     ///
     /// - Parameter httpMethod: The HTTP method to use for the dead render. Defaults to `GET`.
     /// - Parameter httpBody: The HTTP body to send when requesting the dead render.
     public func connect(httpMethod: String? = nil, httpBody: Data? = nil) async {
         switch state {
-        case .notConnected, .connectionFailed:
+        case .setup, .disconnected, .connectionFailed:
             break
         default:
             return
@@ -252,7 +252,7 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
         }
         self.socket?.disconnect()
         self.socket = nil
-        self.state = .notConnected
+        self.state = .disconnected
     }
 
     /// Forces the session to disconnect then connect.

Sources/LiveViewNative/Coordinators/LiveSessionState.swift

@@ -10,21 +10,23 @@ import Foundation
 /// The live view connection state.
 public enum LiveSessionState {
     /// The coordinator has not yet connected to the live view.
-    case notConnected
+    case setup
     /// The coordinator is attempting to connect.
     case connecting
     /// The coordinator is attempting to reconnect.
     case reconnecting
     /// The coordinator has connected and the view tree can be rendered.
     case connected
-    // todo: disconnected state?
+    /// The coordinator is disconnected.
+    case disconnected
     /// The coordinator failed to connect and produced the given error.
     case connectionFailed(Error)
 
-    /// Either `notConnected` or `connecting`
+    /// Either `setup` or `connecting`
     var isPending: Bool {
         switch self {
-        case .notConnected,
+        case .setup,
+             .disconnected,
              .connecting,
              .reconnecting:
             return true

Sources/LiveViewNative/Coordinators/LiveViewCoordinator.swift

@@ -26,7 +26,7 @@ private let logger = Logger(subsystem: "LiveViewNative", category: "LiveViewCoor
 /// - ``handleEvent(_:handler:)``
 @MainActor
 public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
-    @Published internal private(set) var internalState: LiveSessionState = .notConnected
+    @Published internal private(set) var internalState: LiveSessionState = .setup
 
     var state: LiveSessionState {
         internalState
@@ -283,7 +283,7 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
         channel.on("phx_close") { [weak self, weak channel] message in
             Task { @MainActor in
                 guard channel === self?.channel else { return }
-                self?.internalState = .notConnected
+                self?.internalState = .disconnected
             }
         }
 
@@ -320,7 +320,7 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
         }
         await MainActor.run { [weak self] in
             self?.channel = nil
-            self?.internalState = .notConnected
+            self?.internalState = .disconnected
         }
     }
 

Sources/LiveViewNative/Live/LiveView.swift

@@ -201,7 +201,9 @@ public struct LiveView<
             return .connecting
         case let .connectionFailed(error):
             return .error(error)
-        case .notConnected:
+        case .setup:
+            return .connecting
+        case .disconnected:
             return .disconnected
         case .reconnecting:
             return .reconnecting(_ConnectedContent<R>(session: session))

Sources/LiveViewNative/NavStackEntryView.swift

@@ -30,12 +30,14 @@ struct NavStackEntryView<R: RootRegistry>: View {
 
     private var phase: LiveViewPhase<R> {
         switch coordinator.state {
-        case .notConnected:
-            return .disconnected
+        case .setup:
+            return .connecting
         case .connecting:
             return .connecting
         case .connectionFailed(let error):
             return .error(error)
+        case .disconnected:
+            return .disconnected
         case .reconnecting, .connected: // these phases should always be handled internally
             fatalError()
         }