Fix eden health check exit code

Summary:
**Background**:
Previously, when detecting issues with the Eden setup, we would send an exit code of 1 to identify the issue on the VS Code side. However, VS Code's execution logic would interpret this exit code as a command execution failure, causing it to terminate the code flow prematurely and preventing the reporting of Eden-related issues to the end user.

**Changes**:
To address this issue, we have introduced a custom isExitError method within VS Code's execution logic. This method ensures that an exit code of 1 is treated as a non-error scenario, allowing the code flow to continue uninterrupted when Eden-related issues are detected.
With this change, VS Code will no longer terminate prematurely due to Eden issues, enabling more robust error handling and improved user experience.

Reviewed By: genevievehelsel

Differential Revision: D67868950

fbshipit-source-id: 5948e692df4f4e447834c63b413d9b3e503373d1

Author: ViniGupta08

eden/fs/cli/main.py

@@ -1220,11 +1220,11 @@ class ErrorCode(Enum):
 
         def description(self) -> str:
             descriptions = {
-                self.EDEN_NOT_RUNNING: "The EdenFS daemon is not running.",
+                self.EDEN_NOT_RUNNING: "The EdenFS daemon doesn't seem to be running.",
                 self.STALE_EDEN_VERSION: "The running EdenFS daemon is over 30 days out-of-date.",
-                self.INVALID_CERTS: "The EdenFS couldn't find a valid user certificate.",
-                self.NO_REPO_MOUNT_FOUND: "One or more checkouts are unmounted: ",
-                self.CHEF_NOT_RUNNING: "Chef is not running on your machine.",
+                self.INVALID_CERTS: "EdenFS couldn't find a valid user certificate.",
+                self.NO_REPO_MOUNT_FOUND: "One or more checkouts are identified as unmounted.",
+                self.CHEF_NOT_RUNNING: "Chef doesn't seem to be running on your machine.",
             }
             return descriptions[self]
 
@@ -1245,22 +1245,22 @@ def is_eden_running(self, instance: EdenInstance) -> bool:
         health_info = instance.check_health()
         if not health_info.is_healthy():
             self.error_codes[HealthReportCmd.ErrorCode.EDEN_NOT_RUNNING] = (
-                "Could not find EdenFS daemon pid."
+                "Failed to find EdenFS daemon pid"
             )
             return False
 
         try:
             self.running_version = instance.get_running_version()
         except EdenNotRunningError:
             self.error_codes[HealthReportCmd.ErrorCode.EDEN_NOT_RUNNING] = (
-                "Couldn't retrieve EdenFS running version."
+                "Failed to retrieve EdenFS running version"
             )
             return False
 
         self.version_info = version_mod.get_version_info(self.running_version)
         if not self.version_info.is_eden_running:
             self.error_codes[HealthReportCmd.ErrorCode.EDEN_NOT_RUNNING] = (
-                "Couldn't retrieve EdenFS running version."
+                "Failed to retrieve EdenFS running version"
             )
             return False
         return True
@@ -1284,7 +1284,7 @@ def are_certs_valid(self) -> bool:
             return True
         # cert error!
         self.error_codes[HealthReportCmd.ErrorCode.INVALID_CERTS] = (
-            "Couldn't validate x509 certificates."
+            "Failed to validate x509 certificates"
         )
         return False
 
@@ -1299,17 +1299,20 @@ def is_repo_mounted(self, instance: EdenInstance, mounts: List[str]) -> bool:
 
             if unmounted_repos:
                 self.error_codes[HealthReportCmd.ErrorCode.NO_REPO_MOUNT_FOUND] = (
-                    ", ".join(unmounted_repos)
+                    ", ".join(unmounted_repos) + " not mounted correctly"
                 )
                 return False
 
             return True
+
         except Exception as ex:
-            print(f"Couldn't retrieve EdenFS checkouts info.: {ex}", file=sys.stderr)
-            return True
+            self.error_codes[HealthReportCmd.ErrorCode.NO_REPO_MOUNT_FOUND] = " ".join(
+                ["Failed to retrieve EdenFS checkouts info: ", ex.args[0]]
+            )
+            return False
 
     def is_chef_running(self) -> bool:
-        """Examine the status of Chef."""
+        """Examine the status of Chef runs."""
         chef_log_path = get_chef_log_path(platform.system())
         if chef_log_path is None or chef_log_path == "":
             print(f"Skipping chef run check for platform {platform.system()}.")
@@ -1321,9 +1324,10 @@ def is_chef_running(self) -> bool:
                 last_chef_run_sec = chef_log[CHEF_LOG_TIMESTAMP_KEY]
 
                 if not isinstance(last_chef_run_sec, (int, float)):
-                    raise ValueError(
-                        f"Invalid/missing timestamp in {CHEF_LOG_TIMESTAMP_KEY}"
+                    self.error_codes[HealthReportCmd.ErrorCode.CHEF_NOT_RUNNING] = (
+                        "Invalid/missing timestamp in " + CHEF_LOG_TIMESTAMP_KEY
                     )
+                    return False
 
                 last_chef_run = datetime.fromtimestamp(last_chef_run_sec)
 
@@ -1335,7 +1339,7 @@ def is_chef_running(self) -> bool:
                     self.error_codes[HealthReportCmd.ErrorCode.CHEF_NOT_RUNNING] = (
                         "Last run was "
                         + str((ms_since_last_run / 3600000))
-                        + " hours ago."
+                        + " hours ago"
                     )
                     return False
                 return True
@@ -1362,7 +1366,9 @@ def print_error_codes_json(out: ui.Output) -> None:
         data = [
             {
                 "error": error_code.name,
-                "description": error_code.description() + error_additional_info,
+                "description": error_additional_info
+                + ". Possible causes: "
+                + error_code.description(),
             }
             for error_code, error_additional_info in HealthReportCmd.error_codes.items()
         ]
@@ -1389,11 +1395,12 @@ def run(self, args: argparse.Namespace) -> int:
                 )
             ):
                 exit_code = 1
-        except Exception as ex:
-            print(ex)
 
-        self.print_error_codes_json(out)
-        return exit_code
+            self.print_error_codes_json(out)
+            return exit_code
+
+        except Exception as ex:
+            raise Exception("Failed to run health report: " + str(ex))
 
 
 @subcmd("strace", "Monitor FUSE requests.")

eden/fs/cli/test/health_report_test.py

@@ -158,7 +158,7 @@ def test_health_report_notify_eden_not_running(
         self.assertEqual(
             HealthReportCmd.error_codes,
             {
-                HealthReportCmd.ErrorCode.EDEN_NOT_RUNNING: "Could not find EdenFS daemon pid.",
+                HealthReportCmd.ErrorCode.EDEN_NOT_RUNNING: "Failed to find EdenFS daemon pid",
             },
         )
 
@@ -252,7 +252,7 @@ def test_health_report_check_for_invalid_certs(
         self.assertEqual(
             HealthReportCmd.error_codes,
             {
-                HealthReportCmd.ErrorCode.INVALID_CERTS: "Couldn't validate x509 certificates."
+                HealthReportCmd.ErrorCode.INVALID_CERTS: "Failed to validate x509 certificates"
             },
         )