Navigation patterns guide

.github/workflows/elixir.yml

@@ -11,23 +11,6 @@ permissions:
 env:
   MIX_ENV: test
 
-steps:
-- name: Update Homebrew
-  run: |
-    brew update --preinstall
-    cat "$(brew --repository)/Library/Taps/homebrew/homebrew-core/Formula/foo.rb" > .github/brew-formulae
-- name: Configure Homebrew cache
-  uses: actions/cache@v2
-  with:
-    path: |
-      ~/Library/Caches/Homebrew/foo--*
-      ~/Library/Caches/Homebrew/downloads/*--foo-*
-    key: brew-${{ hashFiles('.github/brew-formulae') }}
-    restore-keys: brew-
-- name: Install Homebrew dependencies
-  run: |
-    env HOMEBREW_NO_AUTO_UPDATE=1 brew install xcodegen
-
 jobs:
   build:
     name: Build and test

.gitignore

@@ -38,3 +38,5 @@ live_view_native_swiftui-*.tar
 
 # Temporary files, for example, from tests.
 /tmp/
+
+.vscode

Package.resolved

@@ -86,8 +86,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/davidstump/SwiftPhoenixClient.git",
       "state" : {
-        "revision" : "613989bf2e562d8a851ea83741681c3439353b45",
-        "version" : "5.0.0"
+        "revision" : "588bf6baab5d049752748e19a4bff32421ea40ec",
+        "version" : "5.3.2"
       }
     },
     {

Package.swift

@@ -25,7 +25,7 @@ let package = Package(
     dependencies: [
         // Dependencies declare other packages that this package depends on.
         .package(url: "https://github.com/scinfu/SwiftSoup.git", from: "2.3.2"),
-        .package(url: "https://github.com/davidstump/SwiftPhoenixClient.git", .upToNextMinor(from: "5.0.0")),
+        .package(url: "https://github.com/davidstump/SwiftPhoenixClient.git", .upToNextMinor(from: "5.3.2")),
         .package(url: "https://github.com/apple/swift-async-algorithms", from: "0.1.0"),
         .package(url: "https://github.com/liveview-native/liveview-native-core-swift.git", exact: "0.2.1"),
 

Sources/BuiltinRegistryGenerator/BuiltinRegistryGenerator.swift

@@ -132,21 +132,24 @@ struct BuiltinRegistryGenerator: ParsableCommand {
             // [platform] [version], ...
             let platform = Reference(Substring.self)
             let version = Reference(Double?.self)
-            let expression = Regex {
-                Capture(as: platform) {
-                    OneOrMore(.word)
+            let platformExpr = Capture(as: platform) {
+                OneOrMore(.word)
+            }
+            let versionExpr = Capture(as: version) {
+                OneOrMore(.digit)
+                Optionally {
+                    "."
+                    OneOrMore(.digit)
                 }
+            } transform: {
+                Double($0)
+            }
+
+            let expression = Regex {
+                platformExpr
                 Optionally {
                     OneOrMore(.whitespace)
-                    Capture(as: version) {
-                        OneOrMore(.digit)
-                        Optionally {
-                            "."
-                            OneOrMore(.digit)
-                        }
-                    } transform: {
-                        Double($0)
-                    }
+                    versionExpr
                 }
             }
             let availability = String(match[availability])

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.
@@ -418,7 +418,7 @@ public class LiveSessionCoordinator<R: RootRegistry>: ObservableObject {
                 socket.off(refs)
                 continuation.resume(returning: socket)
             })
-            refs.append(socket.onError { [weak self, weak socket] (error) in
+            refs.append(socket.onError { [weak self, weak socket] (error, response) in
                 guard let socket else { return }
                 guard self != nil else {
                     socket.disconnect()
@@ -521,14 +521,16 @@ class LiveSessionURLSessionDelegate<R: RootRegistry>: NSObject, URLSessionTaskDe
 
 extension LiveSessionCoordinator {
     static var platform: String { "swiftui" }
-    static var platformParams: [String:String] {
+    static var platformParams: [String:Any] {
         [
             "app_version": getAppVersion(),
             "app_build": getAppBuild(),
             "bundle_id": getBundleID(),
             "os": getOSName(),
             "os_version": getOSVersion(),
-            "target": getTarget()
+            "target": getTarget(),
+            "l10n": getLocalization(),
+            "i18n": getInternationalization()
         ]
     }
 
@@ -607,6 +609,18 @@ extension LiveSessionCoordinator {
         }
         #endif
     }
+
+    private static func getLocalization() -> [String:Any] {
+        [
+            "locale": Locale.autoupdatingCurrent.identifier,
+        ]
+    }
+
+    private static func getInternationalization() -> [String:Any] {
+        [
+            "time_zone": TimeZone.autoupdatingCurrent.identifier,
+        ]
+    }
 }
 
 fileprivate extension URL {
@@ -619,12 +633,24 @@ fileprivate extension URL {
                 .init(name: "_format", value: LiveSessionCoordinator<R>.platform)
             ])
         }
-        for (key, value) in LiveSessionCoordinator<R>.platformParams {
-            let name = "_interface[\(key)]"
+        /// Create a nested structure of query items.
+        ///
+        /// `_root[key][nested_key]=value`
+        func queryParameters(for object: [String:Any]) -> [(name: String, value: String?)] {
+            object.reduce(into: [(name: String, value: String?)]()) { (result, pair) in
+                if let value = pair.value as? String {
+                    result.append((name: "[\(pair.key)]", value: value))
+                } else if let nested = pair.value as? [String:Any] {
+                    result.append(contentsOf: queryParameters(for: nested).map {
+                        return (name: "[\(pair.key)]\($0.name)", value: $0.value)
+                    })
+                }
+            }
+        }
+        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: value)
-                ])
+                result.append(queryItems: [.init(name: name, value: queryItem.value)])
             }
         }
         return result

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()
         }

Sources/LiveViewNative/Property Wrappers/ObservedElement.swift

@@ -85,8 +85,8 @@ public struct ObservedElement {
     }
 
     /// A publisher that publishes when the observed element changes.
-    public var projectedValue: some Publisher<Void, Never> {
-        observer.objectWillChange
+    public var projectedValue: some Publisher<NodeRef, Never> {
+        observer.elementChangedPublisher
     }
 
     var children: [Node] { overrideElement.flatMap({ Array($0.children()) }) ?? observer.resolvedChildren }
@@ -127,6 +127,8 @@ extension ObservedElement {
 
         var objectWillChange = ObjectWillChangePublisher()
 
+        var elementChangedPublisher: AnyPublisher<NodeRef, Never>!
+
         init(_ id: NodeRef) {
             self.id = id
         }
@@ -141,18 +143,21 @@ extension ObservedElement {
             self.resolvedChildren = Array(self.resolvedElement.children())
             self._resolvedChildIDs = nil
 
-            let publisher: AnyPublisher<(), Never>
+            let id = self.id
+
             if observeChildren {
-                publisher = Publishers.MergeMany(
-                    [context.elementChanged(id)] + self.resolvedChildIDs.map(context.elementChanged)
+                self.elementChangedPublisher = Publishers.MergeMany(
+                    [context.elementChanged(id).map({ id })] + self.resolvedChildIDs.map({ id in
+                        context.elementChanged(id).map({ id })
+                    })
                 )
                 .eraseToAnyPublisher()
                 self.observedChildIDs = self.resolvedChildIDs
             } else {
-                publisher = context.elementChanged(id).eraseToAnyPublisher()
+                self.elementChangedPublisher = context.elementChanged(id).map({ id }).eraseToAnyPublisher()
             }
 
-            cancellable = publisher
+            cancellable = self.elementChangedPublisher
                 .sink { [weak self] _ in
                     guard let self else { return }
                     self.resolvedElement = context.document[id].asElement()

Sources/LiveViewNative/Protocols/ContentBuilder.swift

@@ -340,6 +340,19 @@ public struct ContentBuilderContext<R: RootRegistry, Builder: ContentBuilder>: D
 
         let resolvedStylesheet: [String:[BuilderModifierContainer<Builder>]]
 
+        public var coordinator: LiveViewCoordinator<R> {
+            context.coordinator
+        }
+
+        public var url: URL {
+            context.url
+        }
+
+        @MainActor
+        public var document: Document? {
+            context.coordinator.document
+        }
+
         func value<OtherBuilder: ContentBuilder>(for _: OtherBuilder.Type = OtherBuilder.self) -> ContentBuilderContext<R, OtherBuilder>.Value {
             return .init(
                 coordinatorEnvironment: coordinatorEnvironment,
@@ -363,9 +376,13 @@ public struct ContentBuilderContext<R: RootRegistry, Builder: ContentBuilder>: D
     static func resolveStylesheet(
         _ stylesheet: Stylesheet<R>
     ) throws -> [String:[BuilderModifierContainer<Builder>]] {
-        return try stylesheet.content.reduce(into: [:], {
-            $0.merge(try StylesheetParser<BuilderModifierContainer<Builder>>(context: .init()).parse($1.utf8), uniquingKeysWith: { $1 })
-        })
+        if Builder.ModifierType.self == EmptyContentModifier<Builder>.self {
+            return [:]
+        } else {
+            return try stylesheet.content.reduce(into: [:], {
+                $0.merge(try StylesheetParser<BuilderModifierContainer<Builder>>(context: .init()).parse($1.utf8), uniquingKeysWith: { $1 })
+            })
+        }
     }
 }