Merge branch 'main' into anh/pir/data-model-mismatch

.github/workflows/publish_dmg_release.yml

@@ -262,7 +262,8 @@ jobs:
             github_handle:"${{ github.actor }}" \
             is_scheduled_release:"${{ github.event_name == 'schedule' }}" \
             release_task_id:"${{ steps.task-id.outputs.asana_task_id }}" \
-            target_section_id:"${{ vars.MACOS_APP_BOARD_DONE_SECTION_ID }}"
+            target_section_id:"${{ vars.MACOS_APP_BOARD_DONE_SECTION_ID }}" \
+            tag:"${{ env.TAG }}"
 
       - name: Get tasks since last internal release
         id: get-tasks-since-last-internal-release

Configuration/BuildNumber.xcconfig

@@ -1 +1 @@
-CURRENT_PROJECT_VERSION = 323
+CURRENT_PROJECT_VERSION = 324

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

@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/BrowserServicesKit",
       "state" : {
-        "revision" : "befc1f1094353d8d88a99ac08885684c978b2016",
-        "version" : "217.0.0"
+        "revision" : "e5d390c8559fbe7b1ca67fd3982c91bcc0437d60",
+        "version" : "218.0.0"
       }
     },
     {

DuckDuckGo/Application/AppDelegate.swift

@@ -31,6 +31,7 @@ import MetricKit
 import Networking
 import Persistence
 import PixelKit
+import PixelExperimentKit
 import ServiceManagement
 import SyncDataProviders
 import UserNotifications
@@ -282,7 +283,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
                 keyValueStore: UserDefaults.appConfiguration,
                 actionHandler: FeatureFlagOverridesPublishingHandler<FeatureFlag>()
             ),
-            experimentManager: ExperimentCohortsManager(store: ExperimentsDataStore()),
+            experimentManager: ExperimentCohortsManager(store: ExperimentsDataStore(), fireCohortAssigned: PixelKit.fireExperimentEnrollmentPixel(subfeatureID:experiment:)),
             for: FeatureFlag.self
         )
 
@@ -331,6 +332,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
 #else
         privacyStats = PrivacyStats(databaseProvider: PrivacyStatsDatabase())
 #endif
