Improve error and document handling (#1221)

* Simplify stale document rendering

* Remove Swift version compile-time checks

Author: carson-katri

Sources/LiveViewNative/Coordinators/LiveSessionCoordinator.swift

@@ -138,42 +138,27 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
 
         state = .connecting
 
-        let html: String
-        do {
-            html = try await fetchDOM(url: self.url)
-        } catch {
-            state = .connectionFailed(error)
-            return
-        }
-        
-        let domValues: DOMValues
         do {
+            let html = try await fetchDOM(url: self.url)
+            
             let doc = try SwiftSoup.parse(html, self.url.absoluteString, SwiftSoup.Parser.xmlParser().settings(.init(true, true)))
-            domValues = try self.extractDOMValues(doc)
+            let domValues = try self.extractDOMValues(doc)
             // extract the root layout, removing anything within the `<div data-phx-main>`.
             let mainDiv = try doc.select("div[data-phx-main]")[0]
             try mainDiv.replaceWith(doc.createElement("phx-main"))
             self.rootLayout = try LiveViewNativeCore.Document.parse(doc.outerHtml())
-        } catch {
-            state = .connectionFailed(error)
-            return
-        }
-        
-        self.domValues = domValues
-        
-        if socket == nil {
-            do {
+            
+            self.domValues = domValues
+            
+            if socket == nil {
                 try await self.connectSocket(domValues)
-            } catch {
-                state = .connectionFailed(error)
-                return
             }
-        }
-        
-        do {
+            
             try await navigationPath.first!.coordinator.connect(domValues: domValues, redirect: false)
         } catch {
             self.state = .connectionFailed(error)
+            logger.log(level: .error, "\(error.localizedDescription)")
+            return
         }
     }
 
@@ -371,8 +356,8 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
             case .push:
                 navigationPath.append(entry)
             case .replace:
-                // If there is nothing to replace, change the root URL.
                 if !navigationPath.isEmpty {
+                    coordinator.document = navigationPath.last!.coordinator.document
                     await navigationPath.last?.coordinator.disconnect()
                     navigationPath[navigationPath.count - 1] = entry
                     try await coordinator.connect(domValues: self.domValues, redirect: true)
@@ -387,7 +372,6 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
             case .push:
                 navigationPath.append(entry)
             case .replace:
-                // If there is nothing to replace, change the root URL.
                 if !navigationPath.isEmpty {
                     navigationPath[navigationPath.count - 1] = entry
                 }

Sources/LiveViewNative/Coordinators/LiveSessionState.swift

@@ -29,4 +29,13 @@ public enum LiveSessionState {
             return false
         }
     }
+    
+    /// Is the enum in the `connected` state.
+    var isConnected: Bool {
+        if case .connected = self {
+            return true
+        } else {
+            return false
+        }
+    }
 }

Sources/LiveViewNative/Coordinators/LiveViewCoordinator.swift

@@ -47,7 +47,7 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
         }
         return subject
     }
-    private var rendered: Root!
+    internal var rendered: Root!
     internal let builder = ViewTreeBuilder<R>()
 
     private var currentConnectionToken: ConnectionAttemptToken?
@@ -56,23 +56,9 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
     private(set) internal var eventSubject = PassthroughSubject<(String, Payload), Never>()
     private(set) internal var eventHandlers = Set<AnyCancellable>()
 
