Challenger data exporter (#878)

## Description

### Summary

Allow admin to export data as xlsx

## Changes Made

<!--Please describe the changes made in this pull request-->

- ...

## Type of Change

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [x] ✨ New feature (non-breaking change which adds functionality)
- [ ] 🔨 Refactor (non-breaking change that neither fixes a bug nor adds
a feature)
- [ ] 🔧 Infra CI/CD (changes to configs of workflows)
- [ ] 💥 BREAKING CHANGE (fix or feature that require a new minimal
version of the front-end)

## Impact & Scope

- [ ] Core functionality changes
- [x] Single module changes
- [ ] Multiple modules changes
- [ ] Database migrations required
- [ ] Other

## Testing

- [x] Added/modified tests that pass the CI
- [x] Tested in a pre-prod
- [x] Tested this locally

## Documentation

- [ ] Updated docs accordingly (docs.myecl.fr) : <!--[Docs#0 -
Title](https://github.com/aeecleclair/myecl-documentation/pull/0)-->
- [ ] Code includes docstrings
- [x] No documentation needed

## Checklist

- [x] My code follows the style guidelines of this project
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] Any dependent changes have been merged and published (_Indicate
the linked PR for the dependent changes_)

## Additional Notes

Add any other context, screenshots, or information about the pull
request here.

Author: Rotheem

app/modules/sport_competition/cruds_sport_competition.py

@@ -313,10 +313,14 @@ async def remove_user_from_group(
 async def load_all_competition_users(
     edition_id: UUID,
     db: AsyncSession,
+    exclude_non_validated: bool = False,
 ) -> list[schemas_sport_competition.CompetitionUser]:
     competition_users = await db.execute(
         select(models_sport_competition.CompetitionUser).where(
             models_sport_competition.CompetitionUser.edition_id == edition_id,
+            models_sport_competition.CompetitionUser.validated
+            if exclude_non_validated
+            else and_(True),
         ),
     )
     return [
@@ -2219,6 +2223,27 @@ async def delete_product_variant_by_id(
 # region: Purchases
 
 
+async def load_all_purchases(
+    edition_id: UUID,
+    db: AsyncSession,
+) -> dict[str, list[schemas_sport_competition.PurchaseComplete]]:
+    purchases = await db.execute(
+        select(models_sport_competition.CompetitionPurchase)
+        .where(
+            models_sport_competition.CompetitionPurchase.edition_id == edition_id,
+        )
+        .options(
+            selectinload(models_sport_competition.CompetitionPurchase.product_variant),
+        ),
+    )
+    users_purchases: dict[str, list[schemas_sport_competition.PurchaseComplete]] = {}
+    for purchase in purchases.scalars().all():
+        if purchase.user_id not in users_purchases:
+            users_purchases[purchase.user_id] = []
+        users_purchases[purchase.user_id].append(purchase_model_to_schema(purchase))
+    return users_purchases
+
+
 async def load_purchases_by_user_id(
     user_id: str,
     edition_id: UUID,
@@ -2388,6 +2413,30 @@ async def delete_purchase(
 # region: Payments
 
 
+async def load_all_payments(
+    edition_id: UUID,
+    db: AsyncSession,
+) -> dict[str, list[schemas_sport_competition.PaymentComplete]]:
+    payments = await db.execute(
+        select(models_sport_competition.CompetitionPayment).where(
+            models_sport_competition.CompetitionPayment.edition_id == edition_id,
+        ),
+    )
+    users_payments: dict[str, list[schemas_sport_competition.PaymentComplete]] = {}
+    for payment in payments.scalars().all():
+        if payment.user_id not in users_payments:
+            users_payments[payment.user_id] = []
+        users_payments[payment.user_id].append(
+            schemas_sport_competition.PaymentComplete(
+                id=payment.id,
+                user_id=payment.user_id,
+                edition_id=payment.edition_id,
+                total=payment.total,
+            ),
+        )
+    return users_payments
+
+
 async def load_user_payments(
     user_id: str,
     edition_id: UUID,

app/modules/sport_competition/endpoints_sport_competition.py

@@ -1,8 +1,9 @@
 import logging
 from datetime import UTC, datetime
+from io import BytesIO
 from uuid import UUID, uuid4
 
-from fastapi import Body, Depends, File, HTTPException, UploadFile
+from fastapi import Body, Depends, File, HTTPException, Query, Response, UploadFile
 from fastapi.responses import FileResponse
 from sqlalchemy.ext.asyncio import AsyncSession
 
@@ -23,10 +24,16 @@
 )
 from app.modules.sport_competition.types_sport_competition import (
     CompetitionGroupType,
+    ExcelExportParams,
     ProductSchoolType,
 )
-from app.modules.sport_competition.utils_sport_competition import (
+from app.modules.sport_competition.utils.data_exporter import (
+    construct_users_excel_with_parameters,
+)
+from app.modules.sport_competition.utils.validation_checker import (
     check_validation_consistency,
+)
+from app.modules.sport_competition.utils_sport_competition import (
     checksport_category_compatibility,
     get_public_type_from_user,
     validate_payment,
@@ -344,6 +351,77 @@ async def get_current_user_competition(
     return competition_user
 
 
+@module.router.get(
+    "/competition/users/data-export",
+    response_class=FileResponse,
+    status_code=200,
+)
+async def export_competition_users_data(
+    included_fields: list[ExcelExportParams] = Query(default=[]),
+    exclude_non_validated: bool = False,
+    db: AsyncSession = Depends(get_db),
+    user: schemas_sport_competition.CompetitionUser = Depends(
+        is_user_in(group_id=GroupType.competition_admin),
+    ),
+    edition: schemas_sport_competition.CompetitionEdition = Depends(
+        get_current_edition,
+    ),
+):
+    """
+    Export competition users data for the current edition as a CSV file.
+    """
+    users = await cruds_sport_competition.load_all_competition_users(
+        edition.id,
+        db,
+        exclude_non_validated=exclude_non_validated,
+    )
+    products = await cruds_sport_competition.load_products(
+        edition.id,
+        db,
+    )
+    sports = await cruds_sport_competition.load_all_sports(db)
+    schools = await cruds_sport_competition.load_all_schools(edition.id, db)
+
+    participants = None
+    if ExcelExportParams.participants in included_fields:
+        all_participants = await cruds_sport_competition.load_all_participants(
+            edition.id,
+            db,
+        )
+        participants = {p.user_id: p for p in all_participants}
+    payments = None
+    if ExcelExportParams.payments in included_fields:
+        payments = await cruds_sport_competition.load_all_payments(edition.id, db)
+    purchases = await cruds_sport_competition.load_all_purchases(edition.id, db)
+
+    excel_io = BytesIO()
+
+    construct_users_excel_with_parameters(
+        parameters=included_fields,
+        sports=sports,
+        schools=schools,
+        users=users,
+        products=products,
+        users_participant=participants,
+        users_payments=payments,
+        users_purchases=purchases,
+        export_io=excel_io,
+    )
+
+    res = excel_io.getvalue()
+
+    excel_io.close()
+
+    headers = {
+        "Content-Disposition": f'attachment; filename="competition_users_{edition.name}.xlsx"',
+    }
+    return Response(
+        res,
+        headers=headers,
+        media_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    )
+
+
 @module.router.get(
     "/competition/users/{user_id}",
     response_model=schemas_sport_competition.CompetitionUser,

app/modules/sport_competition/types_sport_competition.py

@@ -35,3 +35,9 @@ class ProductSchoolType(Enum):
     centrale = "centrale"
     from_lyon = "from_lyon"
     others = "others"
+
+
+class ExcelExportParams(Enum):
+    participants = "participants"
+    purchases = "purchases"
+    payments = "payments"