Files
SnowLuma/packages/onebot/tests/instance-rkey.test.ts
T
DrSmoothl 0d63bf7415 fix(onebot): sign forward-msg media + pick image rkey by appid (#74)
/get_forward_msg returned raw, rkey-less image/media URLs because
getForwardMessage converted forward nodes WITHOUT the URL resolvers the
normal receive path (to-message.ts) uses. Wire imageUrlResolver +
mediaUrlResolver into it so forwarded images/voice/video get signed
download URLs — exactly issue #74 (image url 缺少 rkey).

Also derive the image rkey scene from the appid baked into the URL
(1406 -> private, 1407 -> group) instead of the carrying message's
group/private context, falling back to isGroup only when the URL has no
recognised appid. A c2c image forwarded into a group keeps its original
c2c appid, so the old isGroup-based pick signed it with the group rkey ->
`invalid rkey` on download. Mirrors NapCat's getImageUrlFromParsedUrl;
Lagrange/NapCat both reuse one unified converter so this never drifts.

Fix the self-contradictory `c2c images` rkey test (its fixture used the
group appid 1407) and add cross-tests asserting appid outranks isGroup
both ways, plus the no-appid fallback.
2026-05-31 23:50:08 +08:00

138 lines
5.3 KiB
TypeScript

import { describe, it, expect, vi } from 'vitest';
import { RKeyCache } from '../src/instance-rkey';
import type { MessageElement } from '@snowluma/protocol/events';
// The screenshot URL: a raw QQ-NT multimedia download link with no rkey yet.
// appid 1407 = group image, 1406 = private/c2c image (see instance-rkey).
const NT_IMAGE_URL = 'https://multimedia.nt.qq.com.cn/download?appid=1407&fileid=ABC';
const NT_PRIVATE_IMAGE_URL = 'https://multimedia.nt.qq.com.cn/download?appid=1406&fileid=XYZ';
const GROUP_IMAGE_TYPE = 20;
const PRIVATE_IMAGE_TYPE = 10;
function nowSec(): number {
return Math.floor(Date.now() / 1000);
}
function makeBridge(fetchImpl: () => Promise<unknown[]>) {
const fetchDownloadRKeys = vi.fn(fetchImpl);
return { bridge: { apis: { contacts: { fetchDownloadRKeys } } }, fetchDownloadRKeys };
}
function freshGroupRkey(value = 'GROUPKEY') {
return [{ rkey: value, type: GROUP_IMAGE_TYPE, ttlSeconds: 3600, createTime: nowSec(), storeId: 0 }];
}
function freshBothRkeys() {
return [
{ rkey: 'PRIVATEKEY', type: PRIVATE_IMAGE_TYPE, ttlSeconds: 3600, createTime: nowSec(), storeId: 0 },
{ rkey: 'GROUPKEY', type: GROUP_IMAGE_TYPE, ttlSeconds: 3600, createTime: nowSec(), storeId: 0 },
];
}
function imageEl(): MessageElement {
return { type: 'image', imageUrl: NT_IMAGE_URL };
}
function privateImageEl(): MessageElement {
return { type: 'image', imageUrl: NT_PRIVATE_IMAGE_URL };
}
describe('RKeyCache.resolveImageUrl', () => {
it('awaits a refresh on a cold cache and appends the rkey', async () => {
const { bridge, fetchDownloadRKeys } = makeBridge(async () => freshGroupRkey());
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(bridge as never, imageEl(), true);
expect(url).toBe(`${NT_IMAGE_URL}&rkey=GROUPKEY`);
expect(fetchDownloadRKeys).toHaveBeenCalledTimes(1);
});
it('coalesces concurrent cold-cache lookups into a single fetch', async () => {
const { bridge, fetchDownloadRKeys } = makeBridge(async () => freshGroupRkey());
const cache = new RKeyCache();
const urls = await Promise.all([
cache.resolveImageUrl(bridge as never, imageEl(), true),
cache.resolveImageUrl(bridge as never, imageEl(), true),
cache.resolveImageUrl(bridge as never, imageEl(), true),
]);
expect(urls).toEqual(Array(3).fill(`${NT_IMAGE_URL}&rkey=GROUPKEY`));
expect(fetchDownloadRKeys).toHaveBeenCalledTimes(1);
});
it('serves a still-valid rkey from cache without re-fetching', async () => {
const { bridge, fetchDownloadRKeys } = makeBridge(async () => freshGroupRkey());
const cache = new RKeyCache();
await cache.resolveImageUrl(bridge as never, imageEl(), true);
await cache.resolveImageUrl(bridge as never, imageEl(), true);
expect(fetchDownloadRKeys).toHaveBeenCalledTimes(1);
});
it('falls back to the unsigned URL (no throw) when the refresh fails', async () => {
const { bridge, fetchDownloadRKeys } = makeBridge(async () => { throw new Error('oidb down'); });
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(bridge as never, imageEl(), true);
expect(url).toBe(NT_IMAGE_URL);
expect(fetchDownloadRKeys).toHaveBeenCalledTimes(1);
});
it('uses the private rkey type for c2c images (appid 1406)', async () => {
const { bridge } = makeBridge(async () => freshBothRkeys());
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(bridge as never, privateImageEl(), false);
expect(url).toBe(`${NT_PRIVATE_IMAGE_URL}&rkey=PRIVATEKEY`);
});
// The scene follows the image's own appid, not the carrying message — the
// crux of `/get_forward_msg` rkey correctness (issue #74): a c2c image
// forwarded into a group must still be signed with the private rkey.
it('signs an appid-1406 image with the private rkey even when isGroup is true', async () => {
const { bridge } = makeBridge(async () => freshBothRkeys());
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(bridge as never, privateImageEl(), true);
expect(url).toBe(`${NT_PRIVATE_IMAGE_URL}&rkey=PRIVATEKEY`);
});
it('signs an appid-1407 image with the group rkey even when isGroup is false', async () => {
const { bridge } = makeBridge(async () => freshBothRkeys());
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(bridge as never, imageEl(), false);
expect(url).toBe(`${NT_IMAGE_URL}&rkey=GROUPKEY`);
});
it('falls back to the isGroup scene when the URL carries no appid', async () => {
const noAppidUrl = 'https://multimedia.nt.qq.com.cn/download?fileid=NOAPPID';
const { bridge } = makeBridge(async () => freshBothRkeys());
const cache = new RKeyCache();
const url = await cache.resolveImageUrl(
bridge as never, { type: 'image', imageUrl: noAppidUrl }, true,
);
expect(url).toBe(`${noAppidUrl}&rkey=GROUPKEY`);
});
it('leaves non-NT URLs untouched and never fetches', async () => {
const { bridge, fetchDownloadRKeys } = makeBridge(async () => freshGroupRkey());
const cache = new RKeyCache();
const el: MessageElement = { type: 'image', imageUrl: 'https://gchat.qpic.cn/foo.jpg' };
const url = await cache.resolveImageUrl(bridge as never, el, true);
expect(url).toBe('https://gchat.qpic.cn/foo.jpg');
expect(fetchDownloadRKeys).not.toHaveBeenCalled();
});
});