diff --git a/docs/api.md b/docs/api.md index 1889290..27c517c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -50,6 +50,8 @@ MLS 凭据由标准 Base64 的 publicKey 和 signature 组成,使用 UTF-8 前 群组详情包含十进制字符串 membershipVersion。已接受成员变化会递增版本,待处理邀请和角色变化保留版本。active 成员可以查看其他有效成员,群主与管理员还可查看待处理邀请。群主可解散、调整管理员和移除成员。管理员可改名、邀请好友和移除普通成员。 +创建或更新群资料和成员后,受影响账号的在线客户端收到 `{"type":"group_list_changed"}`,再用授权 API 刷新。邀请相关提示发送给管理者和被邀请人。提示只包含类型字段,不传群号、群名或成员资料。 + 群组密文投递使用 `/groups/{id}/epochs` 和 `/groups/{id}/messages`。群主发布带 membershipVersion 的世代,选取每个有效成员的一台已登记 MLS 设备,提交其他设备的 Welcome。GET epochs 返回当前有效世代的设备名单和本设备获准接收的 Welcome,旧世代仅向在本次成员资格期间加入过该世代的设备返回。POST messages 接受当前世代的 MLS PrivateMessage,GET messages 通过 after 游标返回本设备有权读取的密文。 群世代和密文提交后,WebSocket 向该世代的设备发送 `group_changed`,事件只包含 `type` 和 `groupId`。客户端收到提示、重连或到达兜底轮询周期时,按持久化的游标向授权接口补拉。提示由 Redis 尽力送达,数据库保存投递记录。 diff --git a/docs/progress.md b/docs/progress.md index ca2aa99..a4273f4 100644 --- a/docs/progress.md +++ b/docs/progress.md @@ -147,6 +147,12 @@ Windows 和 Web 的私聊与群聊共用转发目标选择。私聊支持把文 ## 群消息实时同步 -群密文和新加密会话提交后,WebSocket 向群会话的设备发送仅含群标识的同步提示。正在查看该群的 Windows 和 Web 客户端合并密集提示,并按本机游标补拉。重新连接时立即补拉,另保留 15 秒兜底轮询。群成员列表和邀请仍使用原有刷新间隔。 +群密文和新加密会话提交后,WebSocket 向群会话的设备发送仅含群标识的同步提示。正在查看该群的 Windows 和 Web 客户端合并密集提示,并按本机游标补拉。重新连接时立即补拉,另保留 15 秒兜底轮询。 服务端集成测试验证名单内设备收到提示、无关账号收不到提示。Windows Electron 和 Edge 测试验证在线收取及主动断开 WebSocket 后重连补收,私聊和群附件回归通过。 + +## 群成员和邀请实时同步 + +群成员、邀请与群资料更新事务提交后,受影响账号的在线设备收到刷新提示。提示只含事件类型。群组页合并提示,通过现有授权接口刷新列表和当前群详情,重连时也会刷新,并保留 15 秒兜底轮询。群成员权限仍取决于服务端的实时授权结果。 + +Windows Electron 和 Edge 验证了群组页在兜底轮询前显示邀请、成员接受和成员移除。服务端测试验证普通成员收不到其他人的待处理邀请提示,未加入账号收不到群事件,解散会通知仍待接受邀请的账号。 diff --git a/server/internal/groups/store.go b/server/internal/groups/store.go index a9744ef..a80a467 100644 --- a/server/internal/groups/store.go +++ b/server/internal/groups/store.go @@ -115,10 +115,10 @@ func (s *Store) Detail(ctx context.Context, user, id string) (Detail, error) { return result, tx.Commit(ctx) } -func (s *Store) Change(ctx context.Context, user, id string, change Change) error { +func (s *Store) Change(ctx context.Context, user, id string, change Change) ([]string, error) { tx, err := s.db.Begin(ctx) if err != nil { - return err + return nil, err } defer tx.Rollback(ctx) @@ -127,22 +127,29 @@ func (s *Store) Change(ctx context.Context, user, id string, change Change) erro var version int64 err = tx.QueryRow(ctx, "SELECT owner_id,membership_version FROM chat_groups WHERE id=$1 FOR UPDATE", id).Scan(&owner, &version) if errors.Is(err, pgx.ErrNoRows) { - return ErrUnavailable + return nil, ErrUnavailable } if err != nil { - return err + return nil, err } var state, role string err = tx.QueryRow(ctx, "SELECT state,role FROM group_members WHERE group_id=$1 AND user_id=$2", id, user).Scan(&state, &role) if errors.Is(err, pgx.ErrNoRows) { - return ErrUnavailable + return nil, ErrUnavailable } if err != nil { - return err + return nil, err } if owner == user { role = "owner" } + var users []string + if change.Action == "disband" && role == "owner" { + users, err = groupChangeAudience(ctx, tx, id, owner, "all") + if err != nil { + return nil, err + } + } activeChanged := false if state == "invited" { @@ -153,20 +160,50 @@ func (s *Store) Change(ctx context.Context, user, id string, change Change) erro case "decline": _, err = tx.Exec(ctx, "DELETE FROM group_members WHERE group_id=$1 AND user_id=$2", id, user) default: - return ErrAction + return nil, ErrAction } } else { activeChanged, err = changeActive(ctx, tx, user, id, owner, role, change) } if err != nil { - return err + return nil, err } if activeChanged { if _, err = tx.Exec(ctx, "UPDATE chat_groups SET membership_version=membership_version+1 WHERE id=$1", id); err != nil { - return err + return nil, err } } - return tx.Commit(ctx) + if change.Action != "disband" { + audience := "active" + switch { + case change.Action == "rename": + audience = "all" + case change.Action == "invite", change.Action == "decline", change.Action == "remove" && !activeChanged: + audience = "managers" + } + users, err = groupChangeAudience(ctx, tx, id, owner, audience) + if err != nil { + return nil, err + } + // Removed and invited users need to refresh their own group list as well. + users = append(users, user) + if change.Action == "invite" || change.Action == "remove" { + users = append(users, change.Target) + } + } + return users, tx.Commit(ctx) +} + +func groupChangeAudience(ctx context.Context, tx pgx.Tx, group, owner, audience string) ([]string, error) { + rows, err := tx.Query(ctx, ` + SELECT user_id::text FROM group_members WHERE group_id=$1 AND ( + $3='all' OR (state='active' AND ($3='active' OR user_id=$2 OR role='admin')) + ) + `, group, owner, audience) + if err != nil { + return nil, err + } + return pgx.CollectRows(rows, pgx.RowTo[string]) } func changeActive(ctx context.Context, tx pgx.Tx, user, id, owner, role string, change Change) (bool, error) { diff --git a/server/internal/httpapi/groups.go b/server/internal/httpapi/groups.go index c1feb54..57f49f5 100644 --- a/server/internal/httpapi/groups.go +++ b/server/internal/httpapi/groups.go @@ -1,9 +1,11 @@ package httpapi import ( + "context" "errors" "net/http" "strings" + "time" "unicode" "unicode/utf8" @@ -52,6 +54,7 @@ func (a *API) createGroup(w http.ResponseWriter, r *http.Request, _ string, id a groupError(w, err) return } + a.hintGroupList(r.Context(), []string{id.User.ID}) respond(w, 201, group) } @@ -109,9 +112,25 @@ func (a *API) changeGroup(w http.ResponseWriter, r *http.Request, _ string, id a if !a.limit(w, r, "group-change:"+id.User.ID, 60) { return } - if err := a.groups.Change(r.Context(), id.User.ID, group, change); err != nil { + users, err := a.groups.Change(r.Context(), id.User.ID, group, change) + if err != nil { groupError(w, err) return } + a.hintGroupList(r.Context(), users) w.WriteHeader(204) } + +func (a *API) hintGroupList(ctx context.Context, users []string) { + ctx, cancel := context.WithTimeout(context.WithoutCancel(ctx), 250*time.Millisecond) + defer cancel() + pipe := a.redis.Pipeline() + seen := make(map[string]bool, len(users)) + for _, user := range users { + if !seen[user] { + pipe.Publish(ctx, "xhchat:groups:"+user, "changed") + seen[user] = true + } + } + _, _ = pipe.Exec(ctx) +} diff --git a/server/internal/httpapi/realtime.go b/server/internal/httpapi/realtime.go index 1e3f186..77d40ce 100644 --- a/server/internal/httpapi/realtime.go +++ b/server/internal/httpapi/realtime.go @@ -64,11 +64,14 @@ func (a *API) realtime(w http.ResponseWriter, r *http.Request) { return } inboxChannel := "xhchat:inbox:" + identity.Device.ID - subscription := a.redis.Subscribe(r.Context(), "xhchat:contacts:"+identity.User.ID, inboxChannel) + groupsChannel := "xhchat:groups:" + identity.User.ID + subscription := a.redis.Subscribe(r.Context(), "xhchat:contacts:"+identity.User.ID, inboxChannel, groupsChannel) defer subscription.Close() - if _, err = subscription.Receive(r.Context()); err != nil { - unavailable(w, err) - return + for range 3 { + if _, err = subscription.Receive(r.Context()); err != nil { + unavailable(w, err) + return + } } changes := subscription.Channel() // The exact Origin was checked before consuming the ticket. @@ -101,7 +104,10 @@ func (a *API) realtime(w http.ResponseWriter, r *http.Request) { } writeCtx, cancel := context.WithTimeout(ctx, 5*time.Second) event := map[string]string{"type": "contacts_changed"} - if change.Channel == inboxChannel { + switch change.Channel { + case groupsChannel: + event["type"] = "group_list_changed" + case inboxChannel: event["type"] = "inbox_changed" if group, found := strings.CutPrefix(change.Payload, "group:"); found && uuidPattern.MatchString(group) { event["type"] = "group_changed" diff --git a/tests/delivery.test.mjs b/tests/delivery.test.mjs index bf68488..7b31754 100644 --- a/tests/delivery.test.mjs +++ b/tests/delivery.test.mjs @@ -56,7 +56,7 @@ function frame() { return Buffer.concat([Buffer.from([0, 1, 0, 2]), randomBytes(96)]).toString('base64') } -test('群组邀请、授权、成员移除与版本变更', { timeout: 25_000 }, async () => { +test('群组邀请、授权、成员移除、版本变更与实时提示', { timeout: 25_000 }, async (t) => { const owner = await register() const member = await register() const other = await register() @@ -70,32 +70,58 @@ test('群组邀请、授权、成员移除与版本变更', { timeout: 25_000 }, await act(owner, 'invite', member.user.id, 409) await contact(owner, member, 'request') await contact(member, owner, 'accept') - await act(owner, 'invite', member.user.id) + const [ownerSocket, memberSocket, otherSocket] = await Promise.all([owner, member, other].map((actor) => watchRealtime(actor, t))) + const unrelated = [] + otherSocket.on('message', (data) => unrelated.push(JSON.parse(data))) + async function expectHint(sockets, action) { + const pending = Promise.all(sockets.map((socket) => once(socket, 'message', { signal: AbortSignal.timeout(4000) }))) + const [events] = await Promise.all([pending, action()]) + for (const [data] of events) assert.deepEqual(JSON.parse(data), { type: 'group_list_changed' }) + } + await expectHint([ownerSocket, memberSocket], () => act(owner, 'invite', member.user.id)) const invitation = await json(path, 'GET', member.token) assert.equal(invitation.state, 'invited') assert.deepEqual(invitation.members, []) assert.equal(invitation.membershipVersion, '1') - await act(member, 'decline') + await expectHint([ownerSocket, memberSocket], () => act(member, 'decline')) await json(path, 'GET', member.token, undefined, 404) - await act(owner, 'invite', member.user.id) - await act(member, 'accept') + await expectHint([ownerSocket, memberSocket], () => act(owner, 'invite', member.user.id)) + await expectHint([ownerSocket, memberSocket], () => act(member, 'accept')) const active = await json(path, 'GET', member.token) assert.equal(active.membershipVersion, '2') assert.deepEqual(active.members.map((item) => item.role).sort(), ['member', 'owner']) await act(member, 'remove', owner.user.id, 409) await act(member, 'rename', undefined, 409, '未授权名称') - await act(owner, 'promote', member.user.id) - await act(member, 'rename', undefined, 204, '管理员改名') + const candidate = await register() + for (const [actor, target, action] of [[owner, candidate, 'request'], [candidate, owner, 'accept']]) { + const pending = once(ownerSocket, 'message', { signal: AbortSignal.timeout(4000) }) + const [[data]] = await Promise.all([pending, contact(actor, target, action)]) + assert.deepEqual(JSON.parse(data), { type: 'contacts_changed' }) + } + const candidateSocket = await watchRealtime(candidate, t) + const ordinaryMemberEvents = [] + const recordMemberEvent = (data) => ordinaryMemberEvents.push(JSON.parse(data)) + memberSocket.on('message', recordMemberEvent) + await expectHint([ownerSocket, candidateSocket], () => act(owner, 'invite', candidate.user.id)) + assert.deepEqual((await json(path, 'GET', member.token)).members.map((entry) => entry.state), ['active', 'active']) + await expectHint([ownerSocket, candidateSocket], () => act(candidate, 'decline')) + memberSocket.off('message', recordMemberEvent) + assert.deepEqual(ordinaryMemberEvents, []) + await expectHint([ownerSocket, memberSocket], () => act(owner, 'promote', member.user.id)) + await expectHint([ownerSocket, memberSocket], () => act(member, 'rename', undefined, 204, '管理员改名')) const renamed = await json(path, 'GET', owner.token) assert.equal(renamed.name, '管理员改名') assert.equal(renamed.membershipVersion, '2') await act(member, 'disband', undefined, 409) - await act(owner, 'remove', member.user.id) + await expectHint([ownerSocket, memberSocket], () => act(owner, 'remove', member.user.id)) await json(path, 'GET', member.token, undefined, 404) assert.deepEqual(await json('/groups', 'GET', member.token), []) assert.equal((await json(path, 'GET', owner.token)).membershipVersion, '3') - await act(owner, 'disband') + await expectHint([ownerSocket, memberSocket], () => act(owner, 'invite', member.user.id)) + await expectHint([ownerSocket, memberSocket], () => act(owner, 'disband')) await json(path, 'GET', owner.token, undefined, 404) + assert.deepEqual(await json('/groups', 'GET', member.token), []) + assert.deepEqual(unrelated, []) }) test('群密文和实时提示只投递到名单设备,移除或撤销阻断旧世代', { timeout: 25_000 }, async (t) => { diff --git a/tests/group-chat.test.mjs b/tests/group-chat.test.mjs index 2ebfa72..2d641dd 100644 --- a/tests/group-chat.test.mjs +++ b/tests/group-chat.test.mjs @@ -34,11 +34,14 @@ async function connect(owner, member, ownerName, memberName) { } async function invite(owner, member, memberName, group) { + await work(member).getByRole('link', { name: '群组' }).click() + await member.getByRole('heading', { name: '群组', exact: true }).waitFor() + await member.getByText('选择或创建群组。').waitFor() await owner.getByLabel('邀请联系人').selectOption({ label: memberName }) await owner.getByRole('button', { name: '发送邀请' }).click() - await work(member).getByRole('link', { name: '群组' }).click() - await member.getByRole('link', { name: new RegExp(group) }).click() + await member.getByRole('link', { name: new RegExp(group + '.*待接受邀请') }).click({ timeout: 4500 }) await member.getByRole('button', { name: '接受邀请' }).click() + await owner.getByRole('list', { name: '群成员' }).getByText(memberName + ' · 成员', { exact: true }).waitFor({ timeout: 4500 }) await chat(member).getByRole('button', { name: '启用本机群聊' }).waitFor() } @@ -310,7 +313,7 @@ test('Windows 与 Web 加密群聊支持消息操作、附件、语音和成员 const member = owner.getByRole('list', { name: '群成员' }).getByRole('listitem').filter({ hasText: names[2] }) await member.getByRole('button', { name: '移除成员' }).click() await owner.getByRole('button', { name: '确认操作' }).click() - await removed.getByRole('heading', { name: group }).waitFor({ state: 'hidden' }) + await removed.getByRole('heading', { name: group }).waitFor({ state: 'hidden', timeout: 4500 }) const fetchRemovedVoice = () => fetch(base + desktopVoice, { headers: { Authorization: 'Bearer ' + removedIdentity.token } }) assert.equal((await fetchRemovedVoice()).status, 404) assert.equal((await fetch(base + '/api/v1/devices/' + removedIdentity.device.id, { diff --git a/web/src/session.ts b/web/src/session.ts index 0d2b351..532c926 100644 --- a/web/src/session.ts +++ b/web/src/session.ts @@ -27,6 +27,7 @@ export const useSession = defineStore('session', () => { const contactChanges = ref(0) const inboxChanges = ref(0) const groupChange = shallowRef<{ groupId: string }>() + const groupListChanges = ref(0) let token = '' let socket: WebSocket | undefined let retry: ReturnType | undefined @@ -61,6 +62,7 @@ export const useSession = defineStore('session', () => { if (type === 'contacts_changed') contactChanges.value++ if (type === 'inbox_changed') inboxChanges.value++ if (type === 'group_changed' && typeof groupId === 'string') groupChange.value = { groupId } + if (type === 'group_list_changed') groupListChanges.value++ } active.onclose = (event) => { if (socket !== active) return @@ -112,7 +114,7 @@ export const useSession = defineStore('session', () => { } return { - identity, connection, contactChanges, inboxChanges, groupChange, authenticate, logout, authorized, + identity, connection, contactChanges, inboxChanges, groupChange, groupListChanges, authenticate, logout, authorized, devices: () => authorized('/devices'), revoke: (id: string) => authorized('/devices/' + encodeURIComponent(id), 'DELETE'), contacts: () => authorized('/contacts'), diff --git a/web/src/views/GroupView.vue b/web/src/views/GroupView.vue index 2c3640f..efbebfa 100644 --- a/web/src/views/GroupView.vue +++ b/web/src/views/GroupView.vue @@ -2,6 +2,7 @@ import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue' import { useRoute, useRouter } from 'vue-router' import { useSession } from '../session' +import { APIError } from '../api' import type { Contact } from '../contacts' import GroupChat from '../chat/GroupChat.vue' import type { GroupSummary } from '../chat/group-chat' @@ -29,20 +30,33 @@ const eligible = computed(() => contacts.value.filter((item) => item.state === ' !detail.value?.members.some((member) => member.id === item.id))) const roles = { owner: '群主', admin: '管理员', member: '成员' } let timer: ReturnType +let refreshTimer: ReturnType | undefined +let refreshPending = false let revision = 0 async function refresh() { const version = ++revision const selected = id.value - const list = await session.authorized('/groups') - const next = list.some((group) => group.id === selected) - ? await session.authorized('/groups/' + encodeURIComponent(selected)) - : undefined - const friends = next?.role === 'owner' || next?.role === 'admin' ? await session.contacts() : [] + let list = await session.authorized('/groups') + let next: Detail | undefined + if (list.some((group) => group.id === selected)) { + try { + next = await session.authorized('/groups/' + encodeURIComponent(selected)) + } catch (cause) { + if (!(cause instanceof APIError) || cause.status !== 404) throw cause + list = list.filter((group) => group.id !== selected) + } + } if (revision !== version || id.value !== selected) return groups.value = list if (detail.value?.id !== next?.id || detail.value?.name !== next?.name) nextName.value = next?.name ?? '' detail.value = next + if (!next || next.state !== 'active' || next.role === 'member') { + contacts.value = [] + return + } + const friends = await session.contacts() + if (revision !== version || id.value !== selected) return contacts.value = friends } @@ -56,11 +70,25 @@ async function run(action: () => Promise) { error.value = cause instanceof Error ? cause.message : '群操作失败' } finally { busy.value = false + if (refreshPending) queueRefresh() } } function reload() { - if (!busy.value) void run(refresh) + if (busy.value) return + clearTimeout(refreshTimer) + refreshTimer = undefined + refreshPending = false + void run(refresh) +} + +function queueRefresh() { + refreshPending = true + if (busy.value || refreshTimer) return + refreshTimer = setTimeout(() => { + refreshTimer = undefined + reload() + }, 250) } function create() { @@ -87,14 +115,22 @@ watch(id, () => { detail.value = undefined confirmation.value = undefined invite.value = '' + contacts.value = [] if (busy.value) void refresh().catch(() => {}) else reload() }) +watch(() => session.groupListChanges, queueRefresh) +watch(() => session.connection, (connection) => { if (connection === '实时连接已建立') queueRefresh() }) onMounted(() => { reload() - timer = setInterval(reload, 5000) + timer = setInterval(queueRefresh, 15_000) +}) +onBeforeUnmount(() => { + revision++ + refreshPending = false + clearTimeout(refreshTimer) + clearInterval(timer) }) -onBeforeUnmount(() => clearInterval(timer))