openURL adjustments / standardization (#182)

* Fixes for openURL inconsistencies

* Added test

* isolated test to iOS

* Made it more platform agnostic

* Fixed protocol visibility

* Fix linux build; update mac xcode.

* test build

* updated ci config

* Added conversion method for UIKit

* Update documentation

Author: bsneed

.github/workflows/swift.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
     - uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '13.2.1'
+        xcode-version: latest-stable
     - uses: actions/checkout@v2
     - uses: webfactory/[email protected]
       with:
@@ -34,9 +34,9 @@ jobs:
     needs: cancel_previous
     runs-on: ubuntu-latest
     steps:
-    - uses: fwal/setup-swift@v1
+    - uses: fwal/setup-swift@v1.21.0
       with:
-        swift-version: "5.4"
+        swift-version: "5.7.2"
     - uses: actions/checkout@v2
     - uses: webfactory/[email protected]
       with:
@@ -72,7 +72,7 @@ jobs:
     steps:
     - uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '13.2.1'
+        xcode-version: latest-stable
     - uses: actions/checkout@v2
     - uses: actions/cache@v2
       with:
@@ -91,7 +91,7 @@ jobs:
     steps:
     - uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '13.2.1'
+        xcode-version: latest-stable
     - uses: actions/checkout@v2
     - uses: actions/cache@v2
       with:
@@ -110,7 +110,7 @@ jobs:
     steps:
     - uses: maxim-lobanov/[email protected]
       with:
-        xcode-version: '14.0.0'
+        xcode-version: latest-stable
     - uses: actions/checkout@v2
     - uses: actions/cache@v2
       with:
@@ -149,7 +149,7 @@ jobs:
     steps:
     - uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '13.2.1'
+        xcode-version: latest-stable
     - uses: actions/checkout@v2
     - uses: actions/cache@v2
       with:

Sources/Segment/Analytics.swift

@@ -203,7 +203,6 @@ extension Analytics {
     public func manuallyEnableDestination(plugin: DestinationPlugin) {
         self.store.dispatch(action: System.AddDestinationToSettingsAction(key: plugin.key))
     }
-
 }
 
 extension Analytics {
@@ -259,3 +258,60 @@ extension Analytics {
         }
     }
 }
+
+extension Analytics {
+    /**
+     Call openURL as needed or when instructed to by either UIApplicationDelegate or UISceneDelegate.
+     This is necessary to track URL referrers across events.  This method will also iterate
+     any plugins that are watching for openURL events.
+     
+     Example:
+     ```
+     func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
+         let myStruct = MyStruct(options)
+         analytics?.openURL(url, options: options)
+         return true
+     }
+     ```
+     */
+    public func openURL<T: Codable>(_ url: URL, options: T? = nil) {
+        guard let jsonProperties = try? JSON(with: options) else { return }
+        guard let dict = jsonProperties.dictionaryValue else { return }
+        openURL(url, options: dict)
+    }
+    
+    /**
+     Call openURL as needed or when instructed to by either UIApplicationDelegate or UISceneDelegate.
+     This is necessary to track URL referrers across events.  This method will also iterate
+     any plugins that are watching for openURL events.
+     
+     Example:
+     ```
+     func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
+         analytics?.openURL(url, options: options)
+         return true
+     }
+     ```
+     */
+    public func openURL(_ url: URL, options: [String: Any] = [:]) {
+        store.dispatch(action: UserInfo.SetReferrerAction(url: url))
+        
+        // let any conforming plugins know
+        apply { plugin in
+            if let p = plugin as? OpeningURLs {
+                p.openURL(url, options: options)
+            }
+        }
+        
+        var jsonProperties: JSON? = nil
+        if let json = try? JSON(options) {
+            jsonProperties = json
+            _ = try? jsonProperties?.add(value: url.absoluteString, forKey: "url")
+        } else {
+            if let json = try? JSON(["url": url.absoluteString]) {
+                jsonProperties = json
+            }
+        }
+        track(name: "Deep Link Opened", properties: jsonProperties)
+    }
+}

Sources/Segment/Plugins/Context.swift

@@ -7,6 +7,14 @@
 
 import Foundation
 
