Merge pull request #8 from chazchazchaz/feature/app-group-key-storage

feature/app-group-storage

Author: roelvanderkraan

README.md

@@ -60,6 +60,12 @@ You can provide an optional path to track alongside the event.
 SimpleAnalytics.shared.track(event: "logged in", path: ["login", "social"])
 ```
 
+### Tracking Visitors for Apps + Widgets
+If you have an app + widget(s), by default one visit per day per target (app, widget) is treated as separate 'visitors'. This means that if you have an app with a small and medium widget, one person using the core app and both widgets will show in your SimpleAnalytics dashboard as 3 visitors. However, you can ensure one visitor only appears once per day by creating an App Group in your Xcode project. Create a new App Group ([instructions](https://developer.apple.com/documentation/xcode/configuring-app-groups)) in each of your targets (Project > Targets > Signing & Capabilities > App Groups) with the same name. Use this app group name in your SimpleAnalytics instance.
+```swift
+let simpleAnalytics = SimpleAnalytics(hostname: "app.simpleanalytics.com", sharedDefaultsSuiteName: "group.com.simpleanlytics.app")
+```
+
 ## Examples
 ### SwiftUI example
  In SwiftUI, a good place to put the Pageview tracking code is in your view `.onAppear{}` modifier. 

Sources/SimpleAnalytics/SimpleAnalytics.swift

@@ -30,6 +30,7 @@ final public class SimpleAnalytics: NSObject {
     private let userTimezone: String
     /// The last date a unique visit was tracked.
     private var visitDate: Date?
+    private var sharedDefaultsSuiteName: String?
 
     /// Defines if the user is opted out. When set to `true`, all tracking will be skipped. This is persisted between sessions.
     public var isOptedOut: Bool {
@@ -51,6 +52,18 @@ final public class SimpleAnalytics: NSObject {
         self.visitDate = UserDefaults.standard.object(forKey: Keys.visitDateKey) as? Date
     }
 
+    /// Create the SimpleAnalytics instance that can be used to trigger events and pageviews.
+    /// - Parameter hostname: The hostname as found in SimpleAnalytics, without `https://`
+    /// - Parameter: sharedDefaultsSuiteName: When extensions (such as a main app and widget) have a set of sharedDefaults (using an App Group) that unique user can be counted once using this (instead of two or more times when using app and widget, etc.)
+    public init(hostname: String, sharedDefaultsSuiteName: String) {
+        self.hostname = hostname
+        self.userAgent = UserAgent.userAgentString()
+        self.userLanguage = Locale.current.identifier
+        self.userTimezone = TimeZone.current.identifier
+        self.sharedDefaultsSuiteName = sharedDefaultsSuiteName
+        self.visitDate = UserDefaults(suiteName: sharedDefaultsSuiteName)?.object(forKey: Keys.visitDateKey) as? Date
+    }
+    
     /// Track a pageview
     /// - Parameter path: The path of the page as string array, for example: `["list", "detailview", "edit"]`
     public func track(path: [String]) {
@@ -123,13 +136,21 @@ final public class SimpleAnalytics: NSObject {
             } else {
                 // Last visit is not in today, so unique.
                 self.visitDate = Date()
-                UserDefaults.standard.set(self.visitDate, forKey: Keys.visitDateKey)
+                if let sharedDefaults = UserDefaults(suiteName: self.sharedDefaultsSuiteName) {
+                    sharedDefaults.set(self.visitDate, forKey: Keys.visitDateKey)
+                } else {
+                    UserDefaults.standard.set(self.visitDate, forKey: Keys.visitDateKey)
+                }
                 return true
             }
         } else {
             // No visit date yet, initialize it
             visitDate = Date()
-            UserDefaults.standard.set(visitDate, forKey: Keys.visitDateKey)
+            if let sharedDefaults = UserDefaults(suiteName: self.sharedDefaultsSuiteName) {
+                sharedDefaults.set(visitDate, forKey: Keys.visitDateKey)
+            } else {
+                UserDefaults.standard.set(visitDate, forKey: Keys.visitDateKey)
+            }                
             return true
         }
     }

Tests/SimpleAnalyticsTests/Swift_SimpleAnalyticsTests.swift

@@ -48,6 +48,24 @@ final class Swift_SimpleAnalyticsTests: XCTestCase {
 
     }
 
+    func testPageviewWithDefaultsGroup() throws {
+        let expectation = XCTestExpectation(description: "Log a pageview")
+
+        let tracker = SimpleAnalytics(hostname: "simpleanalyticsswift.app", sharedDefaultsSuiteName: "app.yourapp.com")
+        tracker.trackPageView(path: "/test")
+        wait(for: [expectation], timeout: 10.0)
+
+    }
+    
+    func testEventWithDefaultsGroup() throws {
+        let expectation = XCTestExpectation(description: "Log a pageview")
+
+        let tracker = SimpleAnalytics(hostname: "simpleanalyticsswift.app", sharedDefaultsSuiteName: "app.yourapp.com")
+        tracker.trackEvent(event: "test")
+        wait(for: [expectation], timeout: 10.0)
+
+    }
+    
     func testPath() {
 
         let tracker = SimpleAnalytics(hostname: "simpleanalyticsswift.app")