-    init(session: LiveSessionCoordinator<R>, url: URL, from other: LiveViewCoordinator<R>? = nil) {
+    init(session: LiveSessionCoordinator<R>, url: URL) {
         self.session = session
         self.url = url
-        if let other {
-            self.channel = other.channel
-            if let rendered = other.rendered {
-                // create a new document that won't be merged into.
-                // should core have a "clone document" ability?
-                self.document = try! Document.parse(rendered.buildString())
-            }
-            self.rendered = other.rendered
-            self.currentConnectionToken = other.currentConnectionToken
-            self.currentConnectionTask = other.currentConnectionTask
-            self.eventSubject = other.eventSubject
-            self.eventHandlers = other.eventHandlers
-            self.internalState = other.internalState
-        }
 
         self.handleEvent("native_redirect") { [weak self] payload in
             guard let self,
@@ -301,18 +287,14 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
             for try await joinResult in join(channel: channel) {
                 switch joinResult {
                 case .rendered(let payload):
-                    await MainActor.run {
-                        self.internalState = .connecting
-                    }
                     await MainActor.run {
                         self.handleJoinPayload(renderedPayload: payload)
+                        self.internalState = .connected
                     }
                 case .redirect(let liveRedirect):
                     self.url = liveRedirect.to
                     try await self.connect(domValues: domValues, redirect: true)
                 }
-                
-                self.internalState = .connected
             }
         }
 

Sources/LiveViewNative/LiveView.swift

@@ -9,7 +9,6 @@ import Foundation
 import SwiftUI
 import Combine
 
-#if swift(>=5.9)
 /// Create a ``LiveView`` with a list of addons.
 ///
 /// Use this macro to automatically register any addons.
@@ -27,7 +26,6 @@ public macro LiveView<Host: LiveViewHost>(
     configuration: LiveSessionConfiguration = .init(),
     addons: [any CustomRegistry<EmptyRegistry>.Type]
 ) -> AnyView = #externalMacro(module: "LiveViewNativeMacros", type: "LiveViewMacro")
-#endif
 
 /// The SwiftUI root view for a Phoenix LiveView.
 ///
@@ -87,15 +85,11 @@ public struct LiveView<R: RootRegistry>: View {
                         fatalError()
                     case .notConnected:
                         if #available(iOS 17, macOS 14, tvOS 17, watchOS 10, *) {
-                            #if swift(>=5.9)
                             SwiftUI.ContentUnavailableView {
                                 SwiftUI.Label("No Connection", systemImage: "network.slash")
                             } description: {
                                 SwiftUI.Text("The app will reconnect when network connection is regained.")
                             }
-                            #else
-                            SwiftUI.Text("Not Connected")
-                            #endif
                         }
                     case .connecting:
                         SwiftUI.ProgressView("Connecting")
@@ -106,22 +100,19 @@ public struct LiveView<R: RootRegistry>: View {
                             ErrorView<R>(html: trace)
                         } else {
                             if #available(iOS 17, macOS 14, tvOS 17, watchOS 10, *) {
-                                #if swift(>=5.9)
                                 SwiftUI.ContentUnavailableView {
                                     SwiftUI.Label("No Connection", systemImage: "network.slash")
                                 } description: {
-                                    SwiftUI.Text("The app will reconnect when network connection is regained.")
-                                }
-                                #else
-                                SwiftUI.VStack {
-                                    SwiftUI.Text("Connection Failed")
-                                        .font(.subheadline)
+                                    #if DEBUG
                                     SwiftUI.Text(error.localizedDescription)
+                                        .monospaced()
+                                    #else
+                                    SwiftUI.Text("The app will reconnect when network connection is regained.")
+                                    #endif
                                 }
-                                #endif
                             } else {
                                 SwiftUI.VStack {
-                                    SwiftUI.Text("Connection Failed")
+                                    SwiftUI.Text("No Connection")
                                         .font(.subheadline)
                                     SwiftUI.Text(error.localizedDescription)
                                 }

Sources/LiveViewNative/NavStackEntryView.swift

@@ -33,20 +33,17 @@ struct NavStackEntryView<R: RootRegistry>: View {
     private var elementTree: some View {
         SwiftUI.Group {
             if coordinator.url == entry.url {
-                switch coordinator.state {
-                case .connected:
-                    coordinator.builder.fromNodes(coordinator.document![coordinator.document!.root()].children(), coordinator: coordinator, url: coordinator.url)
-                        .environment(\.coordinatorEnvironment, CoordinatorEnvironment(coordinator, document: coordinator.document!))
+                if coordinator.state.isConnected || coordinator.state.isPending,
+                   let document = coordinator.document
+                {
+                    coordinator.builder.fromNodes(document[document.root()].children(), coordinator: coordinator, url: coordinator.url)
+                        .environment(\.coordinatorEnvironment, CoordinatorEnvironment(coordinator, document: document))
+                        .disabled(coordinator.state.isPending)
                         .transition(coordinator.session.configuration.transition ?? .identity)
-                default:
+                        .id(ObjectIdentifier(document))
+                } else {
                     SwiftUI.Group {
-                        if coordinator.state.isPending,
-                           let document = coordinator.document
-                        {
-                            coordinator.builder.fromNodes(document[document.root()].children(), coordinator: coordinator, url: coordinator.url)
-                               .environment(\.coordinatorEnvironment, CoordinatorEnvironment(coordinator, document: document))
-                               .disabled(true)
-                       } else if R.LoadingView.self == Never.self {
+                        if R.LoadingView.self == Never.self {
                             switch coordinator.state {
                             case .connected:
                                 fatalError()
@@ -69,12 +66,6 @@ struct NavStackEntryView<R: RootRegistry>: View {
                 }
             }
         }
-        .animation(coordinator.session.configuration.transition.map({ _ in .default }), value: { () -> Bool in
-            if case .connected = coordinator.state {
-                return true
-            } else {
-                return false
-            }
-        }())
+        .animation(coordinator.session.configuration.transition.map({ _ in .default }), value: coordinator.state.isConnected)
     }
 }

Sources/LiveViewNative/Property Wrappers/Event.swift

@@ -49,41 +49,29 @@ public struct Event: DynamicProperty, Decodable {
     @Environment(\.coordinatorEnvironment) private var coordinatorEnvironment
     @StateObject var handler = Handler()
     /// The name of the event to send.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let event: String?
     private let name: AttributeName?
     /// The type of event, such as `click` or `focus`.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let type: String
     /// The target `LiveView` or `LiveComponent`.
     ///
     /// Pass `@myself` in a component to send the event to the component instead of its parent `LiveView`.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let target: Int?
     /// A duration in milliseconds for the debounce interval.
     ///
     /// - Note: ``debounce`` takes precedence over ``throttle``.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let debounce: Double?
     /// A duration in milliseconds for the throttle interval.
     ///
     /// - Note: ``debounce`` takes precedence over ``throttle``.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let throttle: Double?
     /// Custom values to send with the event.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     private let params: Any?
 
     @Attribute("phx-debounce") private var debounceAttribute: Double?

Sources/LiveViewNative/Registries/AggregateRegistry.swift

@@ -9,7 +9,6 @@ import Foundation
 import SwiftUI
 import LiveViewNativeStylesheet
 
-#if swift(>=5.9)
 /// A macro that combines multiple registries together.
 ///
 /// ```swift
@@ -23,7 +22,6 @@ import LiveViewNativeStylesheet
 /// ```
 @freestanding(declaration, names: named(Registries))
 public macro Registries() = #externalMacro(module: "LiveViewNativeMacros", type: "RegistriesMacro")
-#endif
 
 /// An aggregate registry combines multiple other registries together, allowing you to use tags/modifiers declared by any of them.
 ///

Sources/LiveViewNative/Utils/Font.swift

@@ -22,9 +22,7 @@ import LiveViewNativeCore
 /// * `footnote`
 /// * `caption`
 /// * `caption2`
-#if swift(>=5.8)
 @_documentation(visibility: public)
-#endif
 extension Font.TextStyle: AttributeDecodable {
     public init(from attribute: LiveViewNativeCore.Attribute?) throws {
         guard let value = attribute?.value

Sources/LiveViewNative/Views/Accessibility/ScaledMetric.swift

@@ -36,30 +36,22 @@ import SwiftUI
 ///
 /// ## Bindings
 /// * ``scaledValue``
-#if swift(>=5.8)
 @_documentation(visibility: public)
-#endif
 struct ScaledMetric<R: RootRegistry>: View {
     @ObservedElement private var element: ElementNode
     @LiveContext<R> private var context
 
     /// The event to update with the scaled ``value``.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     @Event("phx-change", type: "click") private var onChange
 
     /// The initial value to scale.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     @Attribute("value") private var value: Double
 
     /// The ``LiveViewNative/SwiftUI/Font/TextStyle`` to scale with.
     /// Defaults to `body`.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     @Attribute("relative-to") private var relativeStyle: Font.TextStyle = .body
 
     var body: some View {

Sources/LiveViewNative/Views/Controls and Indicators/Buttons/Button.swift

@@ -26,9 +26,7 @@ import SwiftUI
 /// 
 /// ## Events
 /// * ``click``
-#if swift(>=5.8)
 @_documentation(visibility: public)
-#endif
 @_spi(LiveForm)
 public struct Button<R: RootRegistry>: View {
     @ObservedElement private var element: ElementNode
@@ -37,15 +35,11 @@ public struct Button<R: RootRegistry>: View {
     private let action: (() -> Void)?
 
     /// Event triggered when tapped.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     @Event("phx-click", type: "click") private var click
 
     /// Boolean attribute that indicates whether the button is tappable.
-    #if swift(>=5.8)
     @_documentation(visibility: public)
-    #endif
     @Attribute("disabled") private var disabled: Bool
 
     @_spi(LiveForm) public init(action: (() -> Void)? = nil) {