appium-android-driver 7.4.1 → 7.5.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [7.5.1](https://github.com/appium/appium-android-driver/compare/v7.5.0...v7.5.1) (2024-01-05)
+
+
+### Bug Fixes
+
+* Use built-in logger for doctor checks ([#893](https://github.com/appium/appium-android-driver/issues/893)) ([5fb33ad](https://github.com/appium/appium-android-driver/commit/5fb33adc600339fb7fa7e951c7069a8518128cd3))
+
+## [7.5.0](https://github.com/appium/appium-android-driver/compare/v7.4.1...v7.5.0) (2024-01-05)
+
+
+### Features
+
+* Add common android doctor checks ([#892](https://github.com/appium/appium-android-driver/issues/892)) ([4d1d648](https://github.com/appium/appium-android-driver/commit/4d1d6480f610bfe7680c325caef36fbd0edc8b20))
+
 ## [7.4.1](https://github.com/appium/appium-android-driver/compare/v7.4.0...v7.4.1) (2023-12-18)
 
 

package/build/lib/doctor/checks.d.ts

@@ -0,0 +1,83 @@
+export const androidHomeCheck: EnvVarAndPathCheck;
+export const javaHomeCheck: EnvVarAndPathCheck;
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class JavaHomeValueCheck {
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export const javaHomeValueCheck: JavaHomeValueCheck;
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class AndroidSdkCheck {
+    /** @type {import('@appium/types').AppiumLogger} */
+    log: import('@appium/types').AppiumLogger;
+    TOOL_NAMES: string[];
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export const androidSdkCheck: AndroidSdkCheck;
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalBundletoolCheck {
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export const optionalBundletoolCheck: OptionalBundletoolCheck;
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalGstreamerCheck {
+    GSTREAMER_BINARY: string;
+    GST_INSPECT_BINARY: string;
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export const optionalGstreamerCheck: OptionalGstreamerCheck;
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalFfmpegCheck {
+    FFMPEG_BINARY: string;
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export const optionalFfmpegCheck: OptionalFfmpegCheck;
+export type EnvVarCheckOptions = {
+    /**
+     * If set to true then
+     * the path is expected to be a valid folder
+     */
+    expectDir?: boolean | undefined;
+    /**
+     * If set to true then
+     * the path is expected to be a valid file
+     */
+    expectFile?: boolean | undefined;
+};
+/**
+ * @typedef EnvVarCheckOptions
+ * @property {boolean} [expectDir] If set to true then
+ * the path is expected to be a valid folder
+ * @property {boolean} [expectFile] If set to true then
+ * the path is expected to be a valid file
+ */
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+declare class EnvVarAndPathCheck {
+    /**
+     * @param {string} varName
+     * @param {EnvVarCheckOptions} [opts={}]
+     */
+    constructor(varName: string, opts?: EnvVarCheckOptions | undefined);
+    varName: string;
+    opts: EnvVarCheckOptions;
+    diagnose(): Promise<import("@appium/types").DoctorCheckResult>;
+    fix(): Promise<string>;
+    hasAutofix(): boolean;
+    isOptional(): boolean;
+}
+export {};
+//# sourceMappingURL=checks.d.ts.map

package/build/lib/doctor/checks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.d.ts","sourceRoot":"","sources":["../../../lib/doctor/checks.js"],"names":[],"mappings":"AA2EA,kDAA0F;AAC1F,+CAAoF;AAEpF,wDAAwD;AACxD;IACE,+DAeC;IAED,uBAGC;IAED,sBAEC;IAED,sBAEC;CACF;AACD,oDAA2D;AAE3D,wDAAwD;AACxD;IACE,mDAAmD;IACnD,KADW,OAAO,eAAe,EAAE,YAAY,CAC3C;IAEJ,qBAAmF;IAEnF,+DAwBC;IAED,uBAKC;IAED,sBAEC;IAED,sBAEC;CACF;AACD,8CAAqD;AAErD,wDAAwD;AACxD;IACE,+DAKC;IAED,uBAOC;IAED,sBAEC;IAED,sBAEC;CACF;AACD,8DAAqE;AAErE,wDAAwD;AACxD;IACE,yBAAuE;IACvE,2BAA0E;IAE1E,+DASC;IAED,uBAOC;IAED,sBAEC;IAED,sBAEC;CACF;AACD,4DAAmE;AAEnE,wDAAwD;AACxD;IACE,sBAA4D;IAE5D,+DAMC;IAED,uBAKC;IAED,sBAEC;IAED,sBAEC;CACF;AACD,sDAA6D;;;;;;;;;;;;;AA5O7D;;;;;;GAMG;AAEH,wDAAwD;AACxD;IACE;;;OAGG;IACH,qBAHW,MAAM,yCAMhB;IAFC,gBAAsB;IACtB,yBAAgB;IAGlB,+DAuBC;IAED,uBAKC;IAED,sBAEC;IAED,sBAEC;CACF"}

package/build/lib/doctor/checks.js

@@ -0,0 +1,211 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.optionalFfmpegCheck = exports.OptionalFfmpegCheck = exports.optionalGstreamerCheck = exports.OptionalGstreamerCheck = exports.optionalBundletoolCheck = exports.OptionalBundletoolCheck = exports.androidSdkCheck = exports.AndroidSdkCheck = exports.javaHomeValueCheck = exports.JavaHomeValueCheck = exports.javaHomeCheck = exports.androidHomeCheck = void 0;
+const utils_1 = require("./utils");
+const support_1 = require("@appium/support");
+const path_1 = __importDefault(require("path"));
+require("@colors/colors");
+const appium_adb_1 = require("appium-adb");
+const JAVA_HOME_VAR_NAME = support_1.system.isWindows() ? '%JAVA_HOME%' : '$JAVA_HOME';
+const ENVIRONMENT_VARS_TUTORIAL_URL = 'https://github.com/appium/java-client/blob/master/docs/environment.md';
+const JAVA_HOME_TUTORIAL = 'https://docs.oracle.com/cd/E21454_01/html/821-2531/inst_jdk_javahome_t.html';
+const ANDROID_SDK_LINK1 = 'https://developer.android.com/studio#cmdline-tools';
+const ANDROID_SDK_LINK2 = 'https://developer.android.com/studio/intro/update#sdk-manager';
+const BUNDLETOOL_RELEASES_LINK = 'https://github.com/google/bundletool/releases/';
+const GSTREAMER_INSTALL_LINK = 'https://gstreamer.freedesktop.org/documentation/installing/index.html?gi-language=c';
+const FFMPEG_INSTALL_LINK = 'https://www.ffmpeg.org/download.html';
+/**
+ * @typedef EnvVarCheckOptions
+ * @property {boolean} [expectDir] If set to true then
+ * the path is expected to be a valid folder
+ * @property {boolean} [expectFile] If set to true then
+ * the path is expected to be a valid file
+ */
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class EnvVarAndPathCheck {
+    /**
+     * @param {string} varName
+     * @param {EnvVarCheckOptions} [opts={}]
+     */
+    constructor(varName, opts = {}) {
+        this.varName = varName;
+        this.opts = opts;
+    }
+    async diagnose() {
+        const varValue = process.env[this.varName];
+        if (!varValue) {
+            return support_1.doctor.nok(`${this.varName} environment variable is NOT set!`);
+        }
+        if (!await support_1.fs.exists(varValue)) {
+            let errMsg = `${this.varName} is set to '${varValue}' but this path does not exist!`;
+            if (support_1.system.isWindows() && varValue.includes('%')) {
+                errMsg += ` Consider replacing all references to other environment variables with absolute paths.`;
+            }
+            return support_1.doctor.nok(errMsg);
+        }
+        const stat = await support_1.fs.stat(varValue);
+        if (this.opts.expectDir && !stat.isDirectory()) {
+            return support_1.doctor.nok(`${this.varName} is expected to be a valid folder, got a file path instead`);
+        }
+        if (this.opts.expectFile && stat.isDirectory()) {
+            return support_1.doctor.nok(`${this.varName} is expected to be a valid file, got a folder path instead`);
+        }
+        return support_1.doctor.ok(`${this.varName} is set to: ${varValue}`);
+    }
+    async fix() {
+        return (`Make sure the environment variable ${this.varName.bold} is properly configured for the Appium process. ` +
+            `Refer ${ENVIRONMENT_VARS_TUTORIAL_URL} for more details.`);
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return false;
+    }
+}
+exports.androidHomeCheck = new EnvVarAndPathCheck('ANDROID_HOME', { expectDir: true });
+exports.javaHomeCheck = new EnvVarAndPathCheck('JAVA_HOME', { expectDir: true });
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class JavaHomeValueCheck {
+    async diagnose() {
+        const envVar = process.env.JAVA_HOME;
+        if (!envVar) {
+            return support_1.doctor.nok(`${JAVA_HOME_VAR_NAME} environment variable must be set`);
+        }
+        const javaBinaryRelativePath = path_1.default.join('bin', `java${support_1.system.isWindows() ? '.exe' : ''}`);
+        const javaBinary = path_1.default.join(envVar, javaBinaryRelativePath);
+        if (!await support_1.fs.exists(javaBinary)) {
+            return support_1.doctor.nok(`${JAVA_HOME_VAR_NAME} is set to an invalid value. ` +
+                `It must be pointing to a folder containing ${javaBinaryRelativePath}`);
+        }
+        return support_1.doctor.ok(`'${javaBinaryRelativePath}' exists under '${envVar}'`);
+    }
+    async fix() {
+        return `Set ${JAVA_HOME_VAR_NAME} environment variable to the root folder path of your local JDK installation. ` +
+            `Read ${JAVA_HOME_TUTORIAL}`;
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return false;
+    }
+}
+exports.JavaHomeValueCheck = JavaHomeValueCheck;
+exports.javaHomeValueCheck = new JavaHomeValueCheck();
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class AndroidSdkCheck {
+    constructor() {
+        this.TOOL_NAMES = ['adb', 'emulator', `apkanalyzer${support_1.system.isWindows() ? '.bat' : ''}`];
+    }
+    async diagnose() {
+        const listOfTools = this.TOOL_NAMES.join(', ');
+        const sdkRoot = (0, appium_adb_1.getSdkRootFromEnv)();
+        if (!sdkRoot) {
+            return support_1.doctor.nok(`${listOfTools} could not be found because ANDROID_HOME is NOT set!`);
+        }
+        this.log.info(`   Checking ${listOfTools}`);
+        const missingBinaries = [];
+        for (const binary of this.TOOL_NAMES) {
+            try {
+                this.log.info(`     '${binary}' exists in ${await (0, appium_adb_1.getAndroidBinaryPath)(binary)}`);
+            }
+            catch (e) {
+                missingBinaries.push(binary);
+            }
+        }
+        if (missingBinaries.length > 0) {
+            return support_1.doctor.nok(`${missingBinaries.join(', ')} could NOT be found in '${sdkRoot}'!`);
+        }
+        return support_1.doctor.ok(`${listOfTools} exist in '${sdkRoot}'`);
+    }
+    async fix() {
+        return (`Manually install ${'Android SDK'.bold} and set ${'ANDROID_HOME'.bold}. ` +
+            `Read ${[ANDROID_SDK_LINK1, ANDROID_SDK_LINK2].join(' and ')}.`);
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return false;
+    }
+}
+exports.AndroidSdkCheck = AndroidSdkCheck;
+exports.androidSdkCheck = new AndroidSdkCheck();
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class OptionalBundletoolCheck {
+    async diagnose() {
+        const bundletoolPath = await (0, utils_1.resolveExecutablePath)('bundletool.jar');
+        return bundletoolPath
+            ? support_1.doctor.okOptional(`bundletool.jar is installed at: ${bundletoolPath}`)
+            : support_1.doctor.nokOptional('bundletool.jar cannot be found');
+    }
+    async fix() {
+        return (`${'bundletool.jar'.bold} is used to handle Android App bundles. ` +
+            `Please download the binary from ${BUNDLETOOL_RELEASES_LINK} and store it ` +
+            `to any folder listed in the PATH environment variable. Folders that ` +
+            `are currently present in PATH: ${process.env.PATH}`);
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return true;
+    }
+}
+exports.OptionalBundletoolCheck = OptionalBundletoolCheck;
+exports.optionalBundletoolCheck = new OptionalBundletoolCheck();
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class OptionalGstreamerCheck {
+    constructor() {
+        this.GSTREAMER_BINARY = `gst-launch-1.0${support_1.system.isWindows() ? '.exe' : ''}`;
+        this.GST_INSPECT_BINARY = `gst-inspect-1.0${support_1.system.isWindows() ? '.exe' : ''}`;
+    }
+    async diagnose() {
+        const gstreamerPath = await (0, utils_1.resolveExecutablePath)(this.GSTREAMER_BINARY);
+        const gstInspectPath = await (0, utils_1.resolveExecutablePath)(this.GST_INSPECT_BINARY);
+        return gstreamerPath && gstInspectPath
+            ? support_1.doctor.okOptional(`${this.GSTREAMER_BINARY} and ${this.GST_INSPECT_BINARY} are installed at: ${gstreamerPath} and ${gstInspectPath}`)
+            : support_1.doctor.nokOptional(`${this.GSTREAMER_BINARY} and/or ${this.GST_INSPECT_BINARY} cannot be found`);
+    }
+    async fix() {
+        return (`${`${this.GSTREAMER_BINARY} and ${this.GST_INSPECT_BINARY}`.bold} are used to stream the screen of the device under test. ` +
+            `Please read ${GSTREAMER_INSTALL_LINK}.`);
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return true;
+    }
+}
+exports.OptionalGstreamerCheck = OptionalGstreamerCheck;
+exports.optionalGstreamerCheck = new OptionalGstreamerCheck();
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class OptionalFfmpegCheck {
+    constructor() {
+        this.FFMPEG_BINARY = `ffmpeg${support_1.system.isWindows() ? '.exe' : ''}`;
+    }
+    async diagnose() {
+        const ffmpegPath = await (0, utils_1.resolveExecutablePath)(this.FFMPEG_BINARY);
+        return ffmpegPath
+            ? support_1.doctor.okOptional(`${this.FFMPEG_BINARY} exists at '${ffmpegPath}'`)
+            : support_1.doctor.nokOptional(`${this.FFMPEG_BINARY} cannot be found`);
+    }
+    async fix() {
+        return (`${`${this.FFMPEG_BINARY}`.bold} is used to capture screen recordings from the device under test. ` +
+            `Please read ${FFMPEG_INSTALL_LINK}.`);
+    }
+    hasAutofix() {
+        return false;
+    }
+    isOptional() {
+        return true;
+    }
+}
+exports.OptionalFfmpegCheck = OptionalFfmpegCheck;
+exports.optionalFfmpegCheck = new OptionalFfmpegCheck();
+//# sourceMappingURL=checks.js.map

package/build/lib/doctor/checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../../lib/doctor/checks.js"],"names":[],"mappings":";;;;;;AAAA,mCAA8C;AAC9C,6CAAmD;AACnD,gDAAwB;AACxB,0BAAwB;AACxB,2CAAmE;AAGnE,MAAM,kBAAkB,GAAG,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC;AAC7E,MAAM,6BAA6B,GAAG,uEAAuE,CAAC;AAC9G,MAAM,kBAAkB,GAAG,6EAA6E,CAAC;AACzG,MAAM,iBAAiB,GAAG,oDAAoD,CAAC;AAC/E,MAAM,iBAAiB,GAAG,+DAA+D,CAAC;AAC1F,MAAM,wBAAwB,GAAG,gDAAgD,CAAC;AAClF,MAAM,sBAAsB,GAAG,qFAAqF,CAAC;AACrH,MAAM,mBAAmB,GAAG,sCAAsC,CAAC;AAEnE;;;;;;GAMG;AAEH,wDAAwD;AACxD,MAAM,kBAAkB;IACtB;;;OAGG;IACH,YAAY,OAAO,EAAE,IAAI,GAAG,EAAE;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,gBAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,mCAAmC,CAAC,CAAC;SACvE;QAED,IAAI,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAC9B,IAAI,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,eAAe,QAAQ,iCAAiC,CAAC;YACrF,IAAI,gBAAM,CAAC,SAAS,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAChD,MAAM,IAAI,wFAAwF,CAAC;aACpG;YACD,OAAO,gBAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SAC3B;QAED,MAAM,IAAI,GAAG,MAAM,YAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE;YAC9C,OAAO,gBAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,4DAA4D,CAAC,CAAC;SAChG;QACD,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YAC9C,OAAO,gBAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,4DAA4D,CAAC,CAAC;SAChG;QAED,OAAO,gBAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,eAAe,QAAQ,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,CACL,sCAAsC,IAAI,CAAC,OAAO,CAAC,IAAI,kDAAkD;YACzG,SAAS,6BAA6B,oBAAoB,CAC3D,CAAC;IACJ,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AACY,QAAA,gBAAgB,GAAG,IAAI,kBAAkB,CAAC,cAAc,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;AAC7E,QAAA,aAAa,GAAG,IAAI,kBAAkB,CAAC,WAAW,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;AAEpF,wDAAwD;AACxD,MAAa,kBAAkB;IAC7B,KAAK,CAAC,QAAQ;QACZ,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,gBAAM,CAAC,GAAG,CAAC,GAAG,kBAAkB,mCAAmC,CAAC,CAAC;SAC7E;QAED,MAAM,sBAAsB,GAAG,cAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3F,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;YAChC,OAAO,gBAAM,CAAC,GAAG,CACf,GAAG,kBAAkB,+BAA+B;gBACpD,8CAA8C,sBAAsB,EAAE,CACvE,CAAC;SACH;QACD,OAAO,gBAAM,CAAC,EAAE,CAAC,IAAI,sBAAsB,mBAAmB,MAAM,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,OAAO,kBAAkB,gFAAgF;YAC9G,QAAQ,kBAAkB,EAAE,CAAC;IACjC,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA9BD,gDA8BC;AACY,QAAA,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;AAE3D,wDAAwD;AACxD,MAAa,eAAe;IAA5B;QAIE,eAAU,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,cAAc,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IA0CrF,CAAC;IAxCC,KAAK,CAAC,QAAQ;QACZ,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAA,8BAAiB,GAAE,CAAC;QACpC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,gBAAM,CAAC,GAAG,CACf,GAAG,WAAW,sDAAsD,CACrE,CAAC;SACH;QAED,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,WAAW,EAAE,CAAC,CAAC;QAC5C,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE;YACpC,IAAI;gBACF,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,MAAM,eAAe,MAAM,IAAA,iCAAoB,EAAC,MAAM,CAAC,EAAE,CAAC,CAAC;aACnF;YAAC,OAAO,CAAC,EAAE;gBACV,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAC9B;SACF;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAC9B,OAAO,gBAAM,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,2BAA2B,OAAO,IAAI,CAAC,CAAC;SACxF;QAED,OAAO,gBAAM,CAAC,EAAE,CAAC,GAAG,WAAW,cAAc,OAAO,GAAG,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,CACL,oBAAoB,aAAa,CAAC,IAAI,YAAY,cAAc,CAAC,IAAI,IAAI;YACzE,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAChE,CAAC;IACJ,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA9CD,0CA8CC;AACY,QAAA,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAErD,wDAAwD;AACxD,MAAa,uBAAuB;IAClC,KAAK,CAAC,QAAQ;QACZ,MAAM,cAAc,GAAG,MAAM,IAAA,6BAAqB,EAAC,gBAAgB,CAAC,CAAC;QACrE,OAAO,cAAc;YACnB,CAAC,CAAC,gBAAM,CAAC,UAAU,CAAC,mCAAmC,cAAc,EAAE,CAAC;YACxE,CAAC,CAAC,gBAAM,CAAC,WAAW,CAAC,gCAAgC,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,CACL,GAAG,gBAAgB,CAAC,IAAI,0CAA0C;YAClE,mCAAmC,wBAAwB,gBAAgB;YAC3E,sEAAsE;YACtE,kCAAkC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CACrD,CAAC;IACJ,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxBD,0DAwBC;AACY,QAAA,uBAAuB,GAAG,IAAI,uBAAuB,EAAE,CAAC;AAErE,wDAAwD;AACxD,MAAa,sBAAsB;IAAnC;QACE,qBAAgB,GAAG,iBAAiB,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACvE,uBAAkB,GAAG,kBAAkB,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IA6B5E,CAAC;IA3BC,KAAK,CAAC,QAAQ;QACZ,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAqB,EAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,MAAM,IAAA,6BAAqB,EAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAE5E,OAAO,aAAa,IAAI,cAAc;YACpC,CAAC,CAAC,gBAAM,CAAC,UAAU,CACf,GAAG,IAAI,CAAC,gBAAgB,QAAQ,IAAI,CAAC,kBAAkB,sBAAsB,aAAa,QAAQ,cAAc,EAAE,CACnH;YACH,CAAC,CAAC,gBAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,gBAAgB,WAAW,IAAI,CAAC,kBAAkB,kBAAkB,CAAC,CAAC;IACvG,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,CACL,GACE,GAAG,IAAI,CAAC,gBAAgB,QAAQ,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAC5D,2DAA2D;YAC3D,eAAe,sBAAsB,GAAG,CACzC,CAAC;IACJ,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/BD,wDA+BC;AACY,QAAA,sBAAsB,GAAG,IAAI,sBAAsB,EAAE,CAAC;AAEnE,wDAAwD;AACxD,MAAa,mBAAmB;IAAhC;QACE,kBAAa,GAAG,SAAS,gBAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAwB9D,CAAC;IAtBC,KAAK,CAAC,QAAQ;QACZ,MAAM,UAAU,GAAG,MAAM,IAAA,6BAAqB,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAEnE,OAAO,UAAU;YACf,CAAC,CAAC,gBAAM,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,aAAa,eAAe,UAAU,GAAG,CAAC;YACtE,CAAC,CAAC,gBAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,aAAa,kBAAkB,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,GAAG;QACP,OAAO,CACL,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,oEAAoE;YACnG,eAAe,mBAAmB,GAAG,CACtC,CAAC;IACJ,CAAC;IAED,UAAU;QACR,OAAO,KAAK,CAAC;IACf,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAzBD,kDAyBC;AACY,QAAA,mBAAmB,GAAG,IAAI,mBAAmB,EAAE,CAAC"}

package/build/lib/doctor/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Return an executable path of cmd
+ *
+ * @param {string} cmd Standard output by command
+ * @return {Promise<string?>} The full path of cmd. `null` if the cmd is not found.
+ */
+export function resolveExecutablePath(cmd: string): Promise<string | null>;
+//# sourceMappingURL=utils.d.ts.map

package/build/lib/doctor/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../lib/doctor/utils.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,2CAHW,MAAM,GACL,QAAQ,MAAM,QAAE,CAU3B"}

package/build/lib/doctor/utils.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveExecutablePath = void 0;
+const support_1 = require("@appium/support");
+/**
+ * Return an executable path of cmd
+ *
+ * @param {string} cmd Standard output by command
+ * @return {Promise<string?>} The full path of cmd. `null` if the cmd is not found.
+ */
+async function resolveExecutablePath(cmd) {
+    try {
+        const executablePath = await support_1.fs.which(cmd);
+        if (executablePath && (await support_1.fs.exists(executablePath))) {
+            return executablePath;
+        }
+    }
+    catch (err) { }
+    return null;
+}
+exports.resolveExecutablePath = resolveExecutablePath;
+//# sourceMappingURL=utils.js.map

package/build/lib/doctor/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../lib/doctor/utils.js"],"names":[],"mappings":";;;AAAA,6CAAmC;AAEnC;;;;;GAKG;AACI,KAAK,UAAU,qBAAqB,CAAC,GAAG;IAC7C,IAAI;QACF,MAAM,cAAc,GAAG,MAAM,YAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,cAAc,IAAI,CAAC,MAAM,YAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE;YACvD,OAAO,cAAc,CAAC;SACvB;KACF;IAAC,OAAO,GAAG,EAAE,GAAE;IAChB,OAAO,IAAI,CAAC;AACd,CAAC;AARD,sDAQC"}

package/build/lib/index.d.ts

@@ -2,6 +2,7 @@ import { AndroidDriver } from './driver';
 export type * from './commands';
 export { ANDROID_DRIVER_CONSTRAINTS as commonCapConstraints } from './constraints';
 export * from './driver';
+export * as doctor from './doctor/checks';
 export { SETTINGS_HELPER_PKG_ID, default as androidHelpers } from './helpers/android';
 export type * from './helpers/types';
 export { CHROMIUM_WIN, NATIVE_WIN, WEBVIEW_BASE, WEBVIEW_WIN, default as webviewHelpers, } from './helpers/webview';

package/build/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAC,0BAA0B,IAAI,oBAAoB,EAAC,MAAM,eAAe,CAAC;AACjF,cAAc,UAAU,CAAC;AACzB,OAAO,EAAC,sBAAsB,EAAE,OAAO,IAAI,cAAc,EAAC,MAAM,mBAAmB,CAAC;AACpF,mBAAmB,iBAAiB,CAAC;AACrC,OAAO,EACL,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,OAAO,IAAI,cAAc,GAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAe,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AACvC,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAC,0BAA0B,IAAI,oBAAoB,EAAC,MAAM,eAAe,CAAC;AACjF,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,sBAAsB,EAAE,OAAO,IAAI,cAAc,EAAC,MAAM,mBAAmB,CAAC;AACpF,mBAAmB,iBAAiB,CAAC;AACrC,OAAO,EACL,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,OAAO,IAAI,cAAc,GAC1B,MAAM,mBAAmB,CAAC;AAE3B,eAAe,aAAa,CAAC"}

package/build/lib/index.js

@@ -10,20 +10,33 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webviewHelpers = exports.WEBVIEW_WIN = exports.WEBVIEW_BASE = exports.NATIVE_WIN = exports.CHROMIUM_WIN = exports.androidHelpers = exports.SETTINGS_HELPER_PKG_ID = exports.commonCapConstraints = void 0;
+exports.webviewHelpers = exports.WEBVIEW_WIN = exports.WEBVIEW_BASE = exports.NATIVE_WIN = exports.CHROMIUM_WIN = exports.androidHelpers = exports.SETTINGS_HELPER_PKG_ID = exports.doctor = exports.commonCapConstraints = void 0;
 const source_map_support_1 = require("source-map-support");
 (0, source_map_support_1.install)();
 const driver_1 = require("./driver");
 var constraints_1 = require("./constraints");
 Object.defineProperty(exports, "commonCapConstraints", { enumerable: true, get: function () { return constraints_1.ANDROID_DRIVER_CONSTRAINTS; } });
 __exportStar(require("./driver"), exports);
+exports.doctor = __importStar(require("./doctor/checks"));
 var android_1 = require("./helpers/android");
 Object.defineProperty(exports, "SETTINGS_HELPER_PKG_ID", { enumerable: true, get: function () { return android_1.SETTINGS_HELPER_PKG_ID; } });
 Object.defineProperty(exports, "androidHelpers", { enumerable: true, get: function () { return __importDefault(android_1).default; } });

package/build/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,2DAA2C;AAC3C,IAAA,4BAAO,GAAE,CAAC;AAEV,qCAAuC;AAEvC,6CAAiF;AAAzE,mHAAA,0BAA0B,OAAwB;AAC1D,2CAAyB;AACzB,6CAAoF;AAA5E,iHAAA,sBAAsB,OAAA;AAAE,0HAAA,OAAO,OAAkB;AAEzD,6CAM2B;AALzB,uGAAA,YAAY,OAAA;AACZ,qGAAA,UAAU,OAAA;AACV,uGAAA,YAAY,OAAA;AACZ,sGAAA,WAAW,OAAA;AACX,0HAAA,OAAO,OAAkB;AAG3B,kBAAe,sBAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA2C;AAC3C,IAAA,4BAAO,GAAE,CAAC;AAEV,qCAAuC;AAEvC,6CAAiF;AAAzE,mHAAA,0BAA0B,OAAwB;AAC1D,2CAAyB;AACzB,0DAA0C;AAC1C,6CAAoF;AAA5E,iHAAA,sBAAsB,OAAA;AAAE,0HAAA,OAAO,OAAkB;AAEzD,6CAM2B;AALzB,uGAAA,YAAY,OAAA;AACZ,qGAAA,UAAU,OAAA;AACV,uGAAA,YAAY,OAAA;AACZ,sGAAA,WAAW,OAAA;AACX,0HAAA,OAAO,OAAkB;AAG3B,kBAAe,sBAAa,CAAC"}

package/lib/doctor/checks.js

@@ -0,0 +1,253 @@
+import {resolveExecutablePath} from './utils';
+import {system, fs, doctor} from '@appium/support';
+import path from 'path';
+import '@colors/colors';
+import {getAndroidBinaryPath, getSdkRootFromEnv} from 'appium-adb';
+
+
+const JAVA_HOME_VAR_NAME = system.isWindows() ? '%JAVA_HOME%' : '$JAVA_HOME';
+const ENVIRONMENT_VARS_TUTORIAL_URL = 'https://github.com/appium/java-client/blob/master/docs/environment.md';
+const JAVA_HOME_TUTORIAL = 'https://docs.oracle.com/cd/E21454_01/html/821-2531/inst_jdk_javahome_t.html';
+const ANDROID_SDK_LINK1 = 'https://developer.android.com/studio#cmdline-tools';
+const ANDROID_SDK_LINK2 = 'https://developer.android.com/studio/intro/update#sdk-manager';
+const BUNDLETOOL_RELEASES_LINK = 'https://github.com/google/bundletool/releases/';
+const GSTREAMER_INSTALL_LINK = 'https://gstreamer.freedesktop.org/documentation/installing/index.html?gi-language=c';
+const FFMPEG_INSTALL_LINK = 'https://www.ffmpeg.org/download.html';
+
+/**
+ * @typedef EnvVarCheckOptions
+ * @property {boolean} [expectDir] If set to true then
+ * the path is expected to be a valid folder
+ * @property {boolean} [expectFile] If set to true then
+ * the path is expected to be a valid file
+ */
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+class EnvVarAndPathCheck {
+  /**
+   * @param {string} varName
+   * @param {EnvVarCheckOptions} [opts={}]
+   */
+  constructor(varName, opts = {}) {
+    this.varName = varName;
+    this.opts = opts;
+  }
+
+  async diagnose() {
+    const varValue = process.env[this.varName];
+    if (!varValue) {
+      return doctor.nok(`${this.varName} environment variable is NOT set!`);
+    }
+
+    if (!await fs.exists(varValue)) {
+      let errMsg = `${this.varName} is set to '${varValue}' but this path does not exist!`;
+      if (system.isWindows() && varValue.includes('%')) {
+        errMsg += ` Consider replacing all references to other environment variables with absolute paths.`;
+      }
+      return doctor.nok(errMsg);
+    }
+
+    const stat = await fs.stat(varValue);
+    if (this.opts.expectDir && !stat.isDirectory()) {
+      return doctor.nok(`${this.varName} is expected to be a valid folder, got a file path instead`);
+    }
+    if (this.opts.expectFile && stat.isDirectory()) {
+      return doctor.nok(`${this.varName} is expected to be a valid file, got a folder path instead`);
+    }
+
+    return doctor.ok(`${this.varName} is set to: ${varValue}`);
+  }
+
+  async fix() {
+    return (
+      `Make sure the environment variable ${this.varName.bold} is properly configured for the Appium process. ` +
+      `Refer ${ENVIRONMENT_VARS_TUTORIAL_URL} for more details.`
+    );
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return false;
+  }
+}
+export const androidHomeCheck = new EnvVarAndPathCheck('ANDROID_HOME', {expectDir: true});
+export const javaHomeCheck = new EnvVarAndPathCheck('JAVA_HOME', {expectDir: true});
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class JavaHomeValueCheck {
+  async diagnose() {
+    const envVar = process.env.JAVA_HOME;
+    if (!envVar) {
+      return doctor.nok(`${JAVA_HOME_VAR_NAME} environment variable must be set`);
+    }
+
+    const javaBinaryRelativePath = path.join('bin', `java${system.isWindows() ? '.exe' : ''}`);
+    const javaBinary = path.join(envVar, javaBinaryRelativePath);
+    if (!await fs.exists(javaBinary)) {
+      return doctor.nok(
+        `${JAVA_HOME_VAR_NAME} is set to an invalid value. ` +
+        `It must be pointing to a folder containing ${javaBinaryRelativePath}`
+      );
+    }
+    return doctor.ok(`'${javaBinaryRelativePath}' exists under '${envVar}'`);
+  }
+
+  async fix() {
+    return `Set ${JAVA_HOME_VAR_NAME} environment variable to the root folder path of your local JDK installation. ` +
+      `Read ${JAVA_HOME_TUTORIAL}`;
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return false;
+  }
+}
+export const javaHomeValueCheck = new JavaHomeValueCheck();
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class AndroidSdkCheck {
+  /** @type {import('@appium/types').AppiumLogger} */
+  log;
+
+  TOOL_NAMES = ['adb', 'emulator', `apkanalyzer${system.isWindows() ? '.bat' : ''}`];
+
+  async diagnose() {
+    const listOfTools = this.TOOL_NAMES.join(', ');
+    const sdkRoot = getSdkRootFromEnv();
+    if (!sdkRoot) {
+      return doctor.nok(
+        `${listOfTools} could not be found because ANDROID_HOME is NOT set!`
+      );
+    }
+
+    this.log.info(`   Checking ${listOfTools}`);
+    const missingBinaries = [];
+    for (const binary of this.TOOL_NAMES) {
+      try {
+        this.log.info(`     '${binary}' exists in ${await getAndroidBinaryPath(binary)}`);
+      } catch (e) {
+        missingBinaries.push(binary);
+      }
+    }
+
+    if (missingBinaries.length > 0) {
+      return doctor.nok(`${missingBinaries.join(', ')} could NOT be found in '${sdkRoot}'!`);
+    }
+
+    return doctor.ok(`${listOfTools} exist in '${sdkRoot}'`);
+  }
+
+  async fix() {
+    return (
+      `Manually install ${'Android SDK'.bold} and set ${'ANDROID_HOME'.bold}. ` +
+      `Read ${[ANDROID_SDK_LINK1, ANDROID_SDK_LINK2].join(' and ')}.`
+    );
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return false;
+  }
+}
+export const androidSdkCheck = new AndroidSdkCheck();
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalBundletoolCheck {
+  async diagnose() {
+    const bundletoolPath = await resolveExecutablePath('bundletool.jar');
+    return bundletoolPath
+      ? doctor.okOptional(`bundletool.jar is installed at: ${bundletoolPath}`)
+      : doctor.nokOptional('bundletool.jar cannot be found');
+  }
+
+  async fix() {
+    return (
+      `${'bundletool.jar'.bold} is used to handle Android App bundles. ` +
+      `Please download the binary from ${BUNDLETOOL_RELEASES_LINK} and store it ` +
+      `to any folder listed in the PATH environment variable. Folders that ` +
+      `are currently present in PATH: ${process.env.PATH}`
+    );
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return true;
+  }
+}
+export const optionalBundletoolCheck = new OptionalBundletoolCheck();
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalGstreamerCheck {
+  GSTREAMER_BINARY = `gst-launch-1.0${system.isWindows() ? '.exe' : ''}`;
+  GST_INSPECT_BINARY = `gst-inspect-1.0${system.isWindows() ? '.exe' : ''}`;
+
+  async diagnose() {
+    const gstreamerPath = await resolveExecutablePath(this.GSTREAMER_BINARY);
+    const gstInspectPath = await resolveExecutablePath(this.GST_INSPECT_BINARY);
+
+    return gstreamerPath && gstInspectPath
+      ? doctor.okOptional(
+          `${this.GSTREAMER_BINARY} and ${this.GST_INSPECT_BINARY} are installed at: ${gstreamerPath} and ${gstInspectPath}`
+        )
+      : doctor.nokOptional(`${this.GSTREAMER_BINARY} and/or ${this.GST_INSPECT_BINARY} cannot be found`);
+  }
+
+  async fix() {
+    return (
+      `${
+        `${this.GSTREAMER_BINARY} and ${this.GST_INSPECT_BINARY}`.bold
+      } are used to stream the screen of the device under test. ` +
+      `Please read ${GSTREAMER_INSTALL_LINK}.`
+    );
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return true;
+  }
+}
+export const optionalGstreamerCheck = new OptionalGstreamerCheck();
+
+/** @satisfies {import('@appium/types').IDoctorCheck} */
+export class OptionalFfmpegCheck {
+  FFMPEG_BINARY = `ffmpeg${system.isWindows() ? '.exe' : ''}`;
+
+  async diagnose() {
+    const ffmpegPath = await resolveExecutablePath(this.FFMPEG_BINARY);
+
+    return ffmpegPath
+      ? doctor.okOptional(`${this.FFMPEG_BINARY} exists at '${ffmpegPath}'`)
+      : doctor.nokOptional(`${this.FFMPEG_BINARY} cannot be found`);
+  }
+
+  async fix() {
+    return (
+      `${`${this.FFMPEG_BINARY}`.bold} is used to capture screen recordings from the device under test. ` +
+      `Please read ${FFMPEG_INSTALL_LINK}.`
+    );
+  }
+
+  hasAutofix() {
+    return false;
+  }
+
+  isOptional() {
+    return true;
+  }
+}
+export const optionalFfmpegCheck = new OptionalFfmpegCheck();

package/lib/doctor/utils.js

@@ -0,0 +1,17 @@
+import {fs} from '@appium/support';
+
+/**
+ * Return an executable path of cmd
+ *
+ * @param {string} cmd Standard output by command
+ * @return {Promise<string?>} The full path of cmd. `null` if the cmd is not found.
+ */
+export async function resolveExecutablePath(cmd) {
+  try {
+    const executablePath = await fs.which(cmd);
+    if (executablePath && (await fs.exists(executablePath))) {
+      return executablePath;
+    }
+  } catch (err) {}
+  return null;
+}

package/lib/index.ts

@@ -5,6 +5,7 @@ import {AndroidDriver} from './driver';
 export type * from './commands';
 export {ANDROID_DRIVER_CONSTRAINTS as commonCapConstraints} from './constraints';
 export * from './driver';
+export * as doctor from './doctor/checks';
 export {SETTINGS_HELPER_PKG_ID, default as androidHelpers} from './helpers/android';
 export type * from './helpers/types';
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appium-android-driver",
-  "version": "7.4.1",
+  "version": "7.5.1",
   "description": "Android UiAutomator and Chrome support for Appium",
   "keywords": [
     "appium",
@@ -55,6 +55,8 @@
     "singleQuote": true
   },
   "dependencies": {
+    "@appium/support": "^4.2.0",
+    "@colors/colors": "^1.6.0",
     "appium-adb": "^11.0.1",
     "appium-chromedriver": "^5.5.1",
     "asyncbox": "^3.0.0",
@@ -75,7 +77,6 @@
   "devDependencies": {
     "@appium/eslint-config-appium": "^8.0.4",
     "@appium/eslint-config-appium-ts": "^0.x",
-    "@appium/support": "^4.1.2",
     "@appium/test-support": "^3.0.20",
     "@appium/tsconfig": "^0.x",
     "@appium/types": "^0.x",