feat: add progress messages when creating sync sessions

Coder-Desktop/Coder-Desktop/Preview Content/PreviewFileSync.swift

@@ -20,7 +20,12 @@ final class PreviewFileSync: FileSyncDaemon {
         state = .stopped
     }
 
-    func createSession(arg _: CreateSyncSessionRequest) async throws(DaemonError) {}
+    func createSession(
+        arg _: CreateSyncSessionRequest,
+        promptCallback _: (
+            @MainActor (String) -> Void
+        )?
+    ) async throws(DaemonError) {}
 
     func deleteSessions(ids _: [String]) async throws(VPNLib.DaemonError) {}
 

Coder-Desktop/Coder-Desktop/Preview Content/PreviewVPN.swift

@@ -6,25 +6,25 @@ final class PreviewVPN: Coder_Desktop.VPNService {
     @Published var state: Coder_Desktop.VPNServiceState = .connected
     @Published var menuState: VPNMenuState = .init(agents: [
         UUID(): Agent(id: UUID(), name: "dev", status: .error, hosts: ["asdf.coder"], wsName: "dogfood2",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .okay, hosts: ["asdf.coder"],
-                      wsName: "testing-a-very-long-name", wsID: UUID()),
+                      wsName: "testing-a-very-long-name", wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .warn, hosts: ["asdf.coder"], wsName: "opensrc",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .off, hosts: ["asdf.coder"], wsName: "gvisor",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .off, hosts: ["asdf.coder"], wsName: "example",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .error, hosts: ["asdf.coder"], wsName: "dogfood2",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .okay, hosts: ["asdf.coder"],
-                      wsName: "testing-a-very-long-name", wsID: UUID()),
+                      wsName: "testing-a-very-long-name", wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .warn, hosts: ["asdf.coder"], wsName: "opensrc",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .off, hosts: ["asdf.coder"], wsName: "gvisor",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
         UUID(): Agent(id: UUID(), name: "dev", status: .off, hosts: ["asdf.coder"], wsName: "example",
-                      wsID: UUID()),
+                      wsID: UUID(), primaryHost: "asdf.coder"),
     ], workspaces: [:])
     let shouldFail: Bool
     let longError = "This is a long error to test the UI with long error messages"

Coder-Desktop/Coder-Desktop/VPN/MenuState.swift

@@ -18,8 +18,7 @@ struct Agent: Identifiable, Equatable, Comparable, Hashable {
         return lhs.wsName.localizedCompare(rhs.wsName) == .orderedAscending
     }
 
-    // Hosts arrive sorted by length, the shortest looks best in the UI.
-    var primaryHost: String? { hosts.first }
+    let primaryHost: String
 }
 
 enum AgentStatus: Int, Equatable, Comparable {
@@ -69,6 +68,9 @@ struct VPNMenuState {
             invalidAgents.append(agent)
             return
         }
+        // Remove trailing dot if present
+        let nonEmptyHosts = agent.fqdn.map { $0.hasSuffix(".") ? String($0.dropLast()) : $0 }
+
         // An existing agent with the same name, belonging to the same workspace
         // is from a previous workspace build, and should be removed.
         agents.filter { $0.value.name == agent.name && $0.value.wsID == wsID }
@@ -81,10 +83,11 @@ struct VPNMenuState {
             name: agent.name,
             // If last handshake was not within last five minutes, the agent is unhealthy
             status: agent.lastHandshake.date > Date.now.addingTimeInterval(-300) ? .okay : .warn,
-            // Remove trailing dot if present
-            hosts: agent.fqdn.map { $0.hasSuffix(".") ? String($0.dropLast()) : $0 },
+            hosts: nonEmptyHosts,
             wsName: workspace.name,
-            wsID: wsID
+            wsID: wsID,
+            // Hosts arrive sorted by length, the shortest looks best in the UI.
+            primaryHost: nonEmptyHosts.first!
         )
     }
 
@@ -135,9 +138,7 @@ struct VPNMenuState {
         return items.sorted()
     }
 
