feat: Track low power mode in device context

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Track low power mode in device context (#7777)
+
 ### Fixes
 
 - Detect development builds via provisioning profile and debugger attachment (#7702)

SentryTestUtils/Sources/TestSentryNSProcessInfoWrapper.swift

@@ -13,6 +13,7 @@
         public var isiOSAppOnMac: Bool?
         public var isMacCatalystApp: Bool?
         public var isiOSAppOnVisionOS: Bool?
+        public var isLowPowerModeEnabled: Bool?
     }
 
     public var overrides = Override()
@@ -50,4 +51,9 @@
     public var isiOSAppOnVisionOS: Bool {
         return overrides.isiOSAppOnVisionOS ?? ProcessInfo.processInfo.isiOSAppOnVisionOS
     }
+
+    @available(macOS 12.0, *)
+    public var isLowPowerModeEnabled: Bool {
+        return overrides.isLowPowerModeEnabled ?? ProcessInfo.processInfo.isLowPowerModeEnabled
+    }
 }

Sources/Swift/Helper/SentryExtraContextProvider.swift

@@ -52,6 +52,10 @@
         default:
             SentrySDKLog.warning("Unexpected thermal state enum value: \(thermalState)")
         }
+
+        if #available(macOS 12.0, *) {
+            extraDeviceContext["low_power_mode"] = NSNumber(value: processInfoWrapper.isLowPowerModeEnabled)
+        }
 
         #if (os(iOS)) && !SENTRY_NO_UI_FRAMEWORK
         if deviceWrapper.orientation != .unknown {

Sources/Swift/Helper/SentryProcessInfo.swift

@@ -11,8 +11,11 @@
 
     @available(macOS 12.0, *)
     var isMacCatalystApp: Bool { get }
-    
+
     var isiOSAppOnVisionOS: Bool { get }
+
+    @available(macOS 12.0, *)
+    var isLowPowerModeEnabled: Bool { get }
 }
 
 // This is needed because a file that only contains an @objc extension will get automatically stripped out

Sources/Swift/Integrations/SentryCrash/SentryCrashIntegration.swift

@@ -113,6 +113,14 @@ final class SentryCrashIntegration<Dependencies: CrashIntegrationProvider>: NSOb
             name: NSLocale.currentLocaleDidChangeNotification,
             object: nil
         )
+
+        if #available(macOS 12.0, *) {
+            NotificationCenter.default.removeObserver(
+                self,
+                name: NSNotification.Name.NSProcessInfoPowerStateDidChange,
+                object: nil
+            )
+        }
     }
 
     // MARK: - Crash Handler
@@ -241,6 +249,16 @@ final class SentryCrashIntegration<Dependencies: CrashIntegrationProvider>: NSOb
             name: NSLocale.currentLocaleDidChangeNotification,
             object: nil
         )
+
+        if #available(macOS 12.0, *) {
+            updateLowPowerModeContext(ProcessInfo.processInfo)
+            NotificationCenter.default.addObserver(
+                self,
+                selector: #selector(powerStateDidChange(notification:)),
+                name: NSNotification.Name.NSProcessInfoPowerStateDidChange,
+                object: nil
+            )
+        }
     }
 
     // Exposed to objc for the NotificationCenter in configureScope()
@@ -261,6 +279,35 @@ final class SentryCrashIntegration<Dependencies: CrashIntegrationProvider>: NSOb
         }
     }
 
+    @objc @available(macOS 12.0, *)
+    private func powerStateDidChange(notification: Notification) {
+        let processInfo = if let notificationProcessInfo = notification.object as? ProcessInfo {
+            notificationProcessInfo
+        } else {
+            ProcessInfo.processInfo
+        }
+
+        updateLowPowerModeContext(processInfo)
+    }
+
+    @available(macOS 12.0, *)
+    private func updateLowPowerModeContext(_ processInfo: ProcessInfo) {
+        let isLowPowerMode = processInfo.isLowPowerModeEnabled
+        SentrySDKInternal.currentHub().configureScope { scope in
+            var device: [String: Any]
+            let contextDictionary = scope.contextDictionary
+            if let existingDevice = contextDictionary[SENTRY_CONTEXT_DEVICE_KEY] as? [String: Any] {
+                device = existingDevice
+            } else {
+                device = [:]
+            }
+
+            device["low_power_mode"] = isLowPowerMode
+
+            scope.setContext(value: device, key: SENTRY_CONTEXT_DEVICE_KEY)
+        }
+    }
+
     // MARK: - Tracing Configuration
 
     private func configureTracingWhenCrashing() {

Tests/SentryTests/Helper/SentryExtraContextProviderTests.swift

@@ -79,4 +79,24 @@ final class SentryExtraContextProviderTests: XCTestCase {
         XCTAssertEqual(try XCTUnwrap(device["thermal_state"] as? String), "critical")
     }
 
+    func testLowPowerMode() throws {
+        let sut = fixture.getSut()
+        fixture.processWrapper.overrides.isLowPowerModeEnabled = true
+
+        let actualContext = sut.getExtraContext()
+        let device = try XCTUnwrap(actualContext["device"] as? [String: Any])
+
+        XCTAssertTrue(try XCTUnwrap(device["low_power_mode"] as? Bool))
+    }
+
+    func testLowPowerModeDisabled() throws {
+        let sut = fixture.getSut()
+        fixture.processWrapper.overrides.isLowPowerModeEnabled = false
+
+        let actualContext = sut.getExtraContext()
+        let device = try XCTUnwrap(actualContext["device"] as? [String: Any])
+
+        XCTAssertFalse(try XCTUnwrap(device["low_power_mode"] as? Bool))
+    }
+
 }