UI/UX enhancements (#654)

* remove confusing error about refresh token expiration

* package webui logfile in log packaging logic

* mark dataset as prepared in webui if operational

* show view result when task is running

* add command to view the URL and token for webui

* improve printed msgs during inference run

* fix how ui.interactive works if nested

* make result window scrollable

* change profiles to settings in UI

* change favicon

* fix edge case bug in format_errors_dict

* fix reading results for finalized executions

* update version string

* fix linter alert

Author: hasan7n

cli/medperf/_version.py

@@ -1 +1 @@
-__version__ = "0.1.4"
+__version__ = "0.1.5"

cli/medperf/account_management/account_management.py

@@ -1,7 +1,7 @@
 from .token_storage import TokenStore
 from medperf.config_management import read_config, write_config
 from medperf import config
-from medperf.exceptions import MedperfException
+from medperf.exceptions import AuthenticationError
 
 
 def read_user_account():
@@ -49,7 +49,7 @@ def set_credentials(
 def read_credentials():
     account_info = read_user_account()
     if account_info is None:
-        raise MedperfException("You are not logged in")
+        raise AuthenticationError("You are not logged in")
     email = account_info["email"]
     access_token, refresh_token = TokenStore().read_tokens(email)
 
@@ -63,7 +63,7 @@ def read_credentials():
 def delete_credentials():
     config_p = read_config()
     if config.credentials_keyword not in config_p.active_profile:
-        raise MedperfException("You are not logged in")
+        raise AuthenticationError("You are not logged in")
 
     email = config_p.active_profile[config.credentials_keyword]["email"]
     TokenStore().delete_tokens(email)
@@ -87,7 +87,7 @@ def get_medperf_user_data():
     """Return cached medperf user data. Get from the server if not found"""
     config_p = read_config()
     if config.credentials_keyword not in config_p.active_profile:
-        raise MedperfException("You are not logged in")
+        raise AuthenticationError("You are not logged in")
 
     medperf_user = config_p.active_profile[config.credentials_keyword].get(
         "medperf_user", None

cli/medperf/cli.py

@@ -22,7 +22,7 @@
 import medperf.commands.certificate.certificate as certificate
 import medperf.commands.storage as storage
 import medperf.web_ui.app as web_ui
-from medperf.utils import check_for_updates
+from medperf.utils import check_for_updates, get_webui_properties
 from medperf.logging.utils import log_machine_details
 
 app = typer.Typer()
@@ -88,6 +88,13 @@ def execute(
     config.ui.print("✅ Done!")
 
 
+@app.command("get_webui_properties")
+@clean_except
+def get_webui_props():
+    """Prints necessary information to access an already-running medperf webui"""
+    get_webui_properties()
+
+
 def version_callback(value: bool):
     if value:
         print(f"MedPerf version {__version__}")

cli/medperf/commands/execution/create.py

@@ -178,10 +178,10 @@ def load_existing_executions(self):
         }
 
     def __get_cube(self, uid: int, name: str) -> Cube:
-        self.ui.text = f"Retrieving container '{name}'"
         cube = Cube.get(uid)
+        self.ui.text = f"Retrieving {name} container '{cube.name}'"
         cube.download_run_files()
-        self.ui.print(f"> Container '{name}' download complete")
+        self.ui.print(f"> {name} Container '{cube.name}' download complete")
         return cube
 
     def run_experiments(self) -> list[Execution]:

cli/medperf/commands/execution/execution_flow.py

@@ -106,7 +106,7 @@ def set_pending_status(self):
         self.__send_evaluator_report("pending")
 
     def run_inference(self):
-        self.ui.text = "Running model inference on dataset"
+        self.ui.text = f"Running inference of model '{self.model.name}' on dataset"
         infer_timeout = config.infer_timeout
         inference_mounts = {
             "data_path": self.dataset.data_path,
@@ -138,15 +138,14 @@ def run_inference(self):
         self.__send_model_report("finished")
 
     def run_evaluation(self):
-        self.ui.text = "Running model evaluation on dataset"
+        self.ui.text = f"Calculating metrics for model '{self.model.name}' predictions"
         evaluate_timeout = config.evaluate_timeout
         evaluator_mounts = {
             "predictions": self.preds_path,
             "labels": self.dataset.labels_path,
             "output_path": self.results_path,
             "local_outputs_path": self.local_outputs_path,
         }
-        self.ui.text = "Evaluating results"
         self.__send_evaluator_report("started")
         try:
             self.evaluator.run(

cli/medperf/comms/auth/auth0.py

@@ -138,8 +138,10 @@ def __check_token_email(self, id_token_payload, email):
     def logout(self):
         """Logs out the user by revoking their refresh token and deleting the
         stored tokens."""
-
-        creds = read_credentials()
+        try:
+            creds = read_credentials()
+        except AuthenticationError:
+            return
         refresh_token = creds["refresh_token"]
 
         url = f"https://{self.domain}/oauth/revoke"

cli/medperf/config.py

@@ -54,6 +54,7 @@
 creds_folder = str(config_storage / ".tokens")
 tokens_db = str(config_storage / ".tokens_db")
 pki_assets = str(config_storage / ".pki_assets")
+webui_host_props = str(config_storage / ".webui_host_props")
 
 # TODO: should we change this?
 safe_root = ""  # Base path to accept input paths from user.

cli/medperf/entities/execution.py

@@ -85,6 +85,8 @@ def save_results(self, results, partial):
                 pass
 
     def read_results(self):
+        if self.finalized:
+            return self.results
         with open(self.results_path) as f:
             results = yaml.safe_load(f)
         return results

cli/medperf/logging/utils.py

@@ -208,7 +208,8 @@ def package_logs():
     logfiles = []
     for file in files:
         is_logfile = re.match(r"medperf\.log(?:\.\d+)?$", file) is not None
-        if is_logfile:
+        is_webui_logfile = re.match(r"medperf_webui\.log(?:\.\d+)?$", file) is not None
+        if is_logfile or is_webui_logfile:
             logfiles.append(file)
 
     package_file = os.path.join(config.logs_storage, config.log_package_file)

cli/medperf/storage/__init__.py

@@ -51,13 +51,11 @@ def __apply_login_tracking_migrations(config_p: ConfigManager):
     if config.credentials_keyword in config_p.active_profile:
         # So the user is logged in
         if "logged_in_at" not in config_p.active_profile[config.credentials_keyword]:
-            # Apply migration. We will set it to the current time, since this
-            # will make sure they will not be logged out before the actual refresh
-            # token expiration (for a better user experience). However, currently logged
-            # in users will still face a confusing error when the refresh token expires.
-            config_p.active_profile[config.credentials_keyword][
-                "logged_in_at"
-            ] = time.time()
+            # Apply migration. We will set it to an old time to make sure users no longer
+            # face a confusing error about refresh token expiration.
+            config_p.active_profile[config.credentials_keyword]["logged_in_at"] = (
+                time.time() - 2 * config.token_absolute_expiry
+            )
 
 
 def __apply_results_to_executions_migrations(config_p):