Merge remote-tracking branch 'origin/master' into mokagio/swiftlint-autocorrect-format

Author: mokagio

CHANGES.rst

@@ -12,6 +12,27 @@ _None_
 Bugfixes
 --------
 
+_None_
+
+0.2.5 (1-08-2025)
+
+Changes
+-------
+
+* The logs show more information #93
+
+0.2.4 (1-28-2024)
+
+Changes
+-------
+
+* Implementation cleanups: Remove unnecessary Optionals, IUOs, force casts and the like [#88, #89]
+
+0.2.3 (1-28-2024)
+
+Bugfixes
+--------
+
 * Prevented a crash in the rare occurrence when a `VideoManager` attempted to send an heartbeat for a video it had not tracked [#83]
 
 0.2.2 (5-10-2023)

Demo/ParselyDemo/FirstViewController.swift

@@ -6,27 +6,31 @@ class FirstViewController: UIViewController {
     let delegate = UIApplication.shared.delegate as! AppDelegate
 
     @IBAction func didTouchButton(_ sender: Any) {
-        os_log("didTouchButton", log: OSLog.default, type: .debug)
+        log("didTouchButton")
         let demoMetas = ParselyMetadata(authors: ["Yogi Berr"])
         delegate.parsely.trackPageView(url: "http://parsely.com/path/cool-blog-post/1?qsarg=nawp&anotherone=yup", metadata: demoMetas, extraData: ["product-id": "12345"], siteId: "subdomain.parsely-test.com")
     }
 
     @IBAction func didStartEngagement(_ sender: Any) {
-        os_log("didStartEngagement", log: OSLog.default, type: .debug)
+        log("didStartEngagement")
         delegate.parsely.startEngagement(url: "http://parsely.com/very-not-real", urlref: "http://parsely.com/not-real", extraData: ["product-id": "12345"], siteId: "engaged.parsely-test.com")
     }
 
     @IBAction func didStopEngagement(_ sender: Any) {
-        os_log("didStopEngagement", log: OSLog.default, type: .debug)
+        log("didStopEngagement")
         delegate.parsely.stopEngagement()
     }
     @IBAction func didStartVideo(_ sender: Any) {
-        os_log("didStartVideo", log: OSLog.default, type: .debug)
+        log("didStartVideo")
         let demoMetas = ParselyMetadata(authors: ["Yogi Berr"], duration: TimeInterval(10))
         delegate.parsely.trackPlay(url: "http://parsely.com/path/cool-blog-post/1?qsarg=nawp&anotherone=yup", urlref: "not-a-real-urlref", videoID: "videoOne", duration: TimeInterval(6000), metadata: demoMetas, extraData: ["product-id": "12345", "ts": "should be overwritten"])
     }
     @IBAction func didPauseVideo(_ sender: Any) {
-        os_log("didStopVideo", log: OSLog.default, type: .debug)
+        log("didStopVideo")
         delegate.parsely.trackPause()
     }
+
+    private func log(_ message: String) {
+        os_log("[Parsely Demo App] %@", log: OSLog.default, type: .debug, message)
+    }
 }

Sources/Sampler.swift

@@ -146,18 +146,28 @@ class Sampler {
             os_log("No accumulator found for %s, skipping sendHeartbeat", log: OSLog.tracker, type: .debug, key)
             return
         }
+        let now = Date()
         let incSecs: TimeInterval = trackedData.accumulatedTime
         if incSecs > 0 {
-            os_log("Sending heartbeat for %s", log: OSLog.tracker, type: .debug, key)
+            os_log(
+                "Sending heartbeat for %s. Timestamp: %s.",
+                log: OSLog.tracker,
+                type: .debug,
+                key,
+                now.description
+            )
             heartbeatFn(data: trackedData, enableHeartbeats: true)
         }
         trackedData.accumulatedTime = 0
-        let totalTrackedTime: TimeInterval = Date().timeIntervalSince(trackedData.firstSampleTime!)
-        trackedData.heartbeatTimeout = self.getHeartbeatInterval(
+        let totalTrackedTime: TimeInterval = now.timeIntervalSince(trackedData.firstSampleTime!)
+        trackedData.heartbeatTimeout = getHeartbeatInterval(
             existingTimeout: trackedData.heartbeatTimeout!,
-            totalTrackedTime: totalTrackedTime)
+            totalTrackedTime: totalTrackedTime
+        )
         updateAccumulator(acc: trackedData)
         heartbeatInterval = trackedData.heartbeatTimeout!
+
+        os_log("Send heartbeat completed. New heartbeat timeout %.2f seconds.", trackedData.heartbeatTimeout!)
     }
 
     @objc internal func sendHeartbeats() -> Void {

Sources/Track.swift

@@ -82,17 +82,9 @@ class Track {
     }
 }
 
-/// Utitlity to log sending event with a dump of the event.
+/// Utility to log sending event with a dump of the event.
 private func os_log_sending_event(_ event: Event, log: OSLog = .tracker, type: OSLogType = .debug) {
-    var eventDump = DumpOutput()
+    var eventDump = ""
     dump(event.toDict(), to: &eventDump)
-    os_log("Sending an event from Track:\n%@", log: log, type: type, eventDump.content)
-}
-
-private struct DumpOutput: TextOutputStream {
-    private(set) var content = ""
-
-    mutating func write(_ string: String) {
-        content.append(string)
-    }
+    os_log("Sending an event from Track:\n%@", log: log, type: type, eventDump)
 }