Unit tests and refactoring to make it testable

.github/workflows/build-examples.yml

@@ -0,0 +1,18 @@
+name: Build Examples
+on:
+  push:
+    branches:
+      - master
+      - main
+      - v3.0.0
+  pull_request:
+jobs:
+  build:
+    runs-on: macos-13
+    steps:
+      - uses: actions/checkout@v4
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '15.0'
+      - name: Build Example
+        run: make buildExample

.github/workflows/build.yml

@@ -11,16 +11,8 @@ jobs:
     runs-on: macos-13
     steps:
       - uses: actions/checkout@v4
-
-      - uses: swift-actions/setup-swift@v1
-        with:
-          swift-version: "5.3.0"
       - uses: maxim-lobanov/setup-xcode@v1
         with:
           xcode-version: '15.0'
       - name: Build SDK
         run: make buildSdk
-      - name: Build Example
-        run: make buildExample
-      - name: Test SDK
-        run: make test

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Tests
+on:
+  push:
+    branches:
+      - master
+      - main
+      - v3.0.0
+  pull_request:
+jobs:
+  test:
+    runs-on: macos-13
+    steps:
+      - uses: actions/checkout@v4
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '15.0'
+      - name: Test SDK
+        run: make test

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build buildSdk buildExample format swiftLint swiftFormat test lint bootstrap releaseCocoaPods
+.PHONY: build buildSdk buildExample format swiftLint swiftFormat test testOnSimulator lint bootstrap releaseCocoaPods
 
 build: buildSdk buildExample
 
@@ -16,9 +16,12 @@ swiftLint:
 swiftFormat:
 	swiftformat . --swiftversion 5.3
 
-test:
+testOnSimulator:
 	set -o pipefail && xcodebuild test -project PostHog.xcodeproj -scheme PostHog -destination 'platform=iOS Simulator,name=iPhone 15,OS=17.0.1' | xcpretty
 
+test:
+	swift test
+
 lint:
 	swiftformat . --lint --swiftversion 5.3 && swiftlint
 

Package.swift

@@ -15,6 +15,9 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
+        .package(url: "https://github.com/Quick/Quick.git", from: "6.0.0"),
+        .package(url: "https://github.com/Quick/Nimble.git", from: "12.0.0"),
+        .package(url: "https://github.com/AliSoftware/OHHTTPStubs.git", from: "9.0.0"),
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -25,7 +28,13 @@ let package = Package(
         ),
         .testTarget(
             name: "PostHogTests",
-            dependencies: ["PostHog"],
+            dependencies: [
+                "PostHog",
+                "Quick",
+                "Nimble",
+                "OHHTTPStubs",
+                .product(name: "OHHTTPStubsSwift", package: "OHHTTPStubs"),
+            ],
             path: "PostHogTests"
         ),
     ]

PostHog/PostHogApi.swift

