feat: use the deployment's hostname suffix in the UI

Author: ethanndickson

Coder-Desktop/Coder-Desktop/Coder_DesktopApp.swift

@@ -65,10 +65,12 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             title: "Coder Desktop",
             image: "MenuBarIcon",
             onAppear: {
-                // If the VPN is enabled, it's likely the token isn't expired
+                // If the VPN is enabled, it's likely the token hasn't expired,
+                // and the deployment config is up to date.
                 guard case .disabled = self.vpn.state, self.state.hasSession else { return }
                 Task { @MainActor in
                     await self.state.handleTokenExpiry()
+                    await self.state.refreshDeploymentConfig()
                 }
             }, content: {
                 VPNMenu<CoderVPNService, MutagenDaemon>().frame(width: 256)

Coder-Desktop/Coder-Desktop/State.swift

@@ -25,6 +25,15 @@ class AppState: ObservableObject {
         }
     }
 
+    @Published private(set) var hostnameSuffix: String {
+        didSet {
+            guard persistent else { return }
+            UserDefaults.standard.set(hostnameSuffix, forKey: Keys.hostnameSuffix)
+        }
+    }
+
+    static let defaultHostnameSuffix: String = "coder"
+
     // Stored in Keychain
     @Published private(set) var sessionToken: String? {
         didSet {
@@ -33,6 +42,8 @@ class AppState: ObservableObject {
         }
     }
 
+    var client: Client?
+
     @Published var useLiteralHeaders: Bool = UserDefaults.standard.bool(forKey: Keys.useLiteralHeaders) {
         didSet {
             reconfigure()
@@ -80,7 +91,7 @@ class AppState: ObservableObject {
     private let keychain: Keychain
     private let persistent: Bool
 
-    let onChange: ((NETunnelProviderProtocol?) -> Void)?
+    private let onChange: ((NETunnelProviderProtocol?) -> Void)?
 
     // reconfigure must be called when any property used to configure the VPN changes
     public func reconfigure() {
@@ -94,6 +105,10 @@ class AppState: ObservableObject {
         self.onChange = onChange
         keychain = Keychain(service: Bundle.main.bundleIdentifier!)
         _hasSession = Published(initialValue: persistent ? UserDefaults.standard.bool(forKey: Keys.hasSession) : false)
+        _hostnameSuffix = Published(
+            initialValue: persistent ? UserDefaults.standard
+                .string(forKey: Keys.hostnameSuffix) ?? Self.defaultHostnameSuffix : Self.defaultHostnameSuffix
+        )
         _baseAccessURL = Published(
             initialValue: persistent ? UserDefaults.standard.url(forKey: Keys.baseAccessURL) : nil
         )
@@ -107,21 +122,30 @@ class AppState: ObservableObject {
             if sessionToken == nil || sessionToken!.isEmpty == true {
                 clearSession()
             }
+            client = Client(
+                url: baseAccessURL!,
+                token: sessionToken!,
+                headers: useLiteralHeaders ? literalHeaders.map { $0.toSDKHeader() } : []
+            )
         }
     }
 
     public func login(baseAccessURL: URL, sessionToken: String) {
         hasSession = true
         self.baseAccessURL = baseAccessURL
         self.sessionToken = sessionToken
+        client = Client(
+            url: baseAccessURL,
+            token: sessionToken,
+            headers: useLiteralHeaders ? literalHeaders.map { $0.toSDKHeader() } : []
+        )
         reconfigure()
     }
 
     public func handleTokenExpiry() async {
         if hasSession {
-            let client = Client(url: baseAccessURL!, token: sessionToken!)
             do {
-                _ = try await client.user("me")
+                _ = try await client!.user("me")
             } catch let SDKError.api(apiErr) {
                 // Expired token
                 if apiErr.statusCode == 401 {
@@ -135,9 +159,24 @@ class AppState: ObservableObject {
         }
     }
 
+    public func refreshDeploymentConfig() async {
+        if hasSession {
+            do {
+                let config = try await client!.sshConfiguration()
+                hostnameSuffix = config.hostname_suffix ?? Self.defaultHostnameSuffix
+            } catch {
+                // If fetching the config fails, there's likely a bigger issue.
+                // We'll show an error in the UI if they try and do something
+                logger.error("failed to refresh deployment config: \(error)")
+                return
+            }
+        }
+    }
+
     public func clearSession() {
         hasSession = false
         sessionToken = nil
+        client = nil
         reconfigure()
     }
 
@@ -159,6 +198,7 @@ class AppState: ObservableObject {
         static let hasSession = "hasSession"
         static let baseAccessURL = "baseAccessURL"
         static let sessionToken = "sessionToken"
+        static let hostnameSuffix = "hostnameSuffix"
 
         static let useLiteralHeaders = "UseLiteralHeaders"
         static let literalHeaders = "LiteralHeaders"

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

@@ -42,21 +42,24 @@ enum VPNMenuItem: Equatable, Comparable, Identifiable {
 }
 
 struct MenuItemView: View {
+    @EnvironmentObject var state: AppState
+
     let item: VPNMenuItem
     let baseAccessURL: URL
     @State private var nameIsSelected: Bool = false
     @State private var copyIsSelected: Bool = false
 
     private var itemName: AttributedString {
         let name = switch item {
-        case let .agent(agent): agent.primaryHost ?? "\(item.wsName).coder"
-        case .offlineWorkspace: "\(item.wsName).coder"
+        case let .agent(agent): agent.primaryHost ?? "\(item.wsName).\(state.hostnameSuffix)"
+        case .offlineWorkspace: "\(item.wsName).\(state.hostnameSuffix)"
         }
 
         var formattedName = AttributedString(name)
         formattedName.foregroundColor = .primary
-        if let range = formattedName.range(of: ".coder") {
-            formattedName[range].foregroundColor = .secondary
+
+        if let lastDot = formattedName.range(of: ".", options: .backwards) {
+            formattedName[lastDot.lowerBound ..< formattedName.endIndex].foregroundColor = .secondary
         }
         return formattedName
     }

Coder-Desktop/CoderSDK/Deployment.swift

@@ -8,6 +8,14 @@ public extension Client {
         }
         return try decode(BuildInfoResponse.self, from: res.data)
     }
+
+    func sshConfiguration() async throws(SDKError) -> SSHConfigResponse {
+        let res = try await request("/api/v2/deployment/ssh", method: .get)
+        guard res.resp.statusCode == 200 else {
+            throw responseAsError(res)
+        }
+        return try decode(SSHConfigResponse.self, from: res.data)
+    }
 }
 
 public struct BuildInfoResponse: Codable, Equatable, Sendable {
@@ -20,3 +28,9 @@ public struct BuildInfoResponse: Codable, Equatable, Sendable {
             .flatMap { Range($0.range(at: 1), in: version).map { String(version[$0]) } }
     }
 }
+
+public struct SSHConfigResponse: Codable, Equatable, Sendable {
+    public let hostname_prefix: String?
+    public let hostname_suffix: String?
+    public let ssh_config_options: [String: String]
+}