Resolve location selection against remote locations #764
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // | ||
| // VPNServerSelectionSanitizer.swift | ||
| // | ||
| // Copyright © 2024 DuckDuckGo. All rights reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
| public enum VPNServerSelectionError: Error { | ||
| case countryNotFound | ||
| case fetchingLocationsFailed(Error) | ||
| } | ||
|
|
||
| public protocol VPNServerSelectionSanitizing { | ||
| func sanitizedServerSelectionMethod() async -> NetworkProtectionServerSelectionMethod | ||
| } | ||
|
|
||
| public final class VPNServerSelectionSanitizer: VPNServerSelectionSanitizing { | ||
| private let locationListRepository: NetworkProtectionLocationListRepository | ||
| private let vpnSettings: VPNSettings | ||
|
|
||
| public init(locationListRepository: NetworkProtectionLocationListRepository, vpnSettings: VPNSettings) { | ||
| self.locationListRepository = locationListRepository | ||
| self.vpnSettings = vpnSettings | ||
| } | ||
|
|
||
| public func sanitizedServerSelectionMethod() async -> NetworkProtectionServerSelectionMethod { | ||
| switch currentServerSelectionMethod { | ||
| case .automatic, .preferredServer, .avoidServer: | ||
| return currentServerSelectionMethod | ||
| case .preferredLocation(let networkProtectionSelectedLocation): | ||
| do { | ||
| let location = try await sanitizeSelectionAgainstAvailableLocations(networkProtectionSelectedLocation) | ||
| return .preferredLocation(location) | ||
| } catch let error as VPNServerSelectionError { | ||
| switch error { | ||
| case .countryNotFound: | ||
| return .automatic | ||
| case .fetchingLocationsFailed: | ||
| return currentServerSelectionMethod | ||
| } | ||
| } catch { | ||
| return currentServerSelectionMethod | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private func sanitizeSelectionAgainstAvailableLocations(_ selection: NetworkProtectionSelectedLocation) async throws -> NetworkProtectionSelectedLocation { | ||
| let availableLocations: [NetworkProtectionLocation] | ||
| do { | ||
| availableLocations = try await locationListRepository.fetchLocationListIgnoringCache() | ||
| } catch { | ||
| throw VPNServerSelectionError.fetchingLocationsFailed(error) | ||
| } | ||
|
|
||
| let availableCitySelections = availableLocations.flatMap { location in | ||
| location.cities.map { city in NetworkProtectionSelectedLocation(country: location.country, city: city.name) } | ||
| } | ||
|
|
||
| if availableCitySelections.contains(selection) { | ||
| return selection | ||
| } | ||
|
|
||
| let selectedCountry = NetworkProtectionSelectedLocation(country: selection.country) | ||
| let availableCountrySelections = availableLocations.map { NetworkProtectionSelectedLocation(country: $0.country) } | ||
| guard availableCountrySelections.contains(selectedCountry) else { | ||
| throw VPNServerSelectionError.countryNotFound | ||
| } | ||
|
|
||
| return selectedCountry | ||
| } | ||
|
|
||
| private var currentServerSelectionMethod: NetworkProtectionServerSelectionMethod { | ||
| var serverSelectionMethod: NetworkProtectionServerSelectionMethod | ||
|
|
||
| switch vpnSettings.selectedLocation { | ||
| case .nearest: | ||
| serverSelectionMethod = .automatic | ||
| case .location(let networkProtectionSelectedLocation): | ||
| serverSelectionMethod = .preferredLocation(networkProtectionSelectedLocation) | ||
| } | ||
|
|
||
| switch vpnSettings.selectedServer { | ||
| case .automatic: | ||
| break | ||
| case .endpoint(let string): | ||
| // Selecting a specific server will override locations setting | ||
| // Only available in debug | ||
| serverSelectionMethod = .preferredServer(serverName: string) | ||
| } | ||
|
|
||
| return serverSelectionMethod | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GitHub Actions 
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few comments here:
PacketTunnelProvider) the instance is namedserverSelection, which makes me think you agree. Why not name this something more generic likeVPNServerSelectororVPNServerSelectionResolver.PacketTunnelProviderwhether this does sanitization or not is an implementation detail - what matters is that this class provides a server / location to connect to.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the naming here gave me a lot of trouble. So just decided to open it up to get opinions. Thanks for the input.