♻️ clean: remove schedule route marking.

Author: korawica

README.md

@@ -244,15 +244,6 @@ it will use default value and do not raise any error to you.
 | **AUDIT_PATH**               |    Log    | `./audits`                                                                                                                      |                                                                                                                    |
 | **AUDIT_ENABLE_WRITE**       |    Log    | `true`                                                                                                                          | A flag that enable logging object saving log to its destination.                                                   |
 
-**API Application**:
-
-This config part use for the workflow application that build from the FastAPI
-only.
-
-| Environment                |  Component  | Default | Description                                                                        |
-|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
-| **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
-
 ## :rocket: Deployment
 
 This package able to run as an application service for receive manual trigger

docs/configuration.md

@@ -34,12 +34,6 @@ and do not raise any error to you.
 | **AUDIT_PATH**               |    Log    | `./audits`                                                                                                                      |                                                                                                                    |
 | **AUDIT_ENABLE_WRITE**       |    Log    | `true`                                                                                                                          | A flag that enable logging object saving log to its destination.                                                   |
 
-### API
-
-| Environment                |  Component  | Default | <div style="width:25em">Description</div>                                          |
-|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
-| **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
-
 ## Execution Override
 
 Some config can override by an extra parameters. For the below example, I override

src/ddeutil/workflow/api/__init__.py

@@ -20,8 +20,7 @@
 from ..__about__ import __version__
 from ..conf import api_config
 from ..logs import get_logger
-from .routes import job, log
-from .utils import repeat_at
+from .routes import job, log, workflow
 
 load_dotenv()
 logger = get_logger("uvicorn.error")
@@ -67,53 +66,7 @@ async def health():
 # 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)
-
-
-# NOTE: Enable the workflows route.
-if api_config.enable_route_workflow:
-    from .routes import workflow
-
-    app.include_router(workflow, prefix=api_config.prefix_path)
-
-
-# NOTE: Enable the schedules route.
-# if api_config.enable_route_schedule:
-#     from ..logs import get_audit
-#     from ..scheduler import schedule_task
-#     from .routes import schedule
-#
-#     app.include_router(schedule, prefix=api_config.prefix_path)
-#
-#     @schedule.on_event("startup")
-#     @repeat_at(cron="* * * * *", delay=2)
-#     def scheduler_listener():
-#         """Schedule broker every minute at 02 second."""
-#         logger.debug(
-#             f"[SCHEDULER]: Start listening schedule from queue "
-#             f"{app.state.scheduler}"
-#         )
-#         if app.state.workflow_tasks:
-#             schedule_task(
-#                 app.state.workflow_tasks,
-#                 stop=datetime.now(config.tz) + timedelta(minutes=1),
-#                 queue=app.state.workflow_queue,
-#                 threads=app.state.workflow_threads,
-#                 audit=get_audit(),
-#             )
-#
-#     @schedule.on_event("startup")
-#     @repeat_at(cron="*/5 * * * *", delay=10)
-#     def monitoring():
-#         """Monitoring workflow thread that running in the background."""
-#         logger.debug("[MONITOR]: Start monitoring threading.")
-#         snapshot_threads: list[str] = list(app.state.workflow_threads.keys())
-#         for t_name in snapshot_threads:
-#
-#             thread_release: ReleaseThread = app.state.workflow_threads[t_name]
-#
-#             # NOTE: remove the thread that running success.
-#             if not thread_release["thread"].is_alive():
-#                 app.state.workflow_threads.pop(t_name)
+app.include_router(workflow, prefix=api_config.prefix_path)
 
 
 @app.exception_handler(RequestValidationError)

src/ddeutil/workflow/api/utils.py

@@ -6,11 +6,9 @@
 from __future__ import annotations
 
 import copy
-import json
 import os
 from abc import ABC, abstractmethod
 from collections.abc import Iterator
-from datetime import timedelta
 from functools import cached_property
 from inspect import isclass
 from pathlib import Path
@@ -163,28 +161,6 @@ def max_cron_per_workflow(self) -> int:
     def max_queue_complete_hist(self) -> int:
         return int(env("CORE_MAX_QUEUE_COMPLETE_HIST", "16"))
 
-    # NOTE: App
-    @property
-    def max_schedule_process(self) -> int:
-        return int(env("APP_MAX_PROCESS", "2"))
-
-    @property
-    def max_schedule_per_process(self) -> int:
-        return int(env("APP_MAX_SCHEDULE_PER_PROCESS", "100"))
-
-    @property
-    def stop_boundary_delta(self) -> timedelta:
-        stop_boundary_delta_str: str = env(
-            "APP_STOP_BOUNDARY_DELTA", '{"minutes": 5, "seconds": 20}'
-        )
-        try:
-            return timedelta(**json.loads(stop_boundary_delta_str))
-        except Exception as err:
-            raise ValueError(
-                "Config `WORKFLOW_APP_STOP_BOUNDARY_DELTA` can not parsing to"
-                f"timedelta with {stop_boundary_delta_str}."
-            ) from err
-
 
 class APIConfig:
     """API Config object."""
@@ -193,14 +169,6 @@ class APIConfig:
     def prefix_path(self) -> str:
         return env("API_PREFIX_PATH", "/api/v1")
 
-    @property
-    def enable_route_workflow(self) -> bool:
-        return str2bool(env("API_ENABLE_ROUTE_WORKFLOW", "true"))
-
-    @property
-    def enable_route_schedule(self) -> bool:
-        return str2bool(env("API_ENABLE_ROUTE_SCHEDULE", "true"))
-
 
 class BaseLoad(ABC):  # pragma: no cov
     """Base Load object is the abstraction object for any Load object that

src/ddeutil/workflow/conf.py

@@ -7,7 +7,7 @@ def test_workflows_get_by_name(client):
     assert response.json() == {
         "name": "wf-run-common",
         "desc": "## Run Python Workflow\n\nThis is a running python workflow\n",
-        "params": {"name": {}},
+        "params": {"name": {"type": "str"}},
         "on": [{"cronjob": "*/5 * * * *", "timezone": "Asia/Bangkok"}],
         "jobs": {
             "demo-run": {

tests/api/test_api_workflows.py

@@ -19,14 +19,6 @@
 
 
 def test_config():
-    origin_stop = os.getenv("WORKFLOW_APP_STOP_BOUNDARY_DELTA")
-    os.environ["WORKFLOW_APP_STOP_BOUNDARY_DELTA"] = "{"
-
-    with pytest.raises(ValueError):
-        _ = Config().stop_boundary_delta
-
-    os.environ["WORKFLOW_APP_STOP_BOUNDARY_DELTA"] = origin_stop
-
     conf = Config()
     os.environ["WORKFLOW_CORE_TIMEZONE"] = "Asia/Bangkok"
     assert conf.tz == ZoneInfo("Asia/Bangkok")

tests/test_conf.py

@@ -42,10 +42,6 @@ def dotenv_setting() -> None:
             WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE=true
             WORKFLOW_LOG_TRACE_ENABLE_WRITE=false
             WORKFLOW_LOG_AUDIT_ENABLE_WRITE=true
-            WORKFLOW_APP_MAX_PROCESS=2
-            WORKFLOW_APP_STOP_BOUNDARY_DELTA='{{"minutes": 5, "seconds": 20}}'
-            WORKFLOW_API_ENABLE_ROUTE_WORKFLOW=true
-            WORKFLOW_API_ENABLE_ROUTE_SCHEDULE=true
             """
         ).strip()
         env_path.write_text(env_str)