List only DAITA enabled entry locations if multihop and DAITA are enabled

Author: Jon Petersson

ios/MullvadREST/ApiHandlers/ServerRelaysResponse.swift

@@ -34,7 +34,7 @@ extension REST {
         public let ipv4AddrIn: IPv4Address
         public let weight: UInt64
         public let includeInCountry: Bool
-        public var daita: Bool? = nil
+        public var daita: Bool?
 
         public func override(ipv4AddrIn: IPv4Address?) -> Self {
             return BridgeRelay(

ios/MullvadVPN.xcodeproj/project.pbxproj

@@ -489,6 +489,8 @@
 		7A516C3C2B712F0B00BBD33D /* IPOverrideWrapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A516C3B2B712F0B00BBD33D /* IPOverrideWrapperTests.swift */; };
 		7A52F96A2C1735AE00B133B9 /* RelaySelectorStub.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58FE25EF2AA77664003D1918 /* RelaySelectorStub.swift */; };
 		7A52F96C2C17450C00B133B9 /* RelaySelectorWrapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A52F96B2C17450C00B133B9 /* RelaySelectorWrapperTests.swift */; };
+		7A5468AC2C6A55B100590086 /* LocationRelays.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A5468AB2C6A55B100590086 /* LocationRelays.swift */; };
+		7A5468AD2C6B5E4B00590086 /* LocationRelays.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A5468AB2C6A55B100590086 /* LocationRelays.swift */; };
 		7A5869952B32E9C700640D27 /* LinkButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A5869942B32E9C700640D27 /* LinkButton.swift */; };
 		7A5869972B32EA4500640D27 /* AppButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A5869962B32EA4500640D27 /* AppButton.swift */; };
 		7A58699B2B482FE200640D27 /* UITableViewCell+Disable.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7A58699A2B482FE200640D27 /* UITableViewCell+Disable.swift */; };
@@ -1803,6 +1805,7 @@
 		7A516C392B7111A700BBD33D /* IPOverrideWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPOverrideWrapper.swift; sourceTree = "<group>"; };
 		7A516C3B2B712F0B00BBD33D /* IPOverrideWrapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPOverrideWrapperTests.swift; sourceTree = "<group>"; };
 		7A52F96B2C17450C00B133B9 /* RelaySelectorWrapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RelaySelectorWrapperTests.swift; sourceTree = "<group>"; };
+		7A5468AB2C6A55B100590086 /* LocationRelays.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LocationRelays.swift; sourceTree = "<group>"; };
 		7A5869942B32E9C700640D27 /* LinkButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LinkButton.swift; sourceTree = "<group>"; };
 		7A5869962B32EA4500640D27 /* AppButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppButton.swift; sourceTree = "<group>"; };
 		7A58699A2B482FE200640D27 /* UITableViewCell+Disable.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UITableViewCell+Disable.swift"; sourceTree = "<group>"; };
@@ -2749,6 +2752,7 @@
 				F050AE5D2B739A73003F4EDB /* LocationDataSourceProtocol.swift */,
 				7A6652B62BB44B120042D848 /* LocationDiffableDataSourceProtocol.swift */,
 				7A6389F72B864CDF008E77E1 /* LocationNode.swift */,
+				7A5468AB2C6A55B100590086 /* LocationRelays.swift */,
 				F050AE512B70DFC0003F4EDB /* LocationSection.swift */,
 				F0BE65362B9F136A005CC385 /* LocationSectionHeaderView.swift */,
 				5888AD86227B17950051EB06 /* LocationViewController.swift */,
@@ -5211,6 +5215,7 @@
 				A9A5FA422ACB05D90083449F /* DeviceStateAccessorProtocol.swift in Sources */,
 				7A5869C32B5820CE00640D27 /* IPOverrideRepositoryTests.swift in Sources */,
 				A9A5FA392ACB05910083449F /* UIColor+Palette.swift in Sources */,
+				7A5468AD2C6B5E4B00590086 /* LocationRelays.swift in Sources */,
 				A9A5FA3A2ACB05910083449F /* UIEdgeInsets+Extensions.swift in Sources */,
 				A9A5FA3B2ACB05910083449F /* UIMetrics.swift in Sources */,
 				58B07C182AEFDD6C00A09625 /* StoreTransactionLog.swift in Sources */,
@@ -5498,6 +5503,7 @@
 				7A9CCCC42A96302800DD6A34 /* TunnelCoordinator.swift in Sources */,
 				5827B0A42B0F38FD00CCBBA1 /* EditAccessMethodInteractorProtocol.swift in Sources */,
 				586C0D852B03D31E00E7CDD7 /* SocksSectionHandler.swift in Sources */,
