Add NetP widget

.github/workflows/alpha.yml

@@ -74,8 +74,9 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-spm-
 
+      # Using Xcode 15 as the alpha build uses iOS 17 APIs
     - name: Select Xcode
-      run: sudo xcode-select -s /Applications/Xcode_$(<.xcode-version).app/Contents/Developer
+      run: sudo xcode-select -s /Applications/Xcode_15.0.1.app/Contents/Developer
 
     - name: Prepare fastlane
       run: bundle install

Core/AppDeepLinkSchemes.swift

@@ -31,6 +31,8 @@ public enum AppDeepLinkSchemes: String, CaseIterable {
 
     case addFavorite = "ddgAddFavorite"
 
+    case openVPN = "ddgOpenVPN"
+
     public var url: URL {
         URL(string: rawValue + "://")!
     }

Core/UserDefaults+NetworkProtection.swift

@@ -31,4 +31,10 @@ public extension UserDefaults {
     }
 }
 
+public enum NetworkProtectionUserDefaultKeys {
+
+    public static let lastSelectedServer = "com.duckduckgo.network-protection.last-selected-server"
+
+}
+
 #endif

DuckDuckGo.xcodeproj/project.pbxproj

@@ -271,6 +271,8 @@
 		4B470EE4299C6DFB0086EBDC /* Core.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = F143C2E41E4A4CD400CFDE3A /* Core.framework */; };
 		4B52648B25F9613B00CB4C24 /* trackerData.json in Resources */ = {isa = PBXBuildFile; fileRef = 4B52648A25F9613B00CB4C24 /* trackerData.json */; };
 		4B53648A26718D0E001AA041 /* EmailWaitlist.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B53648926718D0E001AA041 /* EmailWaitlist.swift */; };
+		4B5C462A2AF2A6E6002A4432 /* VPNIntents.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B5C46292AF2A6E6002A4432 /* VPNIntents.swift */; };
+		4B5C462B2AF2BDC4002A4432 /* VPNIntents.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B5C46292AF2A6E6002A4432 /* VPNIntents.swift */; };
 		4B60AC97252EC07B00E8D219 /* fullscreenvideo.js in Resources */ = {isa = PBXBuildFile; fileRef = 4B60AC96252EC07B00E8D219 /* fullscreenvideo.js */; };
 		4B60ACA1252EC0B100E8D219 /* FullScreenVideoUserScript.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B60ACA0252EC0B100E8D219 /* FullScreenVideoUserScript.swift */; };
 		4B62C4BA25B930DD008912C6 /* AppConfigurationFetchTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B62C4B925B930DD008912C6 /* AppConfigurationFetchTests.swift */; };
@@ -287,6 +289,7 @@
 		4B83397329AFB8D2003F7EA9 /* AppTrackingProtectionFeedbackModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B83397229AFB8D2003F7EA9 /* AppTrackingProtectionFeedbackModel.swift */; };
 		4B83397529AFBCE6003F7EA9 /* AppTrackingProtectionFeedbackModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4B83397429AFBCE6003F7EA9 /* AppTrackingProtectionFeedbackModelTests.swift */; };
 		4B948E2629DCCDB9002531FA /* Persistence in Frameworks */ = {isa = PBXBuildFile; productRef = 4B948E2529DCCDB9002531FA /* Persistence */; };
+		4BB7CBB02AF59C310014A35F /* VPNWidget.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4BB7CBAF2AF59C310014A35F /* VPNWidget.swift */; };
 		4BC21A2F27238B7500229F0E /* RunLoopExtensionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4BC21A2C272388BD00229F0E /* RunLoopExtensionTests.swift */; };
 		4BC6DD1C2A60E6AD001EC129 /* ReportBrokenSiteView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4BC6DD1B2A60E6AD001EC129 /* ReportBrokenSiteView.swift */; };
 		4BE2756827304F57006B20B0 /* URLRequestExtension.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4BE27566272F878F006B20B0 /* URLRequestExtension.swift */; };
