[FLPY-37] Refine ChooseAccount feature, add configurable warning prompts when submitting resources from shared accounts

Author: awkrupka

examples/dev/dev_change_account_and_submit.py

@@ -1,24 +1,18 @@
-import os
-
 import flow360 as fl
-
-# Temporary workaround for API access from dev environment as apikey in config.toml does not appear to work
-os.environ["FLOW360_APIKEY"] = (
-    "QUlEQVU3N0k2QloyUVlaTExWU1JXOmZsb3czNjA6eWNmdGNpNUFRN1pRdDVBbDRPN1M4YXdt"
-    "UzRabUZrYURkRFB4WkdWdVdVb0ZORVc0VE40MG1DVDVJOFRxenp1QW44ME4zT3ZjcVE4ODZLe"
-    "llGZlBoWnIxNHFPaU1CaFp4cmd3djFUSUQwREpZTmlTS0l6M2NzeUxZMEprSk5mU2c="
-)
+from flow360.examples import OM6wing
 
 fl.Env.dev.active()
+fl.UserConfig.set_profile("dev")
 
-mail1 = fl.MyCases()[0].info.userEmail
-
-fl.Accounts.shared_account_info()
-
-fl.Accounts.choose_shared_account("maciej@flexcompute.com")
+# choose shared account interactively
+fl.Accounts.choose_shared_account()
 
-mail2 = fl.MyCases()[0].info.userEmail
+# retrieve mesh files
+OM6wing.get_files()
 
-fl.Accounts.shared_account_info()
+# submit mesh
+volume_mesh = fl.VolumeMesh.from_file(OM6wing.mesh_filename, name="OM6wing-mesh")
+volume_mesh = volume_mesh.submit()
 
-print(f"Email before sharing: {mail1}, email after sharing: {mail2}")
+# leave the account
+fl.Accounts.leave_shared_account()

flow360/accounts_utils.py

@@ -1,20 +1,27 @@
+"""
+This module provides utility functions for managing access between interconnected accounts.
+
+Functions:
+- choose_shared_account(None) -> None - select account from the list of client and organization accounts interactively
+- choose_shared_account(email: str, optional) -> None - select account matching the provided email (if exists)
+- shared_account_info(None) -> str - return current shared account email address (if exists, None otherwise)
+- leave_shared_account(None) -> None - leave current shared account
+"""
+
 from requests import HTTPError
 
 from flow360.cloud.http_util import http
 from flow360.environment import Env
+from flow360.log import log
 
 from .exceptions import WebError
 
-"""
-This module provides utility functions for managing access between interconnected accounts.
-
-Functions:
-- choose_account(None) -> None - select account from the list of supported and organization accounts interactively
-- choose_account(email: str, optional) -> None - select account matching the provided email (if exists)
-"""
-
 
 class AccountsUtils:
+    """
+    Current account info and utility functions.
+    """
+
     def __init__(self):
         self._current_email = None
         self._current_user_identity = None
@@ -37,11 +44,10 @@ def _interactive_selection(users):
                 )
                 if value == "q":
                     return None
-                elif int(value) in range(0, user_count):
+                if int(value) in range(0, user_count):
                     return int(value)
-                else:
-                    print(f"Value out of range [0 - {user_count - 1}]")
-                    continue
+                print(f"Value out of range [0 - {user_count - 1}]")
+                continue
             except ValueError:
                 print("Invalid input type, please input an integer value:")
                 continue
@@ -71,11 +77,32 @@ def _get_company_users():
         except HTTPError as error:
             raise WebError("Failed to retrieve company user data from server") from error
 
+    def _check_state_consistency(self):
+        if Env.impersonate != self._current_user_identity:
+            log.warning(
+                (
+                    f"Environment impersonation ({Env.impersonate}) does "
+                    f"not match current account ({self._current_user_identity}), "
+                    "this may be caused by explicit modification of impersonation "
+                    "in the environment, use choose_shared_account() instead."
+                )
+            )
+            self._current_email = None
+            self._current_user_identity = None
+
     def choose_shared_account(self, email=None):
+        """choose a shared account to impersonate
+
+        Parameters
+        ----------
+        email : str, optional
+           user email to impersonate (if email exists among shared accounts),
+           if email is not provided user can select the account interactively
+        """
         company_users = self._get_company_users()
 
         if len(company_users) == 0:
