VPN screen improvements

DuckDuckGo/Application/URLEventHandler.swift

@@ -147,7 +147,7 @@ final class URLEventHandler {
         case AppLaunchCommand.shareFeedback.launchURL:
             WindowControllersManager.shared.showShareFeedbackModal()
         case AppLaunchCommand.justOpen.launchURL:
-            WindowControllersManager.shared.showNewWindow()
+            WindowControllersManager.shared.showMainWindow()
         case AppLaunchCommand.showVPNLocations.launchURL:
             WindowControllersManager.shared.showPreferencesTab(withSelectedPane: .vpn)
             WindowControllersManager.shared.showLocationPickerSheet()

DuckDuckGo/Common/Localizables/UserText+NetworkProtection.swift

@@ -42,8 +42,8 @@ extension UserText {
     static let networkProtectionInviteSuccessMessage = "DuckDuckGo's VPN secures all of your device's Internet traffic anytime, anywhere."
 
     // MARK: - Navigation Bar Status View
-    // "network.protection.navbar.status.view.share.feedback" - Menu item for 'Send VPN Feedback' in the VPN status view that's shown in the navigation bar
-    static let networkProtectionNavBarStatusViewShareFeedback = "Send VPN Feedback…"
+    // "network.protection.navbar.status.view.share.feedback" - Menu item for 'Share VPN Feedback' in the VPN status view that's shown in the navigation bar
+    static let networkProtectionNavBarStatusViewShareFeedback = "Share VPN Feedback…"
     // "network.protection.status.menu.vpn.settings" - The status menu 'VPN Settings' menu item
     static let networkProtectionNavBarStatusMenuVPNSettings = "VPN Settings…"
     // "network.protection.status.menu.faq" - The status menu 'FAQ' menu item
@@ -299,7 +299,7 @@ extension UserText {
     // "vpn.location.description.nearest" - Nearest city setting description
     static let vpnLocationNearest = "Nearest"
     // "vpn.location.description.nearest.available" - Nearest available location setting description
-    static let vpnLocationNearestAvailable = "Nearest available"
+    static let vpnLocationNearestAvailable = "Nearest Location"
     // "vpn.location.nearest.available.title" - Subtitle underneath the nearest available vpn location preference text.
     static let vpnLocationNearestAvailableSubtitle = "Automatically connect to the nearest server we can find."
 
@@ -330,6 +330,15 @@ extension UserText {
     static let uninstallVPNAlertTitle = "Are you sure you want to uninstall the VPN?"
     // "vpn.uninstall.alert.informative.text" - Informative text for the alert that comes up when the user decides to uninstall our VPN
     static let uninstallVPNInformativeText = "Uninstalling the DuckDuckGo VPN will disconnect the VPN and remove it from your device."
+
+    // MARK: - VPN Screen
+    // "network.protection.vpn.location.nearest" - Description of the location type in the VPN status view
+    static let netPVPNLocationNearest = "(Nearest)"
+
+    // "network.protection.vpn.location.subtitle.formatted.city.and.country" - Subtitle for the preferred location item that formats a city and country. E.g Chicago, United States
+    static func netPVPNSettingsLocationSubtitleFormattedCityAndCountry(city: String, country: String) -> String {
+        return "\(city), \(country)"
+    }
 }
 
 #if DBP

DuckDuckGo/MainWindow/MainViewController.swift

@@ -93,7 +93,8 @@ final class MainViewController: NSViewController {
                 serverInfoObserver: ipcClient.ipcServerInfoObserver,
                 connectionErrorObserver: ipcClient.ipcConnectionErrorObserver,
                 connectivityIssuesObserver: connectivityIssuesObserver,
-                controllerErrorMessageObserver: controllerErrorMessageObserver
+                controllerErrorMessageObserver: controllerErrorMessageObserver,
+                dataVolumeObserver: ipcClient.ipcDataVolumeObserver
             )
         }()
 

DuckDuckGo/NavigationBar/View/NetPPopoverManagerMock.swift

@@ -64,6 +64,12 @@ final class IPCClientMock: NetworkProtectionIPCClient {
     }
     var ipcControllerErrorMessageObserver: any NetworkProtection.ControllerErrorMesssageObserver = ControllerErrorMesssageObserverMock()
 
+    final class DataVolumeObserverMock: NetworkProtection.DataVolumeObserver {
+        var publisher: AnyPublisher<DataVolume, Never> = PassthroughSubject().eraseToAnyPublisher()
+        var recentValue: DataVolume = .init()
+    }
+    var ipcDataVolumeObserver: any NetworkProtection.DataVolumeObserver = DataVolumeObserverMock()
+
     func start(completion: @escaping (Error?) -> Void) {
         completion(nil)
     }

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionNavBarPopoverManager.swift

@@ -29,6 +29,7 @@ protocol NetworkProtectionIPCClient {
     var ipcStatusObserver: ConnectionStatusObserver { get }
     var ipcServerInfoObserver: ConnectionServerInfoObserver { get }
     var ipcConnectionErrorObserver: ConnectionErrorObserver { get }
+    var ipcDataVolumeObserver: DataVolumeObserver { get }
 
     func start(completion: @escaping (Error?) -> Void)
     func stop(completion: @escaping (Error?) -> Void)
@@ -38,6 +39,7 @@ extension TunnelControllerIPCClient: NetworkProtectionIPCClient {
     public var ipcStatusObserver: any NetworkProtection.ConnectionStatusObserver { connectionStatusObserver }
     public var ipcServerInfoObserver: any NetworkProtection.ConnectionServerInfoObserver { serverInfoObserver }
     public var ipcConnectionErrorObserver: any NetworkProtection.ConnectionErrorObserver { connectionErrorObserver }
+    public var ipcDataVolumeObserver: any NetworkProtection.DataVolumeObserver { dataVolumeObserver }
 }
 
 final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
@@ -57,7 +59,7 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
 
     // swiftlint:disable:next function_body_length
     func show(positionedBelow view: NSView, withDelegate delegate: NSPopoverDelegate) {
-        let popover = networkProtectionPopover ?? {
+        let popover = {
 
             let controller = NetworkProtectionIPCTunnelController(ipcClient: ipcClient)
 
@@ -66,7 +68,8 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
                 serverInfoObserver: ipcClient.ipcServerInfoObserver,
                 connectionErrorObserver: ipcClient.ipcConnectionErrorObserver,
                 connectivityIssuesObserver: ConnectivityIssueObserverThroughDistributedNotifications(),
-                controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications()
+                controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications(),
+                dataVolumeObserver: ipcClient.ipcDataVolumeObserver
             )
 
             let onboardingStatusPublisher = UserDefaults.netP.networkProtectionOnboardingStatusPublisher
@@ -111,6 +114,7 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
                                                    agentLoginItem: LoginItem.vpnMenu,
                                                    isMenuBarStatusView: false,
                                                    userDefaults: .netP,
+                                                   locationFormatter: DefaultVPNLocationFormatter(),
                                                    uninstallHandler: { [weak self] in
                 _ = await self?.networkProtectionFeatureDisabler.disable(keepAuthToken: false, uninstallSystemExtension: true)
             })
@@ -132,6 +136,7 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
     func toggle(positionedBelow view: NSView, withDelegate delegate: NSPopoverDelegate) {
         if let networkProtectionPopover, networkProtectionPopover.isShown {
             networkProtectionPopover.close()
+            self.networkProtectionPopover = nil
         } else {
             let featureVisibility = DefaultNetworkProtectionVisibility()
 
@@ -145,5 +150,6 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
 
     func close() {
         networkProtectionPopover?.close()
+        networkProtectionPopover = nil
     }
 }

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/VPNLocation/DefaultVPNLocationFormatter.swift

@@ -0,0 +1,104 @@
+//
+//  DefaultVPNLocationFormatter.swift
+//
+//  Copyright © 2024 DuckDuckGo. All rights reserved.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import Foundation
+import SwiftUI
+import NetworkProtection
+
+struct DefaultVPNLocationFormatter: VPNLocationFormatting {
+    func emoji(for country: String?,
+               preferredLocation someLocation: VPNSettings.SelectedLocation) -> String? {
+        if let country {
+            return NetworkProtectionVPNCountryLabelsModel(country: country, useFullCountryName: true).emoji
+        }
+
+        let preferredLocation = VPNLocationModel(selectedLocation: someLocation)
+        switch preferredLocation.icon {
+        case .defaultIcon:
+            return nil
+        case .emoji(let emoji):
+            return emoji
+        }
+    }
+
+    func string(from location: String?,
+                preferredLocation someLocation: VPNSettings.SelectedLocation) -> String {
+        let preferredLocation = VPNLocationModel(selectedLocation: someLocation)
+
+        if let location {
+            return preferredLocation.isNearest ? "\(location) (Nearest)" : location
+        }
+
+        return preferredLocation.title
+    }
+
+    @available(macOS 12, *)
+    func string(from location: String?,
+                preferredLocation someLocation: VPNSettings.SelectedLocation,
+                locationTextColor: Color,
+                preferredLocationTextColor: Color) -> AttributedString {
+        let preferredLocation = VPNLocationModel(selectedLocation: someLocation)
+
+        if let location {
+            var attributedString = AttributedString(
+                preferredLocation.isNearest ? "\(location) \(UserText.netPVPNLocationNearest)" : location
+            )
+            attributedString.foregroundColor = locationTextColor
+            if let range = attributedString.range(of: UserText.netPVPNLocationNearest) {
+                attributedString[range].foregroundColor = preferredLocationTextColor
+            }
+            return attributedString
+        }
+
+        var attributedString = AttributedString(preferredLocation.title)
+        attributedString.foregroundColor = locationTextColor
+        return attributedString
+    }
+}
+
+final class VPNLocationModel: ObservableObject {
+    enum LocationIcon {
+        case defaultIcon
+        case emoji(String)
+    }
+
+    let title: String
+    let icon: LocationIcon
+    let isNearest: Bool
+
+    init(selectedLocation: VPNSettings.SelectedLocation) {
+        switch selectedLocation {
+        case .nearest:
+            title = UserText.vpnLocationNearestAvailable
+            icon = .defaultIcon
+            isNearest = true
+        case .location(let location):
+            let countryLabelsModel = NetworkProtectionVPNCountryLabelsModel(country: location.country, useFullCountryName: true)
+            if let city = location.city {
+                title = UserText.netPVPNSettingsLocationSubtitleFormattedCityAndCountry(
+                    city: city,
+                    country: countryLabelsModel.title
+                )
+            } else {
+                title = countryLabelsModel.title
+            }
+            icon = .emoji(countryLabelsModel.emoji)
+            isNearest = false
+        }
+    }
+}

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/VPNLocation/NetworkProtectionVPNCountryLabelsModel.swift

@@ -23,8 +23,13 @@ struct NetworkProtectionVPNCountryLabelsModel {
     let emoji: String
     let title: String
 
-    init(country: String) {
-        self.title = Locale.current.localizedString(forRegionCode: country) ?? country.capitalized
+    init(country: String, useFullCountryName: Bool = true) {
+        if useFullCountryName {
+            self.title = Locale.current.localizedString(forRegionCode: country) ?? country.capitalized
+        } else {
+            self.title = country.localizedUppercase
+        }
+
         self.emoji = Self.flag(country: country)
     }
 

DuckDuckGo/VPNFeedbackForm/VPNMetadataCollector.swift

@@ -121,7 +121,8 @@ final class DefaultVPNMetadataCollector: VPNMetadataCollector {
             serverInfoObserver: ipcClient.serverInfoObserver,
             connectionErrorObserver: ipcClient.connectionErrorObserver,
             connectivityIssuesObserver: ConnectivityIssueObserverThroughDistributedNotifications(),
-            controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications()
+            controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications(),
+            dataVolumeObserver: ipcClient.dataVolumeObserver
         )
 
         // Force refresh just in case. A refresh is requested when the IPC client is created, but distributed notifications don't guarantee delivery

DuckDuckGo/Windows/View/WindowControllersManager.swift

@@ -237,7 +237,7 @@ extension WindowControllersManager {
         }
     }
 
-    func showNewWindow() {
+    func showMainWindow() {
         guard WindowControllersManager.shared.lastKeyMainWindowController == nil else { return }
         let tabCollection = TabCollection(tabs: [])
         let tabCollectionViewModel = TabCollectionViewModel(tabCollection: tabCollection)

DuckDuckGoDBPBackgroundAgent/UserText.swift

@@ -21,6 +21,6 @@ import Foundation
 final class UserText {
     // MARK: - Status Menu
 
-    static let networkProtectionStatusMenuShareFeedback = NSLocalizedString("network.protection.status.menu.share.feedback", value: "Send VPN Feedback...", comment: "The status menu 'Send VPN Feedback' menu item")
-    static let networkProtectionStatusMenuOpenDuckDuckGo = NSLocalizedString("network.protection.status.menu.open.duckduckgo", value: "Open DuckDuckGo...", comment: "The status menu 'Open DuckDuckGo' menu item")
+    static let networkProtectionStatusMenuShareFeedback = NSLocalizedString("network.protection.status.menu.share.feedback", value: "Share VPN Feedback…", comment: "The status menu 'Share VPN Feedback' menu item")
+    static let networkProtectionStatusMenuOpenDuckDuckGo = NSLocalizedString("network.protection.status.menu.open.duckduckgo", value: "Open DuckDuckGo…", comment: "The status menu 'Open DuckDuckGo' menu item")
 }

DuckDuckGoVPN/DuckDuckGoVPNAppDelegate.swift

@@ -184,12 +184,18 @@ final class DuckDuckGoVPNAppDelegate: NSObject, NSApplicationDelegate {
             platformNotificationCenter: NSWorkspace.shared.notificationCenter,
             platformDidWakeNotification: NSWorkspace.didWakeNotification)
 
+        let dataVolumeObserver = DataVolumeObserverThroughSession(
+            tunnelSessionProvider: tunnelController,
+            platformNotificationCenter: NSWorkspace.shared.notificationCenter,
+            platformDidWakeNotification: NSWorkspace.didWakeNotification)
+
         return DefaultNetworkProtectionStatusReporter(
             statusObserver: statusObserver,
             serverInfoObserver: serverInfoObserver,
             connectionErrorObserver: errorObserver,
             connectivityIssuesObserver: DisabledConnectivityIssueObserver(),
-            controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications()
+            controllerErrorMessageObserver: ControllerErrorMesssageObserverThroughDistributedNotifications(),
+            dataVolumeObserver: dataVolumeObserver
         )
     }()
 
@@ -242,17 +248,18 @@ final class DuckDuckGoVPNAppDelegate: NSObject, NSApplicationDelegate {
                     StatusBarMenu.MenuItem(name: UserText.networkProtectionStatusMenuFAQ, action: { [weak self] in
                         await self?.appLauncher.launchApp(withCommand: .showFAQ)
                     }),
+                    StatusBarMenu.MenuItem(name: UserText.networkProtectionStatusMenuShareFeedback, action: { [weak self] in
+                        await self?.appLauncher.launchApp(withCommand: .shareFeedback)
+                    }),
                     StatusBarMenu.MenuItem(name: UserText.networkProtectionStatusMenuOpenDuckDuckGo, action: { [weak self] in
                         await self?.appLauncher.launchApp(withCommand: .justOpen)
                     }),
-                    StatusBarMenu.MenuItem(name: UserText.networkProtectionStatusMenuShareFeedback, action: { [weak self] in
-                        await self?.appLauncher.launchApp(withCommand: .shareFeedback)
-                    })
                 ]
             },
             agentLoginItem: nil,
             isMenuBarStatusView: true,
             userDefaults: .netP,
+            locationFormatter: DefaultVPNLocationFormatter(),
             uninstallHandler: { [weak self] in
                 guard let self else { return }
                 await self.vpnUninstaller.uninstall(includingSystemExtension: true)

DuckDuckGoVPN/TunnelControllerIPCService.swift

@@ -50,6 +50,7 @@ final class TunnelControllerIPCService {
         subscribeToErrorChanges()
         subscribeToStatusUpdates()
         subscribeToServerChanges()
+        subscribeToDataVolumeUpdates()
 
         server.serverDelegate = self
     }
@@ -84,6 +85,15 @@ final class TunnelControllerIPCService {
             }
             .store(in: &cancellables)
     }
+
+    private func subscribeToDataVolumeUpdates() {
+        statusReporter.dataVolumeObserver.publisher
+            .subscribe(on: DispatchQueue.main)
+            .sink { [weak self] dataVolume in
+                self?.server.dataVolumeUpdated(dataVolume)
+            }
+            .store(in: &cancellables)
+    }
 }
 
 // MARK: - Requests from the client

DuckDuckGoVPN/UserText.swift

@@ -24,5 +24,5 @@ final class UserText {
     static let networkProtectionStatusMenuVPNSettings = NSLocalizedString("network.protection.status.menu.vpn.settings", value: "VPN Settings…", comment: "The status menu 'VPN Settings' menu item")
     static let networkProtectionStatusMenuFAQ = NSLocalizedString("network.protection.status.menu.faq", value: "Frequently Asked Questions…", comment: "The status menu 'FAQ' menu item")
     static let networkProtectionStatusMenuOpenDuckDuckGo = NSLocalizedString("network.protection.status.menu.vpn.open-duckduckgo", value: "Open DuckDuckGo…", comment: "The status menu 'Open DuckDuckGo' menu item")
-    static let networkProtectionStatusMenuShareFeedback = NSLocalizedString("network.protection.status.menu.share.feedback", value: "Send VPN Feedback…", comment: "The status menu 'Send VPN Feedback' menu item")
+    static let networkProtectionStatusMenuShareFeedback = NSLocalizedString("network.protection.status.menu.share.feedback", value: "Share VPN Feedback…", comment: "The status menu 'Share VPN Feedback' menu item")
 }

LocalPackages/DataBrokerProtection/Package.swift

@@ -29,7 +29,7 @@ let package = Package(
             targets: ["DataBrokerProtection"])
     ],
     dependencies: [
-        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "137.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "138.0.0"),
         .package(path: "../PixelKit"),
         .package(path: "../SwiftUIExtensions"),
         .package(path: "../XPCHelper"),

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: "137.0.0"),
+        .package(url: "https://github.com/duckduckgo/BrowserServicesKit", exact: "138.0.0"),
         .package(path: "../XPCHelper"),
         .package(path: "../SwiftUIExtensions"),
         .package(path: "../LoginItems"),