@@ -1282,6 +1285,7 @@
 		4B470EE2299C6DD10086EBDC /* AppTrackingProtectionStoringModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppTrackingProtectionStoringModel.swift; sourceTree = "<group>"; };
 		4B52648A25F9613B00CB4C24 /* trackerData.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = trackerData.json; sourceTree = "<group>"; };
 		4B53648926718D0E001AA041 /* EmailWaitlist.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmailWaitlist.swift; sourceTree = "<group>"; };
+		4B5C46292AF2A6E6002A4432 /* VPNIntents.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VPNIntents.swift; sourceTree = "<group>"; };
 		4B60AC96252EC07B00E8D219 /* fullscreenvideo.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; path = fullscreenvideo.js; sourceTree = "<group>"; };
 		4B60ACA0252EC0B100E8D219 /* FullScreenVideoUserScript.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FullScreenVideoUserScript.swift; sourceTree = "<group>"; };
 		4B62C4B925B930DD008912C6 /* AppConfigurationFetchTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppConfigurationFetchTests.swift; sourceTree = "<group>"; };
@@ -1296,6 +1300,7 @@
 		4B83397029AC18C9003F7EA9 /* AppTrackingProtectionStoringModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppTrackingProtectionStoringModelTests.swift; sourceTree = "<group>"; };
 		4B83397229AFB8D2003F7EA9 /* AppTrackingProtectionFeedbackModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppTrackingProtectionFeedbackModel.swift; sourceTree = "<group>"; };
 		4B83397429AFBCE6003F7EA9 /* AppTrackingProtectionFeedbackModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppTrackingProtectionFeedbackModelTests.swift; sourceTree = "<group>"; };
+		4BB7CBAF2AF59C310014A35F /* VPNWidget.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VPNWidget.swift; sourceTree = "<group>"; };
 		4BC21A2C272388BD00229F0E /* RunLoopExtensionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunLoopExtensionTests.swift; sourceTree = "<group>"; };
 		4BC6DD1B2A60E6AD001EC129 /* ReportBrokenSiteView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ReportBrokenSiteView.swift; sourceTree = "<group>"; };
 		4BE27566272F878F006B20B0 /* URLRequestExtension.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = URLRequestExtension.swift; path = ../DuckDuckGo/URLRequestExtension.swift; sourceTree = "<group>"; };
@@ -3379,6 +3384,14 @@
 			name = AppTrackingProtection;
 			sourceTree = "<group>";
 		};
+		4B5C46282AF2A6DB002A4432 /* Intents */ = {
+			isa = PBXGroup;
+			children = (
+				4B5C46292AF2A6E6002A4432 /* VPNIntents.swift */,
+			);
+			name = Intents;
+			sourceTree = "<group>";
+		};
 		4B6484F427FD1E390050A7A1 /* Waitlist */ = {
 			isa = PBXGroup;
 			children = (
@@ -3686,6 +3699,7 @@
 				8512EA5324ED30D20073EE19 /* Widgets.swift */,
 				853273AF24FEFE4600E3C778 /* WidgetsExtension.entitlements */,
 				853273A924FEF24300E3C778 /* WidgetViews.swift */,
+				4BB7CBAF2AF59C310014A35F /* VPNWidget.swift */,
 			);
 			path = Widgets;
 			sourceTree = "<group>";
@@ -4473,6 +4487,7 @@
 		EECD94B22A28B8580085C66E /* NetworkProtection */ = {
 			isa = PBXGroup;
 			children = (
+				4B5C46282AF2A6DB002A4432 /* Intents */,
 				EE9D68D62AE1527F00B55EF4 /* VPNNotifications */,
 				EE9D68CF2AE00CE000B55EF4 /* VPNSettings */,
 				EE458D122ABB651500FC651A /* Debug */,
@@ -6416,6 +6431,7 @@
 				020108A729A6ABF600644F9D /* AppTPToggleView.swift in Sources */,
 				02A54A982A093126000C8FED /* AppTPHomeViewModel.swift in Sources */,
 				F1617C191E573EA800DEDCAF /* TabSwitcherDelegate.swift in Sources */,
+				4B5C462A2AF2A6E6002A4432 /* VPNIntents.swift in Sources */,
 				310742A62848CD780012660B /* BackForwardMenuHistoryItem.swift in Sources */,
 				858566FB252E55D6007501B8 /* ImageCacheDebugViewController.swift in Sources */,
 				0290472E29E99A2F0008FE3C /* GenericIconView.swift in Sources */,
@@ -6645,6 +6661,8 @@
 				853273B324FF114700E3C778 /* DeepLinks.swift in Sources */,
 				853273B424FFB36100E3C778 /* UIColorExtension.swift in Sources */,
 				853273AB24FEF27500E3C778 /* WidgetViews.swift in Sources */,
+				4B5C462B2AF2BDC4002A4432 /* VPNIntents.swift in Sources */,
+				4BB7CBB02AF59C310014A35F /* VPNWidget.swift in Sources */,
 				8512EA5424ED30D20073EE19 /* Widgets.swift in Sources */,
 				85DB12EB2A1FE2A4000A4A72 /* LockScreenWidgets.swift in Sources */,
 				8544C37C250B827300A0FE73 /* UserText.swift in Sources */,
@@ -8477,7 +8495,7 @@
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
-				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "DEBUG NETWORK_PROTECTION";
+				SWIFT_ACTIVE_COMPILATION_CONDITIONS = "DEBUG NETWORK_PROTECTION ALPHA";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALID_ARCHS = "$(ARCHS_STANDARD_64_BIT)";

DuckDuckGo/AppDelegate+AppDeepLinks.swift

@@ -22,6 +22,7 @@ import Core
 
 extension AppDelegate {
 
+    // swiftlint:disable:next cyclomatic_complexity
     func handleAppDeepLink(_ app: UIApplication, _ mainViewController: MainViewController?, _ url: URL) -> Bool {
         guard let mainViewController else { return false }
 
@@ -50,6 +51,11 @@ extension AppDelegate {
         case .newEmail:
             mainViewController.newEmailAddress()
 
+        case .openVPN:
+#if NETWORK_PROTECTION
+            presentNetworkProtectionStatusSettingsModal()
+#endif
+
         default:
             guard app.applicationState == .active,
                   let currentTab = mainViewController.currentTab else {

DuckDuckGo/AppDelegate.swift

@@ -536,7 +536,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         }
 
         NotificationCenter.default.post(name: AutofillLoginListAuthenticator.Notifications.invalidateContext, object: nil)
-        mainViewController?.clearNavigationStack()
+        // mainViewController?.clearNavigationStack()
         autoClear?.applicationWillMoveToForeground()
         showKeyboardIfSettingOn = false
 
@@ -784,7 +784,7 @@ extension AppDelegate: UNUserNotificationCenterDelegate {
     }
 
 #if NETWORK_PROTECTION
-    private func presentNetworkProtectionStatusSettingsModal() {
+    func presentNetworkProtectionStatusSettingsModal() {
         if #available(iOS 15, *) {
             let networkProtectionRoot = NetworkProtectionRootViewController()
             presentSettings(with: networkProtectionRoot)

DuckDuckGo/NetworkProtectionStatusViewModel.swift

@@ -22,6 +22,7 @@
 import Foundation
 import Combine
 import NetworkProtection
+import WidgetKit
 
 final class NetworkProtectionStatusViewModel: ObservableObject {
     private static var dateFormatter: DateComponentsFormatter = {
@@ -57,7 +58,11 @@ final class NetworkProtectionStatusViewModel: ObservableObject {
 
     // MARK: Toggle Item
     @Published public var isNetPEnabled = false
-    @Published public var statusMessage: String
+    @Published public var statusMessage: String {
+        didSet {
+            WidgetCenter.shared.reloadTimelines(ofKind: "VPNStatusWidget")
+        }
+    }
     @Published public var shouldDisableToggle: Bool = false
 
     // MARK: Connection Details
@@ -178,6 +183,8 @@ final class NetworkProtectionStatusViewModel: ObservableObject {
         } else {
             await disableNetP()
         }
+
+        WidgetCenter.shared.reloadTimelines(ofKind: "VPNStatusWidget")
     }
 
     @MainActor

DuckDuckGo/VPNIntents.swift

@@ -0,0 +1,102 @@
+//
+//  VPNIntents.swift
+//  DuckDuckGo
+//
+//  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 AppIntents
+import NetworkExtension
+import WidgetKit
+
+@available(iOS 17.0, *)
+struct DisableVPNIntent: AppIntent {
+
+    static let title: LocalizedStringResource = "Disable VPN"
+    static let description: LocalizedStringResource = "Disables the DuckDuckGo VPN"
+    static let openAppWhenRun: Bool = false
+
+    @MainActor
+    func perform() async throws -> some IntentResult {
+        do {
+            let managers = try await NETunnelProviderManager.loadAllFromPreferences()
+            guard let manager = managers.first else {
+                return .result()
+            }
+
+            manager.isOnDemandEnabled = false
+            try await manager.saveToPreferences()
+            manager.connection.stopVPNTunnel()
+
+            WidgetCenter.shared.reloadTimelines(ofKind: "VPNStatusWidget")
+            var iterations = 0
+
+            while iterations <= 10 {
+                try? await Task.sleep(interval: .seconds(0.5))
+
+                if manager.connection.status == .disconnected {
+                    return .result()
+                }
+
+                iterations += 1
+            }
+
+            return .result()
+        } catch {
+            return .result()
+        }
+    }
+
+}
+
+@available(iOS 17.0, *)
+struct EnableVPNIntent: AppIntent {
+
+    static let title: LocalizedStringResource = "Enable VPN"
+    static let description: LocalizedStringResource = "Enables the DuckDuckGo VPN"
+    static let openAppWhenRun: Bool = false
+
+    @MainActor
+    func perform() async throws -> some IntentResult {
+        do {
+            let managers = try await NETunnelProviderManager.loadAllFromPreferences()
+            guard let manager = managers.first else {
+                return .result()
+            }
+
+            manager.isOnDemandEnabled = true
+            try await manager.saveToPreferences()
+            try manager.connection.startVPNTunnel()
+
+            WidgetCenter.shared.reloadTimelines(ofKind: "VPNStatusWidget")
+            var iterations = 0
+
+            while iterations <= 10 {
+                try? await Task.sleep(interval: .seconds(0.5))
+
+                if manager.connection.status == .connected {
+                    return .result()
+                }
+
+                iterations += 1
+            }
+
+            return .result()
+        } catch {
+            return .result()
+        }
+    }
+
+}

PacketTunnelProvider/NetworkProtection/NetworkProtectionPacketTunnelProvider.swift

@@ -20,15 +20,18 @@
 #if NETWORK_PROTECTION
 
 import Foundation
-import NetworkProtection
 import Common
+import Combine
 import Core
 import Networking
 import NetworkExtension
+import NetworkProtection
 
 // Initial implementation for initial Network Protection tests. Will be fleshed out with https://app.asana.com/0/1203137811378537/1204630829332227/f
 final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
 
+    private var cancellables = Set<AnyCancellable>()
+
     // MARK: - PacketTunnelProvider.Event reporting
 
     private static var packetTunnelProviderEvents: EventMapping<PacketTunnelProvider.Event> = .init { event, _, _, _ in
@@ -183,6 +186,7 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
                    debugEvents: Self.networkProtectionDebugEvents(controllerErrorStore: errorStore),
                    providerEvents: Self.packetTunnelProviderEvents)
         startMonitoringMemoryPressureEvents()
+        observeServerChanges()
         APIRequest.Headers.setUserAgent(DefaultUserAgentManager.duckDuckGoUserAgent)
     }
 
@@ -209,6 +213,14 @@ final class NetworkProtectionPacketTunnelProvider: PacketTunnelProvider {
             source.resume()
         }
     }
+
+    private func observeServerChanges() {
+        lastSelectedServerInfoPublisher.sink { server in
+            let location = server?.serverLocation ?? "Unknown Location"
+            UserDefaults.networkProtectionGroupDefaults.set(location, forKey: NetworkProtectionUserDefaultKeys.lastSelectedServer)
+        }
+        .store(in: &cancellables)
+    }
 }
 
 #endif

Widgets/Assets.xcassets/DeprecatedColors/VPNWidgetConnectedColor.colorset/Contents.json

@@ -0,0 +1,20 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "srgb",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0xE7",
+          "green" : "0x68",
+          "red" : "0x44"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Widgets/Assets.xcassets/vpn-off.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "vpn-off.pdf",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Widgets/Assets.xcassets/vpn-on.imageset/Contents.json

@@ -0,0 +1,12 @@
+{
+  "images" : [
+    {
+      "filename" : "vpn-on.pdf",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Widgets/DeepLinks.swift

@@ -29,4 +29,5 @@ struct DeepLinks {
 
     static let addFavorite = AppDeepLinkSchemes.addFavorite.url
 
+    static let openVPN = AppDeepLinkSchemes.openVPN.url
 }