chore: improve vpn configuration errors (#208)

ethanndickson · web-flow · commit ab44e4ab7bb6 · 2025-08-06T12:36:35.000+10:00
Some flakey OS operation has been reported by two different users after installation: <img width="215" height="415" alt="image" src="https://github.com/user-attachments/assets/e632071d-02a3-45d3-bbef-f1bce9139974" /> <img width="247" height="191" alt="image" src="https://github.com/user-attachments/assets/dcd4b39b-5be4-4630-a4c8-dc45fe06bb77" /> I don't know what's happening because the error handling here isn't very good. This PR fixes that by always including the operation that failed in the UI message.
diff --git a/Coder-Desktop/Coder-Desktop/VPN/NetworkExtension.swift b/Coder-Desktop/Coder-Desktop/VPN/NetworkExtension.swift
@@ -16,7 +16,7 @@ enum NetworkExtensionState: Equatable{
 case .disabled:
 "NetworkExtension tunnel disabled"
 case let .failed(error):
- "NetworkExtension config failed: \(error)"
+ "NetworkExtension: \(error)"
 }
 }
 }
@@ -44,7 +44,7 @@ extension CoderVPNService{
 try await removeNetworkExtension()
 } catch{
 logger.error("remove tunnel failed: \(error)")
- neState = .failed(error.localizedDescription)
+ neState = .failed("Failed to remove configuration: \(error.description)")
 return
 }
 logger.debug("inserting new tunnel")
@@ -60,7 +60,9 @@ extension CoderVPNService{
 } catch{
 // This typically fails when the user declines the permission dialog
 logger.error("save tunnel failed: \(error)")
- neState = .failed("Failed to save tunnel: \(error.localizedDescription). Try logging in and out again.")
+ neState = .failed(
+ "Failed to save configuration: \(error.localizedDescription). Try logging in and out again."
+ )
 }
 }
 
@@ -71,17 +73,24 @@ extension CoderVPNService{
 try await tunnel.removeFromPreferences()
 }
 } catch{
- throw .internalError("couldn't remove tunnels: \(error)")
+ throw .internalError(error.localizedDescription)
 }
 }
 
 func startTunnel() async{
+ let tm: NETunnelProviderManager
+ do{
+ tm = try await getTunnelManager()
+ } catch{
+ logger.error("get tunnel: \(error)")
+ neState = .failed("Failed to get VPN configuration: \(error.description)")
+ return
+ }
 do{
- let tm = try await getTunnelManager()
 try tm.connection.startVPNTunnel()
 } catch{
 logger.error("start tunnel: \(error)")
- neState = .failed(error.localizedDescription)
+ neState = .failed("Failed to start VPN tunnel: \(error.localizedDescription)")
 return
 }
 logger.debug("started tunnel")
@@ -94,7 +103,7 @@ extension CoderVPNService{
 tm.connection.stopVPNTunnel()
 } catch{
 logger.error("stop tunnel: \(error)")
- neState = .failed(error.localizedDescription)
+ neState = .failed("Failed to stop VPN tunnel: \(error.localizedDescription)")
 return
 }
 logger.debug("stopped tunnel")
diff --git a/Coder-Desktop/Coder-Desktop/VPN/VPNService.swift b/Coder-Desktop/Coder-Desktop/VPN/VPNService.swift
@@ -37,7 +37,7 @@ enum VPNServiceError: Error, Equatable{
 case systemExtensionError(SystemExtensionState)
 case networkExtensionError(NetworkExtensionState)
 
- var description: String{
+ public var description: String{
 switch self{
 case let .internalError(description):
 "Internal Error: \(description)"
@@ -48,7 +48,7 @@ enum VPNServiceError: Error, Equatable{
 }
 }
 
- var localizedDescription: String{description }
+ public var localizedDescription: String{description }
 }
 
 @MainActor
@@ -126,13 +126,13 @@ final class CoderVPNService: NSObject, VPNService{
 // this just configures the VPN, it doesn't enable it
 tunnelState = .disabled
 } else{
- do{
+ do throws(VPNServiceError){
 try await removeNetworkExtension()
 neState = .unconfigured
 tunnelState = .disabled
 } catch{
- logger.error("failed to remove network extension: \(error)")
- neState = .failed(error.localizedDescription)
+ logger.error("failed to remove configuration: \(error)")
+ neState = .failed("Failed to remove configuration: \(error.description)")
 }
 }
 }
diff --git a/Coder-Desktop/project.yml b/Coder-Desktop/project.yml
@@ -98,7 +98,7 @@ packages:
 # - Set onAppear/disappear handlers.
 # The upstream repo has a purposefully limited API
 url: https://github.com/coder/fluid-menu-bar-extra
- revision: 8e1d8b8
+ revision: b0d5438
 KeychainAccess:
 url: https://github.com/kishikawakatsumi/KeychainAccess
 branch: e0c7eebc5a4465a3c4680764f26b7a61f567cdaf

-Original file line number
+Diff line change
 case.disabled:
 "NetworkExtension tunnel disabled"
 caselet.failed(error):
 -"NetworkExtension config failed: \(error)"
 +"NetworkExtension: \(error)"
+}
+}
+}
 tryawaitremoveNetworkExtension()
 }catch{
  logger.error("remove tunnel failed: \(error)")
 - neState =.failed(error.localizedDescription)
 + neState =.failed("Failed to remove configuration: \(error.description)")
 return
+}
  logger.debug("inserting new tunnel")
 }catch{
  // This typically fails when the user declines the permission dialog
  logger.error("save tunnel failed: \(error)")
 - neState =.failed("Failed to save tunnel: \(error.localizedDescription). Try logging in and out again.")
 + neState =.failed(
 +"Failed to save configuration: \(error.localizedDescription). Try logging in and out again."
 +)
+}
+}
 tryawait tunnel.removeFromPreferences()
