Merge pull request #13 from erwindouna/scheduler-concept

Scheduler concept

Author: erwindouna

poetry.lock

@@ -24,6 +24,7 @@ jinja2 = "^3.1.6"
 python-multipart = "^0.0.20"
 itsdangerous = "^2.2.0"
 pyjwt = "^2.10.1"
+apscheduler = "^3.11.0"
 
 [tool.poetry.group.dev.dependencies]
 aresponses = "3.0.0"

pyproject.toml

@@ -0,0 +1,93 @@
+"""Class to handle the scheduler workflow."""
+
+from __future__ import annotations
+
+from datetime import datetime
+import logging
+from typing import Any
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+from apscheduler.triggers.cron import CronTrigger
+import asyncio
+
+from clients.firefly import FireflyClient
+from clients.truelayer import TrueLayerClient
+from importer2firefly import Import2Firefly
+
+from config import Config
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class Scheduler:
+    """Class to handle the scheduler workflow."""
+
+    def __init__(self, schedule: str | None = None) -> None:
+        """Initialize the Scheduler class."""
+        self._config: Config = Config()
+        self._scheduler: AsyncIOScheduler = AsyncIOScheduler()
+        self._import_job = None
+        self._schedule: str | None = schedule or self._config.get("import_schedule")
+
+    def start(
+        self, truelayer_client: TrueLayerClient, firefly_client: FireflyClient
+    ) -> None:
+        """Start the scheduler."""
+        _LOGGER.info("Starting the scheduler, with schedule: %s", self._schedule)
+        if self._schedule is None:
+            _LOGGER.warning("No schedule set, not starting the scheduler")
+            return
+
+        if self._import_job:
+            self._scheduler.remove_job(self._import_job.id)
+
+        loop = asyncio.get_event_loop()
+
+        def run_import() -> None:
+            """Run the import job."""
+            start_time = datetime.now()
+            _LOGGER.info("Running import job, started at %s", start_time)
+            importer = Import2Firefly(truelayer_client, firefly_client)
+            asyncio.run_coroutine_threadsafe(importer.start_import().__anext__(), loop)
+            end_time = datetime.now()
+            elapsed_time = end_time - start_time
+            _LOGGER.info("Import job completed elapsed time: %s", elapsed_time)
+
+        self._import_job = self._scheduler.add_job(
+            run_import,
+            trigger=CronTrigger.from_crontab(self._schedule),
+            id="import_job",
+            replace_existing=True,
+        )
+        self._scheduler.start()
+        _LOGGER.info("Scheduler started")
+
+    def set_schedule(self, schedule: str) -> None:
+        """Set the schedule for the import job."""
+        self._schedule = schedule
+        _LOGGER.info("Scheduler schedule set to: %s", self._schedule)
+
+        if not schedule:
+            _LOGGER.info("Disabling the scheduler")
+            if self._import_job:
+                self._scheduler.remove_job(self._import_job.id)
+                _LOGGER.info("Scheduler job removed")
+            else:
+                _LOGGER.warning("No import job to remove")
+            self._import_job = None
+            return
+
+        if self._import_job:
+            self._scheduler.reschedule_job(
+                self._import_job.id,
+                trigger=CronTrigger.from_crontab(self._schedule),
+            )
+            _LOGGER.info("Scheduler job rescheduled to: %s", self._schedule)
+
+    def stop(self) -> None:
+        """Stop the scheduler."""
+        if not self._scheduler.running:
+            _LOGGER.warning("Scheduler is not running")
+            return
+
+        self._scheduler.shutdown()
+        _LOGGER.info("Scheduler stopped")

scheduler.py

@@ -32,6 +32,32 @@ <h5 class="modal-title" id="resetModalLabel">Confirm Reset</h5>
     </div>
 </div>
 
