Merge pull request #901 from snowplow/release/6.0.6

Release/6.0.6

CHANGELOG

@@ -1,3 +1,7 @@
+Version 6.0.6 (2024-07-10)
+--------------------------
+Fix remote configuration attempting to serialize a logger class after new configuration is fetched (#900)
+
 Version 6.0.5 (2024-07-03)
 --------------------------
 Stop sending if events fail to be removed from the event store

SnowplowTracker.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name             = "SnowplowTracker"
-    s.version          = "6.0.5"
+    s.version          = "6.0.6"
     s.summary          = "Snowplow event tracker for iOS, macOS, tvOS, watchOS for apps and games."
     s.description      = <<-DESC
     Snowplow is a mobile and event analytics platform with a difference: rather than tell our users how they should analyze their data, we deliver their event-level data in their own data warehouse, on their own Amazon Redshift or Postgres database, so they can analyze it any way they choose. Snowplow mobile is used by data-savvy games companies and app developers to better understand their users and how they engage with their games and applications. Snowplow is open source using the business-friendly Apache License, Version 2.0 and scales horizontally to many billions of events.

Sources/Core/TrackerConstants.swift

@@ -14,7 +14,7 @@
 import Foundation
 
 // --- Version
-let kSPRawVersion = "6.0.5"
+let kSPRawVersion = "6.0.6"
 #if os(iOS)
 let kSPVersion = "ios-\(kSPRawVersion)"
 #elseif os(tvOS)

Sources/Snowplow/Configurations/TrackerConfiguration.swift

@@ -588,7 +588,6 @@ public class TrackerConfiguration: SerializableConfiguration, TrackerConfigurati
         coder.encode(devicePlatform.rawValue, forKey: "devicePlatform")
         coder.encode(base64Encoding, forKey: "base64Encoding")
         coder.encode(logLevel.rawValue, forKey: "logLevel")
-        coder.encode(loggerDelegate, forKey: "loggerDelegate")
         coder.encode(sessionContext, forKey: "sessionContext")
         coder.encode(applicationContext, forKey: "applicationContext")
         coder.encode(platformContext, forKey: "platformContext")
@@ -618,9 +617,6 @@ public class TrackerConfiguration: SerializableConfiguration, TrackerConfigurati
         if let logLevel = LogLevel(rawValue: coder.decodeInteger(forKey: "logLevel")) {
             self.logLevel = logLevel
         }
-        if let loggerDelegate = coder.decodeObject(forKey: "loggerDelegate") as? LoggerDelegate {
-            self.loggerDelegate = loggerDelegate
-        }
         sessionContext = coder.decodeBool(forKey: "sessionContext")
         applicationContext = coder.decodeBool(forKey: "applicationContext")
         platformContext = coder.decodeBool(forKey: "platformContext")

Tests/Configurations/TestRemoteConfiguration.swift

@@ -122,6 +122,30 @@ class TestRemoteConfiguration: XCTestCase {
         XCTAssertNil(configBundle?.trackerConfiguration)
     }
 
+    func testCacheTrackerConfigurationWithoutLoggerDelegate() {
+        let bundle = ConfigurationBundle(namespace: "namespace",
+                                         networkConfiguration: NetworkConfiguration(endpoint: "endpoint"))
+        bundle.trackerConfiguration = TrackerConfiguration()
+            .appId("my-test-app")
+            .loggerDelegate(MockLoggerDelegate())
+
+        let remoteBundle = RemoteConfigurationBundle(schema: "", configurationVersion: 1)
+        remoteBundle.configurationBundle = [bundle]
+        let remoteConfig = RemoteConfiguration(endpoint: generateRemoteConfigEndpoint(), method: .get)
+        var cache = RemoteConfigurationCache(remoteConfiguration: remoteConfig)
+        cache.clear()
+        cache.write(remoteBundle)
+
+        Thread.sleep(forTimeInterval: 1) // wait the config is written on cache.
+
+        cache = RemoteConfigurationCache(remoteConfiguration: remoteConfig)
+        let config = cache.read()
+
+        let configBundle = config?.configurationBundle[0]
+        XCTAssertTrue(configBundle?.trackerConfiguration?.appId == "my-test-app")
+        XCTAssertNil(configBundle?.trackerConfiguration?.loggerDelegate)
+    }
+
     func testCacheEmitterConfiguration() {
         let bundle = ConfigurationBundle(namespace: "namespace",
                                          networkConfiguration: NetworkConfiguration(endpoint: "endpoint"))
@@ -401,6 +425,7 @@ class TestRemoteConfiguration: XCTestCase {
         let bundle1 = ConfigurationBundle(namespace: "ns1")
         bundle1.trackerConfiguration = TrackerConfiguration()
             .appId("app-1")
+            .loggerDelegate(MockLoggerDelegate())
         bundle1.subjectConfiguration = SubjectConfiguration()
             .domainUserId("duid1")
             .userId("u1")
@@ -421,6 +446,7 @@ class TestRemoteConfiguration: XCTestCase {
         XCTAssertEqual("app-1", finalBundle?.trackerConfiguration?.appId)
         XCTAssertEqual("u1", finalBundle?.subjectConfiguration?.userId)
         XCTAssertEqual("duid2", finalBundle?.subjectConfiguration?.domainUserId)
+        XCTAssertNotNil(finalBundle?.trackerConfiguration?.loggerDelegate)
     }
 
     private func generateRemoteConfigEndpoint() -> String {