Files
ds-chat/backend/tests/test_direct_messages.py
ksmithandClaude Sonnet 5 4cc3823adf Fix DM presence indicator never updating live (#63)
The sidebar shows every DM's online/offline dot at once, but the only
existing signal for a presence change (member_updated) is broadcast to
a room's own channel, which Presence only delivers to a connection that
currently has that specific room joined -- never true for a DM sitting
unopened in the sidebar. Add a dedicated per-user broadcast
(dm_presence_update) sent to each of a user's DM partners on their own
per-user channel whenever their global online/offline state changes, so
the sidebar dot updates without needing that DM to be the open room.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-27 20:41:57 -06:00

343 lines
15 KiB
Python

import uuid
from sqlalchemy import select
from app.models import Room, RoomMembership
from app.schemas.user import UserCreate
from app.services.auth_service import register_user
from app.services.room_service import dm_room_name
from tests.conftest import login_as, register_and_login
def _unique(prefix: str) -> str:
return f"{prefix}-{uuid.uuid4().hex[:8]}"
def _register_ws(ws_client, username: str) -> dict:
async def _seed():
async with ws_client.session_factory() as session:
await register_user(
session,
UserCreate(username=username, email=f"{username}@example.com", password="password123"),
)
ws_client.portal.call(_seed)
resp = ws_client.post(
"/api/auth/login", json={"username_or_email": username, "password": "password123"}
)
assert resp.status_code == 200, resp.text
return resp.json()
async def test_start_dm_creates_private_room_with_both_members(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
await client.post("/api/auth/logout")
await login_as(client, "alice")
resp = await client.post("/api/rooms/dm", json={"other_user_id": bob["id"]})
assert resp.status_code == 201, resp.text
room = resp.json()
assert room["is_dm"] is True
assert room["is_private"] is True
# The internal name is never meant to be shown, but its scheme is part
# of the contract find_or_create_dm relies on -- pin it here so a
# future refactor can't silently change it without this test noticing.
assert room["name"] == dm_room_name(uuid.UUID(alice["id"]), uuid.UUID(bob["id"]))
result = await db_session.execute(
select(RoomMembership.user_id).where(RoomMembership.room_id == uuid.UUID(room["id"]))
)
member_ids = {str(row[0]) for row in result.all()}
assert member_ids == {alice["id"], bob["id"]}
async def test_start_dm_is_idempotent_regardless_of_who_initiates(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
resp1 = await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
assert resp1.status_code == 201
room_id = resp1.json()["id"]
# bob -> alice again should return the same room, not create a second one.
resp2 = await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
assert resp2.status_code == 201
assert resp2.json()["id"] == room_id
await client.post("/api/auth/logout")
await login_as(client, "alice")
# alice -> bob (reversed direction) should also find the same room.
resp3 = await client.post("/api/rooms/dm", json={"other_user_id": bob["id"]})
assert resp3.status_code == 201
assert resp3.json()["id"] == room_id
async def test_start_dm_rejects_self(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
resp = await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
assert resp.status_code == 400
async def test_start_dm_404s_for_unknown_user(client, db_session):
await register_and_login(client, db_session, username="alice")
resp = await client.post("/api/rooms/dm", json={"other_user_id": str(uuid.uuid4())})
assert resp.status_code == 404
async def test_dm_excluded_from_browse_rooms(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
# A third user should never see the DM in the open-rooms listing, even
# though find_or_create_dm sets is_private=True (which alone would
# already exclude it) -- confirms the belt-and-suspenders is_dm filter
# in list_open_rooms is doing something, not just is_private.
await client.post("/api/auth/logout")
await register_and_login(client, db_session, username="carol")
resp = await client.get("/api/rooms")
assert resp.status_code == 200
assert all(not r["is_dm"] for r in resp.json())
async def test_dm_excluded_from_admin_room_list(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
await client.post("/api/auth/logout")
admin = await register_and_login(client, db_session, username="dave")
from app.models import User
user = await db_session.get(User, uuid.UUID(admin["id"]))
user.is_site_admin = True
await db_session.commit()
resp = await client.get("/api/admin/rooms")
assert resp.status_code == 200
names = [r["name"] for r in resp.json()]
assert dm_room_name(uuid.UUID(alice["id"]), uuid.UUID(bob["id"])) not in names
async def test_dm_appears_in_mine_with_partner_info(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob", password="password123")
# Give bob a display name so the partner payload's precedence is checked
# for something other than the fallback username.
await client.patch("/api/auth/me", json={"display_name": "Bobby"})
dm = (await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})).json()
await client.post("/api/auth/logout")
await login_as(client, "alice")
mine = (await client.get("/api/rooms/mine")).json()
dm_entry = next(r for r in mine if r["id"] == dm["id"])
assert dm_entry["is_dm"] is True
assert dm_entry["dm_partner"]["user_id"] == bob["id"]
assert dm_entry["dm_partner"]["username"] == "bob"
assert dm_entry["dm_partner"]["display_name"] == "Bobby"
# A regular room's dm_partner is always null.
room = (await client.post("/api/rooms", json={"name": "general"})).json()
mine = (await client.get("/api/rooms/mine")).json()
room_entry = next(r for r in mine if r["id"] == room["id"])
assert room_entry["is_dm"] is False
assert room_entry["dm_partner"] is None
async def test_dm_cannot_be_updated(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
dm = (await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})).json()
# bob is a plain 'member' of the DM (no admin/owner role exists for a
# DM), so this 403s on the ordinary role gate before ever reaching
# update_room's own is_dm guard.
resp = await client.patch(f"/api/rooms/{dm['id']}", json={"name": "renamed"})
assert resp.status_code == 403
# A site admin bypasses that role gate (see #48) -- confirms the
# explicit is_dm guard inside update_room itself is what stops this,
# not just incidental role-based protection.
await client.post("/api/auth/logout")
admin = await register_and_login(client, db_session, username="carol")
from app.models import User
user = await db_session.get(User, uuid.UUID(admin["id"]))
user.is_site_admin = True
await db_session.commit()
resp = await client.patch(f"/api/rooms/{dm['id']}", json={"name": "renamed"})
assert resp.status_code == 400
async def test_dm_rejects_add_member_and_join(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
dm = (await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})).json()
await client.post("/api/auth/logout")
carol = await register_and_login(client, db_session, username="carol")
# Neither participant has admin/owner role in a DM, so adding a third
# person 403s on the existing role gate.
await client.post("/api/auth/logout")
await login_as(client, "bob")
resp = await client.post(f"/api/rooms/{dm['id']}/members", json={"user_id": carol["id"]})
assert resp.status_code == 403
# is_private=True on the DM already blocks the plain join endpoint too.
await client.post("/api/auth/logout")
await login_as(client, "carol")
resp = await client.post(f"/api/rooms/{dm['id']}/join")
assert resp.status_code == 400
async def test_hide_dm_removes_it_from_mine_for_that_user_only(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
dm = (await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})).json()
resp = await client.post(f"/api/rooms/{dm['id']}/hide")
assert resp.status_code == 204
mine = (await client.get("/api/rooms/mine")).json()
assert all(r["id"] != dm["id"] for r in mine)
# Alice never hid it -- still sees it, proving this is per-viewer, not
# something that touched the room or bob's membership for everyone.
await client.post("/api/auth/logout")
await login_as(client, "alice")
mine = (await client.get("/api/rooms/mine")).json()
assert any(r["id"] == dm["id"] for r in mine)
async def test_hide_dm_rejects_regular_rooms(client, db_session):
await register_and_login(client, db_session, username="alice")
room = (await client.post("/api/rooms", json={"name": "general"})).json()
resp = await client.post(f"/api/rooms/{room['id']}/hide")
assert resp.status_code == 400
async def test_starting_a_dm_again_unhides_it(client, db_session):
alice = await register_and_login(client, db_session, username="alice")
await client.post("/api/auth/logout")
bob = await register_and_login(client, db_session, username="bob")
dm = (await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})).json()
await client.post(f"/api/rooms/{dm['id']}/hide")
mine = (await client.get("/api/rooms/mine")).json()
assert all(r["id"] != dm["id"] for r in mine)
# bob clicking alice in the People list again -- find_or_create_dm
# resolves to the same room and un-hides it for him.
resp = await client.post("/api/rooms/dm", json={"other_user_id": alice["id"]})
assert resp.status_code == 201
assert resp.json()["id"] == dm["id"]
mine = (await client.get("/api/rooms/mine")).json()
assert any(r["id"] == dm["id"] for r in mine)
def test_new_message_unhides_dm_for_both_participants(ws_client):
alice = _register_ws(ws_client, _unique("alice"))
bob = _register_ws(ws_client, _unique("bob")) # ws_client is now logged in as bob
dm = ws_client.post("/api/rooms/dm", json={"other_user_id": alice["id"]}).json()
ws_client.post(f"/api/rooms/{dm['id']}/hide")
assert all(r["id"] != dm["id"] for r in ws_client.get("/api/rooms/mine").json())
ws_client.post(
"/api/auth/login", json={"username_or_email": alice["username"], "password": "password123"}
)
with ws_client.websocket_connect("/ws/chat") as ws:
ws.send_json({"type": "join", "room_id": dm["id"]})
assert ws.receive_json()["type"] == "joined"
ws.send_json({"type": "message", "room_id": dm["id"], "content": "you there?"})
ws.receive_json()
# Sync barrier (see test_mentions.py's identical helper): the
# message ack only proves the room-level broadcast happened, not
# that broadcast_new_message's own continuation (which un-hides
# the room) has finished -- a second frame's own ack proves that.
ws.send_json({"type": "join", "room_id": dm["id"]})
assert ws.receive_json()["type"] == "joined"
# bob never re-opened the DM himself -- alice's message alone unhid it.
ws_client.post(
"/api/auth/login", json={"username_or_email": bob["username"], "password": "password123"}
)
assert any(r["id"] == dm["id"] for r in ws_client.get("/api/rooms/mine").json())
def test_dm_partner_presence_update_delivered_without_room_open(ws_client_factory):
# #63: alice never joins the DM's own room channel anywhere in this
# test -- exactly the normal state for a DM sitting in the sidebar that
# isn't the currently open room. member_updated's room-channel broadcast
# would never reach her in that state (Presence gates it on having that
# specific room joined); this signal has to arrive on her own per-user
# channel instead, same as room_added.
#
# Only the connect ("online") side is exercised here, not disconnect --
# see test_presence.py's module docstring for why the offline half
# isn't reliably testable via a `with websocket_connect(...)` block
# closing (TestClient cancels the server task rather than delivering a
# real disconnect, which can interrupt a `finally` block's own awaits
# in tests only, never in production).
instance1 = ws_client_factory()
instance2 = ws_client_factory()
alice = _register_ws(instance1, _unique("alice"))
bob = _register_ws(instance2, _unique("bob"))
instance1.post("/api/rooms/dm", json={"other_user_id": bob["id"]})
with instance1.websocket_connect("/ws/chat") as alice_ws:
# Sync barrier: alice's own websocket_connect() returning only
# proves the handshake completed, not that chat.py's connection
# setup (register_user, in particular -- required before bob's
# connect can reach her per-user channel at all) has finished.
# Any reply -- even an error -- proves the connection has reached
# its main frame loop, which setup always completes before.
alice_ws.send_json({"type": "__sync_barrier__"})
assert alice_ws.receive_json()["type"] == "error"
with instance2.websocket_connect("/ws/chat"):
online_update = alice_ws.receive_json()
assert online_update == {
"type": "dm_presence_update",
"user_id": bob["id"],
"status": "online",
}
def test_dm_presence_update_not_sent_to_non_partner(ws_client_factory):
instance1 = ws_client_factory()
instance2 = ws_client_factory()
instance3 = ws_client_factory()
alice = _register_ws(instance1, _unique("alice"))
bob = _register_ws(instance2, _unique("bob"))
_register_ws(instance3, _unique("outsider"))
instance1.post("/api/rooms/dm", json={"other_user_id": bob["id"]})
with instance3.websocket_connect("/ws/chat") as outsider_ws:
with instance2.websocket_connect("/ws/chat"):
pass
# Nothing should ever arrive for an outsider who shares no DM with
# bob. Prove the socket stayed quiet the same way
# test_desktop_notifications.py's non-member test does: a harmless
# self-targeted join, whose prompt "joined" ack proves nothing else
# was already queued ahead of it.
room = instance3.post("/api/rooms", json={"name": _unique("outsiders-room")}).json()
outsider_ws.send_json({"type": "join", "room_id": room["id"]})
joined = outsider_ws.receive_json()
assert joined == {"type": "joined", "room_id": room["id"]}