Show CPM Stats on new tab page #4 - Feature discovery dialog #2697
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "images" : [ | ||
| { | ||
| "filename" : "Cookies-Blocked-Color-24.pdf", | ||
| "idiom" : "universal" | ||
| } | ||
| ], | ||
| "info" : { | ||
| "author" : "xcode", | ||
| "version" : 1 | ||
| } | ||
| } |
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| // | ||
| // AutoconsentStatsPopoverCoordinator.swift | ||
| // | ||
| // Copyright © 2025 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 AppKit | ||
| import AppKitExtensions | ||
| import AutoconsentStats | ||
| import Persistence | ||
| import Common | ||
| import SwiftUIExtensions | ||
| import FeatureFlags | ||
| import BrowserServicesKit | ||
| import PixelKit | ||
|
|
||
| @MainActor | ||
| final class AutoconsentStatsPopoverCoordinator { | ||
|
|
||
| private let keyValueStore: ThrowingKeyValueStoring | ||
| private let windowControllersManager: WindowControllersManagerProtocol | ||
| private let cookiePopupProtectionPreferences: CookiePopupProtectionPreferences | ||
| private let appearancePreferences: AppearancePreferences | ||
| private let featureFlagger: FeatureFlagger | ||
| private let autoconsentStats: AutoconsentStatsCollecting | ||
| private let presenter: AutoconsentStatsPopoverPresenter | ||
|
|
||
| private enum StorageKey { | ||
| static let blockedCookiesPopoverSeen = "com.duckduckgo.autoconsent.blocked.cookies.popover.seen" | ||
| } | ||
|
|
||
| private enum Constants { | ||
| static let threshold = 5 | ||
| static let minimumDaysSinceInstallation = 2 | ||
| } | ||
|
|
||
| init(autoconsentStats: AutoconsentStatsCollecting, | ||
| keyValueStore: ThrowingKeyValueStoring, | ||
| windowControllersManager: WindowControllersManagerProtocol, | ||
| cookiePopupProtectionPreferences: CookiePopupProtectionPreferences, | ||
| appearancePreferences: AppearancePreferences, | ||
| featureFlagger: FeatureFlagger) { | ||
| self.autoconsentStats = autoconsentStats | ||
| self.keyValueStore = keyValueStore | ||
| self.windowControllersManager = windowControllersManager | ||
| self.cookiePopupProtectionPreferences = cookiePopupProtectionPreferences | ||
| self.appearancePreferences = appearancePreferences | ||
| self.featureFlagger = featureFlagger | ||
| self.presenter = AutoconsentStatsPopoverPresenter( | ||
| autoconsentStats: autoconsentStats, | ||
| windowControllersManager: windowControllersManager | ||
| ) | ||
| } | ||
|
|
||
| func checkAndShowDialogIfNeeded() async { | ||
| guard | ||
| isFeatureFlagEnabled(), | ||
| !presenter.isPopoverBeingPresented(), | ||
| isCPMEnabled(), | ||
| isNotOnNTP(), | ||
| isProtectionsReportEnabledOnNTP(), | ||
| !hasBeenPresented(), | ||
| hasBeenEnoughDaysSinceInstallation(), | ||
| await hasBlockedEnoughCookiePopups() | ||
| else { | ||
| return | ||
| } | ||
|
|
||
| await showDialog() | ||
| } | ||
miasma13 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // MARK: - Dialog Gatekeeping Checks | ||
|
|
||
| private func isFeatureFlagEnabled() -> Bool { | ||
| return featureFlagger.isFeatureOn(FeatureFlag.newTabPageAutoconsentStats) | ||
| } | ||
|
|
||
| private func isCPMEnabled() -> Bool { | ||
| return cookiePopupProtectionPreferences.isAutoconsentEnabled | ||
| } | ||
|
|
||
| private func isNotOnNTP() -> Bool { | ||
| guard let selectedTab = windowControllersManager.selectedTab else { | ||
| return true | ||
| } | ||
| return selectedTab.content != .newtab | ||
| } | ||
|
|
||
| private func isProtectionsReportEnabledOnNTP() -> Bool { | ||
| return appearancePreferences.isProtectionsReportVisible | ||
| } | ||
|
|
||
| private func hasBeenPresented() -> Bool { | ||
| return (try? keyValueStore.object(forKey: StorageKey.blockedCookiesPopoverSeen)) as? Bool ?? false | ||
| } | ||
|
|
||
| private func hasBeenEnoughDaysSinceInstallation() -> Bool { | ||
| return AppDelegate.firstLaunchDate.daysSinceNow() >= Constants.minimumDaysSinceInstallation | ||
| } | ||
|
|
||
| private func hasBlockedEnoughCookiePopups() async -> Bool { | ||
| let blockedCount = await autoconsentStats.fetchTotalCookiePopUpsBlocked() | ||
| return blockedCount >= Constants.threshold | ||
| } | ||
|
|
||
| private func showDialog() async { | ||
| let onClose: () -> Void = { [weak self] in | ||
| PixelKit.fire(AutoconsentPixel.popoverClosed, frequency: .daily) | ||
| do { | ||
| try self?.keyValueStore.set(true, forKey: StorageKey.blockedCookiesPopoverSeen) | ||
| } catch { | ||
| // Log error if needed | ||
|
||
| } | ||
| } | ||
|
|
||
| let onClick: () -> Void = { [weak self] in | ||
| PixelKit.fire(AutoconsentPixel.popoverClicked, frequency: .daily) | ||
| self?.openNewTabWithSpecialAction() | ||
| do { | ||
| try self?.keyValueStore.set(true, forKey: StorageKey.blockedCookiesPopoverSeen) | ||
| } catch { | ||
| // Log error if needed | ||
| } | ||
| } | ||
|
|
||
| let onAutoDismiss: () -> Void = { [weak self] in | ||
| PixelKit.fire(AutoconsentPixel.popoverAutoDismissed, frequency: .daily) | ||
| do { | ||
| try self?.keyValueStore.set(true, forKey: StorageKey.blockedCookiesPopoverSeen) | ||
| } catch { | ||
| // Log error if needed | ||
| } | ||
| } | ||
|
|
||
| await presenter.showPopover(onClose: onClose, onClick: onClick, onAutoDismiss: onAutoDismiss) | ||
| } | ||
|
|
||
| private func openNewTabWithSpecialAction() { | ||
| windowControllersManager.showTab(with: .newtab) | ||
|
|
||
| // if let newTabPageViewModel = windowControllersManager.mainWindowController?.mainViewController.browserTabViewController.newTabPageWebViewModel { | ||
| // NSApp.delegateTyped.newTabPageCustomizationModel.customizerOpener.openSettings(for: newTabPageViewModel.webView) | ||
| // } | ||
| } | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| func dismissDialogDueToNewTabBeingShown() { | ||
| guard presenter.isPopoverBeingPresented() else { | ||
| return | ||
| } | ||
| PixelKit.fire(AutoconsentPixel.popoverNewTabOpened, frequency: .daily) | ||
| do { | ||
| try self.keyValueStore.set(true, forKey: StorageKey.blockedCookiesPopoverSeen) | ||
| } catch { | ||
| // Log error if needed | ||
| } | ||
| presenter.dismissPopover() | ||
| } | ||
miasma13 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // MARK: - Debug | ||
|
|
||
| func showDialogForDebug() async { | ||
| guard !presenter.isPopoverBeingPresented() else { | ||
| return | ||
| } | ||
|
|
||
| await showDialog() | ||
| } | ||
|
|
||
| func clearBlockedCookiesPopoverSeenFlag() { | ||
| do { | ||
| try keyValueStore.removeObject(forKey: StorageKey.blockedCookiesPopoverSeen) | ||
| } catch { | ||
| // Log error if needed | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we check whether a user has completed the contextual onboarding?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, will add that.