feat(deps): update dependency fastapi-filters to v0.3.0 (#26)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

.github/workflows/ci.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - dev
       - master
+      - renovate/**
     paths-ignore:
       - "**/.github/**"
       - "**/.gitignore"
@@ -13,6 +14,10 @@ on:
       - "**/CHANGELOG.md"
       - "**/docs/**"
   workflow_dispatch:
+  pull_request:
+    branches:
+      - dev
+      - master
 
 env:
   REGISTRY: ghcr.io

Dockerfile

@@ -1,9 +1,15 @@
-FROM python:3.12-slim
-ARG VERSION=unkown
+FROM python:3.13-slim
+ARG VERSION=unknown
+
+# Create a non-root user and group
+RUN groupadd -r appuser && useradd -r -g appuser appuser
 
 WORKDIR /app
 COPY . .
 
+# Change ownership of the application directory
+RUN chown -R appuser:appuser /app
+
 # Python setup
 ENV PYTHONDONTWRITEBYTECODE=1
 ENV PYTHONUNBUFFERED=1
@@ -12,13 +18,19 @@ ENV ENV=DEV
 
 # Install dependencies
 RUN pip install --no-cache-dir --upgrade -r requirements.txt
-RUN pip install 'uvicorn[standard]'
+
+# Switch to the non-root user
+USER appuser
 
 EXPOSE 9000
 CMD ["uvicorn", "app.main:app", "--workers", "6" , "--host", "0.0.0.0", "--port", "9000"]
 
 # Install curl
-RUN apt-get update && apt-get install -y curl && apt-get clean
+USER root
+RUN apt-get update && apt-get install -y --no-install-recommends curl && apt-get clean
+
+# Switch back to the non-root user
+USER appuser
 
 HEALTHCHECK --interval=30s --timeout=10s --retries=5 \
   CMD curl --fail http://localhost:9000/openapi.json || exit 1

README.md

@@ -1,3 +1,8 @@
 # apilog
 
 Tiny logging API server, for taking logs via HTTP POST requests.
+
+## TODO
+
+[ ] Application Patch
+[ ] Team CRUD

alembic/versions/1e695b024786_.py

@@ -0,0 +1,29 @@
+"""empty message
+
+Revision ID: 1e695b024786
+Revises: 21dc1dc045b8
+Create Date: 2025-01-20 11:36:14.692849
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "1e695b024786"
+down_revision: Union[str, None] = "21dc1dc045b8"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    with op.batch_alter_table("application", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("retention_days", sa.Integer(), nullable=True))
+
+
+def downgrade() -> None:
+    with op.batch_alter_table("application", schema=None) as batch_op:
+        batch_op.drop_column("retention_days")

app/models/app.py

@@ -1,6 +1,7 @@
 from creyPY.fastapi.models.base import Base
-from sqlalchemy import Column, String
+from sqlalchemy import Column, Integer, String
 
 
 class Application(Base):
     name = Column(String(512), nullable=False, unique=True)
+    retention_days = Column(Integer, nullable=True)

app/models/entry.py

@@ -1,9 +1,9 @@
-from creyPY.fastapi.models.base import Base
-from sqlalchemy import Column, String, ForeignKey, Enum, JSON
-from sqlalchemy.dialects.postgresql import UUID
-
 from enum import Enum as pyenum
 
+from creyPY.fastapi.models.base import Base
+from sqlalchemy import JSON, Column, Enum, ForeignKey, String
+from sqlalchemy.dialects.postgresql import UUID
+
 
 class TransactionType(pyenum):
     CREATE = "create"

app/routes/app.py

@@ -1,17 +1,16 @@
-from creyPY.fastapi.crud import (
-    create_obj_from_data,
-)
-from creyPY.fastapi.db.session import get_db
-from fastapi import APIRouter, Depends, Security, HTTPException
-from sqlalchemy.orm import Session
-from pydantic.json_schema import SkipJsonSchema
-from app.services.auth import verify
-from app.schema.app import AppIN, AppOUT
-from app.models.app import Application
-from creyPY.fastapi.pagination import Page
 from uuid import UUID
-from fastapi_pagination.ext.sqlalchemy import paginate
+
+from creyPY.fastapi.crud import create_obj_from_data
+from creyPY.fastapi.db.session import get_db
+from creyPY.fastapi.pagination import Page, paginate
+from fastapi import APIRouter, Depends, HTTPException, Security
+from pydantic.json_schema import SkipJsonSchema
 from sqlalchemy import select
+from sqlalchemy.orm import Session
+
+from app.models.app import Application
+from app.schema.app import AppIN, AppOUT
+from app.services.auth import verify
 
 router = APIRouter(prefix="/app", tags=["apps"])
 
@@ -26,7 +25,7 @@ async def create_app(
         data,
         Application,
         db,
-        additonal_data={"created_by_id": sub},
+        additional_data={"created_by_id": sub},
     )
     return AppOUT.model_validate(obj)
 

app/routes/entry.py

@@ -1,24 +1,22 @@
-from creyPY.fastapi.crud import (
-    create_obj_from_data,
-)
-from creyPY.fastapi.order_by import order_by
+from datetime import datetime
 from typing import Callable
-from sqlalchemy.sql.selectable import Select
-from creyPY.fastapi.db.session import get_db
-from fastapi import APIRouter, Depends, Security, HTTPException
-from sqlalchemy.orm import Session
-from sqlalchemy import select
-from app.services.auth import verify
-from app.schema.entry import LogIN, LogOUT
-from app.models.entry import LogEntry
-from fastapi_pagination.ext.sqlalchemy import paginate
-from creyPY.fastapi.pagination import Page
 from uuid import UUID
-from pydantic.json_schema import SkipJsonSchema
+
+from creyPY.fastapi.crud import create_obj_from_data
+from creyPY.fastapi.db.session import get_db
+from creyPY.fastapi.order_by import order_by
+from creyPY.fastapi.pagination import Page, paginate
+from fastapi import APIRouter, Depends, HTTPException, Security
 from fastapi_filters import FilterValues, create_filters
 from fastapi_filters.ext.sqlalchemy import apply_filters
-from app.models.entry import LogType, TransactionType
-from datetime import datetime
+from pydantic.json_schema import SkipJsonSchema
+from sqlalchemy import select
+from sqlalchemy.orm import Session
+from sqlalchemy.sql.selectable import Select
+
+from app.models.entry import LogEntry, LogType, TransactionType
+from app.schema.entry import LogIN, LogOUT
+from app.services.auth import verify
 
 router = APIRouter(prefix="/log", tags=["logging"])
 
@@ -33,7 +31,7 @@ async def create_log(
         data,
         LogEntry,
         db,
-        additonal_data={"created_by_id": sub},
+        additional_data={"created_by_id": sub},
     )
     return LogOUT.model_validate(obj)
 
@@ -94,7 +92,7 @@ async def get_logs(
     return paginate(db, order_by_query(the_select))
 
 
-@router.delete("/", status_code=200)
+@router.delete("/", status_code=200, operation_id="log_delete_many")
 async def delete_logs(
     application: UUID,
     environment: str | SkipJsonSchema[None] = None,

app/schema/app.py

@@ -1,8 +1,11 @@
+from pydantic.json_schema import SkipJsonSchema
+
 from app.schema.common import BaseSchemaModelIN, BaseSchemaModelOUT
 
 
 class AppIN(BaseSchemaModelIN):
     name: str
+    retention_days: int | SkipJsonSchema[None] = 30
 
 
 class AppOUT(BaseSchemaModelOUT, AppIN):

app/setup.py

@@ -1,12 +1,32 @@
 import os
+from datetime import datetime, timedelta
 
-from creyPY.fastapi.db.session import SQLALCHEMY_DATABASE_URL, name
+from apscheduler.schedulers.background import BackgroundScheduler
+from creyPY.fastapi.db.session import SQLALCHEMY_DATABASE_URL, get_db, name
+from sqlalchemy.orm import Session
 
 from alembic import command
 from alembic.config import Config
+from app.models.app import Application
+from app.models.entry import LogEntry
 from app.services.db.session import create_if_not_exists
 
 
+def delete_old_logs(sess: Session | None = None):
+    session = sess or next(get_db())
+
+    for app in session.query(Application).filter(Application.retention_days.isnot(None)):
+        cutoff = datetime.now() - timedelta(days=app.retention_days)
+        print(
+            f"Deleting logs older than {app.retention_days} days (cutoff: {cutoff}) for {app.name}",
+        )
+        session.query(LogEntry).filter(
+            LogEntry.application == app.id, LogEntry.created_at < cutoff
+        ).delete()
+
+    session.commit()
+
+
 def setup(db_name=name):
     # Create Database
     create_if_not_exists(db_name)
@@ -18,3 +38,17 @@ def setup(db_name=name):
         "script_location", os.path.join(os.path.dirname(os.path.dirname(__file__)), "alembic")
     )
     command.upgrade(config, "head")
+
+    # Start retention deletion
+    scheduler = BackgroundScheduler()
+    scheduler.add_job(
+        delete_old_logs,
+        "interval",
+        id="deletor",
+        days=1,
+        max_instances=1,
+        replace_existing=True,
+        next_run_time=datetime.now(),
+    )
+    scheduler.start()
+    print("Deletion scheduler started")

app/test_main.py

@@ -1,3 +1,6 @@
+import contextlib
+from datetime import datetime, timedelta
+
 from creyPY.fastapi.db.session import SQLALCHEMY_DATABASE_URL, get_db
 from creyPY.fastapi.models.base import Base
 from creyPY.fastapi.testing import GenericClient
@@ -5,16 +8,55 @@ from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
 from sqlalchemy_utils import create_database, database_exists, drop_database
 
+from app.models.entry import LogEntry
 from app.services.auth import verify
-import contextlib
+from app.setup import delete_old_logs
+
 from .main import app
 
 CURRENT_USER = "api-key|testing"
+ENTRY_EXAMPLES = [
+    {
+        "l_type": "info",
+        "t_type": "create",
+        "message": "User Max Mustermann created",
+        "environment": "dev",
+    },
+    {
+        "l_type": "info",
+        "t_type": "update",
+        "message": "User Max Mustermann updated",
+        "environment": "dev",
+    },
+    {
+        "l_type": "info",
+        "t_type": "create",
+        "author": "auth|max_muster",
+        "message": "User Max Mustermann created a Unit",
+        "object_reference": "1",
+        "environment": "dev",
+    },
+    {
+        "l_type": "info",
+        "t_type": "update",
+        "author": "auth|max_muster",
+        "message": "User Max Mustermann updated Unit 1",
+        "object_reference": "1",
+        "previous_object": {"name": "Unit 1"},
+        "environment": "prod",
+    },
+    {
+        "l_type": "warning",
+        "t_type": "delete",
+        "message": "User Max Mustermann deleted",
+        "environment": "prod",
+    },
+]
 
 
 @contextlib.contextmanager
-def app_context(self, name: str = "Testing"):
-    app_id = self.create_app(name)
+def app_context(self, name: str = "Testing", retention_days: int | None = None):
+    app_id = self.create_app(name, retention_days)
     try:
         yield app_id
     finally:
@@ -23,45 +65,8 @@ def app_context(self, name: str = "Testing"):
 
 @contextlib.contextmanager
 def log_examples(self):
-    LOG_EXAMPLES = [
-        {
-            "l_type": "info",
-            "t_type": "create",
-            "message": "User Max Mustermann created",
-            "environment": "dev",
-        },
-        {
-            "l_type": "info",
-            "t_type": "update",
-            "message": "User Max Mustermann updated",
-            "environment": "dev",
-        },
-        {
-            "l_type": "info",
-            "t_type": "create",
-            "author": "auth|max_muster",
-            "message": "User Max Mustermann created a Unit",
-            "object_reference": "1",
-            "environment": "dev",
-        },
-        {
-            "l_type": "info",
-            "t_type": "update",
-            "author": "auth|max_muster",
-            "message": "User Max Mustermann updated Unit 1",
-            "object_reference": "1",
-            "previous_object": {"name": "Unit 1"},
-            "environment": "prod",
-        },
-        {
-            "l_type": "warning",
-            "t_type": "delete",
-            "message": "User Max Mustermann deleted",
-            "environment": "prod",
-        },
-    ]
     with app_context(self) as app_id:
-        for entry in LOG_EXAMPLES:
+        for entry in ENTRY_EXAMPLES:
             self.log_message({"application": app_id, **entry})
         yield app_id
 
@@ -86,6 +91,7 @@ class TestAPI:
             global CURRENT_USER
             return CURRENT_USER
 
+        self.db_instance = get_db_test()
         app.dependency_overrides[get_db] = get_db_test
         app.dependency_overrides[verify] = get_test_sub
         self.c = GenericClient(app)
@@ -94,8 +100,8 @@ class TestAPI:
         drop_database(self.engine.url)
 
     # HELPERS
-    def create_app(self, name: str = "Testing"):
-        re = self.c.post("/app/", {"name": name})
+    def create_app(self, name: str = "Testing", retention_days: int | None = None):
+        re = self.c.post("/app/", {"name": name, "retention_days": retention_days})
         return re["id"]
 
     def destroy_app(self, app_id):
@@ -260,3 +266,29 @@ class TestAPI:
 
             re = self.c.get("/log/?application=" + str(app_id))
             assert re["total"] == 0
+
+    def test_retention_delete(self):
+        sess = next(self.db_instance)
+
+        with app_context(self, retention_days=2) as app_id:
+            for i in range(5):
+                sess.add(
+                    LogEntry(
+                        application=app_id,
+                        created_at=datetime.now() - timedelta(days=i),
+                        created_by_id=CURRENT_USER,
+                    )
+                )
+            sess.commit()
+
+            assert sess.query(LogEntry).count() == 5
+
+            re = self.c.get("/log/?application=" + str(app_id))
+            assert re["total"] == 5
+
+            delete_old_logs(sess)
+
+            assert sess.query(LogEntry).count() == 2
+
+            # delete all logs
+            re = self.c.delete("/log/?application=" + str(app_id), r_code=200)

renovate.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["config:recommended", ":semanticCommitTypeAll(feat)"],
+  "packageRules": [
+      {
+          "automerge": true,
+          "description": "Automerge non-major updates",
+          "matchUpdateTypes": ["minor", "patch"],
+          "automergeType": "branch"
+      }
+  ]
+}

requirements.txt

@@ -1,36 +1,39 @@
 annotated-types==0.7.0
-anyio==4.6.0
-certifi==2024.8.30
-creyPY==1.2.5
-fastapi==0.115.0
+anyio==4.9.0
+certifi==2025.1.31
+creyPY[postgres]==3.0.0
+fastapi==0.115.12
 fastapi-pagination==0.12.31
 h11==0.14.0
 httpcore==1.0.6
-httpx==0.27.2
+httpx==0.28.1
 idna==3.10
-psycopg==3.2.3
-psycopg-binary==3.2.3
-psycopg-pool==3.2.3
+psycopg==3.2.6
+psycopg-binary==3.2.6
+psycopg-pool==3.2.6
 pydantic==2.9.2
 pydantic_core==2.23.4
-python-dotenv==1.0.1
+python-dotenv==1.1.0
 sniffio==1.3.1
-SQLAlchemy==2.0.35
-starlette==0.38.6
-typing_extensions==4.12.2
+SQLAlchemy==2.0.40
+starlette==0.46.1
+typing_extensions==4.13.2
 
-Mako==1.3.5 # Alembic
+Mako==1.3.10 # Alembic
 MarkupSafe==3.0.1 # Alembic
-alembic==1.13.3 # Alembic
+alembic==1.15.2 # Alembic
 
 SQLAlchemy-Utils==0.41.2 # SQLAlchemy
 
-click==8.1.7 # Uvicorn
-uvicorn==0.31.1 # Uvicorn
+click==8.1.8 # Uvicorn
+uvicorn==0.34.0 # Uvicorn
 
-iniconfig==2.0.0 # pytest
+iniconfig==2.1.0 # pytest
 packaging==24.1 # pytest
 pluggy==1.5.0 # pytest
-pytest==8.3.3 # pytest
+pytest==8.3.5 # pytest
 
-fastapi-filters==0.2.9 # Filters
+fastapi-filters==0.3.0 # Filters
+
+APScheduler==3.11.0 # Scheduler for deletion
+tzlocal==5.3.1 # Scheduler for deletion