+        PixelKit.configureExperimentKit(featureFlagger: featureFlagger, eventTracker: ExperimentEventTracker(store: UserDefaults.appConfiguration))
     }
 
     func applicationWillFinishLaunching(_ notification: Notification) {

DuckDuckGo/FileDownload/View/DownloadsViewController.swift

@@ -95,6 +95,7 @@ final class DownloadsViewController: NSViewController {
         clearDownloadsButton.imagePosition = .imageOnly
         clearDownloadsButton.imageScaling = .scaleProportionallyDown
         clearDownloadsButton.toolTip = UserText.clearDownloadHistoryTooltip
+        clearDownloadsButton.setAccessibilityIdentifier("DownloadsViewController.clearDownloadsButton")
         clearDownloadsButton.cornerRadius = 4
         clearDownloadsButton.backgroundInset = CGPoint(x: 2, y: 2)
         clearDownloadsButton.normalTintColor = .button

DuckDuckGo/HomePage/Model/HomePageContinueSetUpModel.swift

@@ -18,6 +18,7 @@
 
 import AppKit
 import BrowserServicesKit
+import Combine
 import Common
 import Foundation
 import PixelKit
@@ -26,6 +27,20 @@ import Subscription
 import NetworkProtection
 import NetworkProtectionUI
 
+protocol ContinueSetUpModelTabOpening {
+    @MainActor
+    func openTab(_ tab: Tab)
+}
+
+struct TabCollectionViewModelTabOpener: ContinueSetUpModelTabOpening {
+    let tabCollectionViewModel: TabCollectionViewModel
+
+    @MainActor
+    func openTab(_ tab: Tab) {
+        tabCollectionViewModel.insertOrAppend(tab: tab, selected: true)
+    }
+}
+
 extension HomePage.Models {
 
     static let newHomePageTabOpen = Notification.Name("newHomePageAppOpen")
@@ -49,7 +64,7 @@ extension HomePage.Models {
         private let defaultBrowserProvider: DefaultBrowserProvider
         private let dockCustomizer: DockCustomization
         private let dataImportProvider: DataImportStatusProviding
-        private let tabCollectionViewModel: TabCollectionViewModel
+        private let tabOpener: ContinueSetUpModelTabOpening
         private let emailManager: EmailManager
         private let duckPlayerPreferences: DuckPlayerPreferencesPersistor
         private let subscriptionManager: SubscriptionManager
@@ -58,9 +73,13 @@ extension HomePage.Models {
         var shouldShowAllFeatures: Bool {
             didSet {
                 updateVisibleMatrix()
+                shouldShowAllFeaturesSubject.send(shouldShowAllFeatures)
             }
         }
 
+        let shouldShowAllFeaturesPublisher: AnyPublisher<Bool, Never>
+        private let shouldShowAllFeaturesSubject = PassthroughSubject<Bool, Never>()
+
         struct Settings {
             @UserDefaultsWrapper(key: .homePageShowMakeDefault, defaultValue: true)
             var shouldShowMakeDefaultSetting: Bool
@@ -102,36 +121,43 @@ extension HomePage.Models {
 
         lazy var listOfFeatures = settings.isFirstSession ? firstRunFeatures : randomisedFeatures
 
-        private var featuresMatrix: [[FeatureType]] = [[]] {
+        @Published var featuresMatrix: [[FeatureType]] = [[]] {
             didSet {
                 updateVisibleMatrix()
             }
         }
 
         @Published var visibleFeaturesMatrix: [[FeatureType]] = [[]]
 
-        init(defaultBrowserProvider: DefaultBrowserProvider,
-             dockCustomizer: DockCustomization,
-             dataImportProvider: DataImportStatusProviding,
-             tabCollectionViewModel: TabCollectionViewModel,
+        init(defaultBrowserProvider: DefaultBrowserProvider = SystemDefaultBrowserProvider(),
+             dockCustomizer: DockCustomization = DockCustomizer(),
+             dataImportProvider: DataImportStatusProviding = BookmarksAndPasswordsImportStatusProvider(),
+             tabOpener: ContinueSetUpModelTabOpening,
              emailManager: EmailManager = EmailManager(),
-             duckPlayerPreferences: DuckPlayerPreferencesPersistor,
+             duckPlayerPreferences: DuckPlayerPreferencesPersistor = DuckPlayerPreferencesUserDefaultsPersistor(),
              privacyConfigurationManager: PrivacyConfigurationManaging = AppPrivacyFeatures.shared.contentBlocking.privacyConfigurationManager,
              subscriptionManager: SubscriptionManager = Application.appDelegate.subscriptionManager) {
+
             self.defaultBrowserProvider = defaultBrowserProvider
             self.dockCustomizer = dockCustomizer
             self.dataImportProvider = dataImportProvider
-            self.tabCollectionViewModel = tabCollectionViewModel
+            self.tabOpener = tabOpener
             self.emailManager = emailManager
             self.duckPlayerPreferences = duckPlayerPreferences
             self.privacyConfigurationManager = privacyConfigurationManager
             self.subscriptionManager = subscriptionManager
             self.settings = .init()
 
+            shouldShowAllFeaturesPublisher = shouldShowAllFeaturesSubject.removeDuplicates().eraseToAnyPublisher()
+
             refreshFeaturesMatrix()
 
             NotificationCenter.default.addObserver(self, selector: #selector(newTabOpenNotification(_:)), name: HomePage.Models.newHomePageTabOpen, object: nil)
             NotificationCenter.default.addObserver(self, selector: #selector(windowDidBecomeKey(_:)), name: NSWindow.didBecomeKeyNotification, object: nil)
+
+            // HTML NTP doesn't refresh on appear so we have to connect to the appear signal
+            // (the notification in this case) to trigger a refresh.
+            NotificationCenter.default.addObserver(self, selector: #selector(refreshFeaturesForHTMLNewTabPage(_:)), name: .newTabPageWebViewDidAppear, object: nil)
         }
 
         @MainActor func performAction(for featureType: FeatureType) {
@@ -166,14 +192,14 @@ extension HomePage.Models {
         private func performDuckPlayerAction() {
             if let videoUrl = URL(string: duckPlayerURL) {
                 let tab = Tab(content: .url(videoUrl, source: .link), shouldLoadInBackground: true)
-                tabCollectionViewModel.append(tab: tab)
+                tabOpener.openTab(tab)
             }
         }
 
         @MainActor
         private func performEmailProtectionAction() {
             let tab = Tab(content: .url(EmailUrls().emailProtectionLink, source: .ui), shouldLoadInBackground: true)
-            tabCollectionViewModel.append(tab: tab)
+            tabOpener.openTab(tab)
         }
 
         func performDockAction() {
@@ -243,6 +269,14 @@ extension HomePage.Models {
         }
 
         @objc private func windowDidBecomeKey(_ notification: Notification) {
+            // Async dispatch allows default browser setting to propagate
+            // after being changed in the system dialog
+            DispatchQueue.main.async {
+                self.refreshFeaturesMatrix()
+            }
+        }
+
+        @objc private func refreshFeaturesForHTMLNewTabPage(_ notification: Notification) {
             refreshFeaturesMatrix()
         }
 

DuckDuckGo/HomePage/View/ContinueSetUpView.swift

@@ -119,7 +119,7 @@ extension HomePage.Views {
                 .onAppear {
                     if featureType == .dock {
                         PixelKit.fire(GeneralPixel.addToDockNewTabPageCardPresented,
-                                      frequency: .unique,
+                                      frequency: .uniqueByName,
                                       includeAppVersionParameter: false)
                     }
                 }
@@ -292,7 +292,7 @@ extension HomePage.Views {
             defaultBrowserProvider: SystemDefaultBrowserProvider(),
             dockCustomizer: DockCustomizer(),
             dataImportProvider: BookmarksAndPasswordsImportStatusProvider(),
-            tabCollectionViewModel: TabCollectionViewModel(),
+            tabOpener: TabCollectionViewModelTabOpener(tabCollectionViewModel: TabCollectionViewModel()),
             duckPlayerPreferences: DuckPlayerPreferencesUserDefaultsPersistor()
         ))
 }

DuckDuckGo/HomePage/View/HomePageSettings/HomePageSettingsView.swift

@@ -247,7 +247,7 @@ extension HomePage.Views.BackgroundCategoryView {
             defaultBrowserProvider: SystemDefaultBrowserProvider(),
             dockCustomizer: DockCustomizer(),
             dataImportProvider: BookmarksAndPasswordsImportStatusProvider(),
-            tabCollectionViewModel: TabCollectionViewModel(),
+            tabOpener: TabCollectionViewModelTabOpener(tabCollectionViewModel: TabCollectionViewModel()),
             duckPlayerPreferences: DuckPlayerPreferencesUserDefaultsPersistor()
         ))
         .environmentObject(HomePage.Models.FavoritesModel(
@@ -276,7 +276,7 @@ extension HomePage.Views.BackgroundCategoryView {
             defaultBrowserProvider: SystemDefaultBrowserProvider(),
             dockCustomizer: DockCustomizer(),
             dataImportProvider: BookmarksAndPasswordsImportStatusProvider(),
-            tabCollectionViewModel: TabCollectionViewModel(),
+            tabOpener: TabCollectionViewModelTabOpener(tabCollectionViewModel: TabCollectionViewModel()),
             duckPlayerPreferences: DuckPlayerPreferencesUserDefaultsPersistor()
         ))
         .environmentObject(HomePage.Models.FavoritesModel(

DuckDuckGo/HomePage/View/HomePageViewController.swift

@@ -171,7 +171,7 @@ final class HomePageViewController: NSViewController {
             defaultBrowserProvider: SystemDefaultBrowserProvider(),
             dockCustomizer: DockCustomizer(),
             dataImportProvider: BookmarksAndPasswordsImportStatusProvider(),
-            tabCollectionViewModel: tabCollectionViewModel,
+            tabOpener: TabCollectionViewModelTabOpener(tabCollectionViewModel: tabCollectionViewModel),
             duckPlayerPreferences: DuckPlayerPreferencesUserDefaultsPersistor()
         )
     }

DuckDuckGo/NavigationBar/View/NavigationBarViewController.swift

@@ -176,6 +176,7 @@ final class NavigationBarViewController: NSViewController {
         bookmarkListButton.delegate = self
         bookmarkListButton.setAccessibilityIdentifier("NavigationBarViewController.bookmarkListButton")
         downloadsButton.sendAction(on: .leftMouseDown)
+        downloadsButton.setAccessibilityIdentifier("NavigationBarViewController.downloadsButton")
         networkProtectionButton.sendAction(on: .leftMouseDown)
         passwordManagementButton.sendAction(on: .leftMouseDown)
         aiChatButton.sendAction(on: .leftMouseDown)

DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionTunnelController.swift

@@ -654,7 +654,7 @@ final class NetworkProtectionTunnelController: TunnelController, TunnelSessionPr
 
         PixelKit.fire(
             NetworkProtectionPixelEvent.networkProtectionNewUser,
-            frequency: .unique,
+            frequency: .uniqueByName,
             includeAppVersionParameter: true) { [weak self] fired, error in
                 guard let self, error == nil, fired else { return }
                 self.defaults.vpnFirstEnabled = PixelKit.pixelLastFireDate(event: NetworkProtectionPixelEvent.networkProtectionNewUser)

DuckDuckGo/NewTabPage/NewTabPageActionsManager.swift

@@ -130,8 +130,16 @@ extension NewTabPageActionsManager {
         self.init(scriptClients: [
             NewTabPageConfigurationClient(appearancePreferences: appearancePreferences),
             NewTabPageRMFClient(remoteMessageProvider: activeRemoteMessageModel, openURLHandler: openURLHandler),
+            NewTabPageNextStepsCardsClient(model: HomePage.Models.ContinueSetUpModel(tabOpener: NewTabPageTabOpener())),
             NewTabPageFavoritesClient(favoritesModel: NewTabPageFavoritesModel()),
             NewTabPagePrivacyStatsClient(model: privacyStatsModel)
         ])
     }
 }
+
+struct NewTabPageTabOpener: ContinueSetUpModelTabOpening {
+    @MainActor
+    func openTab(_ tab: Tab) {
+        WindowControllersManager.shared.lastKeyMainWindowController?.mainViewController.tabCollectionViewModel.insertOrAppend(tab: tab, selected: true)
+    }
+}

DuckDuckGo/NewTabPage/NewTabPageConfigurationClient.swift

@@ -131,6 +131,7 @@ final class NewTabPageConfigurationClient: NewTabPageScriptClient {
         return NewTabPageUserScript.NewTabPageConfiguration(
             widgets: [
                 .init(id: .rmf),
+                .init(id: .nextSteps),
                 .init(id: .favorites),
                 .init(id: .privacyStats)
             ],
@@ -174,7 +175,7 @@ final class NewTabPageConfigurationClient: NewTabPageScriptClient {
 extension NewTabPageUserScript {
 
     enum WidgetId: String, Codable {
-        case rmf, favorites, privacyStats
+        case rmf, nextSteps, favorites, privacyStats
     }
 
     struct ContextMenuParams: Codable {

DuckDuckGo/NewTabPage/NewTabPageWebViewModel.swift

@@ -52,7 +52,12 @@ final class NewTabPageWebViewModel: NSObject {
 
         windowCancellable = webView.publisher(for: \.window)
             .map { $0 != nil }
-            .assign(to: \.isViewOnScreen, on: activeRemoteMessageModel)
+            .sink { [weak activeRemoteMessageModel] isOnScreen in
+                activeRemoteMessageModel?.isViewOnScreen = isOnScreen
+                if isOnScreen {
+                    NotificationCenter.default.post(name: .newTabPageWebViewDidAppear, object: nil)
+                }
+            }
     }
 }
 
@@ -61,3 +66,7 @@ extension NewTabPageWebViewModel: WKNavigationDelegate {
         navigationAction.request.url == .newtab ? .allow : .cancel
     }
 }
+
+extension Notification.Name {
+    static var newTabPageWebViewDidAppear = Notification.Name("newTabPageWebViewDidAppear")
+}