feat: report low power mode and thermal info to stats (#1583)

kristian-mkd · web-flow · commit ef49ceef032f · 2024-12-20T13:19:08.000+01:00
## Overview

Adds react native implementation for reporting device `thermal state`
and `low power mode enabled` states to the call stats.
diff --git a/packages/client/src/client-details.ts b/packages/client/src/client-details.ts
@@ -1,10 +1,13 @@
 import {
+  AndroidThermalState,
+  AppleThermalState,
   ClientDetails,
   Device,
   OS,
   Sdk,
   SdkType,
 } from './gen/video/sfu/models/models';
+import { SendStatsRequest } from './gen/video/sfu/signal_rpc/signal';
 import { isReactNative } from './helpers/platforms';
 import { UAParser } from 'ua-parser-js';
 
@@ -25,6 +28,7 @@ let sdkInfo: Sdk | undefined = {
 let osInfo: OS | undefined;
 let deviceInfo: Device | undefined;
 let webRtcInfo: WebRTCInfoType | undefined;
+let deviceState: SendStatsRequest['deviceState'];
 
 export const setSdkInfo = (info: Sdk) => {
   sdkInfo = info;
@@ -62,6 +66,82 @@ export type LocalClientDetailsType = ClientDetails & {
   webRTCInfo?: WebRTCInfoType;
 };
 
+export const setThermalState = (state: string) => {
+  if (!osInfo) {
+    deviceState = { oneofKind: undefined };
+    return;
+  }
+
+  if (osInfo.name === 'android') {
+    const thermalState =
+      AndroidThermalState[state as keyof typeof AndroidThermalState] ||
+      AndroidThermalState.UNSPECIFIED;
+
+    deviceState = {
+      oneofKind: 'android',
+      android: {
+        thermalState,
+        isPowerSaverMode:
+          deviceState?.oneofKind === 'android' &&
+          deviceState.android.isPowerSaverMode,
+      },
+    };
+  }
+
+  if (osInfo.name.toLowerCase() === 'ios') {
+    const thermalState =
+      AppleThermalState[state as keyof typeof AppleThermalState] ||
+      AppleThermalState.UNSPECIFIED;
+
+    deviceState = {
+      oneofKind: 'apple',
+      apple: {
+        thermalState,
+        isLowPowerModeEnabled:
+          deviceState?.oneofKind === 'apple' &&
+          deviceState.apple.isLowPowerModeEnabled,
+      },
+    };
+  }
+};
+
+export const setPowerState = (powerMode: boolean) => {
+  if (!osInfo) {
+    deviceState = { oneofKind: undefined };
+    return;
+  }
+
+  if (osInfo.name === 'android') {
+    deviceState = {
+      oneofKind: 'android',
+      android: {
+        thermalState:
+          deviceState?.oneofKind === 'android'
+            ? deviceState.android.thermalState
+            : AndroidThermalState.UNSPECIFIED,
+        isPowerSaverMode: powerMode,
+      },
+    };
+  }
+
+  if (osInfo.name.toLowerCase() === 'ios') {
+    deviceState = {
+      oneofKind: 'apple',
+      apple: {
+        thermalState:
+          deviceState?.oneofKind === 'apple'
+            ? deviceState.apple.thermalState
+            : AppleThermalState.UNSPECIFIED,
+        isLowPowerModeEnabled: powerMode,
+      },
+    };
+  }
+};
+
+export const getDeviceState = () => {
+  return deviceState;
+};
+
 export const getClientDetails = (): LocalClientDetailsType => {
   if (isReactNative()) {
     // Since RN doesn't support web, sharing browser info is not required
diff --git a/packages/client/src/stats/SfuStatsReporter.ts b/packages/client/src/stats/SfuStatsReporter.ts
@@ -4,7 +4,11 @@ import { OwnCapability, StatsOptions } from '../gen/coordinator';
 import { getLogger } from '../logger';
 import { Publisher, Subscriber } from '../rtc';
 import { flatten, getSdkName, getSdkVersion } from './utils';
-import { getWebRTCInfo, LocalClientDetailsType } from '../client-details';
+import {
+  getDeviceState,
+  getWebRTCInfo,
+  LocalClientDetailsType,
+} from '../client-details';
 import { InputDevices } from '../gen/video/sfu/models/models';
 import { CameraManager, MicrophoneManager } from '../devices';
 import { createSubscription } from '../store/rxUtils';
@@ -132,7 +136,7 @@ export class SfuStatsReporter {
       publisherStats,
       audioDevices: this.inputDevices.get('mic'),
       videoDevices: this.inputDevices.get('camera'),
-      deviceState: { oneofKind: undefined },
+      deviceState: getDeviceState(),
       telemetry: telemetryData,
     });
   };
diff --git a/packages/react-native-sdk/android/src/main/AndroidManifest.xml b/packages/react-native-sdk/android/src/main/AndroidManifest.xml
@@ -2,4 +2,5 @@
         package="com.streamvideo.reactnative">
 
     <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.DEVICE_POWER" />
 </manifest>
diff --git a/packages/react-native-sdk/android/src/main/java/com/streamvideo/reactnative/StreamVideoReactNativeModule.kt b/packages/react-native-sdk/android/src/main/java/com/streamvideo/reactnative/StreamVideoReactNativeModule.kt
@@ -4,8 +4,12 @@ import android.app.AppOpsManager
 import android.app.PictureInPictureParams
 import android.content.Context
 import android.content.pm.PackageManager
+import android.content.BroadcastReceiver
+import android.content.Intent
+import android.content.IntentFilter
 import android.net.Uri
 import android.os.Build
+import android.os.PowerManager
 import android.os.Process
 import android.util.Rational
 import androidx.annotation.RequiresApi
@@ -23,13 +27,18 @@ class StreamVideoReactNativeModule(reactContext: ReactApplicationContext) : Reac
         return NAME;
     }
 
+    private var thermalStatusListener: PowerManager.OnThermalStatusChangedListener? = null
+
     override fun initialize() {
         super.initialize()
         StreamVideoReactNative.pipListeners.add { isInPictureInPictureMode ->
             reactApplicationContext.getJSModule(
                 RCTDeviceEventEmitter::class.java
             ).emit(PIP_CHANGE_EVENT, isInPictureInPictureMode)
         }
+        
+        val filter = IntentFilter(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED)
+        reactApplicationContext.registerReceiver(powerReceiver, filter)
     }
 
     @ReactMethod
@@ -81,6 +90,111 @@ class StreamVideoReactNativeModule(reactContext: ReactApplicationContext) : Reac
         StreamVideoReactNative.canAutoEnterPictureInPictureMode = value
     }
 
+    @ReactMethod
+    fun startThermalStatusUpdates(promise: Promise) {
+        try {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+                val powerManager = reactApplicationContext.getSystemService(ReactApplicationContext.POWER_SERVICE) as PowerManager
+                
+                val listener = PowerManager.OnThermalStatusChangedListener { status ->
+                    val thermalStatus = when (status) {
+                        PowerManager.THERMAL_STATUS_NONE -> "NONE"
+                        PowerManager.THERMAL_STATUS_LIGHT -> "LIGHT"
+                        PowerManager.THERMAL_STATUS_MODERATE -> "MODERATE"
+                        PowerManager.THERMAL_STATUS_SEVERE -> "SEVERE"
+                        PowerManager.THERMAL_STATUS_CRITICAL -> "CRITICAL"
+                        PowerManager.THERMAL_STATUS_EMERGENCY -> "EMERGENCY"
+                        PowerManager.THERMAL_STATUS_SHUTDOWN -> "SHUTDOWN"
+                        else -> "UNKNOWN"
+                    }
+                    
+                    reactApplicationContext
+                        .getJSModule(RCTDeviceEventEmitter::class.java)
+                        .emit("thermalStateDidChange", thermalStatus)
+                }
+                
+                thermalStatusListener = listener
+                powerManager.addThermalStatusListener(listener)
+                // Get initial status
+                currentThermalState(promise)
+            } else {
+                promise.resolve("NOT_SUPPORTED")
+            }
+        } catch (e: Exception) {
+            promise.reject("THERMAL_ERROR", e.message)
+        }
+    }
+
+    @ReactMethod
+    fun stopThermalStatusUpdates() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+            val powerManager = reactApplicationContext.getSystemService(ReactApplicationContext.POWER_SERVICE) as PowerManager
+            // Store the current listener in a local val for safe null checking
+            val currentListener = thermalStatusListener
+            if (currentListener != null) {
+                powerManager.removeThermalStatusListener(currentListener)
+                thermalStatusListener = null
+            }
+        }
+    }
+
+    @ReactMethod
+    fun currentThermalState(promise: Promise) {
+        try {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+                val powerManager = reactApplicationContext.getSystemService(ReactApplicationContext.POWER_SERVICE) as PowerManager
+                val status = powerManager.currentThermalStatus
+                val thermalStatus = when (status) {
+                    PowerManager.THERMAL_STATUS_NONE -> "NONE"
+                    PowerManager.THERMAL_STATUS_LIGHT -> "LIGHT"
+                    PowerManager.THERMAL_STATUS_MODERATE -> "MODERATE"
+                    PowerManager.THERMAL_STATUS_SEVERE -> "SEVERE"
+                    PowerManager.THERMAL_STATUS_CRITICAL -> "CRITICAL"
+                    PowerManager.THERMAL_STATUS_EMERGENCY -> "EMERGENCY"
+                    PowerManager.THERMAL_STATUS_SHUTDOWN -> "SHUTDOWN"
+                    else -> "UNKNOWN"
+                }
+                promise.resolve(thermalStatus)
+            } else {
+                promise.resolve("NOT_SUPPORTED")
+            }
+        } catch (e: Exception) {
+            promise.reject("THERMAL_ERROR", e.message)
+        }
+    }
+
+    private val powerReceiver = object : BroadcastReceiver() {
+        override fun onReceive(context: Context?, intent: Intent?) {
+            if (intent?.action == PowerManager.ACTION_POWER_SAVE_MODE_CHANGED) {
+                sendPowerModeEvent()
+            }
+        }
+    }
+
+    override fun onCatalystInstanceDestroy() {
+        super.onCatalystInstanceDestroy()
+        reactApplicationContext.unregisterReceiver(powerReceiver)
+        stopThermalStatusUpdates()
+    }
+
+    private fun sendPowerModeEvent() {
+        val powerManager = reactApplicationContext.getSystemService(Context.POWER_SERVICE) as PowerManager
+        val isLowPowerMode = powerManager.isPowerSaveMode
+        reactApplicationContext
+            .getJSModule(RCTDeviceEventEmitter::class.java)
+            .emit("isLowPowerModeEnabled", isLowPowerMode)
+    }
+
+    @ReactMethod
+    fun isLowPowerModeEnabled(promise: Promise) {
+        try {
+            val powerManager = reactApplicationContext.getSystemService(Context.POWER_SERVICE) as PowerManager
+            promise.resolve(powerManager.isPowerSaveMode)
+        } catch (e: Exception) {
+            promise.reject("ERROR", e.message)
+        }
+    }
+
     private fun hasPermission(): Boolean {
         return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O && reactApplicationContext.packageManager.hasSystemFeature(PackageManager.FEATURE_PICTURE_IN_PICTURE)) {
             val appOps =
diff --git a/packages/react-native-sdk/ios/StreamVideoReactNative.m b/packages/react-native-sdk/ios/StreamVideoReactNative.m
@@ -17,7 +17,7 @@ void broadcastNotificationCallback(CFNotificationCenterRef center,
     StreamVideoReactNative *this = (__bridge StreamVideoReactNative*)observer;
     NSString *eventName = (__bridge NSString*)name;
     [this screenShareEventReceived: eventName];
-    
+
 }
 
 @implementation StreamVideoReactNative
@@ -44,10 +44,21 @@ -(instancetype)init {
         _notificationCenter = CFNotificationCenterGetDarwinNotifyCenter();
         [self setupObserver];
     }
-    
+    if (self) {
+        [UIDevice currentDevice].batteryMonitoringEnabled = YES;
+    }
+
     return self;
 }
 
