Randomize provider server (#263)

* Pick random server within location

* Add toggle to provider section in profile

Passepartout/App/Mac/Models/DefaultLightProfileManager.swift

@@ -77,7 +77,7 @@ class DefaultLightProfileManager: LightProfileManager {
                 $0.header < $1.header
             }.map {
                 let server: ProviderServer?
-                if let serverId = $0.providerServerId() {
+                if let serverId = $0.providerServerId {
                     server = providerManager.server(withId: serverId)
                 } else {
                     server = nil

Passepartout/App/Views/EndpointView+OpenVPN.swift

@@ -92,13 +92,13 @@ extension EndpointView {
             }
             _customEndpoint = .init {
                 if currentProfile.value.isProvider {
-                    return currentProfile.value.providerCustomEndpoint()
+                    return currentProfile.value.providerCustomEndpoint
                 } else {
                     return currentProfile.value.hostOpenVPNSettings?.customEndpoint
                 }
             } set: {
                 if currentProfile.value.isProvider {
-                    currentProfile.value.setProviderCustomEndpoint($0)
+                    currentProfile.value.providerCustomEndpoint = $0
                 } else {
                     currentProfile.value.hostOpenVPNSettings?.customEndpoint = $0
                 }

Passepartout/App/Views/ProfileView+Extra.swift

@@ -35,16 +35,6 @@ extension ProfileView {
         }
 
         var body: some View {
-            if currentProfile.value.isProvider {
-                Section {
-                    Toggle(
-                        L10n.Profile.Items.VpnResolvesHostname.caption,
-                        isOn: $currentProfile.value.networkSettings.resolvesHostname
-                    )
-                } footer: {
-                    Text(L10n.Profile.Sections.VpnResolvesHostname.footer)
-                }
-            }
             Section {
                 Toggle(
                     L10n.Profile.Items.VpnSurvivesSleep.caption,

Passepartout/App/Views/ProfileView+Provider.swift

@@ -77,6 +77,18 @@ extension ProfileView {
             } footer: {
                 currentProviderServerDescription.map(Text.init)
             }
+            Section {
+                Toggle(
+                    L10n.Profile.Items.RandomizesServer.caption,
+                    isOn: $currentProfile.value.providerRandomizesServer ?? false
+                )
+                Toggle(
+                    L10n.Profile.Items.VpnResolvesHostname.caption,
+                    isOn: $currentProfile.value.networkSettings.resolvesHostname
+                )
+            } footer: {
+                Text(L10n.Profile.Sections.VpnResolvesHostname.footer)
+            }
             Section {
                 NavigationLink {
                     ProviderPresetView(currentProfile: currentProfile)
@@ -107,7 +119,14 @@ extension ProfileView {
         }
 
         private var currentProviderServerDescription: String? {
-            profile.providerServer(providerManager)?.localizedLongDescription(withCategory: true)
+            guard let server = profile.providerServer(providerManager) else {
+                return nil
+            }
+            if currentProfile.value.providerRandomizesServer ?? false {
+                return server.localizedCountry(withCategory: true)
+            } else {
+                return server.localizedLongDescription(withCategory: true)
+            }
         }
 
         private var currentProviderCountryImage: Image? {

Passepartout/App/Views/ProviderLocationView.swift

@@ -71,7 +71,7 @@ struct ProviderLocationView: View, ProviderProfileAvailability {
         self.isEditable = isEditable
 
         _selectedServer = .init {
-            guard let serverId = currentProfile.value.providerServerId() else {
+            guard let serverId = currentProfile.value.providerServerId else {
                 return nil
             }
             return providerManager.server(withId: serverId)
@@ -84,9 +84,9 @@ struct ProviderLocationView: View, ProviderProfileAvailability {
             isPresented.wrappedValue = false
         }
         _favoriteLocationIds = .init {
-            currentProfile.value.providerFavoriteLocationIds()
+            currentProfile.value.providerFavoriteLocationIds
         } set: {
-            currentProfile.value.setProviderFavoriteLocationIds($0)
+            currentProfile.value.providerFavoriteLocationIds = $0
         }
     }
 
@@ -151,6 +151,8 @@ struct ProviderLocationView: View, ProviderProfileAvailability {
     private func locationRow(_ location: ProviderLocation) -> some View {
         if let onlyServer = location.onlyServer {
             singleServerRow(location, onlyServer)
+        } else if profile.providerRandomizesServer ?? false {
+            singleServerRow(location, nil)
         } else {
             multipleServersRow(location)
         }
@@ -170,9 +172,9 @@ struct ProviderLocationView: View, ProviderProfileAvailability {
         })
     }
 
-    private func singleServerRow(_ location: ProviderLocation, _ server: ProviderServer) -> some View {
+    private func singleServerRow(_ location: ProviderLocation, _ server: ProviderServer?) -> some View {
         Button {
-            selectedServer = server
+            selectedServer = server ?? location.servers?.randomElement()
         } label: {
             LocationRow(
                 location: location,

Passepartout/App/Views/ProviderPresetView.swift

@@ -46,7 +46,7 @@ struct ProviderPresetView: View {
 
         server = currentProfile.value.providerServer(providerManager)
         _selectedPreset = .init {
-            guard let serverId = currentProfile.value.providerServerId() else {
+            guard let serverId = currentProfile.value.providerServerId else {
                 return nil
             }
             guard let server = providerManager.server(withId: serverId) else {

Passepartout/AppShared/Constants/SwiftGen+Strings.swift

@@ -795,6 +795,10 @@ internal enum L10n {
           internal static let caption = L10n.tr("Localizable", "profile.items.provider.refresh.caption", fallback: "Refresh infrastructure")
         }
       }
+      internal enum RandomizesServer {
+        /// Randomize server
+        internal static let caption = L10n.tr("Localizable", "profile.items.randomizes_server.caption", fallback: "Randomize server")
+      }
       internal enum UseProfile {
         /// Use this profile
         internal static let caption = L10n.tr("Localizable", "profile.items.use_profile.caption", fallback: "Use this profile")

Passepartout/AppShared/L10n/Providers+L10n.swift

@@ -70,6 +70,14 @@ extension ProviderServer {
         countryCode.localizedAsCountryCode
     }
 
+    func localizedCountry(withCategory: Bool) -> String {
+        let desc = localizedCountry
+        if withCategory, !categoryName.isEmpty {
+            return "\(categoryName.uppercased()): \(desc)"
+        }
+        return desc
+    }
+
     var localizedShortDescription: String? {
         var comps = localizedName.map { [$0] } ?? []
         if let serverIndex = serverIndex {

Passepartout/AppShared/en.lproj/Localizable.strings

@@ -152,6 +152,7 @@
 "profile.items.vpn.turn_off.caption" = "Disable VPN";
 "profile.items.connection_status.caption" = "Status";
 "profile.items.data_count.caption" = "Exchanged data";
+"profile.items.randomizes_server.caption" = "Randomize server";
 "profile.items.provider.refresh.caption" = "Refresh infrastructure";
 "profile.items.category.caption" = "Category";
 "profile.items.only_shows_favorites.caption" = "Only show favorite locations";

PassepartoutLibrary/Sources/PassepartoutCore/Extensions/Host+Extensions.swift

@@ -27,23 +27,24 @@ import Foundation
 import TunnelKitCore
 
 extension Profile {
-    public func hostAccount() -> Profile.Account? {
+    public var hostAccount: Profile.Account? {
-        switch currentVPNProtocol {
+        get {
-        case .openVPN:
+            switch currentVPNProtocol {
-            return host?.ovpnSettings?.account
+            case .openVPN:
+                return host?.ovpnSettings?.account
 
-        case .wireGuard:
+            case .wireGuard:
-            return nil
+                return nil
+            }
         }
-    }
+        set {
+            switch currentVPNProtocol {
+            case .openVPN:
+                host?.ovpnSettings?.account = newValue
 
-    public mutating func setHostAccount(_ account: Profile.Account?) {
+            case .wireGuard:
-        switch currentVPNProtocol {
+                break
-        case .openVPN:
+            }
-            host?.ovpnSettings?.account = account
-
-        case .wireGuard:
-            break
         }
     }
 

PassepartoutLibrary/Sources/PassepartoutCore/Extensions/Profile+Extensions.swift

@@ -41,16 +41,16 @@ extension Profile {
     public var account: Profile.Account {
         get {
             if isProvider {
-                return providerAccount() ?? .init()
+                return providerAccount ?? .init()
             } else {
-                return hostAccount() ?? .init()
+                return hostAccount ?? .init()
             }
         }
         set {
             if isProvider {
-                setProviderAccount(newValue)
+                providerAccount = newValue
             } else {
-                setHostAccount(newValue)
+                hostAccount = newValue
             }
         }
     }

PassepartoutLibrary/Sources/PassepartoutCore/Extensions/Provider+Extensions.swift

@@ -45,7 +45,7 @@ extension Profile {
         provider?.name
     }
 
-    public func providerServerId() -> String? {
+    public var providerServerId: String? {
         provider?.vpnSettings[currentVPNProtocol]?.serverId
     }
 
@@ -71,28 +71,40 @@ extension Profile {
         provider?.vpnSettings[currentVPNProtocol]?.presetId = preset.id
     }
 
-    public func providerFavoriteLocationIds() -> Set<String>? {
+    public var providerFavoriteLocationIds: Set<String>? {
-        provider?.vpnSettings[currentVPNProtocol]?.favoriteLocationIds
+        get {
+            provider?.vpnSettings[currentVPNProtocol]?.favoriteLocationIds
+        }
+        set {
+            provider?.vpnSettings[currentVPNProtocol]?.favoriteLocationIds = newValue
+        }
     }
 
-    public mutating func setProviderFavoriteLocationIds(_ ids: Set<String>?) {
+    public var providerCustomEndpoint: Endpoint? {
-        provider?.vpnSettings[currentVPNProtocol]?.favoriteLocationIds = ids
+        get {
+            provider?.vpnSettings[currentVPNProtocol]?.customEndpoint
+        }
+        set {
+            provider?.vpnSettings[currentVPNProtocol]?.customEndpoint = newValue
+        }
     }
 
-    public func providerCustomEndpoint() -> Endpoint? {
+    public var providerAccount: Profile.Account? {
-        provider?.vpnSettings[currentVPNProtocol]?.customEndpoint
+        get {
+            provider?.vpnSettings[currentVPNProtocol]?.account
+        }
+        set {
+            provider?.vpnSettings[currentVPNProtocol]?.account = newValue
+        }
     }
 
-    public mutating func setProviderCustomEndpoint(_ endpoint: Endpoint?) {
+    public var providerRandomizesServer: Bool? {
-        provider?.vpnSettings[currentVPNProtocol]?.customEndpoint = endpoint
+        get {
-    }
+            provider?.randomizesServer
-
+        }
-    public func providerAccount() -> Profile.Account? {
+        set {
-        provider?.vpnSettings[currentVPNProtocol]?.account
+            provider?.randomizesServer = newValue
-    }
+        }
-
-    public mutating func setProviderAccount(_ account: Profile.Account?) {
-        provider?.vpnSettings[currentVPNProtocol]?.account = account
     }
 }
 

PassepartoutLibrary/Sources/PassepartoutCore/Models/Profile+Provider.swift

@@ -47,6 +47,8 @@ extension Profile {
 
         public var vpnSettings: [VPNProtocolType: Settings] = [:]
 
+        public var randomizesServer: Bool?
+
         public init(_ name: ProviderName) {
             self.name = name
         }

PassepartoutLibrary/Sources/PassepartoutProfiles/Extensions/PassepartoutProfiles+Subtype.swift

@@ -39,7 +39,7 @@ extension Profile {
 
 extension Profile {
     public func providerServer(_ providerManager: ProviderManager) -> ProviderServer? {
-        guard let serverId = providerServerId() else {
+        guard let serverId = providerServerId else {
             return nil
         }
         return providerManager.server(withId: serverId)
@@ -51,9 +51,21 @@ extension Profile {
         }
 
         // infer remotes from preset + server
-        guard let server = providerServer(providerManager) else {
+        guard let selectedServer = providerServer(providerManager) else {
             throw PassepartoutError.missingProviderServer
         }
+        let server: ProviderServer
+        if providerRandomizesServer ?? false {
+            let location = selectedServer.location(withVPNProtocol: currentVPNProtocol)
+            let servers = providerManager.servers(forLocation: location)
+            guard let randomServerId = servers.randomElement()?.id,
+                  let randomServer = providerManager.server(withId: randomServerId) else {
+                throw PassepartoutError.missingProviderServer
+            }
+            server = randomServer
+        } else {
+            server = selectedServer
+        }
         guard let preset = providerPreset(server) else {
             throw PassepartoutError.missingProviderPreset
         }
@@ -68,8 +80,8 @@ extension Profile {
         // apply provider settings (username, custom endpoint)
         let cfg = builder.build()
         var settings = OpenVPNSettings(configuration: cfg)
-        settings.account = providerAccount()
+        settings.account = providerAccount
-        settings.customEndpoint = providerCustomEndpoint()
+        settings.customEndpoint = providerCustomEndpoint
         return settings
     }
 

PassepartoutLibrary/Sources/PassepartoutProviders/Extensions/PassepartoutProviders+Identifiable.swift

@@ -45,6 +45,16 @@ extension ProviderServer {
     public var locationId: String {
         "\(providerMetadata.name):\(categoryName):\(countryCode)"
     }
+
+    public func location(withVPNProtocol vpnProtocol: VPNProtocolType) -> ProviderLocation {
+        ProviderLocation(
+            providerMetadata: providerMetadata,
+            vpnProtocol: vpnProtocol,
+            categoryName: categoryName,
+            countryCode: countryCode,
+            servers: nil
+        )
+    }
 }
 
 extension ProviderServer {

PassepartoutLibrary/Sources/PassepartoutVPN/Managers/VPNManager+Actions.swift

@@ -85,7 +85,7 @@ extension VPNManager {
             try await profileManager.makeProfileReady(profile)
         }
 
-        let oldServerId = profile.providerServerId()
+        let oldServerId = profile.providerServerId
         guard let newServer = providerManager.server(withId: newServerId) else {
             pp_log.warning("Server \(newServerId) not found")
             throw PassepartoutError.missingProviderServer

PassepartoutLibrary/Sources/PassepartoutVPN/Managers/VPNManager.swift

@@ -206,15 +206,15 @@ extension VPNManager {
         if newProfile.isProvider {
 
             // server changed?
-            if newProfile.providerServerId() != lastProfile.providerServerId() {
+            if newProfile.providerServerId != lastProfile.providerServerId {
-                pp_log.info("Provider server changed: \(newProfile.providerServerId()?.description ?? "nil")")
+                pp_log.info("Provider server changed: \(newProfile.providerServerId?.description ?? "nil")")
                 isHandled = true
                 shouldReconnect = notDisconnected
             }
 
             // endpoint changed?
-            else if newProfile.providerCustomEndpoint() != lastProfile.providerCustomEndpoint() {
+            else if newProfile.providerCustomEndpoint != lastProfile.providerCustomEndpoint {
-                pp_log.info("Provider endpoint changed: \(newProfile.providerCustomEndpoint()?.description ?? "automatic")")
+                pp_log.info("Provider endpoint changed: \(newProfile.providerCustomEndpoint?.description ?? "automatic")")
                 isHandled = true
                 shouldReconnect = notDisconnected
             }