Show VPN onboarding tips

DuckDuckGo/Application/AppDelegate.swift

@@ -463,6 +463,8 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
 
         DataBrokerProtectionAppEvents(featureGatekeeper: pirGatekeeper).applicationDidFinishLaunching()
 
+        TipKitAppEventHandler(featureFlagger: featureFlagger).appDidFinishLaunching()
+
         setUpAutoClearHandler()
 
         setUpAutofillPixelReporter()

DuckDuckGo/Menus/MainMenu.swift

@@ -723,6 +723,11 @@ final class MainMenu: NSMenu {
                                   openSubscriptionTab: { WindowControllersManager.shared.showTab(with: .subscription($0)) },
                                   subscriptionManager: Application.appDelegate.subscriptionManager)
 
+            NSMenuItem(title: "TipKit") {
+                NSMenuItem(title: "Reset", action: #selector(MainViewController.resetTipKit))
+                NSMenuItem(title: "⚠️ App restart required.", action: nil, target: nil)
+            }
+
             NSMenuItem(title: "Logging").submenu(setupLoggingMenu())
             NSMenuItem(title: "AI Chat").submenu(AIChatDebugMenu())
 

DuckDuckGo/Menus/MainMenuActions.swift

@@ -880,6 +880,10 @@ extension MainViewController {
         SyncPromoManager().resetPromos()
     }
 
+    @objc func resetTipKit(_ sender: Any?) {
+        TipKitDebugOptionsUIActionHandler().resetTipKitTapped()
+    }
+
     @objc func internalUserState(_ sender: Any?) {
         guard let internalUserDecider = NSApp.delegateTyped.internalUserDecider as? DefaultInternalUserDecider else { return }
         let state = internalUserDecider.isInternalUser

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/SiteTroubleshootingInfoPublisher.swift → DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/ActiveSiteInfoPublisher.swift

@@ -1,5 +1,5 @@
 //
-//  SiteTroubleshootingInfoPublisher.swift
+//  ActiveSiteInfoPublisher.swift
 //
 //  Copyright © 2024 DuckDuckGo. All rights reserved.
 //
@@ -22,15 +22,15 @@ import NetworkProtectionProxy
 import NetworkProtectionUI
 
 @MainActor
-final class SiteTroubleshootingInfoPublisher {
+final class ActiveSiteInfoPublisher {
 
     private var activeDomain: String? {
         didSet {
-            refreshSiteTroubleshootingInfo()
+            refreshActiveSiteInfo()
         }
     }
 
-    private let subject: CurrentValueSubject<SiteTroubleshootingInfo?, Never>
+    private let subject: CurrentValueSubject<ActiveSiteInfo?, Never>
 
     private let activeDomainPublisher: AnyPublisher<String?, Never>
     private let proxySettings: TransparentProxySettings
@@ -39,7 +39,7 @@ final class SiteTroubleshootingInfoPublisher {
     init(activeDomainPublisher: AnyPublisher<String?, Never>,
          proxySettings: TransparentProxySettings) {
 
-        subject = CurrentValueSubject<SiteTroubleshootingInfo?, Never>(nil)
+        subject = CurrentValueSubject<ActiveSiteInfo?, Never>(nil)
         self.activeDomainPublisher = activeDomainPublisher
         self.proxySettings = proxySettings
 
@@ -59,7 +59,7 @@ final class SiteTroubleshootingInfoPublisher {
 
             switch change {
             case .excludedDomains:
-                refreshSiteTroubleshootingInfo()
+                refreshActiveSiteInfo()
             default:
                 break
             }
@@ -68,29 +68,29 @@ final class SiteTroubleshootingInfoPublisher {
 
     // MARK: - Refreshing
 
-    func refreshSiteTroubleshootingInfo() {
-        if activeSiteTroubleshootingInfo != subject.value {
-            subject.send(activeSiteTroubleshootingInfo)
+    func refreshActiveSiteInfo() {
+        if activeActiveSiteInfo != subject.value {
+            subject.send(activeActiveSiteInfo)
         }
     }
 
     // MARK: - Active Site Troubleshooting Info
 
-    var activeSiteTroubleshootingInfo: SiteTroubleshootingInfo? {
+    var activeActiveSiteInfo: ActiveSiteInfo? {
         guard let activeDomain else {
             return nil
         }
 
         return site(forDomain: activeDomain.droppingWwwPrefix())
     }
 
-    private func site(forDomain domain: String) -> SiteTroubleshootingInfo? {
+    private func site(forDomain domain: String) -> ActiveSiteInfo? {
         let icon: NSImage?
-        let currentSite: NetworkProtectionUI.SiteTroubleshootingInfo?
+        let currentSite: NetworkProtectionUI.ActiveSiteInfo?
 
         icon = FaviconManager.shared.getCachedFavicon(forDomainOrAnySubdomain: domain, sizeCategory: .small)?.image
         let proxySettings = TransparentProxySettings(defaults: .netP)
-        currentSite = NetworkProtectionUI.SiteTroubleshootingInfo(
+        currentSite = NetworkProtectionUI.ActiveSiteInfo(
             icon: icon,
             domain: domain,
             excluded: proxySettings.isExcluding(domain: domain))
@@ -99,12 +99,12 @@ final class SiteTroubleshootingInfoPublisher {
     }
 }
 
-extension SiteTroubleshootingInfoPublisher: Publisher {
-    typealias Output = SiteTroubleshootingInfo?
+extension ActiveSiteInfoPublisher: Publisher {
+    typealias Output = ActiveSiteInfo?
     typealias Failure = Never
 
     nonisolated
-    func receive<S>(subscriber: S) where S: Subscriber, Never == S.Failure, NetworkProtectionUI.SiteTroubleshootingInfo? == S.Input {
+    func receive<S>(subscriber: S) where S: Subscriber, Never == S.Failure, NetworkProtectionUI.ActiveSiteInfo? == S.Input {
 
         subject.receive(subscriber: subscriber)
     }

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionNavBarPopoverManager.swift

@@ -24,11 +24,12 @@ import Foundation
 import LoginItems
 import NetworkProtection
 import NetworkProtectionIPC
+import NetworkProtectionProxy
 import NetworkProtectionUI
+import os.log
 import Subscription
-import VPNAppLauncher
 import SwiftUI
-import NetworkProtectionProxy
+import VPNAppLauncher
 
 protocol NetworkProtectionIPCClient {
     var ipcStatusObserver: ConnectionStatusObserver { get }
@@ -55,8 +56,8 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
     let vpnUninstaller: VPNUninstalling
 
     @Published
-    private var siteInfo: SiteTroubleshootingInfo?
-    private let siteTroubleshootingInfoPublisher: SiteTroubleshootingInfoPublisher
+    private var siteInfo: ActiveSiteInfo?
+    private let activeSitePublisher: ActiveSiteInfoPublisher
     private var cancellables = Set<AnyCancellable>()
 
     init(ipcClient: VPNControllerXPCClient,
@@ -67,15 +68,15 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
 
         let activeDomainPublisher = ActiveDomainPublisher(windowControllersManager: .shared)
 
-        siteTroubleshootingInfoPublisher = SiteTroubleshootingInfoPublisher(
+        activeSitePublisher = ActiveSiteInfoPublisher(
             activeDomainPublisher: activeDomainPublisher.eraseToAnyPublisher(),
             proxySettings: TransparentProxySettings(defaults: .netP))
 
         subscribeToCurrentSitePublisher()
     }
 
     private func subscribeToCurrentSitePublisher() {
-        siteTroubleshootingInfoPublisher
+        activeSitePublisher
             .assign(to: \.siteInfo, onWeaklyHeld: self)
             .store(in: &cancellables)
     }
@@ -87,9 +88,10 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
     func show(positionedBelow view: NSView, withDelegate delegate: NSPopoverDelegate) -> NSPopover {
 
         /// Since the favicon doesn't have a publisher we force refreshing here
-        siteTroubleshootingInfoPublisher.refreshSiteTroubleshootingInfo()
+        activeSitePublisher.refreshActiveSiteInfo()
 
         let popover: NSPopover = {
+            let vpnSettings = VPNSettings(defaults: .netP)
             let controller = NetworkProtectionIPCTunnelController(ipcClient: ipcClient)
 
             let statusReporter = DefaultNetworkProtectionStatusReporter(
@@ -103,15 +105,18 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
             )
 
             let onboardingStatusPublisher = UserDefaults.netP.networkProtectionOnboardingStatusPublisher
-            _ = VPNSettings(defaults: .netP)
             let appLauncher = AppLauncher(appBundleURL: Bundle.main.bundleURL)
             let vpnURLEventHandler = VPNURLEventHandler()
             let proxySettings = TransparentProxySettings(defaults: .netP)
             let uiActionHandler = VPNUIActionHandler(vpnURLEventHandler: vpnURLEventHandler, proxySettings: proxySettings)
 
+            let activeSitePublisher = CurrentValuePublisher(
+                initialValue: nil,
+                publisher: $siteInfo.eraseToAnyPublisher())
+
             let siteTroubleshootingViewModel = SiteTroubleshootingView.Model(
                 connectionStatusPublisher: statusReporter.statusObserver.publisher,
-                siteTroubleshootingInfoPublisher: $siteInfo.eraseToAnyPublisher(),
+                activeSitePublisher: activeSitePublisher.eraseToAnyPublisher(),
                 uiActionHandler: uiActionHandler)
 
             let statusViewModel = NetworkProtectionStatusView.Model(controller: controller,
@@ -157,10 +162,21 @@ final class NetworkProtectionNavBarPopoverManager: NetPPopoverManager {
                 _ = try? await self?.vpnUninstaller.uninstall(removeSystemExtension: true)
             })
 
+            // TODO: replace with access to actual feature flag
+            let tipsFeatureFlagPublisher = CurrentValuePublisher(initialValue: true, publisher: Just(true).eraseToAnyPublisher())
+
+            let tipsModel = VPNTipsModel(featureFlagPublisher: tipsFeatureFlagPublisher,
+                                         statusObserver: statusReporter.statusObserver,
+                                         activeSitePublisher: activeSitePublisher,
+                                         forMenuApp: false,
+                                         vpnSettings: vpnSettings,
+                                         logger: Logger(subsystem: "DuckDuckGo", category: "TipKit"))
+
             let popover = NetworkProtectionPopover(
                 statusViewModel: statusViewModel,
                 statusReporter: statusReporter,
                 siteTroubleshootingViewModel: siteTroubleshootingViewModel,
+                tipsModel: tipsModel,
                 debugInformationViewModel: DebugInformationViewModel(showDebugInformation: false))
             popover.delegate = delegate
 

DuckDuckGo/TipKit/Logger+TipKit.swift

@@ -0,0 +1,28 @@
+//
+//  Logger+TipKit.swift
+//  DuckDuckGo
+//
+//  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 os.log
+
+extension Logger {
+
+    static var tipKit: Logger = {
+        Logger(subsystem: Bundle.main.bundleIdentifier ?? "DuckDuckGo", category: "TipKit")
+    }()
+}

DuckDuckGo/TipKit/TipKitAppEventHandling.swift

@@ -0,0 +1,72 @@
+//
+//  TipKitAppEventHandling.swift
+//  DuckDuckGo
+//
+//  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 BrowserServicesKit
+import os.log
+import TipKit
+
+protocol TipKitAppEventHandling {
+    func appDidFinishLaunching()
+}
+
+struct TipKitAppEventHandler: TipKitAppEventHandling {
+
+    private let controller: TipKitController
+    private let featureFlagger: FeatureFlagger
+    private let logger: Logger
+
+    init(controller: TipKitController = .make(),
+         featureFlagger: FeatureFlagger,
+         logger: Logger = .tipKit) {
+
+        self.controller = controller
+        self.featureFlagger = featureFlagger
+        self.logger = logger
+    }
+
+    func appDidFinishLaunching() {
+        guard featureFlagger.isFeatureOn(.networkProtectionUserTips) else {
+            logger.log("TipKit disabled by remote feature flag.")
+            return
+        }
+
+        if #available(macOS 14.0, *) {
+            typealias DataStoreLocation = Tips.ConfigurationOption.DatastoreLocation
+
+            /// A this time TipKit does not seem to handle synchronization of state between multiple apps very well.
+            /// That said, we still use the app configuration group for the data store in hopes this will soon change.
+            /// As long as we don't use TipKit for the same views from multiple Apps we'll be fine, but we can test
+            /// whether it's still broken rather easily if we keep the state in a shared app group, and we avoid having
+            /// to migrate the store in the future.
+            let appConfigurationGroupIdentifier = Bundle.main.appGroup(bundle: .appConfiguration)
+
+            guard let dataStoreLocation = try? DataStoreLocation.groupContainer(identifier: appConfigurationGroupIdentifier) else {
+                fatalError()
+            }
+
+            controller.configureTipKit([
+                .displayFrequency(.immediate),
+                .datastoreLocation(dataStoreLocation)
+            ])
+        } else {
+            logger.log("TipKit initialization skipped: iOS 17.0 or later is required.")
+        }
+    }
+}

DuckDuckGo/TipKit/TipKitController+ConvenienceInitializers.swift

@@ -0,0 +1,30 @@
+//
+//  TipKitController+ConvenienceInitializers.swift
+//  DuckDuckGo
+//
+//  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 os
+
+extension TipKitController {
+
+    static func make(logger: Logger = .tipKit,
+                     userDefaults: UserDefaults = .appConfiguration) -> Self {
+
+        self.init(logger: logger, userDefaults: userDefaults)
+    }
+}