-            print("There are no accounts shared with the current user")
+            log.info("There are no accounts shared with the current user")
             return
 
         selected = None
@@ -99,17 +126,31 @@ def choose_shared_account(self, email=None):
         self._current_user_identity = user_id
 
     def shared_account_info(self):
-        # Impersonate has been modified from the outside, discard current state
-        if Env.impersonate != self._current_user_identity:
-            self._current_email = None
-            self._current_user_identity = None
+        """
+        retrieve current shared account name, if possible
+        """
+        self._check_state_consistency()
 
         if self._current_email is not None:
-            print(f"Currently operating as {self._current_email}")
+            log.info(f"Currently operating as {self._current_email}")
         else:
-            print("Currently not logged into a shared account")
+            log.info("Currently not logged into a shared account")
 
         return self._current_email
 
+    def leave_shared_account(self):
+        """
+        leave current shared account name, if possible
+        """
+        self._check_state_consistency()
+
+        if Env.impersonate is None:
+            log.warning("You are not currently logged into any shared account")
+        else:
+            log.info(f"Leaving shared account {self._current_email}")
+            self._current_email = None
+            self._current_user_identity = None
+            Env.impersonate = None
+
 
 Accounts = AccountsUtils()

flow360/cli/app.py

@@ -42,7 +42,26 @@ def flow360():
     is_flag=True,
     help='Whether to show warnings for "submit()" when creating new Case, new VolumeMesh etc.',
 )
-def configure(apikey, profile, suppress_submit_warning, show_submit_warning):
+@click.option(
+    "--suppress-shared-account-prompt",
+    type=bool,
+    is_flag=True,
+    help='Do not prompt for confirmation for "submit()" when creating new resources while logged into a shared account',
+)
+@click.option(
+    "--show-shared-account-prompt",
+    type=bool,
+    is_flag=True,
+    help='Always prompt for confirmation for "submit()" when creating new resources while logged into a shared account',
+)
+def configure(
+    apikey,
+    profile,
+    suppress_submit_warning,
+    show_submit_warning,
+    suppress_shared_account_prompt,
+    show_shared_account_prompt,
+):
     """
     Configure flow360.
     """
@@ -72,6 +91,19 @@ def configure(apikey, profile, suppress_submit_warning, show_submit_warning):
         config.update({"user": {"config": {"suppress_submit_warning": False}}})
         changed = True
 
+    if suppress_submit_warning and show_submit_warning:
+        raise click.ClickException(
+            "You cannot use both --suppress-shared-account-prompt AND --show-shared-account-prompt"
+        )
+
+    if suppress_shared_account_prompt:
+        config.update({"user": {"config": {"suppress_shared_account_prompt": True}}})
+        changed = True
+
+    if show_shared_account_prompt:
+        config.update({"user": {"config": {"suppress_shared_account_prompt": False}}})
+        changed = True
+
     with open(config_file, "w", encoding="utf-8") as file_handler:
         file_handler.write(toml.dumps(config))
 

flow360/component/case.py

@@ -28,7 +28,7 @@
     before_submit_only,
     is_object_cloud_resource,
 )
-from .utils import is_valid_uuid, validate_type
+from .utils import confirm_proceed, is_valid_uuid, validate_type
 from .validator import Validator
 
 
@@ -241,6 +241,9 @@ def submit(self, force_submit: bool = False) -> Case:
 
         self.validate_case_inputs(pre_submit_checks=True)
 
+        if not confirm_proceed():
+            raise FlValueError("User aborted resource submit.")
+
         volume_mesh_id = self.volume_mesh_id
         parent_id = self.parent_id
         if parent_id is not None:

flow360/component/surface_mesh.py

@@ -22,7 +22,7 @@
     Flow360ResourceListBase,
     ResourceDraft,
 )
-from .utils import validate_type
+from .utils import confirm_proceed, validate_type
 from .validator import Validator
 from .volume_mesh import VolumeMeshDraft
 
@@ -121,6 +121,9 @@ def submit(self, progress_callback=None) -> SurfaceMesh:
         if name is None:
             name = os.path.splitext(os.path.basename(self.geometry_file))[0]
 
