Compare commits
4 Commits
2025.09.19
...
2025.09.21
| Author | SHA1 | Date | |
|---|---|---|---|
| 6de4f3c03a | |||
| ea3055527c | |||
| 7b37748ca6 | |||
| 073b35f71a |
@@ -0,0 +1,20 @@
|
|||||||
|
from cpl.dependency.service_collection import ServiceCollection as _ServiceCollection
|
||||||
|
|
||||||
|
def add_api(collection: _ServiceCollection):
|
||||||
|
try:
|
||||||
|
from cpl.database import mysql
|
||||||
|
collection.add_module(mysql)
|
||||||
|
except ImportError as e:
|
||||||
|
from cpl.core.errors import dependency_error
|
||||||
|
dependency_error("cpl-database", e)
|
||||||
|
|
||||||
|
try:
|
||||||
|
from cpl import auth
|
||||||
|
from cpl.auth import permission
|
||||||
|
collection.add_module(auth)
|
||||||
|
collection.add_module(permission)
|
||||||
|
except ImportError as e:
|
||||||
|
from cpl.core.errors import dependency_error
|
||||||
|
dependency_error("cpl-auth", e)
|
||||||
|
|
||||||
|
_ServiceCollection.with_module(add_api, __name__)
|
||||||
0
src/cpl-api/cpl/api/abc/__init__.py
Normal file
0
src/cpl-api/cpl/api/abc/__init__.py
Normal file
15
src/cpl-api/cpl/api/abc/asgi_middleware_abc.py
Normal file
15
src/cpl-api/cpl/api/abc/asgi_middleware_abc.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
|
||||||
|
from starlette.types import Scope, Receive, Send
|
||||||
|
|
||||||
|
|
||||||
|
class ASGIMiddleware(ABC):
|
||||||
|
@abstractmethod
|
||||||
|
def __init__(self, app):
|
||||||
|
self._app = app
|
||||||
|
|
||||||
|
def _call_next(self, scope: Scope, receive: Receive, send: Send):
|
||||||
|
return self._app(scope, receive, send)
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def __call__(self, scope: Scope, receive: Receive, send: Send): ...
|
||||||
@@ -1,11 +1,17 @@
|
|||||||
from http.client import HTTPException
|
from http.client import HTTPException
|
||||||
|
|
||||||
from starlette.responses import JSONResponse
|
from starlette.responses import JSONResponse
|
||||||
|
from starlette.types import Scope, Receive, Send
|
||||||
|
|
||||||
|
|
||||||
class APIError(HTTPException):
|
class APIError(HTTPException):
|
||||||
status_code = 500
|
status_code = 500
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
async def asgi_response(cls, scope: Scope, receive: Receive, send: Send):
|
||||||
|
r = JSONResponse({"error": cls.__name__}, status_code=cls.status_code)
|
||||||
|
return await r(scope, receive, send)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def response(cls):
|
def response(cls):
|
||||||
return JSONResponse({"error": cls.__name__}, status_code=cls.status_code)
|
return JSONResponse({"error": cls.__name__}, status_code=cls.status_code)
|
||||||
|
|||||||
@@ -1,49 +1,76 @@
|
|||||||
from keycloak import KeycloakAuthenticationError
|
from keycloak import KeycloakAuthenticationError
|
||||||
from starlette.middleware.base import BaseHTTPMiddleware
|
from starlette.types import Scope, Receive, Send
|
||||||
from starlette.requests import Request
|
|
||||||
|
|
||||||
|
from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
|
||||||
from cpl.api.api_logger import APILogger
|
from cpl.api.api_logger import APILogger
|
||||||
from cpl.api.error import Unauthorized
|
from cpl.api.error import Unauthorized
|
||||||
|
from cpl.api.middleware.request import get_request
|
||||||
from cpl.api.router import Router
|
from cpl.api.router import Router
|
||||||
from cpl.auth.keycloak import KeycloakClient
|
from cpl.auth.keycloak import KeycloakClient
|
||||||
|
from cpl.auth.schema import AuthUserDao, AuthUser
|
||||||
from cpl.dependency import ServiceProviderABC
|
from cpl.dependency import ServiceProviderABC
|
||||||
|
|
||||||
_logger = APILogger(__name__)
|
_logger = APILogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class AuthenticationMiddleware(BaseHTTPMiddleware):
|
class AuthenticationMiddleware(ASGIMiddleware):
|
||||||
|
|
||||||
@classmethod
|
@ServiceProviderABC.inject
|
||||||
async def _verify_login(cls, token: str) -> bool:
|
def __init__(self, app, keycloak: KeycloakClient, user_dao: AuthUserDao):
|
||||||
keycloak = ServiceProviderABC.get_global_service(KeycloakClient)
|
ASGIMiddleware.__init__(self, app)
|
||||||
try:
|
|
||||||
user_info = keycloak.userinfo(token)
|
|
||||||
if not user_info:
|
|
||||||
return False
|
|
||||||
except KeycloakAuthenticationError:
|
|
||||||
return False
|
|
||||||
return True
|
|
||||||
|
|
||||||
async def dispatch(self, request: Request, call_next):
|
self._keycloak = keycloak
|
||||||
|
self._user_dao = user_dao
|
||||||
|
|
||||||
|
async def __call__(self, scope: Scope, receive: Receive, send: Send):
|
||||||
|
request = get_request()
|
||||||
url = request.url.path
|
url = request.url.path
|
||||||
|
|
||||||
if url not in Router.get_auth_required_routes():
|
if url not in Router.get_auth_required_routes():
|
||||||
_logger.trace(f"No authentication required for {url}")
|
_logger.trace(f"No authentication required for {url}")
|
||||||
return await call_next(request)
|
return await self._app(scope, receive, send)
|
||||||
|
|
||||||
if not request.headers.get("Authorization"):
|
if not request.headers.get("Authorization"):
|
||||||
_logger.debug(f"Unauthorized access to {url}, missing Authorization header")
|
_logger.debug(f"Unauthorized access to {url}, missing Authorization header")
|
||||||
return Unauthorized(f"Missing header Authorization").response()
|
return await Unauthorized(f"Missing header Authorization").asgi_response(scope, receive, send)
|
||||||
|
|
||||||
|
|
||||||
auth_header = request.headers.get("Authorization", None)
|
auth_header = request.headers.get("Authorization", None)
|
||||||
if not auth_header or not auth_header.startswith("Bearer "):
|
if not auth_header or not auth_header.startswith("Bearer "):
|
||||||
return Unauthorized("Invalid Authorization header").response()
|
return await Unauthorized("Invalid Authorization header").asgi_response(scope, receive, send)
|
||||||
|
|
||||||
if not await self._verify_login(auth_header.split("Bearer ")[1]):
|
token = auth_header.split("Bearer ")[1]
|
||||||
|
if not await self._verify_login(token):
|
||||||
_logger.debug(f"Unauthorized access to {url}, invalid token")
|
_logger.debug(f"Unauthorized access to {url}, invalid token")
|
||||||
return Unauthorized("Invalid token").response()
|
return await Unauthorized("Invalid token").asgi_response(scope, receive, send)
|
||||||
|
|
||||||
# check user exists in db, if not create
|
# check user exists in db, if not create
|
||||||
# unauthorized if user is deleted
|
keycloak_id = self._keycloak.get_user_id(token)
|
||||||
return await call_next(request)
|
if keycloak_id is None:
|
||||||
|
return await Unauthorized("Failed to get user id from token").asgi_response(scope, receive, send)
|
||||||
|
|
||||||
|
user = await self._get_or_crate_user(keycloak_id)
|
||||||
|
if user.deleted:
|
||||||
|
_logger.debug(f"Unauthorized access to {url}, user is deleted")
|
||||||
|
return await Unauthorized("User is deleted").asgi_response(scope, receive, send)
|
||||||
|
|
||||||
|
return await self._call_next(scope, receive, send)
|
||||||
|
|
||||||
|
async def _get_or_crate_user(self, keycloak_id: str) -> AuthUser:
|
||||||
|
existing = await self._user_dao.find_by_keycloak_id(keycloak_id)
|
||||||
|
if existing is not None:
|
||||||
|
return existing
|
||||||
|
|
||||||
|
user = AuthUser(0, keycloak_id)
|
||||||
|
uid = await self._user_dao.create(user)
|
||||||
|
return await self._user_dao.get_by_id(uid)
|
||||||
|
|
||||||
|
async def _verify_login(self, token: str) -> bool:
|
||||||
|
try:
|
||||||
|
token_info = self._keycloak.introspect(token)
|
||||||
|
return token_info.get("active", False)
|
||||||
|
except KeycloakAuthenticationError as e:
|
||||||
|
_logger.debug(f"Keycloak authentication error: {e}")
|
||||||
|
return False
|
||||||
|
except Exception as e:
|
||||||
|
_logger.error(f"Unexpected error during token verification: {e}")
|
||||||
|
return False
|
||||||
|
|||||||
@@ -1,21 +1,43 @@
|
|||||||
import time
|
import time
|
||||||
|
|
||||||
from starlette.middleware.base import BaseHTTPMiddleware
|
|
||||||
from starlette.requests import Request
|
from starlette.requests import Request
|
||||||
from starlette.responses import Response
|
from starlette.types import Receive, Scope, Send
|
||||||
|
|
||||||
|
from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
|
||||||
from cpl.api.api_logger import APILogger
|
from cpl.api.api_logger import APILogger
|
||||||
|
from cpl.api.middleware.request import get_request
|
||||||
|
|
||||||
_logger = APILogger(__name__)
|
_logger = APILogger(__name__)
|
||||||
|
|
||||||
|
class LoggingMiddleware(ASGIMiddleware):
|
||||||
|
|
||||||
class LoggingMiddleware(BaseHTTPMiddleware):
|
def __init__(self, app):
|
||||||
async def dispatch(self, request: Request, call_next):
|
ASGIMiddleware.__init__(self, app)
|
||||||
|
|
||||||
|
async def __call__(self, scope: Scope, receive: Receive, send: Send):
|
||||||
|
if scope["type"] != "http":
|
||||||
|
await self._call_next(scope, receive, send)
|
||||||
|
return
|
||||||
|
|
||||||
|
request = get_request()
|
||||||
await self._log_request(request)
|
await self._log_request(request)
|
||||||
response = await call_next(request)
|
start_time = time.time()
|
||||||
await self._log_after_request(request, response)
|
|
||||||
|
|
||||||
return response
|
response_body = b""
|
||||||
|
status_code = 500
|
||||||
|
|
||||||
|
async def send_wrapper(message):
|
||||||
|
nonlocal response_body, status_code
|
||||||
|
if message["type"] == "http.response.start":
|
||||||
|
status_code = message["status"]
|
||||||
|
if message["type"] == "http.response.body":
|
||||||
|
response_body += message.get("body", b"")
|
||||||
|
await send(message)
|
||||||
|
|
||||||
|
await self._call_next(scope, receive, send_wrapper)
|
||||||
|
|
||||||
|
duration = (time.time() - start_time) * 1000
|
||||||
|
await self._log_after_request(request, status_code, duration)
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def _filter_relevant_headers(headers: dict) -> dict:
|
def _filter_relevant_headers(headers: dict) -> dict:
|
||||||
@@ -33,7 +55,7 @@ class LoggingMiddleware(BaseHTTPMiddleware):
|
|||||||
@classmethod
|
@classmethod
|
||||||
async def _log_request(cls, request: Request):
|
async def _log_request(cls, request: Request):
|
||||||
_logger.debug(
|
_logger.debug(
|
||||||
f"Request {request.state.request_id}: {request.method}@{request.url.path} from {request.client.host}"
|
f"Request {getattr(request.state, 'request_id', '-')}: {request.method}@{request.url.path} from {request.client.host}"
|
||||||
)
|
)
|
||||||
|
|
||||||
from cpl.core.ctx.user_context import get_user
|
from cpl.core.ctx.user_context import get_user
|
||||||
@@ -55,11 +77,10 @@ class LoggingMiddleware(BaseHTTPMiddleware):
|
|||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
_logger.trace(f"Request {request.state.request_id}: {request_info}")
|
_logger.trace(f"Request {getattr(request.state, 'request_id', '-')}: {request_info}")
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
async def _log_after_request(request: Request, response: Response):
|
async def _log_after_request(request: Request, status_code: int, duration: float):
|
||||||
duration = (time.time() - request.state.start_time) * 1000
|
|
||||||
_logger.info(
|
_logger.info(
|
||||||
f"Request finished {request.state.request_id}: {response.status_code}-{request.method}@{request.url.path} from {request.client.host} in {duration:.2f}ms"
|
f"Request finished {getattr(request.state, 'request_id', '-')}: {status_code}-{request.method}@{request.url.path} from {request.client.host} in {duration:.2f}ms"
|
||||||
)
|
)
|
||||||
@@ -3,9 +3,11 @@ from contextvars import ContextVar
|
|||||||
from typing import Optional, Union
|
from typing import Optional, Union
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from starlette.middleware.base import BaseHTTPMiddleware
|
from starlette.requests import Request
|
||||||
|
from starlette.types import Scope, Receive, Send
|
||||||
from starlette.websockets import WebSocket
|
from starlette.websockets import WebSocket
|
||||||
|
|
||||||
|
from cpl.api.abc.asgi_middleware_abc import ASGIMiddleware
|
||||||
from cpl.api.api_logger import APILogger
|
from cpl.api.api_logger import APILogger
|
||||||
from cpl.api.typing import TRequest
|
from cpl.api.typing import TRequest
|
||||||
|
|
||||||
@@ -14,35 +16,39 @@ _request_context: ContextVar[Union[TRequest, None]] = ContextVar("request", defa
|
|||||||
_logger = APILogger(__name__)
|
_logger = APILogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class RequestMiddleware(BaseHTTPMiddleware):
|
class RequestMiddleware(ASGIMiddleware):
|
||||||
_request_token = {}
|
|
||||||
_user_token = {}
|
|
||||||
|
|
||||||
@classmethod
|
def __init__(self, app):
|
||||||
async def set_request_data(cls, request: TRequest):
|
ASGIMiddleware.__init__(self, app)
|
||||||
|
self._ctx_token = None
|
||||||
|
|
||||||
|
async def __call__(self, scope: Scope, receive: Receive, send: Send):
|
||||||
|
request = Request(scope, receive, send)
|
||||||
|
await self.set_request_data(request)
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self._app(scope, receive, send)
|
||||||
|
finally:
|
||||||
|
await self.clean_request_data()
|
||||||
|
|
||||||
|
async def set_request_data(self, request: TRequest):
|
||||||
request.state.request_id = uuid4()
|
request.state.request_id = uuid4()
|
||||||
request.state.start_time = time.time()
|
request.state.start_time = time.time()
|
||||||
_logger.trace(f"Set new current request: {request.state.request_id}")
|
_logger.trace(f"Set new current request: {request.state.request_id}")
|
||||||
|
|
||||||
cls._request_token[request.state.request_id] = _request_context.set(request)
|
self._ctx_token = _request_context.set(request)
|
||||||
|
|
||||||
@classmethod
|
async def clean_request_data(self):
|
||||||
async def clean_request_data(cls):
|
|
||||||
request = get_request()
|
request = get_request()
|
||||||
if request is None:
|
if request is None:
|
||||||
return
|
return
|
||||||
|
|
||||||
if request.state.request_id in cls._request_token:
|
if self._ctx_token is None:
|
||||||
_request_context.reset(cls._request_token[request.state.request_id])
|
return
|
||||||
|
|
||||||
async def dispatch(self, request: TRequest, call_next):
|
_logger.trace(f"Clearing current request: {request.state.request_id}")
|
||||||
await self.set_request_data(request)
|
_request_context.reset(self._ctx_token)
|
||||||
try:
|
|
||||||
response = await call_next(request)
|
|
||||||
return response
|
|
||||||
finally:
|
|
||||||
await self.clean_request_data()
|
|
||||||
|
|
||||||
|
|
||||||
def get_request() -> Optional[Union[TRequest, WebSocket]]:
|
def get_request() -> Optional[Union[TRequest, WebSocket]]:
|
||||||
return _request_context.get()
|
return _request_context.get()
|
||||||
@@ -10,6 +10,7 @@ from starlette.responses import JSONResponse
|
|||||||
from starlette.routing import Route
|
from starlette.routing import Route
|
||||||
from starlette.types import ExceptionHandler
|
from starlette.types import ExceptionHandler
|
||||||
|
|
||||||
|
from cpl import api, auth
|
||||||
from cpl.api.api_logger import APILogger
|
from cpl.api.api_logger import APILogger
|
||||||
from cpl.api.api_settings import ApiSettings
|
from cpl.api.api_settings import ApiSettings
|
||||||
from cpl.api.error import APIError
|
from cpl.api.error import APIError
|
||||||
@@ -27,7 +28,7 @@ _logger = APILogger("API")
|
|||||||
|
|
||||||
class WebApp(ApplicationABC):
|
class WebApp(ApplicationABC):
|
||||||
def __init__(self, services: ServiceProviderABC):
|
def __init__(self, services: ServiceProviderABC):
|
||||||
super().__init__(services)
|
super().__init__(services, [auth, api])
|
||||||
self._app: Starlette | None = None
|
self._app: Starlette | None = None
|
||||||
|
|
||||||
self._api_settings = Configuration.get(ApiSettings)
|
self._api_settings = Configuration.get(ApiSettings)
|
||||||
@@ -65,6 +66,10 @@ class WebApp(ApplicationABC):
|
|||||||
_logger.debug(f"Allowed origins: {origins}")
|
_logger.debug(f"Allowed origins: {origins}")
|
||||||
return origins.split(",")
|
return origins.split(",")
|
||||||
|
|
||||||
|
def with_database(self):
|
||||||
|
self.with_migrations()
|
||||||
|
self.with_seeders()
|
||||||
|
|
||||||
def with_app(self, app: Starlette):
|
def with_app(self, app: Starlette):
|
||||||
assert app is not None, "app must not be None"
|
assert app is not None, "app must not be None"
|
||||||
assert isinstance(app, Starlette), "app must be an instance of Starlette"
|
assert isinstance(app, Starlette), "app must be an instance of Starlette"
|
||||||
@@ -131,7 +136,7 @@ class WebApp(ApplicationABC):
|
|||||||
def with_authorization(self):
|
def with_authorization(self):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def main(self):
|
async def main(self):
|
||||||
_logger.debug(f"Preparing API")
|
_logger.debug(f"Preparing API")
|
||||||
if self._app is None:
|
if self._app is None:
|
||||||
routes = [
|
routes = [
|
||||||
@@ -161,10 +166,22 @@ class WebApp(ApplicationABC):
|
|||||||
app = self._app
|
app = self._app
|
||||||
|
|
||||||
_logger.info(f"Start API on {self._api_settings.host}:{self._api_settings.port}")
|
_logger.info(f"Start API on {self._api_settings.host}:{self._api_settings.port}")
|
||||||
uvicorn.run(
|
# uvicorn.run(
|
||||||
|
# app,
|
||||||
|
# host=self._api_settings.host,
|
||||||
|
# port=self._api_settings.port,
|
||||||
|
# log_config=None,
|
||||||
|
# loop="asyncio"
|
||||||
|
# )
|
||||||
|
|
||||||
|
config = uvicorn.Config(
|
||||||
app,
|
app,
|
||||||
host=self._api_settings.host,
|
host=self._api_settings.host,
|
||||||
port=self._api_settings.port,
|
port=self._api_settings.port,
|
||||||
log_config=None,
|
log_config=None,
|
||||||
|
loop="asyncio"
|
||||||
)
|
)
|
||||||
|
server = uvicorn.Server(config)
|
||||||
|
await server.serve()
|
||||||
|
|
||||||
_logger.info("Shutdown API")
|
_logger.info("Shutdown API")
|
||||||
|
|||||||
@@ -22,8 +22,16 @@ class ApplicationABC(ABC):
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def __init__(self, services: ServiceProviderABC):
|
def __init__(self, services: ServiceProviderABC, required_modules: list[str | object] = None):
|
||||||
self._services = services
|
self._services = services
|
||||||
|
self._required_modules = [
|
||||||
|
x.__name__ if not isinstance(x, str) else x
|
||||||
|
for x in required_modules
|
||||||
|
] if required_modules else []
|
||||||
|
|
||||||
|
@property
|
||||||
|
def required_modules(self) -> list[str]:
|
||||||
|
return self._required_modules
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def extend(cls, name: str | Callable, func: Callable[[Self], Self]):
|
def extend(cls, name: str | Callable, func: Callable[[Self], Self]):
|
||||||
@@ -80,7 +88,7 @@ class ApplicationABC(ABC):
|
|||||||
try:
|
try:
|
||||||
Host.run(self.main)
|
Host.run(self.main)
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
Console.close()
|
pass
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def main(self): ...
|
def main(self): ...
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ from cpl.application.abc.application_extension_abc import ApplicationExtensionAB
|
|||||||
from cpl.application.abc.startup_abc import StartupABC
|
from cpl.application.abc.startup_abc import StartupABC
|
||||||
from cpl.application.abc.startup_extension_abc import StartupExtensionABC
|
from cpl.application.abc.startup_extension_abc import StartupExtensionABC
|
||||||
from cpl.application.host import Host
|
from cpl.application.host import Host
|
||||||
|
from cpl.core.errors import dependency_error
|
||||||
from cpl.dependency.service_collection import ServiceCollection
|
from cpl.dependency.service_collection import ServiceCollection
|
||||||
|
|
||||||
TApp = TypeVar("TApp", bound=ApplicationABC)
|
TApp = TypeVar("TApp", bound=ApplicationABC)
|
||||||
@@ -35,6 +36,18 @@ class ApplicationBuilder(Generic[TApp]):
|
|||||||
def service_provider(self):
|
def service_provider(self):
|
||||||
return self._services.build()
|
return self._services.build()
|
||||||
|
|
||||||
|
def validate_app_required_modules(self, app: ApplicationABC):
|
||||||
|
for module in app.required_modules:
|
||||||
|
if module in self._services.loaded_modules:
|
||||||
|
continue
|
||||||
|
|
||||||
|
dependency_error(
|
||||||
|
module,
|
||||||
|
ImportError(
|
||||||
|
f"Required module '{module}' for application '{app.__class__.__name__}' is not loaded. Load using 'add_module({module})' method."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
def with_startup(self, startup: Type[StartupABC]) -> "ApplicationBuilder":
|
def with_startup(self, startup: Type[StartupABC]) -> "ApplicationBuilder":
|
||||||
self._startup = startup
|
self._startup = startup
|
||||||
return self
|
return self
|
||||||
@@ -62,4 +75,6 @@ class ApplicationBuilder(Generic[TApp]):
|
|||||||
for extension in self._app_extensions:
|
for extension in self._app_extensions:
|
||||||
Host.run(extension.run, self.service_provider)
|
Host.run(extension.run, self.service_provider)
|
||||||
|
|
||||||
return self._app(self.service_provider)
|
app = self._app(self.service_provider)
|
||||||
|
self.validate_app_required_modules(app)
|
||||||
|
return app
|
||||||
|
|||||||
@@ -40,11 +40,10 @@ def _add_daos(collection: _ServiceCollection):
|
|||||||
def add_auth(collection: _ServiceCollection):
|
def add_auth(collection: _ServiceCollection):
|
||||||
import os
|
import os
|
||||||
|
|
||||||
from cpl.core.console import Console
|
|
||||||
from cpl.database.service.migration_service import MigrationService
|
|
||||||
from cpl.database.model.server_type import ServerType, ServerTypes
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
from cpl.database.service.migration_service import MigrationService
|
||||||
|
from cpl.database.model.server_type import ServerType, ServerTypes
|
||||||
|
|
||||||
collection.add_singleton(_KeycloakClient)
|
collection.add_singleton(_KeycloakClient)
|
||||||
collection.add_singleton(_KeycloakAdmin)
|
collection.add_singleton(_KeycloakAdmin)
|
||||||
|
|
||||||
@@ -59,22 +58,23 @@ def add_auth(collection: _ServiceCollection):
|
|||||||
elif ServerType.server_type == ServerTypes.MYSQL:
|
elif ServerType.server_type == ServerTypes.MYSQL:
|
||||||
migration_service.with_directory(os.path.join(os.path.dirname(os.path.realpath(__file__)), "scripts/mysql"))
|
migration_service.with_directory(os.path.join(os.path.dirname(os.path.realpath(__file__)), "scripts/mysql"))
|
||||||
except ImportError as e:
|
except ImportError as e:
|
||||||
Console.error("cpl-auth is not installed", str(e))
|
from cpl.core.console import Console
|
||||||
|
Console.error("cpl-database is not installed", str(e))
|
||||||
|
|
||||||
|
|
||||||
def add_permission(collection: _ServiceCollection):
|
def add_permission(collection: _ServiceCollection):
|
||||||
from cpl.auth.permission_seeder import PermissionSeeder
|
from .permission_seeder import PermissionSeeder
|
||||||
from cpl.database.abc.data_seeder_abc import DataSeederABC
|
from .permission.permissions_registry import PermissionsRegistry
|
||||||
from cpl.auth.permission.permissions_registry import PermissionsRegistry
|
from .permission.permissions import Permissions
|
||||||
from cpl.auth.permission.permissions import Permissions
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
from cpl.database.abc.data_seeder_abc import DataSeederABC
|
||||||
collection.add_singleton(DataSeederABC, PermissionSeeder)
|
collection.add_singleton(DataSeederABC, PermissionSeeder)
|
||||||
PermissionsRegistry.with_enum(Permissions)
|
PermissionsRegistry.with_enum(Permissions)
|
||||||
except ImportError as e:
|
except ImportError as e:
|
||||||
from cpl.core.console import Console
|
from cpl.core.console import Console
|
||||||
|
|
||||||
Console.error("cpl-auth is not installed", str(e))
|
Console.error("cpl-database is not installed", str(e))
|
||||||
|
|
||||||
|
|
||||||
_ServiceCollection.with_module(add_auth, __name__)
|
_ServiceCollection.with_module(add_auth, __name__)
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
from keycloak import KeycloakOpenID, KeycloakAdmin, KeycloakOpenIDConnection
|
from typing import Optional
|
||||||
|
|
||||||
|
from keycloak import KeycloakOpenID
|
||||||
|
|
||||||
from cpl.auth.auth_logger import AuthLogger
|
from cpl.auth.auth_logger import AuthLogger
|
||||||
from cpl.auth.keycloak_settings import KeycloakSettings
|
from cpl.auth.keycloak_settings import KeycloakSettings
|
||||||
@@ -17,10 +19,7 @@ class KeycloakClient(KeycloakOpenID):
|
|||||||
client_secret_key=settings.client_secret,
|
client_secret_key=settings.client_secret,
|
||||||
)
|
)
|
||||||
_logger.info("Initializing Keycloak client")
|
_logger.info("Initializing Keycloak client")
|
||||||
connection = KeycloakOpenIDConnection(
|
|
||||||
server_url=settings.url,
|
def get_user_id(self, token: str) -> Optional[str]:
|
||||||
client_id=settings.client_id,
|
info = self.introspect(token)
|
||||||
realm_name=settings.realm,
|
return info.get("sub", None)
|
||||||
client_secret_key=settings.client_secret,
|
|
||||||
)
|
|
||||||
self._admin = KeycloakAdmin(connection=connection)
|
|
||||||
@@ -16,7 +16,7 @@ class AuthUserDao(DbModelDaoABC[AuthUser]):
|
|||||||
def __init__(self):
|
def __init__(self):
|
||||||
DbModelDaoABC.__init__(self, __name__, AuthUser, TableManager.get("auth_users"))
|
DbModelDaoABC.__init__(self, __name__, AuthUser, TableManager.get("auth_users"))
|
||||||
|
|
||||||
self.attribute(AuthUser.keycloak_id, str, aliases=["keycloakId"])
|
self.attribute(AuthUser.keycloak_id, str, db_name="keycloakId")
|
||||||
|
|
||||||
async def get_users():
|
async def get_users():
|
||||||
return [(x.id, x.username, x.email) for x in await self.get_all()]
|
return [(x.id, x.username, x.email) for x in await self.get_all()]
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ CREATE TABLE IF NOT EXISTS administration_auth_users
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS administration_auth_users_history
|
CREATE TABLE IF NOT EXISTS administration_auth_users_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
keycloakId CHAR(36) NOT NULL,
|
keycloakId CHAR(36) NOT NULL,
|
||||||
-- for history
|
-- for history
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ CREATE TABLE IF NOT EXISTS administration_api_keys
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS administration_api_keys_history
|
CREATE TABLE IF NOT EXISTS administration_api_keys_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
identifier VARCHAR(255) NOT NULL,
|
identifier VARCHAR(255) NOT NULL,
|
||||||
keyString VARCHAR(255) NOT NULL,
|
keyString VARCHAR(255) NOT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ CREATE TABLE IF NOT EXISTS permission_permissions
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS permission_permissions_history
|
CREATE TABLE IF NOT EXISTS permission_permissions_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
name VARCHAR(255) NOT NULL,
|
name VARCHAR(255) NOT NULL,
|
||||||
description TEXT NULL,
|
description TEXT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
@@ -57,7 +57,7 @@ CREATE TABLE IF NOT EXISTS permission_roles
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS permission_roles_history
|
CREATE TABLE IF NOT EXISTS permission_roles_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
name VARCHAR(255) NOT NULL,
|
name VARCHAR(255) NOT NULL,
|
||||||
description TEXT NULL,
|
description TEXT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
@@ -103,7 +103,7 @@ CREATE TABLE IF NOT EXISTS permission_role_permissions
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS permission_role_permissions_history
|
CREATE TABLE IF NOT EXISTS permission_role_permissions_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
RoleId INT NOT NULL,
|
RoleId INT NOT NULL,
|
||||||
permissionId INT NOT NULL,
|
permissionId INT NOT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
@@ -149,7 +149,7 @@ CREATE TABLE IF NOT EXISTS permission_role_auth_users
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS permission_role_auth_users_history
|
CREATE TABLE IF NOT EXISTS permission_role_auth_users_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
RoleId INT NOT NULL,
|
RoleId INT NOT NULL,
|
||||||
UserId INT NOT NULL,
|
UserId INT NOT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ CREATE TABLE IF NOT EXISTS permission_api_key_permissions
|
|||||||
|
|
||||||
CREATE TABLE IF NOT EXISTS permission_api_key_permissions_history
|
CREATE TABLE IF NOT EXISTS permission_api_key_permissions_history
|
||||||
(
|
(
|
||||||
id INT AUTO_INCREMENT PRIMARY KEY,
|
id INT NOT NULL,
|
||||||
apiKeyId INT NOT NULL,
|
apiKeyId INT NOT NULL,
|
||||||
permissionId INT NOT NULL,
|
permissionId INT NOT NULL,
|
||||||
deleted BOOL NOT NULL,
|
deleted BOOL NOT NULL,
|
||||||
|
|||||||
@@ -130,7 +130,7 @@ class Configuration:
|
|||||||
key_name = key.__name__ if inspect.isclass(key) else key
|
key_name = key.__name__ if inspect.isclass(key) else key
|
||||||
|
|
||||||
result = cls._config.get(key_name, default)
|
result = cls._config.get(key_name, default)
|
||||||
if issubclass(key, ConfigurationModelABC) and result == default:
|
if isclass(key) and issubclass(key, ConfigurationModelABC) and result == default:
|
||||||
result = key()
|
result = key()
|
||||||
cls.set(key, result)
|
cls.set(key, result)
|
||||||
|
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ class ConfigurationModelABC(ABC):
|
|||||||
value = cast(Environment.get(env_field, str), cast_type)
|
value = cast(Environment.get(env_field, str), cast_type)
|
||||||
|
|
||||||
if value is None and required:
|
if value is None and required:
|
||||||
raise ValueError(f"{field} is required")
|
raise ValueError(f"{type(self).__name__}.{field} is required")
|
||||||
elif value is None:
|
elif value is None:
|
||||||
self._options[field] = default
|
self._options[field] = default
|
||||||
return
|
return
|
||||||
|
|||||||
15
src/cpl-core/cpl/core/errors.py
Normal file
15
src/cpl-core/cpl/core/errors.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import traceback
|
||||||
|
|
||||||
|
from cpl.core.console import Console
|
||||||
|
|
||||||
|
|
||||||
|
def dependency_error(package_name: str, e: ImportError) -> None:
|
||||||
|
Console.error(f"'{package_name}' is required to use this feature. Please install it and try again.")
|
||||||
|
tb = traceback.format_exc()
|
||||||
|
if not tb.startswith("NoneType: None"):
|
||||||
|
Console.write_line("->", tb)
|
||||||
|
|
||||||
|
elif e is not None:
|
||||||
|
Console.write_line("->", str(e))
|
||||||
|
|
||||||
|
exit(1)
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import os
|
||||||
from typing import Type
|
from typing import Type
|
||||||
|
|
||||||
from cpl.application.abc import ApplicationABC as _ApplicationABC
|
from cpl.application.abc import ApplicationABC as _ApplicationABC
|
||||||
@@ -7,13 +8,19 @@ from . import postgres as _postgres
|
|||||||
from .table_manager import TableManager
|
from .table_manager import TableManager
|
||||||
|
|
||||||
|
|
||||||
def _with_migrations(self: _ApplicationABC, *paths: list[str]) -> _ApplicationABC:
|
def _with_migrations(self: _ApplicationABC, *paths: str | list[str]) -> _ApplicationABC:
|
||||||
from cpl.application.host import Host
|
from cpl.application.host import Host
|
||||||
|
|
||||||
from cpl.database.service.migration_service import MigrationService
|
from cpl.database.service.migration_service import MigrationService
|
||||||
|
|
||||||
migration_service = self._services.get_service(MigrationService)
|
migration_service = self._services.get_service(MigrationService)
|
||||||
migration_service.with_directory("./scripts")
|
migration_service.with_directory(os.path.join(os.path.dirname(os.path.abspath(__file__)), "scripts"))
|
||||||
|
|
||||||
|
if isinstance(paths, str):
|
||||||
|
paths = [paths]
|
||||||
|
|
||||||
|
for path in paths:
|
||||||
|
migration_service.with_directory(path)
|
||||||
|
|
||||||
Host.run(migration_service.migrate)
|
Host.run(migration_service.migrate)
|
||||||
|
|
||||||
return self
|
return self
|
||||||
|
|||||||
@@ -156,13 +156,16 @@ class DataAccessObjectABC(ABC, Generic[T_DBM]):
|
|||||||
:param dict result: Result from the database
|
:param dict result: Result from the database
|
||||||
:return:
|
:return:
|
||||||
"""
|
"""
|
||||||
value_map: dict[str, T] = {}
|
value_map: dict[str, Any] = {}
|
||||||
|
db_names = self.__db_names.items()
|
||||||
|
|
||||||
for db_name, value in result.items():
|
for db_name, value in result.items():
|
||||||
# Find the attribute name corresponding to the db_name
|
# Find the attribute name corresponding to the db_name
|
||||||
attr_name = next((k for k, v in self.__db_names.items() if v == db_name), None)
|
attr_name = next((k for k, v in db_names if v == db_name), None)
|
||||||
if attr_name:
|
if not attr_name:
|
||||||
value_map[attr_name] = self._get_value_from_sql(self.__attributes[attr_name], value)
|
continue
|
||||||
|
|
||||||
|
value_map[attr_name] = self._get_value_from_sql(self.__attributes[attr_name], value)
|
||||||
|
|
||||||
return self._model_type(**value_map)
|
return self._model_type(**value_map)
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
from typing import Optional, Any
|
from typing import Optional, Any
|
||||||
|
|
||||||
import sqlparse
|
import sqlparse
|
||||||
import aiomysql
|
from mysql.connector.aio import MySQLConnectionPool
|
||||||
|
|
||||||
from cpl.core.environment import Environment
|
from cpl.core.environment import Environment
|
||||||
from cpl.database.db_logger import DBLogger
|
from cpl.database.db_logger import DBLogger
|
||||||
@@ -9,97 +9,83 @@ from cpl.database.model import DatabaseSettings
|
|||||||
|
|
||||||
_logger = DBLogger(__name__)
|
_logger = DBLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class MySQLPool:
|
class MySQLPool:
|
||||||
"""
|
|
||||||
Create a pool when connecting to MySQL, which will decrease the time spent in
|
|
||||||
requesting connection, creating connection, and closing connection.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, database_settings: DatabaseSettings):
|
def __init__(self, database_settings: DatabaseSettings):
|
||||||
self._db_settings = database_settings
|
self._dbconfig = {
|
||||||
self.pool: Optional[aiomysql.Pool] = None
|
"host": database_settings.host,
|
||||||
|
"port": database_settings.port,
|
||||||
|
"user": database_settings.user,
|
||||||
|
"password": database_settings.password,
|
||||||
|
"database": database_settings.database,
|
||||||
|
"ssl_disabled": True,
|
||||||
|
}
|
||||||
|
self._pool: Optional[MySQLConnectionPool] = None
|
||||||
|
|
||||||
async def _get_pool(self):
|
async def _get_pool(self):
|
||||||
if self.pool is None or self.pool._closed:
|
if self._pool is None:
|
||||||
|
self._pool = MySQLConnectionPool(
|
||||||
|
pool_name="mypool", pool_size=Environment.get("DB_POOL_SIZE", int, 1), **self._dbconfig
|
||||||
|
)
|
||||||
|
await self._pool.initialize_pool()
|
||||||
|
|
||||||
|
con = await self._pool.get_connection()
|
||||||
try:
|
try:
|
||||||
self.pool = await aiomysql.create_pool(
|
async with await con.cursor() as cursor:
|
||||||
host=self._db_settings.host,
|
await cursor.execute("SELECT 1")
|
||||||
port=self._db_settings.port,
|
await cursor.fetchall()
|
||||||
user=self._db_settings.user,
|
|
||||||
password=self._db_settings.password,
|
|
||||||
db=self._db_settings.database,
|
|
||||||
minsize=1,
|
|
||||||
maxsize=Environment.get("DB_POOL_SIZE", int, 1),
|
|
||||||
)
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
_logger.fatal("Failed to connect to the database", e)
|
_logger.fatal(f"Error connecting to the database: {e}")
|
||||||
raise
|
finally:
|
||||||
return self.pool
|
await con.close()
|
||||||
|
|
||||||
|
return self._pool
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
async def _exec_sql(cursor: Any, query: str, args=None, multi=True):
|
async def _exec_sql(cursor: Any, query: str, args=None, multi=True):
|
||||||
|
result = []
|
||||||
if multi:
|
if multi:
|
||||||
queries = [str(stmt).strip() for stmt in sqlparse.parse(query) if str(stmt).strip()]
|
queries = [str(stmt).strip() for stmt in sqlparse.parse(query) if str(stmt).strip()]
|
||||||
for q in queries:
|
for q in queries:
|
||||||
if q.strip() == "":
|
if q.strip() == "":
|
||||||
continue
|
continue
|
||||||
await cursor.execute(q, args)
|
await cursor.execute(q, args)
|
||||||
|
if cursor.description is not None:
|
||||||
|
result = await cursor.fetchall()
|
||||||
else:
|
else:
|
||||||
await cursor.execute(query, args)
|
await cursor.execute(query, args)
|
||||||
|
if cursor.description is not None:
|
||||||
|
result = await cursor.fetchall()
|
||||||
|
|
||||||
|
return result
|
||||||
|
|
||||||
async def execute(self, query: str, args=None, multi=True) -> list[list]:
|
async def execute(self, query: str, args=None, multi=True) -> list[list]:
|
||||||
"""
|
|
||||||
Execute a SQL statement, it could be with args and without args. The usage is
|
|
||||||
similar to the execute() function in aiomysql.
|
|
||||||
:param query: SQL clause
|
|
||||||
:param args: args needed by the SQL clause
|
|
||||||
:param multi: if the query is a multi-statement
|
|
||||||
:return: return result
|
|
||||||
"""
|
|
||||||
pool = await self._get_pool()
|
pool = await self._get_pool()
|
||||||
async with pool.acquire() as con:
|
con = await pool.get_connection()
|
||||||
async with con.cursor() as cursor:
|
try:
|
||||||
await self._exec_sql(cursor, query, args, multi)
|
async with await con.cursor() as cursor:
|
||||||
|
result = await self._exec_sql(cursor, query, args, multi)
|
||||||
await con.commit()
|
await con.commit()
|
||||||
|
return result
|
||||||
if cursor.description is not None: # Query returns rows
|
finally:
|
||||||
res = await cursor.fetchall()
|
await con.close()
|
||||||
if res is None:
|
|
||||||
return []
|
|
||||||
|
|
||||||
return [list(row) for row in res]
|
|
||||||
else:
|
|
||||||
return []
|
|
||||||
|
|
||||||
async def select(self, query: str, args=None, multi=True) -> list[str]:
|
async def select(self, query: str, args=None, multi=True) -> list[str]:
|
||||||
"""
|
|
||||||
Execute a SQL statement, it could be with args and without args. The usage is
|
|
||||||
similar to the execute() function in aiomysql.
|
|
||||||
:param query: SQL clause
|
|
||||||
:param args: args needed by the SQL clause
|
|
||||||
:param multi: if the query is a multi-statement
|
|
||||||
:return: return result
|
|
||||||
"""
|
|
||||||
pool = await self._get_pool()
|
pool = await self._get_pool()
|
||||||
async with pool.acquire() as con:
|
con = await pool.get_connection()
|
||||||
async with con.cursor() as cursor:
|
try:
|
||||||
await self._exec_sql(cursor, query, args, multi)
|
async with await con.cursor() as cursor:
|
||||||
res = await cursor.fetchall()
|
res = await self._exec_sql(cursor, query, args, multi)
|
||||||
return list(res)
|
return list(res)
|
||||||
|
finally:
|
||||||
|
await con.close()
|
||||||
|
|
||||||
async def select_map(self, query: str, args=None, multi=True) -> list[dict]:
|
async def select_map(self, query: str, args=None, multi=True) -> list[dict]:
|
||||||
"""
|
|
||||||
Execute a SQL statement, it could be with args and without args. The usage is
|
|
||||||
similar to the execute() function in aiomysql.
|
|
||||||
:param query: SQL clause
|
|
||||||
:param args: args needed by the SQL clause
|
|
||||||
:param multi: if the query is a multi-statement
|
|
||||||
:return: return result
|
|
||||||
"""
|
|
||||||
pool = await self._get_pool()
|
pool = await self._get_pool()
|
||||||
async with pool.acquire() as con:
|
con = await pool.get_connection()
|
||||||
async with con.cursor(aiomysql.DictCursor) as cursor:
|
try:
|
||||||
await self._exec_sql(cursor, query, args, multi)
|
async with await con.cursor(dictionary=True) as cursor:
|
||||||
res = await cursor.fetchall()
|
res = await self._exec_sql(cursor, query, args, multi)
|
||||||
return list(res)
|
return list(res)
|
||||||
|
finally:
|
||||||
|
await con.close()
|
||||||
|
|||||||
@@ -25,21 +25,23 @@ class PostgresPool:
|
|||||||
f"password={database_settings.password} "
|
f"password={database_settings.password} "
|
||||||
f"dbname={database_settings.database}"
|
f"dbname={database_settings.database}"
|
||||||
)
|
)
|
||||||
|
self._pool: Optional[AsyncConnectionPool] = None
|
||||||
self.pool: Optional[AsyncConnectionPool] = None
|
|
||||||
|
|
||||||
async def _get_pool(self):
|
async def _get_pool(self):
|
||||||
pool = AsyncConnectionPool(
|
if self._pool is None:
|
||||||
conninfo=self._conninfo, open=False, min_size=1, max_size=Environment.get("DB_POOL_SIZE", int, 1)
|
pool = AsyncConnectionPool(
|
||||||
)
|
conninfo=self._conninfo, open=False, min_size=1, max_size=Environment.get("DB_POOL_SIZE", int, 1)
|
||||||
await pool.open()
|
)
|
||||||
try:
|
await pool.open()
|
||||||
async with pool.connection() as con:
|
try:
|
||||||
await pool.check_connection(con)
|
async with pool.connection() as con:
|
||||||
except PoolTimeout as e:
|
await pool.check_connection(con)
|
||||||
await pool.close()
|
except PoolTimeout as e:
|
||||||
_logger.fatal(f"Failed to connect to the database", e)
|
await pool.close()
|
||||||
return pool
|
_logger.fatal(f"Failed to connect to the database", e)
|
||||||
|
self._pool = pool
|
||||||
|
|
||||||
|
return self._pool
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
async def _exec_sql(cursor: Any, query: str, args=None, multi=True):
|
async def _exec_sql(cursor: Any, query: str, args=None, multi=True):
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
from typing import Union, Type, Callable
|
from typing import Union, Type, Callable, Self
|
||||||
|
|
||||||
from cpl.core.log.logger import Logger
|
from cpl.core.log.logger import Logger
|
||||||
from cpl.core.log.logger_abc import LoggerABC
|
from cpl.core.log.logger_abc import LoggerABC
|
||||||
@@ -15,12 +15,17 @@ class ServiceCollection:
|
|||||||
_modules: dict[str, Callable] = {}
|
_modules: dict[str, Callable] = {}
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def with_module(cls, func: Callable, name: str = None):
|
def with_module(cls, func: Callable, name: str = None) -> type[Self]:
|
||||||
cls._modules[func.__name__ if name is None else name] = func
|
cls._modules[func.__name__ if name is None else name] = func
|
||||||
return cls
|
return cls
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self._service_descriptors: list[ServiceDescriptor] = []
|
self._service_descriptors: list[ServiceDescriptor] = []
|
||||||
|
self._loaded_modules: set[str] = set()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def loaded_modules(self) -> set[str]:
|
||||||
|
return self._loaded_modules
|
||||||
|
|
||||||
def _add_descriptor(self, service: Union[type, object], lifetime: ServiceLifetimeEnum, base_type: Callable = None):
|
def _add_descriptor(self, service: Union[type, object], lifetime: ServiceLifetimeEnum, base_type: Callable = None):
|
||||||
found = False
|
found = False
|
||||||
@@ -45,15 +50,15 @@ class ServiceCollection:
|
|||||||
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def add_singleton(self, service_type: T, service: Service = None):
|
def add_singleton(self, service_type: T, service: Service = None) -> Self:
|
||||||
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.singleton, service)
|
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.singleton, service)
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def add_scoped(self, service_type: T, service: Service = None):
|
def add_scoped(self, service_type: T, service: Service = None) -> Self:
|
||||||
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.scoped, service)
|
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.scoped, service)
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def add_transient(self, service_type: T, service: Service = None):
|
def add_transient(self, service_type: T, service: Service = None) -> Self:
|
||||||
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.transient, service)
|
self._add_descriptor_by_lifetime(service_type, ServiceLifetimeEnum.transient, service)
|
||||||
return self
|
return self
|
||||||
|
|
||||||
@@ -62,7 +67,7 @@ class ServiceCollection:
|
|||||||
ServiceProviderABC.set_global_provider(sp)
|
ServiceProviderABC.set_global_provider(sp)
|
||||||
return sp
|
return sp
|
||||||
|
|
||||||
def add_module(self, module: str | object):
|
def add_module(self, module: str | object) -> Self:
|
||||||
if not isinstance(module, str):
|
if not isinstance(module, str):
|
||||||
module = module.__name__
|
module = module.__name__
|
||||||
|
|
||||||
@@ -70,7 +75,10 @@ class ServiceCollection:
|
|||||||
raise ValueError(f"Module {module} not found")
|
raise ValueError(f"Module {module} not found")
|
||||||
|
|
||||||
self._modules[module](self)
|
self._modules[module](self)
|
||||||
|
if module not in self._loaded_modules:
|
||||||
|
self._loaded_modules.add(module)
|
||||||
|
return self
|
||||||
|
|
||||||
def add_logging(self):
|
def add_logging(self) -> Self:
|
||||||
self.add_transient(LoggerABC, Logger)
|
self.add_transient(LoggerABC, Logger)
|
||||||
return self
|
return self
|
||||||
|
|||||||
@@ -24,19 +24,19 @@ class ServiceProviderABC(ABC):
|
|||||||
return cls._provider
|
return cls._provider
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_global_service(cls, instance_type: T, *args, **kwargs) -> Optional[R]:
|
def get_global_service(cls, instance_type: Type[T], *args, **kwargs) -> Optional[T]:
|
||||||
if cls._provider is None:
|
if cls._provider is None:
|
||||||
return None
|
return None
|
||||||
return cls._provider.get_service(instance_type, *args, **kwargs)
|
return cls._provider.get_service(instance_type, *args, **kwargs)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_global_services(cls, instance_type: T, *args, **kwargs) -> list[Optional[R]]:
|
def get_global_services(cls, instance_type: Type[T], *args, **kwargs) -> list[Optional[T]]:
|
||||||
if cls._provider is None:
|
if cls._provider is None:
|
||||||
return []
|
return []
|
||||||
return cls._provider.get_services(instance_type, *args, **kwargs)
|
return cls._provider.get_services(instance_type, *args, **kwargs)
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def _build_by_signature(self, sig: Signature, origin_service_type: type = None) -> list[R]: ...
|
def _build_by_signature(self, sig: Signature, origin_service_type: type = None) -> list[T]: ...
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def _build_service(self, service_type: type, *args, **kwargs) -> object:
|
def _build_service(self, service_type: type, *args, **kwargs) -> object:
|
||||||
@@ -114,14 +114,22 @@ class ServiceProviderABC(ABC):
|
|||||||
if f is None:
|
if f is None:
|
||||||
return functools.partial(cls.inject)
|
return functools.partial(cls.inject)
|
||||||
|
|
||||||
|
if iscoroutinefunction(f):
|
||||||
|
@functools.wraps(f)
|
||||||
|
async def async_inner(*args, **kwargs):
|
||||||
|
if cls._provider is None:
|
||||||
|
raise Exception(f"{cls.__name__} not build!")
|
||||||
|
|
||||||
|
injection = [x for x in cls._provider._build_by_signature(signature(f)) if x is not None]
|
||||||
|
return await f(*args, *injection, **kwargs)
|
||||||
|
|
||||||
|
return async_inner
|
||||||
|
|
||||||
@functools.wraps(f)
|
@functools.wraps(f)
|
||||||
async def inner(*args, **kwargs):
|
def inner(*args, **kwargs):
|
||||||
if cls._provider is None:
|
if cls._provider is None:
|
||||||
raise Exception(f"{cls.__name__} not build!")
|
raise Exception(f"{cls.__name__} not build!")
|
||||||
|
|
||||||
injection = [x for x in cls._provider._build_by_signature(signature(f)) if x is not None]
|
injection = [x for x in cls._provider._build_by_signature(signature(f)) if x is not None]
|
||||||
if iscoroutinefunction(f):
|
|
||||||
return await f(*args, *injection, **kwargs)
|
|
||||||
return f(*args, *injection, **kwargs)
|
return f(*args, *injection, **kwargs)
|
||||||
|
|
||||||
return inner
|
return inner
|
||||||
|
|||||||
8
tests/custom/api/src/appsettings.development.json
Normal file
8
tests/custom/api/src/appsettings.development.json
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"Logging": {
|
||||||
|
"Path": "logs/",
|
||||||
|
"Filename": "log_$start_time.log",
|
||||||
|
"ConsoleLevel": "TRACE",
|
||||||
|
"Level": "TRACE"
|
||||||
|
}
|
||||||
|
}
|
||||||
26
tests/custom/api/src/appsettings.edrafts-pc.json
Normal file
26
tests/custom/api/src/appsettings.edrafts-pc.json
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"TimeFormat": {
|
||||||
|
"DateFormat": "%Y-%m-%d",
|
||||||
|
"TimeFormat": "%H:%M:%S",
|
||||||
|
"DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f",
|
||||||
|
"DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
|
||||||
|
},
|
||||||
|
|
||||||
|
"Log": {
|
||||||
|
"Path": "logs/",
|
||||||
|
"Filename": "log_$start_time.log",
|
||||||
|
"ConsoleLevel": "TRACE",
|
||||||
|
"Level": "TRACE"
|
||||||
|
},
|
||||||
|
|
||||||
|
"Database": {
|
||||||
|
"Host": "localhost",
|
||||||
|
"User": "cpl",
|
||||||
|
"Port": 3306,
|
||||||
|
"Password": "cpl",
|
||||||
|
"Database": "cpl",
|
||||||
|
"Charset": "utf8mb4",
|
||||||
|
"UseUnicode": "true",
|
||||||
|
"Buffered": "true"
|
||||||
|
}
|
||||||
|
}
|
||||||
15
tests/custom/api/src/appsettings.json
Normal file
15
tests/custom/api/src/appsettings.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"TimeFormat": {
|
||||||
|
"DateFormat": "%Y-%m-%d",
|
||||||
|
"TimeFormat": "%H:%M:%S",
|
||||||
|
"DateTimeFormat": "%Y-%m-%d %H:%M:%S.%f",
|
||||||
|
"DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
|
||||||
|
},
|
||||||
|
|
||||||
|
"Log": {
|
||||||
|
"Path": "logs/",
|
||||||
|
"Filename": "log_$start_time.log",
|
||||||
|
"ConsoleLevel": "ERROR",
|
||||||
|
"Level": "WARNING"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,21 +1,31 @@
|
|||||||
from starlette.responses import JSONResponse
|
from starlette.responses import JSONResponse
|
||||||
|
|
||||||
|
from cpl import api
|
||||||
from cpl.api.web_app import WebApp
|
from cpl.api.web_app import WebApp
|
||||||
from cpl.application import ApplicationBuilder
|
from cpl.application import ApplicationBuilder
|
||||||
|
from cpl.core.configuration import Configuration
|
||||||
|
from cpl.core.environment import Environment
|
||||||
from service import PingService
|
from service import PingService
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
builder = ApplicationBuilder[WebApp](WebApp)
|
builder = ApplicationBuilder[WebApp](WebApp)
|
||||||
|
|
||||||
|
Configuration.add_json_file(f"appsettings.json")
|
||||||
|
Configuration.add_json_file(f"appsettings.{Environment.get_environment()}.json")
|
||||||
|
Configuration.add_json_file(f"appsettings.{Environment.get_host_name()}.json", optional=True)
|
||||||
|
|
||||||
builder.services.add_logging()
|
builder.services.add_logging()
|
||||||
builder.services.add_transient(PingService)
|
builder.services.add_transient(PingService)
|
||||||
|
builder.services.add_module(api)
|
||||||
|
|
||||||
app = builder.build()
|
app = builder.build()
|
||||||
|
app.with_logging()
|
||||||
|
app.with_database()
|
||||||
|
|
||||||
|
app.with_authentication()
|
||||||
app.with_route(path="/route1", fn=lambda r: JSONResponse("route1"), method="GET")
|
app.with_route(path="/route1", fn=lambda r: JSONResponse("route1"), method="GET")
|
||||||
app.with_routes_directory("routes")
|
app.with_routes_directory("routes")
|
||||||
app.with_logging()
|
|
||||||
app.with_authentication()
|
|
||||||
|
|
||||||
app.run()
|
app.run()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user