Add logging to state mutations

Author: PGijsbers

src/routers/openml/datasets.py

@@ -5,6 +5,7 @@
 from typing import Annotated, Any, Literal, NamedTuple
 
 from fastapi import APIRouter, Body, Depends
+from loguru import logger
 from sqlalchemy import bindparam, text
 from sqlalchemy.engine import Row
 from sqlalchemy.ext.asyncio import AsyncConnection
@@ -61,6 +62,7 @@ async def tag_dataset(
         raise TagAlreadyExistsError(msg)
 
     await database.datasets.tag(data_id, tag, user_id=user.user_id, connection=expdb_db)
+    logger.info("Dataset {dataset_id} tagged '{tag}'.", dataset_id=data_id, tag=tag)
     return {
         "data_tag": {"id": str(data_id), "tag": [*tags, tag]},
     }
@@ -375,6 +377,12 @@ async def update_dataset_status(
         msg = f"Unknown status transition: {current_status} -> {status}"
         raise InternalError(msg)
 
+    logger.info(
+        "Dataset {dataset_id} changed from {previous} to {current}",
+        dataset_id=dataset_id,
+        previous=current_status.status if current_status else DatasetStatus.IN_PREPARATION,
+        current=status,
+    )
     return {"dataset_id": dataset_id, "status": status}
 
 

src/routers/openml/setups.py

@@ -4,6 +4,7 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Body, Depends, Path
+from loguru import logger
 from sqlalchemy.ext.asyncio import AsyncConnection
 
 import database.setups
@@ -65,6 +66,7 @@ async def tag_setup(
         raise TagAlreadyExistsError(msg)
 
     await database.setups.tag(setup_id, tag, user.user_id, expdb_db)
+    logger.info("Setup {setup_id} tagged '{tag}'.", setup_id=setup_id, tag=tag)
     all_tags = [t.tag for t in setup_tags] + [tag]
     return {"setup_tag": {"id": str(setup_id), "tag": all_tags}}
 
@@ -94,9 +96,15 @@ async def untag_setup(
         msg = (
             f"You may not remove tag {tag!r} of setup {setup_id} because it was not created by you."
         )
+        logger.warning(
+            "User attempted to remove tag '{tag}' from setup {setup_id}.",
+            setup_id=setup_id,
+            tag=tag,
+        )
         raise TagNotOwnedError(msg)
 
     await database.setups.untag(setup_id, matched_tag_row.tag, expdb_db)
+    logger.info("Setup {setup_id} had tag '{tag}' removed.", setup_id=setup_id, tag=tag)
     remaining_tags = [
         t.tag for t in setup_tags if t.tag.casefold() != matched_tag_row.tag.casefold()
     ]

src/routers/openml/study.py

@@ -1,6 +1,7 @@
 from typing import Annotated, Literal
 
 from fastapi import APIRouter, Body, Depends
+from loguru import logger
 from pydantic import BaseModel
 from sqlalchemy.engine import Row
 from sqlalchemy.ext.asyncio import AsyncConnection
@@ -73,6 +74,11 @@ async def attach_to_study(
     # PHP lets *anyone* edit *any* study. We're not going to do that.
     if study.creator != user.user_id and not await user.is_admin():
         msg = f"Study {study_id} can only be edited by its creator."
+        logger.warning(
+            "User attempted to attach entities to study they do not own.",
+            study_id=study_id,
+            entity_ids=entity_ids,
+        )
         raise StudyNotEditableError(msg)
     if study.status != StudyStatus.IN_PREPARATION:
         msg = f"Study {study_id} can only be edited while in preparation."
@@ -93,6 +99,11 @@ async def attach_to_study(
     except ValueError as e:
         msg = str(e)
         raise StudyConflictError(msg) from e
+    logger.info(
+        "User {user_id} attached entities to study {study_id}.",
+        study_id=study_id,
+        entity_ids=entity_ids,
+    )
     return AttachDetachResponse(study_id=study_id, main_entity_type=study.type_)
 
 
@@ -124,6 +135,10 @@ async def create_study(
                 user=user,
                 expdb=expdb,
             )
+    logger.info(
+        "User {user_id} created study {study_id}.",
+        study_id=study_id,
+    )
     # Make sure that invalid fields raise an error (e.g., "task_ids")
     return {"study_id": study_id}