+RCT_EXPORT_METHOD(isLowPowerModeEnabled:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
+    resolve(@([NSProcessInfo processInfo].lowPowerModeEnabled));
+}
+
+RCT_EXPORT_METHOD(currentThermalState:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject) {
+    resolve(@([NSProcessInfo processInfo].thermalState));
+}
+
 -(void)dealloc {
     [self clearObserver];
 }
@@ -81,10 +92,40 @@ -(void)clearObserver {
 
 -(void)startObserving {
     hasListeners = YES;
+    [[NSNotificationCenter defaultCenter] addObserver:self
+                                             selector:@selector(powerModeDidChange)
+                                                 name:NSProcessInfoPowerStateDidChangeNotification
+                                               object:nil];
+    [[NSNotificationCenter defaultCenter] addObserver:self
+                                             selector:@selector(thermalStateDidChange)
+                                                 name:NSProcessInfoThermalStateDidChangeNotification
+                                               object:nil];
 }
 
 -(void)stopObserving {
     hasListeners = NO;
+    [[NSNotificationCenter defaultCenter] removeObserver:self
+                                                    name:NSProcessInfoPowerStateDidChangeNotification
+                                                  object:nil];
+    [[NSNotificationCenter defaultCenter] removeObserver:self
+                                                    name:NSProcessInfoThermalStateDidChangeNotification
+                                                  object:nil];
+}
+
+- (void)powerModeDidChange {
+    if (!hasListeners) {
+        return;
+    }
+    BOOL lowPowerEnabled = [NSProcessInfo processInfo].lowPowerModeEnabled;
+    [self sendEventWithName:@"isLowPowerModeEnabled" body:@(lowPowerEnabled)];
+}
+
+- (void)thermalStateDidChange {
+    if (!hasListeners) {
+        return;
+    }
+    NSInteger thermalState = [NSProcessInfo processInfo].thermalState;
+    [self sendEventWithName:@"thermalStateDidChange" body:@(thermalState)];
 }
 
 -(void)screenShareEventReceived:(NSString*)event {
@@ -113,11 +154,11 @@ +(void)registerIncomingCall:(NSString *)cid uuid:(NSString *)uuid {
      } else {
         reject(@"access_failure", @"requested incoming call found", nil);
      }
-    
+
 }
 
 -(NSArray<NSString *> *)supportedEvents {
-    return @[@"StreamVideoReactNative_Ios_Screenshare_Event"];
+    return @[@"StreamVideoReactNative_Ios_Screenshare_Event", @"isLowPowerModeEnabled", @"thermalStateDidChange"];
 }
 
 @end
diff --git a/packages/react-native-sdk/src/providers/StreamCall.tsx b/packages/react-native-sdk/src/providers/StreamCall.tsx
diff --git a/sample-apps/react-native/dogfood/ios/StreamReactNativeVideoSDKSample.xcodeproj/project.pbxproj b/sample-apps/react-native/dogfood/ios/StreamReactNativeVideoSDKSample.xcodeproj/project.pbxproj
