API stability fixes and dependency modernisation (#36)

* security fixes & packages upgrade

* add comments

Author: dpgiakatos

.gitignore

@@ -193,4 +193,5 @@ cython_debug/
 .cursorignore
 .cursorindexingignore
 
-alembic/versions/
+alembic/versions/
+.DS_Store

config/database.py

@@ -1,5 +1,5 @@
 from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker, declarative_base
+from sqlalchemy.orm import sessionmaker, DeclarativeBase
 import os
 from dotenv import load_dotenv
 import warnings
@@ -13,8 +13,19 @@
 # Read the database URL from the environment variable
 DATABASE_URL = os.getenv("DATABASE_URL")
 if DATABASE_URL is not None:
-    # Create the SQLAlchemy engine with the database URL
-    engine = create_engine(DATABASE_URL)
+    # Create the SQLAlchemy engine with the database URL.
+    # pool_size / max_overflow cap concurrent DB connections so one slow
+    # query can't starve the whole server.  statement_timeout kills any
+    # single query that runs longer than 60 s so a runaway request doesn't
+    # hold a connection indefinitely.
+    engine = create_engine(
+        DATABASE_URL,
+        pool_size=10,
+        max_overflow=5,
+        pool_timeout=30,
+        pool_pre_ping=True,
+        connect_args={"options": "-c statement_timeout=60000"},
+    )
     # Create a session factory
     SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
 else:
@@ -23,7 +34,8 @@
 # Base is the base class for all the SQLAlchemy ORM models.
 # It tells SQLAlchemy that a model maps to a real table.
 # Without inheriting from Base, the class won’t be recognized by SQLAlchemy’s ORM.
-Base = declarative_base()
+class Base(DeclarativeBase):
+    pass
 
 # Dependency to get a DB session for FastAPI routes (used in controllers)
 def get_db():

controllers/disco_controller.py

@@ -1,4 +1,4 @@
-from fastapi import APIRouter, Depends, Query, Request
+from fastapi import APIRouter, Depends, HTTPException, Query, Request
 from sqlalchemy.orm import Session
 from services.disco_service import DiscoService
 from dtos.generic_response_dto import GenericResponseDTO, build_url
@@ -56,16 +56,24 @@ async def get_events(
             None, description="Total number of Atlas probes active in the reported stream (ASN, Country, or geographical area)."),
         ongoing: Optional[str] = Query(
             None, description="Deprecated, this value is unused"),
+        include_probe_details: bool = Query(
+            False, description="Include per-probe details in the response."),
         page: Optional[int] = Query(
             1, ge=1, description="A page number within the paginated result set."),
         ordering: Optional[str] = Query(
             None, description="Which field to use when ordering the results")
     ) -> GenericResponseDTO[DiscoEventsDTO]:
         """
-        List network disconnections detected with RIPE Atlas. 
+        List network disconnections detected with RIPE Atlas.
         These events have different levels of granularity - it can be at a network level (AS), city, or country level.
         """
 
