State datasource for PowerMode (#2919)

bidetofevil · web-flow · commit 85afdf52918a · 2025-12-18T16:08:11.000-08:00
Datasource for Low Power mode. This is disabled in production because of the feature flag and base InstrumentationProvider
diff --git a/embrace-android-instrumentation-power-save/src/main/kotlin/io/embrace/android/embracesdk/internal/instrumentation/powersave/PowerStateDataSource.kt b/embrace-android-instrumentation-power-save/src/main/kotlin/io/embrace/android/embracesdk/internal/instrumentation/powersave/PowerStateDataSource.kt
@@ -0,0 +1,45 @@
+package io.embrace.android.embracesdk.internal.instrumentation.powersave
+
+import android.content.Context
+import android.os.PowerManager
+import io.embrace.android.embracesdk.internal.arch.InstrumentationArgs
+import io.embrace.android.embracesdk.internal.arch.datasource.StateDataSource
+import io.embrace.android.embracesdk.internal.arch.schema.SchemaType.PowerState
+import io.embrace.android.embracesdk.internal.arch.schema.SchemaType.PowerState.PowerMode
+import io.embrace.android.embracesdk.internal.utils.Provider
+import io.embrace.android.embracesdk.internal.worker.Worker
+
+class PowerStateDataSource(
+    private val args: InstrumentationArgs,
+) : StateDataSource<PowerMode>(
+    args = args,
+    stateValueFactory = ::PowerState,
+    defaultValue = PowerMode.UNKNOWN,
+) {
+    private val powerManagerProvider: Provider<PowerManager?> = { args.systemService(Context.POWER_SERVICE) }
+    private val receiver = PowerSaveModeReceiver(powerManagerProvider, ::onPowerSaveModeChanged)
+
+    override fun onDataCaptureEnabled() {
+        super.onDataCaptureEnabled()
+        args.backgroundWorker(Worker.Background.NonIoRegWorker).run {
+            receiver.register(args.context, this)
+            submit {
+                powerManagerProvider()?.let {
+                    onPowerSaveModeChanged(it.isPowerSaveMode)
+                }
+            }
+        }
+    }
+
+    override fun onDataCaptureDisabled(): Unit = receiver.unregister(args.context)
+
+    private fun onPowerSaveModeChanged(powerSaveMode: Boolean) {
+        val timestamp = clock.now()
+        val newState = if (powerSaveMode) {
+            PowerMode.LOW
+        } else {
+            PowerMode.NORMAL
+        }
+        onStateChange(timestamp, newState)
+    }
+}
diff --git a/embrace-android-instrumentation-power-save/src/main/kotlin/io/embrace/android/embracesdk/internal/instrumentation/powersave/PowerStateInstrumentationProvider.kt b/embrace-android-instrumentation-power-save/src/main/kotlin/io/embrace/android/embracesdk/internal/instrumentation/powersave/PowerStateInstrumentationProvider.kt
@@ -0,0 +1,14 @@
+package io.embrace.android.embracesdk.internal.instrumentation.powersave
+
+import io.embrace.android.embracesdk.internal.arch.InstrumentationArgs
+import io.embrace.android.embracesdk.internal.arch.datasource.StateInstrumentationProvider
+import io.embrace.android.embracesdk.internal.arch.schema.SchemaType
+
+class PowerStateInstrumentationProvider :
+    StateInstrumentationProvider<PowerStateDataSource, SchemaType.PowerState.PowerMode>(
+        configGate = { configService.autoDataCaptureBehavior.isPowerSaveModeCaptureEnabled() }
+    ) {
+    override fun factoryProvider(args: InstrumentationArgs): () -> PowerStateDataSource {
+        return { PowerStateDataSource(args) }
+    }
+}
diff --git a/embrace-android-instrumentation-power-save/src/main/resources/META-INF/services/io.embrace.android.embracesdk.internal.arch.InstrumentationProvider b/embrace-android-instrumentation-power-save/src/main/resources/META-INF/services/io.embrace.android.embracesdk.internal.arch.InstrumentationProvider
@@ -1 +1,2 @@
 io.embrace.android.embracesdk.internal.instrumentation.powersave.PowerSaveInstrumentationProvider
+io.embrace.android.embracesdk.internal.instrumentation.powersave.PowerStateInstrumentationProvider
diff --git a/embrace-android-instrumentation-schema/src/main/kotlin/io/embrace/android/embracesdk/internal/arch/schema/SchemaType.kt b/embrace-android-instrumentation-schema/src/main/kotlin/io/embrace/android/embracesdk/internal/arch/schema/SchemaType.kt
@@ -307,6 +307,17 @@ sealed class SchemaType(
         }
     }
 
