Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove dependency on relay selector from tunnel actor #5261

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Remove dependency on relay selector from tunnel actor #5261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e82c32
PacketTunnelCore: Introduce SelectedRelay and remove dependency on Re…
Oct 4, 2023
c731b04
Xcode: sort files
Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 18 additions & 37 deletions ios/MullvadVPN.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
5820EDAB288FF0D2006BF4E4 /* DeviceRowView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5820EDAA288FF0D2006BF4E4 /* DeviceRowView.swift */; };
5822C0042A3724A800A3A5FB /* ShadowsocksConfigurationCache.swift in Sources */ = {isa = PBXBuildFile; fileRef = A9467E8A2A2E0317000DC21F /* ShadowsocksConfigurationCache.swift */; };
5822C0052A3724A800A3A5FB /* ShadowsocksConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = A9467E872A2DCD57000DC21F /* ShadowsocksConfiguration.swift */; };
58238CB92AD57EC700768310 /* MullvadREST.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 06799ABC28F98E1D00ACD94E /* MullvadREST.framework */; };
5823FA5426CE49F700283BF8 /* TunnelObserver.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5823FA5326CE49F600283BF8 /* TunnelObserver.swift */; };
582403822A827E1500163DE8 /* RelaySelectorWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 582403812A827E1500163DE8 /* RelaySelectorWrapper.swift */; };
5826B6CB2ABD83E200B1CA13 /* PacketTunnelOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 587C575226D2615F005EF767 /* PacketTunnelOptions.swift */; };
Expand Down Expand Up @@ -286,7 +287,6 @@
58C7AF112ABD8480007EDD7A /* TunnelProviderMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 585DA89226B0323E00B8C587 /* TunnelProviderMessage.swift */; };
58C7AF122ABD8480007EDD7A /* TunnelProviderReply.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5898D2A7290182B000EB5EBA /* TunnelProviderReply.swift */; };
58C7AF132ABD8480007EDD7A /* PacketTunnelStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 585DA89826B0329200B8C587 /* PacketTunnelStatus.swift */; };
58C7AF142ABD8480007EDD7A /* RelaySelectorResult+PacketTunnelRelay.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58C9B8CC2ABB247700040B46 /* RelaySelectorResult+PacketTunnelRelay.swift */; };
58C7AF152ABD8480007EDD7A /* PacketTunnelRelay.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5898D2B62902A9EA00EB5EBA /* PacketTunnelRelay.swift */; };
58C7AF162ABD84A8007EDD7A /* URLRequestProxy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58D229B6298D1D5200BB5A2D /* URLRequestProxy.swift */; };
58C7AF172ABD84AA007EDD7A /* ProxyURLRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 063687AF28EB083800BE7161 /* ProxyURLRequest.swift */; };
Expand All @@ -297,7 +297,6 @@
58C9B8D12ABB255100040B46 /* DeviceCheckOperation.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58FDF2D82A0BA11900C2B061 /* DeviceCheckOperation.swift */; };
58C9B8D22ABB255100040B46 /* DeviceStateAccessor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 583D86472A2678DC0060D63B /* DeviceStateAccessor.swift */; };
58C9B8D32ABB255100040B46 /* DeviceCheckRemoteService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58915D672A25FA080066445B /* DeviceCheckRemoteService.swift */; };
58C9B8DA2ABB271D00040B46 /* MullvadTransport.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = A97F1F412A1F4E1A00ECEFDE /* MullvadTransport.framework */; };
58CAFA002983FF0200BE19F7 /* LoginInteractor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58CAF9FF2983FF0200BE19F7 /* LoginInteractor.swift */; };
58CAFA032985367600BE19F7 /* Promise.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58CAFA01298530DC00BE19F7 /* Promise.swift */; };
58CC40EF24A601900019D96E /* ObserverList.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58CC40EE24A601900019D96E /* ObserverList.swift */; };
Expand Down Expand Up @@ -414,7 +413,6 @@
58FE25BF2AA72311003D1918 /* MigrationManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = A9D96B192A8247C100A5C673 /* MigrationManager.swift */; };
58FE25C22AA72729003D1918 /* MullvadREST.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 06799ABC28F98E1D00ACD94E /* MullvadREST.framework */; };
58FE25C62AA72779003D1918 /* PacketTunnelCore.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 58C7A4362A863F440060C66F /* PacketTunnelCore.framework */; };
58FE25CB2AA727A9003D1918 /* libRelaySelector.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 5898D29829017DAC00EB5EBA /* libRelaySelector.a */; };
58FE25CE2AA72802003D1918 /* MullvadSettings.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 58B2FDD32AA71D2A003EB5C6 /* MullvadSettings.framework */; };
58FE25D42AA729B5003D1918 /* ActorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 58FE25D32AA729B5003D1918 /* ActorTests.swift */; };
58FE25D72AA72A8F003D1918 /* State.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5824030C2A811B0000163DE8 /* State.swift */; };
Expand Down Expand Up @@ -597,6 +595,13 @@
remoteGlobalIDString = 06799ABB28F98E1D00ACD94E;
remoteInfo = MullvadREST;
};
58238CBB2AD57EC800768310 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
proxyType = 1;
remoteGlobalIDString = 06799ABB28F98E1D00ACD94E;
remoteInfo = MullvadREST;
};
58695AA22A4ADA9200328DB3 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
Expand Down Expand Up @@ -653,13 +658,6 @@
remoteGlobalIDString = 58CE5E5F224146200008646E;
remoteInfo = MullvadVPN;
};
58C9B8DC2ABB271D00040B46 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
proxyType = 1;
remoteGlobalIDString = A97F1F402A1F4E1A00ECEFDE;
remoteInfo = MullvadTransport;
};
58CE5E7F224146470008646E /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
Expand Down Expand Up @@ -821,13 +819,6 @@
remoteGlobalIDString = 58C7A4352A863F440060C66F;
remoteInfo = PacketTunnelCore;
};
58FE25CC2AA727A9003D1918 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
proxyType = 1;
remoteGlobalIDString = 5898D29729017DAC00EB5EBA;
remoteInfo = RelaySelector;
};
58FE25D02AA72802003D1918 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 58CE5E58224146200008646E /* Project object */;
Expand Down Expand Up @@ -1325,7 +1316,6 @@
58C7A43D2A863F460060C66F /* PacketTunnelCoreTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = PacketTunnelCoreTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
58C7A46F2A8649ED0060C66F /* PingerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PingerTests.swift; sourceTree = "<group>"; };
58C8191729FAA2C400DEB1B4 /* NotificationConfiguration.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NotificationConfiguration.swift; sourceTree = "<group>"; };
58C9B8CC2ABB247700040B46 /* RelaySelectorResult+PacketTunnelRelay.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "RelaySelectorResult+PacketTunnelRelay.swift"; sourceTree = "<group>"; };
58CAF9F72983D36800BE19F7 /* Coordinator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Coordinator.swift; sourceTree = "<group>"; };
58CAF9FF2983FF0200BE19F7 /* LoginInteractor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoginInteractor.swift; sourceTree = "<group>"; };
58CAFA01298530DC00BE19F7 /* Promise.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Promise.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1593,9 +1583,8 @@
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
58238CB92AD57EC700768310 /* MullvadREST.framework in Frameworks */,
A94D691A2ABAD66700413DD4 /* WireGuardKitTypes in Frameworks */,
58FE25CB2AA727A9003D1918 /* libRelaySelector.a in Frameworks */,
58C9B8DA2ABB271D00040B46 /* MullvadTransport.framework in Frameworks */,
58FE65952AB1D90600E53CB5 /* MullvadTypes.framework in Frameworks */,
58C7A45C2A8640490060C66F /* MullvadLogging.framework in Frameworks */,
);
Expand Down Expand Up @@ -2455,7 +2444,6 @@
587C575226D2615F005EF767 /* PacketTunnelOptions.swift */,
5898D2B62902A9EA00EB5EBA /* PacketTunnelRelay.swift */,
585DA89826B0329200B8C587 /* PacketTunnelStatus.swift */,
58C9B8CC2ABB247700040B46 /* RelaySelectorResult+PacketTunnelRelay.swift */,
585DA89226B0323E00B8C587 /* TunnelProviderMessage.swift */,
5898D2A7290182B000EB5EBA /* TunnelProviderReply.swift */,
);
Expand Down Expand Up @@ -2682,10 +2670,10 @@
58E7A0312AA0715100C57861 /* Protocols */ = {
isa = PBXGroup;
children = (
5819ABC22A8CF02C007B59A6 /* TunnelAdapterProtocol.swift */,
586E7A2C2A987689006DAB1B /* SettingsReaderProtocol.swift */,
5824037F2A827DF300163DE8 /* RelaySelectorProtocol.swift */,
580D6B8B2AB3369300B2D6E0 /* BlockedStateErrorMapperProtocol.swift */,
5824037F2A827DF300163DE8 /* RelaySelectorProtocol.swift */,
586E7A2C2A987689006DAB1B /* SettingsReaderProtocol.swift */,
5819ABC22A8CF02C007B59A6 /* TunnelAdapterProtocol.swift */,
);
path = Protocols;
sourceTree = "<group>";
Expand Down Expand Up @@ -3161,9 +3149,8 @@
);
dependencies = (
58C7A45F2A8640490060C66F /* PBXTargetDependency */,
58FE25CD2AA727A9003D1918 /* PBXTargetDependency */,
58FE65982AB1D90600E53CB5 /* PBXTargetDependency */,
58C9B8DD2ABB271D00040B46 /* PBXTargetDependency */,
58238CBC2AD57EC800768310 /* PBXTargetDependency */,
);
name = PacketTunnelCore;
packageProductDependencies = (
Expand Down Expand Up @@ -3935,7 +3922,6 @@
58C7A4522A863FB50060C66F /* Pinger.swift in Sources */,
580D6B8C2AB3369300B2D6E0 /* BlockedStateErrorMapperProtocol.swift in Sources */,
58C7AF172ABD84AA007EDD7A /* ProxyURLRequest.swift in Sources */,
58C7AF142ABD8480007EDD7A /* RelaySelectorResult+PacketTunnelRelay.swift in Sources */,
5838321F2AC3160A00EA2071 /* Actor+KeyPolicy.swift in Sources */,
58C7AF122ABD8480007EDD7A /* TunnelProviderReply.swift in Sources */,
58C7A4572A863FB90060C66F /* TunnelDeviceInfoProtocol.swift in Sources */,
Expand Down Expand Up @@ -4432,6 +4418,11 @@
target = 06799ABB28F98E1D00ACD94E /* MullvadREST */;
targetProxy = 58153073294CBE8B00D1702E /* PBXContainerItemProxy */;
};
58238CBC2AD57EC800768310 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 06799ABB28F98E1D00ACD94E /* MullvadREST */;
targetProxy = 58238CBB2AD57EC800768310 /* PBXContainerItemProxy */;
};
58695AA32A4ADA9200328DB3 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 5840231E2A406BF5007B27AC /* TunnelObfuscation */;
Expand Down Expand Up @@ -4479,11 +4470,6 @@
target = 58CE5E5F224146200008646E /* MullvadVPN */;
targetProxy = 58C7A4712A864B860060C66F /* PBXContainerItemProxy */;
};
58C9B8DD2ABB271D00040B46 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = A97F1F402A1F4E1A00ECEFDE /* MullvadTransport */;
targetProxy = 58C9B8DC2ABB271D00040B46 /* PBXContainerItemProxy */;
};
58CE5E80224146470008646E /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 58CE5E78224146470008646E /* PacketTunnel */;
Expand Down Expand Up @@ -4589,11 +4575,6 @@
target = 58C7A4352A863F440060C66F /* PacketTunnelCore */;
targetProxy = 58FE25C82AA72779003D1918 /* PBXContainerItemProxy */;
};
58FE25CD2AA727A9003D1918 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 5898D29729017DAC00EB5EBA /* RelaySelector */;
targetProxy = 58FE25CC2AA727A9003D1918 /* PBXContainerItemProxy */;
};
58FE25D12AA72802003D1918 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 58B2FDD22AA71D2A003EB5C6 /* MullvadSettings */;
Expand Down
37 changes: 24 additions & 13 deletions ios/MullvadVPN/SimulatorTunnelProvider/SimulatorTunnelProviderHost.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import RelayCache
import RelaySelector

