Add new deprecated Mac remote message attribute. (#903)

Task/Issue URL: https://app.asana.com/0/1199333091098016/1207851439577905/f iOS PR: duckduckgo/iOS#3107 macOS PR: duckduckgo/macos-browser#2995 What kind of version bump will this require?: Major Optional: Tech Design URL: CC: Description: This PR adds a new attribute which can check whether a user interacted with a given remote message via the deprecated messaging system on macOS. This new attribute is a clone of the interactedWithMessage attribute, except we provide a different array. I considered simply appending the deprecated message IDs to the array we pass to interactedWithMessage, but would prefer to keep the arrays distinct in case of reused IDs between the two.
duckduckgo · Jul 19, 2024 · 16686ec · 16686ec
1 parent 3274feb
commit 16686ec
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 4 deletions.
diff --git a/Sources/RemoteMessaging/Mappers/JsonToRemoteMessageModelMapper.swift b/Sources/RemoteMessaging/Mappers/JsonToRemoteMessageModelMapper.swift
@@ -43,6 +43,7 @@ private enum AttributesKey: String, CaseIterable {
     case pproPurchasePlatform
     case pproSubscriptionStatus
     case interactedWithMessage
+    case interactedWithDeprecatedMacRemoteMessage
     case installedMacAppStore
     case pinnedTabs
     case customHomePage
@@ -74,6 +75,9 @@ private enum AttributesKey: String, CaseIterable {
         case .pproPurchasePlatform: return PrivacyProPurchasePlatformMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)
         case .pproSubscriptionStatus: return PrivacyProSubscriptionStatusMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)
         case .interactedWithMessage: return InteractedWithMessageMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)
+        case .interactedWithDeprecatedMacRemoteMessage: return InteractedWithDeprecatedMacRemoteMessageMatchingAttribute(
+            jsonMatchingAttribute: jsonMatchingAttribute
+        )
         case .installedMacAppStore: return IsInstalledMacAppStoreMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)
         case .pinnedTabs: return PinnedTabsMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)
         case .customHomePage: return CustomHomePageMatchingAttribute(jsonMatchingAttribute: jsonMatchingAttribute)

