fix(friend): align remark and delete protocols

Route friend remark updates and clears through the commands used by current QQ clients. Emit the required delete flags and surface post-delete cache refresh failures.

Add byte-exact regression coverage for all affected requests.

Fixes #284.
This commit is contained in:
DrSmoothl
2026-07-25 15:41:02 +08:00
parent c64f9d3078
commit dff4b3b032
9 changed files with 192 additions and 54 deletions
+19 -4
View File
@@ -1,4 +1,6 @@
import { createLogger } from '@snowluma/common/logger';
import { ApproveDoubtBuddyReq } from '@snowluma/protocol/oidb-services/friend/approve-doubt-buddy-req';
import { ClearFriendRemark } from '@snowluma/protocol/oidb-services/friend/clear-friend-remark';
import { DeleteFriend } from '@snowluma/protocol/oidb-services/friend/delete-friend';
import { GetDoubtBuddyReq, type DoubtBuddyRequest } from '@snowluma/protocol/oidb-services/friend/get-doubt-buddy-req';
import { HandleFriendRequest } from '@snowluma/protocol/oidb-services/friend/handle-friend-request';
@@ -8,6 +10,8 @@ import type { BridgeContext } from '../bridge-context';
export type { DoubtBuddyRequest };
const log = createLogger('Bridge.Friend');
export class FriendApi {
constructor(private readonly ctx: BridgeContext) { }
@@ -22,13 +26,24 @@ export class FriendApi {
async delete(userId: number, block = false): Promise<void> {
await DeleteFriend.invoke(this.ctx, { userId, block });
// Refresh friend cache after deletion so subsequent reads don't
// surface a ghost entry. Best-effort: a transient OIDB hiccup here
// shouldn't make the delete itself look failed.
try { await this.ctx.apis.contacts.fetchFriendList(); } catch { /* ignore */ }
// The server-side delete has already completed. A refresh failure must be
// visible, but throwing here would misreport the delete itself as failed
// and encourage callers to repeat a destructive request.
try {
await this.ctx.apis.contacts.fetchFriendList();
} catch (err: unknown) {
log.warn(
'friend-list refresh failed after deleting user=%d: %s',
userId,
err instanceof Error ? err.message : String(err),
);
}
}
setRemark(userId: number, remark: string): Promise<void> {
if (remark === '') {
return ClearFriendRemark.invoke(this.ctx, { userId });
}
return SetFriendRemark.invoke(this.ctx, { userId, remark });
}
+26 -9
View File
@@ -1,10 +1,10 @@
import { describe, it, expect, vi } from 'vitest';
import { subscribeLogs, type LogEntry } from '@snowluma/common/logger';
import { protobuf_decode } from '@snowluma/proton';
import type { OidbBase } from '@snowluma/proto-defs/oidb';
import type {
OidbDeleteFriend,
OidbFriendRequestAction,
OidbSetFriendRemark,
} from '@snowluma/proto-defs/oidb-actions/base';
// Post-namespace migration: FriendApi is a thin facade over the
@@ -45,19 +45,36 @@ describe('apis/friend', () => {
expect(bridge.apis.contacts.fetchFriendList).toHaveBeenCalled();
});
it('delete still succeeds when the friend-list refresh throws', async () => {
it('reports a friend-list refresh failure without misreporting the completed delete', async () => {
const bridge = mockBridge();
bridge.apis.contacts.fetchFriendList = vi.fn(async () => { throw new Error('cache miss'); });
await expect(new FriendApi(bridge as any).delete(10001))
.resolves.toBeUndefined();
const captured: LogEntry[] = [];
const unsubscribe = subscribeLogs((entry) => {
if (entry.scope === 'Bridge.Friend') captured.push(entry);
});
try {
await expect(new FriendApi(bridge as any).delete(10001))
.resolves.toBeUndefined();
} finally {
unsubscribe();
}
expect(captured.map(({ level, message }) => ({ level, message }))).toEqual([{
level: 'warn',
message: 'friend-list refresh failed after deleting user=10001: cache miss',
}]);
});
it('setRemark resolves UID and sends 0xb6e_2', async () => {
it('setRemark uses the current set command for a non-empty remark', async () => {
const bridge = mockBridge();
await new FriendApi(bridge as any).setRemark(10001, 'best-friend');
const [cmd, bytes] = bridge.sendRawPacket.mock.calls[0]!;
expect(cmd).toBe('OidbSvcTrpcTcp.0xb6e_2');
const env = protobuf_decode<OidbBase<OidbSetFriendRemark>>(bytes);
expect(env.body).toMatchObject({ targetUid: 'resolved-uid', remark: 'best-friend' });
expect(bridge.sendRawPacket.mock.calls[0]![0])
.toBe('OidbSvcTrpcTcp.0x912e_0');
});
it('setRemark uses the dedicated clear command for an empty remark', async () => {
const bridge = mockBridge();
await new FriendApi(bridge as any).setRemark(10001, '');
expect(bridge.sendRawPacket.mock.calls[0]![0])
.toBe('OidbSvcTrpcTcp.0x912f_0');
});
});
+15 -3
View File
@@ -82,7 +82,7 @@ export interface OidbDeleteFriendField2 {
export interface OidbDeleteFriendField1 {
targetUid?: pb<1, string>;
field2?: pb<2, OidbDeleteFriendField2>;
block?: pb<3, bool>;
block?: pb_optional<3, bool>;
field4?: pb<4, bool>;
}
export interface OidbDeleteFriend {
@@ -904,9 +904,21 @@ export interface OidbStrangerStatusReq {
uin?: pb<1, uint_32>;
key?: pb_repeated<3, OidbStrangerStatusKey>;
}
export interface OidbFriendRemarkTarget {
targetUid?: pb<7, string>;
}
export interface OidbSetFriendRemarkChange {
target?: pb<1, OidbFriendRemarkTarget>;
remark?: pb<2, string>;
}
export interface OidbSetFriendRemark {
targetUid?: pb<1, string>;
remark?: pb<2, string>;
change?: pb<1, OidbSetFriendRemarkChange>;
// Current QQ explicitly emits scene=0 for an ordinary friend. Omitting
// the default changes the request shape used by StrangerRemarkSetWorker.
scene?: pb_optional<2, uint_32>;
}
export interface OidbClearFriendRemark {
target?: pb<1, OidbFriendRemarkTarget>;
}
export interface OidbStrangerStatusRespStatus {
key?: pb<1, uint_32>;
@@ -0,0 +1,35 @@
// 0x912F_0 — clear the remark (备注) stored for a friend. Current QQ
// uses a separate StrangerRemarkSetWorker command instead of sending an
// empty string through 0x912E_0.
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
import type { OidbBase, OidbEmpty } from '@snowluma/proto-defs/oidb';
import type { OidbClearFriendRemark } from '@snowluma/proto-defs/oidb-actions/base';
import { invokeOidb, type OidbSender } from '../../oidb-service';
import type { BridgeContext } from '../../bridge-context';
export namespace ClearFriendRemark {
export const command = 0x912F;
export const subCommand = 0;
export interface Params {
userId: number;
}
export type Deps = OidbSender & Pick<BridgeContext, 'resolveUserUid'>;
export const serialize = async (ctx: Deps, p: Params): Promise<OidbClearFriendRemark> => ({
target: { targetUid: await ctx.resolveUserUid(p.userId) },
});
export const deserialize = (_ctx: Deps, _: OidbEmpty): void => {};
export const encode = (env: OidbBase<OidbClearFriendRemark>): Uint8Array =>
protobuf_encode<OidbBase<OidbClearFriendRemark>>(env);
export const decode = (bytes: Uint8Array): OidbBase<OidbEmpty> =>
protobuf_decode<OidbBase<OidbEmpty>>(bytes);
export const invoke = (deps: Deps, params: Params): Promise<void> =>
invokeOidb(deps, ClearFriendRemark, params);
}
@@ -35,8 +35,9 @@ export namespace DeleteFriend {
field2: 109,
field3: { field1: 8, field2: 8, field3: 50 },
},
// DelBuddyWorker receives both booleans explicitly from current QQ.
block: p.block ?? false,
field4: false,
field4: true,
},
});
@@ -1,5 +1,6 @@
// 0xB6E_2 — set the remark (备注) shown for a friend in the bot's
// own roster. Doesn't affect what the friend sees.
// 0x912E_0 — set the remark (备注) shown for a friend in the bot's
// own roster. Current QQ routes ordinary friend remarks through
// StrangerRemarkSetWorker with scene=0.
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
import type { OidbBase, OidbEmpty } from '@snowluma/proto-defs/oidb';
@@ -8,8 +9,8 @@ import { invokeOidb, type OidbSender } from '../../oidb-service';
import type { BridgeContext } from '../../bridge-context';
export namespace SetFriendRemark {
export const command = 0xB6E;
export const subCommand = 2;
export const command = 0x912E;
export const subCommand = 0;
export interface Params {
userId: number;
@@ -19,8 +20,11 @@ export namespace SetFriendRemark {
export type Deps = OidbSender & Pick<BridgeContext, 'resolveUserUid'>;
export const serialize = async (ctx: Deps, p: Params): Promise<OidbSetFriendRemark> => ({
targetUid: await ctx.resolveUserUid(p.userId),
remark: p.remark,
change: {
target: { targetUid: await ctx.resolveUserUid(p.userId) },
remark: p.remark,
},
scene: 0,
});
export const deserialize = (_ctx: Deps, _: OidbEmpty): void => {};
@@ -0,0 +1,35 @@
import type { SendPacketResult } from '@snowluma/common/packet-sender';
import { describe, expect, it, vi } from 'vitest';
import { ClearFriendRemark } from '../../../src/oidb-services/friend/clear-friend-remark';
import { env, m, s } from '../_pb-oracle';
function makeDeps() {
const result: SendPacketResult = {
success: true,
gotResponse: true,
errorCode: 0,
errorMessage: '',
responseData: Buffer.alloc(0),
};
return {
sendRawPacket: vi.fn(async () => result),
resolveUserUid: vi.fn(async () => 'resolved-uid'),
};
}
describe('ClearFriendRemark namespace', () => {
it('sends the current QQ 0x912F_0 wire shape', async () => {
const deps = makeDeps();
await ClearFriendRemark.invoke(deps, { userId: 10001 });
const [wireName, bytes] = deps.sendRawPacket.mock.calls[0]!;
const body = m(1, s(7, 'resolved-uid'));
expect({
wireName,
hex: Buffer.from(bytes).toString('hex'),
}).toEqual({
wireName: 'OidbSvcTrpcTcp.0x912f_0',
hex: env(0x912F, 0, body, false),
});
});
});
@@ -5,6 +5,7 @@ import type { OidbDeleteFriend } from '@snowluma/proto-defs/oidb-actions/base';
import type { SendPacketResult } from '@snowluma/common/packet-sender';
import { DeleteFriend } from '../../../src/oidb-services/friend/delete-friend';
import { env, m, s, v } from '../_pb-oracle';
function makeDeps() {
const r: SendPacketResult = { success: true, gotResponse: true, errorCode: 0, errorMessage: '', responseData: Buffer.alloc(0) };
@@ -49,13 +50,33 @@ describe('DeleteFriend namespace', () => {
});
});
it('defaults block to false (no block flag)', async () => {
it('matches the current QQ wire for a non-blocking delete', async () => {
const deps = makeDeps();
await DeleteFriend.invoke(deps, { userId: 10001 });
const [, bytes] = deps.sendRawPacket.mock.calls[0]!;
const env = protobuf_decode<OidbBase<OidbDeleteFriend>>(bytes);
// proto3 false omitted on wire — decoded as null/undefined.
expect(env.body?.field1?.block ?? false).toBe(false);
const [wireName, bytes] = deps.sendRawPacket.mock.calls[0]!;
const discriminator = [
...v(1, 130),
...v(2, 109),
...m(3, [
...v(1, 8),
...v(2, 8),
...v(3, 50),
]),
];
const body = m(1, [
...s(1, 'resolved-uid'),
...m(2, discriminator),
// Current QQ explicitly emits both booleans.
...v(3, 0),
...v(4, 1),
]);
expect({
wireName,
hex: Buffer.from(bytes).toString('hex'),
}).toEqual({
wireName: 'OidbSvcTrpcTcp.0x126b_0',
hex: env(0x126B, 0, body, false),
});
});
});
});
@@ -1,10 +1,8 @@
import { describe, expect, it, vi } from 'vitest';
import { protobuf_decode } from '@snowluma/proton';
import type { OidbBase } from '@snowluma/proto-defs/oidb';
import type { OidbSetFriendRemark } from '@snowluma/proto-defs/oidb-actions/base';
import type { SendPacketResult } from '@snowluma/common/packet-sender';
import { SetFriendRemark } from '../../../src/oidb-services/friend/set-friend-remark';
import { env, m, s, v } from '../_pb-oracle';
function makeDeps() {
const r: SendPacketResult = { success: true, gotResponse: true, errorCode: 0, errorMessage: '', responseData: Buffer.alloc(0) };
@@ -15,30 +13,30 @@ function makeDeps() {
}
describe('SetFriendRemark namespace', () => {
it('declares 0xB6E_2', () => {
expect(SetFriendRemark.command).toBe(0xB6E);
expect(SetFriendRemark.subCommand).toBe(2);
it('sends the current QQ 0x912E_0 wire shape for a non-empty remark', async () => {
const deps = makeDeps();
await SetFriendRemark.invoke(deps, { userId: 10001, remark: 'best-friend' });
const [wireName, bytes] = deps.sendRawPacket.mock.calls[0]!;
const body = [
...m(1, [
...m(1, s(7, 'resolved-uid')),
...s(2, 'best-friend'),
]),
// QQ explicitly emits scene=0 for an ordinary friend.
...v(2, 0),
];
expect({
wireName,
hex: Buffer.from(bytes).toString('hex'),
}).toEqual({
wireName: 'OidbSvcTrpcTcp.0x912e_0',
hex: env(0x912E, 0, body, false),
});
});
describe('invoke', () => {
it('routes to OidbSvcTrpcTcp.0xb6e_2', async () => {
const deps = makeDeps();
await SetFriendRemark.invoke(deps, { userId: 10001, remark: 'x' });
expect(deps.sendRawPacket.mock.calls[0]![0]).toBe('OidbSvcTrpcTcp.0xb6e_2');
});
it('resolves the target uid before encoding', async () => {
const deps = makeDeps();
await SetFriendRemark.invoke(deps, { userId: 10001, remark: 'best-friend' });
expect(deps.resolveUserUid).toHaveBeenCalledWith(10001);
});
it('packages uid + remark in body', async () => {
const deps = makeDeps();
await SetFriendRemark.invoke(deps, { userId: 10001, remark: 'best-friend' });
const [, bytes] = deps.sendRawPacket.mock.calls[0]!;
const env = protobuf_decode<OidbBase<OidbSetFriendRemark>>(bytes);
expect(env.body).toMatchObject({ targetUid: 'resolved-uid', remark: 'best-friend' });
});
it('resolves the target UID before encoding', async () => {
const deps = makeDeps();
await SetFriendRemark.invoke(deps, { userId: 10001, remark: 'best-friend' });
expect(deps.resolveUserUid).toHaveBeenCalledWith(10001);
});
});