Add PixelKit source parameter #1989
Merged
Conversation
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
samsymons
commented
Dec 19, 2023
| @@ -41,6 +41,7 @@ final class DuckDuckGoDBPBackgroundAgentApplication: NSApplication { | |||
|
|
|||
| PixelKit.setUp(dryRun: dryRun, | |||
| appVersion: AppVersion.shared.versionNumber, | |||
| source: nil, | |||
There was a problem hiding this comment.
I'm not adding this to DBP since I don't want to modify their pixels unannounced. I'll let them know about this change and they can choose to set this if they wish.
There was a problem hiding this comment.
Once they accept it we should consider making the source param non-optional, IMO.
diegoreymendez
approved these changes
Dec 21, 2023
Comment on lines
+90
to
+109
| /// Sets up PixelKit for the entire app. | ||
| /// | ||
| /// - Parameters: | ||
| /// - `dryRun`: if `true`, simulate requests and "send" them at an accelerated rate (once every 2 minutes instead of once a day) | ||
| /// - `source`: if set, adds a `pixelSource` parameter to the pixel call; this can be used to specify which target is sending the pixel | ||
| /// - `fireRequest`: this is not triggered when `dryRun` is `true` | ||
| public static func setUp(dryRun: Bool = false, | ||
| appVersion: String, | ||
| source: String? = nil, | ||
| defaultHeaders: [String: String], | ||
| log: OSLog, | ||
| defaults: UserDefaults, | ||
| fireRequest: @escaping FireRequest) { | ||
| shared = PixelKit(dryRun: dryRun, | ||
| appVersion: appVersion, | ||
| source: source, | ||
| defaultHeaders: defaultHeaders, | ||
| log: log, | ||
| defaults: defaults, | ||
| fireRequest: fireRequest) |
| @@ -41,6 +41,7 @@ final class DuckDuckGoDBPBackgroundAgentApplication: NSApplication { | |||
|
|
|||
| PixelKit.setUp(dryRun: dryRun, | |||
| appVersion: AppVersion.shared.versionNumber, | |||
| source: nil, | |||
There was a problem hiding this comment.
Once they accept it we should consider making the source param non-optional, IMO.
samsymons
added a commit
that referenced
this pull request
Dec 21, 2023
# By Dominik Kapusta (41) and others # Via Dominik Kapusta (9) and others * main: (138 commits) Make sure when we set custom config url, we don't expect etag in return (#1994) Add PixelKit source parameter (#1989) Fix internal user toggling (#2000) Show alert and display warning icon in Sync Settings when data syncing is disabled (#1996) DBP: Integrate subscription account authentication to DBP (#1995) Improve bookmarks html reader (#1986) Add Sync feature flags (#1992) Add daily stats pixel (#1993) Do not reload DBP tab when switching to it (#1942) Fix: external application requests via redirect URLs shows wrong origin. (#1900) Update clean-app.sh to work on macOS Sonoma and include NetP containers (#1988) Fix: "SwiftLintPlugin" must be enabled before it can be used (#1987) Prevent VPN server list persistence failures (#1985) add test can remove data (#1980) Remove VPN upgrade card (#1983) Fix low-res VPN warning asset (#1984) DBP: Fix unreliable date tests (#1981) Add search retention pixel for NetP (#1964) Sabrina/sync e2e tests (#1959) swiftlint build plugin (#1318) ... # Conflicts: # DuckDuckGo.xcodeproj/project.pbxproj # DuckDuckGo.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved # DuckDuckGo/Application/AppDelegate.swift
samsymons
added a commit
that referenced
this pull request
Dec 22, 2023
# By Dominik Kapusta (2) and others # Via GitHub * main: Make sure when we set custom config url, we don't expect etag in return (#1994) Add PixelKit source parameter (#1989) Fix internal user toggling (#2000) Show alert and display warning icon in Sync Settings when data syncing is disabled (#1996) DBP: Integrate subscription account authentication to DBP (#1995) Improve bookmarks html reader (#1986) Add Sync feature flags (#1992) Add daily stats pixel (#1993) Do not reload DBP tab when switching to it (#1942) Fix: external application requests via redirect URLs shows wrong origin. (#1900) # Conflicts: # DuckDuckGo/Statistics/PixelEvent.swift
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Task/Issue URL: https://app.asana.com/0/0/1206203334750907/f
Tech Design URL:
CC:
Description:
This PR adds a
sourceparameter to the PixelKitsetUpfunction, to allow us to include which target is sending the pixel.Steps to test this PR:
Internal references:
Pull Request Review Checklist
Software Engineering Expectations
Technical Design Template
Pull Request Documentation