Skip to content

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

feat(learner): expose assigned interactive books

XZHc90fe4d0471a
diff --git a/deeptutor/api/routers/auth.py b/deeptutor/api/routers/auth.py
index 5764c3819..c0d595e03 100644
--- a/deeptutor/api/routers/auth.py
+++ b/deeptutor/api/routers/auth.py
@@ -614,6 +614,8 @@ def _learning_surface_for_path(
for root, surface in (
("/api/reading", "reading"),
("/api/courses", "reading"),
+ ("/api/books", "books"),
+ ("/api/dashboard/learning-library/books", "books"),
("/api/chat", "chat"),
("/api/question", "chat"),
("/api/question-notebook", "chat"),
diff --git a/deeptutor/multi_user/grants.py b/deeptutor/multi_user/grants.py
index 86a2735d3..7862ce83f 100644
--- a/deeptutor/multi_user/grants.py
+++ b/deeptutor/multi_user/grants.py
@@ -22,7 +22,7 @@ GRANTS_DIR = SYSTEM_ROOT / "grants"
LEARNING_CAPABILITIES = {"chat", "immersive_reading"}
LEARNING_AGE_BANDS = {"6-8", "9-12", "13-15"}
LEARNING_PERSONAS = {"teacher"}
-LEARNING_SURFACES = {"chat", "reading"}
+LEARNING_SURFACES = {"books", "chat", "reading"}
_EXTENSION_ID_RE = re.compile(r"^[a-z][a-z0-9_-]{0,63}$")
_GRANT_THREAD_LOCKS: dict[Path, threading.Lock] = {}
_GRANT_THREAD_LOCKS_GUARD = threading.Lock()
diff --git a/tests/api/test_book_shared_access.py b/tests/api/test_book_shared_access.py
index cb4cdf227..84d213d13 100644
--- a/tests/api/test_book_shared_access.py
+++ b/tests/api/test_book_shared_access.py
@@ -1,5 +1,7 @@
from __future__ import annotations
+from copy import deepcopy
+
from fastapi import Depends, FastAPI
from fastapi.testclient import TestClient
import pytest
@@ -21,6 +23,7 @@ def shared_env(tmp_path, monkeypatch):
from deeptutor.book import engine as engine_module
from deeptutor.book import storage as storage_module
from deeptutor.multi_user import audit, grants, identity, paths
+ from deeptutor.multi_user.grants import learner_grant, save_grant
from deeptutor.multi_user.identity import save_user, set_book_permission
from deeptutor.multi_user.paths import get_admin_path_service
from deeptutor.services import auth as auth_service
@@ -54,15 +57,36 @@ def shared_env(tmp_path, monkeypatch):
alice = save_user("alice", "hash", role="user")
bob = save_user("bob", "hash", role="user")
editor = save_user("editor", "hash", role="user")
+ default_learner = save_user("default-learner", "hash", role="user", preset="learner")
+ books_without_acl = save_user(
+ "books-without-acl", "hash", role="user", preset="learner"
+ )
+ reader = save_user("reader", "hash", role="user", preset="learner")
set_book_permission("alice", BookPermission(books=(("bk_shared", "read"),)))
set_book_permission("bob", BookPermission(books=(("bk_shared", "read"),)))
set_book_permission("editor", BookPermission(books=(("bk_shared", "edit"),)))
+ set_book_permission("default-learner", BookPermission(create=False))
+ set_book_permission("books-without-acl", BookPermission(create=False))
+ set_book_permission(
+ "reader", BookPermission(create=False, books=(("bk_shared", "read"),))
+ )
+ books_grant = deepcopy(learner_grant(reader["id"]))
+ books_grant["learning_policy"]["allowed_surfaces"] = ["chat", "reading", "books"]
+ save_grant(books_without_acl["id"], deepcopy(books_grant))
+ save_grant(reader["id"], books_grant)
tokens = {
"root": TokenPayload(username="root", role="admin", user_id=root["id"]),
"alice": TokenPayload(username="alice", role="user", user_id=alice["id"]),
"bob": TokenPayload(username="bob", role="user", user_id=bob["id"]),
"editor": TokenPayload(username="editor", role="user", user_id=editor["id"]),
+ "default-learner": TokenPayload(
+ username="default-learner", role="user", user_id=default_learner["id"]
+ ),
+ "books-without-acl": TokenPayload(
+ username="books-without-acl", role="user", user_id=books_without_acl["id"]
+ ),
+ "reader": TokenPayload(username="reader", role="user", user_id=reader["id"]),
}
monkeypatch.setattr(auth_router, "decode_token", lambda token: tokens.get(token))
@@ -90,11 +114,67 @@ def shared_env(tmp_path, monkeypatch):
app.include_router(
book_router.router,
prefix="/api",
- dependencies=[Depends(auth_router.require_auth)],
+ dependencies=[
+ Depends(auth_router.require_auth),
+ Depends(auth_router.require_learning_surface),
+ ],
)
return TestClient(app), shared
+def test_learner_books_surface_requires_explicit_grant(shared_env) -> None:
+ client, _ = shared_env
+
+ denied = client.get("/api/books", headers=_headers("default-learner"))
+ allowed = client.get("/api/books", headers=_headers("reader"))
+
+ assert denied.status_code == 403
+ assert allowed.status_code == 200
+
+
+def test_learner_with_books_surface_still_requires_shared_acl(shared_env) -> None:
+ client, _ = shared_env
+
+ response = client.get("/api/books", headers=_headers("books-without-acl"))
+
+ assert response.status_code == 200
+ assert response.json() == {"books": [], "can_create": False}
+
+
+def test_assigned_shared_book_is_read_only_for_learner(shared_env) -> None:
+ client, _ = shared_env
+
+ listing = client.get("/api/books", headers=_headers("reader")).json()
+ assert [book["id"] for book in listing["books"]] == ["bk_shared"]
+ assert listing["can_create"] is False
+ assert listing["books"][0]["source"] == "shared"
+ assert listing["books"][0]["permission"] == "read"
+ assert listing["books"][0]["can_edit"] is False
+ assert listing["books"][0]["can_delete"] is False
+
+ create = client.post(
+ "/api/books",
+ headers=_headers("reader"),
+ json={"user_intent": "New book"},
+ )
+ update = client.post(
+ "/api/books/update-block",
+ headers=_headers("reader"),
+ json={
+ "book_id": "bk_shared",
+ "page_id": "pg_1",
+ "block_id": "blk_1",
+ "body": "Nope",
+ "expected_revision": 1,
+ },
+ )
+ delete = client.delete("/api/books/bk_shared", headers=_headers("reader"))
+
+ assert create.status_code == 403
+ assert update.status_code == 404
+ assert delete.status_code == 404
+
+
def test_shared_learning_state_is_isolated_per_reader(shared_env) -> None:
client, canonical = shared_env
visit = client.post(
diff --git a/tests/multi_user/test_learning_policy.py b/tests/multi_user/test_learning_policy.py
index 0aa5ae61d..35e74c5a5 100644
--- a/tests/multi_user/test_learning_policy.py
+++ b/tests/multi_user/test_learning_policy.py
@@ -113,6 +113,8 @@ def test_surface_material_upload_and_extension_guards(mu_isolated_root, seed_use
with as_user(learner["id"], username="student"):
assert_learning_surface("chat")
assert_learning_surface("reading")
+ with pytest.raises(PermissionError, match="books surface"):
+ assert_learning_surface("books")
with pytest.raises(PermissionError, match="knowledge surface"):
assert_learning_surface("knowledge")
@@ -171,6 +173,7 @@ def test_learner_preset_falls_back_to_the_conservative_policy(mu_isolated_root,
assert policy is not None
assert policy["default_capability"] == "immersive_reading"
+ assert policy["allowed_surfaces"] == ["chat", "reading"]
assert policy["reading"] == {
"allow_upload": False,
"material_ids": [],
diff --git a/tests/multi_user/test_learning_surface_map.py b/tests/multi_user/test_learning_surface_map.py
index f1bdb0233..0111aa68b 100644
--- a/tests/multi_user/test_learning_surface_map.py
+++ b/tests/multi_user/test_learning_surface_map.py
@@ -26,6 +26,11 @@ from deeptutor.api.routers.auth import _learning_surface_for_path
# Pre-existing mappings keep working.
("/api/reading/materials", "GET", "reading"),
("/api/courses", "GET", "reading"),
+ ("/api/books", "GET", "books"),
+ ("/api/books/bk_123", "GET", "books"),
+ ("/api/books/quiz-attempt", "POST", "books"),
+ ("/api/dashboard/learning-library/books", "GET", "books"),
+ ("/api/books-private", "GET", ""),
("/api/chat/sessions", "GET", "chat"),
("/api/question/generate", "POST", "chat"),
("/api/sessions/abc", "GET", "chat"),