VPN screen improvements #3: Data volume + Menu items

DuckDuckGo.xcodeproj/project.pbxproj

@@ -14568,7 +14568,7 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/duckduckgo/BrowserServicesKit";
 			requirement = {
-				branch = "anh/netp/location-selection";
+				branch = "anh/netp/screen-improvements";
 				kind = branch;
 			};
 		};

DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/BrowserServicesKit",
       "state" : {
-        "branch" : "anh/netp/location-selection",
-        "revision" : "dc6725de9e7019ef7e2b0bb7438b9d98010808f8"
+        "branch" : "anh/netp/screen-improvements",
+        "revision" : "3b354a70cdfff5d46d2c8f525748dee63a36ad88"
       }
     },
     {

DuckDuckGo/Application/URLEventHandler.swift

@@ -145,6 +145,8 @@ final class URLEventHandler {
             WindowControllersManager.shared.showPreferencesTab(withSelectedPane: .vpn)
         case AppLaunchCommand.shareFeedback.launchURL:
             WindowControllersManager.shared.showShareFeedbackModal()
+        case AppLaunchCommand.justOpen.launchURL:
+            WindowControllersManager.shared.showNewWindow()
         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 Feedback' in the VPN status view that's shown in the navigation bar
+    static let networkProtectionNavBarStatusViewShareFeedback = "Share 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."
 

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

@@ -63,6 +63,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() {}
 
     func stop() {}

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionNavBarPopoverManager.swift

@@ -32,6 +32,7 @@ protocol NetworkProtectionIPCClient {
     var ipcStatusObserver: ConnectionStatusObserver { get }
     var ipcServerInfoObserver: ConnectionServerInfoObserver { get }
     var ipcConnectionErrorObserver: ConnectionErrorObserver { get }
+    var ipcDataVolumeObserver: DataVolumeObserver { get }
 
     func start()
     func stop()
@@ -41,6 +42,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 {
@@ -69,7 +71,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

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,6 +237,13 @@ extension WindowControllersManager {
         }
     }
 
+    func showNewWindow() {
+        guard WindowControllersManager.shared.lastKeyMainWindowController == nil else { return }
+        let tabCollection = TabCollection(tabs: [])
+        let tabCollectionViewModel = TabCollectionViewModel(tabCollection: tabCollection)
+        _ = WindowsManager.openNewWindow(with: tabCollectionViewModel)
+    }
+
     func showLocationPickerSheet() {
         let locationsViewController = VPNLocationsHostingViewController()
         let locationsWindowController = locationsViewController.wrappedInWindowController()

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 Feedback…", comment: "The status menu 'Share 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

@@ -187,12 +187,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
         )
     }()
 
@@ -245,12 +251,12 @@ 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,

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 Feedback…", comment: "The status menu 'Share Feedback' menu item")
 }

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionIPC/Observers/DataVolumeObserverThroughIPC.swift

@@ -0,0 +1,40 @@
+//
+//  DataVolumeObserverThroughIPC.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 Combine
+import Foundation
+import NetworkProtection
+
+public final class DataVolumeObserverThroughIPC: DataVolumeObserver {
+
+    private let subject = CurrentValueSubject<DataVolume, Never>(.init())
+
+    // MARK: - DataVolumeObserver
+
+    public lazy var publisher = subject.eraseToAnyPublisher()
+
+    public var recentValue: DataVolume {
+        subject.value
+    }
+
+    // MARK: - Publishing Updates
+
+    func publish(_ dataVolume: DataVolume) {
+        subject.send(dataVolume)
+    }
+}

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionIPC/TunnelControllerIPCClient.swift

@@ -26,6 +26,7 @@ public protocol IPCClientInterface: AnyObject {
     func errorChanged(_ error: String?)
     func serverInfoChanged(_ serverInfo: NetworkProtectionStatusServerInfo)
     func statusChanged(_ status: ConnectionStatus)
+    func dataVolumeUpdated(_ dataVolume: DataVolume)
 }
 
 /// This is the XPC interface with parameters that can be packed properly
@@ -34,6 +35,7 @@ protocol XPCClientInterface {
     func errorChanged(error: String?)
     func serverInfoChanged(payload: Data)
     func statusChanged(payload: Data)
+    func dataVolumeUpdated(payload: Data)
 }
 
 public final class TunnelControllerIPCClient {
@@ -47,6 +49,7 @@ public final class TunnelControllerIPCClient {
     public var serverInfoObserver = ConnectionServerInfoObserverThroughIPC()
     public var connectionErrorObserver = ConnectionErrorObserverThroughIPC()
     public var connectionStatusObserver = ConnectionStatusObserverThroughIPC()
+    public var dataVolumeObserver = DataVolumeObserverThroughIPC()
 
     /// The delegate.
     ///
@@ -65,7 +68,8 @@ public final class TunnelControllerIPCClient {
             clientDelegate: self.clientDelegate,
             serverInfoObserver: self.serverInfoObserver,
             connectionErrorObserver: self.connectionErrorObserver,
-            connectionStatusObserver: self.connectionStatusObserver
+            connectionStatusObserver: self.connectionStatusObserver,
+            dataVolumeObserver: self.dataVolumeObserver
         )
 
         xpc = XPCClient(
@@ -97,15 +101,18 @@ private final class TunnelControllerXPCClientDelegate: XPCClientInterface {
     let serverInfoObserver: ConnectionServerInfoObserverThroughIPC
     let connectionErrorObserver: ConnectionErrorObserverThroughIPC
     let connectionStatusObserver: ConnectionStatusObserverThroughIPC
+    let dataVolumeObserver: DataVolumeObserverThroughIPC
 
     init(clientDelegate: IPCClientInterface?,
          serverInfoObserver: ConnectionServerInfoObserverThroughIPC,
          connectionErrorObserver: ConnectionErrorObserverThroughIPC,
-         connectionStatusObserver: ConnectionStatusObserverThroughIPC) {
+         connectionStatusObserver: ConnectionStatusObserverThroughIPC,
+         dataVolumeObserver: DataVolumeObserverThroughIPC) {
         self.clientDelegate = clientDelegate
         self.serverInfoObserver = serverInfoObserver
         self.connectionErrorObserver = connectionErrorObserver
         self.connectionStatusObserver = connectionStatusObserver
+        self.dataVolumeObserver = dataVolumeObserver
     }
 
     func errorChanged(error: String?) {
@@ -130,6 +137,15 @@ private final class TunnelControllerXPCClientDelegate: XPCClientInterface {
         connectionStatusObserver.publish(status)
         clientDelegate?.statusChanged(status)
     }
+
+    func dataVolumeUpdated(payload: Data) {
+        guard let dataVolume = try? JSONDecoder().decode(DataVolume.self, from: payload) else {
+            return
+        }
+
+        dataVolumeObserver.publish(dataVolume)
+        clientDelegate?.dataVolumeUpdated(dataVolume)
+    }
 }
 
 // MARK: - Outgoing communication to the server

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionIPC/TunnelControllerIPCServer.swift

@@ -135,6 +135,20 @@ extension TunnelControllerIPCServer: IPCClientInterface {
             client.statusChanged(payload: payload)
         }
     }
+
+    public func dataVolumeUpdated(_ dataVolume: DataVolume) {
+        let payload: Data
+
+        do {
+            payload = try JSONEncoder().encode(dataVolume)
+        } catch {
+            return
+        }
+
+        xpc.forEachClient { client in
+            client.dataVolumeUpdated(payload: payload)
+        }
+    }
 }
 
 // MARK: - Incoming communication from a client

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionUI/NetworkProtectionAsset.swift

@@ -19,12 +19,12 @@
 import Foundation
 
 public enum NetworkProtectionAsset: String, CaseIterable {
-    case ipAddressIcon = "IP-16"
-    case serverLocationIcon = "Server-Location-16"
     case vpnDisabledImage = "VPNDisabled"
     case vpnEnabledImage = "VPN"
     case vpnIcon = "VPN-16"
     case nearestAvailable = "VPNLocation"
+    case dataReceived = "VPNDownload"
+    case dataSent = "VPNUpload"
 
     // Apple Icons
     case appleVaultIcon = "apple-vault-icon"

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionUI/NetworkProtectionColor.swift

@@ -31,6 +31,7 @@ extension Color {
 ///
 enum NetworkProtectionColor: String {
     case defaultText = "TextColor"
+    case secondaryText = "SecondaryColor"
     case linkColor = "LinkBlueColor"
     case onboardingButtonBackgroundColor = "OnboardingButtonBackgroundColor"
 #if swift(<5.9)

LocalPackages/NetworkProtectionMac/Sources/NetworkProtectionUI/Resources/Assets.xcassets/Colors/SecondaryColor.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "0.600",
+          "blue" : "0x00",
+          "green" : "0x00",
+          "red" : "0x00"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "0.500",
+          "blue" : "0x00",
+          "green" : "0x00",
+          "red" : "0x00"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}