+public protocol OpeningURLs {
+    func openURL(_ url: URL, options: [String : Any])
+}
+
+extension OpeningURLs {
+    func openURL(_ url: URL, options: [String : Any]) {}
+}
+
 public class Context: PlatformPlugin {
     public let type: PluginType = .before
     public weak var analytics: Analytics?
@@ -25,6 +33,10 @@ public class Context: PlatformPlugin {
         // add instanceId to the context
         context["instanceId"] = instanceId
 
+        if let userInfo: UserInfo = analytics?.store.currentState(), let referrer = userInfo.referrer {
+            context["referrer"] = ["url": referrer.absoluteString]
+        }
+        
         // if this event came in with context data already
         // let it take precedence over our values.
         if let eventContext = workingEvent.context?.dictionaryValue {

Sources/Segment/Plugins/Platforms/iOS/iOSDelegation.swift

@@ -80,27 +80,21 @@ extension Analytics {
                 p.continueUserActivity(activity)
             }
         }
-    }
-}
-
-// MARK: - Opening a URL
-
-public protocol OpeningURLs {
-    func openURL(_ url: URL, options: [UIApplication.OpenURLOptionsKey : Any])
-}
-
-extension OpeningURLs {
-    func openURL(_ url: URL, options: [UIApplication.OpenURLOptionsKey : Any]) {}
-}
-
-extension Analytics {
-    public func openURL(_ url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) {
-        apply { plugin in
-            if let p = plugin as? OpeningURLs {
-                p.openURL(url, options: options)
+        
+        if activity.activityType == NSUserActivityTypeBrowsingWeb {
+            if let url = activity.webpageURL {
+                openURL(url, options: ["title": activity.title ?? ""])
             }
         }
     }
+    
+    public func openURL(_ url: URL, options: [UIApplication.OpenURLOptionsKey: Any]) {
+        var converted: [String: Any] = [:]
+        for (key, value) in options {
+            converted[String(describing:key)] = value
+        }
+        openURL(url, options: converted)
+    }
 }
 
 #endif

Sources/Segment/State.swift

@@ -85,26 +85,27 @@ struct UserInfo: Codable, State {
     let anonymousId: String
     let userId: String?
     let traits: JSON?
+    let referrer: URL?
 
     struct ResetAction: Action {
         func reduce(state: UserInfo) -> UserInfo {
-            return UserInfo(anonymousId: UUID().uuidString, userId: nil, traits: nil)
+            return UserInfo(anonymousId: UUID().uuidString, userId: nil, traits: nil, referrer: nil)
         }
     }
 
     struct SetUserIdAction: Action {
         let userId: String
 
         func reduce(state: UserInfo) -> UserInfo {
-            return UserInfo(anonymousId: state.anonymousId, userId: userId, traits: state.traits)
+            return UserInfo(anonymousId: state.anonymousId, userId: userId, traits: state.traits, referrer: state.referrer)
         }
     }
 
     struct SetTraitsAction: Action {
         let traits: JSON?
 
         func reduce(state: UserInfo) -> UserInfo {
-            return UserInfo(anonymousId: state.anonymousId, userId: state.userId, traits: traits)
+            return UserInfo(anonymousId: state.anonymousId, userId: state.userId, traits: traits, referrer: state.referrer)
         }
     }
 
@@ -113,15 +114,23 @@ struct UserInfo: Codable, State {
         let traits: JSON?
 
         func reduce(state: UserInfo) -> UserInfo {
-            return UserInfo(anonymousId: state.anonymousId, userId: userId, traits: traits)
+            return UserInfo(anonymousId: state.anonymousId, userId: userId, traits: traits, referrer: state.referrer)
         }
     }
 
     struct SetAnonymousIdAction: Action {
         let anonymousId: String
 
         func reduce(state: UserInfo) -> UserInfo {
-            return UserInfo(anonymousId: anonymousId, userId: state.userId, traits: state.traits)
+            return UserInfo(anonymousId: anonymousId, userId: state.userId, traits: state.traits, referrer: state.referrer)
+        }
+    }
+    
+    struct SetReferrerAction: Action {
+        let url: URL
+        
+        func reduce(state: UserInfo) -> UserInfo {
+            return UserInfo(anonymousId: state.anonymousId, userId: state.userId, traits: state.traits, referrer: url)
         }
     }
 }
@@ -150,6 +159,6 @@ extension UserInfo {
         if let existingId: String = storage.read(.anonymousId) {
             anonymousId = existingId
         }
-        return UserInfo(anonymousId: anonymousId, userId: userId, traits: traits)
+        return UserInfo(anonymousId: anonymousId, userId: userId, traits: traits, referrer: nil)
     }
 }

Tests/Segment-Tests/Analytics_Tests.swift

@@ -125,6 +125,9 @@ final class Analytics_Tests: XCTestCase {
 
         waitUntilStarted(analytics: analytics)
 
+        // add a referrer
+        analytics.openURL(URL(string: "https://google.com")!)
+        
         analytics.track(name: "token check")
 
         let trackEvent: TrackEvent? = outputReader.lastEvent as? TrackEvent
@@ -138,6 +141,9 @@ final class Analytics_Tests: XCTestCase {
         XCTAssertNotNil(context?["timezone"], "timezone missing!")
         XCTAssertNotNil(context?["library"], "library missing!")
         XCTAssertNotNil(context?["device"], "device missing!")
+        
+        let referrer = context?["referrer"] as! [String: Any]
+        XCTAssertEqual(referrer["url"] as! String, "https://google.com")
 
         // this key not present on watchOS (doesn't have webkit)
         #if !os(watchOS)

Tests/Segment-Tests/JSON_Tests.swift

@@ -38,7 +38,7 @@ class JSONTests: XCTestCase {
 
     func testJSONBasic() throws {
         let traits = try? JSON(["email": "[email protected]"])
-        let userInfo = UserInfo(anonymousId: "1234", userId: "brandon", traits: traits)
+        let userInfo = UserInfo(anonymousId: "1234", userId: "brandon", traits: traits, referrer: nil)
 
         let encoder = JSONEncoder()
         encoder.outputFormatting = .prettyPrinted

test.txt

@@ -0,0 +1 @@
+blah