+}
 }catch{
 -throw.internalError("couldn't remove tunnels: \(error)")
 +throw.internalError(error.localizedDescription)
+}
+}
 func startTunnel()async{
 +lettm:NETunnelProviderManager
 +do{
 + tm =tryawaitgetTunnelManager()
 +}catch{
 + logger.error("get tunnel: \(error)")
 + neState =.failed("Failed to get VPN configuration: \(error.description)")
 +return
 +}
 do{
 -lettm=tryawaitgetTunnelManager()
 try tm.connection.startVPNTunnel()
 }catch{
  logger.error("start tunnel: \(error)")
 - neState =.failed(error.localizedDescription)
 + neState =.failed("Failed to start VPN tunnel: \(error.localizedDescription)")
 return
+}
  logger.debug("started tunnel")
  tm.connection.stopVPNTunnel()
 }catch{
  logger.error("stop tunnel: \(error)")
 - neState =.failed(error.localizedDescription)
 + neState =.failed("Failed to stop VPN tunnel: \(error.localizedDescription)")
 return
+}
  logger.debug("stopped tunnel")
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ enum VPNServiceError: Error, Equatable{`
`37`	`37`	`case systemExtensionError(SystemExtensionState)`
`38`	`38`	`case networkExtensionError(NetworkExtensionState)`
`39`	`39`
`40`		`-vardescription:String{`
	`40`	`+publicvardescription:String{`
`41`	`41`	`switchself{`
`42`	`42`	`caselet.internalError(description):`
`43`	`43`	`"Internal Error: \(description)"`
`@@ -48,7 +48,7 @@ enum VPNServiceError: Error, Equatable{`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
`51`		`-varlocalizedDescription:String{ description }`
	`51`	`+publicvarlocalizedDescription:String{ description }`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`@MainActor`
`@@ -126,13 +126,13 @@ final class CoderVPNService: NSObject, VPNService{`
`126`	`126`	`// this just configures the VPN, it doesn't enable it`
`127`	`127`	`tunnelState =.disabled`
`128`	`128`	`}else{`
`129`		`-do{`
	`129`	`+dothrows(VPNServiceError){`
`130`	`130`	`tryawaitremoveNetworkExtension()`
`131`	`131`	`neState =.unconfigured`
`132`	`132`	`tunnelState =.disabled`
`133`	`133`	`} catch {`
`134`		`- logger.error("failed to remove network extension: \(error)")`
`135`		`- neState =.failed(error.localizedDescription)`
	`134`	`+ logger.error("failed to remove configuration: \(error)")`
	`135`	`+ neState =.failed("Failed to remove configuration: \(error.description)")`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`	`}`