Skip to content

Commit a9dde3c

Browse files
mojganiiJon Petersson
mojganii
authored and
Jon Petersson
committed
refactoring location datasource
1 parent 3a7fdd4 commit a9dde3c

11 files changed

+608
-410
lines changed

‎ios/MullvadVPN.xcodeproj/project.pbxproj

+28
Original file line numberDiff line numberDiff line change
@@ -774,6 +774,13 @@
774774
F03580252A13842C00E5DAFD /* IncreasedHitButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = F03580242A13842C00E5DAFD /* IncreasedHitButton.swift */; };
775775
F04F95A12B21D24400431E08 /* shadowsocks.h in Headers */ = {isa = PBXBuildFile; fileRef = F04F95A02B21D24400431E08 /* shadowsocks.h */; settings = {ATTRIBUTES = (Private, ); }; };
776776
F04FBE612A8379EE009278D7 /* AppPreferences.swift in Sources */ = {isa = PBXBuildFile; fileRef = F04FBE602A8379EE009278D7 /* AppPreferences.swift */; };
777+
F050AE4C2B70D5A7003F4EDB /* SelectLocationNode.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE4B2B70D5A7003F4EDB /* SelectLocationNode.swift */; };
778+
F050AE4E2B70D7F8003F4EDB /* LocationCellViewModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE4D2B70D7F8003F4EDB /* LocationCellViewModel.swift */; };
779+
F050AE502B70DC4F003F4EDB /* SelectLocationNodeProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE4F2B70DC4F003F4EDB /* SelectLocationNodeProtocol.swift */; };
780+
F050AE522B70DFC0003F4EDB /* SelectLocationGroup.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE512B70DFC0003F4EDB /* SelectLocationGroup.swift */; };
781+
F050AE5E2B739A73003F4EDB /* LocationDataSourceProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE5D2B739A73003F4EDB /* LocationDataSourceProtocol.swift */; };
782+
F050AE602B73A41E003F4EDB /* AllLocationDataSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE5F2B73A41E003F4EDB /* AllLocationDataSource.swift */; };
783+
F050AE622B74DBAC003F4EDB /* CustomListsDataSource.swift in Sources */ = {isa = PBXBuildFile; fileRef = F050AE612B74DBAC003F4EDB /* CustomListsDataSource.swift */; };
777784
F05F39942B21C6C6006E60A7 /* relays.json in Resources */ = {isa = PBXBuildFile; fileRef = 58F3C0A524A50155003E76BE /* relays.json */; };
778785
F05F39972B21C735006E60A7 /* RelayCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5820675A26E6576800655B05 /* RelayCache.swift */; };
779786
F05F39982B21C73C006E60A7 /* CachedRelays.swift in Sources */ = {isa = PBXBuildFile; fileRef = 585DA87626B024A600B8C587 /* CachedRelays.swift */; };
@@ -1865,6 +1872,13 @@
18651872
F03580242A13842C00E5DAFD /* IncreasedHitButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IncreasedHitButton.swift; sourceTree = "<group>"; };
18661873
F04F95A02B21D24400431E08 /* shadowsocks.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = shadowsocks.h; sourceTree = "<group>"; };
18671874
F04FBE602A8379EE009278D7 /* AppPreferences.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppPreferences.swift; sourceTree = "<group>"; };
1875+
F050AE4B2B70D5A7003F4EDB /* SelectLocationNode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SelectLocationNode.swift; sourceTree = "<group>"; };
1876+
F050AE4D2B70D7F8003F4EDB /* LocationCellViewModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LocationCellViewModel.swift; sourceTree = "<group>"; };
1877+
F050AE4F2B70DC4F003F4EDB /* SelectLocationNodeProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SelectLocationNodeProtocol.swift; sourceTree = "<group>"; };
1878+
F050AE512B70DFC0003F4EDB /* SelectLocationGroup.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SelectLocationGroup.swift; sourceTree = "<group>"; };
1879+
F050AE5D2B739A73003F4EDB /* LocationDataSourceProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LocationDataSourceProtocol.swift; sourceTree = "<group>"; };
1880+
F050AE5F2B73A41E003F4EDB /* AllLocationDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AllLocationDataSource.swift; sourceTree = "<group>"; };
1881+
F050AE612B74DBAC003F4EDB /* CustomListsDataSource.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomListsDataSource.swift; sourceTree = "<group>"; };
18681882
F06045E52B231EB700B2D37A /* URLSessionTransport.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URLSessionTransport.swift; sourceTree = "<group>"; };
18691883
F06045E92B23217E00B2D37A /* ShadowsocksTransport.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ShadowsocksTransport.swift; sourceTree = "<group>"; };
18701884
F06045EB2B2322A500B2D37A /* Jittered.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Jittered.swift; sourceTree = "<group>"; };
@@ -2282,9 +2296,16 @@
22822296
583FE01729C196F3006E85F9 /* SelectLocation */ = {
22832297
isa = PBXGroup;
22842298
children = (
2299+
F050AE5F2B73A41E003F4EDB /* AllLocationDataSource.swift */,
2300+
F050AE612B74DBAC003F4EDB /* CustomListsDataSource.swift */,
22852301
58435AC129CB2A350099C71B /* LocationCellFactory.swift */,
2302+
F050AE4D2B70D7F8003F4EDB /* LocationCellViewModel.swift */,
22862303
583DA21325FA4B5C00318683 /* LocationDataSource.swift */,
2304+
F050AE5D2B739A73003F4EDB /* LocationDataSourceProtocol.swift */,
22872305
5888AD82227B11080051EB06 /* SelectLocationCell.swift */,
2306+
F050AE512B70DFC0003F4EDB /* SelectLocationGroup.swift */,
2307+
F050AE4B2B70D5A7003F4EDB /* SelectLocationNode.swift */,
2308+
F050AE4F2B70DC4F003F4EDB /* SelectLocationNodeProtocol.swift */,
22882309
5888AD86227B17950051EB06 /* SelectLocationViewController.swift */,
22892310
);
22902311
path = SelectLocation;
@@ -4892,6 +4913,7 @@
48924913
58968FAE28743E2000B799DC /* TunnelInteractor.swift in Sources */,
48934914
7A1A26472A29CF0800B978AA /* RelayFilterDataSource.swift in Sources */,
48944915
5864AF0929C78850005B0CD9 /* PreferencesCellFactory.swift in Sources */,
4916+
F050AE4E2B70D7F8003F4EDB /* LocationCellViewModel.swift in Sources */,
48954917
58CEB30C2AFD586600E6E088 /* DynamicBackgroundConfiguration.swift in Sources */,
48964918
587B7536266528A200DEF7E9 /* NotificationManager.swift in Sources */,
48974919
5820EDA9288FE064006BF4E4 /* DeviceManagementInteractor.swift in Sources */,
@@ -4905,6 +4927,7 @@
49054927
5871FB96254ADE4E0051A0A4 /* ConsolidatedApplicationLog.swift in Sources */,
49064928
F0E8E4C52A60499100ED26A3 /* AccountDeletionViewController.swift in Sources */,
49074929
7A9CCCC12A96302800DD6A34 /* AccountCoordinator.swift in Sources */,
4930+
F050AE502B70DC4F003F4EDB /* SelectLocationNodeProtocol.swift in Sources */,
49084931
58FEEB58260B662E00A621A8 /* AutomaticKeyboardResponder.swift in Sources */,
49094932
5846227326E22A160035F7C2 /* StorePaymentObserver.swift in Sources */,
49104933
F0E3618B2A4ADD2F00AEEF2B /* WelcomeContentView.swift in Sources */,
@@ -4946,6 +4969,7 @@
49464969
7A9CCCBE2A96302800DD6A34 /* AccountDeletionCoordinator.swift in Sources */,
49474970
588527B4276B4F2F00BAA373 /* SetAccountOperation.swift in Sources */,
49484971
58FF9FE02B075ABC00E4C97D /* EditAccessMethodViewController.swift in Sources */,
4972+
F050AE622B74DBAC003F4EDB /* CustomListsDataSource.swift in Sources */,
49494973
F0DA87472A9CB9A2006044F1 /* AccountExpiryRow.swift in Sources */,
49504974
585CA70F25F8C44600B47C62 /* UIMetrics.swift in Sources */,
49514975
E1187ABD289BBB850024E748 /* OutOfTimeContentView.swift in Sources */,
@@ -4978,6 +5002,7 @@
49785002
063F026628FFE11C001FA09F /* RESTCreateApplePaymentResponse+Localization.swift in Sources */,
49795003
58DF28A52417CB4B00E836B0 /* StorePaymentManager.swift in Sources */,
49805004
583DA21425FA4B5C00318683 /* LocationDataSource.swift in Sources */,
5005+
F050AE602B73A41E003F4EDB /* AllLocationDataSource.swift in Sources */,
49815006
587EB6742714520600123C75 /* PreferencesDataSourceDelegate.swift in Sources */,
49825007
582BB1AF229566420055B6EF /* SettingsCell.swift in Sources */,
49835008
7AF9BE8E2A331C7B00DBFEDB /* RelayFilterViewModel.swift in Sources */,
@@ -5083,7 +5108,9 @@
50835108
584592612639B4A200EF967F /* TermsOfServiceContentView.swift in Sources */,
50845109
5875960A26F371FC00BF6711 /* Tunnel+Messaging.swift in Sources */,
50855110
586C0D912B03D8A400E7CDD7 /* AccessMethodHeaderFooterReuseIdentifier.swift in Sources */,
5111+
F050AE4C2B70D5A7003F4EDB /* SelectLocationNode.swift in Sources */,
50865112
7A2960F62A963F7500389B82 /* AlertCoordinator.swift in Sources */,
5113+
F050AE522B70DFC0003F4EDB /* SelectLocationGroup.swift in Sources */,
50875114
063687BA28EB234F00BE7161 /* PacketTunnelTransport.swift in Sources */,
50885115
A9C342C12ACC37E30045F00E /* TunnelStatusBlockObserver.swift in Sources */,
50895116
587425C12299833500CA2045 /* RootContainerViewController.swift in Sources */,
@@ -5103,6 +5130,7 @@
51035130
5827B0BF2B14B37D00CCBBA1 /* Publisher+PreviousValue.swift in Sources */,
51045131
7A9CCCB62A96302800DD6A34 /* OutOfTimeCoordinator.swift in Sources */,
51055132
5827B0AA2B0F4C9100CCBBA1 /* EditAccessMethodViewControllerDelegate.swift in Sources */,
5133+
F050AE5E2B739A73003F4EDB /* LocationDataSourceProtocol.swift in Sources */,
51065134
7A5869A82B5140C200640D27 /* MethodSettingsValidationErrorContentView.swift in Sources */,
51075135
A99E5EE22B762ED30033F241 /* ProblemReportViewController+ViewManagement.swift in Sources */,
51085136
7A5869A22B502EA800640D27 /* MethodSettingsSectionIdentifier.swift in Sources */,

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

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
//
2+
// AllLocationDataSource.swift
3+
// MullvadVPN
4+
//
5+
// Created by Mojgan on 2024-02-07.
6+
// Copyright © 2024 Mullvad VPN AB. All rights reserved.
7+
//
8+
9+
import Foundation
10+
import MullvadREST
11+
import MullvadTypes
12+
13+
class AllLocationDataSource: LocationDataSourceProtocol {
14+
var nodeByLocation = [RelayLocation: SelectLocationNode]()
15+
private var locationList = [RelayLocation]()
16+
17+
func search(by text: String) -> [RelayLocation] {
18+
if text.isEmpty {
19+
return locationList
20+
} else {
21+
var filteredLocations: [RelayLocation] = []
22+
locationList.forEach { location in
23+
guard let countryNode = nodeByLocation[location] else { return }
24+
countryNode.showsChildren = false
25+
26+
if text.isEmpty || countryNode.displayName.fuzzyMatch(text) {
27+
filteredLocations.append(countryNode.location)
28+
}
29+
30+
for cityNode in countryNode.children {
31+
cityNode.showsChildren = false
32+
33+
let relaysContainSearchString = cityNode.children
34+
.contains(where: { $0.displayName.fuzzyMatch(text) })
35+
36+
if cityNode.displayName.fuzzyMatch(text) || relaysContainSearchString {
37+
if !filteredLocations.contains(where: { $0 == countryNode.location }) {
38+
filteredLocations.append(countryNode.location)
39+
}
40+
41+
filteredLocations.append(cityNode.location)
42+
countryNode.showsChildren = true
43+
44+
if relaysContainSearchString {
45+
cityNode.children.map { $0.location }.forEach {
46+
filteredLocations.append($0)
47+
}
48+
cityNode.showsChildren = true
49+
}
50+
}
51+
}
52+
}
53+
54+
return filteredLocations
55+
}
56+
}
57+
58+
func reload(
59+
_ response: MullvadREST.REST.ServerRelaysResponse,
60+
relays: [MullvadREST.REST.ServerRelay]
61+
) -> [RelayLocation] {
62+
nodeByLocation.removeAll()
63+
let rootNode = self.makeRootNode(name: SelectLocationGroup.allLocations.description)
64+
65+
for relay in relays {
66+
guard case let .city(countryCode, cityCode) = RelayLocation(dashSeparatedString: relay.location),
67+
let serverLocation = response.locations[relay.location] else { continue }
68+
69+
let relayLocation = RelayLocation.hostname(countryCode, cityCode, relay.hostname)
70+
71+
for ascendantOrSelf in relayLocation.ascendants + [relayLocation] {
72+
guard !nodeByLocation.keys.contains(ascendantOrSelf) else {
73+
continue
74+
}
75+
76+
// Maintain the `showsChildren` state when transitioning between relay lists
77+
let wasShowingChildren = nodeByLocation[ascendantOrSelf]?.showsChildren ?? false
78+
79+
let node = createNode(
80+
root: rootNode,
81+
ascendantOrSelf: ascendantOrSelf,
82+
serverLocation: serverLocation,
83+
relay: relay,
84+
wasShowingChildren: wasShowingChildren
85+
)
86+
nodeByLocation[ascendantOrSelf] = node
87+
}
88+
}
89+
90+
rootNode.sortChildrenRecursive()
91+
rootNode.computeActiveChildrenRecursive()
92+
locationList = rootNode.flatRelayLocationList()
93+
return locationList
94+
}
95+
}

‎ios/MullvadVPN/View controllers/SelectLocation/CustomListsDataSource.swift

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
//
2+
// CustomListsDataSource.swift
3+
// MullvadVPN
4+
//
5+
// Created by Mojgan on 2024-02-08.
6+
// Copyright © 2024 Mullvad VPN AB. All rights reserved.
7+
//
8+
9+
import Foundation
10+
import MullvadREST
11+
import MullvadTypes
12+
13+
class CustomListsDataSource: LocationDataSourceProtocol {
14+
var nodeByLocation = [RelayLocation: SelectLocationNode]()
15+
private var locationList = [RelayLocation]()
16+
17+
func search(by text: String) -> [RelayLocation] {
18+
return []
19+
}
20+
21+
func reload(
22+
_ response: MullvadREST.REST.ServerRelaysResponse,
23+
relays: [MullvadREST.REST.ServerRelay]
24+
) -> [RelayLocation] {
25+
locationList
26+
}
27+
}

‎ios/MullvadVPN/View controllers/SelectLocation/LocationCellFactory.swift

+12-8
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,26 @@ import MullvadTypes
1010
import UIKit
1111

1212
protocol LocationCellEventHandler {
13-
func collapseCell(for item: RelayLocation)
13+
func collapseCell(for item: LocationCellViewModel)
14+
func node(for item: LocationCellViewModel) -> SelectLocationNode?
1415
}
1516

1617
final class LocationCellFactory: CellFactoryProtocol {
17-
var nodeByLocation = [RelayLocation: LocationDataSource.Node]()
1818
var delegate: LocationCellEventHandler?
1919
let tableView: UITableView
20+
let reuseIdentifier: String
2021

21-
init(tableView: UITableView, nodeByLocation: [RelayLocation: LocationDataSource.Node]) {
22+
init(
23+
tableView: UITableView,
24+
reuseIdentifier: String
25+
) {
2226
self.tableView = tableView
23-
self.nodeByLocation = nodeByLocation
27+
self.reuseIdentifier = reuseIdentifier
2428
}
2529

26-
func makeCell(for item: RelayLocation, indexPath: IndexPath) -> UITableViewCell {
30+
func makeCell(for item: LocationCellViewModel, indexPath: IndexPath) -> UITableViewCell {
2731
let cell = tableView.dequeueReusableCell(
28-
withIdentifier: LocationDataSource.CellReuseIdentifiers.locationCell.rawValue,
32+
withIdentifier: reuseIdentifier,
2933
for: indexPath
3034
)
3135

@@ -34,9 +38,9 @@ final class LocationCellFactory: CellFactoryProtocol {
3438
return cell
3539
}
3640

37-
func configureCell(_ cell: UITableViewCell, item: RelayLocation, indexPath: IndexPath) {
41+
func configureCell(_ cell: UITableViewCell, item: LocationCellViewModel, indexPath: IndexPath) {
3842
guard let cell = cell as? SelectLocationCell,
39-
let node = nodeByLocation[item] else { return }
43+
let node = delegate?.node(for: item) else { return }
4044

4145
cell.accessibilityIdentifier = node.location.stringRepresentation
4246
cell.isDisabled = !node.isActive

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

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
//
2+
// LocationCellViewModel.swift
3+
// MullvadVPN
4+
//
5+
// Created by Mojgan on 2024-02-05.
6+
// Copyright © 2024 Mullvad VPN AB. All rights reserved.
7+
//
8+
9+
import MullvadTypes
10+
11+
struct LocationCellViewModel: Hashable {
12+
let group: SelectLocationGroup
13+
let location: RelayLocation
14+
}

0 commit comments

Comments
 (0)