Update the Privacy Pro status attribute to use an array. (#878)

Required: Task/Issue URL: https://app.asana.com/0/1199333091098016/1207731341550989/f iOS PR: duckduckgo/iOS#3033 macOS PR: duckduckgo/macos-browser#2940 What kind of version bump will this require?: Patch (technically the public API has not changed) Description: This PR updates the Privacy Pro status attribute to match an array instead of a string.
duckduckgo · Jul 4, 2024 · 6834243 · 6834243
1 parent a9a41a0
commit 6834243
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 23 deletions.
diff --git a/Sources/RemoteMessaging/Matchers/UserAttributeMatcher.swift b/Sources/RemoteMessaging/Matchers/UserAttributeMatcher.swift
@@ -160,19 +160,19 @@ public struct UserAttributeMatcher: AttributeMatcher {
         case let matchingAttribute as PrivacyProPurchasePlatformMatchingAttribute:
             return StringArrayMatchingAttribute(matchingAttribute.value).matches(value: privacyProPurchasePlatform ?? "")
         case let matchingAttribute as PrivacyProSubscriptionStatusMatchingAttribute:
-            guard let value = matchingAttribute.value else {
-                return .fail
+            let mappedStatuses = matchingAttribute.value.compactMap { status in
+                return PrivacyProSubscriptionStatus(rawValue: status)
             }
 
-            guard let status = PrivacyProSubscriptionStatus(rawValue: value) else {
-                return .fail
+            for status in mappedStatuses {
+                switch status {
+                case .active: if isPrivacyProSubscriptionActive { return .match }
+                case .expiring: if isPrivacyProSubscriptionExpiring { return .match }
+                case .expired: if isPrivacyProSubscriptionExpired { return .match }
+                }
             }
 
-            switch status {
-            case .active: return isPrivacyProSubscriptionActive ? .match : .fail
-            case .expiring: return isPrivacyProSubscriptionExpiring ? .match : .fail
-            case .expired: return isPrivacyProSubscriptionExpired ? .match : .fail
-            }
+            return .fail
         case let matchingAttribute as InteractedWithMessageMatchingAttribute:
             if dismissedMessageIds.contains(where: { messageId in
                 StringArrayMatchingAttribute(matchingAttribute.value).matches(value: messageId) == .match

diff --git a/Sources/RemoteMessaging/Model/MatchingAttributes.swift b/Sources/RemoteMessaging/Model/MatchingAttributes.swift
@@ -799,21 +799,22 @@ struct PrivacyProPurchasePlatformMatchingAttribute: MatchingAttribute, Equatable
 }
 
 struct PrivacyProSubscriptionStatusMatchingAttribute: MatchingAttribute, Equatable {
-    var value: String?
+    var value: [String] = []
     var fallback: Bool?
 
     init(jsonMatchingAttribute: AnyDecodable) {
-        guard let jsonMatchingAttribute = jsonMatchingAttribute.value as? [String: Any] else { return }
-
-        if let value = jsonMatchingAttribute[RuleAttributes.value] as? String {
+        guard let jsonMatchingAttribute = jsonMatchingAttribute.value as? [String: Any] else {
+            return
+        }
+        if let value = jsonMatchingAttribute[RuleAttributes.value] as? [String] {
             self.value = value
         }
         if let fallback = jsonMatchingAttribute[RuleAttributes.fallback] as? Bool {
             self.fallback = fallback
         }
     }
 
-    init(value: String?, fallback: Bool?) {
+    init(value: [String], fallback: Bool?) {
         self.value = value
         self.fallback = fallback
     }

diff --git a/.../BrowserServicesKitTests/RemoteMessaging/Mappers/JsonToRemoteConfigModelMapperTests.swift b/.../BrowserServicesKitTests/RemoteMessaging/Mappers/JsonToRemoteConfigModelMapperTests.swift
@@ -168,7 +168,7 @@ class JsonToRemoteConfigModelMapperTests: XCTestCase {
 
         attribs = rule8?.attributes.filter { $0 is PrivacyProSubscriptionStatusMatchingAttribute }
         XCTAssertEqual(attribs?.first as? PrivacyProSubscriptionStatusMatchingAttribute, PrivacyProSubscriptionStatusMatchingAttribute(
-            value: "active", fallback: nil
+            value: ["active", "expiring"], fallback: nil
         ))
 
         let rule9 = config.rules.filter { $0.id == 9 }.first

diff --git a/Tests/BrowserServicesKitTests/RemoteMessaging/Matchers/UserAttributeMatcherTests.swift b/Tests/BrowserServicesKitTests/RemoteMessaging/Matchers/UserAttributeMatcherTests.swift
@@ -250,35 +250,47 @@ class UserAttributeMatcherTests: XCTestCase {
 
     func testWhenPrivacyProSubscriptionStatusMatchesThenReturnMatch() throws {
         XCTAssertEqual(userAttributeMatcher.evaluate(
-            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: "active", fallback: nil)
+            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: ["active"], fallback: nil)
+        ), .match)
+    }
+
+    func testWhenPrivacyProSubscriptionStatusHasMultipleAttributesAndOneMatchesThenReturnMatch() throws {
+        XCTAssertEqual(userAttributeMatcher.evaluate(
+            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: ["active", "expiring", "expired"], fallback: nil)
         ), .match)
     }
 
     func testWhenPrivacyProSubscriptionStatusDoesNotMatchThenReturnFail() throws {
         XCTAssertEqual(userAttributeMatcher.evaluate(
-            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: "expiring", fallback: nil)
+            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: ["expiring"], fallback: nil)
         ), .fail)
     }
 
     func testWhenPrivacyProSubscriptionStatusHasUnsupportedStatusThenReturnFail() throws {
         XCTAssertEqual(userAttributeMatcher.evaluate(
-            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: "unsupported_status", fallback: nil)
+            matchingAttribute: PrivacyProSubscriptionStatusMatchingAttribute(value: ["unsupported_status"], fallback: nil)
         ), .fail)
     }
 
     func testWhenOneDismissedMessageIdMatchesThenReturnMatch() throws {
         setUpUserAttributeMatcher(dismissedMessageIds: ["1"])
-        XCTAssertEqual(userAttributeMatcher.evaluate(matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2", "3"], fallback: nil)), .match)
+        XCTAssertEqual(userAttributeMatcher.evaluate(
+            matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2", "3"], fallback: nil)
+        ), .match)
     }
 
     func testWhenAllDismissedMessageIdsMatchThenReturnMatch() throws {
         setUpUserAttributeMatcher(dismissedMessageIds: ["1", "2", "3"])
-        XCTAssertEqual(userAttributeMatcher.evaluate(matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2", "3"], fallback: nil)), .match)
+        XCTAssertEqual(userAttributeMatcher.evaluate(
+            matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2", "3"], fallback: nil)
+        ), .match)
     }
 
     func testWhenNoDismissedMessageIdsMatchThenReturnFail() throws {
         setUpUserAttributeMatcher(dismissedMessageIds: ["1", "2", "3"])
-        XCTAssertEqual(userAttributeMatcher.evaluate(matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["4", "5"], fallback: nil)), .fail)
+        XCTAssertEqual(userAttributeMatcher.evaluate(
+            matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["4", "5"], fallback: nil)
+        ), .fail)
     }
 
     func testWhenHaveDismissedMessageIdsAndMatchAttributeIsEmptyThenReturnFail() throws {
@@ -288,7 +300,9 @@ class UserAttributeMatcherTests: XCTestCase {
 
     func testWhenHaveNoDismissedMessageIdsAndMatchAttributeIsNotEmptyThenReturnFail() throws {
         setUpUserAttributeMatcher(dismissedMessageIds: [])
-        XCTAssertEqual(userAttributeMatcher.evaluate(matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2"], fallback: nil)), .fail)
+        XCTAssertEqual(userAttributeMatcher.evaluate(
+            matchingAttribute: InteractedWithMessageMatchingAttribute(value: ["1", "2"], fallback: nil)
+        ), .fail)
     }
 
     private func setUpUserAttributeMatcher(dismissedMessageIds: [String] = []) {

diff --git a/Tests/BrowserServicesKitTests/Resources/remote-messaging-config.json b/Tests/BrowserServicesKitTests/Resources/remote-messaging-config.json
@@ -270,7 +270,7 @@
           "value": ["apple", "stripe"]
         },
         "pproSubscriptionStatus": {
-          "value": "active"
+          "value": ["active", "expiring"]
         },
         "pproDaysSinceSubscribed": {
             "min": 5,