Add support for visionOS

snowplow · Sep 27, 2023 · 0355796 · 0355796
1 parent 1f76199
commit 0355796
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 27 deletions.
diff --git a/Package.swift b/Package.swift
@@ -1,14 +1,16 @@
-// swift-tools-version:5.2
+// swift-tools-version:5.9
 
 import PackageDescription
 
 let package = Package(
     name: "SnowplowTracker",
+    defaultLocalization: "en",
     platforms: [
         .macOS("10.13"),
         .iOS("11.0"),
         .tvOS("12.0"),
-        .watchOS("6.0")
+        .watchOS("6.0"),
+        .visionOS("1.0")
     ],
     products: [
         .library(

diff --git a/Sources/Core/Storage/SQLiteEventStore.swift b/Sources/Core/Storage/SQLiteEventStore.swift
@@ -11,7 +11,7 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS) || os(macOS)
+#if os(iOS) || os(macOS) || os(visionOS)
 
 import FMDB
 import Foundation

diff --git a/Sources/Core/Subject/PlatformContext.swift b/Sources/Core/Subject/PlatformContext.swift
@@ -12,7 +12,7 @@
 //  language governing permissions and limitations there under.
 
 import Foundation
-#if os(iOS)
+#if os(iOS) || os(visionOS)
 import UIKit
 #endif
 
@@ -44,7 +44,7 @@ class PlatformContext {
         self.mobileDictUpdateFrequency = mobileDictUpdateFrequency
         self.networkDictUpdateFrequency = networkDictUpdateFrequency
         self.deviceInfoMonitor = deviceInfoMonitor
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         UIDevice.current.isBatteryMonitoringEnabled = true
         #endif
         setPlatformDict()
@@ -53,7 +53,7 @@ class PlatformContext {
     /// Updates and returns payload dictionary with device context information.
     /// - Parameter userAnonymisation: Whether to anonymise user identifiers (IDFA values)
     func fetchPlatformDict(userAnonymisation: Bool, advertisingIdentifierRetriever: (() -> UUID?)?) -> Payload {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         objc_sync_enter(self)
         let now = Date().timeIntervalSince1970
         if now - lastUpdatedEphemeralMobileDict >= mobileDictUpdateFrequency {
@@ -89,7 +89,7 @@ class PlatformContext {
         platformDict[kSPPlatformDeviceManu] = deviceInfoMonitor.deviceVendor
         platformDict[kSPPlatformDeviceModel] = deviceInfoMonitor.deviceModel
 
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         setMobileDict()
         #endif
     }

diff --git a/Sources/Core/Tracker/Tracker.swift b/Sources/Core/Tracker/Tracker.swift
@@ -296,7 +296,7 @@ class Tracker: NSObject {
         super.init()
         builder(self)
 
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         platformContextSchema = kSPMobileContextSchema
         #else
         platformContextSchema = kSPDesktopContextSchema

diff --git a/Sources/Core/Tracker/WebViewMessageHandler.swift b/Sources/Core/Tracker/WebViewMessageHandler.swift
@@ -13,7 +13,7 @@
 
 import Foundation
 
-#if os(iOS) || os(macOS)
+#if os(iOS) || os(macOS) || os(visionOS)
 import WebKit
 
 /// Handler for messages from the JavaScript library embedded in Web views.

diff --git a/Sources/Core/Utils/DeviceInfoMonitor.swift b/Sources/Core/Utils/DeviceInfoMonitor.swift
@@ -19,7 +19,7 @@ import WatchKit
 #if os(iOS)
 import CoreTelephony
 #endif
-#if os(iOS) || os(tvOS)
+#if os(iOS) || os(tvOS) || os(visionOS)
 import UIKit
 #endif
 
@@ -28,7 +28,7 @@ class DeviceInfoMonitor {
     /// Returns the generated identifier for vendors. More info can be found in UIDevice's identifierForVendor documentation.
     /// - Returns: A string containing a formatted UUID for example E621E1F8-C36C-495A-93FC-0C247A3E6E5F.
     var appleIdfv: String? {
-        #if os(iOS) || os(tvOS)
+        #if os(iOS) || os(tvOS) || os(visionOS)
         if let idfv = UIDevice.current.identifierForVendor?.uuidString {
             return idfv
         }
@@ -60,7 +60,7 @@ class DeviceInfoMonitor {
     /// This is to detect what the version of mobile OS of the current device.
     /// - Returns: The current device's OS version type as a string.
     var osVersion: String? {
-        #if os(iOS) || os(tvOS)
+        #if os(iOS) || os(tvOS) || os(visionOS)
         return UIDevice.current.systemVersion
         #elseif os(watchOS)
         return WKInterfaceDevice.current().systemVersion
@@ -85,6 +85,8 @@ class DeviceInfoMonitor {
         return "tvos"
         #elseif os(watchOS)
         return "watchos"
+        #elseif os(visionOS)
+        return "visionos"
         #else
         return "osx"
         #endif
@@ -146,7 +148,7 @@ class DeviceInfoMonitor {
     /// Returns the Network Type the device is connected to.
     /// - Returns: A string containing the Network Type.
     var networkType: String? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         let networkStatus = SNOWReachability.forInternetConnection()?.networkStatus
         switch networkStatus {
         case .offline:
@@ -165,7 +167,7 @@ class DeviceInfoMonitor {
     /// Returns remaining battery level as an integer percentage of total battery capacity.
     /// - Returns: Battery level.
     var batteryLevel: Int? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         let batteryLevel = UIDevice.current.batteryLevel
         if batteryLevel != Float(UIDevice.BatteryState.unknown.rawValue) && batteryLevel >= 0 {
             return Int(batteryLevel * 100)
@@ -177,7 +179,7 @@ class DeviceInfoMonitor {
     /// Returns battery state for the device.
     /// - Returns: One of "charging", "full", "unplugged" or NULL
     var batteryState: String? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         switch UIDevice.current.batteryState {
         case .charging:
             return "charging"
@@ -196,7 +198,7 @@ class DeviceInfoMonitor {
     /// Returns whether low power mode is activated.
     /// - Returns: Boolean indicating the state of low power mode.
     var isLowPowerModeEnabled: Bool? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         return ProcessInfo.processInfo.isLowPowerModeEnabled
         #else
         return nil
@@ -225,7 +227,7 @@ class DeviceInfoMonitor {
     /// Returns number of bytes of storage remaining. The information is requested from the home directory.
     /// - Returns: Bytes of storage remaining.
     var availableStorage: Int64? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         let fileURL = URL(fileURLWithPath: NSHomeDirectory() as String)
         do {
             let values = try fileURL.resourceValues(forKeys: [.volumeAvailableCapacityForImportantUsageKey])
@@ -240,7 +242,7 @@ class DeviceInfoMonitor {
     /// Returns the total number of bytes of storage. The information is requested from the home directory.
     /// - Returns: Total size of storage in bytes.
     var totalStorage: Int? {
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         let fileURL = URL(fileURLWithPath: NSHomeDirectory() as String)
         do {
             let values = try fileURL.resourceValues(forKeys: [.volumeTotalCapacityKey])

diff --git a/Sources/Core/Utils/SNOWReachability.swift b/Sources/Core/Utils/SNOWReachability.swift
@@ -11,7 +11,7 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS)
+#if os(iOS) || os(visionOS)
 import Foundation
 import SystemConfiguration
 
@@ -65,7 +65,7 @@ class SNOWReachability: NSObject {
             return .offline
         }
 
-        #if os(iOS)
+        #if os(iOS) || os(visionOS)
         let isWWAN = (flags.rawValue & SCNetworkReachabilityFlags.isWWAN.rawValue) == SCNetworkReachabilityFlags.isWWAN.rawValue
         if isWWAN {
             return .wwan

diff --git a/Sources/Core/Utils/Utilities.swift b/Sources/Core/Utils/Utilities.swift
@@ -11,12 +11,10 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS)
+#if os(iOS) || os(tvOS) || os(visionOS)
 import UIKit
 #elseif os(macOS)
 import AppKit
-#elseif os(tvOS)
-import UIKit
 #elseif os(watchOS)
 import WatchKit
 #endif
@@ -40,6 +38,8 @@ class Utilities {
     class var platform: DevicePlatform {
         #if os(iOS)
         return .mobile
+        #elseif os(visionOS)
+        return .headset
         #else
         return .desktop
         #endif

diff --git a/Sources/Snowplow/Tracker/DevicePlatform.swift b/Sources/Snowplow/Tracker/DevicePlatform.swift
@@ -23,6 +23,7 @@ public enum DevicePlatform : Int {
     case connectedTV
     case gameConsole
     case internetOfThings
+    case headset
 }
 
 func devicePlatformToString(_ devicePlatform: DevicePlatform) -> String? {
@@ -43,11 +44,13 @@ func devicePlatformToString(_ devicePlatform: DevicePlatform) -> String? {
         return "cnsl"
     case .internetOfThings:
         return "iot"
+    case .headset:
+        return "headset"
     }
 }
 
 func stringToDevicePlatform(_ devicePlatformString: String) -> DevicePlatform? {
-    if let index = ["web", "mob", "pc", "srv", "app", "tv", "cnsl", "iot"].firstIndex(of: devicePlatformString) {
+    if let index = ["web", "mob", "pc", "srv", "app", "tv", "cnsl", "iot", "headset"].firstIndex(of: devicePlatformString) {
         return DevicePlatform(rawValue: index)
     }
     return nil

diff --git a/Tests/TestSQLiteEventStore.swift b/Tests/TestSQLiteEventStore.swift
@@ -11,7 +11,7 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS) || os(macOS)
+#if os(iOS) || os(macOS) || os(visionOS)
 
 import XCTest
 @testable import SnowplowTracker

diff --git a/Tests/TestUtils.swift b/Tests/TestUtils.swift
@@ -36,14 +36,18 @@ class TestUtils: XCTestCase {
     func testGetPlatform() {
 #if os(iOS)
         XCTAssertEqual(Utilities.platform, .mobile)
+#elseif os(visionOS)
+        XCTAssertEqual(Utilities.platform, .headset)
 #else
         XCTAssertEqual(Utilities.platform, .desktop)
 #endif
     }
 
     func testGetResolution() {
+        #if !os(visionOS)
         let actualResolution = Utilities.resolution
         XCTAssertTrue(actualResolution != nil)
+        #endif
     }
 
     func testGetEventId() {

diff --git a/Tests/TestWebViewMessageHandler.swift b/Tests/TestWebViewMessageHandler.swift
@@ -11,7 +11,7 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS) || os(macOS)
+#if os(iOS) || os(macOS) || os(visionOS)
 import XCTest
 @testable import SnowplowTracker
 

diff --git a/Tests/Utils/MockWKScriptMessage.swift b/Tests/Utils/MockWKScriptMessage.swift
@@ -11,7 +11,7 @@
 //  express or implied. See the Apache License Version 2.0 for the specific
 //  language governing permissions and limitations there under.
 
-#if os(iOS) || os(macOS)
+#if os(iOS) || os(macOS) || os(visionOS)
 import WebKit
 
 class MockWKScriptMessage: WKScriptMessage {