Reduce VPN manager instances #3097

samsymons · 2024-07-17T23:20:52Z

Task/Issue URL: https://app.asana.com/0/72649045549333/1207151621945908/f
Tech Design URL:
CC:

Description:

This PR reduces the number of VPN manager instances that we create through the lifetime of the app.

Steps to test this PR:

Test that you can install and enable the VPN as expected, and that all features work
Test that removing the VPN configuration from Settings.app then returning to the VPN UI shows the VPN as disconnected, and when you try to enable it then you get prompted to install it
With the debugger connected, enable the VPN and stay on the status screen, then check that you don't see logs about the connection status once per second

Definition of Done (Internal Only):

Does this PR satisfy our Definition of Done?

Device Testing:

OS Testing:

iOS 15
iOS 16
iOS 17

Internal references:

Software Engineering Expectations
Technical Design Template

DuckDuckGo/NetworkProtectionConvenienceInitialisers.swift

DuckDuckGo/NetworkProtectionStatusViewModel.swift

DuckDuckGo/NetworkProtectionTunnelController.swift

samsymons · 2024-07-17T23:38:20Z

DuckDuckGo/NetworkProtectionTunnelController.swift

+                        if manager.connection.status == .invalid {
+                            self.clearInternalManager()
+                        }


This is the key to making sure that the shared manager is always valid. This publisher will clear it out, and the next time it's accessed then a new one will be created (assuming we have a configuration at all).

Looking good - exactly as in macOS so I'm hoping that means it won't cause trouble.

…roller.

diegoreymendez

The code changes look good, but I'm getting a crash on launch.

The issue is that AppDependencyProvider tries to instance ConnectionStatusObserverThroughSession which tries to access AppDependencyProvider.shared.

I have to say I don't love this AppDependencyProvider approach we're taking as it makes circular dependencies between singletons really hard to spot and likely to fail at runtime, like in this case.

I'm attaching the stack trace.

Thread 1 Queue - com.apple.m.zip

diegoreymendez · 2024-07-18T10:20:01Z

DuckDuckGo/NetworkProtectionTunnelController.swift

+                        if manager.connection.status == .invalid {
+                            self.clearInternalManager()
+                        }


Looking good - exactly as in macOS so I'm hoping that means it won't cause trouble.

# By Mariusz Śpiewak (2) and others # Via GitHub * main: Remove print (#3101) Update Package.resolved file (#3102) New Tab Page favorites section (#3083) Properly compare actual value of the entitlement check (#3100) fix ui tests broken by new onboarding and use shared setup flow (#3081) # Conflicts: # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

…nel controller." This reverts commit 427948a.

# By Diego Rey Mendez (1) and dependabot[bot] (1) # Via GitHub * main: Bump submodules/privacy-reference-tests from `a242bf0` to `afb4f61` (#3096) Updates BSK to 171.2.3 # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

samsymons · 2024-07-19T03:11:39Z

DuckDuckGoTests/MockDependencyProvider.swift