-    var onlineAgents: [Agent] {
-        agents.map(\.value).filter { $0.primaryHost != nil }
-    }
+    var onlineAgents: [Agent] { agents.map(\.value) }
 
     mutating func clear() {
         agents.removeAll()

Coder-Desktop/Coder-Desktop/Views/FileSync/FileSyncSessionModal.swift

@@ -15,6 +15,8 @@ struct FileSyncSessionModal<VPN: VPNService, FS: FileSyncDaemon>: View {
     @State private var createError: DaemonError?
     @State private var pickingRemote: Bool = false
 
+    @State private var lastPromptMessage: String?
+
     var body: some View {
         let agents = vpn.menuState.onlineAgents
         VStack(spacing: 0) {
@@ -40,7 +42,7 @@ struct FileSyncSessionModal<VPN: VPNService, FS: FileSyncDaemon>: View {
                 Section {
                     Picker("Workspace", selection: $remoteHostname) {
                         ForEach(agents, id: \.id) { agent in
-                            Text(agent.primaryHost!).tag(agent.primaryHost!)
+                            Text(agent.primaryHost).tag(agent.primaryHost)
                         }
                         // HACK: Silence error logs for no-selection.
                         Divider().tag(nil as String?)
@@ -62,6 +64,12 @@ struct FileSyncSessionModal<VPN: VPNService, FS: FileSyncDaemon>: View {
             Divider()
             HStack {
                 Spacer()
+                if let msg = lastPromptMessage {
+                    Text(msg).foregroundStyle(.secondary)
+                }
+                if loading {
+                    ProgressView().controlSize(.small)
+                }
                 Button("Cancel", action: { dismiss() }).keyboardShortcut(.cancelAction)
                 Button(existingSession == nil ? "Add" : "Save") { Task { await submit() }}
                     .keyboardShortcut(.defaultAction)
@@ -103,8 +111,10 @@ struct FileSyncSessionModal<VPN: VPNService, FS: FileSyncDaemon>: View {
                 arg: .init(
                     alpha: .init(path: localPath, protocolKind: .local),
                     beta: .init(path: remotePath, protocolKind: .ssh(host: remoteHostname))
-                )
+                ),
+                promptCallback: { lastPromptMessage = $0 }
             )
+            lastPromptMessage = nil
         } catch {
             createError = error
             return

Coder-Desktop/Coder-Desktop/Views/VPN/VPNMenuItem.swift

@@ -66,7 +66,7 @@ struct MenuItemView: View {
 
     private var itemName: AttributedString {
         let name = switch item {
-        case let .agent(agent): agent.primaryHost ?? "\(item.wsName).\(state.hostnameSuffix)"
+        case let .agent(agent): agent.primaryHost
         case .offlineWorkspace: "\(item.wsName).\(state.hostnameSuffix)"
         }
 
@@ -103,10 +103,10 @@ struct MenuItemView: View {
                         }
                     Spacer()
                 }.buttonStyle(.plain)
-                if case let .agent(agent) = item, let copyableDNS = agent.primaryHost {
+                if case let .agent(agent) = item {
                     Button {
                         NSPasteboard.general.clearContents()
-                        NSPasteboard.general.setString(copyableDNS, forType: .string)
+                        NSPasteboard.general.setString(agent.primaryHost, forType: .string)
                     } label: {
                         Image(systemName: "doc.on.doc")
                             .symbolVariant(.fill)
@@ -143,7 +143,6 @@ struct MenuItemView: View {
         // If this menu item is an agent, and the user is logged in
         if case let .agent(agent) = item,
            let client = state.client,
-           let host = agent.primaryHost,
            let baseAccessURL = state.baseAccessURL,
            // Like the CLI, we'll re-use the existing session token to populate the URL
            let sessionToken = state.sessionToken
@@ -166,7 +165,7 @@ struct MenuItemView: View {
                 .flatMap(\.self)
                 .first(where: { $0.id == agent.id })
             {
-                apps = agentToApps(logger, wsAgent, host, baseAccessURL, sessionToken)
+                apps = agentToApps(logger, wsAgent, agent.primaryHost, baseAccessURL, sessionToken)
             } else {
                 logger.error("Could not find agent '\(agent.id)' in workspace '\(item.wsName)' resources")
             }

Coder-Desktop/Coder-DesktopTests/AgentsTests.swift

@@ -27,7 +27,8 @@ struct AgentsTests {
                 status: status,
                 hosts: ["a\($0).coder"],
                 wsName: "ws\($0)",
-                wsID: UUID()
+                wsID: UUID(),
+                primaryHost: "a\($0).coder"
             )
             return (agent.id, agent)
         })

Coder-Desktop/Coder-DesktopTests/FileSyncDaemonTests.swift

@@ -61,6 +61,7 @@ class FileSyncDaemonTests {
         #expect(statesEqual(daemon.state, .stopped))
         #expect(daemon.sessionState.count == 0)
 
+        var promptMessages: [String] = []
         try await daemon.createSession(
             arg: .init(
                 alpha: .init(
@@ -71,9 +72,16 @@ class FileSyncDaemonTests {
                     path: mutagenBetaDirectory.path(),
                     protocolKind: .local
                 )
-            )
+            ),
+            promptCallback: {
+                promptMessages.append($0)
+            }
         )
 
+        // There should be at least one prompt message
+        // Usually "Creating session..."
+        #expect(promptMessages.count > 0)
+
         // Daemon should have started itself
         #expect(statesEqual(daemon.state, .running))
         #expect(daemon.sessionState.count == 1)

Coder-Desktop/Coder-DesktopTests/Util.swift

@@ -31,6 +31,8 @@ class MockVPNService: VPNService, ObservableObject {
 class MockFileSyncDaemon: FileSyncDaemon {
     var logFile: URL = .init(filePath: "~/log.txt")
 
+    var lastPromptMessage: String?
+
     var sessionState: [VPNLib.FileSyncSession] = []
 
     func refreshSessions() async {}
@@ -47,7 +49,10 @@ class MockFileSyncDaemon: FileSyncDaemon {
         []
     }
 
-    func createSession(arg _: CreateSyncSessionRequest) async throws(DaemonError) {}
+    func createSession(
+        arg _: CreateSyncSessionRequest,
+        promptCallback _: (@MainActor (String) -> Void)?
+    ) async throws(DaemonError) {}
 
     func pauseSessions(ids _: [String]) async throws(VPNLib.DaemonError) {}
 

Coder-Desktop/VPNLib/FileSync/FileSyncDaemon.swift

@@ -14,7 +14,10 @@ public protocol FileSyncDaemon: ObservableObject {
     func tryStart() async
     func stop() async
     func refreshSessions() async
-    func createSession(arg: CreateSyncSessionRequest) async throws(DaemonError)
+    func createSession(
+        arg: CreateSyncSessionRequest,
+        promptCallback: (@MainActor (String) -> Void)?
+    ) async throws(DaemonError)
     func deleteSessions(ids: [String]) async throws(DaemonError)
     func pauseSessions(ids: [String]) async throws(DaemonError)
     func resumeSessions(ids: [String]) async throws(DaemonError)

Coder-Desktop/VPNLib/FileSync/FileSyncManagement.swift

@@ -17,7 +17,10 @@ public extension MutagenDaemon {
         sessionState = sessions.sessionStates.map { FileSyncSession(state: $0) }
     }
 
-    func createSession(arg: CreateSyncSessionRequest) async throws(DaemonError) {
+    func createSession(
+        arg: CreateSyncSessionRequest,
+        promptCallback: (@MainActor (String) -> Void)? = nil
+    ) async throws(DaemonError) {
         if case .stopped = state {
             do throws(DaemonError) {
                 try await start()
@@ -26,7 +29,7 @@ public extension MutagenDaemon {
                 throw error
             }
         }
-        let (stream, promptID) = try await host()
+        let (stream, promptID) = try await host(promptCallback: promptCallback)
         defer { stream.cancel() }
         let req = Synchronization_CreateRequest.with { req in
             req.prompter = promptID

Coder-Desktop/VPNLib/FileSync/FileSyncPrompting.swift

@@ -3,7 +3,10 @@ import GRPC
 extension MutagenDaemon {
     typealias PromptStream = GRPCAsyncBidirectionalStreamingCall<Prompting_HostRequest, Prompting_HostResponse>
 
-    func host(allowPrompts: Bool = true) async throws(DaemonError) -> (PromptStream, identifier: String) {
+    func host(
+        allowPrompts: Bool = true,
+        promptCallback: (@MainActor (String) -> Void)? = nil
+    ) async throws(DaemonError) -> (PromptStream, identifier: String) {
         let stream = client!.prompt.makeHostCall()
 
         do {
@@ -39,6 +42,8 @@ extension MutagenDaemon {
                         }
                         // Any other messages that require a non-empty response will
                         // cause the create op to fail, showing an error. This is ok for now.
+                    } else {
+                        Task { @MainActor in promptCallback?(msg.message) }
                     }
                     try await stream.requestStream.send(reply)
                 }