+        if not confirm_proceed():
+            raise FlValueError("User aborted resource submit.")
+
         data = {
             "name": self.name,
             "tags": self.tags,

flow360/component/utils.py

@@ -8,10 +8,13 @@
 
 import zstandard as zstd
 
+from ..accounts_utils import Accounts
 from ..cloud.utils import _get_progress, _S3Action
+from ..error_messages import shared_submit_warning
 from ..exceptions import TypeError as FlTypeError
 from ..exceptions import ValueError as FlValueError
 from ..log import log
+from ..user_config import UserConfig
 
 
 # pylint: disable=redefined-builtin
@@ -48,6 +51,32 @@ def wrapper_func(*args, **kwargs):
     return wrapper
 
 
+def confirm_proceed():
+    """
+    Prompts confirmation from user when submitting a resource from a shared account
+    """
+    if (
+        Accounts.shared_account_info() is not None
+        and not UserConfig.is_suppress_shared_account_prompt()
+    ):
+        log.warning(shared_submit_warning)
+        print("Are you sure you want to proceed? (y/n): ")
+        while True:
+            try:
+                value = input()
+                if value.lower() == "y":
+                    return True
+                if value.lower() == "n":
+                    return False
+                print("Enter a valid value (y/n): ")
+                continue
+            except ValueError:
+                print("Invalid input type")
+                continue
+    else:
+        return True
+
+
 # pylint: disable=bare-except
 def _get_value_or_none(callable):
     try:

flow360/component/volume_mesh.py

@@ -37,7 +37,7 @@
     ResourceDraft,
 )
 from .types import COMMENTS
-from .utils import validate_type, zstd_compress
+from .utils import confirm_proceed, validate_type, zstd_compress
 from .validator import Validator
 
 try:
@@ -503,6 +503,9 @@ def submit(self, progress_callback=None) -> VolumeMesh:
             VolumeMesh object with id
         """
 
+        if not confirm_proceed():
+            raise FlValueError("User aborted resource submit.")
+
         if self.file_name is not None:
             return self._submit_upload_mesh(progress_callback)
 

flow360/error_messages.py

@@ -10,6 +10,12 @@
 """
 
 
+shared_submit_warning = """\
+You are submitting a resource from a shared account.
+To suppress this message run: flow360 configure --suppress-shared-account-prompt
+"""
+
+
 def change_solver_version_error(from_version, to_version):
     return f"""\
 Cannot change solver version from parent to child.

flow360/user_config.py

@@ -26,6 +26,7 @@ def __init__(self):
         self._check_env_apikey()
         self._do_validation = True
         self._suppress_submit_warning = None
+        self._suppress_shared_account_prompt = None
 
     def _check_env_profile(self):
         simcloud_profile = os.environ.get("SIMCLOUD_PROFILE", None)
@@ -76,14 +77,34 @@ def apikey(self):
             return self._apikey
         return self.config.get(self.profile, {}).get("apikey", "")
 
+    def suppress_shared_account_prompt(self):
+        """locally suppress warning when trying to submit from a shared account"""
+        self._suppress_shared_account_prompt = True
+
+    def show_shared_account_prompt(self):
+        """locally show warning when trying to submit from a shared account"""
+        self._suppress_shared_account_prompt = False
+
+    def is_suppress_shared_account_prompt(self):
+        """suppress shared account submit warning config
+
+        Returns
+        -------
+        bool
+            whether to suppress shared account submit warnings
+        """
+        if self._suppress_shared_account_prompt is not None:
+            return self._suppress_shared_account_prompt
+        return (
+            self.config.get("user", {})
+            .get("config", {})
+            .get("suppress_shared_account_prompt", False)
+        )
+
     def suppress_submit_warning(self):
         """locally suppress submit warning"""
         self._suppress_submit_warning = True
 
-    def cancel_local_submit_warning_settings(self):
-        """cancel local submit warning settings"""
-        self._suppress_submit_warning = None
-
     def show_submit_warning(self):
         """locally show submit warning"""
         self._suppress_submit_warning = False
@@ -100,6 +121,14 @@ def is_suppress_submit_warning(self):
             return self._suppress_submit_warning
         return self.config.get("user", {}).get("config", {}).get("suppress_submit_warning", False)
 
+    def cancel_local_submit_warning_settings(self):
+        """cancel local submit warning settings"""
+        self._suppress_submit_warning = None
+
+    def cancel_local_shared_account_prompt_settings(self):
+        """cancel local shared account submit warning settings"""
+        self._suppress_shared_account_prompt = None
+
     @property
     def do_validation(self):
         """for handling user side validation (pydantic)