Add support for skipping sending usage pixels for remote messages #902
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
ayoy
commented
Jul 18, 2024
| self.content = try container.decodeIfPresent(RemoteMessageModelType.self, forKey: .content) | ||
| self.matchingRules = try container.decode([Int].self, forKey: .matchingRules) | ||
| self.exclusionRules = try container.decode([Int].self, forKey: .exclusionRules) | ||
| self.isMetricsEnabled = try container.decodeIfPresent(Bool.self, forKey: .isMetricsEnabled) ?? true |
There was a problem hiding this comment.
The ?? true part is why we require custom init function
Comment on lines
+39
to
+51
|
|
||
| var isMetricsEnabled: Bool { | ||
| metrics?.state.flatMap(JsonMetrics.MetricsState.init) != .disabled | ||
| } | ||
| } | ||
|
|
||
| struct JsonMetrics: Decodable { | ||
| let state: String? | ||
|
|
||
| enum MetricsState: String, Decodable { | ||
| case disabled | ||
| case enabled | ||
| } |
There was a problem hiding this comment.
This is the actual change – parse metrics object within the message definition if it exists and decode state property. If "disabled", disable metrics.
There was a problem hiding this comment.
This file contains all supported cases for metrics object, including no metrics object at all.
This was referenced Jul 18, 2024
Merged
quanganhdo
reviewed
Jul 19, 2024
Comment on lines
+416
to
+429
| <BuildActionEntry | ||
| buildForTesting = "YES" | ||
| buildForRunning = "YES" | ||
| buildForProfiling = "YES" | ||
| buildForArchiving = "YES" | ||
| buildForAnalyzing = "YES"> | ||
| <BuildableReference | ||
| BuildableIdentifier = "primary" | ||
| BlueprintIdentifier = "CxxCrashHandler" | ||
| BuildableName = "CxxCrashHandler" | ||
| BlueprintName = "CxxCrashHandler" | ||
| ReferencedContainer = "container:"> | ||
| </BuildableReference> | ||
| </BuildActionEntry> |
There was a problem hiding this comment.
My Xcode keeps bugging me about adding this. It's an update to the otherwise auto-generated scheme, so I reckon it doesn't hurt to include it.
quanganhdo
approved these changes
Jul 19, 2024
samsymons
added a commit
that referenced
this pull request
Jul 19, 2024
* main: Remove unused VPN session utilities (#898) Add new deprecated Mac remote message attribute. (#903) Resetting all state for the VPN will cancel the tunnel and stop the monitors (#900) Add support for skipping sending usage pixels for remote messages (#902) Bump Tests/BrowserServicesKitTests/Resources/privacy-reference-tests (#896) Removes the listen port from the wireguard client (#901) Be explicit when performing developer redirects (#884) C-S-S cross origin fixes Update C-S-S version (#892) Add a debug menu action to reset Remote Messages on macOS (#891) Add desktop specific RMF attributes (#883) Upload exception message to Sentry (#856) Add locale to broken site report (#889) Add new subfeature for duckplayer (#885) Swiftlint refactoring (#882) Remote Messaging Framework for macOS (#876)
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.
Please review the release process for BrowserServicesKit here.
Required:
Task/Issue URL: https://app.asana.com/0/1201621708115095/1207841204698435/f
iOS PR: duckduckgo/iOS#3106
macOS PR: duckduckgo/macos-browser#2994
What kind of version bump will this require?: Major
Description:
This change allows to skip sending usage pixels for a given remote message if that's stated in the RMF config.
Steps to test this PR:
For both iOS and macOS apps:
https://www.jsonblob.com/api/1263462242434539520. This config contains 4 messages: 1, 2, and 4 send pixels, and 3 has pixels disabled.OS Testing:
Internal references:
Software Engineering Expectations
Technical Design Template