diff --git a/Sources/RemoteMessaging/Matchers/UserAttributeMatcher.swift b/Sources/RemoteMessaging/Matchers/UserAttributeMatcher.swift
@@ -94,6 +94,7 @@ public struct DesktopUserAttributeMatcher: AttributeMatching {
     private let hasCustomHomePage: Bool
     private let isDuckPlayerOnboarded: Bool
     private let isDuckPlayerEnabled: Bool
+    private let dismissedDeprecatedMacRemoteMessageIds: [String]
 
     private let commonUserAttributeMatcher: CommonUserAttributeMatcher
 
@@ -116,12 +117,14 @@ public struct DesktopUserAttributeMatcher: AttributeMatching {
                 pinnedTabsCount: Int,
                 hasCustomHomePage: Bool,
                 isDuckPlayerOnboarded: Bool,
-                isDuckPlayerEnabled: Bool
+                isDuckPlayerEnabled: Bool,
+                dismissedDeprecatedMacRemoteMessageIds: [String]
     ) {
         self.pinnedTabsCount = pinnedTabsCount
         self.hasCustomHomePage = hasCustomHomePage
         self.isDuckPlayerOnboarded = isDuckPlayerOnboarded
         self.isDuckPlayerEnabled = isDuckPlayerEnabled
+        self.dismissedDeprecatedMacRemoteMessageIds = dismissedDeprecatedMacRemoteMessageIds
 
         commonUserAttributeMatcher = .init(
             statisticsStore: statisticsStore,
@@ -153,6 +156,14 @@ public struct DesktopUserAttributeMatcher: AttributeMatching {
             return matchingAttribute.evaluate(for: isDuckPlayerOnboarded)
         case let matchingAttribute as DuckPlayerEnabledMatchingAttribute:
             return matchingAttribute.evaluate(for: isDuckPlayerEnabled)
+        case let matchingAttribute as InteractedWithDeprecatedMacRemoteMessageMatchingAttribute:
+            if dismissedDeprecatedMacRemoteMessageIds.contains(where: { messageId in
+                StringArrayMatchingAttribute(matchingAttribute.value).matches(value: messageId) == .match
+            }) {
+                return .match
+            } else {
+                return .fail
+            }
         default:
             return commonUserAttributeMatcher.evaluate(matchingAttribute: matchingAttribute)
         }

diff --git a/Sources/RemoteMessaging/Model/MatchingAttributes.swift b/Sources/RemoteMessaging/Model/MatchingAttributes.swift
@@ -159,6 +159,11 @@ struct InteractedWithMessageMatchingAttribute: SingleValueMatching {
     var fallback: Bool?
 }
 
+struct InteractedWithDeprecatedMacRemoteMessageMatchingAttribute: SingleValueMatching {
+    var value: [String]? = []
+    var fallback: Bool?
+}
+
 struct IsInstalledMacAppStoreMatchingAttribute: SingleValueMatching {
     var value: Bool?
     var fallback: Bool?

diff --git a/Tests/RemoteMessagingTests/Matchers/DesktopUserAttributeMatcherTests.swift b/Tests/RemoteMessagingTests/Matchers/DesktopUserAttributeMatcherTests.swift
@@ -51,7 +51,7 @@ class DesktopUserAttributeMatcherTests: XCTestCase {
         emailManagerStorage.mockToken = "token"
 
         emailManager = EmailManager(storage: emailManagerStorage)
-        setUpUserAttributeMatcher()
+        setUpUserAttributeMatcher(dismissedDeprecatedMacRemoteMessageIds: ["dismissed-message"])
     }
 
     override func tearDownWithError() throws {
@@ -133,9 +133,37 @@ class DesktopUserAttributeMatcherTests: XCTestCase {
                        .fail)
     }
 
+    // MARK: - DeprecatedMacRemoteMessage
+
+    func testWhenNoDismissedMessageIdsAreProvidedThenReturnFail() throws {
+        XCTAssertEqual(matcher.evaluate(
+            matchingAttribute: InteractedWithDeprecatedMacRemoteMessageMatchingAttribute(value: [], fallback: nil)
+        ), .fail)
+    }
+
+    func testWhenNoDismissedMessageIdsMatchThenReturnFail() throws {
+        XCTAssertEqual(matcher.evaluate(
+            matchingAttribute: InteractedWithDeprecatedMacRemoteMessageMatchingAttribute(value: ["unrelated-message"], fallback: nil)
+        ), .fail)
+    }
+
+    func testWhenOneDismissedMessageIdMatchesThenReturnMatch() throws {
+        XCTAssertEqual(matcher.evaluate(
+            matchingAttribute: InteractedWithDeprecatedMacRemoteMessageMatchingAttribute(value: ["dismissed-message"], fallback: nil)
+        ), .match)
+    }
+
+    func testWhenTwoDismissedMessageIdsMatchThenReturnMatch() throws {
+        XCTAssertEqual(matcher.evaluate(
+            matchingAttribute: InteractedWithDeprecatedMacRemoteMessageMatchingAttribute(value: [
+                "dismissed-message", "unrelated-message"
+            ], fallback: nil)
+        ), .match)
+    }
+
     // MARK: -
 
-    private func setUpUserAttributeMatcher(dismissedMessageIds: [String] = []) {
+    private func setUpUserAttributeMatcher(dismissedMessageIds: [String] = [], dismissedDeprecatedMacRemoteMessageIds: [String] = []) {
         matcher = DesktopUserAttributeMatcher(
             statisticsStore: mockStatisticsStore,
             variantManager: manager,
@@ -156,7 +184,8 @@ class DesktopUserAttributeMatcherTests: XCTestCase {
             pinnedTabsCount: 3,
             hasCustomHomePage: true,
             isDuckPlayerOnboarded: true,
-            isDuckPlayerEnabled: false
+            isDuckPlayerEnabled: false,
+            dismissedDeprecatedMacRemoteMessageIds: dismissedDeprecatedMacRemoteMessageIds
         )
     }
 }