Fix some issues with handling when the adapter is started up. (#2251)

Task/Issue URL: https://app.asana.com/0/0/1206634919441353/f iOS PR: duckduckgo/iOS#2496 BSK PR: duckduckgo/BrowserServicesKit#674 ## Description Fixes how we handle the event of the tunnel adapter started. More broadly, this PR tries to ensure we don't "histerically" start and stop our monitors, since that could result in a lot of noise in our metrics.
duckduckgo · Feb 24, 2024 · 2049db6 · 2049db6
1 parent bd5375a
commit 2049db6
Show file tree

Hide file tree

Showing 13 changed files with 34 additions and 22 deletions.
diff --git a/DuckDuckGo.xcodeproj/project.pbxproj b/DuckDuckGo.xcodeproj/project.pbxproj
@@ -13538,7 +13538,7 @@
 			repositoryURL = "https://github.com/duckduckgo/BrowserServicesKit";
 			requirement = {
 				kind = exactVersion;
-				version = 110.0.0;
+				version = 110.0.1;
 			};
 		};
 		AA06B6B52672AF8100F541C5 /* XCRemoteSwiftPackageReference "Sparkle" */ = {

diff --git a/DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -14,8 +14,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/BrowserServicesKit",
       "state" : {
-        "revision" : "d56b90bd229288f681f0a3a6a325ef25e3ce5f3c",
-        "version" : "110.0.0"
+        "revision" : "483427db845410f10121cf2200f5a940c9bbf70b",
+        "version" : "110.0.1"
       }
     },
     {

diff --git a/...uckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionTunnelController.swift b/...uckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionTunnelController.swift
@@ -86,6 +86,12 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
     ///
     private var internalManager: NETunnelProviderManager?
 
+    /// The last known VPN status.
+    ///
+    /// Should not be used for checking the current status.
+    ///
+    private var previousStatus: NEVPNStatus = .invalid
+
     // MARK: - User Defaults
 
     /* Temporarily disabled - https://app.asana.com/0/0/1205766100762904/f
@@ -172,12 +178,15 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
 
     private func handleStatusChange(_ notification: Notification) {
         guard let session = (notification.object as? NETunnelProviderSession),
-            let manager = session.manager as? NETunnelProviderManager else {
+              session.status != previousStatus,
+              let manager = session.manager as? NETunnelProviderManager else {
 
             return
         }
 
         Task { @MainActor in
+            previousStatus = session.status
+
             switch session.status {
             case .connected:
                 try await enableOnDemand(tunnelManager: manager)

diff --git a/...kProtection/NetworkExtensionTargets/NetworkExtensionTargets/MacPacketTunnelProvider.swift b/...kProtection/NetworkExtensionTargets/NetworkExtensionTargets/MacPacketTunnelProvider.swift
@@ -238,7 +238,6 @@ final class MacPacketTunnelProvider: PacketTunnelProvider {
                    providerEvents: Self.packetTunnelProviderEvents,
                    settings: settings)
 
-        observeConnectionStatusChanges()
         observeServerChanges()
         observeStatusUpdateRequests()
     }
@@ -247,12 +246,11 @@ final class MacPacketTunnelProvider: PacketTunnelProvider {
 
     /// Observe connection status changes to broadcast those changes through distributed notifications.
     ///
-    private func observeConnectionStatusChanges() {
-        connectionStatusPublisher.sink { [weak self] status in
-            self?.lastStatusChangeDate = Date()
-            self?.broadcast(status)
-        }
-        .store(in: &cancellables)
+    public override func handleConnectionStatusChange(old: ConnectionStatus, new: ConnectionStatus) {
+        super.handleConnectionStatusChange(old: old, new: new)
+
+        lastStatusChangeDate = Date()
+        broadcast(new)
     }
 
     /// Observe server changes to broadcast those changes through distributed notifications.
@@ -271,8 +269,12 @@ final class MacPacketTunnelProvider: PacketTunnelProvider {
     ///
     private func observeStatusUpdateRequests() {
         notificationCenter.publisher(for: .requestStatusUpdate).sink { [weak self] _ in
-            self?.broadcastConnectionStatus()
-            self?.broadcastLastSelectedServerInfo()
+            guard let self else { return }
+
+            Task { @MainActor in
+                self.broadcastConnectionStatus()
+                self.broadcastLastSelectedServerInfo()
+            }
         }
         .store(in: &cancellables)
     }
@@ -281,6 +283,7 @@ final class MacPacketTunnelProvider: PacketTunnelProvider {
 
     /// Broadcasts the current connection status.
     ///
+    @MainActor
     private func broadcastConnectionStatus() {
         broadcast(connectionStatus)
     }

diff --git a/LocalPackages/DataBrokerProtection/Package.swift b/LocalPackages/DataBrokerProtection/Package.swift
@@ -29,7 +29,7 @@ let package = Package(
             targets: ["DataBrokerProtection"])
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
         .package(path: "../PixelKit"),
         .package(path: "../SwiftUIExtensions"),
         .package(path: "../XPCHelper")

diff --git a/LocalPackages/LoginItems/Package.swift b/LocalPackages/LoginItems/Package.swift
@@ -13,7 +13,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         .target(

diff --git a/LocalPackages/NetworkProtectionMac/Package.swift b/LocalPackages/NetworkProtectionMac/Package.swift
@@ -31,7 +31,7 @@ let package = Package(
         .library(name: "NetworkProtectionUI", targets: ["NetworkProtectionUI"])
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
         .package(path: "../XPCHelper"),
         .package(path: "../SwiftUIExtensions"),
         .package(path: "../LoginItems")

diff --git a/LocalPackages/PixelKit/Package.swift b/LocalPackages/PixelKit/Package.swift
@@ -20,7 +20,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         .target(

diff --git a/LocalPackages/SubscriptionUI/Package.swift b/LocalPackages/SubscriptionUI/Package.swift
@@ -12,7 +12,7 @@ let package = Package(
             targets: ["SubscriptionUI"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
         .package(path: "../SwiftUIExtensions")
     ],
     targets: [

diff --git a/LocalPackages/SwiftUIExtensions/Package.swift b/LocalPackages/SwiftUIExtensions/Package.swift
@@ -11,7 +11,7 @@ let package = Package(
         .library(name: "PreferencesViews", targets: ["PreferencesViews"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         .target(

diff --git a/LocalPackages/SyncUI/Package.swift b/LocalPackages/SyncUI/Package.swift
@@ -14,7 +14,7 @@ let package = Package(
     ],
     dependencies: [
         .package(path: "../SwiftUIExtensions"),
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         .target(

diff --git a/LocalPackages/SystemExtensionManager/Package.swift b/LocalPackages/SystemExtensionManager/Package.swift
@@ -16,7 +16,7 @@ let package = Package(
         ),
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         // Targets are the basic building blocks of a package, defining a module or a test suite.

diff --git a/LocalPackages/XPCHelper/Package.swift b/LocalPackages/XPCHelper/Package.swift
@@ -30,7 +30,7 @@ let package = Package(
         .library(name: "XPCHelper", targets: ["XPCHelper"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "110.0.1"),
     ],
     targets: [
         .target(