final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {
private var selectorResult: RelaySelectorResult?
private var selectedRelay: SelectedRelay?
private let urlRequestProxy: URLRequestProxy
private let relayCacheTracker: RelayCacheTracker

Expand All @@ -40,24 +40,24 @@ final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {
completionHandler: @escaping (Error?) -> Void
) {
dispatchQueue.async {
var selectorResult: RelaySelectorResult?
var selectedRelay: SelectedRelay?

do {
let tunnelOptions = PacketTunnelOptions(rawOptions: options ?? [:])

selectorResult = try tunnelOptions.getSelectorResult()
selectedRelay = try tunnelOptions.getSelectedRelay()
} catch {
self.providerLogger.error(
error: error,
message: """
Failed to decode relay selector result passed from the app. \
Failed to decode selected relay passed from the app. \
Will continue by picking new relay.
"""
)
}

do {
self.selectorResult = try selectorResult ?? self.pickRelay()
self.selectedRelay = try selectedRelay ?? self.pickRelay()

completionHandler(nil)
} catch {
Expand All @@ -72,7 +72,7 @@ final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {

override func stopTunnel(with reason: NEProviderStopReason, completionHandler: @escaping () -> Void) {
dispatchQueue.async {
self.selectorResult = nil
self.selectedRelay = nil

completionHandler()
}
Expand All @@ -99,7 +99,7 @@ final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {
switch message {
case .getTunnelStatus:
var tunnelStatus = PacketTunnelStatus()
tunnelStatus.tunnelRelay = self.selectorResult?.packetTunnelRelay
tunnelStatus.tunnelRelay = self.selectedRelay?.packetTunnelRelay

var reply: Data?
do {
Expand All @@ -113,10 +113,17 @@ final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {

completionHandler?(reply)

case let .reconnectTunnel(aSelectorResult):
case let .reconnectTunnel(nextRelay):
reasserting = true
if let aSelectorResult {
selectorResult = aSelectorResult
switch nextRelay {
case let .preSelected(selectedRelay):
self.selectedRelay = selectedRelay
case .random:
if let nextRelay = try? pickRelay() {
self.selectedRelay = nextRelay
}
case .current:
break
}
reasserting = false
completionHandler?(nil)
Expand Down Expand Up @@ -145,15 +152,19 @@ final class SimulatorTunnelProviderHost: SimulatorTunnelProviderDelegate {
}
}

private func pickRelay() throws -> RelaySelectorResult {
private func pickRelay() throws -> SelectedRelay {
let cachedRelays = try relayCacheTracker.getCachedRelays()
let tunnelSettings = try SettingsManager.readSettings()

return try RelaySelector.evaluate(
let selectorResult = try RelaySelector.evaluate(
relays: cachedRelays.relays,
constraints: tunnelSettings.relayConstraints,
numberOfFailedAttempts: 0
)
return SelectedRelay(
endpoint: selectorResult.endpoint,
hostname: selectorResult.relay.hostname,
location: selectorResult.location
)
}
}

Expand Down
16 changes: 8 additions & 8 deletions ios/MullvadVPN/TunnelManager/StartTunnelOperation.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ class StartTunnelOperation: ResultOperation<Void> {

case .disconnected, .pendingReconnect:
do {
let selectorResult = try interactor.selectRelay()
let selectedRelay = try interactor.selectRelay()

makeTunnelProviderAndStartTunnel(selectorResult: selectorResult) { error in
makeTunnelProviderAndStartTunnel(selectedRelay: selectedRelay) { error in
self.finish(result: error.map { .failure($0) } ?? .success(()))
}
} catch {
Expand All @@ -66,15 +66,15 @@ class StartTunnelOperation: ResultOperation<Void> {
}

private func makeTunnelProviderAndStartTunnel(
selectorResult: RelaySelectorResult,
selectedRelay: SelectedRelay,
completionHandler: @escaping (Error?) -> Void
) {
makeTunnelProvider { result in
self.dispatchQueue.async {
do {
try self.startTunnel(
tunnel: try result.get(),
selectorResult: selectorResult
selectedRelay: selectedRelay
)

completionHandler(nil)
Expand All @@ -85,11 +85,11 @@ class StartTunnelOperation: ResultOperation<Void> {
}
}

private func startTunnel(tunnel: Tunnel, selectorResult: RelaySelectorResult) throws {
private func startTunnel(tunnel: Tunnel, selectedRelay: SelectedRelay) throws {
var tunnelOptions = PacketTunnelOptions()

do {
try tunnelOptions.setSelectorResult(selectorResult)
try tunnelOptions.setSelectedRelay(selectedRelay)
} catch {
logger.error(
error: error,
Expand All @@ -101,8 +101,8 @@ class StartTunnelOperation: ResultOperation<Void> {

interactor.updateTunnelStatus { tunnelStatus in
tunnelStatus = TunnelStatus()
tunnelStatus.packetTunnelStatus.tunnelRelay = selectorResult.packetTunnelRelay
tunnelStatus.state = .connecting(selectorResult.packetTunnelRelay)
tunnelStatus.packetTunnelStatus.tunnelRelay = selectedRelay.packetTunnelRelay
tunnelStatus.state = .connecting(selectedRelay.packetTunnelRelay)
}

try tunnel.start(options: tunnelOptions.rawOptions())
Expand Down
7 changes: 3 additions & 4 deletions ios/MullvadVPN/TunnelManager/Tunnel+Messaging.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,16 @@ private let dispatchQueue = DispatchQueue(label: "Tunnel.dispatchQueue")
private let proxyRequestTimeout = REST.defaultAPINetworkTimeout + 2

extension Tunnel {
/// Request packet tunnel process to reconnect the tunnel with the given relay selector result.
/// Packet tunnel will reconnect to the current relay if relay selector result is not provided.
/// Request packet tunnel process to reconnect the tunnel with the given relay.
func reconnectTunnel(
relaySelectorResult: RelaySelectorResult?,
to nextRelay: NextRelay,
completionHandler: @escaping (Result<Void, Error>) -> Void
) -> Cancellable {
let operation = SendTunnelProviderMessageOperation(
dispatchQueue: dispatchQueue,
application: .shared,
tunnel: self,
message: .reconnectTunnel(relaySelectorResult),
message: .reconnectTunnel(nextRelay),
completionHandler: completionHandler
)

Expand Down
5 changes: 2 additions & 3 deletions ios/MullvadVPN/TunnelManager/TunnelInteractor.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@

import Foundation
import MullvadSettings
import RelayCache
import RelaySelector
import PacketTunnelCore

protocol TunnelInteractor {
// MARK: - Tunnel manipulation
Expand Down Expand Up @@ -38,5 +37,5 @@ protocol TunnelInteractor {

func startTunnel()
func prepareForVPNConfigurationDeletion()
func selectRelay() throws -> RelaySelectorResult
func selectRelay() throws -> SelectedRelay
}
Loading
Loading