Merge pull request #274 from AvdLee/feature/macos-ui-improvements

kean · web-flow · commit bb0a835fd0d0 · 2024-07-01T08:16:07.000-04:00
macOS UI Improvements
diff --git a/Demo/macOS/Pulse_Demo_macOSApp.swift b/Demo/macOS/Pulse_Demo_macOSApp.swift
@@ -11,7 +11,6 @@ struct Pulse_Demo_macOSApp: App {
         WindowGroup {
             ConsoleView(store: .demo)
         }
-        .windowStyle(.hiddenTitleBar)
         .windowToolbarStyle(.unified(showsTitle: false))
     }
 }
diff --git a/Sources/Pulse/LoggerStore/LoggerStore.swift b/Sources/Pulse/LoggerStore/LoggerStore.swift
@@ -347,7 +347,7 @@ extension LoggerStore {
     }
 
     /// Handles event created by the current store and dispatches it to observers.
-    func handle(_ event: Event) {
+    public func handle(_ event: Event) {
         guard let event = configuration.willHandleEvent(event) else {
             return
         }
diff --git a/Sources/Pulse/RemoteLogger/RemoteLogger-Connection.swift b/Sources/Pulse/RemoteLogger/RemoteLogger-Connection.swift
@@ -11,12 +11,12 @@ import OSLog
 import Pulse
 #endif
 
-protocol RemoteLoggerConnectionDelegate: AnyObject {
+public protocol RemoteLoggerConnectionDelegate: AnyObject {
     func connection(_ connection: RemoteLogger.Connection, didChangeState newState: NWConnection.State)
     func connection(_ connection: RemoteLogger.Connection, didReceiveEvent event: RemoteLogger.Connection.Event)
 }
 
-extension RemoteLogger {
+public extension RemoteLogger {
     final class Connection {
         var endpoint: NWEndpoint { connection.endpoint }
         private let connection: NWConnection
@@ -31,14 +31,15 @@ extension RemoteLogger {
             self.init(NWConnection(to: endpoint, using: parameters))
         }
 
-        init(_ connection: NWConnection) {
+        public init(_ connection: NWConnection, delegate: RemoteLoggerConnectionDelegate? = nil) {
             self.connection = connection
+            self.delegate = delegate
 
             let isLogEnabled = UserDefaults.standard.bool(forKey: "com.github.kean.pulse.debug")
             self.log = isLogEnabled ? OSLog(subsystem: "com.github.kean.pulse", category: "RemoteLogger") : .disabled
         }
-
-        func start(on queue: DispatchQueue) {
+        
+        public func start(on queue: DispatchQueue) {
             connection.stateUpdateHandler = { [weak self] state in
                 guard let self = self else { return }
                 DispatchQueue.main.async {
@@ -49,15 +50,15 @@ extension RemoteLogger {
             connection.start(queue: queue)
         }
 
-        enum Event {
+        public enum Event {
             case packet(Packet)
             case error(Error)
             case completed
         }
 
-        struct Packet {
-            let code: UInt8
-            let body: Data
+        public struct Packet {
+            public let code: UInt8
+            public let body: Data
         }
 
         private func receive() {
@@ -130,7 +131,7 @@ extension RemoteLogger {
             }
         }
         
-        func send(code: UInt8, data: Data) {
+        public func send(code: UInt8, data: Data) {
             do {
                 let data = try encode(code: code, body: data)
                 let log = self.log
@@ -144,7 +145,7 @@ extension RemoteLogger {
             }
         }
 
-        func send<T: Encodable>(code: UInt8, entity: T) {
+        public func send<T: Encodable>(code: UInt8, entity: T) {
             do {
                 let data = try JSONEncoder().encode(entity)
                 send(code: code, data: data)
@@ -206,7 +207,7 @@ extension RemoteLogger {
             }
         }
         
-        func cancel() {
+        public func cancel() {
             connection.cancel()
         }
     }
diff --git a/Sources/Pulse/RemoteLogger/RemoteLogger-Protocol.swift b/Sources/Pulse/RemoteLogger/RemoteLogger-Protocol.swift
@@ -8,7 +8,7 @@ import Network
 import Pulse
 #endif
 
-extension RemoteLogger {
+public extension RemoteLogger {
     enum PacketCode: UInt8, Equatable {
         // Handshake
         case clientHello = 0 // PacketClientHello
@@ -83,7 +83,7 @@ extension RemoteLogger {
             return data
         }
         
-        static func decode(_ data: Data) throws -> LoggerStore.Event.NetworkTaskCompleted {
+        public static func decode(_ data: Data) throws -> LoggerStore.Event.NetworkTaskCompleted {
             guard data.count >= Manifest.size else {
                 throw PacketParsingError.notEnoughData // Should never happen
             }
@@ -197,6 +197,10 @@ extension RemoteLogger {
 
     struct ServerHelloResponse: Codable {
         let version: String
+        
+        public init(version: String) {
+            self.version = version
+        }
     }
 }
 
diff --git a/Sources/Pulse/RemoteLogger/RemoteLogger.swift b/Sources/Pulse/RemoteLogger/RemoteLogger.swift
@@ -322,7 +322,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat
 
         openConnection(to: server, passcode: passcode)
     }
-
+    
     private func connectionDidTimeout(isProtected: Bool) {
         os_log("Connection did timeout", log: log)
         connectionCompletion?(.failure(self.connectionError ?? .unknown(isProtected: isProtected)))
@@ -341,7 +341,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat
     }
 
     private func saveServer(named name: String) {
-        os_log("Save server  %{private}@", log: log, name)
+        os_log("Save server %{private}@", log: log, name)
         knownServers.removeAll(where: { $0 == name })
         knownServers.append(name)
         saveKnownServers()
@@ -371,7 +371,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat
 
     // MARK: RemoteLoggerConnectionDelegate
 
-    func connection(_ connection: Connection, didChangeState newState: NWConnection.State) {
+    public func connection(_ connection: Connection, didChangeState newState: NWConnection.State) {
         os_log("Connection did change state to %{public}@", log: log, "\(newState)")
 
         switch newState {
@@ -390,7 +390,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat
         }
     }
 
-    func connection(_ connection: Connection, didReceiveEvent event: Connection.Event) {
+    public func connection(_ connection: Connection, didReceiveEvent event: Connection.Event) {
         switch event {
         case .packet(let packet):
             do {
@@ -730,5 +730,5 @@ extension RemoteLogger.ConnectionState {
 }
 
 extension RemoteLogger {
-    public static let serviceType = "_pulse._tcp"
+    public static var serviceType = "_pulse._tcp"
 }
diff --git a/Sources/PulseUI/Features/Console/ConsoleView-macos.swift b/Sources/PulseUI/Features/Console/ConsoleView-macos.swift
@@ -51,7 +51,7 @@ private struct ConsoleMainView: View {
 
     private var contentView: some View {
         ConsoleListView()
-            .frame(minWidth: 200, idealWidth: 400, minHeight: 120, idealHeight: 480)
+            .frame(minWidth: 400, idealWidth: 500, minHeight: 120, idealHeight: 480)
             .toolbar {
                 ToolbarItemGroup(placement: .navigation) {
                     contentToolbarNavigationItems
@@ -60,18 +60,21 @@ private struct ConsoleMainView: View {
                     Button(action: { isShowingFilters = true }) {
                         Label("Show Filters", systemImage: "line.3.horizontal.decrease.circle")
                     }
+                    .help("Show Filters")
                     .popover(isPresented: $isShowingFilters) {
                         ConsoleFiltersView().frame(width: 300).fixedSize()
                     }
                     Button(action: { isShowingSessions = true }) {
                         Label("Show Sessions", systemImage: "list.clipboard")
                     }
+                    .help("Show Sessions")
                     .popover(isPresented: $isShowingSessions) {
                         SessionsView().frame(width: 300, height: 420)
                     }
                     Button(action: { isShowingSettings = true }) {
                         Label("Show Settings", systemImage: "gearshape")
                     }
+                    .help("Show Settings")
                     .popover(isPresented: $isShowingSettings) {
                         SettingsView().frame(width: 300, height: 420)
                     }
@@ -88,17 +91,19 @@ private struct ConsoleMainView: View {
         if !(environment.store.options.contains(.readonly)) {
             Toggle(isOn: $isNowEnabled) {
                 Image(systemName: "clock")
-            }
+            }.help("Now Mode: Automatically scrolls to the top of the view to display newly incoming network requests.")
             Button(action: { isSharingStore = true }) {
                 Image(systemName: "square.and.arrow.up")
             }
+            .help("Share a session")
             .popover(isPresented: $isSharingStore, arrowEdge: .bottom) {
                 ShareStoreView(onDismiss: {})
                     .frame(width: 240).fixedSize()
             }
             Button(action: { environment.store.removeAll() }) {
                 Image(systemName: "trash")
             }
+            .help("Clear current session")
         }
     }
 }
diff --git a/Sources/PulseUI/Features/Console/ConsoleView.swift b/Sources/PulseUI/Features/Console/ConsoleView.swift
@@ -12,9 +12,9 @@ extension ConsoleView {
     ///
     /// - parameters:
     ///   - store: The store to display. By default, `LoggerStore/shared`.
-    ///   - mode: The console mode. By default, ``ConsoleMode/all``. If you change
-    ///   the mode to ``ConsoleMode/network``, the console will only display the
-    ///   network messages.
+    ///   - mode: The initial console mode. By default, ``ConsoleMode/all``. If you change
+    ///   the mode to ``ConsoleMode/network``, the console will display the
+    ///   network messages up on appearance.
     ///   - delegate: The delegate that allows you to customize multiple aspects
     ///   of the console view.
     public init(
diff --git a/Sources/PulseUI/Features/Console/List/ConsoleListView.swift b/Sources/PulseUI/Features/Console/List/ConsoleListView.swift
@@ -174,7 +174,7 @@ private struct _ConsoleListView: View {
                     } else {
                         ConsoleListContentView(proxy: proxy)
                     }
-                }
+                }.scrollContentBackground(.hidden)
             }
             .environment(\.defaultMinListRowHeight, 1)
         }

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ struct Pulse_Demo_macOSApp: App {`
`11`	`11`	`WindowGroup {`
`12`	`12`	`ConsoleView(store: .demo)`
`13`	`13`	`}`
`14`		`- .windowStyle(.hiddenTitleBar)`
`15`	`14`	`.windowToolbarStyle(.unified(showsTitle: false))`
`16`	`15`	`}`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -347,7 +347,7 @@ extension LoggerStore {`
`347`	`347`	`}`
`348`	`348`
`349`	`349`	`/// Handles event created by the current store and dispatches it to observers.`
`350`		`- func handle(_ event: Event) {`
	`350`	`+ public func handle(_ event: Event) {`
`351`	`351`	`guard let event = configuration.willHandleEvent(event) else {`
`352`	`352`	`return`
`353`	`353`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,12 +11,12 @@ import OSLog`
`11`	`11`	`import Pulse`
`12`	`12`	`#endif`
`13`	`13`
`14`		`-protocol RemoteLoggerConnectionDelegate: AnyObject {`
	`14`	`+public protocol RemoteLoggerConnectionDelegate: AnyObject {`
`15`	`15`	`func connection(_ connection: RemoteLogger.Connection, didChangeState newState: NWConnection.State)`
`16`	`16`	`func connection(_ connection: RemoteLogger.Connection, didReceiveEvent event: RemoteLogger.Connection.Event)`
`17`	`17`	`}`
`18`	`18`
`19`		`-extension RemoteLogger {`
	`19`	`+public extension RemoteLogger {`
`20`	`20`	`final class Connection {`
`21`	`21`	`var endpoint: NWEndpoint { connection.endpoint }`
`22`	`22`	`private let connection: NWConnection`
`@@ -31,14 +31,15 @@ extension RemoteLogger {`
`31`	`31`	`self.init(NWConnection(to: endpoint, using: parameters))`
`32`	`32`	`}`
`33`	`33`
`34`		`- init(_ connection: NWConnection) {`
	`34`	`+ public init(_ connection: NWConnection, delegate: RemoteLoggerConnectionDelegate? = nil) {`
`35`	`35`	`self.connection = connection`
	`36`	`+ self.delegate = delegate`
`36`	`37`
`37`	`38`	`let isLogEnabled = UserDefaults.standard.bool(forKey: "com.github.kean.pulse.debug")`
`38`	`39`	`self.log = isLogEnabled ? OSLog(subsystem: "com.github.kean.pulse", category: "RemoteLogger") : .disabled`
`39`	`40`	`}`
`40`		`-`
`41`		`- func start(on queue: DispatchQueue) {`
	`41`	`+`
	`42`	`+ public func start(on queue: DispatchQueue) {`
`42`	`43`	`connection.stateUpdateHandler = { [weak self] state in`
`43`	`44`	`guard let self = self else { return }`
`44`	`45`	`DispatchQueue.main.async {`
`@@ -49,15 +50,15 @@ extension RemoteLogger {`
`49`	`50`	`connection.start(queue: queue)`
`50`	`51`	`}`
`51`	`52`
`52`		`- enum Event {`
	`53`	`+ public enum Event {`
`53`	`54`	`case packet(Packet)`
`54`	`55`	`case error(Error)`
`55`	`56`	`case completed`
`56`	`57`	`}`
`57`	`58`
`58`		`- struct Packet {`
`59`		`- let code: UInt8`
`60`		`- let body: Data`
	`59`	`+ public struct Packet {`
	`60`	`+ public let code: UInt8`
	`61`	`+ public let body: Data`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`private func receive() {`
`@@ -130,7 +131,7 @@ extension RemoteLogger {`
`130`	`131`	`}`
`131`	`132`	`}`
`132`	`133`
`133`		`- func send(code: UInt8, data: Data) {`
	`134`	`+ public func send(code: UInt8, data: Data) {`
`134`	`135`	`do {`
`135`	`136`	`let data = try encode(code: code, body: data)`
`136`	`137`	`let log = self.log`
`@@ -144,7 +145,7 @@ extension RemoteLogger {`
`144`	`145`	`}`
`145`	`146`	`}`
`146`	`147`
`147`		`- func send<T: Encodable>(code: UInt8, entity: T) {`
	`148`	`+ public func send<T: Encodable>(code: UInt8, entity: T) {`
`148`	`149`	`do {`
`149`	`150`	`let data = try JSONEncoder().encode(entity)`
`150`	`151`	`send(code: code, data: data)`
`@@ -206,7 +207,7 @@ extension RemoteLogger {`
`206`	`207`	`}`
`207`	`208`	`}`
`208`	`209`
`209`		`- func cancel() {`
	`210`	`+ public func cancel() {`
`210`	`211`	`connection.cancel()`
`211`	`212`	`}`
`212`	`213`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import Network`
`8`	`8`	`import Pulse`
`9`	`9`	`#endif`
`10`	`10`
`11`		`-extension RemoteLogger {`
	`11`	`+public extension RemoteLogger {`
`12`	`12`	`enum PacketCode: UInt8, Equatable {`
`13`	`13`	`// Handshake`
`14`	`14`	`case clientHello = 0 // PacketClientHello`
`@@ -83,7 +83,7 @@ extension RemoteLogger {`
`83`	`83`	`return data`
`84`	`84`	`}`
`85`	`85`
`86`		`- static func decode(_ data: Data) throws -> LoggerStore.Event.NetworkTaskCompleted {`
	`86`	`+ public static func decode(_ data: Data) throws -> LoggerStore.Event.NetworkTaskCompleted {`
`87`	`87`	`guard data.count >= Manifest.size else {`
`88`	`88`	`throw PacketParsingError.notEnoughData // Should never happen`
`89`	`89`	`}`
`@@ -197,6 +197,10 @@ extension RemoteLogger {`
`197`	`197`
`198`	`198`	`struct ServerHelloResponse: Codable {`
`199`	`199`	`let version: String`
	`200`	`+`
	`201`	`+ public init(version: String) {`
	`202`	`+ self.version = version`
	`203`	`+ }`
`200`	`204`	`}`
`201`	`205`	`}`
`202`	`206`
Original file line number	Diff line number	Diff line change
`@@ -322,7 +322,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat`
`322`	`322`
`323`	`323`	`openConnection(to: server, passcode: passcode)`
`324`	`324`	`}`
`325`		`-`
	`325`	`+`
`326`	`326`	`private func connectionDidTimeout(isProtected: Bool) {`
`327`	`327`	`os_log("Connection did timeout", log: log)`
`328`	`328`	`connectionCompletion?(.failure(self.connectionError ?? .unknown(isProtected: isProtected)))`
`@@ -341,7 +341,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat`
`341`	`341`	`}`
`342`	`342`
`343`	`343`	`private func saveServer(named name: String) {`
`344`		`- os_log("Save server %{private}@", log: log, name)`
	`344`	`+ os_log("Save server %{private}@", log: log, name)`
`345`	`345`	`knownServers.removeAll(where: { $0 == name })`
`346`	`346`	`knownServers.append(name)`
`347`	`347`	`saveKnownServers()`
`@@ -371,7 +371,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat`
`371`	`371`
`372`	`372`	`// MARK: RemoteLoggerConnectionDelegate`
`373`	`373`
`374`		`- func connection(_ connection: Connection, didChangeState newState: NWConnection.State) {`
	`374`	`+ public func connection(_ connection: Connection, didChangeState newState: NWConnection.State) {`
`375`	`375`	`os_log("Connection did change state to %{public}@", log: log, "\(newState)")`
`376`	`376`
`377`	`377`	`switch newState {`
`@@ -390,7 +390,7 @@ public final class RemoteLogger: ObservableObject, RemoteLoggerConnectionDelegat`
`390`	`390`	`}`
`391`	`391`	`}`
`392`	`392`
`393`		`- func connection(_ connection: Connection, didReceiveEvent event: Connection.Event) {`
	`393`	`+ public func connection(_ connection: Connection, didReceiveEvent event: Connection.Event) {`
`394`	`394`	`switch event {`
`395`	`395`	`case .packet(let packet):`
`396`	`396`	`do {`
`@@ -730,5 +730,5 @@ extension RemoteLogger.ConnectionState {`
`730`	`730`	`}`
`731`	`731`
`732`	`732`	`extension RemoteLogger {`
`733`		`- public static let serviceType = "_pulse._tcp"`
	`733`	`+ public static var serviceType = "_pulse._tcp"`
`734`	`734`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ private struct ConsoleMainView: View {`
`51`	`51`
`52`	`52`	`private var contentView: some View {`
`53`	`53`	`ConsoleListView()`
`54`		`- .frame(minWidth: 200, idealWidth: 400, minHeight: 120, idealHeight: 480)`
	`54`	`+ .frame(minWidth: 400, idealWidth: 500, minHeight: 120, idealHeight: 480)`
`55`	`55`	`.toolbar {`
`56`	`56`	`ToolbarItemGroup(placement: .navigation) {`
`57`	`57`	`contentToolbarNavigationItems`
`@@ -60,18 +60,21 @@ private struct ConsoleMainView: View {`
`60`	`60`	`Button(action: { isShowingFilters = true }) {`
`61`	`61`	`Label("Show Filters", systemImage: "line.3.horizontal.decrease.circle")`
`62`	`62`	`}`
	`63`	`+ .help("Show Filters")`
`63`	`64`	`.popover(isPresented: $isShowingFilters) {`
`64`	`65`	`ConsoleFiltersView().frame(width: 300).fixedSize()`
`65`	`66`	`}`
`66`	`67`	`Button(action: { isShowingSessions = true }) {`
`67`	`68`	`Label("Show Sessions", systemImage: "list.clipboard")`
`68`	`69`	`}`
	`70`	`+ .help("Show Sessions")`
`69`	`71`	`.popover(isPresented: $isShowingSessions) {`
`70`	`72`	`SessionsView().frame(width: 300, height: 420)`
`71`	`73`	`}`
`72`	`74`	`Button(action: { isShowingSettings = true }) {`
`73`	`75`	`Label("Show Settings", systemImage: "gearshape")`
`74`	`76`	`}`
	`77`	`+ .help("Show Settings")`
`75`	`78`	`.popover(isPresented: $isShowingSettings) {`
`76`	`79`	`SettingsView().frame(width: 300, height: 420)`
`77`	`80`	`}`
`@@ -88,17 +91,19 @@ private struct ConsoleMainView: View {`
`88`	`91`	`if !(environment.store.options.contains(.readonly)) {`
`89`	`92`	`Toggle(isOn: $isNowEnabled) {`
`90`	`93`	`Image(systemName: "clock")`
`91`		`- }`
	`94`	`+ }.help("Now Mode: Automatically scrolls to the top of the view to display newly incoming network requests.")`
`92`	`95`	`Button(action: { isSharingStore = true }) {`
`93`	`96`	`Image(systemName: "square.and.arrow.up")`
`94`	`97`	`}`
	`98`	`+ .help("Share a session")`
`95`	`99`	`.popover(isPresented: $isSharingStore, arrowEdge: .bottom) {`
`96`	`100`	`ShareStoreView(onDismiss: {})`
`97`	`101`	`.frame(width: 240).fixedSize()`
`98`	`102`	`}`
`99`	`103`	`Button(action: { environment.store.removeAll() }) {`
`100`	`104`	`Image(systemName: "trash")`
`101`	`105`	`}`
	`106`	`+ .help("Clear current session")`
`102`	`107`	`}`
`103`	`108`	`}`
`104`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -174,7 +174,7 @@ private struct _ConsoleListView: View {`
`174`	`174`	`} else {`
`175`	`175`	`ConsoleListContentView(proxy: proxy)`
`176`	`176`	`}`
`177`		`- }`
	`177`	`+ }.scrollContentBackground(.hidden)`
`178`	`178`	`}`
`179`	`179`	`.environment(\.defaultMinListRowHeight, 1)`
`180`	`180`	`}`