[DIA-2937] special feature toggle tvos (#517)

* [DIA-2937] Saving `specialFeatures` * [DIA-2937] Add toggle logic for `specialFeatures` * [DIA-2937] Add `specialFeatures` on `ManagePreferenceView` * [DIA-2937] Test fix * [DIA-2937] Test fix * [DIA-2937] Short notation and remove inherit from `Int` * [DIA-2937] lint fix
SourcePointUSA · Nov 15, 2023 · 9ffbafe · 9ffbafe
1 parent 0438baa
commit 9ffbafe
Show file tree

Hide file tree

Showing 14 changed files with 95 additions and 31 deletions.
diff --git a/ConsentViewController/Classes/Consents/SPGDPRConsent.swift b/ConsentViewController/Classes/Consents/SPGDPRConsent.swift
@@ -77,6 +77,7 @@ public typealias SPGDPRPurposeId = String
         case legIntVendors
         case vendors
         case categories
+        case specialFeatures
         case dateCreated
         case expirationDate
     }
@@ -145,6 +146,7 @@ public typealias SPGDPRPurposeId = String
     var legIntVendors: [String]?
     var vendors: [String]?
     var categories: [String]?
+    var specialFeatures: [String]?
 
     override open var description: String {
         """
@@ -170,6 +172,7 @@ public typealias SPGDPRPurposeId = String
         legIntVendors = try container.decodeIfPresent(Array.self, forKey: .legIntVendors)
         vendors = try container.decodeIfPresent(Array.self, forKey: .vendors)
         categories = try container.decodeIfPresent(Array.self, forKey: .categories)
+        specialFeatures = try container.decodeIfPresent(Array.self, forKey: .specialFeatures)
         expirationDate = try container.decode(SPDate.self, forKey: .expirationDate)
         if let date = try container.decodeIfPresent(SPDate.self, forKey: .dateCreated) {
             dateCreated = date

diff --git a/ConsentViewController/Classes/SPConsentManager.swift b/ConsentViewController/Classes/SPConsentManager.swift
@@ -560,6 +560,7 @@ extension SPConsentManager: SPNativePMDelegate {
                 pmData.legIntVendors = self?.userData.gdpr?.consents?.legIntVendors ?? []
                 pmData.acceptedVendors = self?.userData.gdpr?.consents?.vendors ?? []
                 pmData.acceptedCategories = self?.userData.gdpr?.consents?.categories ?? []
+                pmData.acceptedSpecialFeatures = self?.userData.gdpr?.consents?.specialFeatures ?? []
                 pmData.hasConsentData = self?.userData.gdpr?.consents?.consentStatus.hasConsentData
                 handler(result.map { _ in pmData })
             }

diff --git a/ConsentViewController/Classes/SourcePointClient/ChoiceAllResponse.swift b/ConsentViewController/Classes/SourcePointClient/ChoiceAllResponse.swift
@@ -42,6 +42,7 @@ struct ChoiceAllResponse: Decodable {
         let legIntVendors: [String]?
         let vendors: [String]?
         let categories: [String]?
+        let specialFeatures: [String]?
     }
 
     let gdpr: GDPR?

diff --git a/ConsentViewController/Classes/SourcePointClient/ChoiceResponses.swift b/ConsentViewController/Classes/SourcePointClient/ChoiceResponses.swift
@@ -19,6 +19,7 @@ struct GDPRChoiceResponse: Decodable, Equatable {
     let legIntVendors: [String]?
     let vendors: [String]?
     let categories: [String]?
+    let specialFeatures: [String]?
 }
 
 struct CCPAChoiceResponse: Equatable {

diff --git a/ConsentViewController/Classes/SourcePointClient/ConsentStatusResponse.swift b/ConsentViewController/Classes/SourcePointClient/ConsentStatusResponse.swift
@@ -20,6 +20,7 @@ struct ConsentStatusResponse: Decodable, Equatable {
             let legIntVendors: [String]
             let vendors: [String]
             let categories: [String]
+            let specialFeatures: [String]
         }
 
         struct CCPA: Decodable, Equatable {

diff --git a/ConsentViewController/Classes/SourcePointClient/GDPRPrivacyManagerViewResponse.swift b/ConsentViewController/Classes/SourcePointClient/GDPRPrivacyManagerViewResponse.swift
@@ -130,7 +130,7 @@ struct GDPRPrivacyManagerViewResponse: Decodable {
     let vendors: [GDPRVendor]
     let categories, specialPurposes, features, specialFeatures: [GDPRCategory]
     var grants: SPGDPRVendorGrants?
-    var legIntCategories, legIntVendors, acceptedVendors, acceptedCategories: [String]?
+    var legIntCategories, legIntVendors, acceptedVendors, acceptedCategories, acceptedSpecialFeatures: [String]?
     var hasConsentData: Bool?
 }
 

diff --git a/ConsentViewController/Classes/SourcePointClient/SourcepointClientCoordinator.swift b/ConsentViewController/Classes/SourcePointClient/SourcepointClientCoordinator.swift
@@ -440,6 +440,7 @@ class SourcepointClientCoordinator: SPClientCoordinator {
             state.gdpr?.legIntVendors = gdpr.legIntVendors
             state.gdpr?.vendors = gdpr.vendors
             state.gdpr?.categories = gdpr.categories
+            state.gdpr?.specialFeatures = gdpr.specialFeatures
         }
         if let ccpa = response.consentStatusData.ccpa {
             state.ccpa?.uuid = ccpa.uuid
@@ -735,6 +736,7 @@ class SourcepointClientCoordinator: SPClientCoordinator {
         state.gdpr?.legIntVendors = postResponse.legIntVendors ?? getResponse?.gdpr?.legIntVendors
         state.gdpr?.vendors = postResponse.vendors ?? getResponse?.gdpr?.vendors
         state.gdpr?.categories = postResponse.categories ?? getResponse?.gdpr?.categories
+        state.gdpr?.specialFeatures = postResponse.specialFeatures ?? getResponse?.gdpr?.specialFeatures
         storage.spState = state
     }
 

diff --git a/...entViewController/Classes/Views/tvOS/NativePrivacyManager/Common/LongButtonViewCell.swift b/...entViewController/Classes/Views/tvOS/NativePrivacyManager/Common/LongButtonViewCell.swift
@@ -16,6 +16,7 @@ class LongButtonViewCell: UITableViewCell {
     var customText: String?
     var selectable = false
     var identifier: String = ""
+    var contentType: CategoryContentType?
 
     @IBOutlet var label: UILabel!
     @IBOutlet var customLabel: UILabel!

diff --git a/...ntViewController/Classes/Views/tvOS/NativePrivacyManager/GDPR/GDPRPMConsentSnapshot.swift b/...ntViewController/Classes/Views/tvOS/NativePrivacyManager/GDPR/GDPRPMConsentSnapshot.swift
@@ -11,6 +11,12 @@ protocol ConsentSnapshot {
     func toPayload(language: SPMessageLanguage, pmId: String) -> JSONAble
 }
 
+public enum CategoryContentType {
+    case consent
+    case legitimate
+    case specialFeatures
+}
+
 class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCategoryManager {
     typealias VendorType = GDPRVendor
     typealias CategoryType = GDPRCategory
@@ -26,6 +32,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
     var toggledCategoriesIds: Set<String>
     var toggledConsentCategoriesIds: Set<String>
     var toggledLICategoriesIds: Set<String>
+    var toggledSpecialFeatures: Set<String>
 
     var consentVendorsWhosePurposesAreOff: [String] {
         toggledConsentVendorsIds
@@ -78,6 +85,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
         toggledLIVendorsIds = Set<String>([])
         toggledConsentCategoriesIds = Set<String>([])
         toggledLICategoriesIds = Set<String>([])
+        toggledSpecialFeatures = Set<String>([])
     }
 
     convenience init(
@@ -86,6 +94,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
         legIntVendors: [String]?,
         acceptedVendors: [String]?,
         acceptedCategories: [String]?,
+        acceptedSpecialFeatures: [String]?,
         hasConsentData: Bool,
         vendors: Set<GDPRVendor>,
         categories: Set<GDPRCategory>,
@@ -103,6 +112,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
         )
         toggledVendorsIds.formUnion(acceptedVendors ?? [])
         toggledCategoriesIds.formUnion(acceptedCategories ?? [])
+        toggledSpecialFeatures.formUnion(acceptedSpecialFeatures ?? [])
         if hasConsentData {
             toggledConsentVendorsIds = Set<String>(acceptedVendors ?? [])
             toggledLIVendorsIds = Set<String>(legIntVendors ?? [])
@@ -124,6 +134,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
         toggledCategoriesIds = []
         toggledConsentCategoriesIds = []
         toggledLICategoriesIds = []
+        toggledSpecialFeatures = []
         vendors = []
         categories = []
         specialPurposes = []
@@ -136,7 +147,7 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
             lan: language,
             privacyManagerId: pmId,
             categories: toggledCategoriesIds.compactMap { id in
-                guard let category = categories.first(where: { c in c._id == id }) else { return nil }
+                guard let category = categories.first(where: { $0._id == id }) else { return nil }
                 return GDPRPMPayload.Category(
                     _id: id,
                     iabId: category.iabId,
@@ -146,14 +157,21 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
                 )
             },
             vendors: toggledVendorsIds.compactMap { id in
-                guard let vendor = vendors.first(where: { v in v.vendorId == id }) else { return nil }
+                guard let vendor = vendors.first(where: { $0.vendorId == id }) else { return nil }
                 return GDPRPMPayload.Vendor(
                     _id: id,
                     iabId: vendor.iabId,
                     consent: toggledConsentVendorsIds.contains(id),
                     legInt: toggledLIVendorsIds.contains(id),
                     vendorType: vendor.vendorType
                 )
+            },
+            specialFeatures: toggledSpecialFeatures.compactMap { id in
+                guard let feature = specialFeatures.first(where: { $0._id == id }) else { return nil }
+                return GDPRPMPayload.Feature(
+                    _id: id,
+                    iabId: feature.iabId
+                )
             }
         )
     }
@@ -166,26 +184,44 @@ class GDPRPMConsentSnaptshot: NSObject, ConsentSnapshot, PMVendorManager, PMCate
 
     func onVendorOff(_ vendor: GDPRVendor) {}
 
-    func onCategoryOn(category: GDPRCategory, legInt: Bool) {
-        if legInt {
-            toggledLICategoriesIds.insert(category._id)
-            toggledLIVendorsIds.formUnion(category.uniqueLIVendorIds)
-        } else {
+    func onCategoryOn(category: GDPRCategory, type: CategoryContentType?) {
+        switch type {
+        case .consent:
             toggledConsentCategoriesIds.insert(category._id)
             toggledConsentVendorsIds.formUnion(category.uniqueConsentVendorIds)
+
+        case .legitimate:
+            toggledLICategoriesIds.insert(category._id)
+            toggledLIVendorsIds.formUnion(category.uniqueLIVendorIds)
+
+        case .specialFeatures:
+            toggledSpecialFeatures.insert(category._id)
+
+        case .none:
+            break
+        }
+        if type != .specialFeatures {
+            toggledCategoriesIds.insert(category._id)
+            toggledVendorsIds.formUnion(category.uniqueVendorIds)
         }
-        toggledCategoriesIds.insert(category._id)
-        toggledVendorsIds.formUnion(category.uniqueVendorIds)
         onConsentsChange()
     }
 
-    func onCategoryOff(category: GDPRCategory, legInt: Bool) {
-        if legInt {
-            toggledLICategoriesIds.remove(category._id)
-            toggledLIVendorsIds.subtract(liVendorsWhosePurposesAreOff)
-        } else {
+    func onCategoryOff(category: GDPRCategory, type: CategoryContentType?) {
+        switch type {
+        case .consent:
             toggledConsentCategoriesIds.remove(category._id)
             toggledConsentVendorsIds.subtract(consentVendorsWhosePurposesAreOff)
+
+        case .legitimate:
+            toggledLICategoriesIds.remove(category._id)
+            toggledLIVendorsIds.subtract(liVendorsWhosePurposesAreOff)
+
+        case .specialFeatures:
+            toggledSpecialFeatures.remove(category._id)
+
+        case .none:
+            break
         }
         onConsentsChange()
     }

diff --git a/...er/Classes/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRCategoryDetailsViewController.swift b/...er/Classes/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRCategoryDetailsViewController.swift
@@ -12,7 +12,8 @@ class SPGDPRCategoryDetailsViewController: SPNativeScreenViewController {
     weak var categoryManagerDelegate: GDPRPMConsentSnaptshot?
 
     var category: GDPRCategory?
-    var displayingLegIntCategories = false
+    var categoryType: CategoryContentType?
+    var displayingLegIntCategories: Bool { categoryType == .legitimate }
     var purposeToggleActive = true
     var partners: [String] {
         ((displayingLegIntCategories ?
@@ -57,14 +58,14 @@ class SPGDPRCategoryDetailsViewController: SPNativeScreenViewController {
 
     @IBAction func onOnButtonTap(_ sender: Any) {
         if let category = category {
-            categoryManagerDelegate?.onCategoryOn(category: category, legInt: displayingLegIntCategories)
+            categoryManagerDelegate?.onCategoryOn(category: category, type: categoryType)
         }
         dismiss(animated: true)
     }
 
     @IBAction func onOffButtonTap(_ sender: Any) {
         if let category = category {
-            categoryManagerDelegate?.onCategoryOff(category: category, legInt: displayingLegIntCategories)
+            categoryManagerDelegate?.onCategoryOff(category: category, type: categoryType)
         }
         dismiss(animated: true)
     }

diff --git a/...r/Classes/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRManagePreferenceViewController.swift b/...r/Classes/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRManagePreferenceViewController.swift
@@ -150,9 +150,13 @@ class SPGDPRManagePreferenceViewController: SPNativeScreenViewController {
 // MARK: UITableViewDataSource
 extension SPGDPRManagePreferenceViewController: UITableViewDataSource, UITableViewDelegate {
     func currentCategory(_ index: IndexPath) -> GDPRCategory {
-        displayingLegIntCategories ?
+        if index.section >= 2 {
+            return sections[index.section].contentConsent[index.row]
+        } else {
+            return displayingLegIntCategories ?
             sections[index.section].contentLegIntCategory[index.row] :
             sections[index.section].contentConsent[index.row]
+        }
     }
 
     func tableView(_ tableView: UITableView, estimatedHeightForHeaderInSection section: Int) -> CGFloat {
@@ -194,14 +198,23 @@ extension SPGDPRManagePreferenceViewController: UITableViewDataSource, UITableVi
         let category = currentCategory(indexPath)
         cell.identifier = category._id
         cell.labelText = category.name
-        if displayingLegIntCategories {
-            cell.isOn = section == 0 || section == 3 ?
-                consentsSnapshot.toggledLICategoriesIds.contains(category._id) :
-                nil
-        } else {
-            cell.isOn = section == 0 || section == 3 ?
-                consentsSnapshot.toggledConsentCategoriesIds.contains(category._id) :
-                nil
+        switch section {
+        case 0:
+            if displayingLegIntCategories {
+                cell.contentType = .legitimate
+                cell.isOn = consentsSnapshot.toggledLICategoriesIds.contains(category._id)
+            } else {
+                cell.contentType = .consent
+                cell.isOn = consentsSnapshot.toggledConsentCategoriesIds.contains(category._id)
+            }
+
+        case 3:
+            cell.contentType = .specialFeatures
+            cell.isOn = consentsSnapshot.toggledSpecialFeatures.contains(category._id)
+
+        default:
+            cell.contentType = nil
+            cell.isOn = nil
         }
         cell.selectable = true
         cell.isCustom = category.type != .IAB || category.type != .IAB_PURPOSE
@@ -229,6 +242,7 @@ extension SPGDPRManagePreferenceViewController: UITableViewDataSource, UITableVi
     }
 
     func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
+        let cell = tableView.cellForRow(at: indexPath) as? LongButtonViewCell
         let categoryDetailsVC = SPGDPRCategoryDetailsViewController(
             messageId: messageId,
             campaignType: campaignType,
@@ -239,8 +253,8 @@ extension SPGDPRManagePreferenceViewController: UITableViewDataSource, UITableVi
         )
         categoryDetailsVC.category = currentCategory(indexPath)
         categoryDetailsVC.categoryManagerDelegate = consentsSnapshot
-        categoryDetailsVC.displayingLegIntCategories = displayingLegIntCategories
-        categoryDetailsVC.purposeToggleActive = indexPath.section == 0
+        categoryDetailsVC.categoryType = cell?.contentType
+        categoryDetailsVC.purposeToggleActive = indexPath.section == 0 || indexPath.section == 3
         present(categoryDetailsVC, animated: true)
     }
 }
diff --git a/...asses/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRNativePrivacyManagerViewController.swift b/...asses/Views/tvOS/NativePrivacyManager/GDPR/SPGDPRNativePrivacyManagerViewController.swift
@@ -111,6 +111,7 @@ protocol SPNativePrivacyManagerHome {
                                 legIntVendors: data.legIntVendors,
                                 acceptedVendors: data.acceptedVendors,
                                 acceptedCategories: data.acceptedCategories,
+                                acceptedSpecialFeatures: data.acceptedSpecialFeatures,
                                 hasConsentData: data.hasConsentData ?? false,
                                 vendors: Set<GDPRVendor>(data.vendors),
                                 categories: Set<GDPRCategory>(data.categories),
@@ -165,6 +166,7 @@ protocol SPNativePrivacyManagerHome {
                             legIntVendors: data.legIntVendors,
                             acceptedVendors: data.acceptedVendors,
                             acceptedCategories: data.acceptedCategories,
+                            acceptedSpecialFeatures: data.acceptedSpecialFeatures,
                             hasConsentData: data.hasConsentData ?? false,
                             vendors: Set<GDPRVendor>(data.vendors),
                             categories: Set<GDPRCategory>(data.categories),

diff --git a/Example/ConsentViewController_ExampleTests/Helpers/SourcePointClientMock.swift b/Example/ConsentViewController_ExampleTests/Helpers/SourcePointClientMock.swift
@@ -165,7 +165,8 @@ class SourcePointClientMock: SourcePointProtocol {
                 legIntCategories: nil,
                 legIntVendors: nil,
                 vendors: nil,
-                categories: nil
+                categories: nil,
+                specialFeatures: nil
             )))
         }
     }

diff --git a/Example/NativePMExampleAppUITests/NativePMUITests.swift b/Example/NativePMExampleAppUITests/NativePMUITests.swift
@@ -24,7 +24,7 @@ extension XCUIElement {
 class NativePMUITests: QuickSpec {
     var app: NativePMApp!
     var timeout = 20
-    var gdprCategoriesCount = 10
+    var gdprCategoriesCount = 12
     var ccpaCategoriesCount = 3
     var gdprCategoriePlusSpecialFeatures = 12
     var gdprDefaultOnCategories = 3