Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aligning Privacy Dashboard EventMapping with iOS #3744

Merged
merged 12 commits into from
Jan 17, 2025
Merged

Aligning Privacy Dashboard EventMapping with iOS #3744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fa32de0
BSK update
mgurgel Jan 14, 2025
7fd3ad1
Disable animation on brekage report window
mgurgel Dec 17, 2024
2c572aa
Privacy Dashboard 8.0.0
mgurgel Jan 9, 2025
ea9e32e
BSK update
mgurgel Jan 14, 2025
908c79a
New message handler for ReportBrokenSiteShown
mgurgel Jan 16, 2025
92a9ea7
Pixel renamed
mgurgel Jan 16, 2025
b76de78
Added legacy event showReportBrokenSite
mgurgel Jan 16, 2025
267e5c5
Removed unused code
mgurgel Jan 17, 2025
e2ffde1
Added test
mgurgel Jan 17, 2025
5cd336a
Fixed pixel name
mgurgel Jan 17, 2025
70e9484
BSK update
mgurgel Jan 17, 2025
9dd2078
BSK update
mgurgel Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DuckDuckGo.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15385,7 +15385,7 @@
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/duckduckgo/BrowserServicesKit";
requirement = {
branch = "mgurgel/improved-breakage-form";
branch = "mgurgel/improved-breakage-form-pixel";
kind = branch;
};
};
Expand Down
16 changes: 8 additions & 8 deletions DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/duckduckgo/BrowserServicesKit",
"state" : {
"branch" : "mgurgel/improved-breakage-form",
"revision" : "82a612a0c2d164a797f148356dd8d51dd804c52c"
"branch" : "mgurgel/improved-breakage-form-pixel",
"revision" : "f85a4199ba4251921ecff6d110527c8d5c44e329"
}
},
{
"identity" : "content-scope-scripts",
"kind" : "remoteSourceControl",
"location" : "https://github.com/duckduckgo/content-scope-scripts",
"state" : {
"revision" : "7958ddab724c26326333cae13fe81478290607fa",
"version" : "7.6.0"
"revision" : "0502ed7de4130bd8705daebaca9aeb20d3e62d15",
"version" : "7.5.0"
}
},
{
Expand Down Expand Up @@ -104,8 +104,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/duckduckgo/privacy-dashboard",
"state" : {
"revision" : "3f58e008d4e9d1b56ab12dbb95bd891045cf2758",
"version" : "8.0.0"
"branch" : "pr-releases/pr-302",
"revision" : "05d04de7505117b32949b2007e5a56ba2d39469b"
}
},
{
Expand Down Expand Up @@ -167,8 +167,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/duckduckgo/sync_crypto",
"state" : {
"revision" : "cc726cebb67367466bc31ced4784e16d44ac68d1",
"version" : "0.4.0"
"revision" : "0c8bf3c0e75591bc366407b9d7a73a9fcfc7736f",
"version" : "0.3.0"
}
},
{
Expand Down
18 changes: 15 additions & 3 deletions DuckDuckGo/PrivacyDashboard/View/PrivacyDashboardViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ final class PrivacyDashboardViewController: NSViewController {
}, keyValueStoring: UserDefaults.standard)
}()

private let eventMapping = EventMapping<PrivacyDashboardEvents> { _, _, _, _ in }

