Add idb check to doctor

Summary:
Adds a check for idb to flipper-doctor.

This depends on the flipper settings, to know where to look for idb, so I've made it so you can pass settings into the doctor when running it. When run from the command line, you don't get the settings. This is because settings loading currently depends on redux so I haven't extracted it into its own package.

Not that this will notify ALL open source iOS users with a doctor warning because they don't have idb installed. The error message says you can disable it in settings, which will silence this warning.

CHANGELOG: The open source version now works with physical iOS devices.

Reviewed By: passy

Differential Revision: D21883086

fbshipit-source-id: f28c43487e88a6c07ef3cc3da2764026726c9f18

desktop/app/src/chrome/DoctorBar.tsx

@@ -141,13 +141,9 @@ class DoctorBar extends Component<Props, State> {
 }
 
 export default connect<StateFromProps, DispatchFromProps, {}, Store>(
-  ({
+  ({settingsState, healthchecks: {healthcheckReport}}) => ({
-    settingsState: {enableAndroid, enableIOS},
-    healthchecks: {healthcheckReport},
-  }) => ({
-    enableAndroid,
-    enableIOS,
     healthcheckReport,
+    settings: settingsState,
   }),
   {
     setActiveSheet,

desktop/app/src/chrome/DoctorSheet.tsx

@@ -406,13 +406,9 @@ class DoctorSheet extends Component<Props, State> {
 }
 
 export default connect<StateFromProps, DispatchFromProps, OwnProps, Store>(
-  ({
+  ({healthchecks: {healthcheckReport}, settingsState}) => ({
-    healthchecks: {healthcheckReport},
-    settingsState: {enableAndroid, enableIOS},
-  }) => ({
     healthcheckReport,
-    enableAndroid,
+    settings: settingsState,
-    enableIOS,
   }),
   {
     startHealthchecks,

desktop/app/src/chrome/SettingsSheet.tsx

@@ -85,6 +85,7 @@ class SettingsSheet extends Component<Props, State> {
       enableAndroid,
       androidHome,
       enableIOS,
+      enablePhysicalIOS,
       enablePrefetching,
       idbPath,
       reactNative,
@@ -138,6 +139,18 @@ class SettingsSheet extends Component<Props, State> {
               content={'iOS development is only supported on MacOS'}
             />
           )}
+          <ToggledSection
+            label="Enable physical iOS devices"
+            toggled={enablePhysicalIOS}
+            frozen={false}
+            onChange={(v) => {
+              this.setState({
+                updatedSettings: {
+                  ...this.state.updatedSettings,
+                  enablePhysicalIOS: v,
+                },
+              });
+            }}>
             <FilePathConfigField
               label="IDB binary location"
               defaultValue={idbPath}
@@ -149,6 +162,7 @@ class SettingsSheet extends Component<Props, State> {
               }}
             />
           </ToggledSection>
+        </ToggledSection>
         <LauncherSettingsPanel
           isPrefetchingEnabled={enablePrefetching}
           onEnablePrefetchingChange={(v) => {

desktop/app/src/chrome/settings/configFields.tsx

@@ -17,6 +17,8 @@ import path from 'path';
 const ConfigFieldContainer = styled(FlexRow)({
   paddingLeft: 10,
   paddingRight: 10,
+  marginBottom: 5,
+  paddingTop: 5,
 });
 
 const InfoText = styled(Text)({

desktop/app/src/dispatcher/iOSDevice.tsx

@@ -258,7 +258,9 @@ export default (store: Store, logger: Logger) => {
   isXcodeDetected().then((isDetected) => {
     store.dispatch(setXcodeDetected(isDetected));
     if (isDetected) {
+      if (store.getState().settingsState.enablePhysicalIOS) {
         startDevicePortForwarders();
+      }
       return queryDevicesForever(store, logger);
     }
   });

desktop/app/src/reducers/settings.tsx

@@ -21,6 +21,7 @@ export type Settings = {
   androidHome: string;
   enableAndroid: boolean;
   enableIOS: boolean;
+  enablePhysicalIOS: boolean;
   /**
    * If unset, this will assume the value of the GK setting.
    * Note that this setting has no effect in the open source version
@@ -57,6 +58,7 @@ const initialState: Settings = {
   androidHome: getDefaultAndroidSdkPath(),
   enableAndroid: true,
   enableIOS: os.platform() === 'darwin',
+  enablePhysicalIOS: os.platform() === 'darwin',
   enablePrefetching: Tristate.Unset,
   idbPath: '/usr/local/bin/idb',
   jsApps: {

desktop/app/src/utils/runHealthchecks.tsx

@@ -25,15 +25,19 @@ export type HealthcheckEventsHandler = {
 };
 
 export type HealthcheckSettings = {
+  settings: {
     enableAndroid: boolean;
     enableIOS: boolean;
+    enablePhysicalIOS: boolean;
+    idbPath: string;
+  };
 };
 
 export type HealthcheckOptions = HealthcheckEventsHandler & HealthcheckSettings;
 
 async function launchHealthchecks(options: HealthcheckOptions): Promise<void> {
   const healthchecks = getHealthchecks();
-  if (!options.enableAndroid) {
+  if (!options.settings.enableAndroid) {
     healthchecks.android = {
       label: healthchecks.android.label,
       isSkipped: true,
@@ -41,7 +45,7 @@ async function launchHealthchecks(options: HealthcheckOptions): Promise<void> {
         'Healthcheck is skipped, because "Android Development" option is disabled in the Flipper settings',
     };
   }
-  if (!options.enableIOS) {
+  if (!options.settings.enableIOS) {
     healthchecks.ios = {
       label: healthchecks.ios.label,
       isSkipped: true,
@@ -57,7 +61,7 @@ async function launchHealthchecks(options: HealthcheckOptions): Promise<void> {
       continue;
     }
     for (const h of category.healthchecks) {
-      const checkResult = await h.run(environmentInfo);
+      const checkResult = await h.run(environmentInfo, options.settings);
       const metricName = `doctor:${h.key.replace('.', ':')}.healthcheck`; // e.g. "doctor:ios:xcode-select.healthcheck"
       if (checkResult.hasProblem) {
         hasProblems = true;

desktop/doctor/src/index.ts

@@ -34,11 +34,19 @@ export type Healthchecks = {
   ios: HealthcheckCategory | SkippedHealthcheckCategory;
 };
 
+export type Settings = {
+  idbPath: string;
+  enablePhysicalIOS: boolean;
+};
+
 export type Healthcheck = {
   key: string;
   label: string;
   isRequired?: boolean;
-  run: (env: EnvironmentInfo) => Promise<HealthchecRunResult>;
+  run: (
+    env: EnvironmentInfo,
+    settings?: Settings,
+  ) => Promise<HealthchecRunResult>;
 };
 
 export type HealthchecRunResult = {
@@ -204,6 +212,41 @@ export function getHealthchecks(): Healthchecks {
                   };
                 },
               },
+              {
+                key: 'ios.idb',
+                label: 'IDB installed',
+                isRequired: false,
+                run: async (
+                  _: 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,
+                  };
+                },
+              },
             ],
           }
         : {