Merge pull request #579 from SourcePointUSA/DIA-4263_fix_pv-data_payload

DIA-4263 fix `/pv-data` payload
SourcePointUSA · Aug 27, 2024 · a12966d · a12966d
2 parents d2415f3 + 948d7f7
commit a12966d
Show file tree

Hide file tree

Showing 16 changed files with 245 additions and 182 deletions.
diff --git a/ConsentViewController/Assets/javascript/SPJSReceiver.js b/ConsentViewController/Assets/javascript/SPJSReceiver.js
@@ -44,7 +44,8 @@ var getActionFromMessage = function (eventData) {
         type: choiceData.type,
         pmUrl: choiceData.pmUrl || choiceData.iframe_url,
         consentLanguage: eventData.consentLanguage,
-        customActionId: choiceData.customAction
+        customActionId: choiceData.customAction,
+        messageId: eventData.messageId
     };
 };
 
@@ -67,7 +68,8 @@ var handleMessageEvent = function(SDK) {
                         payload: eventData.payload,
                         consentLanguage: eventData.consentLanguage,
                         customActionId: eventData.customAction,
-                        pmUrl: eventData.pmUrl
+                        pmUrl: eventData.pmUrl,
+                        messageId: eventData.messageId
                     }) :
                     SDK.onAction(getActionFromMessage(eventData));
                 break;

