Status Menu #3: Move code to NetworkProtection package. (#52)

Task/Issue URL: https://app.asana.com/0/0/1204215685631880/f

* Adds options to simulate tunnel and controller errors for testing

* The status bar menu is now controller through the main app

* Moves several files to NetworkProtection and NetworkProtectionUI:

* Removes some files submitted by mistake

* Removes a copy of NetworkProtectionUI submitted by mistake

* Added back an empty test file to NetworkProtectionUITests

Author: diegoreymendez

DuckDuckGo.xcodeproj/project.pbxproj

@@ -16,7 +16,9 @@
 //  limitations under the License.
 //
 
+import ApplicationServices
 import Foundation
+import NetworkProtection
 import os.log
 
 final class URLEventHandler {
@@ -108,10 +110,13 @@ final class URLEventHandler {
     /// Handles NetP URLs
     ///
     private static func handleNetworkProtectionURL(_ url: URL) {
-        if url == networkProtectionShowStatusURL {
+        switch url {
+        case AppLauncher.Command.showStatus.launchURL:
             Task {
                 await WindowControllersManager.shared.showNetworkProtectionStatus()
             }
+        default:
+            return
         }
     }
 #endif

DuckDuckGo/App Delegate/URLEventHandler.swift

@@ -22,41 +22,7 @@ extension UserText {
     static let networkProtectionTunnelName = NSLocalizedString("network.protection.tunnel.name", value: "DuckDuckGo Network Protection", comment: "The name of the NetP VPN that will be visible in the system to the user")
     static let networkProtection = NSLocalizedString("network.protection", value: "Network Protection", comment: "Menu item for opening Network Protection")
 
-    // MARK: - Connection Status
-
-    static let networkProtectionStatusDisconnected = NSLocalizedString("network.protection.status.disconnected", value: "Disconnected", comment: "The label for the NetP VPN when disconnected")
-    static let networkProtectionStatusDisconnecting = NSLocalizedString("network.protection.status.disconnecting", value: "Disconnecting...", comment: "The label for the NetP VPN when disconnecting")
-    static let networkProtectionStatusConnected = NSLocalizedString("network.protection.status.connected", value: "Connected", comment: "The label for the NetP VPN when connected")
-    static let networkProtectionStatusConnecting = NSLocalizedString("network.protection.status.connected", value: "Connecting...", comment: "The label for the NetP VPN when connecting")
-    static let networkProtectionStatusUnknown = NSLocalizedString("network.protection.status.unknown", value: "Unknown", comment: "When we can't tell the user what the status of the NetP VPN is")
-
-    // MARK: - Connection Information
-
-    static let networkProtectionServerAddressUnknown = NSLocalizedString("network.protection.server.address.unknown", value: "Unknown", comment: "When we can't tell the user the IP of the NetP server is")
-    static let networkProtectionServerLocationUnknown = NSLocalizedString("network.protection.server.location.unknown", value: "Unknown", comment: "When we can't tell the user the location of the NetP server")
-
-    // MARK: - Status View
-
-    static let networkProtectionStatusViewTitle = NSLocalizedString("network.protection.status.view.title", value: "Network Protection", comment: "Title shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewFeatureDesc = NSLocalizedString("network.protection.status.view.feature.description", value: "Hide your location from websites and conceal your online activity from Internet providers and others on your network.", comment: "Feature description shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewConnLabel = NSLocalizedString("network.protection.status.view.connection.label", value: "Network Protection", comment: "Connection label shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewConnDetails = NSLocalizedString("network.protection.status.view.connection.details", value: "Connection Details", comment: "Connection details label shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewBetaWarning = NSLocalizedString("network.protection.status.view.beta.warning", value: "DuckDuckGo Network Protection is currently in beta.", comment: "Beta warning message shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewLocation = NSLocalizedString("network.protection.status.view.location", value: "Location", comment: "Location label shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewIPAddress = NSLocalizedString("network.protection.status.view.ip.address", value: "IP Address", comment: "IP Address label shown in NetworkProtection's status view.")
-    static let networkProtectionStatusViewFeatureOff = NSLocalizedString("network.protection.status.view.feature.on", value: "Network Protection is OFF", comment: "Text shown in NetworkProtection's status view when NetP is OFF.")
-    static let networkProtectionStatusViewFeatureOn = NSLocalizedString("network.protection.status.view.feature.on", value: "Network Protection is ON", comment: "Text shown in NetworkProtection's status view when NetP is ON.")
-    static let networkProtectionStatusViewTimerZero = "00:00:00"
-    static let networkProtectionStatusViewShareFeedbackPrefix = NSLocalizedString("network.protection.status.view.share.feedback.prefix", value: "Help us improve and ", comment: "Text shown in NetworkProtection's status view before 'share feedback'")
-    static let networkProtectionStatusViewShareFeedbackSuffix = NSLocalizedString("network.protection.status.view.share.feedback.suffix", value: ".", comment: "Text shown in NetworkProtection's status view after 'share feedback'")
-    static let networkProtectionStatusViewShareFeedback = NSLocalizedString("network.protection.status.view.share.feedback", value: "share feedback", comment: "Text shown in NetworkProtection's status view in a link that allows users to share feedback")
-
     // MARK: - Navigation Bar
 
     static let networkProtectionButtonTooltip = NSLocalizedString("network.protection.status.button.tooltip", value: "Network Protection", comment: "The tooltip for NetP's nav bar button")
-
-    // MARK: - Connection Issues
-
-    static let networkProtectionInterruptedReconnecting = NSLocalizedString("network.protection.interrupted.reconnecting", value: "Your Network Protection connection was interrupted. Attempting to reconnect now...", comment: "The warning message shown in NetP's status view when the connection is interrupted and its attempting to reconnect.")
-    static let networkProtectionInterrupted = NSLocalizedString("network.protection.interrupted", value: "Network Protection was unable to connect at this time. Please try again later.", comment: "The warning message shown in NetP's status view when the connection is interrupted.")
 }

DuckDuckGo/Common/Localizables/UserText+NetworkProtection.swift

@@ -21,6 +21,7 @@ import os.log
 import WebKit
 import BrowserServicesKit
 import SwiftUI
+import NetworkProtectionUI
 
 protocol OptionsButtonMenuDelegate: AnyObject {
 
@@ -94,7 +95,7 @@ final class MoreOptionsMenu: NSMenu {
 #if NETP
         addItem(withTitle: UserText.networkProtection, action: #selector(showNetworkProtectionStatus(_:)), keyEquivalent: "")
             .targetting(self)
-            .withImage(.init(.vpnIcon))
+            .withImage(.image(for: .vpnIcon))
 #endif
 
         addItem(NSMenuItem.separator())

DuckDuckGo/Navigation Bar/View/MoreOptionsMenu.swift

@@ -0,0 +1,59 @@
+//
+//  LoginItem.swift
+//
+//  Copyright © 2023 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 ServiceManagement
+
+/// Takes care of enabling and disabling a login item.
+///
+final class LoginItem {
+    private static let resetDelay = 200
+
+    let agentBundleID: String
+
+    init(agentBundleID: String) {
+        self.agentBundleID = agentBundleID
+    }
+
+    func enable() throws {
+        if #available(macOS 13.0, *) {
+            try SMAppService.loginItem(identifier: agentBundleID).register()
+        } else {
+            SMLoginItemSetEnabled(agentBundleID as CFString, true)
+        }
+    }
+
+    func disable() throws {
+        if #available(macOS 13.0, *) {
+            try SMAppService.loginItem(identifier: agentBundleID).unregister()
+        } else {
+            SMLoginItemSetEnabled(agentBundleID as CFString, false)
+        }
+    }
+
+    func reset() async throws {
+        try? disable()
+
+        if #available(macOS 13, *) {
+            try await Task.sleep(for: .milliseconds(Self.resetDelay))
+        } else {
+            try await Task.sleep(nanoseconds: UInt64(Self.resetDelay) * NSEC_PER_MSEC)
+        }
+
+        try enable()
+    }
+}

DuckDuckGo/NetworkProtection/LoginItem.swift

@@ -18,6 +18,7 @@
 
 import Foundation
 import Combine
+import NetworkProtectionUI
 
 final class NetworkProtectionIconPublisher {
 

DuckDuckGo/NetworkProtection/NetworkProtectionAgentManager.swift

@@ -19,13 +19,15 @@
 import AppKit
 import Combine
 import Foundation
+import NetworkProtection
+import NetworkProtectionUI
 
 /// Model for managing the NetP button in the Nav Bar.
 ///
 final class NetworkProtectionNavBarButtonModel: NSObject, ObservableObject {
 
     private let networkProtectionStatusReporter: NetworkProtectionStatusReporter
-    private var status: NetworkProtectionConnectionStatus = .disconnected
+    private var status: NetworkProtection.ConnectionStatus = .disconnected
     private let popovers: NavigationBarPopovers
 
     // MARK: - Subscriptions
@@ -59,7 +61,7 @@ final class NetworkProtectionNavBarButtonModel: NSObject, ObservableObject {
         self.popovers = popovers
 
         isHavingConnectivityIssues = networkProtectionStatusReporter.connectivityIssuesPublisher.value
-        buttonImage = .init(iconPublisher.icon)
+        buttonImage = .image(for: iconPublisher.icon)
 
         super.init()
 
@@ -76,7 +78,7 @@ final class NetworkProtectionNavBarButtonModel: NSObject, ObservableObject {
 
     private func setupIconSubscription() {
         iconPublisherCancellable = iconPublisher.$icon.sink { [weak self] icon in
-            self?.buttonImage = .init(icon)
+            self?.buttonImage = .image(for: icon)
         }
     }
 

DuckDuckGo/NetworkProtection/NetworkProtectionIconPublisher.swift

@@ -1,5 +1,5 @@
 //
-//  NSImage+NetworkProtection.swift
+//  NetworkProtectionProvider.swift
 //
 //  Copyright © 2022 DuckDuckGo. All rights reserved.
 //
@@ -25,17 +25,7 @@ import NetworkExtension
 import NetworkProtection
 import SystemExtensions
 
-enum NetworkProtectionConnectionStatus {
-    case notConfigured
-    case disconnected
-    case disconnecting
-    case connected(connectedDate: Date)
-    case connecting
-    case reasserting
-    case unknown
-}
-
-typealias NetworkProtectionStatusChangeHandler = (NetworkProtectionConnectionStatus) -> Void
+typealias NetworkProtectionStatusChangeHandler = (NetworkProtection.ConnectionStatus) -> Void
 typealias NetworkProtectionConfigChangeHandler = () -> Void
 
 protocol NetworkProtectionProvider: NetworkProtection.TunnelController {
@@ -314,16 +304,21 @@ final class DefaultNetworkProtectionProvider: NetworkProtectionProvider {
 
     // MARK: - Ensure things are working
 
+    private let loginItem = LoginItem(agentBundleID: "HKE973VLUW.com.duckduckgo.macos.browser.network-protection.notifications")
+
+    private func ensureLoginItemsAreEnabled() async throws {
+ #if DEBUG
+         try await loginItem.reset()
+ #else
+         try loginItem.enable()
+ #endif
+     }
+
 #if NETP_SYSTEM_EXTENSION
     /// - Returns: `true` if the system extension and the background agent were activated successfully
     ///
     private func ensureSystemExtensionAndAgentAreActivated() async throws -> Bool {
-        #if DEBUG
-        try? await NetworkProtectionAgentManager.current.reset()
-        #else
-
-        NetworkProtectionAgentManager.current.enable()
-        #endif
+        try await ensureLoginItemsAreEnabled()
 
         if case .willActivateAfterReboot = try await SystemExtensionManager.shared.activate(waitingForUserApprovalHandler: { [weak self] in
             self?.controllerErrorStore.lastErrorMessage = "Go to Security & Privacy in System Settings to allow Network Protection to activate"
@@ -454,7 +449,7 @@ final class DefaultNetworkProtectionProvider: NetworkProtectionProvider {
             }
 
 #if NETP_SYSTEM_EXTENSION
-            NetworkProtectionAgentManager.current.disable()
+            try? LoginItem(agentBundleID: "HKE973VLUW.com.duckduckgo.macos.browser.network-protection.notifications").disable()
 #endif
             NetworkProtectionSelectedServerUserDefaultsStore().reset()
         }

DuckDuckGo/NetworkProtection/NetworkProtectionNavBarButtonModel.swift

@@ -20,6 +20,7 @@ import Foundation
 import Combine
 import SwiftUI
 import NetworkProtection
+import NetworkProtectionUI
 import os.log
 
 /// Abstraction of the the Network Protection status bar menu with a simple interface.
@@ -57,14 +58,14 @@ final class NetworkProtectionStatusBarMenu {
 
         let menu = NSMenu(items: [item])
         self.statusItem.menu = menu
-        self.statusItem.button?.image = .init(iconPublisher.icon)
+        self.statusItem.button?.image = .image(for: iconPublisher.icon)
 
         subscribeToIconUpdates()
     }
 
     private func subscribeToIconUpdates() {
         iconPublisherCancellable = iconPublisher.$icon.sink { [weak self] icon in
-            self?.statusItem.button?.image = .init(icon)
+            self?.statusItem.button?.image = .image(for: icon)
         }
     }