Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Android] Avoid possible crash using essentials Battery #18386

Merged
merged 7 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 21 additions & 10 deletions src/Essentials/src/Battery/Battery.android.cs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# nullable enable
jsuarezruiz marked this conversation as resolved.
Show resolved Hide resolved

using System;
using Android.App;
using Android.Content;
Expand All @@ -8,13 +10,13 @@ namespace Microsoft.Maui.Devices
{
partial class BatteryImplementation : IBattery
{
static PowerManager powerManager;
static PowerManager? powerManager;

static PowerManager PowerManager =>
static PowerManager? PowerManager =>
powerManager ??= Application.Context.GetSystemService(Context.PowerService) as PowerManager;

BatteryBroadcastReceiver batteryReceiver;
EnergySaverBroadcastReceiver powerReceiver;
BatteryBroadcastReceiver? batteryReceiver;
EnergySaverBroadcastReceiver? powerReceiver;

void StartEnergySaverListeners()
{
Expand All @@ -32,7 +34,7 @@ void StopEnergySaverListeners()
{
System.Diagnostics.Debug.WriteLine("Energy saver receiver already unregistered. Disposing of it.");
}
powerReceiver.Dispose();
powerReceiver?.Dispose();
powerReceiver = null;
}

Expand Down Expand Up @@ -63,7 +65,7 @@ void StopBatteryListeners()
{
System.Diagnostics.Debug.WriteLine("Battery receiver already unregistered. Disposing of it.");
}
batteryReceiver.Dispose();
batteryReceiver?.Dispose();
jsuarezruiz marked this conversation as resolved.
Show resolved Hide resolved
batteryReceiver = null;
}

Expand All @@ -76,6 +78,9 @@ public double ChargeLevel
using (var filter = new IntentFilter(Intent.ActionBatteryChanged))
using (var battery = Application.Context.RegisterReceiver(null, filter))
{
if(battery is null)
return -1; // Unknown

var level = battery.GetIntExtra(BatteryManager.ExtraLevel, -1);
var scale = battery.GetIntExtra(BatteryManager.ExtraScale, -1);

Expand All @@ -96,6 +101,9 @@ public BatteryState State
using (var filter = new IntentFilter(Intent.ActionBatteryChanged))
using (var battery = Application.Context.RegisterReceiver(null, filter))
{
if (battery is null)
return BatteryState.Unknown;

var status = battery.GetIntExtra(BatteryManager.ExtraStatus, -1);
switch (status)
{
Expand Down Expand Up @@ -123,6 +131,9 @@ public BatteryPowerSource PowerSource
using (var filter = new IntentFilter(Intent.ActionBatteryChanged))
using (var battery = Application.Context.RegisterReceiver(null, filter))
{
if (battery is null)
return BatteryPowerSource.Unknown;

var chargePlug = battery.GetIntExtra(BatteryManager.ExtraPlugged, -1);

if (chargePlug == (int)BatteryPlugged.Usb)
Expand All @@ -143,7 +154,7 @@ public BatteryPowerSource PowerSource
[BroadcastReceiver(Enabled = true, Exported = false, Label = "Essentials Battery Broadcast Receiver")]
class BatteryBroadcastReceiver : BroadcastReceiver
{
Action onChanged;
readonly Action? onChanged;

public BatteryBroadcastReceiver()
{
Expand All @@ -152,14 +163,14 @@ public BatteryBroadcastReceiver()
public BatteryBroadcastReceiver(Action onChanged) =>
this.onChanged = onChanged;

public override void OnReceive(Context context, Intent intent) =>
public override void OnReceive(Context? context, Intent? intent) =>
onChanged?.Invoke();
}

[BroadcastReceiver(Enabled = true, Exported = false, Label = "Essentials Energy Saver Broadcast Receiver")]
class EnergySaverBroadcastReceiver : BroadcastReceiver
{
Action onChanged;
readonly Action? onChanged;

public EnergySaverBroadcastReceiver()
{
Expand All @@ -168,7 +179,7 @@ public EnergySaverBroadcastReceiver()
public EnergySaverBroadcastReceiver(Action onChanged) =>
this.onChanged = onChanged;

public override void OnReceive(Context context, Intent intent) =>
public override void OnReceive(Context? context, Intent? intent) =>
onChanged?.Invoke();
}
}
10 changes: 10 additions & 0 deletions src/Essentials/test/DeviceTests/Tests/Battery_Tests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,15 @@ public void App_Is_Not_Lower_Power_mode()
{
Assert.Equal(EnergySaverStatus.Off, Battery.EnergySaverStatus);
}

[Fact]
public void No_Unsubscribe_Crash()
{
// TODO: the test runner app (UI version) should do this, until then...
if (!HardwareSupport.HasBattery)
return;

Battery.BatteryInfoChanged -= (sender, args) => { };
}
}
}