Split select location view into two sections

Author: Jon Petersson

ios/.swiftlint.yml

@@ -7,6 +7,7 @@ disabled_rules:
   - type_body_length
   - opening_brace  # Differs from Google swift guidelines enforced by swiftformat
   - trailing_comma
+  - switch_case_alignment # Enables expressions such as [return switch location {}]
 opt_in_rules:
   - empty_count
 

ios/MullvadVPN.xcodeproj/project.pbxproj

@@ -0,0 +1,22 @@
+{
+  "pins" : [
+    {
+      "identity" : "swift-log",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-log.git",
+      "state" : {
+        "revision" : "173f567a2dfec11d74588eea82cecea555bdc0bc",
+        "version" : "1.4.0"
+      }
+    },
+    {
+      "identity" : "wireguard-apple",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/mullvad/wireguard-apple.git",
+      "state" : {
+        "revision" : "11a00c20dc03f2751db47e94f585c0778c7bde82"
+      }
+    }
+  ],
+  "version" : 2
+}

ios/MullvadVPN.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -65,7 +65,7 @@ final class ApplicationCoordinator: Coordinator, Presenting, RootContainerViewCo
     }()
 
     private var splitTunnelCoordinator: TunnelCoordinator?
-    private var splitLocationCoordinator: SelectLocationCoordinator?
+    private var splitLocationCoordinator: LocationCoordinator?
 
     private let tunnelManager: TunnelManager
     private let storePaymentManager: StorePaymentManager
@@ -703,11 +703,11 @@ final class ApplicationCoordinator: Coordinator, Presenting, RootContainerViewCo
     }
 
     private func makeSelectLocationCoordinator(forModalPresentation isModalPresentation: Bool)
