Page the admin panel routes, and add a hard-delete route in admin panel. (Fixes #925) (#926)

* Page the admin panel routes, and add a hard-delete route in admin panel. (Fixes #925)

* lint fixes

* 🌐 Update German language

---------

Co-authored-by: Andreas Müller <[email protected]>

Author: MelissaAutumn

backend/src/appointment/database/schemas.py

@@ -159,7 +159,7 @@ class Availability(AvailabilityBase):
 
 
 class ScheduleBase(BaseModel):
-    model_config = ConfigDict(json_encoders = { time: lambda t: t.strftime('%H:%M') })
+    model_config = ConfigDict(json_encoders={time: lambda t: t.strftime('%H:%M')})
 
     active: bool | None = True
     name: str = Field(min_length=1, max_length=128)
@@ -195,7 +195,7 @@ class ScheduleValidationIn(ScheduleBase):
     """ScheduleBase but with specific fields overridden to add validation."""
 
     # Regex to exclude any character can be mess with a url
-    slug: Annotated[Optional[str], Field(min_length=2, max_length=16, pattern=r"^[^\;\/\?\:\@\&\=\+\$\,\#]*$")] = None
+    slug: Annotated[Optional[str], Field(min_length=2, max_length=16, pattern=r'^[^\;\/\?\:\@\&\=\+\$\,\#]*$')] = None
     slot_duration: Annotated[int, Field(ge=10, default=30)]
     # Require these fields
     start_date: date
@@ -211,29 +211,26 @@ def start_time_should_be_before_end_time(self) -> Self:
         # Fallback to utc...
         tz = self.timezone or 'UTC'
 
-        start_time = datetime.combine(
-            self.start_date,
-            self.start_time,
-            tzinfo=timezone.utc).astimezone(zoneinfo.ZoneInfo(tz)
+        start_time = datetime.combine(self.start_date, self.start_time, tzinfo=timezone.utc).astimezone(
+            zoneinfo.ZoneInfo(tz)
         )
 
-        end_time = datetime.combine(
-            self.start_date,
-            self.end_time,
-            tzinfo=timezone.utc).astimezone(zoneinfo.ZoneInfo(tz)
+        end_time = datetime.combine(self.start_date, self.end_time, tzinfo=timezone.utc).astimezone(
+            zoneinfo.ZoneInfo(tz)
         )
 
-        start_time = (start_time + timedelta(minutes=self.slot_duration))
+        start_time = start_time + timedelta(minutes=self.slot_duration)
         end_time = end_time
         # Compare time objects!
         if start_time.time() > end_time.time():
             msg = l10n('error-minimum-value')
 
             # These can't be field or value because that will auto-format the msg? Weird feature but okay.
-            raise PydanticCustomError(defines.END_TIME_BEFORE_START_TIME_ERR, msg, {
-                'err_field': 'end_time',
-                'err_value': start_time.astimezone(timezone.utc).time()
-            })
+            raise PydanticCustomError(
+                defines.END_TIME_BEFORE_START_TIME_ERR,
+                msg,
+                {'err_field': 'end_time', 'err_value': start_time.astimezone(timezone.utc).time()},
+            )
 
         return self
 
@@ -286,6 +283,8 @@ class CalendarOut(CalendarBase):
 
 
 class Invite(BaseModel):
+    model_config = ConfigDict(from_attributes=True)
+
     subscriber_id: int | None = None
     owner_id: Optional[int] = None
     code: str
@@ -339,14 +338,38 @@ class SubscriberMeOut(SubscriberBase):
     schedule_links: list[str] = []
 
 
-class SubscriberAdminOut(Subscriber):
+class SubscriberAdminItem(Subscriber):
     model_config = ConfigDict(from_attributes=True)
 
     invite: Invite | None = None
     time_created: datetime
     time_deleted: datetime | None
 
 
+class Paginator(BaseModel):
+    page: int
+    total_pages: int
+    count: int
+    per_page: int
+
+
+class ListResponse(BaseModel):
+    items: list
+    page_meta: Paginator
+
+
+class SubscriberAdminOut(ListResponse):
+    items: list[SubscriberAdminItem]
+
+
+class ListResponseIn(BaseModel):
+    page: int = 1
+    per_page: int = 50
+
+
+class InviteAdminOut(ListResponse):
+    items: list[Invite]
+
 """ other schemas used for requests or data migration
 """
 
@@ -471,7 +494,7 @@ class WaitingListInviteAdminOut(BaseModel):
     errors: list[str]
 
 
-class WaitingListAdminOut(BaseModel):
+class WaitingListAdminOutItem(BaseModel):
     model_config = ConfigDict(from_attributes=True)
 
     id: int
@@ -484,6 +507,10 @@ class WaitingListAdminOut(BaseModel):
     invite: Invite | None = None
 
 
+class WaitingListAdminOut(ListResponse):
+    items: list[WaitingListAdminOutItem]
+
+
 class PageLoadIn(BaseModel):
     browser: Optional[str] = None
     browser_version: Optional[str] = None

backend/src/appointment/exceptions/validation.py

@@ -283,6 +283,16 @@ def get_msg(self):
         return l10n('subscriber-already-deleted')
 
 
+class SubscriberNotDisabledException(APIException):
+    """Raise when a subscriber is not disabled before being hard deleted."""
+
+    id_code = 'SUBSCRIBER_NOT_DISABLED'
+    status_code = 400
+
+    def get_msg(self):
+        return l10n('subscriber-not-disabled')
+
+
 class SubscriberAlreadyEnabledException(APIException):
     """Raise when a subscriber failed to be marked undeleted because they already are"""
 

backend/src/appointment/l10n/de/main.ftl

@@ -61,6 +61,7 @@ subscriber-already-exists = Eine Person mit dieser E-Mail-Adresse existiert bere
 subscriber-already-deleted = Die Person ist bereits gelöscht.
 subscriber-already-enabled = Die Person ist bereits aktiv.
 subscriber-self-delete = Die Löschung des eigenen Benutzerkontos ist hier nicht möglich.
+subscriber-not-disabled = Die Person muss deaktiviert sein, bevor sie gänzlich gelöscht werden kann.
 
 rate-limit-exceeded = Zu viele Anfragen in zu kurzem Zeitraum. Bitte später noch einmal versuchen.
 

backend/src/appointment/l10n/en/main.ftl

@@ -61,6 +61,7 @@ subscriber-already-exists = A subscriber with this email address already exists.
 subscriber-already-deleted = The subscriber is already deleted.
 subscriber-already-enabled = The subscriber is already enabled.
 subscriber-self-delete = You are not allowed to delete yourself here.
+subscriber-not-disabled = You must disable a subscriber before you can hard-delete their account.
 
 rate-limit-exceeded = Too many requests in a short period. Please try again later.
 

backend/src/appointment/routes/invite.py

@@ -1,3 +1,5 @@
+import math
+
 from fastapi import APIRouter, Depends, BackgroundTasks
 
 from sqlalchemy.orm import Session
@@ -20,10 +22,23 @@
 """
 
 
-@router.get('/', response_model=list[schemas.Invite])
-def get_all_invites(db: Session = Depends(get_db), _admin: Subscriber = Depends(get_admin_subscriber)):
+@router.post('/', response_model=schemas.InviteAdminOut)
+def get_all_invites(
+    data: schemas.ListResponseIn, db: Session = Depends(get_db), _admin: Subscriber = Depends(get_admin_subscriber)
+):
     """List all existing invites, needs admin permissions"""
-    return db.query(models.Invite).all()
+    page = data.page - 1
+    per_page = data.per_page
+
+    total_count = db.query(models.Subscriber).count()
+    invites = db.query(models.Invite).order_by('time_created').offset(page * per_page).limit(per_page).all()
+
+    return schemas.InviteAdminOut(
+        items=invites,
+        page_meta=schemas.Paginator(
+            page=data.page, per_page=per_page, count=len(invites), total_pages=math.ceil(total_count / per_page)
+        ),
+    )
 
 
 @router.post('/generate/{n}', response_model=list[schemas.Invite])

backend/src/appointment/routes/subscriber.py

@@ -1,6 +1,8 @@
-from fastapi import APIRouter, Depends, Request
+import math
 
-from sqlalchemy.orm import Session
+from fastapi import APIRouter, Depends
+
+from sqlalchemy.orm import Session, joinedload
 
 from ..database import repo, schemas, models
 from ..database.models import Subscriber
@@ -15,11 +17,34 @@
 These require get_admin_subscriber!
 """
 
-@router.get('/', response_model=list[schemas.SubscriberAdminOut])
-def get_all_subscriber(request: Request, db: Session = Depends(get_db), _: Subscriber = Depends(get_admin_subscriber)):
+
+@router.post('/', response_model=schemas.SubscriberAdminOut)
+def get_all_subscriber(
+    data: schemas.ListResponseIn, db: Session = Depends(get_db), _: Subscriber = Depends(get_admin_subscriber)
+):
     """List all existing invites, needs admin permissions"""
-    response = db.query(models.Subscriber).all()
-    return response
+    page = data.page - 1
+    per_page = data.per_page
+
+    total_count = db.query(models.Subscriber).count()
+    subscribers = (
+        db.query(models.Subscriber)
+        .options(joinedload(models.Subscriber.invite))
+        .order_by('time_created')
+        .offset(page * per_page)
+        .limit(per_page)
+        .all()
+    )
+
+    return schemas.SubscriberAdminOut(
+        items=subscribers,
+        page_meta=schemas.Paginator(
+            page=data.page,
+            per_page=per_page,
+            count=len(subscribers),
+            total_pages=math.ceil(total_count / per_page)
+        ),
+    )
 
 
 @router.put('/disable/{email}')
@@ -52,6 +77,23 @@ def enable_subscriber(email: str, db: Session = Depends(get_db), _: Subscriber =
     return repo.subscriber.enable(db, subscriber_to_enable)
 
 
+@router.put('/hard-delete/{id}')
+def hard_delete_subscriber(
+    id: str, db: Session = Depends(get_db), subscriber: Subscriber = Depends(get_admin_subscriber)
+):
+    """endpoint to hard-delete a subscriber by email, needs admin permissions"""
+    subscriber_to_delete = repo.subscriber.get(db, int(id))
+    if not subscriber_to_delete:
+        raise validation.SubscriberNotFoundException()
+    if not subscriber_to_delete.is_deleted:
+        raise validation.SubscriberNotDisabledException()
+    if subscriber.email == subscriber_to_delete.email:
+        raise validation.SubscriberSelfDeleteException()
+
+    # Nuke their account
+    return repo.subscriber.hard_delete(db, subscriber_to_delete)
+
+
 """ NON-ADMIN ROUTES """
 
 

backend/src/appointment/routes/waiting_list.py

@@ -1,3 +1,4 @@
+import math
 import os
 
 import sentry_sdk
@@ -27,12 +28,9 @@ class WaitingListAction(Enum):
 
 
 @router.post('/join')
-@limiter.limit("2/minute")
+@limiter.limit('2/minute')
 def join_the_waiting_list(
-    request: Request,
-    data: schemas.JoinTheWaitingList,
-    background_tasks: BackgroundTasks,
-    db: Session = Depends(get_db)
+    request: Request, data: schemas.JoinTheWaitingList, background_tasks: BackgroundTasks, db: Session = Depends(get_db)
 ):
     """Join the waiting list!"""
     email = data.email.lower()
@@ -78,11 +76,7 @@ def act_on_waiting_list(data: schemas.TokenForWaitingList, db: Session = Depends
         waiting_list_entry = repo.invite.get_waiting_list_entry_by_email(db, email)
 
         if waiting_list_entry and waiting_list_entry.invite_id and waiting_list_entry.invite.subscriber_id:
-            return {
-                'action': action,
-                'success': False,
-                'redirectToSettings': True
-            }
+            return {'action': action, 'success': False, 'redirectToSettings': True}
 
         success = repo.invite.remove_waiting_list_email(db, email)
     else:
@@ -108,11 +102,28 @@ def act_on_waiting_list(data: schemas.TokenForWaitingList, db: Session = Depends
 """
 
 
-@router.get('/', response_model=list[schemas.WaitingListAdminOut])
-def get_all_waiting_list_users(db: Session = Depends(get_db), _: models.Subscriber = Depends(get_admin_subscriber)):
+@router.post('/', response_model=schemas.WaitingListAdminOut)
+def get_all_waiting_list_users(
+    data: schemas.ListResponseIn, db: Session = Depends(get_db), _: models.Subscriber = Depends(get_admin_subscriber)
+):
     """List all existing waiting list users, needs admin permissions"""
-    response = db.query(models.WaitingList).all()
-    return response
+    page = data.page - 1
+    per_page = data.per_page
+
+    total_count = db.query(models.WaitingList).count()
+    waiting_list_items = (
+        db.query(models.WaitingList).order_by('time_created').offset(page * per_page).limit(per_page).all()
+    )
+
+    return schemas.WaitingListAdminOut(
+        items=waiting_list_items,
+        page_meta=schemas.Paginator(
+            page=data.page,
+            per_page=per_page,
+            count=len(waiting_list_items),
+            total_pages=math.ceil(total_count / per_page),
+        ),
+    )
 
 
 @router.post('/invite', response_model=schemas.WaitingListInviteAdminOut)
@@ -139,7 +150,7 @@ def invite_waiting_list_users(
 
     for id in data.id_list:
         # Look the user up!
-        waiting_list_user: models.WaitingList|None = (
+        waiting_list_user: models.WaitingList | None = (
             db.query(models.WaitingList).filter(models.WaitingList.id == id).first()
         )
         # If the user doesn't exist, or if they're already invited ignore them
@@ -179,17 +190,21 @@ def invite_waiting_list_users(
             send_invite_account_email,
             date=waiting_list_user.time_created,
             to=subscriber.email,
-            lang=subscriber.language
+            lang=subscriber.language,
         )
         accepted.append(waiting_list_user.id)
 
     if posthog:
-        posthog.capture(distinct_id=admin.unique_hash, event='apmt.admin.invited', properties={
-            'from': 'waitingList',
-            'waiting-list-ids': accepted,
-            'errors-encountered': len(errors),
-            'service': 'apmt'
-        })
+        posthog.capture(
+            distinct_id=admin.unique_hash,
+            event='apmt.admin.invited',
+            properties={
+                'from': 'waitingList',
+                'waiting-list-ids': accepted,
+                'errors-encountered': len(errors),
+                'service': 'apmt',
+            },
+        )
 
     return schemas.WaitingListInviteAdminOut(
         accepted=accepted,

backend/test/integration/test_general.py

@@ -57,10 +57,10 @@ def test_health_for_locale(self, with_client):
         ('get', '/schedule'),
         ('get', '/schedule/0'),
         ('put', '/schedule/0'),
-        ('get', '/invite'),
+        ('post', '/invite'),
         ('post', '/invite/generate/1'),
         ('put', '/invite/revoke/1'),
-        ('get', '/subscriber'),
+        ('post', '/subscriber'),
         ('put', '/subscriber/enable/[email protected]'),
         ('put', '/subscriber/disable/[email protected]'),
         ('post', '/subscriber/setup'),