Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

fix(multi-user): preserve newer grant writes during preset rollback

Bingxi Zhao (Frank)c0d19dae0469
diff --git a/deeptutor/api/routers/multi_user.py b/deeptutor/api/routers/multi_user.py
index aedb505be..a96675292 100644
--- a/deeptutor/api/routers/multi_user.py
+++ b/deeptutor/api/routers/multi_user.py
@@ -26,11 +26,12 @@ from deeptutor.multi_user.device_credentials import revoke_device_credentials_fo
from deeptutor.multi_user.grants import (
LEARNING_AGE_BANDS,
LEARNING_SURFACES,
- grant_path,
learner_grant,
load_grant,
normalize_grant,
+ restore_grant_if_unchanged,
save_grant,
+ save_grant_with_receipt,
validate_grant,
)
from deeptutor.multi_user.guardians import (
@@ -59,7 +60,6 @@ from deeptutor.reading import ReadingStore
from deeptutor.reading.extensions import get_reading_extension_registry
from deeptutor.services.auth import POCKETBASE_ENABLED, hash_password
from deeptutor.services.config.model_catalog import ModelCatalogService
-from deeptutor.services.file_io import atomic_write_text
router = APIRouter()
@@ -690,40 +690,38 @@ async def put_guardian_restrictions(
reading["allow_upload"] = payload.allow_upload
reading["extensions"] = payload.extensions
needs_preset_update = learner_record.get("preset") != "learner"
- previous_grant_path = grant_path(learner_user_id) if needs_preset_update else None
- previous_grant_text = (
- previous_grant_path.read_text(encoding="utf-8")
- if previous_grant_path is not None and previous_grant_path.exists()
- else None
- )
try:
grant = normalize_grant(learner_user_id, grant)
validate_grant(grant)
_validate_reading_policy(grant)
- grant = save_grant(learner_user_id, grant)
+ if needs_preset_update:
+ grant, receipt = save_grant_with_receipt(learner_user_id, grant)
+ else:
+ grant = save_grant(learner_user_id, grant)
except ValueError as exc:
raise HTTPException(status_code=400, detail=str(exc)) from exc
+ except OSError as exc:
+ raise HTTPException(status_code=500, detail="Learner grant could not be saved") from exc
if needs_preset_update:
preset_error: Exception | None = None
try:
- preset_saved = set_preset(learner_username, "learner")
+ preset_saved = set_preset(learner_username, "learner", expected_user_id=learner_user_id)
except Exception as exc:
preset_saved = False
preset_error = exc
if not preset_saved:
- # The grant and account preset live in separate files. Restore the
- # exact prior grant if the second write fails, including absence.
- assert previous_grant_path is not None
try:
- if previous_grant_text is None:
- previous_grant_path.unlink(missing_ok=True)
- else:
- atomic_write_text(previous_grant_path, previous_grant_text)
+ restored = restore_grant_if_unchanged(learner_user_id, receipt)
except OSError as exc:
raise HTTPException(
status_code=500,
detail="Learner preset update failed and the prior grant could not be restored",
) from exc
+ if not restored:
+ raise HTTPException(
+ status_code=409,
+ detail="Learner preset update failed; a later grant change was preserved",
+ ) from preset_error
raise HTTPException(
status_code=500 if preset_error is not None else 409,
detail="Learner preset update failed; the prior grant was restored",
diff --git a/deeptutor/multi_user/identity.py b/deeptutor/multi_user/identity.py
index 5669872fb..34bb633df 100644
--- a/deeptutor/multi_user/identity.py
+++ b/deeptutor/multi_user/identity.py
@@ -473,7 +473,9 @@ def set_role(username: str, role: Role) -> bool:
return True
-def set_preset(username: str, preset: AccountPreset) -> bool:
+def set_preset(
+ username: str, preset: AccountPreset, *, expected_user_id: str | None = None
+) -> bool:
"""Update an account's configuration preset without changing its role."""
if preset not in {"standard", "learner", "custom"}:
raise ValueError("preset must be 'standard', 'learner', or 'custom'")
@@ -483,6 +485,11 @@ def set_preset(username: str, preset: AccountPreset) -> bool:
users = load_users()
if username not in users:
return False
+ if (
+ expected_user_id is not None
+ and str(users[username].get("id") or "") != expected_user_id
+ ):
+ return False
users[username]["preset"] = preset
_write_users(users)
return True
diff --git a/tests/multi_user/test_learning_surface_map.py b/tests/multi_user/test_learning_surface_map.py
index 1e8e16035..d85a854bb 100644
--- a/tests/multi_user/test_learning_surface_map.py
+++ b/tests/multi_user/test_learning_surface_map.py
@@ -185,9 +185,12 @@ def test_put_restrictions_flips_standard_preset_to_learner(
original_set_preset = multi_user.set_preset
- def set_preset_after_grant(username: str, preset: str) -> bool:
+ def set_preset_after_grant(
+ username: str, preset: str, *, expected_user_id: str | None = None
+ ) -> bool:
assert load_grant(learner_user_id)["learning_policy"]["age_band"] == "13-15"
- return original_set_preset(username, preset)
+ assert expected_user_id == learner_user_id
+ return original_set_preset(username, preset, expected_user_id=expected_user_id)
monkeypatch.setattr(multi_user, "set_preset", set_preset_after_grant)
@@ -223,7 +226,7 @@ def test_failed_grant_save_does_not_change_standard_preset(
def fail_save_grant(*_args, **_kwargs):
raise ValueError("Grant store unavailable")
- monkeypatch.setattr(multi_user, "save_grant", fail_save_grant)
+ monkeypatch.setattr(multi_user, "save_grant_with_receipt", fail_save_grant)
with pytest.raises(HTTPException, match="Grant store unavailable"):
asyncio.run(
multi_user.put_guardian_restrictions(
@@ -236,6 +239,46 @@ def test_failed_grant_save_does_not_change_standard_preset(
assert load_grant(learner_user_id).get("learning_policy") is None
+def test_failed_grant_io_reports_error_without_preset_change(
+ mu_isolated_root, seed_user, monkeypatch
+) -> None:
+ import asyncio
+ from types import SimpleNamespace
+
+ from fastapi import HTTPException
+
+ from deeptutor.api.routers import multi_user
+ from deeptutor.multi_user import grants
+ from deeptutor.multi_user.identity import get_user_by_id
+
+ seed_user("bootstrap-admin")
+ record = seed_user("student-standard")
+ learner_user_id = record["id"]
+ payload = multi_user.GuardianRestrictionsPayload(
+ age_band="13-15",
+ allow_upload=True,
+ allowed_surfaces=["chat", "reading"],
+ extensions=[],
+ )
+
+ def fail_write(_path, _text):
+ raise OSError("grant storage unavailable")
+
+ monkeypatch.setattr(grants, "atomic_write_text", fail_write)
+ with pytest.raises(HTTPException) as error:
+ asyncio.run(
+ multi_user.put_guardian_restrictions(
+ learner_user_id, payload, SimpleNamespace(user_id="u_admin", role="admin")
+ )
+ )
+
+ assert error.value.status_code == 500
+ assert error.value.detail == "Learner grant could not be saved"
+ _username, updated = get_user_by_id(learner_user_id)
+ assert updated["preset"] == "standard"
+ assert not grants.grant_path(learner_user_id).exists()
+
+
@pytest.mark.parametrize(
("preset_failure", "existing_grant", "status_code"),
[("returns_false", True, 409), ("raises", False, 500)],
@@ -271,7 +314,10 @@ def test_failed_preset_update_restores_previous_grant(
extensions=[],
)
- def fail_set_preset(_username: str, _preset: str) -> bool:
+ def fail_set_preset(
+ _username: str, _preset: str, *, expected_user_id: str | None = None
+ ) -> bool:
+ assert expected_user_id == learner_user_id
assert load_grant(learner_user_id)["learning_policy"]["age_band"] == "13-15"
if preset_failure == "raises":
raise OSError("users file is unavailable")
@@ -295,3 +341,117 @@ def test_failed_preset_update_restores_previous_grant(
assert not path.exists()
else:
assert path.read_text(encoding="utf-8") == previous_grant_text
+
+
[email protected]("newer_age_band", ["6-8", "13-15"])
+def test_preset_failure_keeps_a_later_grant_write(
+ mu_isolated_root, seed_user, monkeypatch, newer_age_band: str
+) -> None:
+ import asyncio
+ from threading import Thread
+ from types import SimpleNamespace
+
+ from fastapi import HTTPException
+
+ from deeptutor.api.routers import multi_user
+ from deeptutor.multi_user.grants import load_grant, save_grant
+ from deeptutor.multi_user.identity import get_user_by_id
+
+ seed_user("bootstrap-admin")
+ record = seed_user("student-standard")
+ learner_user_id = record["id"]
+ payload = multi_user.GuardianRestrictionsPayload(
+ age_band="13-15",
+ allow_upload=True,
+ allowed_surfaces=["chat", "reading"],
+ extensions=[],
+ )
+ writer_errors: list[Exception] = []
+
+ def write_newer_grant() -> None:
+ try:
+ changed = load_grant(learner_user_id)
+ changed["learning_policy"]["age_band"] = newer_age_band
+ save_grant(learner_user_id, changed)
+ except Exception as exc:
+ writer_errors.append(exc)
+
+ def fail_set_preset(
+ _username: str, _preset: str, *, expected_user_id: str | None = None
+ ) -> bool:
+ assert expected_user_id == learner_user_id
+ writer = Thread(target=write_newer_grant, daemon=True)
+ writer.start()
+ writer.join(timeout=5)
+ assert not writer.is_alive()
+ assert not writer_errors
+ return False
+
+ monkeypatch.setattr(multi_user, "set_preset", fail_set_preset)
+ with pytest.raises(HTTPException) as error:
+ asyncio.run(
+ multi_user.put_guardian_restrictions(
+ learner_user_id, payload, SimpleNamespace(user_id="u_admin", role="admin")
+ )
+ )
+
+ assert error.value.status_code == 409
+ assert "later grant change was preserved" in error.value.detail
+ assert load_grant(learner_user_id)["learning_policy"]["age_band"] == newer_age_band
+ _username, updated = get_user_by_id(learner_user_id)
+ assert updated["preset"] == "standard"
+
+
+def test_failed_grant_rollback_reports_storage_error(
+ mu_isolated_root, seed_user, monkeypatch
+) -> None:
+ import asyncio
+ from types import SimpleNamespace
+
+ from fastapi import HTTPException
+
+ from deeptutor.api.routers import multi_user
+ from deeptutor.multi_user import grants
+
+ seed_user("bootstrap-admin")
+ record = seed_user("student-standard")
+ learner_user_id = record["id"]
+ grants.save_grant(learner_user_id, {"enabled_tools": []})
+ payload = multi_user.GuardianRestrictionsPayload(
+ age_band="13-15",
+ allow_upload=True,
+ allowed_surfaces=["chat", "reading"],
+ extensions=[],
+ )
+ original_write = grants.atomic_write_text
+ write_count = 0
+
+ def fail_rollback(path, text):
+ nonlocal write_count
+ write_count += 1
+ if write_count == 2:
+ raise OSError("rollback unavailable")
+ return original_write(path, text)
+
+ monkeypatch.setattr(grants, "atomic_write_text", fail_rollback)
+ monkeypatch.setattr(multi_user, "set_preset", lambda *_args, **_kwargs: False)
+ with pytest.raises(HTTPException) as error:
+ asyncio.run(
+ multi_user.put_guardian_restrictions(
+ learner_user_id, payload, SimpleNamespace(user_id="u_admin", role="admin")
+ )
+ )
+
+ assert error.value.status_code == 500
+ assert "could not be restored" in error.value.detail
+ assert write_count == 2
+
+
+def test_set_preset_checks_expected_user_id(mu_isolated_root, seed_user) -> None:
+ from deeptutor.multi_user.identity import get_user_by_id, set_preset
+
+ seed_user("bootstrap-admin")
+ record = seed_user("student-standard")
+ assert set_preset("student-standard", "learner", expected_user_id="different") is False
+ _username, unchanged = get_user_by_id(record["id"])
+ assert unchanged["preset"] == "standard"