private let permissionHandler = PrivacyDashboardPermissionHandler()
private var preferredMaxHeight: CGFloat = Constants.initialContentHeight
func setPreferredMaxHeight(_ height: CGFloat) {
Expand All @@ -73,6 +71,20 @@ final class PrivacyDashboardViewController: NSViewController {
var sizeDelegate: PrivacyDashboardViewControllerSizeDelegate?
private weak var tabViewModel: TabViewModel?

private let privacyDashboardEvents = EventMapping<PrivacyDashboardEvents> { event, _, parameters, _ in
let domainEvent: NonStandardPixel
switch event {
case .showReportBrokenSite: domainEvent = .brokenSiteReportShown
case .reportBrokenSiteShown: domainEvent = .brokenSiteReportShown
case .reportBrokenSiteSent: domainEvent = .brokenSiteReportSent
}
if let parameters {
PixelKit.fire(NonStandardEvent(domainEvent), withAdditionalParameters: parameters)
} else {
PixelKit.fire(NonStandardEvent(domainEvent))
}
}

init(privacyInfo: PrivacyInfo? = nil,
entryPoint: PrivacyDashboardEntryPoint = .dashboard,
privacyConfigurationManager: PrivacyConfigurationManaging = ContentBlocking.shared.privacyConfigurationManager) {
Expand All @@ -82,7 +94,7 @@ final class PrivacyDashboardViewController: NSViewController {
self.privacyDashboardController = PrivacyDashboardController(privacyInfo: privacyInfo,
entryPoint: entryPoint,
toggleReportingManager: toggleReportingManager,
eventMapping: eventMapping)
eventMapping: privacyDashboardEvents)
super.init(nibName: nil, bundle: nil)
}

Expand Down
6 changes: 6 additions & 0 deletions DuckDuckGo/Statistics/NonStandardPixel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ import Configuration
enum NonStandardPixel: PixelKitEventV2 {

case brokenSiteReport
case brokenSiteReportShown
case brokenSiteReportSent
case privacyDashboardReportBrokenSite
case emailEnabled
case emailDisabled
case emailUserPressedUseAddress
Expand All @@ -35,6 +38,9 @@ enum NonStandardPixel: PixelKitEventV2 {
var name: String {
switch self {
case .brokenSiteReport: return "epbf_macos_desktop"
case .brokenSiteReportSent: return "m_report-broken-site_sent"
case .brokenSiteReportShown: return "m_report-broken-site_shown"
case .privacyDashboardReportBrokenSite: return "mp_rb"
case .emailEnabled: return "email_enabled_macos_desktop"
case .emailDisabled: return "email_disabled_macos_desktop"
case .emailUserPressedUseAddress: return "email_filled_main_macos_desktop"
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/DataBrokerProtection/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ let package = Package(
targets: ["DataBrokerProtection"])
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
.package(path: "../SwiftUIExtensions"),
.package(path: "../AppKitExtensions"),
.package(path: "../XPCHelper"),
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/FeatureFlags/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ let package = Package(
targets: ["FeatureFlags"]),
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
],
targets: [
// Targets are the basic building blocks of a package, defining a module or a test suite.
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/NetworkProtectionMac/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ let package = Package(
.library(name: "VPNAppLauncher", targets: ["VPNAppLauncher"]),
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
.package(url: "https://github.com/airbnb/lottie-spm", exact: "4.4.3"),
.package(path: "../AppLauncher"),
.package(path: "../UDSHelper"),
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/NewTabPage/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ let package = Package(
targets: ["NewTabPage"]),
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
.package(path: "../WebKitExtensions"),
.package(path: "../Utilities"),
],
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/SubscriptionUI/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ let package = Package(
targets: ["SubscriptionUI"]),
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
.package(path: "../SwiftUIExtensions"),
.package(path: "../FeatureFlags")
],
Expand Down
2 changes: 1 addition & 1 deletion LocalPackages/WebKitExtensions/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ let package = Package(
),
],
dependencies: [
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form"),
.package(url: "https://github.com/duckduckgo/BrowserServicesKit", branch: "mgurgel/improved-breakage-form-pixel"),
.package(path: "../AppKitExtensions")
],
targets: [
Expand Down
16 changes: 16 additions & 0 deletions UnitTests/WebsiteBreakageReport/WebsiteBreakageReportTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@ class WebsiteBreakageReportTests: XCTestCase {
line: #line)
}

func testReportBrokenSiteShownPixel() {
fire(NonStandardEvent(NonStandardPixel.brokenSiteReportShown),
frequency: .standard,
and: .expect(pixelName: "m_report-broken-site_shown"),
file: #filePath,
line: #line)
}

func testReportBrokenSiteSentPixel() {
fire(NonStandardEvent(NonStandardPixel.brokenSiteReportSent),
frequency: .standard,
and: .expect(pixelName: "m_report-broken-site_sent"),
file: #filePath,
line: #line)
}

func testCommonSetOfFields() throws {
let breakage = BrokenSiteReport(
siteUrl: URL(string: "https://example.test/")!,
Expand Down
Loading