in desktop/doctor/src/index.tsx [21:265]
export function getHealthchecks(): FlipperDoctor.Healthchecks {
return {
common: {
label: 'Common',
isRequired: true,
isSkipped: false,
healthchecks: [
{
key: 'common.openssl',
label: 'OpenSSL Installed',
run: async (_: FlipperDoctor.EnvironmentInfo) => {
const result = await tryExecuteCommand('openssl version');
const hasProblem = result.hasProblem;
const message = hasProblem
? `OpenSSL (https://wiki.openssl.org/index.php/Binaries) is not installed or not added to PATH. ${result.message}.`
: `OpenSSL (https://wiki.openssl.org/index.php/Binaries) is installed and added to PATH. ${result.message}.`;
return {
hasProblem,
message,
};
},
},
{
key: 'common.watchman',
label: 'Watchman Installed',
run: async (_: FlipperDoctor.EnvironmentInfo) => {
const isAvailable = await isWatchmanAvailable();
return {
hasProblem: !isAvailable,
message: isAvailable
? 'Watchman file watching service (https://facebook.github.io/watchman/) is installed and added to PATH. Live reloading after changes during Flipper plugin development is enabled.'
: 'Watchman file watching service (https://facebook.github.io/watchman/) is not installed or not added to PATH. Live reloading after changes during Flipper plugin development is disabled.',
};
},
},
],
},
android: {
label: 'Android',
isRequired: false,
isSkipped: false,
healthchecks: [
{
key: 'android.sdk',
label: 'SDK Installed',
isRequired: true,
run: async (_: FlipperDoctor.EnvironmentInfo) => {
const androidHome = process.env.ANDROID_HOME;
const androidSdkRoot = process.env.ANDROID_SDK_ROOT;
let androidHomeResult: FlipperDoctor.HealthcheckRunResult;
if (!androidHome) {
androidHomeResult = {
hasProblem: true,
message: `ANDROID_HOME is not defined. You can use Flipper Settings (File > Preferences) to point to its location.`,
};
} else if (!fs.existsSync(androidHome)) {
androidHomeResult = {
hasProblem: true,
message: `ANDROID_HOME point to a folder which does not exist: ${androidHome}. You can use Flipper Settings (File > Preferences) to point to a different location.`,
};
} else {
const platformToolsDir = path.join(androidHome, 'platform-tools');
if (!fs.existsSync(platformToolsDir)) {
androidHomeResult = {
hasProblem: true,
message: `Android SDK Platform Tools not found at the expected location "${platformToolsDir}". Probably they are not installed.`,
};
} else {
androidHomeResult = await tryExecuteCommand(
`"${path.join(platformToolsDir, 'adb')}" version`,
);
}
}
if (androidHomeResult.hasProblem == false) {
return androidHomeResult;
}
let androidSdkRootResult: FlipperDoctor.HealthcheckRunResult;
if (!androidSdkRoot) {
androidSdkRootResult = {
hasProblem: true,
message: `ANDROID_SDK_ROOT is not defined. You can use Flipper Settings (File > Preferences) to point to its location.`,
};
} else if (!fs.existsSync(androidSdkRoot)) {
androidSdkRootResult = {
hasProblem: true,
message: `ANDROID_SDK_ROOT point to a folder which does not exist: ${androidSdkRoot}. You can use Flipper Settings (File > Preferences) to point to a different location.`,
};
} else {
const platformToolsDir = path.join(
androidSdkRoot,
'platform-tools',
);
if (!fs.existsSync(platformToolsDir)) {
androidSdkRootResult = {
hasProblem: true,
message: `Android SDK Platform Tools not found at the expected location "${platformToolsDir}". Probably they are not installed.`,
};
} else {
androidSdkRootResult = await tryExecuteCommand(
`"${path.join(platformToolsDir, 'adb')}" version`,
);
}
}
return androidSdkRootResult;
},
},
],
},
ios: {
label: 'iOS',
...(process.platform === 'darwin'
? {
isRequired: false,
isSkipped: false,
healthchecks: [
{
key: 'ios.sdk',
label: 'SDK Installed',
isRequired: true,
run: async (e: FlipperDoctor.EnvironmentInfo) => {
const hasProblem =
!e.SDKs['iOS SDK'] ||
!e.SDKs['iOS SDK'].Platforms ||
!e.SDKs['iOS SDK'].Platforms.length;
const message = hasProblem
? 'iOS SDK is not installed. You can install it using Xcode (https://developer.apple.com/xcode/).'
: `iOS SDK is installed for the following platforms: ${JSON.stringify(
e.SDKs['iOS SDK'].Platforms,
)}.`;
return {
hasProblem,
message,
};
},
},
{
key: 'ios.xcode',
label: 'XCode Installed',
isRequired: true,
run: async (e: FlipperDoctor.EnvironmentInfo) => {
const hasProblem = e.IDEs == null || e.IDEs.Xcode == null;
const message = hasProblem
? 'Xcode (https://developer.apple.com/xcode/) is not installed.'
: `Xcode version ${e.IDEs.Xcode.version} is installed at "${e.IDEs.Xcode.path}".`;
return {
hasProblem,
message,
};
},
},
{
key: 'ios.xcode-select',
label: 'xcode-select set',
isRequired: true,
run: async (_: FlipperDoctor.EnvironmentInfo) => {
const result = await tryExecuteCommand('xcode-select -p');
if (result.hasProblem) {
return {
hasProblem: true,
message: `Xcode version is not selected. You can select it using command "sudo xcode-select -switch <path/to/>Xcode.app". ${result.message}.`,
};
}
const selectedXcode = result.stdout!.toString().trim();
if (selectedXcode == '/Library/Developer/CommandLineTools') {
return {
hasProblem: true,
message: `xcode-select has no Xcode selected, You can select it using command "sudo xcode-select -switch <path/to/>Xcode.app".`,
};
}
if ((await fs_extra.pathExists(selectedXcode)) == false) {
return {
hasProblem: true,
message: `xcode-select has path of ${selectedXcode}, however this path does not exist on disk. Run "sudo xcode-select --switch" with a valid Xcode.app path.`,
};
}
return {
hasProblem: false,
message: `xcode-select has path of ${selectedXcode}.`,
};
},
},
{
key: 'ios.xctrace',
label: 'xctrace exists',
isRequired: true,
run: async (_: FlipperDoctor.EnvironmentInfo) => {
const result = await tryExecuteCommand(
'xcrun xctrace version',
);
const hasProblem = result.hasProblem;
const message = hasProblem
? `xctrace is not available. Please ensure you have Xcode installed and are running a recent version (https://developer.apple.com/xcode/). ${result.message}.`
: `xctrace is available. ${result.message}.`;
return {
hasProblem,
message,
};
},
},
{
key: 'ios.idb',
label: 'IDB installed',
isRequired: false,
run: async (
_: FlipperDoctor.EnvironmentInfo,
settings?: {enablePhysicalIOS: boolean; idbPath: string},
) => {
if (!settings) {
return {
hasProblem: false,
message:
'Not enough context to check IDB installation. Needs to be run through Flipper UI.',
};
}
if (!settings.enablePhysicalIOS) {
return {
hasProblem: false,
message:
'Using physical iOS devices is disabled in settings. So IDB is not required.',
};
}
const result = await tryExecuteCommand(
`${settings?.idbPath} --help`,
);
const hasProblem = result.hasProblem;
const message = hasProblem
? `IDB is required to use Flipper with iOS devices. It can be installed from https://github.com/facebook/idb and configured in Flipper settings. You can also disable physical iOS device support in settings. Current setting: ${settings.idbPath} isn't a valid IDB installation.`
: 'Flipper is configured to use your IDB installation.';
return {
hasProblem,
message,
};
},
},
],
}
: {
isSkipped: true,
skipReason: `Healthcheck is skipped, because iOS development is not supported on the current platform "${process.platform}".`,
}),
},
};
}