-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into sam/rmf-survey-updates
* main: Autofill engagement KPIs for pixel reporting (#830) Bump C-S-S to 5.17.0 (#828) ensure bookmarks can be shown in top hits (#818) Subscription refactoring (#815)
- Loading branch information
Showing
46 changed files
with
1,661 additions
and
521 deletions.
There are no files selected for viewing
This file contains 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 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
243 changes: 243 additions & 0 deletions
243
Sources/BrowserServicesKit/Autofill/AutofillPixelReporter.swift
This file contains 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,243 @@ | ||
| // | ||
| // AutofillPixelReporter.swift | ||
| // | ||
| // 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 Persistence | ||
| import SecureStorage | ||
| import Common | ||
|
|
||
| public enum AutofillPixelEvent { | ||
| case autofillActiveUser | ||
| case autofillEnabledUser | ||
| case autofillOnboardedUser | ||
| case autofillLoginsStacked | ||
| case autofillCreditCardsStacked | ||
|
|
||
| enum Parameter { | ||
| static let countBucket = "count_bucket" | ||
| } | ||
| } | ||
|
|
||
| public final class AutofillPixelReporter { | ||
|
|
||
| enum Keys { | ||
| static let autofillSearchDauDateKey = "com.duckduckgo.app.autofill.SearchDauDate" | ||
| static let autofillFillDateKey = "com.duckduckgo.app.autofill.FillDate" | ||
| static let autofillOnboardedUserKey = "com.duckduckgo.app.autofill.OnboardedUser" | ||
| } | ||
|
|
||
| enum BucketName: String { | ||
| case none | ||
| case few | ||
| case some | ||
| case many | ||
| case lots | ||
| } | ||
|
|
||
| private enum EventType { | ||
| case fill | ||
| case searchDAU | ||
| } | ||
|
|
||
| private let userDefaults: UserDefaults | ||
| private let eventMapping: EventMapping<AutofillPixelEvent> | ||
| private var secureVault: (any AutofillSecureVault)? | ||
| private var reporter: SecureVaultReporting? | ||
| // Third party password manager | ||
| private let passwordManager: PasswordManager? | ||
| private var installDate: Date? | ||
|
|
||
| private var autofillSearchDauDate: Date? { userDefaults.object(forKey: Keys.autofillSearchDauDateKey) as? Date ?? .distantPast } | ||
| private var autofillFillDate: Date? { userDefaults.object(forKey: Keys.autofillFillDateKey) as? Date ?? .distantPast } | ||
| private var autofillOnboardedUser: Bool { userDefaults.object(forKey: Keys.autofillOnboardedUserKey) as? Bool ?? false } | ||
|
|
||
| public init(userDefaults: UserDefaults, | ||
| eventMapping: EventMapping<AutofillPixelEvent>, | ||
| secureVault: (any AutofillSecureVault)? = nil, | ||
| reporter: SecureVaultReporting? = nil, | ||
| passwordManager: PasswordManager? = nil, | ||
| installDate: Date? = nil | ||
| ) { | ||
| self.userDefaults = userDefaults | ||
| self.eventMapping = eventMapping | ||
| self.secureVault = secureVault | ||
| self.reporter = reporter | ||
| self.passwordManager = passwordManager | ||
| self.installDate = installDate | ||
|
|
||
| createNotificationObservers() | ||
| } | ||
|
|
||
| public func resetStoreDefaults() { | ||
| userDefaults.set(Date.distantPast, forKey: Keys.autofillSearchDauDateKey) | ||
| userDefaults.set(Date.distantPast, forKey: Keys.autofillFillDateKey) | ||
| userDefaults.set(false, forKey: Keys.autofillOnboardedUserKey) | ||
| } | ||
|
|
||
| private func createNotificationObservers() { | ||
| NotificationCenter.default.addObserver(self, selector: #selector(didReceiveSearchDAU), name: .searchDAU, object: nil) | ||
| NotificationCenter.default.addObserver(self, selector: #selector(didReceiveFillEvent), name: .autofillFillEvent, object: nil) | ||
| NotificationCenter.default.addObserver(self, selector: #selector(didReceiveSaveEvent), name: .autofillSaveEvent, object: nil) | ||
| } | ||
|
|
||
| @objc | ||
| private func didReceiveSearchDAU() { | ||
| guard let autofillSearchDauDate = autofillSearchDauDate, !Date.isSameDay(Date(), autofillSearchDauDate) else { | ||
| return | ||
| } | ||
|
|
||
| userDefaults.set(Date(), forKey: Keys.autofillSearchDauDateKey) | ||
|
|
||
| firePixelsFor(.searchDAU) | ||
| } | ||
|
|
||
| @objc | ||
| private func didReceiveFillEvent() { | ||
| guard let autofillFillDate = autofillFillDate, !Date.isSameDay(Date(), autofillFillDate) else { | ||
| return | ||
| } | ||
|
|
||
| userDefaults.set(Date(), forKey: Keys.autofillFillDateKey) | ||
|
|
||
| firePixelsFor(.fill) | ||
| } | ||
|
|
||
| @objc | ||
| private func didReceiveSaveEvent() { | ||
| guard !autofillOnboardedUser else { | ||
| return | ||
| } | ||
|
|
||
| if shouldFireOnboardedUserPixel() { | ||
| eventMapping.fire(.autofillOnboardedUser) | ||
| } | ||
| } | ||
|
|
||
| private func firePixelsFor(_ type: EventType) { | ||
| if shouldFireActiveUserPixel() { | ||
| eventMapping.fire(.autofillActiveUser) | ||
|
|
||
| if let accountsCountBucket = getAccountsCountBucket() { | ||
| eventMapping.fire(.autofillLoginsStacked, parameters: [AutofillPixelEvent.Parameter.countBucket: accountsCountBucket]) | ||
| } | ||
|
|
||
| if let cardsCount = try? vault()?.creditCardsCount() { | ||
| eventMapping.fire(.autofillCreditCardsStacked, parameters: [AutofillPixelEvent.Parameter.countBucket: creditCardsBucketNameFrom(count: cardsCount)]) | ||
| } | ||
| } | ||
|
|
||
| switch type { | ||
| case .searchDAU: | ||
| if shouldFireEnabledUserPixel() { | ||
| eventMapping.fire(.autofillEnabledUser) | ||
| } | ||
| default: | ||
| break | ||
| } | ||
| } | ||
|
|
||
| private func getAccountsCountBucket() -> String? { | ||
| if let passwordManager = passwordManager, passwordManager.isEnabled { | ||
| // if a user is using a password manager we can't get a count of their passwords so we are assuming they are likely to have a lot of passwords saved | ||
| return BucketName.lots.rawValue | ||
| } else if let accountsCount = try? vault()?.accountsCount() { | ||
| return accountsBucketNameFrom(count: accountsCount) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| private func shouldFireActiveUserPixel() -> Bool { | ||
| let today = Date() | ||
| if Date.isSameDay(today, autofillSearchDauDate) && Date.isSameDay(today, autofillFillDate) { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| private func shouldFireEnabledUserPixel() -> Bool { | ||
| if Date.isSameDay(Date(), autofillSearchDauDate) { | ||
| if let passwordManager = passwordManager, passwordManager.isEnabled { | ||
| return true | ||
| } else if let count = try? vault()?.accountsCount(), count >= 10 { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| private func shouldFireOnboardedUserPixel() -> Bool { | ||
| guard !autofillOnboardedUser, let installDate = installDate else { | ||
| return false | ||
| } | ||
|
|
||
| let pastWeek = Date().addingTimeInterval(.days(-7)) | ||
|
|
||
| if installDate >= pastWeek { | ||
| if let passwordManager = passwordManager, passwordManager.isEnabled { | ||
| return true | ||
| } else if let count = try? vault()?.accountsCount(), count > 0 { | ||
| userDefaults.set(true, forKey: Keys.autofillOnboardedUserKey) | ||
| return true | ||
| } | ||
| } else { | ||
| userDefaults.set(true, forKey: Keys.autofillOnboardedUserKey) | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| private func vault() -> (any AutofillSecureVault)? { | ||
| if secureVault == nil { | ||
| secureVault = try? AutofillSecureVaultFactory.makeVault(reporter: reporter) | ||
| } | ||
| return secureVault | ||
| } | ||
|
|
||
| private func accountsBucketNameFrom(count: Int) -> String { | ||
| if count == 0 { | ||
| return BucketName.none.rawValue | ||
| } else if count < 4 { | ||
| return BucketName.few.rawValue | ||
| } else if count < 11 { | ||
| return BucketName.some.rawValue | ||
| } else if count < 50 { | ||
| return BucketName.many.rawValue | ||
| } else { | ||
| return BucketName.lots.rawValue | ||
| } | ||
| } | ||
|
|
||
| private func creditCardsBucketNameFrom(count: Int) -> String { | ||
| if count == 0 { | ||
| return BucketName.none.rawValue | ||
| } else if count < 4 { | ||
| return BucketName.some.rawValue | ||
| } else { | ||
| return BucketName.many.rawValue | ||
| } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| public extension NSNotification.Name { | ||
|
|
||
| static let autofillFillEvent: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.browserServicesKit.AutofillFillEvent") | ||
| static let autofillSaveEvent: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.browserServicesKit.AutofillSaveEvent") | ||
| static let searchDAU: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.browserServicesKit.SearchDAU") | ||
|
|
||
| } |
This file contains 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 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 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 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
Oops, something went wrong.