Performed fixup for url options, lifecycle updates, objc compatibility (#396)

* feat: Allow for more granular tracked lifecycle events to track

# Conflicts:
#	Sources/Segment/Plugins/Platforms/iOS/iOSLifecycleEvents.swift

* Performed fixup for url options, lifecycle updates, objc compat

* fix objc example

* fix objc configuration; update docs.

* fix watchOS

* fixed watchOS defaults

* fixed watchOS lifecycle event handling

* removed test code

* attempt to fix test

* checking test timeout and real errors

* bump timeout for CI, again.

* Remove this yeetd thing.

* put tests back like they were

* Still too short for the CI runner.

---------

Co-authored-by: Kevin Delannoy <[email protected]>

Author: bsneed

.github/workflows/swift.yml

@@ -53,11 +53,6 @@ jobs:
     needs: cancel_previous
     runs-on: macos-15
     steps:
-      - name: Install yeetd
-        run: |
-          wget https://github.com/biscuitehh/yeetd/releases/download/1.0/yeetd-normal.pkg
-          sudo installer -pkg yeetd-normal.pkg -target /
-          yeetd &
       - uses: maxim-lobanov/setup-xcode@v1
         with:
           xcode-version: "16.2"

Examples/apps/BasicExample/BasicExample/AppDelegate.swift

@@ -17,7 +17,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Override point for customization after application launch.
 
         let configuration = Configuration(writeKey: "WRITE KEY")
-            .trackApplicationLifecycleEvents(true)
+            .setTrackedApplicationLifecycleEvents(.all)
             .flushInterval(10)
             .flushAt(2)
 

Examples/apps/DestinationsExample/DestinationsExample/AppDelegate.swift

@@ -23,7 +23,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Override point for customization after application launch.
 
         let configuration = Configuration(writeKey: "EioRQCqLHUECnoSseEguI8GnxOlZTOyX")
-            .trackApplicationLifecycleEvents(true)
+            .setTrackedApplicationLifecycleEvents(.all)
             .flushInterval(1)
 
         analytics = Analytics(configuration: configuration)

Examples/apps/MacExample/MacExample/AppDelegate.swift

@@ -18,7 +18,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         // Insert code here to initialize your application
 
         let configuration = Configuration(writeKey: "<WRITE KEY>")
-            .trackApplicationLifecycleEvents(true)
+            .setTrackedApplicationLifecycleEvents(.all)
             .flushInterval(10)
             .flushAt(1)
             .errorHandler { error in

Examples/apps/SegmentExtensionsExample/ArticleWidget/ArticleWidget.swift

@@ -101,5 +101,5 @@ extension Analytics {
     static var main = Analytics(configuration:
                                     Configuration(writeKey: "ABCD")
                                     .flushAt(3)
-                                    .trackApplicationLifecycleEvents(true))
+                                    .setTrackedApplicationLifecycleEvents(.all))
 }

Examples/apps/SegmentSwiftUIExample/SegmentSwiftUIExample/SegmentSwiftUIExampleApp.swift

@@ -21,5 +21,5 @@ extension Analytics {
     static var main = Analytics(configuration:
                                     Configuration(writeKey: "ABCD")
                                     .flushAt(3)
-                                    .trackApplicationLifecycleEvents(true))
+                                    .setTrackedApplicationLifecycleEvents(.all))
 }

Examples/apps/watchOSExample/watchOSExample WatchKit Extension/ExtensionDelegate.swift

@@ -14,7 +14,7 @@ class ExtensionDelegate: NSObject, WKExtensionDelegate {
     func applicationDidFinishLaunching() {
         // Perform any final initialization of your application.
         let configuration = Configuration(writeKey: "WRITE KEY")
-            .trackApplicationLifecycleEvents(true)
+            .setTrackedApplicationLifecycleEvents(.all)
             .flushInterval(10)
 
         analytics = Analytics(configuration: configuration)

Examples/tasks/MultiInstance.swift

@@ -38,9 +38,9 @@ import Segment
 extension Analytics {
     static var main = Analytics(configuration: Configuration(writeKey: "1234")
                                     .flushAt(3)
-                                    .trackApplicationLifecycleEvents(true))
-    
+                                    .setTrackedApplicationLifecycleEvents(.all))
+
     static var support = Analytics(configuration: Configuration(writeKey: "5678")
                                     .flushAt(10)
-                                    .trackApplicationLifecycleEvents(false))
+                                    .setTrackedApplicationLifecycleEvents(.none))
 }

Sources/Segment/Configuration.swift

