Explicitly define what types are allowed for custom properties

aptabase · Jun 10, 2023 · ed2db3b · ed2db3b
1 parent 608dd0d
commit ed2db3b
Show file tree

Hide file tree

Showing 6 changed files with 99 additions and 6 deletions.
diff --git a/Aptabase.podspec b/Aptabase.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
     s.name                      = 'Aptabase'
-    s.version                   = '0.0.7'
+    s.version                   = '0.1.0'
     s.summary                   = 'Swift SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps'
     s.homepage                  = 'https://aptabase.com'
     s.license                   = { :type => 'MIT', :file => 'LICENSE' }

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.1.0
+
+* General refactor
+* Explicitly define what types are allowed for custom properties
+
 ## 0.0.7
 
 * Added support for CocoaPods

diff --git a/Example/HelloWorld.xcodeproj/xcshareddata/xcschemes/HelloWorld.xcscheme b/Example/HelloWorld.xcodeproj/xcshareddata/xcschemes/HelloWorld.xcscheme
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1430"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "E2019AE329DAEF2600204720"
+               BuildableName = "HelloWorld.app"
+               BlueprintName = "HelloWorld"
+               ReferencedContainer = "container:HelloWorld.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "E2019AE329DAEF2600204720"
+            BuildableName = "HelloWorld.app"
+            BlueprintName = "HelloWorld"
+            ReferencedContainer = "container:HelloWorld.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "E2019AE329DAEF2600204720"
+            BuildableName = "HelloWorld.app"
+            BlueprintName = "HelloWorld"
+            ReferencedContainer = "container:HelloWorld.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ let package = Package(
     ...
     dependencies: [
         ...
-        .package(name: "Aptabase", url: "https://github.com/aptabase/aptabase-swift.git", from: "0.0.7"),
+        .package(name: "Aptabase", url: "https://github.com/aptabase/aptabase-swift.git", from: "0.1.0"),
     ],
     targets: [
         .target(
@@ -39,7 +39,7 @@ Use this [guide](https://developer.apple.com/documentation/xcode/adding-package-
 Aptabase is alsoavailable through CocoaPods. To install it, simply add the following line to your Podfile:
 
 ```ruby
-pod 'Aptabase', :git => 'https://github.com/aptabase/aptabase-swift.git', :tag => '0.0.7'
+pod 'Aptabase', :git => 'https://github.com/aptabase/aptabase-swift.git', :tag => '0.1.0'
 ```
 
 

diff --git a/Sources/Aptabase/Aptabase.swift b/Sources/Aptabase/Aptabase.swift
@@ -10,7 +10,7 @@ public struct InitOptions {
 
 // The Aptabase client used to track events
 public class Aptabase {
-    private static var sdkVersion = "aptabase-swift@0.0.7";
+    private static var sdkVersion = "aptabase-swift@0.1.0";
 
     // Session expires after 1 hour of inactivity
     private var sessionTimeout: TimeInterval = 1 * 60 * 60
@@ -64,7 +64,7 @@ public class Aptabase {
     }
 
     // Track an event and its properties
-    public func trackEvent(_ eventName: String, with props: [String: Any] = [:]) {
+    public func trackEvent(_ eventName: String, with props: [String: Value] = [:]) {
         DispatchQueue(label: "com.aptabase.aptabase").async { [self] in
             guard let appKey, let env, let apiURL else {
                 return
@@ -92,7 +92,12 @@ public class Aptabase {
                 ] as [String : Any],
                 "props": props
             ]
-
+
+            if !JSONSerialization.isValidJSONObject(props) {
+                debugPrint("Aptabase: unable to serialize custom props. Event will be discarded.")
+                return
+            }
+
             guard let body = try? JSONSerialization.data(withJSONObject: body) else { return }
 
             var request = URLRequest(url: apiURL)

diff --git a/Sources/Aptabase/Value.swift b/Sources/Aptabase/Value.swift
@@ -0,0 +1,6 @@
+public protocol Value {}
+extension Int: Value {}
+extension Double: Value {}
+extension String: Value {}
+extension Float: Value {}
+extension Bool: Value {}