+    class PowerState(initialValue: PowerMode) :
+        State<PowerState.PowerMode>(initialValue, "power") {
+        enum class PowerMode(private val value: String) {
+            NORMAL("normal"),
+            LOW("low"),
+            UNKNOWN("unknown");
+
+            override fun toString(): String = value
+        }
+    }
+
     /**
      * A custom telemetry type. This allows the hybrid SDKs (and others) to pass in custom
      * telemetry schemas if required.
diff --git a/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/SessionApiTest.kt b/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/SessionApiTest.kt
@@ -4,8 +4,8 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.assertions.toMap
 import io.embrace.android.embracesdk.fakes.config.FakeEnabledFeatureConfig
 import io.embrace.android.embracesdk.fakes.config.FakeInstrumentedConfig
-import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.arch.attrs.embFreeDiskBytes
+import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.otel.sdk.findAttributeValue
 import io.embrace.android.embracesdk.testframework.SdkIntegrationTestRule
 import io.embrace.opentelemetry.kotlin.semconv.IncubatingApi
diff --git a/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/features/LowPowerFeatureTest.kt b/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/features/LowPowerFeatureTest.kt
@@ -8,13 +8,21 @@ import android.os.PowerManager
 import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.embrace.android.embracesdk.assertions.assertMatches
+import io.embrace.android.embracesdk.assertions.assertStateTransition
 import io.embrace.android.embracesdk.assertions.findSpanOfType
 import io.embrace.android.embracesdk.fakes.config.FakeEnabledFeatureConfig
 import io.embrace.android.embracesdk.fakes.config.FakeInstrumentedConfig
 import io.embrace.android.embracesdk.internal.arch.schema.EmbType
+import io.embrace.android.embracesdk.internal.arch.schema.SchemaType
 import io.embrace.android.embracesdk.internal.clock.nanosToMillis
+import io.embrace.android.embracesdk.internal.instrumentation.powersave.PowerStateDataSource
+import io.embrace.android.embracesdk.internal.session.getSessionSpan
+import io.embrace.android.embracesdk.internal.session.getStateSpan
 import io.embrace.android.embracesdk.testframework.SdkIntegrationTestRule
+import io.embrace.android.embracesdk.testframework.actions.EmbraceActionInterface.Companion.LIFECYCLE_EVENT_GAP
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNull
+import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -74,6 +82,81 @@ internal class LowPowerFeatureTest {
         )
     }
 
+    @Test
+    fun `power state feature`() {
+        val transitions: MutableList<Pair<Long, SchemaType.PowerState.PowerMode>> = mutableListOf()
+        testRule.runTest(
+            instrumentedConfig = FakeInstrumentedConfig(
+                enabledFeatures = FakeEnabledFeatureConfig(
+                    stateCaptureEnabled = true,
+                    bgActivityCapture = false,
+                    powerSaveCapture = true
+                )
+            ),
+            testCaseAction = {
+                recordSession {
+                    setPowerSaveMode(true)
+                    transitions.add(Pair(clock.now(), SchemaType.PowerState.PowerMode.LOW))
+                    clock.tick(10000L)
+                    setPowerSaveMode(false)
+                    transitions.add(Pair(clock.now(), SchemaType.PowerState.PowerMode.NORMAL))
+                }
+            },
+            assertAction = {
+                val message = getSingleSessionEnvelope()
+                val sessionSpan = checkNotNull(message.getSessionSpan())
+                with(checkNotNull(message.getStateSpan("emb-state-power"))) {
+                    assertEquals(
+                        checkNotNull(sessionSpan.startTimeNanos).nanosToMillis() + LIFECYCLE_EVENT_GAP,
+                        checkNotNull(startTimeNanos).nanosToMillis()
+                    )
+                    assertEquals(sessionSpan.endTimeNanos, endTimeNanos)
+                    with(checkNotNull(events)) {
+                        assertEquals(2, size)
+                        repeat(size) { i ->
+                            this[i].assertStateTransition(
+                                timestampMs = transitions[i].first,
+                                newStateValue = transitions[i].second,
+                                notInSession = if (i == 0) {
+                                    1
+                                } else {
+                                    0
+                                }
+                            )
+                        }
+                    }
+                }
+            }
+        )
+    }
+
+    @Test
+    fun `power state disabled by feature flag`() {
+        var throwable: Throwable? = null
+        testRule.runTest(
+            instrumentedConfig = FakeInstrumentedConfig(
+                enabledFeatures = FakeEnabledFeatureConfig(
+                    stateCaptureEnabled = true,
+                    powerSaveCapture = false
+                )
+            ),
+            testCaseAction = {
+                try {
+                    findDataSource<PowerStateDataSource>()
+                } catch (e: IllegalStateException) {
+                    throwable = e
+                }
+                recordSession {
+                    setPowerSaveMode(true)
+                }
+            },
+            assertAction = {
+                assertNull(getSingleSessionEnvelope().getStateSpan("emb-state-power"))
+                assertTrue(throwable is IllegalStateException)
+            }
+        )
+    }
+
     private fun setPowerSaveMode(powerSaveModeEnabled: Boolean) {
         shadowPowerManager.setIsPowerSaveMode(powerSaveModeEnabled)
         application.sendBroadcast(Intent(PowerManager.ACTION_POWER_SAVE_MODE_CHANGED))
diff --git a/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/session/BackgroundActivityDisabledTest.kt b/embrace-android-sdk/src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/session/BackgroundActivityDisabledTest.kt
@@ -16,10 +16,10 @@ import io.embrace.android.embracesdk.internal.arch.attrs.embSessionStartType
 import io.embrace.android.embracesdk.internal.arch.attrs.embState
 import io.embrace.android.embracesdk.internal.arch.attrs.embTerminated
 import io.embrace.android.embracesdk.internal.arch.schema.EmbType
+import io.embrace.android.embracesdk.internal.arch.state.AppState
 import io.embrace.android.embracesdk.internal.clock.nanosToMillis
 import io.embrace.android.embracesdk.internal.otel.sdk.findAttributeValue
 import io.embrace.android.embracesdk.internal.payload.Span
-import io.embrace.android.embracesdk.internal.arch.state.AppState
 import io.embrace.android.embracesdk.spans.EmbraceSpan
 import io.embrace.android.embracesdk.testframework.SdkIntegrationTestRule
 import io.embrace.opentelemetry.kotlin.semconv.IncubatingApi

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`io.embrace.android.embracesdk.internal.instrumentation.powersave.PowerSaveInstrumentationProvider`
	`2`	`+io.embrace.android.embracesdk.internal.instrumentation.powersave.PowerStateInstrumentationProvider`