fix: memory leaks (#27)

* fix: memory leaks

* use locks for dictionary acess

* more defenses

* deadlock

Author: marcmrf

CompassSDK/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.14.0</string>
+	<string>2.14.1</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 </dict>

CompassSDK/Tick/TikOperation.swift

@@ -15,7 +15,7 @@ protocol ConversionsProvider: AnyObject {
     func getConversions(_ completion: @escaping ([String]) -> ())
 }
 typealias DataBuilderCompletion = (_ res: Encodable) -> Void
-typealias DataBuilder = (_ completion: @escaping DataBuilderCompletion) -> Encodable?
+typealias DataBuilder = (_ completion: @escaping DataBuilderCompletion) -> Void
 
 class TikOperation: Operation, @unchecked Sendable {
     private let dataBuilder: DataBuilder
@@ -24,6 +24,9 @@ class TikOperation: Operation, @unchecked Sendable {
     private let path: String
     private let contentType: ContentType
 
+    private var timer: DispatchSourceTimer?
+    private let lock = NSRecursiveLock()
+
     init(
         dataBuilder: @escaping DataBuilder,
         dispatchDate: Date,
@@ -39,31 +42,47 @@ class TikOperation: Operation, @unchecked Sendable {
         super.init()
     }
 
-    private var timer: DispatchSourceTimer?
-    
-    private var running: Bool = false {
-        didSet {
-            willChangeValue(forKey: "isFinished")
-            willChangeValue(forKey: "isExecuting")
-            didChangeValue(forKey: "isFinished")
-            didChangeValue(forKey: "isExecuting")
+    private var _running: Bool = false
+    private var running: Bool {
+        get {
+            lock.lock()
+            defer { lock.unlock() }
+            return _running
+        }
+        set {
+            var didChange = false
+            lock.lock()
+            if _running != newValue {
+                willChangeValue(forKey: "isFinished")
+                willChangeValue(forKey: "isExecuting")
+                _running = newValue
+                didChange = true
+            }
+            lock.unlock()
+            
+            if didChange {
+                didChangeValue(forKey: "isFinished")
+                didChangeValue(forKey: "isExecuting")
+            }
         }
     }
-    
+
     override var isAsynchronous: Bool { true }
-    
     override var isFinished: Bool { !running }
-    
     override var isExecuting: Bool { running }
 
     override func start() {
-        guard !isCancelled else { return }
+        guard !isCancelled else {
+            finish()
+            return
+        }
+        
         running = true
 
         let timer = DispatchSource.makeTimerSource(queue: DispatchQueue.global(qos: .utility))
         let timeInterval = dispatchDate.timeIntervalSinceNow
-        let deadline = DispatchTime.now() + timeInterval
-        
+        let deadline = DispatchTime.now() + max(timeInterval, 0)
+
         timer.schedule(deadline: deadline)
 
         timer.setEventHandler { [weak self] in
@@ -86,23 +105,25 @@ class TikOperation: Operation, @unchecked Sendable {
                 self.finish()
             }
 
-            let data = self.dataBuilder(track)
-            
-            if data != nil {
-                track(data)
-            }
+           self.dataBuilder(track)
         }
 
         self.timer = timer
         timer.resume()
     }
 
     override func cancel() {
-        finish()
         super.cancel()
+        finish()
     }
 
     private func finish() {
+        lock.lock()
+        defer { lock.unlock() }
+
+        guard running else { return }
+        
+        timer?.setEventHandler {} 
         timer?.cancel()
         timer = nil
         running = false

CompassSDK/Tracker/AbstractTracker.swift

@@ -10,6 +10,7 @@ import Foundation
 public class Tracker {
     private let queueName: String
     private var finishObserver: [Int: NSKeyValueObservation] = [:]
+    private let observerLock = NSLock()
 
     init(queueName: String) {
         self.queueName = queueName
@@ -32,19 +33,31 @@ public class Tracker {
     internal func observeFinish(for operation: Operation, cb: (() -> Void)?) {
         let opId = getOperationId(for: operation)
 
+        observerLock.lock()
+        defer { observerLock.unlock() }
         finishObserver[opId] = operation.observe(\Operation.isFinished, options: .new) { [weak self] (operation, change) in
-            guard !operation.isCancelled, operation.isFinished else {return}
-            
-            self?.finishObserver.removeValue(forKey: opId)
+            guard !operation.isCancelled, operation.isFinished else { return }
+           
+            self?.invalidateObserver(for: opId)
             cb?()
         }
     }
 
+    private func invalidateObserver(for opId: Int) {
+        observerLock.lock()
+        defer { observerLock.unlock() }
+        finishObserver[opId]?.invalidate()
+        finishObserver.removeValue(forKey: opId)
+    }
+    
     internal func stopObserving(for operation: Operation) {
-        finishObserver.removeValue(forKey: getOperationId(for: operation))
+        invalidateObserver(for: getOperationId(for: operation))
     }
 
     internal func stopObserving() {
+        observerLock.lock()
+        defer { observerLock.unlock() }
+        finishObserver.values.forEach { $0.invalidate() }
         finishObserver.removeAll()
     }
 }

CompassSDK/Tracker/Core/CompassTracker.swift

@@ -357,7 +357,9 @@ private extension CompassTracker {
     func doTik() {
         guard trackInfo.pageUrl != nil else { return }
 
-        getConversions { [self] conversions in
+        getConversions { [weak self] conversions in
+            guard let self = self else { return }
+            
             let dispatchDate = Date(timeIntervalSinceNow: deadline)
 
             let dispatchGroup = DispatchGroup()
@@ -389,7 +391,6 @@ private extension CompassTracker {
                     }
                     self.tick += 1
                 }
-                return nil
             },
             dispatchDate: dispatchDate,
             path: TIK_PATH,
@@ -404,7 +405,7 @@ private extension CompassTracker {
 
     func restart(pageName: String?) {
         stopObserving()
-        operationQueue.cancelAllOperations()
+        operationQueue.operations.forEach{ $0.cancel() }
         trackInfo.pageUrl = pageName
         pageVars.removeAll()
         tick = 0

CompassSDK/Tracker/Multimedia/CompassTrackerMultimedia.swift

@@ -97,8 +97,6 @@ private extension CompassTrackerMultimedia {
                             tik: tik
                         ))
                     }
-
-                    return nil
                 },
                 dispatchDate: dispatchDate,
                 path: TIK_PATH,

MarfeelSDK-iOS.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |spec|
   #
 
   spec.name         = "MarfeelSDK-iOS"
-  spec.version      = "2.14.0"
+  spec.version      = "2.14.1"
   spec.summary      = "iOS version of MarfeelSDK."
 
 

Playground/Playground/AllPostsView.swift

@@ -28,6 +28,7 @@ struct AllPosts: View {
                 scrollView = $0
              }
             .onAppear(perform: {
+                CompassTracker.shared.setLandingPage("landing page")
                 CompassTracker.shared.setUserType(.logged)
                 CompassTracker.shared.addUserSegment("segment1")
                 CompassTracker.shared.addUserSegment("segment1")