feat: add coder connect startup progress messages

Author: ethanndickson

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

@@ -33,6 +33,8 @@ final class PreviewVPN: Coder_Desktop.VPNService {
         self.shouldFail = shouldFail
     }
 
+    @Published var progressMessage: String?
+
     var startTask: Task<Void, Never>?
     func start() async {
         if await startTask?.value != nil {

Coder-Desktop/Coder-Desktop/VPN/VPNService.swift

@@ -7,6 +7,7 @@ import VPNLib
 protocol VPNService: ObservableObject {
     var state: VPNServiceState { get }
     var menuState: VPNMenuState { get }
+    var progressMessage: String? { get }
     func start() async
     func stop() async
     func configureTunnelProviderProtocol(proto: NETunnelProviderProtocol?)
@@ -72,6 +73,8 @@ final class CoderVPNService: NSObject, VPNService {
         return tunnelState
     }
 
+    @Published var progressMessage: String?
+
     @Published var menuState: VPNMenuState = .init()
 
     // Whether the VPN should start as soon as possible
@@ -155,6 +158,10 @@ final class CoderVPNService: NSObject, VPNService {
         }
     }
 
+    func onProgress(_ msg: String?) {
+        progressMessage = msg
+    }
+
     func applyPeerUpdate(with update: Vpn_PeerUpdate) {
         // Delete agents
         update.deletedAgents.forEach { menuState.deleteAgent(withId: $0.id) }

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

@@ -6,6 +6,14 @@ struct VPNState<VPN: VPNService>: View {
 
     let inspection = Inspection<Self>()
 
+    var progressMessage: String {
+        if let msg = vpn.progressMessage {
+            msg
+        } else {
+            vpn.state == .connecting ? "Starting Coder Connect..." : "Stopping Coder Connect..."
+        }
+    }
+
     var body: some View {
         Group {
             switch (vpn.state, state.hasSession) {
@@ -24,9 +32,11 @@ struct VPNState<VPN: VPNService>: View {
             case (.connecting, _), (.disconnecting, _):
                 HStack {
                     Spacer()
-                    ProgressView(
-                        vpn.state == .connecting ? "Starting Coder Connect..." : "Stopping Coder Connect..."
-                    ).padding()
+                    ProgressView {
+                        Text(progressMessage)
+                            .multilineTextAlignment(.center)
+                    }
+                    .padding()
                     Spacer()
                 }
             case let (.failed(vpnErr), _):

Coder-Desktop/Coder-Desktop/XPCInterface.swift

@@ -71,6 +71,12 @@ import VPNLib
         }
     }
 
+    func onProgress(msg: String?) {
+        Task { @MainActor in
+            svc.onProgress(msg)
+        }
+    }
+
     // The NE has verified the dylib and knows better than Gatekeeper
     func removeQuarantine(path: String, reply: @escaping (Bool) -> Void) {
         let reply = CallbackWrapper(reply)

Coder-Desktop/Coder-DesktopTests/Util.swift

@@ -10,6 +10,7 @@ class MockVPNService: VPNService, ObservableObject {
     @Published var state: Coder_Desktop.VPNServiceState = .disabled
     @Published var baseAccessURL: URL = .init(string: "https://dev.coder.com")!
     @Published var menuState: VPNMenuState = .init()
+    @Published var progressMessage: String?
     var onStart: (() async -> Void)?
     var onStop: (() async -> Void)?
 

Coder-Desktop/VPN/Manager.swift

@@ -39,6 +39,7 @@ actor Manager {
         } catch {
             throw .download(error)
         }
+        pushProgress(msg: "Fetching server version...")
         let client = Client(url: cfg.serverUrl)
         let buildInfo: BuildInfoResponse
         do {
@@ -49,6 +50,7 @@ actor Manager {
         guard let semver = buildInfo.semver else {
             throw .serverInfo("invalid version: \(buildInfo.version)")
         }
+        pushProgress(msg: "Validating library...")
         do {
             try SignatureValidator.validate(path: dest, expectedVersion: semver)
         } catch {
@@ -59,11 +61,13 @@ actor Manager {
         // so it's safe to execute. However, the SE must be sandboxed, so we defer to the app.
         try await removeQuarantine(dest)
 
+        pushProgress(msg: "Opening library...")
         do {
             try tunnelHandle = TunnelHandle(dylibPath: dest)
         } catch {
             throw .tunnelSetup(error)
         }
+        pushProgress(msg: "Setting up tunnel...")
         speaker = await Speaker<Vpn_ManagerMessage, Vpn_TunnelMessage>(
             writeFD: tunnelHandle.writeHandle,
             readFD: tunnelHandle.readHandle
@@ -158,6 +162,7 @@ actor Manager {
     }
 
     func startVPN() async throws(ManagerError) {
+        pushProgress(msg: nil)
         logger.info("sending start rpc")
         guard let tunFd = ptp.tunnelFileDescriptor else {
             logger.error("no fd")
@@ -234,6 +239,15 @@ actor Manager {
     }
 }
 
+func pushProgress(msg: String?) {
+    guard let conn = globalXPCListenerDelegate.conn else {
+        logger.error("couldn't send progress message to app: no connection")
+        return
+    }
+    logger.info("sending progress message to app: \(msg ?? "nil")")
+    conn.onProgress(msg: msg)
+}
+
 struct ManagerConfig {
     let apiToken: String
     let serverUrl: URL
@@ -312,6 +326,7 @@ private func removeQuarantine(_ dest: URL) async throws(ManagerError) {
     let file = NSURL(fileURLWithPath: dest.path)
     try? file.getResourceValue(&flag, forKey: kCFURLQuarantinePropertiesKey as URLResourceKey)
     if flag != nil {
+        pushProgress(msg: "Unquarantining download...")
         // Try the privileged helper first (it may not even be registered)
         if await globalHelperXPCSpeaker.tryRemoveQuarantine(path: dest.path) {
             // Success!

Coder-Desktop/VPN/PacketTunnelProvider.swift

@@ -92,6 +92,8 @@ class PacketTunnelProvider: NEPacketTunnelProvider, @unchecked Sendable {
                 logger.info("vpn started")
                 self.manager = manager
                 completionHandler(nil)
+                // Clear progress message
+                pushProgress(msg: nil)
             } catch {
                 logger.error("error starting manager: \(error.description, privacy: .public)")
                 completionHandler(

Coder-Desktop/VPNLib/XPC.swift

@@ -10,5 +10,6 @@ import Foundation
 @objc public protocol VPNXPCClientCallbackProtocol {
     // data is a serialized `Vpn_PeerUpdate`
     func onPeerUpdate(_ data: Data)
+    func onProgress(msg: String?)
     func removeQuarantine(path: String, reply: @escaping (Bool) -> Void)
 }