@@ -49,7 +49,7 @@ class PostHogApi {
 
         do {
             data = try JSONSerialization.data(withJSONObject: toSend)
-        } catch let error as NSError {
+        } catch {
             return completion(PostHogBatchUploadInfo(statusCode: nil, error: error))
         }
 
@@ -109,7 +109,7 @@ class PostHogApi {
 
         do {
             data = try JSONSerialization.data(withJSONObject: toSend)
-        } catch let error as NSError {
+        } catch {
             return completion(nil, error)
         }
 
@@ -128,7 +128,7 @@ class PostHogApi {
             do {
                 let jsonData = try JSONSerialization.jsonObject(with: data!, options: .allowFragments) as? [String: Any]
                 completion(jsonData, nil)
-            } catch let error as NSError {
+            } catch {
                 completion(nil, error)
             }
         }.resume()

PostHog/PostHogConfig.swift

@@ -28,6 +28,10 @@ import Foundation
     @objc public var optOut: Bool = false
     public static let defaultHost: String = "https://app.posthog.com"
 
+    // only internal
+    var disableReachabilityForTesting: Bool = false
+    var disableQueueTimerForTesting: Bool = false
+
     @objc(apiKey:)
     public init(
         apiKey: String

PostHog/PostHogContext.swift

@@ -61,7 +61,6 @@ class PostHogContext {
             if deviceType != nil {
                 properties["$device_type"] = deviceType
             }
-
         #endif
 
         return properties
@@ -87,8 +86,8 @@ class PostHogContext {
         var properties: [String: Any] = [:]
 
         #if os(iOS) || os(tvOS)
-            properties["$screen_width"] = UIScreen.main.bounds.width
-            properties["$screen_height"] = UIScreen.main.bounds.height
+            properties["$screen_width"] = Float(UIScreen.main.bounds.width)
+            properties["$screen_height"] = Float(UIScreen.main.bounds.height)
         #endif
 
         properties["$lib"] = "posthog-ios"

PostHog/PostHogFeatureFlags.swift

@@ -16,9 +16,13 @@ class PostHogFeatureFlags {
     private let featureFlagsLock = NSLock()
     private var isLoadingFeatureFlags = false
 
-    private let dispatchQueue = DispatchQueue(label: "com.posthog.FeatureFlags", target: .global(qos: .utility))
+    private let dispatchQueue = DispatchQueue(label: "com.posthog.FeatureFlags",
+                                              target: .global(qos: .utility))
 
-    init(_ config: PostHogConfig, _ storage: PostHogStorage, _ api: PostHogApi) {
+    init(_ config: PostHogConfig,
+         _ storage: PostHogStorage,
+         _ api: PostHogApi)
+    {
         self.config = config
         self.storage = storage
         self.api = api
@@ -52,7 +56,9 @@ class PostHogFeatureFlags {
                       let featureFlagPayloads = data?["featureFlagPayloads"] as? [String: Any]
                 else {
                     hedgeLog("Error: Decide response missing correct featureFlags format")
-                    self.setLoading(false)
+
+                    self.notifyAndRelease()
+
                     return callback()
                 }
                 let errorsWhileComputingFlags = data?["errorsWhileComputingFlags"] as? Bool ?? false
@@ -74,17 +80,21 @@ class PostHogFeatureFlags {
                     }
                 }
 
-                DispatchQueue.main.async {
-                    NotificationCenter.default.post(name: PostHogSDK.didReceiveFeatureFlags, object: nil)
-                }
-
-                self.setLoading(false)
+                self.notifyAndRelease()
 
                 return callback()
             }
         }
     }
 
+    private func notifyAndRelease() {
+        DispatchQueue.main.async {
+            NotificationCenter.default.post(name: PostHogSDK.didReceiveFeatureFlags, object: nil)
+        }
+
+        setLoading(false)
+    }
+
     func getFeatureFlags() -> [String: Any]? {
         var flags: [String: Any]?
         featureFlagsLock.withLock {
@@ -103,9 +113,9 @@ class PostHogFeatureFlags {
         let value = flags?[key]
 
         if value != nil {
-            let boolValue = value as? Bool ?? false
-            if boolValue {
-                return boolValue
+            let boolValue = value as? Bool
+            if boolValue != nil {
+                return boolValue!
             } else {
                 return true
             }
@@ -135,14 +145,15 @@ class PostHogFeatureFlags {
             return value
         }
 
-        // The payload value is stored as a string and is not pre-parsed...
-        // We need to mimic the JSON.parse of JS which is what posthog-js uses
-        let jsonData = try? JSONSerialization.jsonObject(with: stringValue.data(using: .utf8)!, options: .fragmentsAllowed)
-
-        if jsonData == nil {
-            return value
+        do {
+            // The payload value is stored as a string and is not pre-parsed...
+            // We need to mimic the JSON.parse of JS which is what posthog-js uses
+            return try JSONSerialization.jsonObject(with: stringValue.data(using: .utf8)!, options: .fragmentsAllowed)
+        } catch {
+            hedgeLog("Error parsing the object \(String(describing: value)): \(error)")
         }
 
-        return jsonData
+        // fallbak to original value if not possible to serialize
+        return value
     }
 }