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

Throttle network path updates in packet tunnel #5511

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Throttle network path updates in packet tunnel #5511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 17 additions & 11 deletions ios/PacketTunnel/PacketTunnelProvider/PacketTunnelPathObserver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@
// Copyright © 2023 Mullvad VPN AB. All rights reserved.
//

import Foundation
import Combine
import NetworkExtension
import PacketTunnelCore

final class PacketTunnelPathObserver: DefaultPathObserverProtocol {
private weak var packetTunnelProvider: NEPacketTunnelProvider?
private let stateLock = NSLock()
private var observationToken: NSKeyValueObservation?
private var pathUpdatePublisher: AnyCancellable?
private let eventQueue: DispatchQueue

init(packetTunnelProvider: NEPacketTunnelProvider) {
init(packetTunnelProvider: NEPacketTunnelProvider, eventQueue: DispatchQueue) {
self.packetTunnelProvider = packetTunnelProvider
self.eventQueue = eventQueue
}

var defaultPath: NetworkPath? {
Expand All @@ -25,22 +27,26 @@ final class PacketTunnelPathObserver: DefaultPathObserverProtocol {

func start(_ body: @escaping (NetworkPath) -> Void) {
stateLock.withLock {
observationToken?.invalidate()
pathUpdatePublisher?.cancel()

// Normally packet tunnel provider should exist throughout the network extension lifetime.
observationToken = packetTunnelProvider?.observe(\.defaultPath, options: [.new]) { _, change in
let nwPath = change.newValue.flatMap { $0 }
if let nwPath {
body(nwPath)
pathUpdatePublisher = packetTunnelProvider?.publisher(for: \.defaultPath)
.removeDuplicates(by: { oldPath, newPath in
oldPath?.status == newPath?.status
})
.throttle(for: .seconds(2), scheduler: eventQueue, latest: true)
.sink { change in
if let change {
body(change)
}
}
}
}
}

func stop() {
stateLock.withLock {
observationToken?.invalidate()
observationToken = nil
pathUpdatePublisher?.cancel()
pathUpdatePublisher = nil
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions ios/PacketTunnel/PacketTunnelProvider/PacketTunnelProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class PacketTunnelProvider: NEPacketTunnelProvider {
eventQueue: internalQueue,
pinger: Pinger(replyQueue: internalQueue),
tunnelDeviceInfo: adapter,
defaultPathObserver: PacketTunnelPathObserver(packetTunnelProvider: self),
defaultPathObserver: PacketTunnelPathObserver(packetTunnelProvider: self, eventQueue: internalQueue),
timings: TunnelMonitorTimings()
)

Expand All @@ -78,7 +78,7 @@ class PacketTunnelProvider: NEPacketTunnelProvider {
timings: PacketTunnelActorTimings(),
tunnelAdapter: adapter,
tunnelMonitor: tunnelMonitor,
defaultPathObserver: PacketTunnelPathObserver(packetTunnelProvider: self),
defaultPathObserver: PacketTunnelPathObserver(packetTunnelProvider: self, eventQueue: internalQueue),
blockedStateErrorMapper: BlockedStateErrorMapper(),
relaySelector: RelaySelectorWrapper(relayCache: relayCache),
settingsReader: SettingsReader()
Expand Down
Loading