Add macOS Lifecycle Support

Segment.xcodeproj/project.pbxproj

@@ -59,6 +59,7 @@
 		967C40E3258D4DAF008EB0B6 /* Metrics_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 967C40E2258D4DAF008EB0B6 /* Metrics_Tests.swift */; };
 		9692724E25A4E5B7009B5298 /* Startup.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9692724D25A4E5B7009B5298 /* Startup.swift */; };
 		9692726825A583A6009B5298 /* SegmentDestination.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9692726725A583A6009B5298 /* SegmentDestination.swift */; };
+		96A9624E2810C6B80011DE54 /* macOSLifecycleEvents.swift in Sources */ = {isa = PBXBuildFile; fileRef = 96A9624D2810C6B80011DE54 /* macOSLifecycleEvents.swift */; };
 		96A9668927BC137F00078F8B /* iOSLifecycle_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 96A9668827BC137F00078F8B /* iOSLifecycle_Tests.swift */; };
 		96C33A9C25880A5E00F3D538 /* SegmentLog.swift in Sources */ = {isa = PBXBuildFile; fileRef = 96C33A9B25880A5E00F3D538 /* SegmentLog.swift */; };
 		96C33AB1258961F500F3D538 /* Settings.swift in Sources */ = {isa = PBXBuildFile; fileRef = 96C33AB0258961F500F3D538 /* Settings.swift */; };
@@ -161,6 +162,7 @@
 		967C40ED259A7311008EB0B6 /* HTTPClient.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HTTPClient.swift; sourceTree = "<group>"; };
 		9692724D25A4E5B7009B5298 /* Startup.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Startup.swift; sourceTree = "<group>"; };
 		9692726725A583A6009B5298 /* SegmentDestination.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SegmentDestination.swift; sourceTree = "<group>"; };
+		96A9624D2810C6B80011DE54 /* macOSLifecycleEvents.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = macOSLifecycleEvents.swift; sourceTree = "<group>"; };
 		96A9668827BC137F00078F8B /* iOSLifecycle_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = iOSLifecycle_Tests.swift; sourceTree = "<group>"; };
 		96C33A9B25880A5E00F3D538 /* SegmentLog.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SegmentLog.swift; sourceTree = "<group>"; };
 		96C33AB0258961F500F3D538 /* Settings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Settings.swift; sourceTree = "<group>"; };
@@ -337,6 +339,7 @@
 			isa = PBXGroup;
 			children = (
 				46FE4C9625A3F35E003A7362 /* macOSLifecycleMonitor.swift */,
+				96A9624D2810C6B80011DE54 /* macOSLifecycleEvents.swift */,
 			);
 			path = Mac;
 			sourceTree = "<group>";
@@ -544,6 +547,7 @@
 				46FE4CE025A53FAD003A7362 /* Storage.swift in Sources */,
 				465879BA2686560C00180335 /* watchOSDelegation.swift in Sources */,
 				46022764261E64A800A9E913 /* iOSLifecycleEvents.swift in Sources */,
+				96A9624E2810C6B80011DE54 /* macOSLifecycleEvents.swift in Sources */,
 				4621080C2605332D00EBC4A8 /* KeyPath.swift in Sources */,
 				A31A16262576B6F200C9CDDF /* Timeline.swift in Sources */,
 				96C33AB1258961F500F3D538 /* Settings.swift in Sources */,

Sources/Segment/Plugins/Platforms/Mac/macOSLifecycleEvents.swift

@@ -0,0 +1,118 @@
+//
+//  macOSLifecycleEvents.swift
+//  Segment
+//
+//  Created by Cody on 4/20/22.
+//
+
+import Foundation
+
+#if os(macOS)
+
+import Cocoa
+
+class macOSLifecycleEvents: PlatformPlugin, macOSLifecycle {
+    static var versionKey = "SEGVersionKey"
+    static var buildKey = "SEGBuildKeyV2"
+
+    let type = PluginType.before
+    var analytics: Analytics?
+
+    /// Since application:didFinishLaunchingWithOptions is not automatically called with Scenes / SwiftUI,
+    /// this gets around by using a flag in user defaults to check for big events like application updating,
+    /// being installed or even opening.
+    @Atomic
+    private var didFinishLaunching = false
+
+    func application(didFinishLaunchingWithOptions launchOptions: [String : Any]?) {
+        // Make sure we aren't double calling application:didFinishLaunchingWithOptions
+        // by resetting the check at the start
+        didFinishLaunching = true
+
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        let previousVersion = UserDefaults.standard.string(forKey: Self.versionKey)
+        let previousBuild = UserDefaults.standard.string(forKey: Self.buildKey)
+
+        let currentVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String
+        let currentBuild = Bundle.main.infoDictionary?["CFBundleVersion"] as? String
+
+        if previousBuild == nil {
+            analytics?.track(name: "Application Installed", properties: [
+                "version": currentVersion ?? "",
+                "build": currentBuild ?? ""
+            ])
+        } else if currentBuild != previousBuild {
+            analytics?.track(name: "Application Updated", properties: [
+                "previous_version": previousVersion ?? "",
+                "previous_build": previousBuild ?? "",
+                "version": currentVersion ?? "",
+                "build": currentBuild ?? ""
+            ])
+        }
+
+        analytics?.track(name: "Application Opened", properties: [
+            "from_background": false,
+            "version": currentVersion ?? "",
+            "build": currentBuild ?? ""
+        ])
+
+        UserDefaults.standard.setValue(currentVersion, forKey: Self.versionKey)
+        UserDefaults.standard.setValue(currentBuild, forKey: Self.buildKey)
+    }
+
+    func applicationDidUnhide() {
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        let currentVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String
+        let currentBuild = Bundle.main.infoDictionary?["CFBundleVersion"] as? String
+
+        analytics?.track(name: "Application Unhidden", properties: [
+            "from_background": true,
+            "version": currentVersion ?? "",
+            "build": currentBuild ?? ""
+        ])
+    }
+
+    func applicationDidHide() {
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        analytics?.track(name: "Application Hidden")
+    }
+    func applicationDidResignActive() {
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        analytics?.track(name: "Application Backgrounded")
+    }
+
+    func applicationDidBecomeActive() {
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        // Lets check if we skipped application:didFinishLaunchingWithOptions,
+        // if so, lets call it.
+        if didFinishLaunching == false {
+            // Call application did finish launching
+            self.application(didFinishLaunchingWithOptions: nil)
+        }
+    }
+
+    func applicationWillTerminate() {
+        if analytics?.configuration.values.trackApplicationLifecycleEvents == false {
+            return
+        }
+
+        analytics?.track(name: "Application Terminated")
+    }
+}
+
+#endif

Sources/Segment/Startup.swift

@@ -53,8 +53,7 @@ extension Analytics: Subscriber {
             plugins.append(watchOSLifecycleEvents())
             #endif
             #if os(macOS)
-            // placeholder - need to build this
-            //plugins.append(macOSLifecycleEvents())
+            plugins.append(macOSLifecycleEvents())
             #endif
             #if os(Linux)
             // placeholder - not sure what this is yet