mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-02-20 07:46:18 -05:00
b7bee132a1
- Refactored activity backend for full user-level management, using the db file - Revamped the activity sidebar UX and categorisation - Added download history and user filtering - Added User Preferences modal, giving limited configuration for non-admins - replaces the "restrict settings" config option. - Many many bug fixes - Many many new tests
246 lines
8.5 KiB
Python
246 lines
8.5 KiB
Python
"""Tests for activity service persistence helpers."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import tempfile
|
|
|
|
import pytest
|
|
|
|
from shelfmark.core.activity_service import (
|
|
ActivityService,
|
|
build_download_item_key,
|
|
build_item_key,
|
|
build_request_item_key,
|
|
)
|
|
from shelfmark.core.user_db import UserDB
|
|
|
|
|
|
@pytest.fixture
|
|
def db_path():
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
yield os.path.join(tmpdir, "users.db")
|
|
|
|
|
|
@pytest.fixture
|
|
def user_db(db_path):
|
|
db = UserDB(db_path)
|
|
db.initialize()
|
|
return db
|
|
|
|
|
|
@pytest.fixture
|
|
def activity_service(db_path):
|
|
return ActivityService(db_path)
|
|
|
|
|
|
class TestItemKeys:
|
|
def test_build_request_item_key(self):
|
|
assert build_request_item_key(42) == "request:42"
|
|
assert build_item_key("request", 7) == "request:7"
|
|
|
|
def test_build_download_item_key(self):
|
|
assert build_download_item_key("abc123") == "download:abc123"
|
|
assert build_item_key("download", "xyz") == "download:xyz"
|
|
|
|
def test_build_item_key_validation(self):
|
|
with pytest.raises(ValueError):
|
|
build_item_key("bad", "x")
|
|
with pytest.raises(ValueError):
|
|
build_item_key("request", "nope")
|
|
with pytest.raises(ValueError):
|
|
build_item_key("download", "")
|
|
|
|
|
|
class TestActivityService:
|
|
def test_record_snapshot_and_dismiss_and_history(self, user_db, activity_service):
|
|
user = user_db.create_user(username="activity-user")
|
|
snapshot = activity_service.record_terminal_snapshot(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-1",
|
|
origin="requested",
|
|
final_status="complete",
|
|
request_id=12,
|
|
source_id="task-1",
|
|
snapshot={"title": "My Book", "status": "complete"},
|
|
)
|
|
|
|
assert snapshot["item_type"] == "download"
|
|
assert snapshot["item_key"] == "download:task-1"
|
|
assert snapshot["origin"] == "requested"
|
|
assert snapshot["final_status"] == "complete"
|
|
|
|
dismissal = activity_service.dismiss_item(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-1",
|
|
)
|
|
assert dismissal["item_type"] == "download"
|
|
assert dismissal["item_key"] == "download:task-1"
|
|
assert dismissal["activity_log_id"] == snapshot["id"]
|
|
|
|
dismissed_set = activity_service.get_dismissal_set(user["id"])
|
|
assert dismissed_set == [{"item_type": "download", "item_key": "download:task-1"}]
|
|
|
|
history = activity_service.get_history(user["id"], limit=10, offset=0)
|
|
assert len(history) == 1
|
|
assert history[0]["item_type"] == "download"
|
|
assert history[0]["item_key"] == "download:task-1"
|
|
assert history[0]["origin"] == "requested"
|
|
assert history[0]["final_status"] == "complete"
|
|
assert history[0]["snapshot"] == {"title": "My Book", "status": "complete"}
|
|
|
|
def test_history_hydrates_legacy_request_dismissals_without_snapshot(self, user_db, activity_service):
|
|
user = user_db.create_user(username="legacy-reader")
|
|
request_row = user_db.create_request(
|
|
user_id=user["id"],
|
|
content_type="ebook",
|
|
request_level="book",
|
|
policy_mode="request_book",
|
|
book_data={
|
|
"title": "Legacy Request",
|
|
"author": "Legacy Author",
|
|
"provider": "openlibrary",
|
|
"provider_id": "legacy-hydrate-1",
|
|
},
|
|
status="fulfilled",
|
|
delivery_state="unknown",
|
|
)
|
|
|
|
activity_service.dismiss_item(
|
|
user_id=user["id"],
|
|
item_type="request",
|
|
item_key=f"request:{request_row['id']}",
|
|
)
|
|
|
|
history = activity_service.get_history(user["id"], limit=10, offset=0)
|
|
assert len(history) == 1
|
|
assert history[0]["item_type"] == "request"
|
|
assert history[0]["item_key"] == f"request:{request_row['id']}"
|
|
assert history[0]["origin"] == "request"
|
|
assert history[0]["final_status"] == "complete"
|
|
assert history[0]["snapshot"] == {
|
|
"kind": "request",
|
|
"request": {
|
|
"id": request_row["id"],
|
|
"user_id": user["id"],
|
|
"status": "fulfilled",
|
|
"delivery_state": "unknown",
|
|
"request_level": "book",
|
|
"book_data": {
|
|
"title": "Legacy Request",
|
|
"author": "Legacy Author",
|
|
"provider": "openlibrary",
|
|
"provider_id": "legacy-hydrate-1",
|
|
},
|
|
"release_data": {},
|
|
"note": None,
|
|
"admin_note": None,
|
|
"created_at": request_row["created_at"],
|
|
"updated_at": request_row["created_at"],
|
|
},
|
|
}
|
|
|
|
def test_dismiss_many_and_clear_history(self, user_db, activity_service):
|
|
alice = user_db.create_user(username="alice")
|
|
bob = user_db.create_user(username="bob")
|
|
|
|
activity_service.record_terminal_snapshot(
|
|
user_id=alice["id"],
|
|
item_type="request",
|
|
item_key="request:10",
|
|
origin="request",
|
|
final_status="rejected",
|
|
request_id=10,
|
|
snapshot={"title": "Rejected Book"},
|
|
)
|
|
activity_service.record_terminal_snapshot(
|
|
user_id=alice["id"],
|
|
item_type="download",
|
|
item_key="download:task-2",
|
|
origin="direct",
|
|
final_status="error",
|
|
source_id="task-2",
|
|
snapshot={"title": "Failed Download"},
|
|
)
|
|
|
|
dismissed_count = activity_service.dismiss_many(
|
|
user_id=alice["id"],
|
|
items=[
|
|
{"item_type": "request", "item_key": "request:10"},
|
|
{"item_type": "download", "item_key": "download:task-2"},
|
|
],
|
|
)
|
|
assert dismissed_count == 2
|
|
|
|
# Bob has independent dismiss state.
|
|
activity_service.dismiss_item(
|
|
user_id=bob["id"],
|
|
item_type="request",
|
|
item_key="request:10",
|
|
)
|
|
|
|
alice_history = activity_service.get_history(alice["id"])
|
|
bob_history = activity_service.get_history(bob["id"])
|
|
assert len(alice_history) == 2
|
|
assert len(bob_history) == 1
|
|
|
|
cleared = activity_service.clear_history(alice["id"])
|
|
assert cleared == 2
|
|
assert activity_service.get_history(alice["id"]) == []
|
|
assert len(activity_service.get_history(bob["id"])) == 1
|
|
|
|
def test_get_undismissed_terminal_downloads_returns_latest_per_item_and_excludes_dismissed(
|
|
self,
|
|
user_db,
|
|
activity_service,
|
|
):
|
|
user = user_db.create_user(username="snapshot-user")
|
|
|
|
activity_service.record_terminal_snapshot(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-1",
|
|
origin="direct",
|
|
final_status="error",
|
|
source_id="task-1",
|
|
terminal_at="2026-01-01T10:00:00+00:00",
|
|
snapshot={"kind": "download", "download": {"id": "task-1", "status_message": "failed"}},
|
|
)
|
|
activity_service.record_terminal_snapshot(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-1",
|
|
origin="direct",
|
|
final_status="complete",
|
|
source_id="task-1",
|
|
terminal_at="2026-01-01T11:00:00+00:00",
|
|
snapshot={"kind": "download", "download": {"id": "task-1", "status_message": "done"}},
|
|
)
|
|
activity_service.record_terminal_snapshot(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-2",
|
|
origin="direct",
|
|
final_status="cancelled",
|
|
source_id="task-2",
|
|
terminal_at="2026-01-01T09:00:00+00:00",
|
|
snapshot={"kind": "download", "download": {"id": "task-2", "status_message": "stopped"}},
|
|
)
|
|
|
|
activity_service.dismiss_item(
|
|
user_id=user["id"],
|
|
item_type="download",
|
|
item_key="download:task-2",
|
|
)
|
|
|
|
rows = activity_service.get_undismissed_terminal_downloads(user["id"])
|
|
assert len(rows) == 1
|
|
assert rows[0]["item_key"] == "download:task-1"
|
|
assert rows[0]["final_status"] == "complete"
|
|
assert rows[0]["snapshot"] == {
|
|
"kind": "download",
|
|
"download": {"id": "task-1", "status_message": "done"},
|
|
}
|