+        if not any([starttime, starttime__gte, starttime__lte, endtime, endtime__gte, endtime__lte]):
+            raise HTTPException(
+                status_code=400,
+                detail="At least one time parameter is required: starttime, starttime__gte, starttime__lte, endtime, endtime__gte, or endtime__lte."
+            )
+
         events_data, total_count = DiscoController.service.get_disco_events(
             db,
             streamname=streamname,
@@ -86,6 +94,7 @@ async def get_events(
             totalprobes_gte=totalprobes__gte,
             totalprobes_lte=totalprobes__lte,
             ongoing=ongoing,
+            include_probe_details=include_probe_details,
             page=page,
             order_by=ordering
         )

docs/add_new_endpoint.md

@@ -19,6 +19,55 @@ Create a service file in the `services/` directory or modify an existing one. Th
 ### 3. **Create the Repository**
 Add a repository file in the `repositories/` directory or modify an existing one. Ensure it handles pagination and ordering using `offset` and `limit`.
 
+Use the SQLAlchemy 2.0 `select()` style — **not** the legacy `db.query()` API.
+
+Example:
+```python
+# filepath: repositories/new_entity_repository.py
+from sqlalchemy.orm import Session
+from sqlalchemy import select, func
+from models.new_entity_model import NewEntity
+from typing import Optional, List, Tuple
+from utils import page_size
+
+
+class NewEntityRepository:
+    def get_all(
+        self,
+        db: Session,
+        field1: Optional[str] = None,
+        page: int = 1,
+        order_by: Optional[str] = None,
+    ) -> Tuple[List[NewEntity], int]:
+        stmt = select(NewEntity)
+
+        if field1:
+            stmt = stmt.where(NewEntity.field1 == field1)
+
+        total_count = db.scalar(select(func.count()).select_from(stmt.subquery()))
+
+        if order_by and hasattr(NewEntity, order_by):
+            stmt = stmt.order_by(getattr(NewEntity, order_by))
+
+        offset = (page - 1) * page_size
+        results = db.scalars(stmt.offset(offset).limit(page_size)).all()
+
+        return results, total_count
+```
+
+If the model has a relationship that needs to be loaded eagerly alongside the main query, use `contains_eager` with `of_type()`:
+```python
+from sqlalchemy.orm import contains_eager, aliased
+
+RelatedModel = aliased(NewEntity.related_relation.property.mapper.class_)
+stmt = (
+    select(NewEntity)
+    .join(NewEntity.related_relation.of_type(RelatedModel))
+    .options(contains_eager(NewEntity.related_relation.of_type(RelatedModel)))
+)
+# then add .where() clauses and call db.scalars(...).unique().all()
+```
+
 ---
 
 ### 4. **Define the Model**
@@ -88,14 +137,13 @@ Add a DTO in the `dtos/` directory to define the structure of the response.
 Example:
 ```python
 # filepath: dtos/new_entity_dto.py
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 class NewEntityDTO(BaseModel):
     field1: str
     field2: str
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)
 ```
 ---
 

dtos/country_dto.py

@@ -1,8 +1,7 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 
 class CountryDTO(BaseModel):
     code: str
     name: str
 
-    class Config:
-        from_attributes = True  
+    model_config = ConfigDict(from_attributes=True)

dtos/disco_events_dto.py

@@ -1,5 +1,5 @@
 from dtos.disco_probes_dto import DiscoProbesDTO
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from datetime import datetime
 from typing import List, Optional
 
@@ -13,13 +13,12 @@ class DiscoEventsDTO(BaseModel):
     nbdiscoprobes: int
     totalprobes: int
     ongoing: bool
-    discoprobes: List[DiscoProbesDTO]
+    discoprobes: Optional[List[DiscoProbesDTO]] = None
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)
 
     @staticmethod
-    def from_model(disco_event):
+    def from_model(disco_event, include_probe_details: bool = False):
         return DiscoEventsDTO(
             id=disco_event.id,
             streamtype=disco_event.streamtype,
@@ -30,6 +29,6 @@ def from_model(disco_event):
             nbdiscoprobes=disco_event.nbdiscoprobes,
             totalprobes=disco_event.totalprobes,
             ongoing=disco_event.ongoing,
-            discoprobes=[DiscoProbesDTO.from_orm(
-                probe) for probe in disco_event.probes]
+            discoprobes=[DiscoProbesDTO.model_validate(probe) for probe in disco_event.probes]
+            if include_probe_details else None,
         )

dtos/disco_probes_dto.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from datetime import datetime
 
 
@@ -13,5 +13,4 @@ class DiscoProbesDTO(BaseModel):
     lat: float
     lon: float
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)

dtos/hegemony_alarms_dto.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from datetime import datetime
 
 
@@ -11,5 +11,4 @@ class HegemonyAlarmsDTO(BaseModel):
     asn_name: str
     originasn_name: str
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)

dtos/hegemony_cone_dto.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from datetime import datetime
 
 
@@ -8,5 +8,4 @@ class HegemonyConeDTO(BaseModel):
     conesize: int
     af: int
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)

dtos/hegemony_country_dto.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
 from datetime import datetime
 
 
@@ -13,5 +13,4 @@ class HegemonyCountryDTO(BaseModel):
     weightscheme: str
     transitonly: bool
 
-    class Config:
-        from_attributes = True
+    model_config = ConfigDict(from_attributes=True)