-        -> SelectLocationCoordinator {
+        -> LocationCoordinator {
         let navigationController = CustomNavigationController()
         navigationController.isNavigationBarHidden = !isModalPresentation
 
-        let selectLocationCoordinator = SelectLocationCoordinator(
+        let selectLocationCoordinator = LocationCoordinator(
             navigationController: navigationController,
             tunnelManager: tunnelManager,
             relayCacheTracker: relayCacheTracker

ios/MullvadVPN/Coordinators/ApplicationCoordinator.swift

@@ -0,0 +1,95 @@
+//
+//  CustomListsDataSource.swift
+//  MullvadVPN
+//
+//  Created by Jon Petersson on 2024-02-22.
+//  Copyright © 2024 Mullvad VPN AB. All rights reserved.
+//
+
+import Foundation
+import MullvadREST
+import MullvadSettings
+import MullvadTypes
+
+class CustomListsDataSource: LocationDataSourceProtocol {
+    private(set) var nodes = [LocationNode]()
+    private(set) var repository: CustomListRepositoryProtocol
+
+    init(repository: CustomListRepositoryProtocol) {
+        self.repository = repository
+    }
+
+    var searchableNodes: [LocationNode] {
+        nodes.flatMap { $0.children }
+    }
+
+    func reload(allLocationNodes: [LocationNode]) {
+        nodes = repository.fetchAll().map { list in
+            let listNode = LocationListNode(
+                nodeName: list.name,
+                nodeCode: list.name.lowercased(),
+                locations: list.locations,
+                customList: list
+            )
+
+            listNode.children = list.locations.compactMap { location in
+                copy(location, from: allLocationNodes, withParent: listNode)
+            }
+
+            listNode.forEachDescendant { _, node in
+                node.nodeCode = "\(listNode.nodeCode)-\(node.nodeCode)"
+            }
+
+            return listNode
+        }
+    }
+
+    func node(by locations: [RelayLocation], for customList: CustomList) -> LocationNode? {
+        guard let customListNode = nodes.first(where: { $0.nodeName == customList.name })
+        else { return nil }
+
+        if locations.count > 1 {
+            return customListNode
+        } else {
+            return switch locations.first {
+            case let .country(countryCode):
+                customListNode.nodeFor(nodeCode: "\(customListNode.nodeCode)-\(countryCode)")
+            case let .city(_, cityCode):
+                customListNode.nodeFor(nodeCode: "\(customListNode.nodeCode)-\(cityCode)")
+            case let .hostname(_, _, hostCode):
+                customListNode.nodeFor(nodeCode: "\(customListNode.nodeCode)-\(hostCode)")
+            case .none:
+                nil
+            }
+        }
+    }
+
+    func customList(by id: UUID) -> CustomList? {
+        repository.fetch(by: id)
+    }
+
+    private func copy(
+        _ location: RelayLocation,
+        from allLocationNodes: [LocationNode],
+        withParent rootNode: LocationNode
+    ) -> LocationNode? {
+        let rootNode = RootNode(children: allLocationNodes)
+
+        return switch location {
+        case let .country(countryCode):
+            rootNode
+                .countryFor(countryCode: countryCode)?.copy(withParent: rootNode)
+
+        case let .city(countryCode, cityCode):
+            rootNode
+                .countryFor(countryCode: countryCode)?.copy(withParent: rootNode)
+                .cityFor(cityCode: cityCode)
+
+        case let .hostname(countryCode, cityCode, hostCode):
+            rootNode
+                .countryFor(countryCode: countryCode)?.copy(withParent: rootNode)
+                .cityFor(cityCode: cityCode)?
+                .hostFor(hostCode: hostCode)
+        }
+    }
+}

ios/MullvadVPN/Coordinators/CustomLists/CustomListsDataSource.swift

@@ -1,5 +1,5 @@
 //
-//  SelectLocationCoordinator.swift
+//  LocationCoordinator.swift
 //  MullvadVPN
 //
 //  Created by pronebird on 29/01/2023.
@@ -13,7 +13,7 @@ import UIKit
 
 import MullvadSettings
 
-class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCacheTrackerObserver {
+class LocationCoordinator: Coordinator, Presentable, Presenting, RelayCacheTrackerObserver {
     private let tunnelManager: TunnelManager
     private let relayCacheTracker: RelayCacheTracker
     private var cachedRelays: CachedRelays?
@@ -24,10 +24,10 @@ class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCach
         navigationController
     }
 
-    var selectLocationViewController: SelectLocationViewController? {
+    var selectLocationViewController: LocationViewController? {
         return navigationController.viewControllers.first {
-            $0 is SelectLocationViewController
-        } as? SelectLocationViewController
+            $0 is LocationViewController
+        } as? LocationViewController
     }
 
     var relayFilter: RelayFilter {
@@ -39,7 +39,7 @@ class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCach
         }
     }
 
-    var didFinish: ((SelectLocationCoordinator, RelayLocation?) -> Void)?
+    var didFinish: ((LocationCoordinator, [RelayLocation]) -> Void)?
 
     init(
         navigationController: UINavigationController,
@@ -52,22 +52,22 @@ class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCach
     }
 
     func start() {
-        let selectLocationViewController = SelectLocationViewController()
+        let selectLocationViewController = LocationViewController()
 
-        selectLocationViewController.didSelectRelay = { [weak self] relay in
+        selectLocationViewController.didSelectRelays = { [weak self] locations, customListId in
             guard let self else { return }
 
             var relayConstraints = tunnelManager.settings.relayConstraints
             relayConstraints.locations = .only(RelayLocations(
-                locations: [relay],
-                customListId: nil
+                locations: locations,
+                customListId: customListId
             ))
 
             tunnelManager.updateSettings([.relayConstraints(relayConstraints)]) {
                 self.tunnelManager.startTunnel()
             }
 
-            didFinish?(self, relay)
+            didFinish?(self, locations)
         }
 
         selectLocationViewController.navigateToFilter = { [weak self] in
@@ -91,7 +91,7 @@ class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCach
         selectLocationViewController.didFinish = { [weak self] in
             guard let self else { return }
 
-            didFinish?(self, nil)
+            didFinish?(self, [])
         }
 
         relayCacheTracker.addObserver(self)
@@ -101,8 +101,7 @@ class SelectLocationCoordinator: Coordinator, Presentable, Presenting, RelayCach
             selectLocationViewController.setCachedRelays(cachedRelays, filter: relayFilter)
         }
 
-        selectLocationViewController.relayLocation =
-            tunnelManager.settings.relayConstraints.locations.value?.locations.first
+        selectLocationViewController.relayLocations = tunnelManager.settings.relayConstraints.locations.value
 
         navigationController.pushViewController(selectLocationViewController, animated: false)
     }

ios/MullvadVPN/Coordinators/SelectLocationCoordinator.swift ios/MullvadVPN/Coordinators/LocationCoordinator.swift

@@ -117,6 +117,10 @@ extension UIColor {
         static let backgroundColor = UIColor(red: 0.13, green: 0.20, blue: 0.30, alpha: 1.0)
     }
 
+    enum SubSubSubCell {
+        static let backgroundColor = UIColor(red: 0.11, green: 0.17, blue: 0.27, alpha: 1.0)
+    }
+
     enum HeaderBar {
         static let defaultBackgroundColor = primaryColor
         static let unsecuredBackgroundColor = dangerColor

ios/MullvadVPN/UI appearance/UIColor+Palette.swift

@@ -173,7 +173,7 @@ extension UIMetrics {
     static let contentInsets = UIEdgeInsets(top: 24, left: 24, bottom: 24, right: 24)
 
     /// Common layout margins for location cell presentation
-    static let selectLocationCellLayoutMargins = NSDirectionalEdgeInsets(top: 16, leading: 28, bottom: 16, trailing: 12)
+    static let locationCellLayoutMargins = NSDirectionalEdgeInsets(top: 16, leading: 28, bottom: 16, trailing: 12)
 
     /// Layout margins used by content heading displayed below the large navigation title.
     static let contentHeadingLayoutMargins = NSDirectionalEdgeInsets(top: 8, leading: 24, bottom: 24, trailing: 24)