Paid events

.gitignore

@@ -36,3 +36,5 @@ Example/Pods
 
 fastlane/*
 !fastlane/.env
+tests-build/*
+test-reports/*

Changelogs/1.5.0

@@ -9,3 +9,5 @@ Improvements to the 'RingPublishingTracking' module.
 * Separate method to update user data
 * Separate method to update SSO system name
 * New method for user logout
+* New event parameter - Content marked as paid
+* New tracking event types for paid

Sources/RingPublishingTracking/Private/Decorator/Generic/ClientDecorator.swift

@@ -14,12 +14,7 @@ final class ClientDecorator: Decorator {
     var parameters: [String: AnyHashable] {
         var userDataParams: [String: AnyHashable] = [:]
 
-        // swiftlint:disable non_optional_string_data_conversion
-        if let jsonData = try? JSONEncoder().encode(client),
-           let jsonString = String(data: jsonData, encoding: .utf8) {
-            userDataParams["RDLC"] = Data(jsonString.utf8).base64EncodedString()
-        }
-        // swiftlint:enable non_optional_string_data_conversion
+        userDataParams["RDLC"] = client.jsonStringBase64
 
         return userDataParams
     }

Sources/RingPublishingTracking/Private/Decorator/Generic/Models/ContentMarkAsPaid.swift

@@ -30,7 +30,11 @@ struct ContentMarkAsPaid: Encodable {
         case source
     }
 
-    init(contentMetadata: ContentMetadata) {
+    init?(contentMetadata: ContentMetadata?) {
+        guard let contentMetadata = contentMetadata else {
+            return nil
+        }
+
         publication = Publication(premium: contentMetadata.paidContent)
         source = Source(id: contentMetadata.contentId, system: contentMetadata.sourceSystemName)
     }

Sources/RingPublishingTracking/Private/Decorator/Generic/Models/PaidEventUserId.swift

@@ -0,0 +1,19 @@
+//
+//  PaidEventUserId.swift
+//  RingPublishingTracking
+//
+//  Created by Bernard Bijoch on 04/09/2024.
+//
+
+import Foundation
+
+struct PaidEventUserId: Encodable {
+
+    enum CodingKeys: String, CodingKey {
+        case fakeUserId = "fake_user_id"
+        case realUserId = "real_user_id"
+    }
+
+    let fakeUserId: String?
+    let realUserId: String?
+}

Sources/RingPublishingTracking/Private/EventsFactory+Paid.swift

@@ -0,0 +1,175 @@
+//
+//  EventsFactory+Paid.swift
+//  RingPublishingTracking
+//
+//  Created by Bernard Bijoch on 04/09/2024.
+//
+
+import Foundation
+
+extension EventsFactory {
+
+    func createPaidEvent(parameters: [String: AnyHashable]) -> Event {
+        return Event(analyticsSystemName: AnalyticsSystem.kropkaEvents.rawValue,
+                     eventName: EventType.paid.rawValue,
+                     eventParameters: parameters)
+    }
+
+    func createShowOfferEvent(contentMetadata: ContentMetadata?,
+                              offerData: OfferData,
+                              offerContextData: OfferContextData,
+                              targetPromotionCampaignCode: String?) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "checkout"
+        parameters[.eventAction] = "showOffer"
+        parameters[.supplierAppId] = offerData.supplierData.supplierAppId
+        parameters[.paywallSupplier] = offerData.supplierData.paywallSupplier
+        parameters[.paywallTemplateId] = offerData.paywallTemplateId
+        parameters[.displayMode] = offerData.displayMode.rawValue
+        parameters[.source] = offerContextData.source
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.paywallVariantId] = offerData.paywallVariantId
+        parameters[.closurePercentage] = offerContextData.closurePercentage
+        parameters[.tpcc] = targetPromotionCampaignCode
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    func createShowOfferTeaserEvent(contentMetadata: ContentMetadata?,
+                                    offerData: OfferData,
+                                    offerContextData: OfferContextData,
+                                    targetPromotionCampaignCode: String?) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "checkout"
+        parameters[.eventAction] = "showOfferTeaser"
+        parameters[.supplierAppId] = offerData.supplierData.supplierAppId
+        parameters[.paywallSupplier] = offerData.supplierData.paywallSupplier
+        parameters[.paywallTemplateId] = offerData.paywallTemplateId
+        parameters[.displayMode] = offerData.displayMode.rawValue
+        parameters[.source] = offerContextData.source
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.paywallVariantId] = offerData.paywallVariantId
+        parameters[.closurePercentage] = offerContextData.closurePercentage
+        parameters[.tpcc] = targetPromotionCampaignCode
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    func createPurchaseClickButtonEvent(contentMetadata: ContentMetadata?,
+                                        offerData: OfferData,
+                                        offerContextData: OfferContextData,
+                                        termId: String,
+                                        targetPromotionCampaignCode: String?) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "checkout"
+        parameters[.eventAction] = "clickButton"
+        parameters[.supplierAppId] = offerData.supplierData.supplierAppId
+        parameters[.paywallSupplier] = offerData.supplierData.paywallSupplier
+        parameters[.paywallTemplateId] = offerData.paywallTemplateId
+        parameters[.displayMode] = offerData.displayMode.rawValue
+        parameters[.source] = offerContextData.source
+        parameters[.termId] = termId
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.paywallVariantId] = offerData.paywallVariantId
+        parameters[.tpcc] = targetPromotionCampaignCode
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    // swiftlint:disable function_parameter_count
+
+    func createPurchaseEvent(contentMetadata: ContentMetadata?,
+                             offerData: OfferData,
+                             offerContextData: OfferContextData,
+                             subscriptionPaymentData: SubscriptionPaymentData,
+                             termId: String,
+                             termConversionId: String,
+                             targetPromotionCampaignCode: String?,
+                             temporaryUserId: String?) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "checkout"
+        parameters[.eventAction] = "purchase"
+        parameters[.supplierAppId] = offerData.supplierData.supplierAppId
+        parameters[.paywallSupplier] = offerData.supplierData.paywallSupplier
+        parameters[.paywallTemplateId] = offerData.paywallTemplateId
+        parameters[.displayMode] = offerData.displayMode.rawValue
+        parameters[.source] = offerContextData.source
+        parameters[.termId] = termId
+        parameters[.termConversionId] = termConversionId
+        parameters[.paymentMethod] = subscriptionPaymentData.paymentMethod.rawValue
+        parameters[.subscriptionBasePrice] = subscriptionPaymentData.subscriptionBasePrice
+        parameters[.subscriptionPriceCurrency] = subscriptionPaymentData.subscriptionPriceCurrency
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.paywallVariantId] = offerData.paywallVariantId
+        parameters[.tpcc] = targetPromotionCampaignCode
+        parameters[.subscriptionPromoPrice] = subscriptionPaymentData.subscriptionPromoPrice
+        parameters[.subscriptionPromoPriceDuration] = subscriptionPaymentData.subscriptionPromoPriceDuration
+        parameters[.eventDetails] = PaidEventUserId(fakeUserId: temporaryUserId, realUserId: nil).jsonString
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    // swiftlint:enable function_parameter_count
+
+    func createShowMetricLimitEvent(contentMetadata: ContentMetadata?,
+                                    supplierData: SupplierData,
+                                    metricsData: MetricsData) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "metric_limit"
+        parameters[.eventAction] = "showMetricLimit"
+        parameters[.supplierAppId] = supplierData.supplierAppId
+        parameters[.paywallSupplier] = supplierData.paywallSupplier
+        parameters[.metricLimitName] = metricsData.metricLimitName
+        parameters[.freePvCnt] = metricsData.freePageViewCount
+        parameters[.freePvLimit] = metricsData.freePageViewLimit
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    func createLikelihoodScoringEvent(contentMetadata: ContentMetadata?,
+                                      supplierData: SupplierData,
+                                      likelihoodData: LikelihoodData) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "likelihood_scoring"
+        parameters[.eventAction] = "likelihoodScoring"
+        parameters[.supplierAppId] = supplierData.supplierAppId
+        parameters[.paywallSupplier] = supplierData.paywallSupplier
+        parameters[.sourceDx] = contentMetadata?.dxParameter
+        parameters[.sourcePublicationUuid] = contentMetadata?.publicationId
+        parameters[.eventDetails] = likelihoodData.jsonString
+        parameters[.contentMarkedAsPaid] = contentMetadata?.rdlcnParameter
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+    func createMobileAppFakeUserIdReplacedEvent(contentMetadata: ContentMetadata?,
+                                                temporaryUserId: String,
+                                                realUserId: String) -> Event {
+        var parameters: [PaidEventParameter: AnyHashable] = [:]
+
+        parameters[.eventCategory] = "mobile_app_fake_user_id_replaced"
+        parameters[.eventAction] = "mobileAppFakeUserIdReplaced"
+        parameters[.eventDetails] = PaidEventUserId(fakeUserId: temporaryUserId, realUserId: realUserId).jsonString
+        parameters[.contentMarkedAsPaid] = ContentMarkAsPaid(contentMetadata: contentMetadata)?.jsonStringBase64
+
+        return createPaidEvent(parameters: parameters.keysAsStrings)
+    }
+
+}

Sources/RingPublishingTracking/Private/Extensions/ContentMetadata+Parameters.swift

@@ -25,19 +25,7 @@ extension ContentMetadata {
         return "PV_4,\(sourceSystem),\(pubId),\(part),\(paid)".replacingOccurrences(of: " ", with: "_")
     }
 
-    // swiftlint:disable non_optional_string_data_conversion
-
     var rdlcnParameter: String? {
-        let contentMarkAsPaid = ContentMarkAsPaid(contentMetadata: self)
-
-        if let jsonData = try? Self.encoder.encode(contentMarkAsPaid),
-           let jsonString = String(data: jsonData, encoding: .utf8) {
-            return Data(jsonString.utf8).base64EncodedString()
-        }
-
-        return nil
+        return ContentMarkAsPaid(contentMetadata: self).jsonStringBase64
     }
-
-    // swiftlint:enable non_optional_string_data_conversion
-
 }

Sources/RingPublishingTracking/Private/Extensions/Encodable+JSON.swift

@@ -0,0 +1,31 @@
+//
+//  Encodable+JSON.swift
+//  RingPublishingTracking
+//
+//  Created by Bernard Bijoch on 04/09/2024.
+//
+
+import Foundation
+
+extension Encodable {
+
+    // swiftlint:disable non_optional_string_data_conversion
+
+    var jsonString: String? {
+        let encoder = JSONEncoder()
+        encoder.outputFormatting = .sortedKeys
+
+        guard let data = try? encoder.encode(self),
+              let jsonString = String(data: data, encoding: .utf8) else { return nil }
+
+        return jsonString
+    }
+
+    // swiftlint:enable non_optional_string_data_conversion
+
+    var jsonStringBase64: String? {
+        guard let jsonString = jsonString else { return nil }
+
+        return Data(jsonString.utf8).base64EncodedString()
+    }
+}

Sources/RingPublishingTracking/Private/Extensions/VideoVisibility+ParameterName.swift

@@ -25,14 +25,7 @@ extension VideoVisibility {
 
         let visibilityData = VideoVisibilityWrapper(context: VideoVisibilityContext(visible: visibilityParamName))
 
-        // swiftlint:disable non_optional_string_data_conversion
-        guard let jsonData = try? JSONEncoder().encode(visibilityData),
-              let jsonString = String(data: jsonData, encoding: .utf8) else {
-            return nil
-        }
-        // swiftlint:enable non_optional_string_data_conversion
-
-        return Data(jsonString.utf8).base64EncodedString()
+        return visibilityData.jsonStringBase64
     }
 }
 

Sources/RingPublishingTracking/Private/Tracking/EventType.swift

@@ -16,4 +16,5 @@ enum EventType: String {
     case keepAlive = "KeepAlive"
     case videoEvent = "VidEvent"
     case error = "ErrEvent"
+    case paid = "PaidEvent"
 }

Sources/RingPublishingTracking/Private/Tracking/KeepAlive/KeepAliveManager.swift

@@ -39,6 +39,7 @@ final class KeepAliveManager {
     private var pauseTimeStart = [Date]()
     private var pauseTimeEnd = [Date]()
 
+    private let timerQueue = DispatchQueue(label: "timerQueue", attributes: .concurrent)
     private var measurementTimer: DispatchSourceTimer?
     private var sendingTimer: DispatchSourceTimer?
 
@@ -213,6 +214,25 @@ extension KeepAliveManager {
 
 extension KeepAliveManager {
 
+    /// Schedule timer on dedicated concurrent queue
+    /// Action is called on main thread
+    ///
+    /// - Parameters:
+    ///   - timeInterval: TimeInterval from now when timer should fire
+    ///   - action: (() -> Void)? Action to execute when timer is fired
+    func scheduledTimer(timeInterval: TimeInterval, action: (() -> Void)?) -> DispatchSourceTimer {
+        let timer = DispatchSource.makeTimerSource(queue: timerQueue)
+        timer.setEventHandler {
+            DispatchQueue.main.async {
+                action?()
+            }
+        }
+        timer.schedule(deadline: .now() + timeInterval, repeating: .never)
+        timer.activate()
+
+        return timer
+    }
+
     private func scheduleMeasurementTimer() {
         guard let timeFromStart = timeFromStart else {
             stop()
@@ -223,7 +243,7 @@ extension KeepAliveManager {
 
         Logger.log("Keep alive manager: Scheduling measurement timer \(interval)s")
 
-        measurementTimer = DispatchQueue.scheduledTimer(timeInterval: interval, action: { [weak self] in
+        measurementTimer = scheduledTimer(timeInterval: interval, action: { [weak self] in
             self?.takeMeasurements(measureType: .activityTimer)
             self?.scheduleMeasurementTimer()
         })
@@ -239,7 +259,7 @@ extension KeepAliveManager {
 
         Logger.log("Keep alive manager: Scheduling sending timer \(interval)s")
 
-        sendingTimer = DispatchQueue.scheduledTimer(timeInterval: interval, action: { [weak self] in
+        sendingTimer = scheduledTimer(timeInterval: interval, action: { [weak self] in
             self?.takeMeasurements(measureType: .sendTimer)
             self?.sendMeasurements()
             self?.scheduleSendingTimer()