Compare commits

...

2 Commits

Author SHA1 Message Date
b2487e7740 fix: skip workspace members with no Raven User record in Open channels
raven.api.chat.get_channel_members built each Open-channel member's row by
indexing straight into the Raven User lookup result without checking it was
found, unlike the identical branch 10 lines below for non-Open channels. A
workspace member whose Raven User record is missing (e.g. left behind by a
direct cleanup that skipped RavenUser.on_trash's own cascade) crashes the
whole whitelisted endpoint with AttributeError instead of just being omitted.

Extracted the row-building into build_member_entry(), which returns None for
an unmatched member so both branches skip it the same way. Added
raven/tests/test_chat_channel_members.py (pure-function coverage plus an
IntegrationTestCase reproducing the stale-membership state) following this
repo's existing test conventions.

Verified: apps/web vitest (480/480) and tsc -b are unaffected and pass; the
new Python tests need a Frappe bench (DB-backed test runner) this sandbox
does not have, so they are written to the repo's established
IntegrationTestCase pattern but not executed here.
2026-10-21 03:59:57 +03:00
Nikhil Kothari
5c22932b44 chore: bump raven settings timestamp 2026-10-20 19:51:01 +05:30
3 changed files with 123 additions and 24 deletions

View File

@ -6,6 +6,28 @@ from raven.utils import get_channel_members as get_channel_members_util
from raven.utils import get_workspace_members
def build_member_entry(user_obj, channel_member) -> dict | None:
"""One member's row for the member list, or None when there's no matching
Raven User record (e.g. a workspace member whose Raven User record was
removed). The caller must skip a None entry instead of indexing into it —
a workspace can list a member with no Raven User doc, and that one bad
row must never crash the whole list."""
if user_obj is None:
return None
return {
"name": user_obj.name,
"full_name": user_obj.full_name,
"user_image": user_obj.user_image,
"first_name": user_obj.first_name,
"type": user_obj.type,
"availability_status": user_obj.availability_status,
"is_admin": channel_member.get("is_admin", 0),
"allow_notifications": channel_member.get("allow_notifications", 1),
"channel_member_name": channel_member.get("name", None),
}
@frappe.whitelist(methods=["GET"])
def get_channel_members(channel_id: str):
# Check if the user has permission to view the channel
@ -33,34 +55,17 @@ def get_channel_members(channel_id: str):
channel_member = channel_members.get(workspace_member, {})
user_obj = next((u for u in all_users if u.name == workspace_member), None)
member_object[user_obj.name] = {
"name": user_obj.name,
"full_name": user_obj.full_name,
"user_image": user_obj.user_image,
"first_name": user_obj.first_name,
"type": user_obj.type,
"availability_status": user_obj.availability_status,
"is_admin": channel_member.get("is_admin", 0),
"allow_notifications": channel_member.get("allow_notifications", 1),
"channel_member_name": channel_member.get("name", None),
}
entry = build_member_entry(user_obj, channel_member)
if entry:
member_object[entry["name"]] = entry
else:
for member in channel_members:
channel_member = channel_members[member]
user_obj = next((u for u in all_users if u.name == member), None)
if user_obj:
member_object[user_obj.name] = {
"name": user_obj.name,
"full_name": user_obj.full_name,
"user_image": user_obj.user_image,
"first_name": user_obj.first_name,
"type": user_obj.type,
"availability_status": user_obj.availability_status,
"is_admin": channel_member.is_admin,
"allow_notifications": channel_member.allow_notifications,
"channel_member_name": channel_member.name,
}
entry = build_member_entry(user_obj, channel_member)
if entry:
member_object[entry["name"]] = entry
return member_object

View File

@ -343,7 +343,7 @@
"index_web_pages_for_search": 1,
"issingle": 1,
"links": [],
"modified": "2026-10-17 12:00:00.000000",
"modified": "2026-10-20 14:12:54.000000",
"modified_by": "Administrator",
"module": "Raven",
"name": "Raven Settings",

View File

@ -0,0 +1,94 @@
import frappe
from frappe.tests import IntegrationTestCase
from raven.api.chat import build_member_entry, get_channel_members
EXTRA_TEST_RECORD_DEPENDENCIES = ["User", "Raven User"]
class TestBuildMemberEntry(IntegrationTestCase):
"""Pure-function checks for the row builder `get_channel_members` relies on."""
def test_none_user_obj_returns_none(self):
# No matching Raven User record for this member — the caller must be able
# to skip it instead of indexing into None.
self.assertIsNone(build_member_entry(None, {}))
def test_matching_user_obj_returns_entry(self):
user_obj = frappe._dict(
name="test1@example.com",
full_name="Test One",
user_image=None,
first_name="Test",
type="User",
availability_status="Available",
)
entry = build_member_entry(user_obj, {"is_admin": 1, "name": "RCM-1"})
self.assertEqual(entry["name"], "test1@example.com")
self.assertEqual(entry["is_admin"], 1)
self.assertEqual(entry["channel_member_name"], "RCM-1")
def test_missing_channel_member_fields_default(self):
# The Open-channel branch passes `{}` when there's no explicit Raven
# Channel Member row (every workspace member is implicitly a member).
user_obj = frappe._dict(
name="test1@example.com",
full_name="Test One",
user_image=None,
first_name="Test",
type="User",
availability_status="Available",
)
entry = build_member_entry(user_obj, {})
self.assertEqual(entry["is_admin"], 0)
self.assertEqual(entry["allow_notifications"], 1)
self.assertIsNone(entry["channel_member_name"])
class TestOpenChannelMembers(IntegrationTestCase):
"""
Regression test: a workspace member whose Raven User record is gone (e.g. a
direct cleanup / data fix that skipped RavenUser.on_trash's own cascade) must
be skipped from the Open channel's member list, not crash the whole request.
"""
def setUp(self):
frappe.set_user("Administrator")
frappe.get_doc("User", "test1@example.com").add_roles("Raven User")
self.workspace = frappe.get_doc(
{
"doctype": "Raven Workspace",
"workspace_name": "Chat Members Test Workspace",
"type": "Private",
}
).insert()
self.channel = frappe.get_doc(
{
"doctype": "Raven Channel",
"channel_name": "chat-members-open-test",
"type": "Open",
"workspace": self.workspace.name,
}
).insert()
def tearDown(self):
frappe.set_user("Administrator")
frappe.db.delete("Raven Channel Member", {"channel_id": self.channel.name})
frappe.db.delete("Raven Workspace Member", {"workspace": self.workspace.name})
self.channel.delete()
self.workspace.delete()
def test_open_channel_skips_member_with_no_raven_user_record(self):
user = "test1@example.com"
frappe.get_doc(
{"doctype": "Raven Workspace Member", "workspace": self.workspace.name, "user": user}
).insert(ignore_permissions=True)
# Simulate the broken state directly: a raw delete bypasses RavenUser.on_trash,
# so the Workspace Member row survives with no matching Raven User doc.
frappe.db.delete("Raven User", {"user": user})
frappe.cache().delete_value(f"raven:workspace_members:{self.workspace.name}")
members = get_channel_members(self.channel.name)
self.assertNotIn(user, members)