maleo-foundation 0.3.71__py3-none-any.whl → 0.3.74__py3-none-any.whl

maleo_foundation/utils/exceptions/client.py

@@ -3,10 +3,12 @@ from functools import wraps
 from httpx import RequestError
 from pydantic import ValidationError
 from typing import Optional
+from uuid import UUID
 from maleo_foundation.enums import BaseEnums
 from maleo_foundation.models.transfers.results.client.service import (
     BaseClientServiceResultsTransfers,
 )
+from maleo_foundation.types import BaseTypes
 from maleo_foundation.utils.logging import BaseLogger
 
 
@@ -30,10 +32,14 @@ class BaseClientExceptions:
         fail_result_class: type[
             BaseClientServiceResultsTransfers.Fail
         ] = BaseClientServiceResultsTransfers.Fail,
+        operation_id: BaseTypes.OptionalUUID = None,
     ) -> BaseClientServiceResultsTransfers.Fail:
-        if logger:
+        if logger is not None:
+            log_string = f"{category} occurred while {summary}: '{str(e)}'"
+            if operation_id is not None:
+                log_string = f"{operation_id} - {log_string}"
             logger.error(
-                f"{category} occurred while {summary}: '{str(e)}'",
+                log_string,
                 exc_info=True,
             )
         return fail_result_class(
@@ -77,6 +83,12 @@ class BaseClientExceptions:
         def decorator(func):
             @wraps(func)
             async def wrapper(*args, **kwargs):
+                # Search for operation_id in args and kwargs
+                operation_id: BaseTypes.OptionalUUID = None
+                for k, v in kwargs.items():
+                    if k == "operation_id":
+                        operation_id = UUID(v)
+                        break
                 try:
                     return await func(*args, **kwargs)
                 except ValidationError as e:
@@ -96,6 +108,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except RequestError as e:
                     return BaseClientExceptions._exception_handler(
@@ -114,6 +127,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except Exception as e:
                     return BaseClientExceptions._exception_handler(
@@ -132,6 +146,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
 
             return wrapper
@@ -159,6 +174,12 @@ class BaseClientExceptions:
         def decorator(func):
             @wraps(func)
             def wrapper(*args, **kwargs):
+                # Search for operation_id in args and kwargs
+                operation_id: BaseTypes.OptionalUUID = None
+                for k, v in kwargs.items():
+                    if k == "operation_id":
+                        operation_id = UUID(v)
+                        break
                 try:
                     return func(*args, **kwargs)
                 except ValidationError as e:
@@ -178,6 +199,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except RequestError as e:
                     return BaseClientExceptions._exception_handler(
@@ -196,6 +218,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except Exception as e:
                     return BaseClientExceptions._exception_handler(
@@ -214,6 +237,7 @@ class BaseClientExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
 
             return wrapper

maleo_foundation/utils/exceptions/service.py

@@ -3,10 +3,12 @@ from functools import wraps
 from pydantic import ValidationError
 from sqlalchemy.exc import SQLAlchemyError
 from typing import Optional
+from uuid import UUID
 from maleo_foundation.enums import BaseEnums
 from maleo_foundation.models.transfers.results.service.general import (
     BaseServiceGeneralResultsTransfers,
 )
+from maleo_foundation.types import BaseTypes
 from maleo_foundation.utils.logging import BaseLogger
 
 
@@ -30,10 +32,14 @@ class BaseServiceExceptions:
         fail_result_class: type[
             BaseServiceGeneralResultsTransfers.Fail
         ] = BaseServiceGeneralResultsTransfers.Fail,
+        operation_id: BaseTypes.OptionalUUID = None,
     ) -> BaseServiceGeneralResultsTransfers.Fail:
-        if logger:
+        if logger is not None:
+            log_string = f"{category} occurred while {summary}: '{str(e)}'"
+            if operation_id is not None:
+                log_string = f"{operation_id} - {log_string}"
             logger.error(
-                f"{category} occurred while {summary}: '{str(e)}'",
+                log_string,
                 exc_info=True,
             )
         return fail_result_class(
@@ -77,6 +83,12 @@ class BaseServiceExceptions:
         def decorator(func):
             @wraps(func)
             async def wrapper(*args, **kwargs):
+                # Search for operation_id in args and kwargs
+                operation_id: BaseTypes.OptionalUUID = None
+                for k, v in kwargs.items():
+                    if k == "operation_id":
+                        operation_id = UUID(v)
+                        break
                 try:
                     return await func(*args, **kwargs)
                 except ValidationError as e:
@@ -96,6 +108,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except SQLAlchemyError as e:
                     return BaseServiceExceptions._exception_handler(
@@ -114,6 +127,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except Exception as e:
                     return BaseServiceExceptions._exception_handler(
@@ -132,6 +146,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
 
             return wrapper
@@ -159,6 +174,12 @@ class BaseServiceExceptions:
         def decorator(func):
             @wraps(func)
             def wrapper(*args, **kwargs):
+                # Search for operation_id in args and kwargs
+                operation_id: BaseTypes.OptionalUUID = None
+                for k, v in kwargs.items():
+                    if k == "operation_id":
+                        operation_id = UUID(v)
+                        break
                 try:
                     return func(*args, **kwargs)
                 except ValidationError as e:
@@ -178,6 +199,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except SQLAlchemyError as e:
                     return BaseServiceExceptions._exception_handler(
@@ -196,6 +218,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
                 except Exception as e:
                     return BaseServiceExceptions._exception_handler(
@@ -214,6 +237,7 @@ class BaseServiceExceptions:
                         status_update_type=status_update_type,
                         logger=logger,
                         fail_result_class=fail_result_class,
+                        operation_id=operation_id,
                     )
 
             return wrapper

maleo_foundation/utils/extractor.py

@@ -1,8 +1,40 @@
-from datetime import datetime, timezone
-from fastapi import Request
+from fastapi import Request, Security
+from fastapi.security import HTTPAuthorizationCredentials
 from starlette.requests import HTTPConnection
-from uuid import UUID, uuid4
+from uuid import UUID
+from maleo_foundation.constants import TOKEN_SCHEME
+from maleo_foundation.authentication import (
+    Credentials as RequestCredentials,
+    User as RequestUser,
+)
+from maleo_foundation.models.transfers.general.authentication import (
+    Authentication,
+    Credentials,
+    User,
+)
+from maleo_foundation.models.transfers.general.authorization import Authorization
 from maleo_foundation.models.transfers.general.request import RequestContext
+from .parser import parse_user_agent
+
+
+def extract_authentication(request: Request) -> Authentication:
+    # validate credentials
+    request_credentials = request.auth
+    if not isinstance(request_credentials, RequestCredentials):
+        raise TypeError("'credentials' is not of type 'RequestCredentials'")
+    credentials = Credentials.model_validate(request_credentials, from_attributes=True)
+    # validate user
+    request_user = request.user
+    if not isinstance(request_user, RequestUser):
+        raise TypeError("'user' is not of type 'RequestUser'")
+    user = User.model_validate(request_user, from_attributes=True)
+    return Authentication(credentials=credentials, user=user)
+
+
+def extract_authorization(
+    token: HTTPAuthorizationCredentials = Security(TOKEN_SCHEME),
+) -> Authorization:
+    return Authorization(scheme=token.scheme, credentials=token.credentials)
 
 
 def extract_client_ip(conn: HTTPConnection) -> str:
@@ -23,28 +55,26 @@ def extract_client_ip(conn: HTTPConnection) -> str:
     return conn.client.host if conn.client else "unknown"
 
 
+def extract_operation_id(request: Request) -> UUID:
+    return request.state.operation_id
+
+
 def extract_request_context(request: Request) -> RequestContext:
-    headers = request.headers
+    request_id = request.state.request_id
+    requested_at = request.state.requested_at
 
-    request_id = headers.get("x-request-id")
-    if request_id is None:
-        request_id = uuid4()
-    else:
-        request_id = UUID(request_id)
+    headers = request.headers
 
     ip_address = extract_client_ip(request)
 
-    ua_browser = headers.get("sec-ch-ua", "")
-    if ua_browser:
-        ua_browser = ua_browser.replace('"', "").split(",")[0].strip()
+    user_agent_string = headers.get("user-agent", "")
+    user_agent = parse_user_agent(user_agent_string=user_agent_string)
 
     return RequestContext(
         request_id=request_id,
-        requested_at=datetime.now(tz=timezone.utc),
+        requested_at=requested_at,
         method=request.method,
         url=request.url.path,
-        path_params=None if not request.path_params else request.path_params,
-        query_params=None if not request.query_params else str(request.query_params),
         ip_address=ip_address,
         is_internal=(
             None
@@ -55,10 +85,10 @@ def extract_request_context(request: Request) -> RequestContext:
                 or ip_address.startswith("172.")
             )
         ),
-        user_agent=headers.get("user-agent"),
-        ua_browser=ua_browser,
-        ua_mobile=headers.get("sec-ch-ua-mobile"),
-        platform=headers.get("sec-ch-ua-platform"),
+        headers=headers.items(),
+        path_params=None if not request.path_params else request.path_params,
+        query_params=None if not request.query_params else str(request.query_params),
+        user_agent=user_agent,
         referer=headers.get("referer"),
         origin=headers.get("origin"),
         host=headers.get("host"),

maleo_foundation/utils/logging.py

@@ -57,21 +57,33 @@ class SimpleConfig(BaseModel):
 class BaseLogger(logging.Logger):
     def __init__(
         self,
-        dir: str,
         type: BaseEnums.LoggerType,
-        service_key: BaseTypes.OptionalString = None,
+        dir: str,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         client_key: BaseTypes.OptionalString = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         self._type = type  # * Declare logger type
 
-        # * Ensure service_key exists
-        self._service_key = service_key or os.getenv("SERVICE_KEY")
-        if self._service_key is None:
+        # Ensure environment exists
+        actual_environment = environment or os.getenv("ENVIRONMENT")
+        if actual_environment is None:
+            raise ValueError(
+                "ENVIRONMENT environment variable must be set if 'environment' is set to None"
+            )
+        else:
+            self._environment = BaseEnums.EnvironmentType(actual_environment)
+
+        # Ensure service_key exists
+        actual_service_key = service_key or os.getenv("SERVICE_KEY")
+        if actual_service_key is None:
             raise ValueError(
                 "SERVICE_KEY environment variable must be set if 'service_key' is set to None"
             )
+        else:
+            self._service_key = BaseEnums.Service(actual_service_key)
 
         self._client_key = client_key  # * Declare client key
 
@@ -82,10 +94,11 @@ class BaseLogger(logging.Logger):
             )
 
         # * Define logger name
+        base_name = f"{self._environment} - {self._service_key} - {self._type}"
         if self._type == BaseEnums.LoggerType.CLIENT:
-            self._name = f"{self._service_key} - {self._type} - {self._client_key}"
+            self._name = f"{base_name} - {self._client_key}"
         else:
-            self._name = f"{self._service_key} - {self._type}"
+            self._name = base_name
 
         super().__init__(self._name, level)  # * Init the superclass's logger
 
@@ -111,7 +124,9 @@ class BaseLogger(logging.Logger):
             )
             self.addHandler(cloud_logging_handler)
         else:
-            self.info("Cloud logging is not configured.")
+            self.warning(
+                "Cloud logging is not configured. Will not add cloud loggin handler"
+            )
 
         # * Define log directory
         if self._type == BaseEnums.LoggerType.CLIENT:
@@ -164,13 +179,15 @@ class ApplicationLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         super().__init__(
-            dir=dir,
             type=BaseEnums.LoggerType.APPLICATION,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,
@@ -182,13 +199,15 @@ class CacheLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         super().__init__(
             dir=dir,
             type=BaseEnums.LoggerType.CACHE,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,
@@ -201,13 +220,15 @@ class ClientLogger(BaseLogger):
         self,
         dir: str,
         client_key: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         super().__init__(
-            dir=dir,
             type=BaseEnums.LoggerType.CLIENT,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=client_key,
             level=level,
@@ -215,17 +236,39 @@ class ClientLogger(BaseLogger):
         )
 
 
+class ControllerLogger(BaseLogger):
+    def __init__(
+        self,
+        dir: str,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
+        level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging: Optional[GoogleCloudLogging] = None,
+    ):
+        super().__init__(
+            dir=dir,
+            type=BaseEnums.LoggerType.CONTROLLER,
+            environment=environment,
+            service_key=service_key,
+            client_key=None,
+            level=level,
+            google_cloud_logging=google_cloud_logging,
+        )
+
+
 class DatabaseLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level=BaseEnums.LoggerLevel.INFO,
         google_cloud_logging=None,
     ):
         super().__init__(
-            dir=dir,
             type=BaseEnums.LoggerType.DATABASE,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,
@@ -237,13 +280,15 @@ class MiddlewareLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level=BaseEnums.LoggerLevel.INFO,
         google_cloud_logging=None,
     ):
         super().__init__(
-            dir=dir,
             type=BaseEnums.LoggerType.MIDDLEWARE,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,
@@ -251,17 +296,39 @@ class MiddlewareLogger(BaseLogger):
         )
 
 
-class RepositoryLogger(BaseLogger):
+class RouterLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         super().__init__(
             dir=dir,
+            type=BaseEnums.LoggerType.ROUTER,
+            environment=environment,
+            service_key=service_key,
+            client_key=None,
+            level=level,
+            google_cloud_logging=google_cloud_logging,
+        )
+
+
+class RepositoryLogger(BaseLogger):
+    def __init__(
+        self,
+        dir: str,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
+        level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
+        google_cloud_logging: Optional[GoogleCloudLogging] = None,
+    ):
+        super().__init__(
             type=BaseEnums.LoggerType.REPOSITORY,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,
@@ -273,13 +340,15 @@ class ServiceLogger(BaseLogger):
     def __init__(
         self,
         dir: str,
-        service_key: BaseTypes.OptionalString = None,
+        environment: Optional[BaseEnums.EnvironmentType] = None,
+        service_key: Optional[BaseEnums.Service] = None,
         level: BaseEnums.LoggerLevel = BaseEnums.LoggerLevel.INFO,
         google_cloud_logging: Optional[GoogleCloudLogging] = None,
     ):
         super().__init__(
-            dir=dir,
             type=BaseEnums.LoggerType.SERVICE,
+            dir=dir,
+            environment=environment,
             service_key=service_key,
             client_key=None,
             level=level,

maleo_foundation/utils/parser.py

@@ -0,0 +1,7 @@
+from user_agents.parsers import parse
+from maleo_foundation.models.transfers.general.user_agent import UserAgent
+
+
+def parse_user_agent(user_agent_string: str) -> UserAgent:
+    parsed_user_agent = parse(user_agent_string)
+    return UserAgent.model_validate(parsed_user_agent, from_attributes=True)

{maleo_foundation-0.3.71.dist-info → maleo_foundation-0.3.74.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.3.71
+Version: 0.3.74
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT
@@ -98,6 +98,8 @@ Requires-Dist: starlette>=0.46.2
 Requires-Dist: twine>=6.1.0
 Requires-Dist: typing-inspection>=0.4.0
 Requires-Dist: typing_extensions>=4.13.2
+Requires-Dist: ua-parser>=1.0.1
+Requires-Dist: ua-parser-builtins>=0.18.0.post1
 Requires-Dist: urllib3>=2.4.0
 Requires-Dist: uvicorn>=0.34.2
 Requires-Dist: virtualenv>=20.31.2