+<div class="row">
+    <div class="col-md-12">
+        <h3>Scheduler</h3>
+        <p>Set a scheduler to automatically import your transactions.</p>
+        <hr>
+        <form action="/set-schedule" method="post">
+            <div class="mb-3">
+                <label for="schedule" class="form-label">Scheduler</label>
+                <select class="form-select" id="schedule" name="schedule">
+                    <option value="">Disabled</option>
+                    <option value="*/1 * * * *">Every minute</option>
+                    <option value="*/5 * * * *">Every 5 minutes</option>
+                    <option value="*/10 * * * *">Every 10 minutes</option>
+                    <option value="*/15 * * * *">Every 15 minutes</option>
+                    <option value="*/30 * * * *">Every 30 minutes</option>
+                    <option value="0 * * * *">Every hour</option>
+                    <option value="0 0 * * *">Every day at midnight</option>
+                    <option value="0 0 * * 0">Every week at midnight</option>
+                </select>
+            </div>
+            <button type="submit" class="btn btn-primary">Save Scheduler</button>
+        </form>
+    </div>
+</div>
+<hr>
+
 <div class="row">
     <div class="col-md-6">
         <div class="card mb-4">
@@ -107,4 +133,4 @@ <h5 class="modal-title" id="resetModalLabel">Confirm Reset</h5>
     </div>
 </div>
 
-{% endblock %}
+{% endblock %}

templates/configuration.html

@@ -17,9 +17,13 @@
 import logging
 from contextlib import asynccontextmanager
 from starlette.middleware.sessions import SessionMiddleware
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+from apscheduler.triggers.cron import CronTrigger
+
 
 from clients.firefly import FireflyClient
 from clients.truelayer import TrueLayerClient
+from scheduler import Scheduler
 from config import Config
 from exception_handlers import (
     truelayer_authorization_error_handler,
@@ -63,6 +67,14 @@ async def lifespan(application: FastAPI) -> AsyncGenerator[None, None]:
     )
     _LOGGER.info("Firefly client initialized")
 
+    application.state.scheduler = Scheduler()
+    _LOGGER.info("Scheduler initialized")
+
+    application.state.scheduler.start(
+        application.state.truelayer_client, application.state.firefly_client
+    )
+    _LOGGER.info("Scheduling started")
+
     yield
 
     if client := application.state.truelayer_client:
@@ -73,6 +85,10 @@ async def lifespan(application: FastAPI) -> AsyncGenerator[None, None]:
         await client.close()
         _LOGGER.info("Firefly client closed")
 
+    if scheduler := application.state.scheduler:
+        scheduler.stop()
+        _LOGGER.info("Scheduler stopped")
+
     _LOGGER.info("Application shutdown complete")
 
 
@@ -97,6 +113,14 @@ async def get_firefly_client() -> FireflyClient:
     return client
 
 
+async def get_scheduler() -> Scheduler:
+    """Get the scheduler from the application state."""
+    scheduler = app.state.scheduler
+    if not scheduler:
+        raise RuntimeError("Scheduler is not initialized.")
+    return scheduler
+
+
 @app.get("/", response_class=HTMLResponse)
 async def index(request: Request):
     """Render the index page."""
@@ -349,6 +373,27 @@ async def reset_configuration(request: Request):
     return RedirectResponse(str(request.url_for("index")), status_code=302)
 
 
+@app.post("/set-schedule")
+async def set_schedule(
+    request: Request,
+    schedule: str = Form(...),
+    scheduler: Scheduler = Depends(get_scheduler),
+) -> RedirectResponse:
+    """Set the import schedule."""
+    _LOGGER.info("Setting schedule to %s", schedule)
+    config.set("import_schedule", schedule)
+
+    try:
+        scheduler.set_schedule(schedule)
+    except Exception as e:
+        _LOGGER.error("Error setting schedule: %s", e)
+        return JSONResponse(
+            status_code=500,
+            content={"error": "Error setting schedule", "details": str(e)},
+        )
+    return RedirectResponse(str(request.url_for("index")), status_code=302)
+
+
 app.add_exception_handler(
     TrueLayer2FireflyAuthorizationError, truelayer_authorization_error_handler
 )