feat(focus-mvp-android-device) Grant overlay permission (#4020)

* feat(focus-mvp-android-device) Grant overlay permission

* Update AppiumAdbWrapper so that grantOverlayPermission takes the service package name as a parameter.

This allows us to specify the package name in one place only.

Author: RobGallo

src/electron/platform/android/adb-wrapper.ts

@@ -30,6 +30,7 @@ export interface AdbWrapper {
     setTcpForwarding(deviceId: string, localPort: number, devicePort: number): Promise<number>;
     removeTcpForwarding(deviceId: string, devicePort: number): Promise<void>;
     sendKeyEvent(deviceId: string, keyEventCode: KeyEventCode): Promise<void>;
+    grantOverlayPermission: (deviceId: string, packageName: string) => Promise<void>;
 }
 
 export interface AdbWrapperFactory {

src/electron/platform/android/appium-adb-wrapper.ts

@@ -88,4 +88,18 @@ export class AppiumAdbWrapper implements AdbWrapper {
         this.adb.setDeviceId(deviceId);
         await this.adb.shell(['input', 'keyevent', keyEventCode]);
     };
+
+    public grantOverlayPermission = async (
+        deviceId: string,
+        packageName: string,
+    ): Promise<void> => {
+        this.adb.setDeviceId(deviceId);
+        await this.adb.shell(['cmd', 'appops', 'reset', packageName]);
+        await this.adb.shell([
+            'pm',
+            'grant',
+            packageName,
+            'android.permission.SYSTEM_ALERT_WINDOW',
+        ]);
+    };
 }

src/electron/platform/android/setup/android-service-configurator.ts

@@ -15,6 +15,7 @@ export interface ServiceConfigurator {
     hasRequiredServiceVersion(): Promise<boolean>;
     installRequiredServiceVersion(): Promise<void>;
     hasRequiredPermissions(): Promise<boolean>;
+    grantOverlayPermission(): Promise<void>;
     setupTcpForwarding(): Promise<number>;
     removeTcpForwarding(hostPort: number): Promise<void>;
 }
@@ -83,6 +84,13 @@ export class AndroidServiceConfigurator implements ServiceConfigurator {
         return screenshotGranted;
     };
 
+    public grantOverlayPermission = async (): Promise<void> => {
+        return await this.adbWrapper.grantOverlayPermission(
+            this.selectedDeviceId,
+            this.servicePackageName,
+        );
+    };
+
     public setupTcpForwarding = async (): Promise<number> => {
         const hostPort = await this.portFinder({
             port: servicePortNumber,

src/electron/platform/android/setup/android-setup-deps.ts

@@ -12,6 +12,7 @@ export type AndroidSetupDeps = {
     hasExpectedServiceVersion: () => Promise<boolean>;
     installService: () => Promise<boolean>;
     hasExpectedPermissions: () => Promise<boolean>;
+    grantOverlayPermission: () => Promise<void>;
     setupTcpForwarding: () => Promise<number>;
     removeTcpForwarding: (hostPort: number) => Promise<void>;
     fetchDeviceConfig: (port: number) => Promise<DeviceConfig>;

src/electron/platform/android/setup/android-setup-step-id.ts

@@ -13,6 +13,7 @@ export type AndroidSetupStepId =
     | 'prompt-install-failed'
     | 'detect-permissions'
     | 'prompt-grant-permissions'
+    | 'grant-overlay-permission'
     | 'configuring-port-forwarding'
     | 'prompt-configuring-port-forwarding-failed'
     | 'prompt-connected-start-testing';

src/electron/platform/android/setup/android-setup-steps-configs.ts

@@ -9,6 +9,7 @@ import { configuringPortForwarding } from 'electron/platform/android/setup/steps
 import { detectDevices } from 'electron/platform/android/setup/steps/detect-devices';
 import { detectPermissions } from 'electron/platform/android/setup/steps/detect-permissions';
 import { detectService } from 'electron/platform/android/setup/steps/detect-service';
+import { grantOverlayPermission } from 'electron/platform/android/setup/steps/grant-overlay-permission';
 import { installingService } from 'electron/platform/android/setup/steps/installing-service';
 import { promptChooseDevice } from 'electron/platform/android/setup/steps/prompt-choose-device';
 import { promptConfiguringPortForwardingFailed } from 'electron/platform/android/setup/steps/prompt-configuring-port-forwarding-failed';
@@ -51,6 +52,7 @@ export const allAndroidSetupStepConfigs: AndroidSetupStepConfigs = {
     'prompt-install-failed': promptInstallService,
     'detect-permissions': detectPermissions,
     'prompt-grant-permissions': promptGrantPermissions,
+    'grant-overlay-permission': grantOverlayPermission,
     'configuring-port-forwarding': configuringPortForwarding,
     'prompt-configuring-port-forwarding-failed': promptConfiguringPortForwardingFailed,
     'prompt-connected-start-testing': promptConnectedStartTesting,

src/electron/platform/android/setup/live-android-setup-deps.ts

@@ -79,6 +79,14 @@ export class LiveAndroidSetupDeps implements AndroidSetupDeps {
         return false;
     };
 
+    public grantOverlayPermission = async (): Promise<void> => {
+        try {
+            return await this.serviceConfig.grantOverlayPermission();
+        } catch (error) {
+            this.logger.log(error);
+        }
+    };
+
     public setupTcpForwarding = async (): Promise<number> => {
         return await this.serviceConfig.setupTcpForwarding();
     };

src/electron/platform/android/setup/port-cleaning-service-configurator.ts

@@ -31,6 +31,10 @@ export class PortCleaningServiceConfigurator implements ServiceConfigurator {
         return this.innerObject.hasRequiredPermissions();
     };
 
+    public grantOverlayPermission = (): Promise<void> => {
+        return this.innerObject.grantOverlayPermission();
+    };
+
     public setupTcpForwarding = async (): Promise<number> => {
         const assignedPort = await this.innerObject.setupTcpForwarding();
         this.portCleaner.addPort(assignedPort);

src/electron/platform/android/setup/steps/detect-permissions.ts

@@ -7,6 +7,6 @@ export const detectPermissions: AndroidSetupStepConfig = (stepTransition, deps)
     actions: {},
     onEnter: async () => {
         const detected = await deps.hasExpectedPermissions();
-        stepTransition(detected ? 'configuring-port-forwarding' : 'prompt-grant-permissions');
+        stepTransition(detected ? 'grant-overlay-permission' : 'prompt-grant-permissions');
     },
 });

src/electron/platform/android/setup/steps/grant-overlay-permission.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { AndroidSetupStepConfig } from 'electron/platform/android/setup/android-setup-steps-configs';
+
+export const grantOverlayPermission: AndroidSetupStepConfig = (stepTransition, deps) => ({
+    actions: {},
+    onEnter: async () => {
+        await deps.grantOverlayPermission();
+        stepTransition('configuring-port-forwarding');
+    },
+});