+				7A5468AC2C6A55B100590086 /* LocationRelays.swift in Sources */,
 				58BFA5CC22A7CE1F00A6173D /* ApplicationConfiguration.swift in Sources */,
 				5891BF5125E66B1E006D6FB0 /* UIBarButtonItem+KeyboardNavigation.swift in Sources */,
 				58E511E628DDDEAC00B0BCDE /* CodingErrors+CustomErrorDescription.swift in Sources */,

ios/MullvadVPN/Coordinators/LocationCoordinator.swift

@@ -16,7 +16,7 @@ class LocationCoordinator: Coordinator, Presentable, Presenting {
     private let tunnelManager: TunnelManager
     private let relayCacheTracker: RelayCacheTracker
     private let customListRepository: CustomListRepositoryProtocol
-    private var cachedRelays: CachedRelays?
+    private var cachedRelays: LocationRelays?
 
     let navigationController: UINavigationController
 
@@ -69,8 +69,13 @@ class LocationCoordinator: Coordinator, Presentable, Presenting {
         relayCacheTracker.addObserver(self)
 
         if let cachedRelays = try? relayCacheTracker.getCachedRelays() {
-            self.cachedRelays = cachedRelays
-            locationViewControllerWrapper.setCachedRelays(cachedRelays, filter: relayFilter)
+            let locationRelays = LocationRelays(
+                relays: cachedRelays.relays.wireguard.relays,
+                locations: cachedRelays.relays.locations
+            )
+            self.cachedRelays = locationRelays
+
+            locationViewControllerWrapper.setCachedRelays(locationRelays, filter: relayFilter)
         }
 
         navigationController.pushViewController(locationViewControllerWrapper, animated: false)
@@ -87,7 +92,11 @@ class LocationCoordinator: Coordinator, Presentable, Presenting {
         )
 
         relayFilterCoordinator.didFinish = { [weak self] coordinator, filter in
-            if let cachedRelays = self?.cachedRelays, let filter {
+            if var cachedRelays = self?.cachedRelays, let filter {
+                cachedRelays.relays = cachedRelays.relays.filter { relay in
+                    RelaySelector.relayMatchesFilter(relay, filter: filter)
+                }
+
                 self?.locationViewControllerWrapper?.setCachedRelays(cachedRelays, filter: filter)
             }
 
@@ -148,9 +157,13 @@ extension LocationCoordinator: RelayCacheTrackerObserver {
         _ tracker: RelayCacheTracker,
         didUpdateCachedRelays cachedRelays: CachedRelays
     ) {
-        self.cachedRelays = cachedRelays
+        let locationRelays = LocationRelays(
+            relays: cachedRelays.relays.wireguard.relays,
+            locations: cachedRelays.relays.locations
+        )
+        self.cachedRelays = locationRelays
 
-        locationViewControllerWrapper?.setCachedRelays(cachedRelays, filter: relayFilter)
+        locationViewControllerWrapper?.setCachedRelays(locationRelays, filter: relayFilter)
     }
 }
 
@@ -178,6 +191,10 @@ extension LocationCoordinator: LocationViewControllerWrapperDelegate {
         relayConstraints.filter = .only(filter)
 
         tunnelManager.updateSettings([.relayConstraints(relayConstraints)])
+
+        if let cachedRelays {
+            locationViewControllerWrapper?.setCachedRelays(cachedRelays, filter: filter)
+        }
     }
 
     func navigateToFilter() {

ios/MullvadVPN/View controllers/SelectLocation/AllLocationDataSource.swift

@@ -20,13 +20,13 @@ class AllLocationDataSource: LocationDataSourceProtocol {
     /// Constructs a collection of node trees from relays fetched from the API.
     /// ``RelayLocation.city`` is of special import since we use it to get country
     /// and city names.
-    func reload(_ response: REST.ServerRelaysResponse, relays: [REST.ServerRelay]) {
+    func reload(_ relays: LocationRelays) {
         let rootNode = RootLocationNode()
 
-        for relay in relays {
+        for relay in relays.relays {
             guard case
                 let .city(countryCode, cityCode) = RelayLocation(dashSeparatedString: relay.location),
-                let serverLocation = response.locations[relay.location]
+                let serverLocation = relays.locations[relay.location]
             else { continue }
 
             let relayLocation = RelayLocation.hostname(countryCode, cityCode, relay.hostname)

ios/MullvadVPN/View controllers/SelectLocation/LocationCellViewModel.swift

@@ -62,17 +62,17 @@ extension [LocationCellViewModel] {
 }
 
 extension LocationCellViewModel {
-    /* Exclusion of other locations in the same node tree as the currently excluded location
+    /* Exclusion of other locations in the same node tree (as the currently excluded location)
      happens when there are no more hosts in that tree that can be selected.
      We check this by doing the following, in order:
 
-     1. Count host names in the tree. More than one means that there are other locations than
+     1. Count hostnames in the tree. More than one means that there are other locations than
      the excluded one for the relay selector to choose from. No exlusion.
 
-     2. Count host names in the excluded node. More than one means that there are multiple
-     locations for the relay selector to choose from. No exlusion.
+     2. Count hostnames in the excluded node. More than one means that there are multiple
+     locations for the relay selector to choose from. No exclusion.
 
-     3. Check existance of a location in the tree that match the currently excluded location.
+     3. Check existance of a location in the tree that matches the currently excluded location.
      No match means no exclusion.
      */
     func shouldExcludeLocation(_ excludedLocation: LocationCellViewModel?) -> Bool {
@@ -86,8 +86,8 @@ extension LocationCellViewModel {
             if case .hostname = location { true } else { false }
         }.count
 
-        // If the there are more than one selectable relay in the current node we don't need
-        // show this in the location tree and can return early.
+        // If the there's more than one selectable relay in the current node we don't need
+        // to show this in the location tree and can return early.
         guard hostCount == 1 else { return false }
 
         let proxyExcludedNode = RootLocationNode(children: [excludedLocation.node])
@@ -96,8 +96,8 @@ extension LocationCellViewModel {
             if case .hostname = location { true } else { false }
         }.count
 
-        // If the there are more than one selectable relay in the excluded node we don't need
-        // show this in the location tree and can return early.
+        // If the there's more than one selectable relay in the excluded node we don't need
+        // to show this in the location tree and can return early.
         guard excludedHostCount == 1 else { return false }
 
         var containsExcludedLocation = false

ios/MullvadVPN/View controllers/SelectLocation/LocationDataSource.swift

@@ -54,18 +54,14 @@ final class LocationDataSource:
         defaultRowAnimation = .fade
     }
 
-    func setRelays(_ response: REST.ServerRelaysResponse, selectedRelays: RelaySelection, filter: RelayFilter) {
+    func setRelays(_ cachedRelays: LocationRelays, selectedRelays: RelaySelection) {
         let allLocationsDataSource =
             dataSources.first(where: { $0 is AllLocationDataSource }) as? AllLocationDataSource
 
         let customListsDataSource =
             dataSources.first(where: { $0 is CustomListsDataSource }) as? CustomListsDataSource
 
-        let relays = response.wireguard.relays.filter { relay in
-            RelaySelector.relayMatchesFilter(relay, filter: filter)
-        }
-
-        allLocationsDataSource?.reload(response, relays: relays)
+        allLocationsDataSource?.reload(cachedRelays)
         customListsDataSource?.reload(allLocationNodes: allLocationsDataSource?.nodes ?? [])
 
         setSelectedRelays(selectedRelays)
@@ -237,12 +233,6 @@ final class LocationDataSource:
         )
     }
 
-    private func nodeMatchesExcludedLocation(_ node: LocationNode) -> Bool {
-        // Compare nodes on name rather than whole node in order to match all items in both .customLists
-        // and .allLocations.
-        node.name == excludedLocation?.node.name
-    }
-
     override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
         let cell = super.tableView(tableView, cellForRowAt: indexPath)
         guard let cell = cell as? LocationCell, let item = itemIdentifier(for: indexPath) else {

ios/MullvadVPN/View controllers/SelectLocation/LocationRelays.swift

@@ -0,0 +1,14 @@
+//
+//  LocationRelays.swift
+//  MullvadVPN
+//
+//  Created by Jon Petersson on 2024-08-12.
+//  Copyright © 2024 Mullvad VPN AB. All rights reserved.
+//
+
+import MullvadREST
+
+struct LocationRelays {
+    var relays: [REST.ServerRelay]
+    var locations: [String: REST.ServerLocation]
+}

ios/MullvadVPN/View controllers/SelectLocation/LocationViewController.swift

@@ -23,7 +23,7 @@ final class LocationViewController: UIViewController {
     private let topContentView = UIStackView()
     private let filterView = RelayFilterView()
     private var dataSource: LocationDataSource?
-    private var cachedRelays: CachedRelays?
+    private var cachedRelays: LocationRelays?
     private var filter = RelayFilter()
     private var selectedRelays: RelaySelection
     weak var delegate: LocationViewControllerDelegate?
@@ -80,7 +80,7 @@ final class LocationViewController: UIViewController {
 
     // MARK: - Public
 
-    func setCachedRelays(_ cachedRelays: CachedRelays, filter: RelayFilter) {
+    func setCachedRelays(_ cachedRelays: LocationRelays, filter: RelayFilter) {
         self.cachedRelays = cachedRelays
         self.filter = filter
 
@@ -91,7 +91,7 @@ final class LocationViewController: UIViewController {
             filterView.setFilter(filter)
         }
 
-        dataSource?.setRelays(cachedRelays.relays, selectedRelays: selectedRelays, filter: filter)
+        dataSource?.setRelays(cachedRelays, selectedRelays: selectedRelays)
     }
 
     func refreshCustomLists() {
@@ -121,13 +121,13 @@ final class LocationViewController: UIViewController {
 
             if let cachedRelays {
                 let allLocationDataSource = AllLocationDataSource()
-                allLocationDataSource.reload(cachedRelays.relays, relays: cachedRelays.relays.wireguard.relays)
+                allLocationDataSource.reload(cachedRelays)
                 delegate?.navigateToCustomLists(nodes: allLocationDataSource.nodes)
             }
         }
 
         if let cachedRelays {
-            dataSource?.setRelays(cachedRelays.relays, selectedRelays: selectedRelays, filter: filter)
+            dataSource?.setRelays(cachedRelays, selectedRelays: selectedRelays)
         }
     }
 
@@ -150,14 +150,7 @@ final class LocationViewController: UIViewController {
         filterView.isHidden = filterViewShouldBeHidden
 
         filterView.didUpdateFilter = { [weak self] in
-            guard let self else { return }
-
-            filter = $0
-            delegate?.didUpdateFilter(filter: $0)
-
-            if let cachedRelays {
-                setCachedRelays(cachedRelays, filter: filter)
-            }
+            self?.delegate?.didUpdateFilter(filter: $0)
         }
 
         setUpSearchBar()

ios/MullvadVPN/View controllers/SelectLocation/LocationViewControllerWrapper.swift

@@ -53,6 +53,9 @@ final class LocationViewControllerWrapper: UIViewController {
     private let multihopEnabled: Bool
     private var multihopContext: MultihopContext = .exit
 
+    // TODO: Change, Jon
+    var daitaState: MultihopState = .on
+
     weak var delegate: LocationViewControllerWrapperDelegate?
 
     init(
@@ -100,10 +103,16 @@ final class LocationViewControllerWrapper: UIViewController {
         swapViewController()
     }
 
-    func setCachedRelays(_ cachedRelays: CachedRelays, filter: RelayFilter) {
-        updateViewControllers {
-            $0.setCachedRelays(cachedRelays, filter: filter)
+    func setCachedRelays(_ cachedRelays: LocationRelays, filter: RelayFilter) {
+        var entryRelays = cachedRelays
+        if daitaState == .on {
+            entryRelays.relays = cachedRelays.relays.filter { relay in
+                relay.daita == true
+            }
         }
+
+        entryLocationViewController.setCachedRelays(entryRelays, filter: filter)
+        exitLocationViewController.setCachedRelays(cachedRelays, filter: filter)
     }
 
     func refreshCustomLists() {

ios/MullvadVPNTests/MullvadREST/Relay/RelaySelectorTests.swift

@@ -90,7 +90,7 @@ class RelaySelectorTests: XCTestCase {
         )
     }
 
-    func testNoMatchingRelayConstraintError() throws {
+    func testNoMatchingRelayConstraint() throws {
         let constraints = RelayConstraints(
             exitLocations: .only(UserSelectedRelays(locations: [.country("-")]))
         )

ios/MullvadVPNTests/MullvadVPN/View controllers/SelectLocation/AllLocationsDataSourceTests.swift

@@ -58,9 +58,9 @@ class AllLocationsDataSourceTests: XCTestCase {
 extension AllLocationsDataSourceTests {
     private func setUpDataSource() {
         let response = ServerRelaysResponseStubs.sampleRelays
-        let relays = response.wireguard.relays
+        let relays = LocationRelays(relays: response.wireguard.relays, locations: response.locations)
 
         dataSource = AllLocationDataSource()
-        dataSource.reload(response, relays: relays)
+        dataSource.reload(relays)
     }
 }

ios/MullvadVPNTests/MullvadVPN/View controllers/SelectLocation/CustomListsDataSourceTests.swift

@@ -80,10 +80,10 @@ extension CustomListsDataSourceTests {
 
     private func createAllLocationNodes() {
         let response = ServerRelaysResponseStubs.sampleRelays
-        let relays = response.wireguard.relays
+        let relays = LocationRelays(relays: response.wireguard.relays, locations: response.locations)
 
         let dataSource = AllLocationDataSource()
-        dataSource.reload(response, relays: relays)
+        dataSource.reload(relays)
 
         allLocationNodes = dataSource.nodes
     }