Merge pull request #3052 from leancodepl/feature/battery-optimization-allowance

Feature/battery optimization allowance on android

Author: dworik

dev/e2e_app/android/app/src/main/AndroidManifest.xml

@@ -15,6 +15,9 @@
     <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES" tools:ignore="QueryAllPackagesPermission"/>
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
     <uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
+    <uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS"/>
+
+
 
     <application
         android:label="example"

dev/e2e_app/lib/keys.dart

@@ -43,6 +43,7 @@ class Keys {
   static const microphonePermissionTile = Key('microphone');
   static const locationPermissionTile = Key('location');
   static const galleryPermissionTile = Key('gallery');
+  static const batteryPermissionTile = Key('battery');
   static const permissionsScreen = Key('permissionsScreen');
   static const requestCameraPermissionButton = Key(
     'requestCameraPermissionButton',
@@ -56,6 +57,9 @@ class Keys {
   static const requestGalleryPermissionButton = Key(
     'requestGalleryPermissionButton',
   );
+  static const requestBatteryPermissionButton = Key(
+    'requestBatteryPermissionButton',
+  );
 
   // location screen
   static const grantLocationPermissionButton = Key(

dev/e2e_app/lib/permissions_screen.dart

@@ -16,6 +16,7 @@ class _PermissionsScreenState extends State<PermissionsScreen> {
   var _microphonePermissionGranted = false;
   var _locationPermissionGranted = false;
   var _galleryPermissionGranted = false;
+  var _batteryPermissionGranted = false;
 
   Future<void> _requestCameraPermission() async {
     await Future<void>.delayed(Duration(seconds: 1));
@@ -49,6 +50,13 @@ class _PermissionsScreenState extends State<PermissionsScreen> {
     });
   }
 
+  Future<void> _requestBatteryPermission() async {
+    final status = await Permission.ignoreBatteryOptimizations.request();
+    setState(() {
+      _batteryPermissionGranted = status == PermissionStatus.granted;
+    });
+  }
+
   @override
   void initState() {
     super.initState();
@@ -83,6 +91,14 @@ class _PermissionsScreenState extends State<PermissionsScreen> {
         });
       }),
     );
+
+    unawaited(
+      Permission.ignoreBatteryOptimizations.status.then((value) {
+        setState(() {
+          _batteryPermissionGranted = value == PermissionStatus.granted;
+        });
+      }),
+    );
   }
 
   @override
@@ -121,6 +137,13 @@ class _PermissionsScreenState extends State<PermissionsScreen> {
               onTap: _requestGalleryPermission,
               key: K.galleryPermissionTile,
             ),
+            _PermissionTile(
+              name: 'Battery Optimizations',
+              icon: Icons.battery_0_bar,
+              granted: _batteryPermissionGranted,
+              onTap: _requestBatteryPermission,
+              key: K.batteryPermissionTile,
+            ),
           ],
         ),
       ),
@@ -148,6 +171,7 @@ class _PermissionTile extends StatelessWidget {
         'microphone' => K.requestMicrophonePermissionButton,
         'location' => K.requestLocationPermissionButton,
         'gallery' => K.requestGalleryPermissionButton,
+        'battery optimizations' => K.requestBatteryPermissionButton,
         _ => Key('request${permissionName}PermissionButton'),
       };
 

dev/e2e_app/patrol_test/permissions/permissions_many_test.dart

@@ -19,6 +19,7 @@ void main() {
       await _requestAndGrantMicrophonePermission($);
       await _requestAndDenyLocationPermission($);
       await _requestAndDenyGalleryPermission($);
+      await _requestAndGrantBatteryPermission($);
     },
     tags: [
       'locale_testing_ios',
@@ -92,3 +93,18 @@ Future<void> _requestAndDenyGalleryPermission(PatrolIntegrationTester $) async {
   }
   expect($(K.galleryPermissionTile).$(#statusText).text, 'Not granted');
 }
+
+Future<void> _requestAndGrantBatteryPermission(
+  PatrolIntegrationTester $,
+) async {
+  if (Platform.isAndroid) {
+    if (!await Permission.ignoreBatteryOptimizations.isGranted) {
+      expect($(K.batteryPermissionTile).$(#statusText).text, 'Not granted');
+      await $(K.requestBatteryPermissionButton).tap();
+      await $.platform.android.allowPermission();
+      await $.pump();
+    }
+
+    expect($(K.batteryPermissionTile).$(#statusText).text, 'Granted');
+  }
+}

packages/patrol/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.6.0
+
+- Add `allowPermission` method to `AndroidAutomator`.
+
 ## 4.5.0
 
 - Fix `appId` not being passed down on `$.platform.mobile.enterText` and `$.platform.mobile.enterTextByIndex` (#2992)

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/Automator.kt

@@ -669,7 +669,8 @@ class Automator private constructor() {
         val identifiers = arrayOf(
             "com.android.packageinstaller:id/permission_deny_button", // API <= 28
             "com.android.permissioncontroller:id/permission_deny_button", // API >= 29 (first invocation)
-            "com.android.permissioncontroller:id/permission_deny_and_dont_ask_again_button" // API >= 29 (second invocation)
+            "com.android.permissioncontroller:id/permission_deny_and_dont_ask_again_button", // API >= 29 (second invocation)
+            "android:id/button2" // for battery permission
         )
 
         val uiObject = waitForUiObjectByResourceId(*identifiers, timeout = timeoutMillis)
@@ -678,6 +679,13 @@ class Automator private constructor() {
         uiObject.click()
     }
 
+    fun allowPermission() {
+        val resourceId = "android:id/button1"
+        val uiObject = waitForUiObjectByResourceId(resourceId, timeout = timeoutMillis)
+            ?: throw UiObjectNotFoundException("button to allow permission")
+        uiObject.click()
+    }
+
     fun selectFineLocation() {
         if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
             Logger.i("Ignoring selectFineLocation() since it's not available on ${Build.VERSION.SDK_INT}")

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/AutomatorServer.kt

@@ -247,6 +247,10 @@ class AutomatorServer(private val automation: Automator) : MobileAutomatorServer
         }
     }
 
+    override fun allowPermission() {
+        automation.allowPermission()
+    }
+
     override fun setLocationAccuracy(request: SetLocationAccuracyRequest) {
         when (request.locationAccuracy) {
             SetLocationAccuracyRequestLocationAccuracy.coarse -> automation.selectCoarseLocation()

packages/patrol/android/src/main/kotlin/pl/leancode/patrol/contracts/AndroidAutomatorServer.kt

@@ -233,6 +233,12 @@ abstract interface class AndroidAutomator implements MobileAutomator {
   /// [AndroidAutomatorConfig.findTimeout].
   Future<void> waitUntilVisible(AndroidSelector selector, {Duration? timeout});
 
+  /// Taps the standard Android system dialog "Allow" button.
+  ///
+  /// This is useful for Android dialogs that use the platform alert button with
+  /// `android:id/button1`, for example battery optimization permission dialogs.
+  Future<void> allowPermission();
+
   /// Returns a list of currently visible native UI controls, specified by
   /// [selector], which are currently visible on screen.
   ///

packages/patrol/lib/src/platform/android/android_automator.dart

@@ -489,6 +489,12 @@ class AndroidAutomator extends NativeMobileAutomator
     );
   }
 
+  /// Taps the standard Android system dialog "Allow" button.
+  @override
+  Future<void> allowPermission() async {
+    await wrapRequest('allowPermission', _client.allowPermission);
+  }
+
   /// Returns a list of currently visible native UI controls, specified by
   /// [selector], which are currently visible on screen.
   ///