-
Notifications
You must be signed in to change notification settings - Fork 426
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Task/Issue URL: https://app.asana.com/0/0/1206668965195606/f Description: New Settings layout with Privacy Protections, Main Settings, Next Steps and others. It also includes the implementation of pixel experiment for monitoring the usage of old and new Settings to make sure we don't harm the experience. ℹ️ The experiment will be activated in a follow-up PR after running experiments on iOS are over.
- Loading branch information
1 parent
2b0a8dc
commit 9a9cd02
Showing
219 changed files
with
16,915 additions
and
2,049 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| // | ||
| // PixelExperiment.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 | ||
|
|
||
| public enum PixelExperiment: String, CaseIterable { | ||
|
|
||
| fileprivate static var logic: PixelExperimentLogic { | ||
| customLogic ?? defaultLogic | ||
| } | ||
| fileprivate static let defaultLogic = PixelExperimentLogic { | ||
| Pixel.fire(pixel: $0, | ||
| withAdditionalParameters: PixelExperiment.parameters) | ||
| } | ||
| // Custom logic for testing purposes | ||
| static var customLogic: PixelExperimentLogic? | ||
|
|
||
| /// When `cohort` is accessed for the first time after the experiment is installed with `install()`, | ||
| /// allocate and return a cohort. Subsequently, return the same cohort. | ||
| public static var cohort: PixelExperiment? { | ||
| logic.cohort | ||
| } | ||
|
|
||
| static var isExperimentInstalled: Bool { | ||
| return logic.isInstalled | ||
| } | ||
|
|
||
| static var allocatedCohortDoesNotMatchCurrentCohorts: Bool { | ||
| guard let allocatedCohort = logic.allocatedCohort else { return false } | ||
| if PixelExperiment(rawValue: allocatedCohort) == nil { | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| /// Enables this experiment for new users when called from the new installation path. | ||
| public static func install() { | ||
| // Disable the experiment until all other experiments are finished | ||
| logic.install() | ||
| } | ||
|
|
||
| static func cleanup() { | ||
| logic.cleanup() | ||
| } | ||
|
|
||
| // These are the variants. Rename or add/remove them as needed. If you change the string value | ||
| // remember to keep it clear for privacy triage. | ||
| case control | ||
| case newSettings | ||
|
|
||
| // Internal state for users not included in any variant | ||
| case noVariant | ||
| } | ||
|
|
||
| extension PixelExperiment { | ||
|
|
||
| // Pixel parameter - cohort | ||
| public static var parameters: [String: String] { | ||
| guard let cohort, cohort != .noVariant else { | ||
| return [:] | ||
| } | ||
|
|
||
| return [PixelParameters.cohort: cohort.rawValue] | ||
| } | ||
|
|
||
| } | ||
|
|
||
| final internal class PixelExperimentLogic { | ||
|
|
||
| var cohort: PixelExperiment? { | ||
| guard isInstalled else { return nil } | ||
|
|
||
| // Use the `customCohort` if it's set | ||
| if let customCohort = customCohort { | ||
| return customCohort | ||
| } | ||
|
|
||
| // Check if a cohort is already allocated and valid | ||
| if let allocatedCohort, | ||
| let cohort = PixelExperiment(rawValue: allocatedCohort) { | ||
| return cohort | ||
| } | ||
|
|
||
| let randomNumber = Int.random(in: 0..<100) | ||
|
|
||
| // Allocate user to a cohort based on the random number | ||
| let cohort: PixelExperiment | ||
| if randomNumber < 5 { | ||
| cohort = .control | ||
| } else if randomNumber < 10 { | ||
| cohort = .newSettings | ||
| } else { | ||
| cohort = .noVariant | ||
| } | ||
|
|
||
| // Store and use the selected cohort | ||
| allocatedCohort = cohort.rawValue | ||
| fireEnrollmentPixel() | ||
| return cohort | ||
| } | ||
|
|
||
| @UserDefaultsWrapper(key: .pixelExperimentInstalled, defaultValue: false) | ||
| var isInstalled: Bool | ||
|
|
||
| @UserDefaultsWrapper(key: .pixelExperimentCohort, defaultValue: nil) | ||
| var allocatedCohort: String? | ||
|
|
||
| private let fire: (Pixel.Event) -> Void | ||
| private let customCohort: PixelExperiment? | ||
|
|
||
| init(fire: @escaping (Pixel.Event) -> Void, | ||
| customCohort: PixelExperiment? = nil) { | ||
| self.fire = fire | ||
| self.customCohort = customCohort | ||
| } | ||
|
|
||
| func install() { | ||
| isInstalled = true | ||
| } | ||
|
|
||
| private func fireEnrollmentPixel() { | ||
| guard cohort != .noVariant else { | ||
| return | ||
| } | ||
|
|
||
| fire(.pixelExperimentEnrollment) | ||
| } | ||
|
|
||
| func cleanup() { | ||
| isInstalled = false | ||
| allocatedCohort = nil | ||
| } | ||
|
|
||
| } |
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.