Added structured and wrapped logger #187

src/cpl-auth/cpl/auth/auth_logger.py

@@ -1,8 +1,8 @@
-from cpl.core.log import Logger
-from cpl.core.typing import Source
+from cpl.core.log import LoggerABC
+from cpl.core.log.wrapped_logger import WrappedLogger
 
 
-class AuthLogger(Logger):
+class AuthLogger(WrappedLogger):
 
-    def __init__(self, source: Source):
-        Logger.__init__(self, source, "auth")
+    def __init__(self, logger: LoggerABC):
+        WrappedLogger.__init__(self, logger)

src/cpl-auth/cpl/auth/keycloak/keycloak_admin.py

@@ -3,13 +3,11 @@ from keycloak import KeycloakAdmin as _KeycloakAdmin, KeycloakOpenIDConnection
 from cpl.auth.auth_logger import AuthLogger
 from cpl.auth.keycloak_settings import KeycloakSettings
 
-_logger = AuthLogger("keycloak")
-
 
 class KeycloakAdmin(_KeycloakAdmin):
 
-    def __init__(self, settings: KeycloakSettings):
-        _logger.info("Initializing Keycloak admin")
+    def __init__(self, logger: AuthLogger, settings: KeycloakSettings):
+        logger.info("Initializing Keycloak admin")
         _connection = KeycloakOpenIDConnection(
             server_url=settings.url,
             client_id=settings.client_id,

src/cpl-auth/cpl/auth/keycloak/keycloak_client.py

@@ -5,12 +5,10 @@ from keycloak import KeycloakOpenID
 from cpl.auth.auth_logger import AuthLogger
 from cpl.auth.keycloak_settings import KeycloakSettings
 
-_logger = AuthLogger("keycloak")
-
 
 class KeycloakClient(KeycloakOpenID):
 
-    def __init__(self, settings: KeycloakSettings):
+    def __init__(self, logger: AuthLogger, settings: KeycloakSettings):
         KeycloakOpenID.__init__(
             self,
             server_url=settings.url,
@@ -18,7 +16,7 @@ class KeycloakClient(KeycloakOpenID):
             realm_name=settings.realm,
             client_secret_key=settings.client_secret,
         )
-        _logger.info("Initializing Keycloak client")
+        logger.info("Initializing Keycloak client")
 
     def get_user_id(self, token: str) -> Optional[str]:
         info = self.introspect(token)

src/cpl-auth/cpl/auth/permission_seeder.py

@@ -16,12 +16,11 @@ from cpl.core.utils.get_value import get_value
 from cpl.database.abc.data_seeder_abc import DataSeederABC
 from cpl.database.db_logger import DBLogger
 
-_logger = DBLogger(__name__)
-
 
 class PermissionSeeder(DataSeederABC):
     def __init__(
         self,
+        logger: DBLogger,
         permission_dao: PermissionDao,
         role_dao: RoleDao,
         role_permission_dao: RolePermissionDao,
@@ -29,6 +28,7 @@ class PermissionSeeder(DataSeederABC):
         api_key_permission_dao: ApiKeyPermissionDao,
     ):
         DataSeederABC.__init__(self)
+        self._logger = logger
         self._permission_dao = permission_dao
         self._role_dao = role_dao
         self._role_permission_dao = role_permission_dao
@@ -40,7 +40,7 @@ class PermissionSeeder(DataSeederABC):
         possible_permissions = [permission for permission in PermissionsRegistry.get()]
 
         if len(permissions) == len(possible_permissions):
-            _logger.info("Permissions already existing")
+            self._logger.info("Permissions already existing")
             await self._update_missing_descriptions()
             return
 
@@ -53,7 +53,7 @@ class PermissionSeeder(DataSeederABC):
 
         await self._permission_dao.delete_many(to_delete, hard_delete=True)
 
-        _logger.warning("Permissions incomplete")
+        self._logger.warning("Permissions incomplete")
         permission_names = [permission.name for permission in permissions]
         await self._permission_dao.create_many(
             [

src/cpl-auth/cpl/auth/schema/_administration/api_key_dao.py

@@ -3,15 +3,12 @@ from typing import Optional
 from cpl.auth.schema._administration.api_key import ApiKey
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class ApiKeyDao(DbModelDaoABC[ApiKey]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, ApiKey, TableManager.get("api_keys"))
+        DbModelDaoABC.__init__(self, ApiKey, TableManager.get("api_keys"))
 
         self.attribute(ApiKey.identifier, str)
         self.attribute(ApiKey.key, str, "keystring")

src/cpl-auth/cpl/auth/schema/_administration/auth_user.py

@@ -6,14 +6,12 @@ from async_property import async_property
 from keycloak import KeycloakGetError
 
 from cpl.auth.keycloak import KeycloakAdmin
-from cpl.auth.auth_logger import AuthLogger
 from cpl.auth.permission.permissions import Permissions
 from cpl.core.typing import SerialId
 from cpl.database.abc import DbModelABC
+from cpl.database.db_logger import DBLogger
 from cpl.dependency import ServiceProviderABC
 
-_logger = AuthLogger(__name__)
-
 
 class AuthUser(DbModelABC):
     def __init__(
@@ -43,7 +41,8 @@ class AuthUser(DbModelABC):
         except KeycloakGetError as e:
             return "UNKNOWN"
         except Exception as e:
-            _logger.error(f"Failed to get user {self._keycloak_id} from Keycloak", e)
+            logger = ServiceProviderABC.get_global_service(DBLogger)
+            logger.error(f"Failed to get user {self._keycloak_id} from Keycloak", e)
             return "UNKNOWN"
 
     @property
@@ -57,7 +56,8 @@ class AuthUser(DbModelABC):
         except KeycloakGetError as e:
             return "UNKNOWN"
         except Exception as e:
-            _logger.error(f"Failed to get user {self._keycloak_id} from Keycloak", e)
+            logger = ServiceProviderABC.get_global_service(DBLogger)
+            logger.error(f"Failed to get user {self._keycloak_id} from Keycloak", e)
             return "UNKNOWN"
 
     @async_property

src/cpl-auth/cpl/auth/schema/_administration/auth_user_dao.py

@@ -4,17 +4,14 @@ from cpl.auth.permission.permissions import Permissions
 from cpl.auth.schema._administration.auth_user import AuthUser
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
 from cpl.database.external_data_temp_table_builder import ExternalDataTempTableBuilder
 from cpl.dependency import ServiceProviderABC
 
-_logger = DBLogger(__name__)
-
 
 class AuthUserDao(DbModelDaoABC[AuthUser]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, AuthUser, TableManager.get("auth_users"))
+        DbModelDaoABC.__init__(self, AuthUser, TableManager.get("auth_users"))
 
         self.attribute(AuthUser.keycloak_id, str, db_name="keycloakId")
 

src/cpl-auth/cpl/auth/schema/_permission/api_key_permission_dao.py

@@ -1,15 +1,12 @@
 from cpl.auth.schema._permission.api_key_permission import ApiKeyPermission
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class ApiKeyPermissionDao(DbModelDaoABC[ApiKeyPermission]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, ApiKeyPermission, TableManager.get("api_key_permissions"))
+        DbModelDaoABC.__init__(self, ApiKeyPermission, TableManager.get("api_key_permissions"))
 
         self.attribute(ApiKeyPermission.api_key_id, int)
         self.attribute(ApiKeyPermission.permission_id, int)

src/cpl-auth/cpl/auth/schema/_permission/permission_dao.py

@@ -3,15 +3,12 @@ from typing import Optional
 from cpl.auth.schema._permission.permission import Permission
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class PermissionDao(DbModelDaoABC[Permission]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, Permission, TableManager.get("permissions"))
+        DbModelDaoABC.__init__(self, Permission, TableManager.get("permissions"))
 
         self.attribute(Permission.name, str)
         self.attribute(Permission.description, Optional[str])

src/cpl-auth/cpl/auth/schema/_permission/role_dao.py

@@ -1,14 +1,11 @@
 from cpl.auth.schema._permission.role import Role
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class RoleDao(DbModelDaoABC[Role]):
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, Role, TableManager.get("roles"))
+        DbModelDaoABC.__init__(self, Role, TableManager.get("roles"))
         self.attribute(Role.name, str)
         self.attribute(Role.description, str)
 

src/cpl-auth/cpl/auth/schema/_permission/role_permission_dao.py

@@ -1,15 +1,12 @@
 from cpl.auth.schema._permission.role_permission import RolePermission
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class RolePermissionDao(DbModelDaoABC[RolePermission]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, RolePermission, TableManager.get("role_permissions"))
+        DbModelDaoABC.__init__(self, RolePermission, TableManager.get("role_permissions"))
 
         self.attribute(RolePermission.role_id, int)
         self.attribute(RolePermission.permission_id, int)

src/cpl-auth/cpl/auth/schema/_permission/role_user_dao.py

@@ -1,15 +1,12 @@
 from cpl.auth.schema._permission.role_user import RoleUser
 from cpl.database import TableManager
 from cpl.database.abc import DbModelDaoABC
-from cpl.database.db_logger import DBLogger
-
-_logger = DBLogger(__name__)
 
 
 class RoleUserDao(DbModelDaoABC[RoleUser]):
 
     def __init__(self):
-        DbModelDaoABC.__init__(self, __name__, RoleUser, TableManager.get("role_users"))
+        DbModelDaoABC.__init__(self, RoleUser, TableManager.get("role_users"))
 
         self.attribute(RoleUser.role_id, int)
         self.attribute(RoleUser.user_id, int)