User UUID to use the designated column instead (#4299)

* token generation on the terminal * revoke and show commands * uuid on the right column * adding logs to the account commands * login info at this point does not make sense anymore * get_user_uuid function * log formatter to use get_user_uuid function * ruff + black * fix tests * fix tests --------- Co-authored-by: James Maslek <[email protected]>
OpenBB-finance · Feb 22, 2023 · a054e5d · a054e5d
1 parent 2079649
commit a054e5d
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 48 deletions.
diff --git a/openbb_terminal/core/library/operation.py b/openbb_terminal/core/library/operation.py
@@ -7,7 +7,6 @@
 import openbb_terminal.config_terminal as cfg
 from openbb_terminal.core.library.metadata import Metadata
 from openbb_terminal.core.library.trail_map import TrailMap
-from openbb_terminal.session.sdk_session import login
 
 # pylint: disable=import-outside-toplevel
 
@@ -249,9 +248,6 @@ def log_after_call(
                 method_result=method_result,
                 method_chosen=self.__method_chosen,
             )
-            self.__log_if_login(
-                method_chosen=self.__method_chosen,
-            )
             self.__log_end(
                 logger=logger,
                 method_chosen=self.__method_chosen,
@@ -275,17 +271,6 @@ def __log_exception_if_any(
                 extra={"func_name_override": method_chosen.__name__},
             )
 
-    @staticmethod
-    def __log_if_login(
-        method_chosen: Callable,
-    ):
-        if method_chosen.__name__ == login.__name__:
-            from openbb_terminal.core.log.generation.user_logger import (  # pylint: disable=import-outside-toplevel
-                log_user,
-            )
-
-            log_user(with_rollover=False)
-
     @staticmethod
     def __log_end(logger: Logger, method_chosen: Callable):
         logger.info(

diff --git a/openbb_terminal/core/log/generation/custom_logger.py b/openbb_terminal/core/log/generation/custom_logger.py
@@ -1,7 +1,7 @@
 # IMPORTATION STANDARD
 import logging
 
-from openbb_terminal.core.log.generation import settings_logger, user_logger
+from openbb_terminal.core.log.generation import settings_logger
 from openbb_terminal.core.log.generation.common import do_rollover
 
 # IMPORTATION THIRDPARTY
@@ -19,5 +19,4 @@ def log_terminal(test_mode: bool):
 
     logger.info("START")
     settings_logger.log_all_settings(with_rollover=False)
-    user_logger.log_user(with_rollover=False)
     do_rollover()
diff --git a/openbb_terminal/core/log/generation/formatter_with_exceptions.py b/openbb_terminal/core/log/generation/formatter_with_exceptions.py
@@ -6,6 +6,7 @@
 # IMPORTATION INTERNAL
 from openbb_terminal.core.config.paths import HOME_DIRECTORY
 from openbb_terminal.core.log.generation.settings import AppSettings
+from openbb_terminal.core.log.generation.user_logger import get_user_uuid
 
 
 class FormatterWithExceptions(logging.Formatter):
@@ -36,8 +37,6 @@ def extract_log_extra(record: logging.LogRecord):
             record.funcName = record.func_name_override  # type: ignore
             record.lineno = 0
 
-        log_extra["userId"] = getattr(record, "user_id", "NA")
-
         if hasattr(record, "session_id"):
             log_extra["sessionId"] = record.session_id  # type: ignore
 
@@ -149,7 +148,9 @@ def format(self, record: logging.LogRecord) -> str:
             "appId": app_settings.identifier,
             "sessionId": app_settings.session_id,
             "commitHash": app_settings.commit_hash,
+            "userId": get_user_uuid(),
         }
+
         log_extra = self.extract_log_extra(record=record)
         log_prefix_content = {**log_prefix_content, **log_extra}
         log_prefix = self.LOGPREFIXFORMAT % log_prefix_content

diff --git a/openbb_terminal/core/log/generation/settings.py b/openbb_terminal/core/log/generation/settings.py
@@ -42,25 +42,36 @@ def identifier(self) -> str:
     def session_id(self) -> str:
         return self.__session_id
 
+    @property
+    def user_id(self) -> str:
+        return self.__user_id
+
+    @user_id.setter
+    def user_id(self, value: str):
+        self.__user_id = value
+
     def __init__(
         self,
         name: str,
         commit_hash: str,
         session_id: str,
         identifier: str,
+        user_id: str,
     ):
         """
         Args:
             name (str): Source of the application.
             commit_hash (str): Commit hash of the current running code.
             identifier (str): Unique key identifying a particular installation.
             session_id (str): Key identifying a particular running session.
+            user_id (str): Hash identifying a particular user.
         """
 
         self.__name = name
         self.__commit_hash = commit_hash
         self.__identifier = identifier
         self.__session_id = session_id
+        self.__user_id = user_id
 
 
 class LogSettings:

diff --git a/openbb_terminal/core/log/generation/user_logger.py b/openbb_terminal/core/log/generation/user_logger.py
@@ -1,26 +1,19 @@
 # IMPORTATION STANDARD
-import json
 import logging
 
-from openbb_terminal.core.log.generation.common import do_rollover
-
 # IMPORTATION THIRDPARTY
 # IMPORTATION INTERNAL
 from openbb_terminal.session.user import User
 
 logger = logging.getLogger(__name__)
 
+NO_USER_PLACEHOLDER = "NA"
 
-def log_user(with_rollover: bool = True):
-    """Log user"""
-    if not User.is_guest():
-        _log_user_info()
 
-    if with_rollover:
-        do_rollover()
+def get_user_uuid() -> str:
+    """Get user UUID"""
 
+    if not User.is_guest():
+        return User.get_uuid()
 
-def _log_user_info():
-    """Log user info"""
-    user_info = {"user_uuid": User.get_uuid()}
-    logger.info("USER: %s ", json.dumps(user_info))
+    return NO_USER_PLACEHOLDER
diff --git a/openbb_terminal/loggers.py b/openbb_terminal/loggers.py
@@ -40,6 +40,7 @@
     LogSettings,
     Settings,
 )
+from openbb_terminal.core.log.generation.user_logger import get_user_uuid
 
 logging.getLogger("requests").setLevel(LOGGING_VERBOSITY)
 logging.getLogger("urllib3").setLevel(LOGGING_VERBOSITY)
@@ -166,6 +167,7 @@ def setup_logging(
     name = app_name or LOGGING_APP_NAME
     identifier = get_app_id()
     session_id = session_id or str(START_TIMESTAMP)
+    user_id = get_user_uuid()
 
     # AWSSettings
     aws_access_key_id = LOGGING_AWS_ACCESS_KEY_ID
@@ -184,6 +186,7 @@ def setup_logging(
             name=name,
             identifier=identifier,
             session_id=session_id,
+            user_id=user_id,
         ),
         aws_settings=AWSSettings(
             aws_access_key_id=aws_access_key_id,

diff --git a/openbb_terminal/sdk_core/sdk_helpers.py b/openbb_terminal/sdk_core/sdk_helpers.py
@@ -16,7 +16,6 @@
     OPTIMIZATION_TOOLKIT_ENABLED,
     OPTIMIZATION_TOOLKIT_WARNING,
 )
-from openbb_terminal.session.sdk_session import login
 
 if not FORECASTING_TOOLKIT_ENABLED and not load_env_vars(
     "OPENBB_DISABLE_FORECASTING_WARNING", strtobool, False
@@ -279,9 +278,6 @@ def log_after_call(
                 method_result=method_result,
                 method_chosen=self.__method_chosen,
             )
-            self.__log_if_login(
-                method_chosen=self.__method_chosen,
-            )
             self.__log_end(
                 logger=logger,
                 method_chosen=self.__method_chosen,
@@ -305,17 +301,6 @@ def __log_exception_if_any(
                 extra={"func_name_override": method_chosen.__name__},
             )
 
-    @staticmethod
-    def __log_if_login(
-        method_chosen: Callable,
-    ):
-        if method_chosen.__name__ == login.__name__:
-            from openbb_terminal.core.log.generation.user_logger import (  # pylint: disable=import-outside-toplevel
-                log_user,
-            )
-
-            log_user(with_rollover=False)
-
     @staticmethod
     def __log_end(logger: Logger, method_chosen: Callable):
         logger.info(

diff --git a/openbb_terminal/session/sdk_session.py b/openbb_terminal/session/sdk_session.py
@@ -1,10 +1,15 @@
+import logging
+
+from openbb_terminal.decorators import log_start_end
 from openbb_terminal.rich_config import console
 from openbb_terminal.session import (
     local_model as Local,
     session_model,
 )
 from openbb_terminal.session.user import User
 
+logger = logging.getLogger(__name__)
+
 
 def get_session(email: str, password: str, token: str, save: bool):
     session = ""
@@ -23,6 +28,7 @@ def get_session(email: str, password: str, token: str, save: bool):
     return session
 
 
+@log_start_end(log=logger)
 def login(
     email: str = "", password: str = "", token: str = "", keep_session: bool = False
 ):
@@ -65,6 +71,7 @@ def login(
     console.print("[green]Login successful.[/green]")
 
 
+@log_start_end(log=logger)
 def logout():
     """
     Logout and clear session.
@@ -81,6 +88,7 @@ def logout():
     )
 
 
+@log_start_end(log=logger)
 def whoami():
     """
     Display user info.

diff --git a/tests/openbb_terminal/core/log/conftest.py b/tests/openbb_terminal/core/log/conftest.py
@@ -16,6 +16,7 @@ def settings(tmp_path):
             name="MOCK_NAME",
             identifier="MOCK_IDENTIFIER",
             session_id="MOCK_SESSION_ID",
+            user_id="MOCK_USER_ID",
         ),
         aws_settings=AWSSettings(
             aws_access_key_id="MOCK_AWS_ACCESS_KEY_ID",

diff --git a/...minal/core/log/generation/json/test_formatter_with_exceptions/test_extract_log_extra.json b/...minal/core/log/generation/json/test_formatter_with_exceptions/test_extract_log_extra.json
@@ -1 +1 @@
-{"userId": "MOCK_USER_ID", "sessionId": "MOCK_SESSION_ID"}
+{"sessionId": "MOCK_SESSION_ID"}
diff --git a/tests/openbb_terminal/core/log/generation/test_formatter_with_exceptions.py b/tests/openbb_terminal/core/log/generation/test_formatter_with_exceptions.py
@@ -14,6 +14,7 @@
     name="MOCK_COMMIT_HASH",
     identifier="MOCK_COMMIT_HASH",
     session_id="MOCK_SESSION_ID",
+    user_id="MOCK_USER_ID",
 )
 formatter = FormatterWithExceptions(app_settings)
 

diff --git a/tests/openbb_terminal/core/log/generation/test_settings.py b/tests/openbb_terminal/core/log/generation/test_settings.py
@@ -24,12 +24,14 @@ def test_app_settings():
     commit_hash = "MOCK_COMMIT_HASH"
     session_id = "MOCK_SESSION_ID"
     identifier = "MOCK_IDENTIFIER"
+    user_id = "MOCK_USER_ID"
 
     app_settings = AppSettings(
         name=name,
         commit_hash=commit_hash,
         session_id=session_id,
         identifier=identifier,
+        user_id=user_id,
     )
 
     assert app_settings.name == name
@@ -78,11 +80,13 @@ def test_settings(tmp_path):
     commit_hash = "MOCK_COMMIT_HASH"
     session_id = "MOCK_SESSION_ID"
     identifier = "MOCK_IDENTIFIER"
+    user_id = "MOCK_USER_ID"
     app_settings = AppSettings(
         name=name,
         commit_hash=commit_hash,
         session_id=session_id,
         identifier=identifier,
+        user_id=user_id,
     )
 
     aws_access_key_id = "MOCK_AWS_ACCESS_KEY_ID"

diff --git a/tests/openbb_terminal/test_loggers.py b/tests/openbb_terminal/test_loggers.py
@@ -16,6 +16,7 @@
         name="MOCK_COMMIT_HASH",
         identifier="MOCK_COMMIT_HASH",
         session_id="MOCK_SESSION_ID",
+        user_id="MOCK_USER_ID",
     ),
     aws_settings=AWSSettings(
         aws_access_key_id="MOCK_AWS_ACCESS_KEY_ID",
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"userId": "MOCK_USER_ID", "sessionId": "MOCK_SESSION_ID"}
		{"sessionId": "MOCK_SESSION_ID"}