@@ -47,11 +47,68 @@ public enum StorageMode {
 
 // MARK: - Internal Configuration
 
+@objc(SEGTrackedLifecycleEvent)
+public final class TrackedLifecycleEvent: NSObject, OptionSet {
+    public let rawValue: Int
+
+    public init(rawValue: Int) {
+        self.rawValue = rawValue
+    }
+
+    public override func isEqual(_ object: Any?) -> Bool {
+        (object as? Self)?.rawValue == rawValue
+    }
+
+    public override var hash: Int {
+        rawValue.hashValue
+    }
+
+    @objc public static let none: TrackedLifecycleEvent = []
+    @objc public static let applicationInstalled = TrackedLifecycleEvent(rawValue: 1 << 0)
+    @objc public static let applicationUpdated = TrackedLifecycleEvent(rawValue: 1 << 1)
+    @objc public static let applicationOpened = TrackedLifecycleEvent(rawValue: 1 << 2)
+    @objc public static let applicationBackgrounded = TrackedLifecycleEvent(rawValue: 1 << 3)
+    @objc public static let applicationForegrounded = TrackedLifecycleEvent(rawValue: 1 << 4)
+    #if os(macOS)
+    @objc public static let applicationUnhidden = TrackedLifecycleEvent(rawValue: 1 << 5)
+    @objc public static let applicationHidden = TrackedLifecycleEvent(rawValue: 1 << 6)
+    @objc public static let applicationTerminated = TrackedLifecycleEvent(rawValue: 1 << 7)
+
+    @objc public static let all: TrackedLifecycleEvent = [
+        .applicationInstalled,
+        .applicationUpdated,
+        .applicationOpened,
+        .applicationBackgrounded,
+        .applicationForegrounded,
+        .applicationUnhidden,
+        .applicationHidden,
+        .applicationTerminated,
+    ]
+    #elseif os(iOS) || os(tvOS) || os(visionOS) || targetEnvironment(macCatalyst)
+    @objc public static let all: TrackedLifecycleEvent = [
+        .applicationInstalled,
+        .applicationUpdated,
+        .applicationOpened,
+        .applicationBackgrounded,
+        .applicationForegrounded,
+    ]
+    #elseif os(watchOS)
+    @objc public static let all: TrackedLifecycleEvent = [
+        .applicationInstalled,
+        .applicationUpdated,
+        .applicationOpened,
+        .applicationBackgrounded,
+    ]
+    #else
+    @objc public static let all = TrackedLifecycleEvent.none
+    #endif
+}
+
 public class Configuration {
     internal struct Values {
         var writeKey: String
         var application: Any? = nil
-        var trackApplicationLifecycleEvents: Bool = true
+        var trackedApplicationLifecycleEvents = TrackedLifecycleEvent.all
         var flushAt: Int = 20
         var flushInterval: TimeInterval = 30
         var defaultSettings: Settings? = nil
@@ -110,8 +167,19 @@ public extension Configuration {
     /// - Parameter enabled: A bool value
     /// - Returns: The current Configuration.
     @discardableResult
+    @available(*, deprecated, message: "Use `setTrackedApplicationLifecycleEvents(_:)` for more granular control")
     func trackApplicationLifecycleEvents(_ enabled: Bool) -> Configuration {
-        values.trackApplicationLifecycleEvents = enabled
+        values.trackedApplicationLifecycleEvents = enabled ? .all : .none
+        return self
+    }
+
+    /// Opt-in/out of tracking lifecycle events.  The default value is `.none`.
+    ///
+    /// - Parameter events: An option set of the events to track.
+    /// - Returns: The current Configuration.
+    @discardableResult
+    func setTrackedApplicationLifecycleEvents(_ events: TrackedLifecycleEvent) -> Configuration {
+        values.trackedApplicationLifecycleEvents = events
         return self
     }
 

Sources/Segment/ObjC/ObjCConfiguration.swift

@@ -27,14 +27,15 @@ public class ObjCConfiguration: NSObject {
         }
     }
 
-    /// Opt-in/out of tracking lifecycle events.  The default value is `false`.
+    /// Opt-in/out of tracking lifecycle events.  The default value is `true`.
+    /// NOTE: the default differs from analytics-ios.
     @objc
     public var trackApplicationLifecycleEvents: Bool {
         get {
-            return configuration.values.trackApplicationLifecycleEvents
+            return (configuration.values.trackedApplicationLifecycleEvents != .none)
         }
         set(value) {
-            configuration.trackApplicationLifecycleEvents(value)
+            configuration.setTrackedApplicationLifecycleEvents(.all)
         }
     }