🎯 feat: improve logging module for overridable from child package (#49).

* 🎨 format: reformat code on api component.

* 🎯 feat: update api application.

* 🧪 tests: update testcase for job execute api.

* 🧪 tests: add dynamic assert context for foreach stage.

* 📌 deps: upgrade typer version to 0.16.0.

* 🎨 format: change way to setting log config.

Author: korawica

.container/Dockerfile

@@ -15,3 +15,5 @@ RUN pip install --no-cache-dir -U ddeutil-workflow[all]
 USER worker
 
 ENTRYPOINT ["workflow-cli"]
+
+CMD ["api"]

pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
     "pydantic==2.11.4",
     "pydantic-extra-types==2.10.4",
     "python-dotenv==1.1.0",
-    "typer==0.15.4",
+    "typer>=0.16.0",
 ]
 dynamic = ["version"]
 
@@ -78,9 +78,10 @@ omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
     "src/ddeutil/workflow/__main__.py",
+    "src/ddeutil/workflow/__types.py",
     "src/ddeutil/workflow/cli.py",
     "src/ddeutil/workflow/api/__init__.py",
-    "src/ddeutil/workflow/api/logs.py",
+    "src/ddeutil/workflow/api/log_conf.py",
     "src/ddeutil/workflow/api/routes/__init__.py",
     "src/ddeutil/workflow/api/routes/job.py",
     "src/ddeutil/workflow/api/routes/logs.py",

src/ddeutil/workflow/api/__init__.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 import contextlib
+import logging
 from collections.abc import AsyncIterator
 
 from dotenv import load_dotenv
@@ -19,11 +20,10 @@
 
 from ..__about__ import __version__
 from ..conf import api_config
-from ..logs import get_logger
 from .routes import job, log, workflow
 
 load_dotenv()
-logger = get_logger("uvicorn.error")
+logger = logging.getLogger("uvicorn.error")
 
 
 @contextlib.asynccontextmanager
@@ -58,34 +58,35 @@ async def lifespan(_: FastAPI) -> AsyncIterator[dict[str, list]]:
 
 
 @app.get(path="/", response_class=UJSONResponse)
-async def health():
+async def health() -> UJSONResponse:
     """Index view that not return any template without json status."""
-    return {"message": "Workflow already start up with healthy status."}
+    logger.info("[API]: Workflow API Application already running ...")
+    return UJSONResponse(
+        content={"message": "Workflow already start up with healthy status."},
+        status_code=st.HTTP_200_OK,
+    )
 
 
-# NOTE Add the jobs and logs routes by default.
+# NOTE: Add the jobs and logs routes by default.
 app.include_router(job, prefix=api_config.prefix_path)
 app.include_router(log, prefix=api_config.prefix_path)
 app.include_router(workflow, prefix=api_config.prefix_path)
 
 
 @app.exception_handler(RequestValidationError)
 async def validation_exception_handler(
-    request: Request, exc: RequestValidationError
-):
+    request: Request,
+    exc: RequestValidationError,
+) -> UJSONResponse:
+    """Error Handler for model validate does not valid."""
     _ = request
     return UJSONResponse(
         status_code=st.HTTP_422_UNPROCESSABLE_ENTITY,
-        content=jsonable_encoder({"detail": exc.errors(), "body": exc.body}),
-    )
-
-
-if __name__ == "__main__":
-    import uvicorn
-
-    uvicorn.run(
-        app,
-        host="0.0.0.0",
-        port=80,
-        log_level="DEBUG",
+        content=jsonable_encoder(
+            {
+                "message": "Body does not parsing with model.",
+                "detail": exc.errors(),
+                "body": exc.body,
+            }
+        ),
     )

src/ddeutil/workflow/api/logs.py src/ddeutil/workflow/api/log_conf.pysrc/ddeutil/workflow/api/logs.py renamed to src/ddeutil/workflow/api/log_conf.py

@@ -1,6 +1,8 @@
+from typing import Any
+
 from ..conf import config
 