@@ -46,6 +46,7 @@ class MockDependencyProvider: DependencyProvider {
    var networkProtectionKeychainTokenStore: NetworkProtectionKeychainTokenStore
    var networkProtectionTunnelController: NetworkProtectionTunnelController
    var connectionObserver: NetworkProtection.ConnectionStatusObserver
+    var serverInfoObserver: NetworkProtection.ConnectionServerInfoObserver


We need to keep an instance of this alive from the very beginning so that it can listen for connection changes. Otherwise, when we enter the VPN UI, we won't have any server info to display.

diegoreymendez

Works great!

Task/Issue URL: https://app.asana.com/0/72649045549333/1207151621945908/f iOS PR: duckduckgo/iOS#3097 macOS PR: duckduckgo/macos-browser#2989 What kind of version bump will this require?: Major Description: This PR removes connection utilities that haven't been used on macOS for a while, but were still used on iOS. These are now unused on iOS as well, so they're being removed.

# By Daniel Bernal (2) and others # Via GitHub * main: Update BSK for Mac RMF changes (#3107) [DuckPlayer] 7- Open Settings (#3110) [DuckPlayer] 6 - Init updates and Watch on YouTube (#3066) New Tab Page Shortcuts section (#3104) Fix VPN configuration removal to stop the tunnel (#3099) avoid resizing webview when keyboard shows/hides (#3094) Add support for skipping sending usage pixels for remote messages (#3106) # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

# By Christopher Brind (9) and others # Via Chris Brind (1) and GitHub (1) * main: (48 commits) Reduce VPN manager instances (#3097) Update BSK for Mac RMF changes (#3107) [DuckPlayer] 7- Open Settings (#3110) [DuckPlayer] 6 - Init updates and Watch on YouTube (#3066) New Tab Page Shortcuts section (#3104) Fix VPN configuration removal to stop the tunnel (#3099) avoid resizing webview when keyboard shows/hides (#3094) Add support for skipping sending usage pixels for remote messages (#3106) Bump submodules/privacy-reference-tests from `a242bf0` to `afb4f61` (#3096) Updates BSK to 171.2.3 Remove print (#3101) Update Package.resolved file (#3102) New Tab Page favorites section (#3083) Properly compare actual value of the entitlement check (#3100) fix ui tests broken by new onboarding and use shared setup flow (#3081) AdHoc lane: Make proper assignment to variable (#3095) Expand AdHoc build workflow, add debug bookmarks screen (#3086) Update BSK to latest - for macOS fix to AdAttribution (#3084) Revert "Fix tests" Fix tests ... # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved # DuckDuckGo/NetworkProtectionStatusViewModel.swift

# By Daniel Bernal (6) and others # Via Chris Brind (3) and others * main: (24 commits) [DuckPlayer] 10 . Move DuckPlayer init to TabManager (#3124) Fix threading issue with Mesage broker (#3132) [Duckplayer] - 9. Edge Cases (#3115) Release 7.130.0-2 (#3134) Internal update for: fix index out-of-bounds in startAttachingCrashLogMessages (#3123) (#3128) Attach params to PPro pixels (#3092) Don't show key icon for empty passwords (#3070) Release 7.129.1-0 (#3127) fix index out-of-bounds in startAttachingCrashLogMessages (#3123) Release 7.130.0-1 (#3122) Revert old Dax icon for old onboarding (#3085) Scroll to Internal User setting (#3114) Release 7.130.0-0 (#3118) Allow activating subscription for internal users via debug menu (#3117) Update breakage report locale to JSON format (#3112) [Duckplayer] 8. Age restricted videos (#3111) Reduce VPN manager instances (#3097) Update BSK for Mac RMF changes (#3107) [DuckPlayer] 7- Open Settings (#3110) [DuckPlayer] 6 - Init updates and Watch on YouTube (#3066) ... # Conflicts: # DuckDuckGo/DuckPlayer/DuckPlayerNavigationHandler.swift

samsymons added 3 commits July 17, 2024 15:15

Re-use the tunnel controller manager more effectively.

4c2e53e

Use the shared tunnel controller for accessing the session.

b80838c

Use BSK branch.

a75cb47

samsymons requested a review from diegoreymendez July 17, 2024 23:20

samsymons mentioned this pull request Jul 17, 2024

Remove unused VPN session utilities duckduckgo/BrowserServicesKit#898

Merged

6 tasks

samsymons commented Jul 17, 2024

View reviewed changes

DuckDuckGo/NetworkProtectionConvenienceInitialisers.swift Show resolved Hide resolved

samsymons commented Jul 17, 2024

View reviewed changes

DuckDuckGo/NetworkProtectionStatusViewModel.swift Show resolved Hide resolved

samsymons commented Jul 17, 2024

View reviewed changes

DuckDuckGo/NetworkProtectionTunnelController.swift Show resolved Hide resolved

samsymons commented Jul 17, 2024

View reviewed changes

Remove DefaultTunnelSessionProvider in favor of using the tunnel cont…

427948a

…roller.

diegoreymendez reviewed Jul 18, 2024

View reviewed changes

samsymons added 6 commits July 18, 2024 08:45

Revert "Remove DefaultTunnelSessionProvider in favor of using the tun…

94d77fa

…nel controller." This reverts commit 427948a.

Fix async warning.

bd1fae3

Update the VPN view model state when viewing the status UI.

f6cfa31

Replace server info observer solution with something cleaner.

8aafbfd

samsymons commented Jul 19, 2024

View reviewed changes

samsymons requested a review from diegoreymendez July 19, 2024 03:14

diegoreymendez approved these changes Jul 19, 2024

View reviewed changes

samsymons added 2 commits July 19, 2024 10:16

Set BSK to 174.0.0.

6ce8f8b

samsymons merged commit ba71738 into main Jul 19, 2024
14 checks passed

samsymons deleted the sam/reduce-vpn-manager-instances branch July 19, 2024 17:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reduce VPN manager instances #3097

Reduce VPN manager instances #3097

samsymons commented Jul 17, 2024 •

edited

Loading

samsymons Jul 17, 2024

diegoreymendez Jul 18, 2024

diegoreymendez left a comment •

edited

Loading

diegoreymendez Jul 18, 2024

samsymons Jul 19, 2024

diegoreymendez left a comment

Reduce VPN manager instances #3097

Reduce VPN manager instances #3097

Conversation

samsymons commented Jul 17, 2024 • edited Loading

Internal references:

samsymons Jul 17, 2024

Choose a reason for hiding this comment

diegoreymendez Jul 18, 2024

Choose a reason for hiding this comment

diegoreymendez left a comment • edited Loading

Choose a reason for hiding this comment

diegoreymendez Jul 18, 2024

Choose a reason for hiding this comment

samsymons Jul 19, 2024

Choose a reason for hiding this comment

diegoreymendez left a comment

Choose a reason for hiding this comment

samsymons commented Jul 17, 2024 •

edited

Loading

diegoreymendez left a comment •

edited

Loading