Merge branch 'main' into 0.3

Author: bcardarella

CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [unreleased]
+
+## Added
+- `LiveViewNative.SwiftUI.normalize_os_version/1`
+- `LiveViewNative.SwiftUI.normalize_app_version/1`
+- Optional `LiveSessionConfiguration.headers`, sent when fetching the dead render (#1456)
+
+## Changed
+- Submitting a form will remove focus from all fields (#1451)
+
+## Fixed
+- Form elements will apply updates from a diff (#1451)
+- Updates to change-tracked properties no longer occur on the next RunLoop, fixing modal dismissal on macOS (#1450)
+- `+` characters are properly encoded as `%2B` in form events (#1449)
+- Fixed retain cycle in `LiveViewCoordinator` (#1455)
+- Made `StylesheetCache` thread-safe, fixing occasional crashes (#1461)
+- Form elements outside of a `LiveForm` will show the value provided in the template (#1464)
+
 ## [0.3.0] 2024-08-21
 
 ### Added

Sources/LiveViewNative/Coordinators/LiveSessionConfiguration.swift

@@ -15,6 +15,11 @@ public struct LiveSessionConfiguration {
     ///
     /// By default, no connection params are provided.
     public var connectParams: ((URL) -> [String: Any])? = nil
+  
+    /// Optional headers that are sent when fetching the dead render.
+    ///
+    /// By default, no additional headers are provided.
+    public var headers: [String: String]? = nil
 
     /// The URL session configuration the coordinator will use for performing HTTP and socket requests.
     /// 
@@ -34,10 +39,12 @@ public struct LiveSessionConfiguration {
 
     public init(
         connectParams: ((URL) -> [String: Any])? = nil,
+        headers: [String: String]? = nil,
         urlSessionConfiguration: URLSessionConfiguration = .default,
         transition: AnyTransition? = nil,
         reconnectBehavior: ReconnectBehavior = .exponential
     ) {
+        self.headers = headers
         self.connectParams = connectParams
         self.urlSessionConfiguration = urlSessionConfiguration
         self.transition = transition

Sources/LiveViewNative/Coordinators/LiveSessionCoordinator.swift

@@ -128,13 +128,17 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
                 false
             }
             if next.last!.coordinator.url != next.last!.url || isDisconnected {
-                Task {
-                    if prev.count > next.count {
-                        // back navigation
+                if prev.count > next.count {
+                    // back navigation
+                    Task(priority: .userInitiated) {
                         try await next.last!.coordinator.connect(domValues: self.domValues, redirect: true)
-                    } else if next.count > prev.count && prev.count > 0 {
-                        // forward navigation (from `redirect` or `<NavigationLink>`)
+                    }
+                } else if next.count > prev.count && prev.count > 0 {
+                    // forward navigation (from `redirect` or `<NavigationLink>`)
+                    Task {
                         await prev.last?.coordinator.disconnect()
+                    }
+                    Task(priority: .userInitiated) {
                         try await next.last?.coordinator.connect(domValues: self.domValues, redirect: true)
                     }
                 }
@@ -193,7 +197,8 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
             var request = URLRequest(url: originalURL)
             request.httpMethod = httpMethod
             request.httpBody = httpBody
-            let (html, response) = try await deadRender(for: request)
+            let (html, response) = try await deadRender(for: request, domValues: self.domValues)
+            
             // update the URL if redirects happened.
             let url: URL
             if let responseURL = response.url {
@@ -209,27 +214,37 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
             } else {
                 url = originalURL
             }
-            
+
             let doc = try SwiftSoup.parse(html, url.absoluteString, SwiftSoup.Parser.xmlParser().settings(.init(true, true)))
-            let domValues = try self.extractDOMValues(doc)
+            self.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"))
-            async let stylesheet = withThrowingTaskGroup(of: (Data, URLResponse).self) { group in
+            
+            self.rootLayout = try LiveViewNativeCore.Document.parse(doc.outerHtml())
+
+            async let stylesheet = withThrowingTaskGroup(of: Stylesheet<R>.self) { group in
                 for style in try doc.select("Style") {
                     guard let url = URL(string: try style.attr("url"), relativeTo: url)
                     else { continue }
-                    group.addTask { try await self.urlSession.data(from: url) }
+                    group.addTask {
+                        if let cachedStylesheet = await StylesheetCache.shared.read(for: url, registry: R.self) {
+                            return cachedStylesheet
+                        } else {
+                            let (data, _) = try await self.urlSession.data(from: url)
+                            guard let contents = String(data: data, encoding: .utf8)
+                            else { return Stylesheet<R>(content: [], classes: [:]) }
+                            let stylesheet = try Stylesheet<R>(from: contents, in: .init())
+                            await StylesheetCache.shared.write(stylesheet, for: url, registry: R.self)
+                            return stylesheet
+                        }
+                    }
                 }
                 return try await group.reduce(Stylesheet<R>(content: [], classes: [:])) { result, next in
-                    guard let contents = String(data: next.0, encoding: .utf8)
-                    else { return result }
-                    return result.merge(with: try Stylesheet<R>(from: contents, in: .init()))
+                    return result.merge(with: next)
                 }
             }
-            self.rootLayout = try LiveViewNativeCore.Document.parse(doc.outerHtml())
-            
-            self.domValues = domValues
 
             if socket == nil {
                 try await self.connectSocket(domValues)
@@ -259,13 +274,20 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
     }
 
     private func disconnect(preserveNavigationPath: Bool = false) async {
-        for entry in self.navigationPath {
-            await entry.coordinator.disconnect()
-            if !preserveNavigationPath {
-                entry.coordinator.document = nil
+        // disconnect all views
+        await withTaskGroup(of: Void.self) { group in
+            for entry in self.navigationPath {
+                group.addTask {
+                    await entry.coordinator.disconnect()
+                }
             }
         }
+        // reset all documents if navigation path is being reset.
         if !preserveNavigationPath {
+            for entry in self.navigationPath {
+                entry.coordinator.document = nil
+            }
+            
             self.navigationPath = [self.navigationPath.first!]
         }
         self.socket?.disconnect()
@@ -320,10 +342,16 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
     /// Request the dead render with the given `request`.
     ///
     /// Returns the dead render HTML and the HTTP response information (including the final URL after redirects).
-    func deadRender(for request: URLRequest) async throws -> (String, HTTPURLResponse) {
+    nonisolated func deadRender(
+        for request: URLRequest,
+        domValues: DOMValues?
+    ) async throws -> (String, HTTPURLResponse) {
+        
         var request = request
-        request.url = request.url!.appendingLiveViewItems(R.self)
-        if domValues != nil {
+        request.url = request.url!.appendingLiveViewItems()
+        request.allHTTPHeaderFields = configuration.headers
+        
+        if let domValues {
             request.setValue(domValues.phxCSRFToken, forHTTPHeaderField: "x-csrf-token")
         }
 
@@ -361,7 +389,7 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
         let liveReloadEnabled: Bool
     }
 
-    private func extractLiveReloadFrame(_ doc: SwiftSoup.Document) throws -> Bool {
+    nonisolated private func extractLiveReloadFrame(_ doc: SwiftSoup.Document) throws -> Bool {
         !(try doc.select("iframe[src=\"/phoenix/live_reload/frame\"]").isEmpty())
     }
 
@@ -395,9 +423,12 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
             var wsEndpoint = URLComponents(url: self.url, resolvingAgainstBaseURL: true)!
             wsEndpoint.scheme = self.url.scheme == "https" ? "wss" : "ws"
             wsEndpoint.path = "/live/websocket"
+            let configuration = self.urlSession.configuration
             let socket = Socket(
                 endPoint: wsEndpoint.string!,
-                transport: { [unowned self] in URLSessionTransport(url: $0, configuration: self.urlSession.configuration) },
+                transport: {
+                    URLSessionTransport(url: $0, configuration: configuration)
+                },
                 paramsClosure: {
                     [
                         "_csrf_token": domValues.phxCSRFToken,
@@ -479,11 +510,12 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
         }.receive("error") { msg in
             logger.debug("[LiveReload] error connecting to channel: \(msg.payload)")
         }
-        self.liveReloadChannel!.on("assets_change") { [unowned self] _ in
+        self.liveReloadChannel!.on("assets_change") { [weak self] _ in
             logger.debug("[LiveReload] assets changed, reloading")
             Task {
+                await StylesheetCache.shared.removeAll()
                 // need to fully reconnect (rather than just re-join channel) because the elixir code reloader only triggers on http reqs
-                await self.reconnect()
+                await self?.reconnect()
             }
         }
     }
@@ -532,12 +564,12 @@ class LiveSessionURLSessionDelegate<R: RootRegistry>: NSObject, URLSessionTaskDe
         }
 
         var newRequest = request
-        newRequest.url = await url.appendingLiveViewItems(R.self)
+        newRequest.url = await url.appendingLiveViewItems()
         return newRequest
     }
 }
 
-extension LiveSessionCoordinator {
+enum LiveSessionParameters {
     static var platform: String { "swiftui" }
     static var platformParams: [String:Any] {
         [
@@ -639,18 +671,8 @@ extension LiveSessionCoordinator {
             "time_zone": TimeZone.autoupdatingCurrent.identifier,
         ]
     }
-}
-
-fileprivate extension URL {
-    @MainActor
-    func appendingLiveViewItems<R: RootRegistry>(_: R.Type = R.self) -> Self {
-        var result = self
-        let components = URLComponents(url: self, resolvingAgainstBaseURL: false)
-        if !(components?.queryItems?.contains(where: { $0.name == "_format" }) ?? false) {
-            result.append(queryItems: [
-                .init(name: "_format", value: LiveSessionCoordinator<R>.platform)
-            ])
-        }
+    
+    static var queryItems: [URLQueryItem] = {
         /// Create a nested structure of query items.
         ///
         /// `_root[key][nested_key]=value`
@@ -665,12 +687,24 @@ fileprivate extension URL {
                 }
             }
         }
-        for queryItem in queryParameters(for: LiveSessionCoordinator<R>.platformParams) {
-            let name = "_interface\(queryItem.name)"
-            if !(components?.queryItems?.contains(where: { $0.name == name }) ?? false) {
-                result.append(queryItems: [.init(name: name, value: queryItem.value)])
+        
+        return queryParameters(for: platformParams)
+            .map { queryItem in
+                URLQueryItem(name: "_interface\(queryItem.name)", value: queryItem.value)
             }
-        }
+            + [.init(name: "_format", value: platform)]
+    }()
+}
+
+fileprivate extension URL {
+    nonisolated func appendingLiveViewItems() -> Self {
+        var result = self
+        let components = URLComponents(url: self, resolvingAgainstBaseURL: false)
+        let existingQueryItems = (components?.queryItems ?? []).reduce(into: Set<String>()) { $0.insert($1) }
+        result.append(
+            queryItems: LiveSessionParameters.queryItems
+                .filter({ !existingQueryItems.contains($0.name) })
+        )
         return result
     }
 }

Sources/LiveViewNative/Coordinators/LiveViewCoordinator.swift

@@ -32,7 +32,7 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
         internalState
     }
 
-    @_spi(LiveForm) public let session: LiveSessionCoordinator<R>
+    @_spi(LiveForm) public private(set) weak var session: LiveSessionCoordinator<R>!
     var url: URL
 
     private var channel: Channel?
@@ -56,16 +56,22 @@ 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) {
+    private(set) internal var liveViewModel = LiveViewModel()
+    
+    init(
+        session: LiveSessionCoordinator<R>,
+        url: URL
+    ) {
         self.session = session
         self.url = url
 
         self.handleEvent("native_redirect") { [weak self] payload in
             guard let self,
-                  let redirect = LiveRedirect(from: payload, relativeTo: self.url)
+                  let redirect = LiveRedirect(from: payload, relativeTo: self.url),
+                  let session = self.session
             else { return }
-            Task { [weak session] in
-                try await session?.redirect(redirect)
+            Task {
+                try await session.redirect(redirect)
             }
         }
     }
@@ -238,7 +244,7 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
         connectParams["_mounts"] = 0
         connectParams["_format"] = "swiftui"
         connectParams["_csrf_token"] = domValues.phxCSRFToken
-        connectParams["_interface"] = LiveSessionCoordinator<R>.platformParams
+        connectParams["_interface"] = LiveSessionParameters.platformParams
 
         let params: Payload = [
             "session": domValues.phxSession,
@@ -324,10 +330,10 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
                         continuation.resume()
                     }
             }
-        }
-        await MainActor.run { [weak self] in
-            self?.channel = nil
-            self?.internalState = .disconnected
+            await MainActor.run { [weak self] in
+                self?.channel = nil
+                self?.internalState = .disconnected
+            }
         }
     }
 
@@ -393,7 +399,13 @@ public class LiveViewCoordinator<R: RootRegistry>: ObservableObject {
     private func handleJoinPayload(renderedPayload: Payload) {
         // todo: what should happen if decoding or parsing fails?
         self.rendered = try! Root(from: FragmentDecoder(data: renderedPayload))
+        
+        // FIXME: LiveForm should send change event when restored from `liveViewModel`.
+        // For now, we just clear the forms whenever the page reconnects.
+        self.liveViewModel.clearForms()
+        
         self.document = try! LiveViewNativeCore.Document.parse(rendered.buildString())
+        
         self.document?.on(.changed) { [unowned self] doc, nodeRef in
             switch doc[nodeRef].data {
             case .root:

Sources/LiveViewNative/Live/LiveErrorView.swift

@@ -39,25 +39,36 @@ public struct LiveErrorView<Fallback: View>: View {
                 }
                 .padding()
                 #else
-                SwiftUI.Menu {
-                    SwiftUI.Button {
-                        Task {
-                            await reconnectLiveView(.automatic)
+                if #available(iOS 14, macOS 11, tvOS 17, visionOS 1, *) {
+                    SwiftUI.Menu {
+                        SwiftUI.Button {
+                            Task {
+                                await reconnectLiveView(.automatic)
+                            }
+                        } label: {
+                            SwiftUI.Label("Reconnect this page", systemImage: "arrow.2.circlepath")
+                        }
+                        SwiftUI.Button {
+                            Task {
+                                await reconnectLiveView(.restart)
+                            }
+                        } label: {
+                            SwiftUI.Label("Restart from root", systemImage: "arrow.circlepath")
                         }
                     } label: {
-                        SwiftUI.Label("Reconnect this page", systemImage: "arrow.2.circlepath")
+                        SwiftUI.Label("Reconnect", systemImage: "arrow.2.circlepath")
                     }
+                    .padding()
+                } else {
                     SwiftUI.Button {
                         Task {
                             await reconnectLiveView(.restart)
                         }
                     } label: {
                         SwiftUI.Label("Restart from root", systemImage: "arrow.circlepath")
                     }
-                } label: {
-                    SwiftUI.Label("Reconnect", systemImage: "arrow.2.circlepath")
+                    .padding()
                 }
-                .padding()
                 #endif
             }
         } else {