-LOGGING_CONFIG = {  # pragma: no cov
+LOGGING_CONFIG: dict[str, Any] = {  # pragma: no cov
     "version": 1,
     "disable_existing_loggers": False,
     "formatters": {
@@ -22,38 +24,49 @@
             "stream": "ext://sys.stderr",
         },
         "stream_handler": {
+            # "formatter": "standard",
             "formatter": "custom_formatter",
             "class": "logging.StreamHandler",
             "stream": "ext://sys.stdout",
         },
-        "file_handler": {
-            "formatter": "custom_formatter",
-            "class": "logging.handlers.RotatingFileHandler",
-            "filename": "logs/app.log",
-            "maxBytes": 1024 * 1024 * 1,
-            "backupCount": 3,
-        },
+        # "file_handler": {
+        #     "formatter": "custom_formatter",
+        #     "class": "logging.handlers.RotatingFileHandler",
+        #     "filename": "logs/app.log",
+        #     "maxBytes": 1024 * 1024 * 1,
+        #     "backupCount": 3,
+        # },
     },
     "loggers": {
         "uvicorn": {
-            "handlers": ["default", "file_handler"],
+            # "handlers": ["default", "file_handler"],
+            "handlers": ["default"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
         "uvicorn.access": {
-            "handlers": ["stream_handler", "file_handler"],
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
         "uvicorn.error": {
-            "handlers": ["stream_handler", "file_handler"],
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
             "level": "DEBUG" if config.debug else "INFO",
             "propagate": False,
         },
-        # "uvicorn.asgi": {
-        #     "handlers": ["stream_handler", "file_handler"],
-        #     "level": "TRACE",
-        #     "propagate": False,
+        "uvicorn.asgi": {
+            # "handlers": ["stream_handler", "file_handler"],
+            "handlers": ["stream_handler"],
+            "level": "TRACE",
+            "propagate": False,
+        },
+        # "ddeutil.workflow": {
+        #     "handlers": ["stream_handler"],
+        #     "level": "INFO",
+        #     # "propagate": False,
+        #     "propagate": True,
         # },
     },
 }

src/ddeutil/workflow/api/routes/__init__.py

@@ -3,6 +3,6 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
-from .job import job_route as job
-from .logs import log_route as log
-from .workflows import workflow_route as workflow
+from .job import router as job
+from .logs import router as log
+from .workflows import router as workflow

src/ddeutil/workflow/api/routes/job.py

@@ -5,20 +5,21 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+import logging
 from typing import Any, Optional
 
 from fastapi import APIRouter
+from fastapi import status as st
 from fastapi.responses import UJSONResponse
 from pydantic import BaseModel, Field
 
 from ...__types import DictData
 from ...errors import JobError
 from ...job import Job
-from ...logs import get_logger
 from ...result import Result
 
-logger = get_logger("uvicorn.error")
-job_route = APIRouter(prefix="/job", tags=["job"])
+logger = logging.getLogger("uvicorn.error")
+router = APIRouter(prefix="/job", tags=["job"])
 
 
 class ResultCreate(BaseModel):
@@ -32,14 +33,19 @@ class ResultCreate(BaseModel):
     )
 
 
-@job_route.post(path="/execute/", response_class=UJSONResponse)
+@router.post(
+    path="/execute/",
+    response_class=UJSONResponse,
+    status_code=st.HTTP_200_OK,
+)
 async def job_execute(
     result: ResultCreate,
     job: Job,
     params: dict[str, Any],
     extras: Optional[dict[str, Any]] = None,
-):
+) -> UJSONResponse:
     """Execute job via RestAPI with execute route path."""
+    logger.info("[API]: Start execute job ...")
     rs: Result = Result(
         run_id=result.run_id,
         parent_run_id=result.parent_run_id,
@@ -61,15 +67,35 @@ async def job_execute(
         )
     except JobError as err:
         rs.trace.error(f"[JOB]: {err.__class__.__name__}: {err}")
+        return UJSONResponse(
+            content={
+                "message": str(err),
+                "result": {
+                    "run_id": rs.run_id,
+                    "parent_run_id": rs.parent_run_id,
+                },
+                "job": job.model_dump(
+                    by_alias=True,
+                    exclude_none=False,
+                    exclude_unset=True,
+                ),
+                "params": params,
+                "context": context,
+            },
+            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
+        )
 
-    return {
-        "message": "Execute job via RestAPI.",
-        "result": {"run_id": rs.run_id, "parent_run_id": rs.parent_run_id},
-        "job": job.model_dump(
-            by_alias=True,
-            exclude_none=False,
-            exclude_unset=True,
-        ),
-        "params": params,
-        "context": context,
-    }
+    return UJSONResponse(
+        content={
+            "message": "Execute job via RestAPI successful.",
+            "result": {"run_id": rs.run_id, "parent_run_id": rs.parent_run_id},
+            "job": job.model_dump(
+                by_alias=True,
+                exclude_none=False,
+                exclude_unset=True,
+            ),
+            "params": params,
+            "context": context,
+        },
+        status_code=st.HTTP_200_OK,
+    )

src/ddeutil/workflow/api/routes/logs.py

@@ -13,14 +13,14 @@
 from ...logs import get_audit
 from ...result import Result
 
-log_route = APIRouter(
+router = APIRouter(
     prefix="/logs",
     tags=["logs"],
     default_response_class=UJSONResponse,
 )
 
 
-@log_route.get(
+@router.get(
     path="/traces/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -50,7 +50,7 @@ async def get_traces(
     }
 
 
-@log_route.get(
+@router.get(
     path="/traces/{run_id}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -77,7 +77,7 @@ async def get_trace_with_id(run_id: str):
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -94,7 +94,7 @@ async def get_audits():
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -113,7 +113,7 @@ async def get_audit_with_workflow(workflow: str):
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/{release}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,
@@ -140,7 +140,7 @@ async def get_audit_with_workflow_release(
     }
 
 
-@log_route.get(
+@router.get(
     path="/audits/{workflow}/{release}/{run_id}",
     response_class=UJSONResponse,
     status_code=st.HTTP_200_OK,