diff --git a/ConsentViewController/Classes/Consents/LastMessageData.swift b/ConsentViewController/Classes/Consents/LastMessageData.swift
diff --git a/ConsentViewController/Classes/Consents/SPCCPAConsent.swift b/ConsentViewController/Classes/Consents/SPCCPAConsent.swift
@@ -125,9 +125,6 @@ extension SPUSPString {
     /// In case `/getMessages` request was done with `groupPmId`, `childPmId` will be returned
     var childPmId: String?
 
-    /// Required by SP endpoints
-    var lastMessage: LastMessageData?
-
     /// Required by SP endpoints
     var consentStatus: ConsentStatus
 
@@ -166,7 +163,6 @@ extension SPUSPString {
         applies: Bool,
         dateCreated: SPDate,
         expirationDate: SPDate,
-        lastMessage: LastMessageData?,
         consentStatus: ConsentStatus = ConsentStatus(),
         webConsentPayload: SPWebConsentPayload? = nil,
         GPPData: SPJson = SPJson()
@@ -183,7 +179,6 @@ extension SPUSPString {
         self.applies = applies
         self.dateCreated = dateCreated
         self.expirationDate = expirationDate
-        self.lastMessage = lastMessage
     }
 
     public required init(from decoder: Decoder) throws {
@@ -211,8 +206,7 @@ extension SPUSPString {
         signedLspa: false,
         applies: false,
         dateCreated: .now(),
-        expirationDate: .distantFuture(),
-        lastMessage: nil
+        expirationDate: .distantFuture()
     )}
 
     public func copy(with zone: NSZone? = nil) -> Any {
@@ -226,7 +220,6 @@ extension SPUSPString {
             applies: applies,
             dateCreated: dateCreated,
             expirationDate: expirationDate,
-            lastMessage: lastMessage,
             consentStatus: consentStatus,
             webConsentPayload: webConsentPayload,
             GPPData: GPPData

diff --git a/ConsentViewController/Classes/Consents/SPGDPRConsent.swift b/ConsentViewController/Classes/Consents/SPGDPRConsent.swift
@@ -103,9 +103,6 @@ public typealias SPGDPRPurposeId = String
     /// Information required by Google's Firebase Analytics SDK, GCM 2.0
     public var googleConsentMode: SPGCMData?
 
-    /// Required by SP endpoints
-    var lastMessage: LastMessageData?
-
     /// Used by the rendering app
     var webConsentPayload: SPWebConsentPayload?
 
@@ -158,7 +155,6 @@ public typealias SPGDPRPurposeId = String
         expirationDate: SPDate,
         applies: Bool,
         consentStatus: ConsentStatus = ConsentStatus(),
-        lastMessage: LastMessageData? = nil,
         webConsentPayload: SPWebConsentPayload? = nil,
         googleConsentMode: SPGCMData? = nil,
         acceptedLegIntCategories: [String] = [],
@@ -176,7 +172,6 @@ public typealias SPGDPRPurposeId = String
         self.expirationDate = expirationDate
         self.applies = applies
         self.consentStatus = consentStatus
-        self.lastMessage = lastMessage
         self.webConsentPayload = webConsentPayload
         self.googleConsentMode = googleConsentMode
         self.acceptedLegIntCategories = acceptedLegIntCategories
@@ -224,7 +219,6 @@ public typealias SPGDPRPurposeId = String
             expirationDate: expirationDate,
             applies: applies,
             consentStatus: consentStatus,
-            lastMessage: lastMessage,
             webConsentPayload: webConsentPayload,
             googleConsentMode: googleConsentMode,
             acceptedLegIntCategories: acceptedLegIntCategories,

diff --git a/ConsentViewController/Classes/Consents/SPUSNatConsent.swift b/ConsentViewController/Classes/Consents/SPUSNatConsent.swift
@@ -34,9 +34,6 @@ import Foundation
 
     var dateCreated, expirationDate: SPDate
 
-    /// Required by SP endpoints
-    var lastMessage: LastMessageData?
-
     /// Used by the rendering app
     let webConsentPayload: SPWebConsentPayload?
 
@@ -54,7 +51,6 @@ import Foundation
         expirationDate: SPDate,
         consentStrings: [ConsentString],
         webConsentPayload: SPWebConsentPayload? = nil,
-        lastMessage: LastMessageData? = nil,
         categories: [SPConsentable],
         vendors: [SPConsentable],
         consentStatus: ConsentStatus,
@@ -66,7 +62,6 @@ import Foundation
         self.expirationDate = expirationDate
         self.consentStrings = consentStrings
         self.webConsentPayload = webConsentPayload
-        self.lastMessage = lastMessage
         self.consentStatus = consentStatus
         self.GPPData = GPPData
         self.userConsents = UserConsents(vendors: vendors, categories: categories)
@@ -80,7 +75,6 @@ import Foundation
         expirationDate = try container.decode(SPDate.self, forKey: .expirationDate)
         consentStrings = try container.decode([ConsentString].self, forKey: .consentStrings)
         webConsentPayload = try container.decodeIfPresent(SPWebConsentPayload.self, forKey: .webConsentPayload)
-        lastMessage = try container.decodeIfPresent(LastMessageData.self, forKey: .lastMessage)
         consentStatus = try container.decode(ConsentStatus.self, forKey: .consentStatus)
         GPPData = try container.decodeIfPresent(SPJson.self, forKey: .GPPData)
         userConsents = try container.decodeIfPresent(UserConsents.self, forKey: .userConsents) ?? UserConsents(vendors: [], categories: [])
@@ -131,7 +125,6 @@ extension SPUSNatConsent {
         expirationDate: expirationDate,
         consentStrings: consentStrings,
         webConsentPayload: webConsentPayload,
-        lastMessage: lastMessage,
         categories: categories,
         vendors: vendors,
         consentStatus: consentStatus,

diff --git a/ConsentViewController/Classes/SPAction.swift b/ConsentViewController/Classes/SPAction.swift
@@ -62,6 +62,7 @@ import Foundation
     /// This property will be renamed to `publisherData` in the next major release
     public var encodablePubData: SPPublisherData = [:]
     public var customActionId: String?
+    public var messageId: String?
 
     override public var description: String {
         """
@@ -78,7 +79,8 @@ import Foundation
         consentLanguage: String? = nil,
         pmPayload: SPJson = SPJson(),
         pmurl: URL? = nil,
-        customActionId: String? = nil
+        customActionId: String? = nil,
+        messageId: String? = nil
     ) {
         self.type = type
         self.campaignType = campaignType
@@ -87,16 +89,18 @@ import Foundation
         self.pmPayload = pmPayload
         self.pmURL = pmurl
         self.customActionId = customActionId
+        self.messageId = messageId
     }
 
     override public func isEqual(_ object: Any?) -> Bool {
         guard let other = object as? SPAction else {
             return false
         }
         return other.type == type &&
-        other.consentLanguage == consentLanguage &&
-        other.pmURL == pmURL &&
-        other.pmPayload == pmPayload &&
-        other.publisherData == publisherData
+            other.consentLanguage == consentLanguage &&
+            other.pmURL == pmURL &&
+            other.pmPayload == pmPayload &&
+            other.publisherData == publisherData &&
+            other.messageId == messageId
     }
 }
diff --git a/ConsentViewController/Classes/SPConsentManager.swift b/ConsentViewController/Classes/SPConsentManager.swift
@@ -575,9 +575,21 @@ extension SPConsentManager: SPMessageUIDelegate {
                     osVersion: self?.deviceManager.osVersion ?? ""
                 )
                 if status == .accepted {
-                    self?.onAction(SPAction(type: .IDFAAccepted, campaignType: .ios14), from: controller)
+                    self?.onAction(
+                        SPAction(
+                            type: .IDFAAccepted,
+                            campaignType: .ios14,
+                            messageId: action.messageId
+                        ),
+                        from: controller
+                    )
                 } else if status == .denied {
-                    self?.onAction(SPAction(type: .IDFADenied, campaignType: .ios14), from: controller)
+                    self?.onAction(
+                        SPAction(
+                            type: .IDFADenied,
+                            campaignType: .ios14,
+                            messageId: action.messageId
+                        ), from: controller)
                 }
                 self?.nextMessageIfAny(controller)
             }

diff --git a/ConsentViewController/Classes/SourcePointClient/MessagesResponse.swift b/ConsentViewController/Classes/SourcePointClient/MessagesResponse.swift
@@ -152,7 +152,7 @@ extension Consent: Codable {
         }
     }
 
-    func toConsent(defaults: SPUSNatConsent?, messageMetaData: MessageMetaData?) -> SPUSNatConsent? {
+    func toConsent(defaults: SPUSNatConsent?) -> SPUSNatConsent? {
         switch self {
             case .usnat(let consents):
                 return SPUSNatConsent(
@@ -162,7 +162,6 @@ extension Consent: Codable {
                     expirationDate: consents.expirationDate,
                     consentStrings: consents.consentStrings,
                     webConsentPayload: consents.webConsentPayload,
-                    lastMessage: LastMessageData(from: messageMetaData),
                     categories: consents.categories,
                     vendors: consents.vendors,
                     consentStatus: consents.consentStatus,
@@ -174,7 +173,7 @@ extension Consent: Codable {
         }
     }
 
-    func toConsent(defaults: SPCCPAConsent?, messageMetaData: MessageMetaData?) -> SPCCPAConsent? {
+    func toConsent(defaults: SPCCPAConsent?) -> SPCCPAConsent? {
         switch self {
             case .ccpa(let consents):
                 return SPCCPAConsent(
@@ -187,7 +186,6 @@ extension Consent: Codable {
                     applies: defaults?.applies ?? false,
                     dateCreated: consents.dateCreated,
                     expirationDate: consents.expirationDate,
-                    lastMessage: LastMessageData(from: messageMetaData),
                     consentStatus: consents.consentStatus,
                     webConsentPayload: consents.webConsentPayload,
                     GPPData: consents.GPPData
@@ -198,7 +196,7 @@ extension Consent: Codable {
         }
     }
 
-    func toConsent(defaults: SPGDPRConsent?, messageMetaData: MessageMetaData?) -> SPGDPRConsent? {
+    func toConsent(defaults: SPGDPRConsent?) -> SPGDPRConsent? {
         switch self {
             case .gdpr(let consents):
                 return SPGDPRConsent(
@@ -211,7 +209,6 @@ extension Consent: Codable {
                     expirationDate: consents.expirationDate,
                     applies: defaults?.applies ?? false,
                     consentStatus: consents.consentStatus,
-                    lastMessage: LastMessageData(from: messageMetaData),
                     webConsentPayload: consents.webConsentPayload,
                     acceptedLegIntCategories: consents.acceptedLegIntCategories,
                     acceptedLegIntVendors: consents.acceptedLegIntVendors,

diff --git a/ConsentViewController/Classes/SourcePointClient/MetaDataRequestResponse.swift b/ConsentViewController/Classes/SourcePointClient/MetaDataRequestResponse.swift
@@ -7,12 +7,12 @@
 
 import Foundation
 
-struct MetaDataResponse: Decodable, Equatable {
-    struct CCPA: Decodable, Equatable {
+struct MetaDataResponse: Equatable {
+    struct CCPA: Equatable {
         let applies: Bool
         let sampleRate: Float
     }
-    struct GDPR: Decodable, Equatable {
+    struct GDPR: Equatable {
         let additionsChangeDate: SPDate
         let legalBasisChangeDate: SPDate?
         let vendorListId: String
@@ -25,7 +25,7 @@ struct MetaDataResponse: Decodable, Equatable {
             case vendorListId = "_id"
         }
     }
-    struct USNat: Decodable, Equatable {
+    struct USNat: Equatable {
         let vendorListId: String
         let additionsChangeDate: SPDate
         let applies: Bool
@@ -43,6 +43,11 @@ struct MetaDataResponse: Decodable, Equatable {
     let usnat: USNat?
 }
 
+extension MetaDataResponse: Decodable {}
+extension MetaDataResponse.GDPR: Decodable {}
+extension MetaDataResponse.CCPA: Decodable {}
+extension MetaDataResponse.USNat: Decodable {}
+
 struct MetaDataQueryParam: QueryParamEncodable {
     struct Campaign: Encodable {
         let groupPmId: String?