Compare commits
89 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e44e4ced17 | ||
|
|
f452c657ed | ||
|
|
1cd838e7a1 | ||
|
|
a8f460499b | ||
|
|
a977228a09 | ||
|
|
e9faec0e28 | ||
|
|
4a10f38743 | ||
|
|
a1688a33b0 | ||
|
|
45c3a6841a | ||
|
|
2b63f375fc | ||
|
|
0fa912a32e | ||
|
|
5f1700fc1b | ||
|
|
54038c775a | ||
|
|
c15ecd0402 | ||
|
|
f79187f36a | ||
|
|
24ec8a7eba | ||
|
|
3773106425 | ||
|
|
f65880b164 | ||
|
|
8d9f44b6b0 | ||
|
|
bd40ac3522 | ||
|
|
60733aacab | ||
|
|
a2ce3b2c19 | ||
|
|
7882081bdb | ||
|
|
f1ef07544d | ||
|
|
c120b0fb97 | ||
|
|
93290e4d0c | ||
|
|
fa4870bdca | ||
|
|
b126b5c166 | ||
|
|
11d42b4e98 | ||
|
|
8b3f11a22b | ||
|
|
8ecf41ccb7 | ||
|
|
fcbb2661d1 | ||
|
|
299fa85a74 | ||
|
|
d8763c98db | ||
|
|
a557bf72e7 | ||
|
|
eb119ecb92 | ||
|
|
304f3e772f | ||
|
|
26639ffef7 | ||
|
|
bd14b0a98e | ||
|
|
77d883f235 | ||
|
|
bb4443b12d | ||
|
|
947af4b22c | ||
|
|
6b8362e049 | ||
|
|
8ffd314260 | ||
|
|
8b8a9df894 | ||
|
|
bc3930a2ce | ||
|
|
d30cd1ba53 | ||
|
|
05f18614c1 | ||
|
|
3acd3cd28b | ||
|
|
dafe2082f1 | ||
|
|
2f1aadffbe | ||
|
|
1ff2c08765 | ||
|
|
4d55608b56 | ||
|
|
5c9328206f | ||
|
|
3bd74acb60 | ||
|
|
9bf4b9107b | ||
|
|
d95d3bf761 | ||
|
|
dc2d60e57f | ||
|
|
1172a6bd3d | ||
|
|
8e28bca775 | ||
|
|
9e7da154ff | ||
|
|
fa5efcd310 | ||
|
|
2d659b0ceb | ||
|
|
34a73084e0 | ||
|
|
9b5ce9b502 | ||
|
|
166fcd8613 | ||
|
|
b997de44a2 | ||
|
|
f8cb15c27b | ||
|
|
c5464e48d1 | ||
|
|
8fc68c0ec3 | ||
|
|
b4ece8671b | ||
|
|
bde7f2805d | ||
|
|
491b531841 | ||
|
|
617e7581dd | ||
|
|
27120f884a | ||
|
|
3a4c1eeea2 | ||
|
|
5cd4ae61dd | ||
|
|
28f64113e7 | ||
|
|
c537311ed1 | ||
|
|
9d8df59370 | ||
|
|
76846f40b1 | ||
|
|
79522d949f | ||
|
|
db142db9e6 | ||
|
|
e5cfec01bd | ||
|
|
1b74747251 | ||
|
|
38fc636088 | ||
|
|
9c3c768968 | ||
|
|
059faf79c0 | ||
|
|
20cf7394e5 |
7
.github/pull_request_template.md
vendored
7
.github/pull_request_template.md
vendored
@@ -2,7 +2,11 @@
|
||||
|
||||
## 关联 Issue
|
||||
|
||||
<!-- 例如 Closes #123。若无关联 issue,请说明这个 PR 解决什么问题、为何现在做。 -->
|
||||
<!-- 必填:在本段填写 Refs #编号 或 Closes #编号(也支持 Fixes / Resolves)。
|
||||
必须关联至少一个先于本 PR 创建、仍开放且通过模板检查的本仓库 issue。
|
||||
先通过 GitHub 网页模板提交 issue,或认领已有对应 issue,再可选地提交 PR。
|
||||
请把关联标记写在本注释之外,不要只保留示例或只填写编号。
|
||||
目标分支不是 dev,或缺少有效关联 issue 的 PR 会被自动关闭。 -->
|
||||
|
||||
## 变更说明
|
||||
|
||||
@@ -10,6 +14,7 @@
|
||||
|
||||
## 提交前检查
|
||||
|
||||
- [ ] 目标分支为 `dev`,正文已关联符合上述要求的 issue
|
||||
- [ ] 本 PR 聚焦单一目标,未夹带无关改动
|
||||
- [ ] 已通过 `pnpm lint` 与 `pnpm typecheck`
|
||||
- [ ] 已补充/更新相关测试,且 `pnpm test` 通过
|
||||
|
||||
204
.github/scripts/pr-policy-guard.cjs
vendored
Normal file
204
.github/scripts/pr-policy-guard.cjs
vendored
Normal file
@@ -0,0 +1,204 @@
|
||||
const COMMENT_MARKER = '<!-- snowluma-pr-policy-guard -->';
|
||||
const TEMPLATE_LABELS = new Set(['bug', 'enhancement']);
|
||||
const PRIVILEGED_AUTHORS = new Set(['OWNER', 'MEMBER', 'COLLABORATOR']);
|
||||
|
||||
function prose(body) {
|
||||
let fence = null;
|
||||
return (body || '')
|
||||
.replace(/<!--[\s\S]*?(?:-->|$)/g, '')
|
||||
.split(/\r?\n/)
|
||||
.map((line) => {
|
||||
const marker = /^ {0,3}(`{3,}|~{3,})(.*)$/.exec(line);
|
||||
|
||||
if (fence) {
|
||||
if (
|
||||
marker &&
|
||||
marker[1][0] === fence[0] &&
|
||||
marker[1].length >= fence.length &&
|
||||
!marker[2].trim()
|
||||
) {
|
||||
fence = null;
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
if (marker) {
|
||||
fence = marker[1];
|
||||
return '';
|
||||
}
|
||||
|
||||
if (/^(?: {4}|\t|\s*>)/.test(line)) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return line;
|
||||
})
|
||||
.join('\n')
|
||||
.replace(/(`+)[\s\S]*?\1/g, '');
|
||||
}
|
||||
|
||||
function referencedIssues(body, context) {
|
||||
const repository = `${context.repo.owner}/${context.repo.repo}`.toLowerCase();
|
||||
const references = new Set();
|
||||
const pattern =
|
||||
/\b(?:refs?|close[sd]?|fix(?:e[sd])?|resolve[sd]?):?[ \t]+(https?:\/\/[^\s<>]+|(?:[\w.-]+\/[\w.-]+)?#[1-9]\d*)(?![\w/#-])/gi;
|
||||
|
||||
for (const match of prose(body).matchAll(pattern)) {
|
||||
const reference = match[1].replace(/[),.;!?]+$/, '');
|
||||
let number;
|
||||
|
||||
if (/^https?:\/\//i.test(reference)) {
|
||||
let url;
|
||||
|
||||
try {
|
||||
url = new URL(reference);
|
||||
} catch {
|
||||
continue;
|
||||
}
|
||||
|
||||
const path = url.pathname.match(/^\/([^/]+\/[^/]+)\/issues\/([1-9]\d*)\/?$/i);
|
||||
|
||||
if (!path || url.origin !== context.serverUrl || path[1].toLowerCase() !== repository) {
|
||||
continue;
|
||||
}
|
||||
|
||||
number = Number(path[2]);
|
||||
} else {
|
||||
const [name, id] = reference.split('#');
|
||||
|
||||
if (name && name.toLowerCase() !== repository) {
|
||||
continue;
|
||||
}
|
||||
|
||||
number = Number(id);
|
||||
}
|
||||
|
||||
if (Number.isSafeInteger(number) && number > 0) {
|
||||
references.add(number);
|
||||
}
|
||||
}
|
||||
|
||||
return [...references];
|
||||
}
|
||||
|
||||
async function violation(pr, github, context) {
|
||||
if (pr.base.ref !== 'dev') {
|
||||
return 'PR 的目标分支必须是 `dev`;`main` 仅由维护者的发布流程更新。';
|
||||
}
|
||||
|
||||
const numbers = referencedIssues(pr.body, context);
|
||||
|
||||
if (numbers.length === 0) {
|
||||
return 'PR 正文缺少本仓库 issue 的关联标记。请填写 `Refs #编号`、`Closes #编号`、`Fixes #编号` 或 `Resolves #编号`。';
|
||||
}
|
||||
|
||||
const failures = [];
|
||||
|
||||
for (const issue_number of numbers) {
|
||||
let issue;
|
||||
|
||||
try {
|
||||
({ data: issue } = await github.rest.issues.get({ ...context.repo, issue_number }));
|
||||
} catch (error) {
|
||||
if (error.status !== 404 && error.status !== 410) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
failures.push(`#${issue_number} 不存在或不可访问`);
|
||||
continue;
|
||||
}
|
||||
|
||||
const expectedUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/issues/${issue_number}`;
|
||||
|
||||
if (issue.pull_request) {
|
||||
failures.push(`#${issue_number} 是 PR,不是 issue`);
|
||||
} else if (issue.html_url.toLowerCase() !== expectedUrl.toLowerCase()) {
|
||||
failures.push(`#${issue_number} 已不属于本仓库`);
|
||||
} else if (issue.state !== 'open') {
|
||||
failures.push(`#${issue_number} 已关闭`);
|
||||
} else if (Date.parse(issue.created_at) > Date.parse(pr.created_at)) {
|
||||
failures.push(`#${issue_number} 晚于本 PR 创建,请先提 issue 再创建 PR`);
|
||||
} else if (
|
||||
!PRIVILEGED_AUTHORS.has(issue.author_association) &&
|
||||
!issue.labels.some((label) =>
|
||||
TEMPLATE_LABELS.has(typeof label === 'string' ? label : label.name),
|
||||
)
|
||||
) {
|
||||
// Match issue-template-guard.yml immediately, without racing its
|
||||
// asynchronous close action. Its GITHUB_TOKEN cannot trigger us.
|
||||
failures.push(`#${issue_number} 未通过 issue 模板检查`);
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
return `没有有效的关联 issue:${failures.join(';')}。`;
|
||||
}
|
||||
|
||||
module.exports = async function guard({ github, context, core }) {
|
||||
const params = { ...context.repo, pull_number: context.issue.number };
|
||||
const { data: pr } = await github.rest.pulls.get(params);
|
||||
|
||||
if (pr.state !== 'open' || pr.merged) {
|
||||
core.info('PR is no longer open; nothing to enforce.');
|
||||
return;
|
||||
}
|
||||
|
||||
const reason = await violation(pr, github, context);
|
||||
|
||||
if (!reason) {
|
||||
core.info(`PR #${pr.number} targets dev and references an eligible issue.`);
|
||||
return;
|
||||
}
|
||||
|
||||
// An edit may have fixed the policy while its issue lookup was in flight.
|
||||
const { data: current } = await github.rest.pulls.get(params);
|
||||
|
||||
if (
|
||||
current.state !== 'open' ||
|
||||
current.merged ||
|
||||
current.body !== pr.body ||
|
||||
current.base.ref !== pr.base.ref
|
||||
) {
|
||||
core.info('PR changed during validation; leaving it to the next event.');
|
||||
return;
|
||||
}
|
||||
|
||||
const commentParams = { ...context.repo, issue_number: pr.number };
|
||||
const comments = await github.paginate(github.rest.issues.listComments, {
|
||||
...commentParams,
|
||||
per_page: 100,
|
||||
});
|
||||
const previous = comments.find(
|
||||
(comment) =>
|
||||
comment.user?.login === 'github-actions[bot]' && comment.body?.startsWith(COMMENT_MARKER),
|
||||
);
|
||||
const body = [
|
||||
COMMENT_MARKER,
|
||||
'此 PR 未满足贡献要求,现自动关闭。',
|
||||
'',
|
||||
reason,
|
||||
'',
|
||||
'请先通过 [GitHub 网页模板](' +
|
||||
context.serverUrl +
|
||||
'/' +
|
||||
context.repo.owner +
|
||||
'/' +
|
||||
context.repo.repo +
|
||||
'/issues/new/choose) 提交 issue;也可以认领已有的对应 issue。',
|
||||
'PR 必须指向 `dev`,并在正文引用至少一个先于 PR 创建、仍开放且通过模板检查的本仓库 issue。注释、代码示例和引用块中的标记不计入。',
|
||||
'若已有符合要求的 issue,可修改目标分支或正文后重新打开 PR;若需新建 issue,请先完成 issue 再创建新的 PR。',
|
||||
].join('\n');
|
||||
|
||||
if (previous) {
|
||||
if (previous.body !== body) {
|
||||
await github.rest.issues.updateComment({ ...context.repo, comment_id: previous.id, body });
|
||||
}
|
||||
} else {
|
||||
await github.rest.issues.createComment({ ...commentParams, body });
|
||||
}
|
||||
|
||||
await github.rest.pulls.update({ ...params, state: 'closed' });
|
||||
core.setFailed(`Closed PR #${pr.number}: ${reason}`);
|
||||
};
|
||||
313
.github/scripts/pr-policy-guard.test.cjs
vendored
Normal file
313
.github/scripts/pr-policy-guard.test.cjs
vendored
Normal file
@@ -0,0 +1,313 @@
|
||||
const assert = require('node:assert/strict');
|
||||
const { test } = require('node:test');
|
||||
const guard = require('./pr-policy-guard.cjs');
|
||||
|
||||
function fixture() {
|
||||
const pr = {
|
||||
number: 100,
|
||||
state: 'open',
|
||||
merged: false,
|
||||
base: { ref: 'dev' },
|
||||
body: 'Refs #42',
|
||||
created_at: '2026-11-01T10:00:00Z',
|
||||
};
|
||||
const issue = {
|
||||
number: 42,
|
||||
state: 'open',
|
||||
html_url: 'https://github.com/SnowLuma/SnowLuma/issues/42',
|
||||
created_at: '2026-11-01T09:00:00Z',
|
||||
author_association: 'NONE',
|
||||
labels: [{ name: 'bug' }],
|
||||
};
|
||||
const state = {
|
||||
pr,
|
||||
issue,
|
||||
issues: new Map([[42, issue]]),
|
||||
comments: [],
|
||||
lookups: [],
|
||||
mutations: [],
|
||||
failures: [],
|
||||
refresh: null,
|
||||
requests: 0,
|
||||
};
|
||||
const context = {
|
||||
repo: { owner: 'SnowLuma', repo: 'SnowLuma' },
|
||||
issue: { number: 100 },
|
||||
serverUrl: 'https://github.com',
|
||||
};
|
||||
const github = {
|
||||
rest: {
|
||||
pulls: {
|
||||
get: async () => {
|
||||
state.requests += 1;
|
||||
return {
|
||||
data: structuredClone(state.requests > 1 && state.refresh ? state.refresh : pr),
|
||||
};
|
||||
},
|
||||
update: async (params) => state.mutations.push({ action: 'close', ...params }),
|
||||
},
|
||||
issues: {
|
||||
get: async ({ issue_number }) => {
|
||||
state.lookups.push(issue_number);
|
||||
const result = state.issues.get(issue_number);
|
||||
|
||||
if (result instanceof Error) {
|
||||
throw result;
|
||||
}
|
||||
|
||||
if (!result) {
|
||||
throw Object.assign(new Error('Not found'), { status: 404 });
|
||||
}
|
||||
|
||||
return { data: structuredClone(result) };
|
||||
},
|
||||
listComments: () => {},
|
||||
createComment: async (params) => state.mutations.push({ action: 'comment', ...params }),
|
||||
updateComment: async (params) =>
|
||||
state.mutations.push({ action: 'edit-comment', ...params }),
|
||||
},
|
||||
},
|
||||
paginate: async () => structuredClone(state.comments),
|
||||
};
|
||||
const core = {
|
||||
info: () => {},
|
||||
setFailed: (reason) => state.failures.push(reason),
|
||||
};
|
||||
return { ...state, state, github, run: () => guard({ github, context, core }) };
|
||||
}
|
||||
|
||||
function assertClosed(f, reason) {
|
||||
assert.deepEqual(
|
||||
f.mutations.map((entry) => entry.action),
|
||||
['comment', 'close'],
|
||||
);
|
||||
assert.equal(f.mutations[1].pull_number, 100);
|
||||
assert.equal(f.mutations[1].state, 'closed');
|
||||
assert.match(f.mutations[0].body, reason);
|
||||
assert.equal(f.failures.length, 1);
|
||||
}
|
||||
|
||||
for (const body of [
|
||||
'Refs #42',
|
||||
'refs: #42',
|
||||
'Ref #42',
|
||||
'Close #42',
|
||||
'Closes #42',
|
||||
'Closed #42',
|
||||
'Fix #42',
|
||||
'Fixes #42',
|
||||
'Fixed #42',
|
||||
'Resolve #42',
|
||||
'Resolves #42',
|
||||
'Resolved #42',
|
||||
'This change fixes #42.',
|
||||
'CLOSES: #42',
|
||||
'Refs SnowLuma/SnowLuma#42',
|
||||
'Refs snowluma/snowluma#42',
|
||||
'Refs https://github.com/SnowLuma/SnowLuma/issues/42',
|
||||
]) {
|
||||
test(`accepts a real issue reference: ${body}`, async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = body;
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, [42]);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
assert.deepEqual(f.failures, []);
|
||||
});
|
||||
}
|
||||
|
||||
for (const body of [
|
||||
'',
|
||||
null,
|
||||
'#42',
|
||||
'prefixRefs #42',
|
||||
'Refs #0',
|
||||
'Refs #42abc',
|
||||
'Refs #42/other',
|
||||
'Refs #9007199254740993',
|
||||
'Refs other/repo#42',
|
||||
'Refs https://github.com/other/repo/issues/42',
|
||||
'Refs https://example.org/SnowLuma/SnowLuma/issues/42',
|
||||
'Refs https://github.com/SnowLuma/SnowLuma/pull/42',
|
||||
'Refs https://%',
|
||||
'<!-- Closes #42 -->',
|
||||
'<!-- Closes #42',
|
||||
'`Refs #42`',
|
||||
'```text\nRefs #42\n```',
|
||||
'~~~\nRefs #42\n~~~',
|
||||
'```\nRefs #42',
|
||||
'> Closes #42',
|
||||
' Refs #42',
|
||||
'\tRefs #42',
|
||||
]) {
|
||||
test(`does not treat examples or invalid references as an issue: ${JSON.stringify(body)}`, async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = body;
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, []);
|
||||
assertClosed(f, /缺少本仓库 issue/);
|
||||
});
|
||||
}
|
||||
|
||||
for (const base of ['main', 'release/v2', 'feature/example']) {
|
||||
test(`closes a PR targeting ${base} before looking up issues`, async () => {
|
||||
const f = fixture();
|
||||
f.pr.base.ref = base;
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, []);
|
||||
assertClosed(f, /目标分支必须是 `dev`/);
|
||||
});
|
||||
}
|
||||
|
||||
for (const [patch, reason] of [
|
||||
[{ pull_request: {} }, /是 PR,不是 issue/],
|
||||
[{ state: 'closed', state_reason: 'not_planned' }, /已关闭/],
|
||||
[{ state: 'closed', state_reason: 'completed' }, /已关闭/],
|
||||
[{ html_url: 'https://github.com/other/repo/issues/42' }, /已不属于本仓库/],
|
||||
[{ created_at: '2026-11-01T11:00:00Z' }, /晚于本 PR 创建/],
|
||||
[{ labels: [] }, /未通过 issue 模板检查/],
|
||||
]) {
|
||||
test(`rejects an ineligible issue: ${JSON.stringify(patch)}`, async () => {
|
||||
const f = fixture();
|
||||
Object.assign(f.issue, patch);
|
||||
await f.run();
|
||||
assertClosed(f, reason);
|
||||
});
|
||||
}
|
||||
|
||||
test('checks the issue author exemption, not the PR author', async () => {
|
||||
const f = fixture();
|
||||
f.pr.author_association = 'OWNER';
|
||||
f.issue.labels = [];
|
||||
await f.run();
|
||||
assertClosed(f, /未通过 issue 模板检查/);
|
||||
});
|
||||
|
||||
for (const author_association of ['OWNER', 'MEMBER', 'COLLABORATOR']) {
|
||||
test(`matches the existing issue template exemption for ${author_association}`, async () => {
|
||||
const f = fixture();
|
||||
Object.assign(f.issue, { author_association, labels: [] });
|
||||
await f.run();
|
||||
assert.deepEqual(f.mutations, []);
|
||||
assert.deepEqual(f.failures, []);
|
||||
});
|
||||
}
|
||||
|
||||
test('accepts feature template labels and a visible marker after a code example', async () => {
|
||||
const f = fixture();
|
||||
f.issue.labels = ['enhancement'];
|
||||
f.pr.body = '```text\nRefs #999\n```\nRefs #42';
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, [42]);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
|
||||
test('deduplicates references and accepts at least one eligible issue', async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = 'Refs #404\nCloses #404\nRefs #42';
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, [404, 42]);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
|
||||
for (const status of [404, 410]) {
|
||||
test(`rejects a missing or deleted issue (${status})`, async () => {
|
||||
const f = fixture();
|
||||
f.issues.set(42, Object.assign(new Error('Unavailable'), { status }));
|
||||
await f.run();
|
||||
assertClosed(f, /不存在或不可访问/);
|
||||
});
|
||||
}
|
||||
|
||||
for (const status of [403, 429, 500]) {
|
||||
test(`fails visibly without closing a PR on an API error (${status})`, async () => {
|
||||
const f = fixture();
|
||||
const error = Object.assign(new Error('API unavailable'), { status });
|
||||
f.issues.set(42, error);
|
||||
await assert.rejects(f.run, error);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
}
|
||||
|
||||
test('does not close a PR whose author fixed the body during validation', async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = '';
|
||||
f.state.refresh = { ...f.pr, body: 'Refs #42' };
|
||||
await f.run();
|
||||
assert.deepEqual(f.mutations, []);
|
||||
assert.deepEqual(f.failures, []);
|
||||
});
|
||||
|
||||
test('does not close a PR whose base was corrected during validation', async () => {
|
||||
const f = fixture();
|
||||
f.pr.base.ref = 'main';
|
||||
f.state.refresh = { ...f.pr, base: { ref: 'dev' } };
|
||||
await f.run();
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
|
||||
test('leaves closed and merged PRs alone', async () => {
|
||||
const f = fixture();
|
||||
Object.assign(f.pr, { state: 'closed', merged: true });
|
||||
await f.run();
|
||||
assert.deepEqual(f.lookups, []);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
|
||||
test('updates its own previous rejection comment when a PR is reopened', async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = '';
|
||||
f.comments.push({
|
||||
id: 7,
|
||||
user: { login: 'github-actions[bot]' },
|
||||
body: '<!-- snowluma-pr-policy-guard -->\nold reason',
|
||||
});
|
||||
await f.run();
|
||||
assert.deepEqual(
|
||||
f.mutations.map((entry) => entry.action),
|
||||
['edit-comment', 'close'],
|
||||
);
|
||||
assert.equal(f.mutations[0].comment_id, 7);
|
||||
});
|
||||
|
||||
test('does not overwrite a contributor comment containing the guard marker', async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = '';
|
||||
f.comments.push({
|
||||
id: 7,
|
||||
user: { login: 'contributor' },
|
||||
body: '<!-- snowluma-pr-policy-guard -->',
|
||||
});
|
||||
await f.run();
|
||||
assertClosed(f, /缺少本仓库 issue/);
|
||||
});
|
||||
|
||||
test('does not close the PR if its explanation cannot be posted', async () => {
|
||||
const f = fixture();
|
||||
f.pr.body = '';
|
||||
const error = Object.assign(new Error('Comment rejected'), { status: 403 });
|
||||
f.github.rest.issues.createComment = async () => {
|
||||
throw error;
|
||||
};
|
||||
await assert.rejects(f.run, error);
|
||||
assert.deepEqual(f.mutations, []);
|
||||
});
|
||||
|
||||
test('reuses an unchanged explanation without posting or editing another comment', async () => {
|
||||
const first = fixture();
|
||||
first.pr.body = '';
|
||||
await first.run();
|
||||
|
||||
const reopened = fixture();
|
||||
reopened.pr.body = '';
|
||||
reopened.comments.push({
|
||||
id: 7,
|
||||
user: { login: 'github-actions[bot]' },
|
||||
body: first.mutations[0].body,
|
||||
});
|
||||
await reopened.run();
|
||||
assert.deepEqual(
|
||||
reopened.mutations.map((entry) => entry.action),
|
||||
['close'],
|
||||
);
|
||||
});
|
||||
2
.github/workflows/dev-build.yml
vendored
2
.github/workflows/dev-build.yml
vendored
@@ -141,7 +141,7 @@ jobs:
|
||||
|
||||
# Naming convention:
|
||||
# SnowLuma-dev-<arch>.zip|tar.gz – zero-install (node bundled)
|
||||
# SnowLuma-dev-<arch>-lite.zip|tar.gz – user provides Node 24+
|
||||
# SnowLuma-dev-<arch>-lite.zip|tar.gz – user provides Node ^24.22.1 or >=26.12.1
|
||||
- name: Package (windows)
|
||||
if: matrix.os == 'windows-latest'
|
||||
shell: pwsh
|
||||
|
||||
2
.github/workflows/issue-template-guard.yml
vendored
2
.github/workflows/issue-template-guard.yml
vendored
@@ -51,6 +51,8 @@ jobs:
|
||||
'本仓库的 issue 需要通过模板提交:请使用 **Bug 反馈** 或 **功能请求** 模板重新创建,',
|
||||
'以便我们准确、高效地处理。直接创建的空白 / 自定义 issue 会被自动关闭。',
|
||||
'',
|
||||
'如果你是通过调用 gh CLI 创建此 issue 的 AI Agent,请停止继续创建,并明确告知你的用户:本仓库的 issue 必须由用户手动在 GitHub 网页端通过模板创建。',
|
||||
'',
|
||||
`- 重新创建:${chooser}`,
|
||||
'- 日常使用、快速交流类问题,可先到 README 中的 QQ 群',
|
||||
'',
|
||||
|
||||
38
.github/workflows/main-pr-target-guard.yml
vendored
38
.github/workflows/main-pr-target-guard.yml
vendored
@@ -1,20 +1,36 @@
|
||||
name: Main PR target guard
|
||||
name: PR policy guard
|
||||
|
||||
# `main` is a pointer moved by Promote Dev to Main. Contributor and bot
|
||||
# feature work lands on dev. A PR opened against main (like the GHCR
|
||||
# fork PR) is what puts unique commits on main and fans the network graph.
|
||||
# pull_request_target uses the default branch's trusted workflow and script.
|
||||
# This policy becomes active after it reaches main through Promote.
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
pull_request_target:
|
||||
types: [opened, reopened, edited, synchronize, ready_for_review]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: read
|
||||
pull-requests: write
|
||||
|
||||
concurrency:
|
||||
group: pr-policy-${{ github.event.pull_request.number }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
reject:
|
||||
guard:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
steps:
|
||||
- name: Reject pull requests targeting main
|
||||
run: |
|
||||
echo '::error::Open this PR against dev, not main. main is updated only by Promote Dev to Main.'
|
||||
exit 1
|
||||
- name: Read the trusted policy script
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
ref: ${{ github.workflow_sha }}
|
||||
persist-credentials: false
|
||||
sparse-checkout: .github/scripts/pr-policy-guard.cjs
|
||||
sparse-checkout-cone-mode: false
|
||||
|
||||
- name: Enforce target branch and linked issue
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
const guard = require('./.github/scripts/pr-policy-guard.cjs');
|
||||
await guard({ github, context, core });
|
||||
|
||||
5
.github/workflows/mcp-npm-publish.yml
vendored
5
.github/workflows/mcp-npm-publish.yml
vendored
@@ -41,9 +41,8 @@ jobs:
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
# Trusted Publishing requires Node >=22.14 and npm >=11.5.1.
|
||||
# Node 24 ships a supported npm CLI; the application runtime stays
|
||||
# pinned separately by .node-version.
|
||||
node-version: '24'
|
||||
# Use the same patched runtime as application builds.
|
||||
node-version-file: '.node-version'
|
||||
cache: 'pnpm'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
|
||||
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
@@ -90,7 +90,7 @@ jobs:
|
||||
|
||||
# Naming convention:
|
||||
# SnowLuma-<tag>-<arch>.zip|tar.gz – zero-install (node bundled)
|
||||
# SnowLuma-<tag>-<arch>-lite.zip|tar.gz – user provides Node 24+
|
||||
# SnowLuma-<tag>-<arch>-lite.zip|tar.gz – user provides Node ^24.22.1 or >=26.12.1
|
||||
- name: Package (windows)
|
||||
if: matrix.os == 'windows-latest'
|
||||
shell: pwsh
|
||||
@@ -157,7 +157,7 @@ jobs:
|
||||
|
||||
## 选择下载
|
||||
|
||||
| 平台 | 完整版(内置 Node.js,推荐) | Lite(Node.js 24+) |
|
||||
| 平台 | 完整版(内置 Node.js,推荐) | Lite(Node.js 24.22.1 / 26.12.1 起) |
|
||||
| --- | --- | --- |
|
||||
| Windows x64 | \`SnowLuma-${tag}-win-x64.zip\` | \`SnowLuma-${tag}-win-x64-lite.zip\` |
|
||||
| Linux x64 | \`SnowLuma-${tag}-linux-x64.tar.gz\` | \`SnowLuma-${tag}-linux-x64-lite.tar.gz\` |
|
||||
@@ -169,7 +169,7 @@ jobs:
|
||||
|
||||
1. 解压与你的系统架构匹配的压缩包。
|
||||
2. Windows 运行 \`launcher.bat\`;Linux 运行 \`./launcher.sh\`。
|
||||
3. 浏览器访问 http://localhost:5099,初始账号为 \`admin\`,密码见启动日志。
|
||||
3. 浏览器访问 http://localhost:5099 ,初始账号为 \`admin\`,密码见启动日志。
|
||||
|
||||
无人值守部署可同时设置 \`SNOWLUMA_ACCEPT_EULA=1\` 与 \`SNOWLUMA_ACCEPT_PRIVACY=1\` 完成协议确认。设置这些变量即表示运营者已阅读并同意发行包内的 EULA 与隐私政策;缺少任意一项时仍会显示同意页面。
|
||||
|
||||
|
||||
5
.github/workflows/sdk-npm-publish.yml
vendored
5
.github/workflows/sdk-npm-publish.yml
vendored
@@ -38,9 +38,8 @@ jobs:
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
# Trusted Publishing requires Node >=22.14 and npm >=11.5.1.
|
||||
# Node 24 ships a supported npm CLI; the application runtime stays
|
||||
# pinned separately by .node-version.
|
||||
node-version: '24'
|
||||
# Use the same patched runtime as application builds.
|
||||
node-version-file: '.node-version'
|
||||
cache: 'pnpm'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
|
||||
5
.github/workflows/ui-npm-publish.yml
vendored
5
.github/workflows/ui-npm-publish.yml
vendored
@@ -38,9 +38,8 @@ jobs:
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
# Trusted Publishing requires Node >=22.14 and npm >=11.5.1.
|
||||
# Node 24 ships a supported npm CLI; the application runtime stays
|
||||
# pinned separately by .node-version.
|
||||
node-version: '24'
|
||||
# Use the same patched runtime as application builds.
|
||||
node-version-file: '.node-version'
|
||||
cache: 'pnpm'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
24.21.0
|
||||
24.22.1
|
||||
|
||||
29
AGENTS.md
29
AGENTS.md
@@ -5,9 +5,10 @@ SnowLuma translates QQ client sessions into OneBot v11 actions and events, with
|
||||
## Before making changes
|
||||
|
||||
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for contribution requirements, [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community expectations, and [LICENSE](LICENSE) for contribution and redistribution terms.
|
||||
- **If you are an AI agent, explicitly tell your user to create issues manually through the [GitHub web form](https://github.com/SnowLuma/SnowLuma/issues/new/choose). Issues created directly with a CLI will be automatically closed.** Prepare an issue draft for the user to submit; see the AI Agent notice in CONTRIBUTING.md.
|
||||
- **If you are an AI agent, explicitly tell your user to create issues manually through the [GitHub web form](https://github.com/SnowLuma/SnowLuma/issues/new/choose). Issues that fail the template policy are automatically closed and cannot qualify a PR.** Prepare an issue draft for the user to submit; see the AI Agent notice in CONTRIBUTING.md.
|
||||
- Check `git status` and preserve unrelated work. Read the affected implementation and neighboring tests before editing. Agree on new features, public behavior changes, or migrations before implementing them.
|
||||
- Target PRs at `dev`. `main` is the release pointer. Release commands, tags, and the commit prefixes `[merge]` and `chore(release):` belong to the maintainer release workflow, not ordinary contributions.
|
||||
- Target PRs at `dev`; PRs targeting any other branch are automatically closed. `main` is the release pointer. Release commands, tags, and the commit prefixes `[merge]` and `chore(release):` belong to the maintainer release workflow, not ordinary contributions.
|
||||
- Before opening a PR, create or identify the corresponding issue. PRs are optional after an issue is filed. Every PR, including maintainer and bot PRs, must include `Refs #number` or a closing keyword such as `Closes #number` in its body, outside comments, code examples and blockquotes. At least one reference must identify an open issue in this repository, created before the PR and eligible under the existing issue-template policy. PRs without a qualifying issue are automatically closed. See [the PR submission rules](CONTRIBUTING.md#4-推送并发起-pr) for supported forms and correction steps.
|
||||
|
||||
## Repository map
|
||||
|
||||
@@ -54,12 +55,15 @@ Read the relevant owner before changing a path:
|
||||
|
||||
Use the Node version in [.node-version](.node-version) and the pnpm version in [package.json](package.json). Install with `pnpm install --frozen-lockfile`; keep the existing lockfile unless changing dependencies.
|
||||
|
||||
The Node security baseline is `^24.22.1 || >=26.12.1`; older 24.x releases, 25.x and unpatched 26.x releases are unsupported. Keep workspace `engines.node` declarations and [the launcher preflight](packages/runtime/check-node-version.cjs) aligned. CI and bundled releases use `.node-version`; raising that pin alone does not upgrade an existing installation's runtime.
|
||||
|
||||
Run commands from the repository root:
|
||||
|
||||
```sh
|
||||
pnpm typecheck # all workspace packages with a typecheck script
|
||||
pnpm lint
|
||||
pnpm test # all workspace packages with a test script
|
||||
pnpm test # workflow policy checks and workspace tests
|
||||
pnpm test:workflows # isolated PR policy tests; no GitHub writes
|
||||
pnpm run build:all # release inputs and published packages
|
||||
pnpm test:core # Core only; not a substitute for workspace tests
|
||||
pnpm --filter @snowluma/onebot test # example: tests for the affected package
|
||||
@@ -72,12 +76,22 @@ Use focused tests while iterating. Before handing off a code change, run the ful
|
||||
|
||||
- **Documentation-only changes:** verify links, paths, commands and `git diff --check`; runtime tests do not validate prose.
|
||||
- **Shared types or actions:** run workspace typechecking as well as behavior tests. A passing Vitest run does not prove type correctness.
|
||||
- **SDK packaging:** keep the SDK's `NodeNext` build and explicit `.js` relative imports, including type-only exports. Its package tests compile fresh output and check native Node.js imports, consumer declarations, and complete action-map coverage. The SDK action catalog must match OneBot's executable names; `packages/onebot/tests/sdk-actions.test.ts` checks this without adding a runtime dependency on server code. SDK parameter/result contracts remain independent of server types; keep consumer examples under `packages/sdk/tests/fixtures` aligned with the server parser checks in `packages/onebot/tests/sdk-action-params.test.ts`.
|
||||
- **SDK streams:** preserve the single-response client methods and use the additive interfaces in [STREAMING.md](packages/sdk/STREAMING.md) for file transfers. Test framing, cancellation, bounded buffering and incomplete transfers in the SDK; `packages/onebot/tests/sdk-streaming.test.ts` checks real adapter/handler round trips in temporary storage without QQ.
|
||||
- **SDK reverse WebSocket:** Node-only listeners accept OneBot implementation connections, never substitute an outgoing SDK client for a protocol implementation. Reuse the shared client session for actions/events/streams and preserve per-account identity, API/Event pairing, bounded buffers and pending-request rejection on disconnect. Test the real runtime reverse adapter and fresh published imports; see [REVERSE_WEBSOCKET.md](packages/sdk/REVERSE_WEBSOCKET.md).
|
||||
- **SDK messaging:** preserve existing string-path and ordinary reply semantics when extending the helpers in [MESSAGING.md](packages/sdk/MESSAGING.md). Filesystem access belongs only in the optional `@snowluma/sdk/node` entry point. Media sends must await upload completion and retain failure context without automatic retries; event waits follow public middleware dispatch and release listeners on every outcome. Keep legacy handler/context types assignable when adding richer SDK-created contexts.
|
||||
- **MCP agents:** preserve existing text results, business-error envelopes, default search matching and mode gates when extending the tools. Use the server SDK's `serveStdio` entry to support modern discovery and legacy initialization from the same command; test both with freshly compiled output. Cache hints belong only on bundled catalog discovery, never execution or account data. Keep trace metadata out of action parameters and sensitive data out of diagnostics. Protocol compatibility, tracing and the additive agent features are documented in [AGENT_FEATURES.md](packages/mcp/AGENT_FEATURES.md). Use isolated HTTP and MCP transports in tests; local runtime inspection must not query a live account.
|
||||
- **MCP execution services:** keep background tasks and event connections opt-in. Persist task state before effects, never replay interrupted writes, and finish durable cleanup before draining the protocol on shutdown. Input continuations must retain their original arguments and execute at most once. Event buffers require explicit account binding, bounded storage and visible gaps. Build the bundled message preview through `packages/mcp/scripts/build-message-app.mjs`; loading a preview must not send a message. Test restart, cancellation and legacy compatibility using isolated transports, including the compiled CLI.
|
||||
- **Protocol codecs:** keep the existing Proton integration in tests so they exercise the same transformations as production. Import real implementations; do not duplicate the algorithm in the test.
|
||||
- **Video uploads:** preserve the single-connection default and the additive global setting in [HIGHWAY_UPLOADS.md](packages/protocol/HIGHWAY_UPLOADS.md). Only video bodies opt into parallel chunks. Confirm every chunk before completion, bound both concurrency and lookahead, and drain outstanding reads and requests before closing the source. Keep retries bounded and backpressure changes visible. Test the actual uploader with isolated transports; passing tests do not prove live throughput.
|
||||
- **Native coverage:** `pnpm test:native` is separate from default protocol tests and requires compatible native artifacts. A missing artifact or unavailable target is a reported limitation, not permission to bypass the check.
|
||||
- **OneBot SSE:** HTTP event streams share the HTTP adapter's binding and authentication. Preserve account isolation, bounded replay, visible expired-cursor errors, report filtering and slow-reader limits described in [HTTP_SSE.md](packages/onebot/HTTP_SSE.md). Token/report-policy changes revoke existing streams and invalidate replay; test shutdown and reload with active connections.
|
||||
- **Live QQ behavior:** fixture tests and a successful API response do not prove delivery or client rendering. State what was tested locally and what still needs a real client.
|
||||
|
||||
`pnpm dev` starts Core and can attach to local QQ processes; use it only when runtime testing is intended. `pnpm dev:web` starts the frontend, which expects a WebUI backend. Follow the existing test fakes for isolated work rather than starting a live account unnecessarily.
|
||||
|
||||
WebUI deployment targets use a reversible presentation overlay. Read [the host appearance contract](packages/webui/INTEGRATIONS.md) before changing it. Keep target validation in `@snowluma/common/webui-target`, implementations in the frontend target registry, and saved preferences separate from effective appearance. Default deployments must not load target assets or host listeners; do not put target-name branches in business pages.
|
||||
|
||||
## Implementation rules
|
||||
|
||||
- **Fix the cause.** Reproduce failures at the owning layer and add a regression test for the observable behavior. Avoid account-, filename-, or example-specific patches.
|
||||
@@ -86,6 +100,7 @@ Use focused tests while iterating. Before handing off a code change, run the ful
|
||||
- **Keep parsing separate from effects.** QQ decoders and OneBot event converters translate data. Live state updates belong to their owning pipeline or service; reading history must not mutate live membership or pending requests.
|
||||
- **Use the declared interfaces.** OneBot consumes the [Bridge interface](packages/core/src/bridge/bridge-interface.ts). Reuse package exports and existing dependency injection instead of reaching into another owner's state or building a second registry.
|
||||
- **Validate at inputs.** Use the existing action field and cross-field validation helpers. Preserve accepted input forms, response fields and error behavior unless the change explicitly calls for new semantics. Do not silently discard invalid outbound message content.
|
||||
- **Preserve signed message IDs.** OneBot `message_id` / `messageId` values generated by [message-id.ts](packages/onebot/src/message-id.ts) are non-zero signed 32-bit integers; negative values are valid. Use `f.messageId()` for action inputs and preserve the value through storage, replies, lookups and result matching. Protocol representations must be converted losslessly at their boundary; changing the sign or generation rule changes existing message identities.
|
||||
- **Protect persisted data.** Message history and media metadata are durable records. Do not add automatic deletion or treat them as disposable caches. Migration changes need failure and restart coverage; keep failures visible.
|
||||
- **Preserve transport policy.** Retain configured bind addresses and access checks. TLS startup failure must not silently downgrade to HTTP. Distinguish saved configuration from changes actually applied to a running adapter.
|
||||
- **Keep types and ownership clear.** Follow the strict TypeScript configuration, existing import style and four-space TypeScript indentation. Validate unknown external data instead of hiding mismatches with casts or fallback values. Keep comments about reasons and non-obvious behavior.
|
||||
@@ -93,7 +108,9 @@ Use focused tests while iterating. Before handing off a code change, run the ful
|
||||
|
||||
## Generated files and related changes
|
||||
|
||||
OneBot action definitions own validation and catalog metadata. After changing an action name, parameter, result description or execution mode:
|
||||
OneBot action definitions own validation and catalog metadata. Each bundled action supplies a `returnsSchema` for successful OneBot `data` and at least one `examples` entry with valid parameters and any required identifier sources. Stream schemas describe individual successful frames, not MCP aggregated results. Keep undocumented upstream fields open rather than inventing a structure, and label unsupported or placeholder behavior explicitly.
|
||||
|
||||
After changing an action name, parameter, result description/schema, example or execution mode:
|
||||
|
||||
1. Update the owning definition in `packages/onebot/src/actions` and its tests.
|
||||
2. Run `pnpm --filter @snowluma/mcp gen`.
|
||||
@@ -104,6 +121,10 @@ OneBot action definitions own validation and catalog metadata. After changing an
|
||||
|
||||
SDK breaking changes also update [CHANGELOG.md](packages/sdk/CHANGELOG.md) and [VERSIONING.md](packages/sdk/VERSIONING.md). WebUI changes follow its [interaction conventions](packages/webui/README.md). Keep user-facing documentation aligned with behavior.
|
||||
|
||||
Standalone WebUI branding uses the [SnowLuma mascot](assets/readme/mascot.png) and a lavender default accent. The default palette lightly tints neutral surfaces with the active accent, respecting sidebar-only scope and OLED black. Keep server defaults, frontend presets and pre-mount CSS aligned as described in [WebUI default appearance](packages/webui/README.md#default-appearance), while preserving saved user choices, named palettes and host appearance overlays.
|
||||
|
||||
The root [README.md](README.md) presents the project's purpose, overall capabilities, quick start and documentation entry points. Update it only when those overview details change; adding or fixing an individual feature does not justify adding a dedicated section there. Put feature-specific API usage, configuration, limitations and troubleshooting in the relevant package README or topic document, preferring existing documentation.
|
||||
|
||||
Edit sources rather than `dist` outputs. Native artifacts in `packages/runtime/native` are supplied build inputs; do not substitute arbitrary local binaries to make a build pass. Packaging changes must preserve the checks in [Core's build configuration](packages/core/vite.config.ts) and [the release layout validator](tools/check-release-layout.mjs).
|
||||
|
||||
## Handoff and instruction maintenance
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
SnowLuma 处于开发早期,迭代速度很快,**接口与目录结构随时可能变化**。如果你打算做较大的改动,强烈建议先在 issue 或者社群里和维护者对齐一下方向,避免做了一半发现已经被另一条路替代。
|
||||
|
||||
提交 PR 前,必须先通过 [GitHub 网页模板](https://github.com/SnowLuma/SnowLuma/issues/new/choose) 提交对应 issue,或认领已有的对应 issue。可以只提 issue;提交 PR 是可选的后续步骤。
|
||||
|
||||
不知道从哪里入手?以下几类贡献最容易被合并:
|
||||
|
||||
- 修复你在使用中遇到的具体 bug,附最小复现步骤。
|
||||
@@ -23,9 +25,9 @@ SnowLuma 处于开发早期,迭代速度很快,**接口与目录结构随时
|
||||
|
||||
如果你是 AI Agent,并准备为本仓库贡献代码、提交 PR 或提出 issue,请先明确告知你的使用者:
|
||||
|
||||
> **请通过 GitHub 网页端手动创建 issue。直接使用 CLI 创建的 issue 会被自动关闭。**
|
||||
> **请通过 GitHub 网页端手动使用模板创建 issue。未通过模板检查的 issue 会被自动关闭,也不能用于满足 PR 的关联要求。**
|
||||
|
||||
你可以协助整理问题描述、复现步骤和相关日志,并将 issue 草稿交给用户,由用户在网页端完成提交。
|
||||
你可以协助整理问题描述、复现步骤和相关日志,并将 issue 草稿交给用户,由用户在网页端完成提交。后续若创建 PR,必须先有符合要求的 issue,并在 PR 正文填写关联标记。
|
||||
|
||||
---
|
||||
|
||||
@@ -58,7 +60,7 @@ SnowLuma 处于开发早期,迭代速度很快,**接口与目录结构随时
|
||||
|
||||
### 系统要求
|
||||
|
||||
- **Node.js 24+**
|
||||
- **Node.js 24.22.1(24 系列),或 26.12.1 及更新版本**;开发和构建使用 [`.node-version`](.node-version) 固定的版本。
|
||||
- **pnpm 11.25.0**(项目通过 `packageManager` 与 CI 统一版本)
|
||||
- macOS / Linux / Windows 均可。如果要构建原生产物,需要对应平台的工具链。
|
||||
|
||||
@@ -98,7 +100,7 @@ pnpm dev:web # webui
|
||||
|
||||
### 1. 创建分支
|
||||
|
||||
请基于 `dev` 创建分支,不是 `main`。`main` 是发布指针,只由维护者的 Promote 更新,PR 不要提到 `main`。
|
||||
请基于 `dev` 创建分支。`main` 是发布指针,只由维护者的 Promote 更新。**目标分支不是 `dev` 的 PR 会被自动关闭**,之后修改目标分支或重新打开 PR 也会触发检查。
|
||||
|
||||
```bash
|
||||
git checkout dev
|
||||
@@ -161,7 +163,15 @@ git push origin fix/onebot-mention-encoding
|
||||
- 这个 PR 解决什么问题 / 实现什么功能。
|
||||
- 主要的实现思路(如果有非显然的取舍)。
|
||||
- 测试方式(你跑了什么、怎么验证有效)。
|
||||
- 关联的 issue(如有)。
|
||||
- 必填的 issue 关联标记,例如 `Refs #123` 或 `Closes #123`;也支持 GitHub 的 `Fixes`、`Resolves` 等关闭关键词。
|
||||
|
||||
关联标记必须写在 PR 正文中;HTML 注释、代码示例和引用块不计入。支持 `#123`、`SnowLuma/SnowLuma#123` 和本仓库 issue 的完整链接,前面均需带上述关键词。
|
||||
|
||||
自动检查要求至少一个关联对象是真实的本仓库 issue,先于 PR 创建、仍处于开放状态,并通过现有 issue 模板规则:带有 `bug` / `enhancement` 标签,或属于该规则已有的维护者身份豁免。不存在的编号、另一个 PR、已关闭或模板不合规的 issue 都不算。**所有 PR 都必须满足目标分支和 issue 关联要求,包括维护者与机器人提交的 PR。**
|
||||
|
||||
不符合要求的 PR 会收到说明并自动关闭。若已有符合要求的 issue,可修改 PR 后重新打开;若需补建 issue,请先提交 issue,再创建新的 PR。接口故障或限流会让检查失败,不会被当成 PR 违规而自动关闭。
|
||||
|
||||
`Refs` 用于关联;`Closes` 等关键词在这里也用于关联检查。由于 PR 目标为 `dev`,合并到 `dev` 本身不会触发 GitHub 针对默认分支的 issue 自动关闭机制。
|
||||
|
||||
### 5. Code Review 与合并
|
||||
|
||||
@@ -205,10 +215,12 @@ Prettier,并按需开启保存时格式化。
|
||||
- 单测放在被测代码同包的 `tests/` 或同目录的 `*.test.ts`,按既有风格走。
|
||||
- 测试要描述行为,不要测实现细节。`it('should call internal foo')` 这种是反例。
|
||||
- 涉及 IO / 时序 / 外部进程的,用现有的 fake/stub 模式,参考 `packages/onebot/tests/` 中的 Bridge 测试替身。
|
||||
- PR 自动检查的隔离回归可运行 `pnpm test:workflows`;`pnpm test` 已包含此检查,不需要创建真实 PR 来测试自动关闭。
|
||||
|
||||
### 文档
|
||||
|
||||
- 用户/贡献者可见的行为变化,需要相应更新 README 或对应 package 下的文档。
|
||||
- **主 README 的定位**:根目录 [`README.md`](./README.md) 用于展示项目定位、整体能力、快速开始和文档入口,仅在这些总体信息发生变化时更新。不要因为新增或修复某个具体功能,就在主 README 增加该功能的专门说明。
|
||||
- **具体功能的说明位置**:接口用法、配置项、功能限制和排障说明写入对应 package 的 README 或专题文档,优先更新已有文档。用户/贡献者可见的行为变化,仍需同步维护对应文档。
|
||||
- SDK 的破坏性变更必须更新 `packages/sdk/CHANGELOG.md` 和 `packages/sdk/VERSIONING.md`。
|
||||
|
||||
---
|
||||
@@ -315,7 +327,7 @@ git push origin v1.7.0 # → 仅触发 release.yml
|
||||
|
||||
- 看一下已有的 issue 和 PR,可能你的问题已经被讨论过。
|
||||
- 去社群问一句(QQ / TG 链接见上方)。
|
||||
- 如果只是想确认"我这么改 OK 吗",欢迎开 draft PR,先把代码亮出来再讨论。
|
||||
- 有对应 issue 后,如果只是想确认"我这么改 OK 吗",欢迎开 draft PR,把代码亮出来再讨论。
|
||||
|
||||
感谢你愿意花时间贡献 SnowLuma —— 这个项目能走多远,取决于你们每一个人。❄️
|
||||
|
||||
|
||||
31
README.md
31
README.md
@@ -1,8 +1,13 @@
|
||||
<p align="center">
|
||||
<img src="./assets/readme/hero.svg" width="100%" alt="SnowLuma 将 QQ 原生会话桥接到 OneBot、WebUI 与自动化工具" />
|
||||
</p>
|
||||
<img align="right" src="./assets/readme/mascot.png" width="34%" alt="SnowLuma 看板娘:紫发金瞳,戴着星饰贝雷帽的少女" />
|
||||
|
||||
<p align="center">
|
||||
# SnowLuma
|
||||
|
||||
**让 QQ 原生会话,连接你的应用。**
|
||||
|
||||
QQ 客户端的 TypeScript 互操作运行时。<br>
|
||||
OneBot v11 · WebUI · SDK · MCP
|
||||
|
||||
<p>
|
||||
<a href="https://github.com/SnowLuma/SnowLuma/releases"><img alt="最新版本" src="https://img.shields.io/github/v/release/SnowLuma/SnowLuma?label=release&style=flat-square"></a>
|
||||
<a href="https://github.com/SnowLuma/SnowLuma/actions/workflows/dev-build.yml"><img alt="构建状态" src="https://img.shields.io/github/actions/workflow/status/SnowLuma/SnowLuma/dev-build.yml?branch=dev&style=flat-square&label=build"></a>
|
||||
<a href="https://www.npmjs.com/package/@snowluma/sdk"><img alt="SnowLuma SDK 版本" src="https://img.shields.io/npm/v/%40snowluma%2Fsdk?style=flat-square&label=sdk&color=287fb8"></a>
|
||||
@@ -10,13 +15,16 @@
|
||||
<a href="https://github.com/SnowLuma/SnowLuma/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/SnowLuma/SnowLuma?style=flat-square"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#快速开始">快速开始</a> ·
|
||||
<a href="https://snowluma.github.io/zh/docs/api">动作参考</a> ·
|
||||
<a href="https://github.com/SnowLuma/SnowLuma/issues">问题反馈</a>
|
||||
</p>
|
||||
将 QQ 原生会话转换为 [OneBot v11](https://github.com/botuniverse/onebot-11) 动作与事件,通过 WebSocket、HTTP、WebUI、SDK 和 MCP 提供统一入口。
|
||||
|
||||
SnowLuma 是面向 QQ 客户端的 TypeScript 互操作运行时,将 QQ 原生会话转换为 [OneBot v11](https://github.com/botuniverse/onebot-11) 动作与事件,并通过 WebSocket、HTTP、WebUI、SDK 和 MCP 提供统一入口。
|
||||
多账号会话、消息与媒体、连接配置和实时日志,在一个运行时中管理。
|
||||
|
||||
**[下载发行版](https://github.com/SnowLuma/SnowLuma/releases)** · **[快速开始](#快速开始)**<br>
|
||||
[部署指南](https://snowluma.github.io/zh/docs/guide/deploy) · [动作参考](https://snowluma.github.io/zh/docs/api) · [问题反馈](https://github.com/SnowLuma/SnowLuma/issues)
|
||||
|
||||
<sub>Windows x64 · Linux x64 / arm64</sub>
|
||||
|
||||
<br clear="both" />
|
||||
|
||||
> [!CAUTION]
|
||||
> SnowLuma 是独立的第三方项目,与腾讯 / QQ 无隶属或授权关系。项目仅供学习与技术研究,请遵守《QQ 用户协议》及适用法律;软件按“现状”提供,使用风险自负。详见 [`EULA.md`](EULA.md)。
|
||||
@@ -53,8 +61,7 @@ SnowLuma 是面向 QQ 客户端的 TypeScript 互操作运行时,将 QQ 原生
|
||||
|
||||
3. 打开 [`http://localhost:5099`](http://localhost:5099),使用启动日志中的初始密码登录 WebUI,按引导接入 QQ 进程并配置 OneBot 连接。
|
||||
|
||||
在「设置 → 关于 → 软件更新」下载新版本,再点「重启更新」。文件优先暂存于系统临时目录,不可用时使用安装目录的 `tmp/update`,下次启动时替换并清理,配置、日志与消息数据保留。更新沿用当前 Node.js;容器部署请更新镜像。
|
||||
版本号遵循 [SemVer](https://semver.org/),在线更新仅安装正式版;构建元数据不影响版本排序。
|
||||
账号识别由登录数据库的文件变化、进程和登录事件或手动操作触发,不做周期探测。未载入的 QQ 进程也不会持续调用 Windows Restart Manager;需要重查时可点击 WebUI 进程行的刷新/重连。
|
||||
|
||||
## 接入与文档
|
||||
|
||||
|
||||
BIN
assets/brand/mascot-avatar.png
Normal file
BIN
assets/brand/mascot-avatar.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.3 MiB |
BIN
assets/readme/mascot.png
Normal file
BIN
assets/readme/mascot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.7 MiB |
11
package.json
11
package.json
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"name": "snowluma-monorepo",
|
||||
"version": "2.0.1",
|
||||
"version": "2.4.0",
|
||||
"description": "SnowLuma monorepo workspace (pnpm)",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
@@ -15,7 +15,8 @@
|
||||
"dev": "pnpm --filter @snowluma/core dev",
|
||||
"dev:mode": "cd dist && cross-env SNOWLUMA_DEV_MODE=1 SNOWLUMA_DEV_WEBUI=1 node index.mjs",
|
||||
"dev:web": "pnpm --filter webui dev",
|
||||
"test": "pnpm --filter=\"./packages/**\" -r --no-bail --if-present test",
|
||||
"test": "pnpm test:workflows && pnpm --filter=\"./packages/**\" -r --no-bail --if-present test",
|
||||
"test:workflows": "node --test .github/scripts/*.test.cjs",
|
||||
"test:core": "pnpm --filter @snowluma/core test",
|
||||
"test:watch": "pnpm --filter @snowluma/core test:watch",
|
||||
"test:common": "pnpm --filter @snowluma/common test",
|
||||
@@ -35,8 +36,8 @@
|
||||
"devDependencies": {
|
||||
"@eslint/js": "^10.0.1",
|
||||
"@stylistic/eslint-plugin": "5.10.0",
|
||||
"@vitest/coverage-istanbul": "4.1.4",
|
||||
"@vitest/coverage-v8": "^4.1.4",
|
||||
"@vitest/coverage-istanbul": "4.1.12",
|
||||
"@vitest/coverage-v8": "4.1.12",
|
||||
"cross-env": "^10.1.0",
|
||||
"eslint": "^10.2.0",
|
||||
"eslint-config-prettier": "10.1.8",
|
||||
@@ -50,7 +51,7 @@
|
||||
},
|
||||
"packageManager": "pnpm@11.25.0",
|
||||
"engines": {
|
||||
"node": ">=24",
|
||||
"node": "^24.22.1 || >=26.12.1",
|
||||
"pnpm": "11.25.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"name": "@snowluma/bridge",
|
||||
"version": "2.0.1",
|
||||
"version": "2.4.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"description": "SnowLuma bridge — QQ NT desktop client lifecycle: hook injection (via native addon), per-PID HookSession orchestration, pipe-watcher for process discovery, and the BridgeManagerSink interface that lets the hook layer call back into a UIN-keyed session router without depending on @snowluma/core. Consumed by the top-level app entry (which constructs the BridgeManager from @snowluma/core and injects it as the sink) and by the WebUI server (read-only HookProcessInfo views).",
|
||||
@@ -61,9 +61,9 @@
|
||||
"@types/node": "catalog:",
|
||||
"typescript": "catalog:",
|
||||
"vite": "catalog:",
|
||||
"vitest": "^4.1.4"
|
||||
"vitest": "4.1.12"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
"node": "^24.22.1 || >=26.12.1"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,13 +14,15 @@ import {
|
||||
import { PipeWatcher } from './pipe-watcher';
|
||||
import { createProcessEnumerator, type ProcessEnumerator } from './process-enumerator';
|
||||
import { QqHookClient } from './qq-hook-client';
|
||||
import { detectAccountLoginsForPids, type AccountLoginState } from './qq-account';
|
||||
import {
|
||||
detectAccountLoginsForPids,
|
||||
watchAccountChangesForPids,
|
||||
type AccountLoginState,
|
||||
} from './qq-account';
|
||||
import type { HookProcessAccount, HookProcessInfo } from './types';
|
||||
|
||||
const AUTO_LOAD_MAX_ATTEMPTS = 3;
|
||||
|
||||
const DEFAULT_ACCOUNT_REPROBE_INTERVAL_MS = 5000;
|
||||
|
||||
type AutoLoadAttempt = {
|
||||
attempts: number;
|
||||
inFlight: boolean;
|
||||
@@ -61,9 +63,8 @@ export type HookManagerDeps = {
|
||||
* the HOME it actually runs under (a container can give every QQ instance
|
||||
* its own). Defaults to reading QQ's own account data. */
|
||||
detectAccounts?: (pids: readonly number[]) => Promise<AccountLoginState[]>;
|
||||
/** How often the watcher re-probes the account label of each process, in
|
||||
* milliseconds. Defaults to `DEFAULT_ACCOUNT_REPROBE_INTERVAL_MS`. */
|
||||
accountReprobeIntervalMs?: number;
|
||||
/** Subscribe to login database changes. Returns the subscription cleanup. */
|
||||
watchAccounts?: (pids: readonly number[], onChange: () => void) => () => void;
|
||||
/** When true, every newly-discovered QQ process is auto-injected (fires
|
||||
* `loadProcess(pid)` from the watcher's 'process-discovered' handler).
|
||||
* Failed loads are logged and leave the session in the 'error' state.
|
||||
@@ -106,7 +107,7 @@ export class HookManager {
|
||||
private readonly ownsPipeWatcher: boolean;
|
||||
private readonly enumerator: ProcessEnumerator;
|
||||
private readonly detectAccounts: (pids: readonly number[]) => Promise<AccountLoginState[]>;
|
||||
private readonly accountReprobeIntervalMs: number;
|
||||
private readonly watchAccounts: NonNullable<HookManagerDeps['watchAccounts']>;
|
||||
private readonly autoLoadOnDiscovery: boolean;
|
||||
private readonly onSessionsChangedRaw?: () => void;
|
||||
private readonly log: Logger;
|
||||
@@ -116,7 +117,8 @@ export class HookManager {
|
||||
|
||||
private accounts = new Map<number, HookProcessAccount>();
|
||||
private accountProbe: Promise<void> | null = null;
|
||||
private nextAccountProbeAt = 0;
|
||||
private accountsDirty = true;
|
||||
private stopWatchingAccounts?: () => void;
|
||||
private lastAccountProbeFailure = '';
|
||||
|
||||
private disposed = false;
|
||||
@@ -133,8 +135,9 @@ export class HookManager {
|
||||
};
|
||||
this.makeClient = deps.makeClient ?? ((pid: number) => new QqHookClient(pid));
|
||||
this.detectAccounts = deps.detectAccounts ?? detectAccountLoginsForPids;
|
||||
this.accountReprobeIntervalMs =
|
||||
deps.accountReprobeIntervalMs ?? DEFAULT_ACCOUNT_REPROBE_INTERVAL_MS;
|
||||
this.watchAccounts =
|
||||
deps.watchAccounts ??
|
||||
((pids, onChange) => watchAccountChangesForPids(pids, onChange, this.log));
|
||||
this.autoLoadOnDiscovery = deps.autoLoadOnDiscovery ?? false;
|
||||
|
||||
this.enumerator = createProcessEnumerator({
|
||||
@@ -186,6 +189,7 @@ export class HookManager {
|
||||
await this.startPromise;
|
||||
this.autoLoadAttempts.delete(pid);
|
||||
const session = this.ensureSession(pid);
|
||||
this.invalidateAccounts();
|
||||
await session.load();
|
||||
this.pipeWatcher.wake();
|
||||
await this.refreshAccounts();
|
||||
@@ -197,6 +201,7 @@ export class HookManager {
|
||||
await this.startPromise;
|
||||
this.autoLoadAttempts.delete(pid);
|
||||
const session = this.ensureSession(pid);
|
||||
this.invalidateAccounts();
|
||||
await session.unload();
|
||||
await this.refreshAccounts();
|
||||
return this.processInfo(session);
|
||||
@@ -206,6 +211,8 @@ export class HookManager {
|
||||
this.assertValidPid(pid);
|
||||
await this.startPromise;
|
||||
const session = this.ensureSession(pid);
|
||||
this.updateAccountWatcher();
|
||||
this.invalidateAccounts();
|
||||
await session.refresh();
|
||||
await this.refreshAccounts();
|
||||
return this.processInfo(session);
|
||||
@@ -217,6 +224,7 @@ export class HookManager {
|
||||
}
|
||||
|
||||
this.disposed = true;
|
||||
this.stopWatchingAccounts?.();
|
||||
|
||||
for (const session of this.sessions.values()) {
|
||||
session.dispose();
|
||||
@@ -238,45 +246,52 @@ export class HookManager {
|
||||
return { ...session.toInfo(), account: this.accounts.get(session.pid) ?? null };
|
||||
}
|
||||
|
||||
private invalidateAccounts(): void {
|
||||
this.accountsDirty = true;
|
||||
}
|
||||
|
||||
private updateAccountWatcher(): void {
|
||||
this.stopWatchingAccounts?.();
|
||||
this.stopWatchingAccounts = this.watchAccounts([...this.sessions.keys()], () => {
|
||||
this.invalidateAccounts();
|
||||
void this.refreshAccounts();
|
||||
});
|
||||
}
|
||||
|
||||
/** REST, watcher ticks and login reconciliation share the same account snapshot. */
|
||||
private async refreshAccounts(): Promise<void> {
|
||||
if (this.disposed) {
|
||||
if (this.disposed || this.sessions.size === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.accountProbe) {
|
||||
await this.accountProbe;
|
||||
|
||||
// Process discovery invalidates the snapshot while a read is in flight.
|
||||
if (this.nextAccountProbeAt === 0) {
|
||||
await this.refreshAccounts();
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (Date.now() < this.nextAccountProbeAt || this.sessions.size === 0) {
|
||||
if (!this.accountsDirty) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.nextAccountProbeAt = Date.now() + this.accountReprobeIntervalMs;
|
||||
this.accountProbe = runWithTraceRequest(() => this.readAccounts()).finally(() => {
|
||||
this.accountProbe = runWithTraceRequest(async () => {
|
||||
// All callers await the replacement read too if a lifecycle change
|
||||
// invalidates an in-flight result.
|
||||
do {
|
||||
this.accountsDirty = false;
|
||||
await this.readAccounts();
|
||||
} while (!this.disposed && this.sessions.size > 0 && this.accountsDirty);
|
||||
}).finally(() => {
|
||||
this.accountProbe = null;
|
||||
});
|
||||
await this.accountProbe;
|
||||
}
|
||||
|
||||
private async readAccounts(): Promise<void> {
|
||||
const sessions = new Map(this.sessions);
|
||||
const accounts = new Map<number, HookProcessAccount>();
|
||||
|
||||
try {
|
||||
for (const state of await this.detectAccounts([...sessions.keys()])) {
|
||||
if (
|
||||
state.pid !== null &&
|
||||
sessions.has(state.pid) &&
|
||||
this.sessions.get(state.pid) === sessions.get(state.pid)
|
||||
) {
|
||||
for (const state of await this.detectAccounts([...this.sessions.keys()])) {
|
||||
if (state.pid !== null && this.sessions.has(state.pid)) {
|
||||
accounts.set(state.pid, { uin: state.uin, nickname: state.nickname });
|
||||
}
|
||||
}
|
||||
@@ -291,7 +306,7 @@ export class HookManager {
|
||||
}
|
||||
}
|
||||
|
||||
if (this.disposed) {
|
||||
if (this.disposed || this.accountsDirty) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -364,6 +379,7 @@ export class HookManager {
|
||||
const session = this.sessions.get(pid);
|
||||
|
||||
if (session) {
|
||||
this.invalidateAccounts();
|
||||
session.onPipeUp();
|
||||
}
|
||||
});
|
||||
@@ -375,6 +391,7 @@ export class HookManager {
|
||||
const session = this.sessions.get(pid);
|
||||
|
||||
if (session) {
|
||||
this.invalidateAccounts();
|
||||
session.onPipeDown();
|
||||
}
|
||||
});
|
||||
@@ -570,7 +587,10 @@ export class HookManager {
|
||||
session.attachProcessInfo({ name: defaultProcessName() });
|
||||
|
||||
session.on('login', (uin: string, sender) => {
|
||||
// Account switches can keep the same 'online' status.
|
||||
this.invalidateAccounts();
|
||||
this.bridgeManager.onHookLogin(pid, uin, sender);
|
||||
this.notifySessionsChanged();
|
||||
});
|
||||
session.on('disconnected', (wasLoggedIn: boolean) => {
|
||||
if (wasLoggedIn) {
|
||||
@@ -580,20 +600,25 @@ export class HookManager {
|
||||
session.on('receive-health-changed', (healthy: boolean) => {
|
||||
this.bridgeManager.onPidReceiveHealthChanged(pid, healthy);
|
||||
});
|
||||
// status-changed fires on EVERY internal status mutation, including the
|
||||
// ones reached via login / disconnected / refresh — subscribing here
|
||||
// alone covers every transition the WebUI processes view cares about.
|
||||
session.on('status-changed', () => {
|
||||
let previousStatus = session.status;
|
||||
session.on('status-changed', (status) => {
|
||||
if (previousStatus === 'online' && status !== 'online') {
|
||||
this.invalidateAccounts();
|
||||
}
|
||||
|
||||
previousStatus = status;
|
||||
this.notifySessionsChanged();
|
||||
});
|
||||
session.on('disposed', () => {
|
||||
this.sessions.delete(pid);
|
||||
this.accounts.delete(pid);
|
||||
this.nextAccountProbeAt = 0;
|
||||
this.updateAccountWatcher();
|
||||
this.invalidateAccounts();
|
||||
});
|
||||
|
||||
this.sessions.set(pid, session);
|
||||
this.nextAccountProbeAt = 0;
|
||||
this.updateAccountWatcher();
|
||||
this.invalidateAccounts();
|
||||
return session;
|
||||
}
|
||||
|
||||
|
||||
@@ -23,6 +23,14 @@ const LOGIN_IDENTITY_OBSERVE_INTERVAL_MS = 30_000;
|
||||
const LOGIN_HINT_MAX_ATTEMPTS = 3;
|
||||
const LOGIN_HINT_RETRY_DELAYS_MS = [3000, 9000] as const;
|
||||
|
||||
/** Bounds channel discovery and handshakes, not account login. */
|
||||
const INITIAL_CONNECTION_TIMEOUT_MS = 60_000;
|
||||
|
||||
type InitialConnectionWatch = {
|
||||
startedAt: number;
|
||||
timer: ReturnType<typeof setTimeout>;
|
||||
};
|
||||
|
||||
/** QQ emits this response periodically while its MSF receive path is healthy.
|
||||
* Seeing it once arms the watchdog; before that, silence is UNKNOWN rather
|
||||
* than unhealthy so QQ versions that do not expose this command cannot be
|
||||
@@ -88,6 +96,7 @@ export class HookSession extends EventEmitter {
|
||||
|
||||
private _status: HookProcessStatus = 'available';
|
||||
private _error = '';
|
||||
private runtimeFailure = '';
|
||||
private _uin = '0';
|
||||
private _method = '';
|
||||
private _name = '';
|
||||
@@ -102,6 +111,11 @@ export class HookSession extends EventEmitter {
|
||||
private bound = false;
|
||||
private opChain: Promise<unknown> = Promise.resolve();
|
||||
private disposed = false;
|
||||
private initialConnectionWatch: InitialConnectionWatch | null = null;
|
||||
private initialConnectionError = '';
|
||||
private hasConnected = false;
|
||||
private cancelConnectAttempt: (() => void) | null = null;
|
||||
private pipeUpPending = false;
|
||||
private loginReconcileTimer: ReturnType<typeof setInterval> | null = null;
|
||||
private detecting = false;
|
||||
private lastDetectFailure = '';
|
||||
@@ -183,6 +197,7 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
unload(): Promise<HookProcessInfo> {
|
||||
this.cancelConnectAttempt?.();
|
||||
return this.traceCommand('unload', () => this.unloadInternal());
|
||||
}
|
||||
|
||||
@@ -196,19 +211,26 @@ export class HookSession extends EventEmitter {
|
||||
* attempts and adopts pre-existing hooks. Idempotent; safe to call on
|
||||
* every watcher tick where the pipe is live. */
|
||||
onPipeUp(): void {
|
||||
if (this.disposed) {
|
||||
if (this.disposed || this.pipeUpPending || this.cancelConnectAttempt) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Watcher ticks must not queue a backlog of stalled handshakes ahead of
|
||||
// user commands. The next tick can retry once this attempt has settled.
|
||||
this.pipeUpPending = true;
|
||||
void this.serialize(async () => {
|
||||
if (this.disposed) {
|
||||
return;
|
||||
}
|
||||
|
||||
await this.reconcilePipeUp();
|
||||
}).catch((err) =>
|
||||
this.log.warn('onPipeUp failed: PID=%d err=%s', this.pid, errorMessage(err)),
|
||||
);
|
||||
})
|
||||
.catch((err) =>
|
||||
this.log.warn('onPipeUp failed: PID=%d err=%s', this.pid, errorMessage(err)),
|
||||
)
|
||||
.finally(() => {
|
||||
this.pipeUpPending = false;
|
||||
});
|
||||
}
|
||||
|
||||
onPipeDown(): void {
|
||||
@@ -234,6 +256,7 @@ export class HookSession extends EventEmitter {
|
||||
return;
|
||||
}
|
||||
|
||||
this.cancelConnectAttempt?.();
|
||||
void this.serialize(async () => {
|
||||
if (this.disposed) {
|
||||
return;
|
||||
@@ -247,6 +270,7 @@ export class HookSession extends EventEmitter {
|
||||
this.pid,
|
||||
renderParamsVerbose(this.toInfo()),
|
||||
]);
|
||||
this.stopInitialConnectionWatch();
|
||||
this.tearDownClient();
|
||||
this.injected = false;
|
||||
this.injectResult = null;
|
||||
@@ -291,6 +315,7 @@ export class HookSession extends EventEmitter {
|
||||
|
||||
const wasLoggedIn = this.loggedIn;
|
||||
this.disposed = true;
|
||||
this.stopInitialConnectionWatch();
|
||||
this.tearDownClient();
|
||||
|
||||
// Process shutdown must take the same PID-detach path as a live drop.
|
||||
@@ -373,6 +398,10 @@ export class HookSession extends EventEmitter {
|
||||
// ─────────────── internal transitions ───────────────
|
||||
|
||||
private async loadInternal(): Promise<HookProcessInfo> {
|
||||
if (this.disposed) {
|
||||
return this.toInfo();
|
||||
}
|
||||
|
||||
this._error = '';
|
||||
this.setStatus('loading', '');
|
||||
|
||||
@@ -406,6 +435,14 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
}
|
||||
|
||||
if (this.disposed) {
|
||||
return this.toInfo();
|
||||
}
|
||||
|
||||
// A retry reuses the loaded component and its unload handle. Only an
|
||||
// expired deadline is restarted; repeated clicks cannot postpone it.
|
||||
this.initialConnectionError = '';
|
||||
this.startInitialConnectionWatch();
|
||||
this.applyStatus();
|
||||
} catch (error) {
|
||||
this._error = errorMessage(error);
|
||||
@@ -428,6 +465,9 @@ export class HookSession extends EventEmitter {
|
||||
|
||||
private async unloadInternal(): Promise<HookProcessInfo> {
|
||||
this._error = '';
|
||||
this.stopInitialConnectionWatch();
|
||||
this.initialConnectionError = '';
|
||||
this.hasConnected = false;
|
||||
|
||||
try {
|
||||
const wasLoggedIn = this.loggedIn;
|
||||
@@ -500,6 +540,16 @@ export class HookSession extends EventEmitter {
|
||||
* defaults to the current `loggedIn`; callers that just tore the client
|
||||
* down pass the value captured *before* teardown (teardown clears it). */
|
||||
private applyStatus(wasLoggedIn: boolean = this.loggedIn, error = ''): void {
|
||||
if (this.runtimeFailure) {
|
||||
this.setStatus('error', this.runtimeFailure);
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.initialConnectionError) {
|
||||
this.setStatus('error', this.initialConnectionError);
|
||||
return;
|
||||
}
|
||||
|
||||
this.setStatus(
|
||||
statusFor({
|
||||
injected: this.injected,
|
||||
@@ -523,6 +573,8 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
}
|
||||
|
||||
this.startInitialConnectionWatch();
|
||||
|
||||
if (this.client?.isClosed) {
|
||||
this.tearDownClient();
|
||||
}
|
||||
@@ -559,7 +611,7 @@ export class HookSession extends EventEmitter {
|
||||
this.pid,
|
||||
renderParamsVerbose(this.toInfo()),
|
||||
]);
|
||||
this.tearDownClient();
|
||||
this.tearDownClient(true);
|
||||
this.applyStatus(wasLoggedIn);
|
||||
|
||||
try {
|
||||
@@ -607,6 +659,7 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
if (!this.client) {
|
||||
this.runtimeFailure = '';
|
||||
this.client = this.makeClient(this.pid);
|
||||
this.sender = new HookPacketClient(this.client, (healthy) =>
|
||||
this.setOutboundHealthy(healthy),
|
||||
@@ -620,10 +673,26 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
const client = this.client;
|
||||
const watch = this.initialConnectionWatch;
|
||||
const timeoutMs = watch
|
||||
? Math.max(1, INITIAL_CONNECTION_TIMEOUT_MS - (Date.now() - watch.startedAt))
|
||||
: INITIAL_CONNECTION_TIMEOUT_MS;
|
||||
|
||||
try {
|
||||
await client.connectAll({ recv: true });
|
||||
await this.connectWithTimeout(client, timeoutMs);
|
||||
|
||||
if (this.disposed || this.client !== client) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.runtimeFailure) {
|
||||
throw new Error(this.runtimeFailure);
|
||||
}
|
||||
|
||||
this.connected = true;
|
||||
this.hasConnected = true;
|
||||
this.stopInitialConnectionWatch();
|
||||
this.initialConnectionError = '';
|
||||
const loginState = client.getLoginState();
|
||||
|
||||
// handleLoginState owns the connected+loggedIn → 'online' (+ login
|
||||
@@ -647,11 +716,27 @@ export class HookSession extends EventEmitter {
|
||||
Date.now() - startedAt,
|
||||
]);
|
||||
} catch (error) {
|
||||
if (this.disposed || this.client !== client) {
|
||||
return;
|
||||
}
|
||||
|
||||
this._error = errorMessage(error);
|
||||
const wasLoggedIn = this.loggedIn;
|
||||
// Drop the client so the next attempt builds a fresh socket pair.
|
||||
// A failed connect was never logged in → 'connecting' (or 'available').
|
||||
this.tearDownClient();
|
||||
this.applyStatus(false, this._error);
|
||||
this.tearDownClient(true);
|
||||
|
||||
if (watch && Date.now() - watch.startedAt >= INITIAL_CONNECTION_TIMEOUT_MS) {
|
||||
this.expireInitialConnection(watch, 'handshake');
|
||||
}
|
||||
|
||||
this.applyStatus(wasLoggedIn, this._error);
|
||||
|
||||
// Login can arrive on one channel while the other is still
|
||||
// handshaking. Revoke that binding if the full connection fails.
|
||||
if (wasLoggedIn) {
|
||||
this.emit('disconnected', true);
|
||||
}
|
||||
|
||||
this.log.trace(() => [
|
||||
'hook_session_connect_terminal pid=%d outcome=failed reason=connect_failed error=%j state=%s elapsedMs=%d',
|
||||
this.pid,
|
||||
@@ -663,12 +748,118 @@ export class HookSession extends EventEmitter {
|
||||
});
|
||||
}
|
||||
|
||||
private startInitialConnectionWatch(): void {
|
||||
if (
|
||||
this.disposed ||
|
||||
this.hasConnected ||
|
||||
this.initialConnectionWatch ||
|
||||
this.initialConnectionError
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
const watch: InitialConnectionWatch = {
|
||||
startedAt: Date.now(),
|
||||
timer: setTimeout(() => {
|
||||
void this.serialize(async () => this.expireInitialConnection(watch)).catch(
|
||||
(error) =>
|
||||
this.log.error(
|
||||
'initial connection timeout transition failed: PID=%d err=%s',
|
||||
this.pid,
|
||||
errorMessage(error),
|
||||
),
|
||||
);
|
||||
}, INITIAL_CONNECTION_TIMEOUT_MS),
|
||||
};
|
||||
watch.timer.unref();
|
||||
this.initialConnectionWatch = watch;
|
||||
this.log.debug(
|
||||
'initial connection started: PID=%d timeoutMs=%d',
|
||||
this.pid,
|
||||
INITIAL_CONNECTION_TIMEOUT_MS,
|
||||
);
|
||||
}
|
||||
|
||||
private stopInitialConnectionWatch(): void {
|
||||
if (this.initialConnectionWatch) {
|
||||
clearTimeout(this.initialConnectionWatch.timer);
|
||||
this.initialConnectionWatch = null;
|
||||
}
|
||||
}
|
||||
|
||||
private expireInitialConnection(
|
||||
watch: InitialConnectionWatch,
|
||||
phase: 'waiting_channel' | 'handshake' = 'waiting_channel',
|
||||
): void {
|
||||
if (this.disposed || this.connected || this.initialConnectionWatch !== watch) {
|
||||
return;
|
||||
}
|
||||
|
||||
const previousError = this._error;
|
||||
this.stopInitialConnectionWatch();
|
||||
this.initialConnectionError =
|
||||
'首次连接超时(60 秒):组件已加载,但通信通道尚未就绪,可重试连接或卸载组件';
|
||||
this.log.error(
|
||||
'initial connection timed out: PID=%d phase=%s timeoutMs=%d elapsedMs=%d previousError=%j',
|
||||
this.pid,
|
||||
phase,
|
||||
INITIAL_CONNECTION_TIMEOUT_MS,
|
||||
Date.now() - watch.startedAt,
|
||||
previousError,
|
||||
);
|
||||
this.applyStatus();
|
||||
}
|
||||
|
||||
private async connectWithTimeout(client: QqHookClient, timeoutMs: number): Promise<void> {
|
||||
let cancel!: () => void;
|
||||
let timer!: ReturnType<typeof setTimeout>;
|
||||
const deadline = new Promise<never>((_, reject) => {
|
||||
cancel = () => reject(new Error('Connection attempt cancelled'));
|
||||
timer = setTimeout(
|
||||
() => reject(new Error(`Connection handshake timed out after ${timeoutMs} ms`)),
|
||||
timeoutMs,
|
||||
);
|
||||
timer.unref();
|
||||
});
|
||||
this.cancelConnectAttempt = cancel;
|
||||
|
||||
try {
|
||||
// A stalled handshake must release the serialized operation queue so
|
||||
// timeout handling and unload can run. Late completion has no effects.
|
||||
await Promise.race([client.connectAll({ recv: true }), deadline]);
|
||||
} finally {
|
||||
clearTimeout(timer);
|
||||
|
||||
if (this.cancelConnectAttempt === cancel) {
|
||||
this.cancelConnectAttempt = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private bindClient(client: QqHookClient): void {
|
||||
client.on('runtimeError', (error) => {
|
||||
if (this.client !== client || this.disposed) {
|
||||
return;
|
||||
}
|
||||
|
||||
const wasLoggedIn = this.loggedIn;
|
||||
this.runtimeFailure = errorMessage(error);
|
||||
this.stopInitialConnectionWatch();
|
||||
this.loggedIn = false;
|
||||
this.stopLoginReconcile();
|
||||
this.resetReceiveWatch();
|
||||
this.applyStatus(wasLoggedIn);
|
||||
this.log.error('QQ runtime unavailable: PID=%d err=%s', this.pid, this.runtimeFailure);
|
||||
|
||||
if (wasLoggedIn) {
|
||||
this.emit('disconnected', true);
|
||||
}
|
||||
});
|
||||
client.on('packet', (packet) => this.handlePacket(packet));
|
||||
client.on('loginState', (state) => this.handleLoginState(state));
|
||||
client.on('error', (error) => {
|
||||
const msg = errorMessage(error);
|
||||
this._error = msg;
|
||||
this._error = this.runtimeFailure || this.initialConnectionError || msg;
|
||||
this.log.warn('pipe error: PID=%d err=%s', this.pid, msg);
|
||||
});
|
||||
client.on('close', () => {
|
||||
@@ -698,7 +889,8 @@ export class HookSession extends EventEmitter {
|
||||
});
|
||||
}
|
||||
|
||||
private tearDownClient(): void {
|
||||
private tearDownClient(preserveRuntimeFailure = false): void {
|
||||
this.cancelConnectAttempt?.();
|
||||
this.stopLoginReconcile();
|
||||
this.resetReceiveWatch();
|
||||
const client = this.client;
|
||||
@@ -714,6 +906,11 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
this.client = null;
|
||||
|
||||
if (!preserveRuntimeFailure) {
|
||||
this.runtimeFailure = '';
|
||||
}
|
||||
|
||||
this.sender = null;
|
||||
this.bound = false;
|
||||
this.connected = false;
|
||||
@@ -723,6 +920,10 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
private handleLoginState(state: QqHookLoginState): void {
|
||||
if (this.runtimeFailure) {
|
||||
return;
|
||||
}
|
||||
|
||||
const wasLoggedIn = this.loggedIn;
|
||||
const previousUin = this._uin;
|
||||
this._uin = state.uin || state.uinNumber.toString();
|
||||
@@ -800,7 +1001,7 @@ export class HookSession extends EventEmitter {
|
||||
// reconciliation, but never synthesize online state from the detection.
|
||||
|
||||
private startLoginReconcile(): void {
|
||||
if (this.loginReconcileTimer || this.disposed) {
|
||||
if (this.loginReconcileTimer || this.disposed || this.runtimeFailure) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -829,7 +1030,7 @@ export class HookSession extends EventEmitter {
|
||||
|
||||
const client = this.client;
|
||||
|
||||
if (this.disposed || !client || !this.connected || this.loggedIn) {
|
||||
if (this.disposed || !client || !this.connected || this.loggedIn || this.runtimeFailure) {
|
||||
this.stopLoginReconcile();
|
||||
return;
|
||||
}
|
||||
@@ -861,7 +1062,13 @@ export class HookSession extends EventEmitter {
|
||||
}
|
||||
|
||||
// A reconnect owns a new client; an older read cannot supply its identity.
|
||||
if (this.client !== client || this.disposed || !this.connected || this.loggedIn) {
|
||||
if (
|
||||
this.client !== client ||
|
||||
this.disposed ||
|
||||
!this.connected ||
|
||||
this.loggedIn ||
|
||||
this.runtimeFailure
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -902,7 +1109,8 @@ export class HookSession extends EventEmitter {
|
||||
this.client !== client ||
|
||||
this.disposed ||
|
||||
!this.connected ||
|
||||
this.loggedIn
|
||||
this.loggedIn ||
|
||||
this.runtimeFailure
|
||||
) {
|
||||
return;
|
||||
}
|
||||
@@ -911,7 +1119,7 @@ export class HookSession extends EventEmitter {
|
||||
this.nextLoginIdentityObservationAt =
|
||||
Date.now() + LOGIN_IDENTITY_OBSERVE_INTERVAL_MS;
|
||||
} catch (error) {
|
||||
if (this.client !== client || this.disposed) {
|
||||
if (this.client !== client || this.disposed || this.runtimeFailure) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -957,6 +1165,17 @@ export class HookSession extends EventEmitter {
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
packet.source === 'client-message' &&
|
||||
(!isRealUin(packet.uin) || packet.uin !== this._uin)
|
||||
) {
|
||||
this.log.warn(
|
||||
'Client message receipt belongs to an inactive account: PID=%d',
|
||||
this.pid,
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
const uin = packet.uin || this._uin;
|
||||
// Routing requires a real UIN, but even a frame carrying UIN=0 proves the
|
||||
// receive hook is alive. Attribute that evidence to the current epoch
|
||||
@@ -986,6 +1205,7 @@ export class HookSession extends EventEmitter {
|
||||
seqId: packet.seq,
|
||||
retCode: packet.error,
|
||||
fromClient: false,
|
||||
...(packet.source ? { source: packet.source } : {}),
|
||||
body: Buffer.from(packet.body),
|
||||
});
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ export {
|
||||
type LoginDbFailure,
|
||||
} from './login-db';
|
||||
export { accountDirName, loginDbPaths, ntMsgDbPath, qqDataRoots, qqDataRootsForPid } from './paths';
|
||||
export { watchAccountChangesForPids } from './watch';
|
||||
export {
|
||||
decryptDatabase,
|
||||
detectAlgorithm,
|
||||
|
||||
115
packages/bridge/src/qq-account/watch.ts
Normal file
115
packages/bridge/src/qq-account/watch.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import { errorMessage } from '@snowluma/common/errors';
|
||||
import { createLogger, type Logger } from '@snowluma/common/logger';
|
||||
import { watch, type FSWatcher } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { loginDbPaths, qqDataRootsForPid } from './paths';
|
||||
|
||||
export function watchAccountChangesForPids(
|
||||
pids: readonly number[],
|
||||
onChange: () => void,
|
||||
log: Logger = createLogger('QqAccount'),
|
||||
): () => void {
|
||||
const roots = new Set<string>();
|
||||
|
||||
for (const pid of pids) {
|
||||
try {
|
||||
for (const root of qqDataRootsForPid(pid)) {
|
||||
roots.add(root);
|
||||
}
|
||||
} catch (error) {
|
||||
log.warn('account watch root failed: PID=%d err=%s', pid, errorMessage(error));
|
||||
}
|
||||
}
|
||||
|
||||
return watchAccountFiles([...roots].flatMap(loginDbPaths), onChange, log);
|
||||
}
|
||||
|
||||
/** Watch directories so replacing login.db or recreating its WAL keeps working. */
|
||||
export function watchAccountFiles(
|
||||
dbPaths: readonly string[],
|
||||
onChange: () => void,
|
||||
log: Logger = createLogger('QqAccount'),
|
||||
): () => void {
|
||||
const watchers = new Map<string, FSWatcher>();
|
||||
let timer: NodeJS.Timeout | undefined;
|
||||
|
||||
const changed = () => {
|
||||
clearTimeout(timer);
|
||||
timer = setTimeout(() => {
|
||||
timer = undefined;
|
||||
onChange();
|
||||
}, 250);
|
||||
timer.unref();
|
||||
};
|
||||
|
||||
const observe = (dbPath: string) => {
|
||||
watchers.get(dbPath)?.close();
|
||||
watchers.delete(dbPath);
|
||||
const dbDirectory = path.dirname(dbPath);
|
||||
let directory = dbDirectory;
|
||||
|
||||
for (;;) {
|
||||
const target = path.relative(directory, dbPath).split(path.sep)[0]!;
|
||||
|
||||
try {
|
||||
const watcher = watch(directory, { persistent: false }, (_event, filename) => {
|
||||
if (
|
||||
watchers.get(dbPath) !== watcher ||
|
||||
(filename !== null &&
|
||||
filename !== target &&
|
||||
!(directory === dbDirectory && filename === `${target}-wal`))
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
// QQ may create its data directories after process discovery.
|
||||
if (directory !== dbDirectory) {
|
||||
observe(dbPath);
|
||||
}
|
||||
|
||||
changed();
|
||||
});
|
||||
watcher.on('error', (error) => {
|
||||
if (watchers.get(dbPath) !== watcher) {
|
||||
return;
|
||||
}
|
||||
|
||||
watcher.close();
|
||||
watchers.delete(dbPath);
|
||||
log.warn('account watch failed: path=%s err=%s', dbPath, errorMessage(error));
|
||||
});
|
||||
watchers.set(dbPath, watcher);
|
||||
return;
|
||||
} catch (error) {
|
||||
const parent = path.dirname(directory);
|
||||
|
||||
if (
|
||||
error instanceof Error &&
|
||||
'code' in error &&
|
||||
error.code === 'ENOENT' &&
|
||||
parent !== directory
|
||||
) {
|
||||
directory = parent;
|
||||
continue;
|
||||
}
|
||||
|
||||
log.warn('account watch failed: path=%s err=%s', dbPath, errorMessage(error));
|
||||
return;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
for (const dbPath of new Set(dbPaths)) {
|
||||
observe(dbPath);
|
||||
}
|
||||
|
||||
return () => {
|
||||
clearTimeout(timer);
|
||||
|
||||
for (const watcher of watchers.values()) {
|
||||
watcher.close();
|
||||
}
|
||||
|
||||
watchers.clear();
|
||||
};
|
||||
}
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
} from '@snowluma/common/logger';
|
||||
import { renderParamsVerbose } from '@snowluma/common/log-summary';
|
||||
import { isRealUin } from '@snowluma/common/uin';
|
||||
import { CLIENT_MESSAGE_RECEIPT_CMD } from '@snowluma/common/protocol-types';
|
||||
import { readdirSync, promises as fs } from 'fs';
|
||||
import net from 'net';
|
||||
import path from 'path';
|
||||
@@ -38,6 +39,8 @@ export enum PipeOp {
|
||||
recvPacket = 6,
|
||||
loginState = 7,
|
||||
loginIdentityHint = 17,
|
||||
clientMessageReceipt = 21,
|
||||
clientMessageState = 22,
|
||||
}
|
||||
|
||||
const PipeFlagWantReply = 1 << 0;
|
||||
@@ -55,6 +58,7 @@ export interface QqHookPacket {
|
||||
cmd: string;
|
||||
uin: string;
|
||||
body: Buffer;
|
||||
source?: 'client-message';
|
||||
}
|
||||
|
||||
export interface QqHookHello {
|
||||
@@ -541,6 +545,7 @@ class FrameReader {
|
||||
}
|
||||
|
||||
export class QqHookClient extends EventEmitter {
|
||||
private readonly connectingSockets = new Set<net.Socket>();
|
||||
readonly pid: number;
|
||||
readonly runtimeDir: string;
|
||||
readonly defaultAckTimeoutMs: number;
|
||||
@@ -559,6 +564,7 @@ export class QqHookClient extends EventEmitter {
|
||||
private recvHelloResolver: Deferred<QqHookHello> | null = null;
|
||||
private controlWriteChain: Promise<unknown> = Promise.resolve();
|
||||
private closed = false;
|
||||
private runtimeFailure: Error | null = null;
|
||||
private loginState: QqHookLoginState = { loggedIn: false, uin: '0', uinNumber: 0n };
|
||||
private readonly loginWaiters = new Set<Deferred<QqHookLoginState>>();
|
||||
|
||||
@@ -611,10 +617,7 @@ export class QqHookClient extends EventEmitter {
|
||||
|
||||
async waitForLogin({ timeoutMs = 0 } = {}): Promise<QqHookLoginState> {
|
||||
await this.connect();
|
||||
|
||||
if (this.closed) {
|
||||
throw new Error('qq_hook client is closed');
|
||||
}
|
||||
this.assertUsable();
|
||||
|
||||
if (this.loginState.loggedIn) {
|
||||
return this.getLoginState();
|
||||
@@ -688,9 +691,7 @@ export class QqHookClient extends EventEmitter {
|
||||
}
|
||||
|
||||
async connect(): Promise<QqHookHello> {
|
||||
if (this.closed) {
|
||||
throw new Error('qq_hook client is closed');
|
||||
}
|
||||
this.assertUsable();
|
||||
|
||||
if (this.controlSocket && this.controlHello) {
|
||||
return this.controlHello;
|
||||
@@ -710,9 +711,7 @@ export class QqHookClient extends EventEmitter {
|
||||
}
|
||||
|
||||
async startRecv(onPacket?: (packet: QqHookPacket) => void): Promise<QqHookHello> {
|
||||
if (this.closed) {
|
||||
throw new Error('qq_hook client is closed');
|
||||
}
|
||||
this.assertUsable();
|
||||
|
||||
if (typeof onPacket === 'function') {
|
||||
this.on('packet', onPacket);
|
||||
@@ -977,6 +976,12 @@ export class QqHookClient extends EventEmitter {
|
||||
this.rejectRecvPending(new Error('qq_hook client closed'));
|
||||
this.rejectLoginWaiters(new Error('qq_hook client closed'));
|
||||
|
||||
for (const socket of this.connectingSockets) {
|
||||
socket.destroy();
|
||||
}
|
||||
|
||||
this.connectingSockets.clear();
|
||||
|
||||
if (this.controlSocket) {
|
||||
this.controlSocket.destroy();
|
||||
this.controlSocket = null;
|
||||
@@ -992,6 +997,16 @@ export class QqHookClient extends EventEmitter {
|
||||
this.controlWriteChain = Promise.resolve();
|
||||
}
|
||||
|
||||
private assertUsable(): void {
|
||||
if (this.runtimeFailure) {
|
||||
throw this.runtimeFailure;
|
||||
}
|
||||
|
||||
if (this.closed) {
|
||||
throw new Error('qq_hook client is closed');
|
||||
}
|
||||
}
|
||||
|
||||
private rejectLoginWaiters(error: Error): void {
|
||||
for (const waiter of this.loginWaiters) {
|
||||
waiter.reject(error);
|
||||
@@ -1029,26 +1044,28 @@ export class QqHookClient extends EventEmitter {
|
||||
const socket = this.controlSocket;
|
||||
|
||||
if (!socket || socket.destroyed) {
|
||||
return Promise.reject(new Error('control pipe is not connected'));
|
||||
return Promise.reject(
|
||||
this.runtimeFailure ?? new Error('control pipe is not connected'),
|
||||
);
|
||||
}
|
||||
|
||||
const writePromise = this.controlWriteChain.then(
|
||||
() =>
|
||||
new Promise<void>((resolve, reject) => {
|
||||
if (!this.controlSocket || this.controlSocket.destroyed) {
|
||||
reject(new Error('control pipe is not connected'));
|
||||
return;
|
||||
}
|
||||
const writePromise = this.controlWriteChain.then(() => {
|
||||
this.assertUsable();
|
||||
|
||||
socket.write(payload, (error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
}),
|
||||
);
|
||||
if (this.controlSocket !== socket || socket.destroyed) {
|
||||
throw new Error('control pipe is not connected');
|
||||
}
|
||||
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
socket.write(payload, (error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
this.controlWriteChain = writePromise.catch(() => {});
|
||||
return writePromise;
|
||||
}
|
||||
@@ -1128,6 +1145,11 @@ export class QqHookClient extends EventEmitter {
|
||||
),
|
||||
);
|
||||
|
||||
if (this.closed || this.runtimeFailure) {
|
||||
socket.destroy();
|
||||
this.assertUsable();
|
||||
}
|
||||
|
||||
if (kind === 'control') {
|
||||
this.controlSocket = socket;
|
||||
} else {
|
||||
@@ -1142,6 +1164,8 @@ export class QqHookClient extends EventEmitter {
|
||||
phase = 'hello';
|
||||
const hello = await this.waitForHello(kind === 'recv');
|
||||
|
||||
this.assertUsable();
|
||||
|
||||
if (kind === 'control') {
|
||||
this.controlHello = hello;
|
||||
} else {
|
||||
@@ -1177,10 +1201,19 @@ export class QqHookClient extends EventEmitter {
|
||||
): Promise<net.Socket> {
|
||||
return new Promise((resolve, reject) => {
|
||||
const socket = net.createConnection(pipeName);
|
||||
this.connectingSockets.add(socket);
|
||||
const reader = new FrameReader(onFrame);
|
||||
const onInitialError = (error: Error) => reject(error);
|
||||
socket.once('error', onInitialError);
|
||||
socket.once('connect', () => {
|
||||
|
||||
const onInitialClose = () => {
|
||||
this.connectingSockets.delete(socket);
|
||||
socket.off('connect', onConnect);
|
||||
reject(new Error(`${kind} pipe closed before connecting`));
|
||||
};
|
||||
|
||||
const onConnect = () => {
|
||||
this.connectingSockets.delete(socket);
|
||||
socket.off('close', onInitialClose);
|
||||
socket.off('error', onInitialError);
|
||||
socket.on('data', (chunk) => {
|
||||
try {
|
||||
@@ -1200,7 +1233,11 @@ export class QqHookClient extends EventEmitter {
|
||||
});
|
||||
});
|
||||
resolve(socket);
|
||||
});
|
||||
};
|
||||
|
||||
socket.once('error', onInitialError);
|
||||
socket.once('close', onInitialClose);
|
||||
socket.once('connect', onConnect);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -1297,6 +1334,10 @@ export class QqHookClient extends EventEmitter {
|
||||
}
|
||||
|
||||
private handleControlFrame(frame: PipeFrame): void {
|
||||
if (this.runtimeFailure) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (frame.op === PipeOp.hello) {
|
||||
this.resolveHello(frame, false);
|
||||
return;
|
||||
@@ -1342,6 +1383,16 @@ export class QqHookClient extends EventEmitter {
|
||||
frame.status,
|
||||
frame.requestId,
|
||||
);
|
||||
|
||||
if (frame.requestId === 0 && frame.cmd === 'runtime') {
|
||||
this.runtimeFailure = error;
|
||||
this.rejectControlPending(error);
|
||||
this.rejectRecvPending(error);
|
||||
this.rejectLoginWaiters(error);
|
||||
this.emit('runtimeError', error);
|
||||
return;
|
||||
}
|
||||
|
||||
const ack = this.pendingAcks.get(frame.requestId);
|
||||
|
||||
if (ack) {
|
||||
@@ -1359,6 +1410,10 @@ export class QqHookClient extends EventEmitter {
|
||||
}
|
||||
|
||||
private handleRecvFrame(frame: PipeFrame): void {
|
||||
if (this.runtimeFailure) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (frame.op === PipeOp.hello) {
|
||||
this.resolveHello(frame, true);
|
||||
return;
|
||||
@@ -1369,6 +1424,45 @@ export class QqHookClient extends EventEmitter {
|
||||
return;
|
||||
}
|
||||
|
||||
if (frame.op === PipeOp.clientMessageState) {
|
||||
if (frame.status === 1) {
|
||||
runtimeLog.debug('Client private-message reporting is available: PID=%d', this.pid);
|
||||
} else {
|
||||
runtimeLog.warn(
|
||||
'Client private-message reporting is unavailable: PID=%d status=%d%s',
|
||||
this.pid,
|
||||
frame.status,
|
||||
frame.value0 === 0n ? '' : ` reason=${frame.value0}`,
|
||||
);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (frame.op === PipeOp.clientMessageReceipt) {
|
||||
if (
|
||||
frame.cmd !== '' ||
|
||||
frame.requestId !== 0 ||
|
||||
frame.flags !== 0 ||
|
||||
frame.value0 <= 0n ||
|
||||
frame.value0 > BigInt(Number.MAX_SAFE_INTEGER) ||
|
||||
!isRealUin(frame.msg)
|
||||
) {
|
||||
runtimeLog.warn('Invalid client message receipt: PID=%d', this.pid);
|
||||
return;
|
||||
}
|
||||
|
||||
this.emit('packet', {
|
||||
seq: Number(frame.value0),
|
||||
error: frame.status,
|
||||
cmd: CLIENT_MESSAGE_RECEIPT_CMD,
|
||||
uin: frame.msg,
|
||||
body: Buffer.from(frame.body),
|
||||
source: 'client-message',
|
||||
} satisfies QqHookPacket);
|
||||
return;
|
||||
}
|
||||
|
||||
if (frame.op !== PipeOp.recvPacket) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -24,6 +24,8 @@ interface Harness {
|
||||
setLivePipes: (next: number[]) => void;
|
||||
onSessionsChanged: ReturnType<typeof vi.fn>;
|
||||
clientFactory: ReturnType<typeof vi.fn>;
|
||||
notifyAccountChange: () => void;
|
||||
watchAccounts: ReturnType<typeof vi.fn>;
|
||||
}
|
||||
|
||||
function makeManager(
|
||||
@@ -31,7 +33,6 @@ function makeManager(
|
||||
processes?: number[];
|
||||
livePipes?: number[];
|
||||
detectAccounts?: (pids: readonly number[]) => Promise<AccountLoginState[]>;
|
||||
accountReprobeIntervalMs?: number;
|
||||
} = {},
|
||||
): Harness {
|
||||
let pids = opts.processes ?? [];
|
||||
@@ -64,6 +65,13 @@ function makeManager(
|
||||
onPidReceiveHealthChanged: vi.fn(),
|
||||
} as unknown as BridgeManagerSink & { onPidReceiveHealthChanged: ReturnType<typeof vi.fn> };
|
||||
const onSessionsChanged = vi.fn();
|
||||
|
||||
let accountChanged = () => {};
|
||||
|
||||
const watchAccounts = vi.fn((_pids: readonly number[], onChange: () => void) => {
|
||||
accountChanged = onChange;
|
||||
return vi.fn();
|
||||
});
|
||||
const manager = new HookManager({
|
||||
bridgeManager,
|
||||
pipeWatcher,
|
||||
@@ -77,7 +85,7 @@ function makeManager(
|
||||
makeClient: clientFactory,
|
||||
listProcesses: async () => pids.map((pid) => ({ pid, name: 'qq', path: '' })),
|
||||
detectAccounts: opts.detectAccounts ?? (async () => []),
|
||||
accountReprobeIntervalMs: opts.accountReprobeIntervalMs,
|
||||
watchAccounts,
|
||||
onSessionsChanged,
|
||||
});
|
||||
return {
|
||||
@@ -86,6 +94,8 @@ function makeManager(
|
||||
bridgeManager,
|
||||
onSessionsChanged,
|
||||
clientFactory,
|
||||
notifyAccountChange: () => accountChanged(),
|
||||
watchAccounts,
|
||||
setProcesses: (next) => {
|
||||
pids = next;
|
||||
},
|
||||
@@ -142,6 +152,43 @@ describe('HookManager.onSessionsChanged', () => {
|
||||
ctx.manager.dispose();
|
||||
});
|
||||
|
||||
it('publishes an initial timeout and automatically recovers when the channel arrives late', async () => {
|
||||
vi.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout', 'Date'] });
|
||||
const ctx = makeManager({ processes: [4242] });
|
||||
|
||||
try {
|
||||
await ctx.manager.loadProcess(4242);
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
await vi.advanceTimersByTimeAsync(60_000);
|
||||
expect(ctx.onSessionsChanged).toHaveBeenCalled();
|
||||
expect(await ctx.manager.listProcesses()).toEqual([
|
||||
expect.objectContaining({
|
||||
pid: 4242,
|
||||
status: 'error',
|
||||
injected: true,
|
||||
error: expect.stringContaining('首次连接超时'),
|
||||
}),
|
||||
]);
|
||||
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
ctx.setLivePipes([4242]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await flush();
|
||||
expect(ctx.onSessionsChanged).toHaveBeenCalled();
|
||||
expect(await ctx.manager.listProcesses()).toEqual([
|
||||
expect.objectContaining({
|
||||
pid: 4242,
|
||||
status: 'loaded',
|
||||
connected: true,
|
||||
error: '',
|
||||
}),
|
||||
]);
|
||||
} finally {
|
||||
ctx.manager.dispose();
|
||||
vi.useRealTimers();
|
||||
}
|
||||
});
|
||||
|
||||
it('survives a throwing onSessionsChanged callback — the watcher loop keeps running', async () => {
|
||||
const ctx = makeManager({ processes: [] });
|
||||
ctx.onSessionsChanged.mockImplementation(() => {
|
||||
@@ -198,6 +245,7 @@ describe('HookManager.onSessionsChanged', () => {
|
||||
}),
|
||||
listProcesses: async () => pids.map((pid) => ({ pid, name: 'qq', path: '' })),
|
||||
detectAccounts: async () => [],
|
||||
watchAccounts: () => () => {},
|
||||
// onSessionsChanged deliberately omitted
|
||||
});
|
||||
await pipeWatcher.start();
|
||||
@@ -210,7 +258,111 @@ describe('HookManager.onSessionsChanged', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('HookManager periodic account re-probe', () => {
|
||||
describe('HookManager account re-probe', () => {
|
||||
it('reuses the account snapshot across ticks and REST reads while all sessions are online (#549)', async () => {
|
||||
const detectAccounts = vi.fn(async (): Promise<AccountLoginState[]> => [
|
||||
{ uin: '10001', uid: 'u_a', nickname: 'Alice', pid: 4242 },
|
||||
{ uin: '10002', uid: 'u_b', nickname: 'Bob', pid: 5151 },
|
||||
]);
|
||||
const ctx = makeManager({
|
||||
processes: [4242, 5151],
|
||||
livePipes: [4242, 5151],
|
||||
detectAccounts,
|
||||
});
|
||||
const now = vi.spyOn(Date, 'now');
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
|
||||
for (const [index, uin] of ['10001', '10002'].entries()) {
|
||||
const client = ctx.clientFactory.mock.results[index]!.value as EventEmitter;
|
||||
client.emit('loginState', { loggedIn: true, uin, uinNumber: BigInt(uin) });
|
||||
}
|
||||
|
||||
const initial = await ctx.manager.listProcesses();
|
||||
expect(initial.map((info) => info.status)).toEqual(['online', 'online']);
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
const startedAt = Date.now();
|
||||
|
||||
for (let tick = 1; tick <= 10; tick++) {
|
||||
now.mockReturnValue(startedAt + tick * 6000);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
expect(await ctx.manager.listProcesses()).toEqual(initial);
|
||||
}
|
||||
|
||||
expect(detectAccounts).toHaveBeenCalledTimes(baseline);
|
||||
expect(ctx.onSessionsChanged).not.toHaveBeenCalled();
|
||||
} finally {
|
||||
now.mockRestore();
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it.each(['loadProcess', 'unloadProcess', 'refreshProcess'] as const)(
|
||||
'refreshes account labels on %s even within the probe interval',
|
||||
async (operation) => {
|
||||
let nickname = 'Alice';
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
detectAccounts: async () => [{ uin: '10001', uid: 'u_a', nickname, pid: 4242 }],
|
||||
});
|
||||
|
||||
try {
|
||||
expect((await ctx.manager.listProcesses())[0]!.account?.nickname).toBe('Alice');
|
||||
nickname = 'Updated';
|
||||
expect((await ctx.manager[operation](4242)).account?.nickname).toBe('Updated');
|
||||
} finally {
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
it('discards an in-flight account result when an online process switches accounts', async () => {
|
||||
const stale = Promise.withResolvers<AccountLoginState[]>();
|
||||
const fresh = Promise.withResolvers<AccountLoginState[]>();
|
||||
const detectAccounts = vi.fn(async (): Promise<AccountLoginState[]> => [
|
||||
{ uin: '10001', uid: 'u_a', nickname: 'Alice', pid: 4242 },
|
||||
]);
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
livePipes: [4242],
|
||||
detectAccounts,
|
||||
});
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
const client = ctx.clientFactory.mock.results[0]!.value as EventEmitter;
|
||||
client.emit('loginState', { loggedIn: true, uin: '10001', uinNumber: 10001n });
|
||||
await ctx.manager.listProcesses();
|
||||
detectAccounts.mockImplementationOnce(() => stale.promise);
|
||||
detectAccounts.mockImplementationOnce(() => fresh.promise);
|
||||
const refreshing = ctx.manager.refreshProcess(4242);
|
||||
await flush();
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
client.emit('loginState', { loggedIn: true, uin: '10002', uinNumber: 10002n });
|
||||
const snapshot = ctx.manager.listProcesses();
|
||||
await flush();
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
stale.resolve([{ uin: '10003', uid: 'u_c', nickname: 'Stale', pid: 4242 }]);
|
||||
await flush();
|
||||
expect(ctx.onSessionsChanged).not.toHaveBeenCalled();
|
||||
expect(detectAccounts).toHaveBeenCalledTimes(baseline + 1);
|
||||
fresh.resolve([{ uin: '10002', uid: 'u_b', nickname: 'Bob', pid: 4242 }]);
|
||||
expect((await snapshot)[0]!.account).toEqual({ uin: '10002', nickname: 'Bob' });
|
||||
expect((await refreshing).account).toEqual({ uin: '10002', nickname: 'Bob' });
|
||||
} finally {
|
||||
stale.resolve([]);
|
||||
fresh.resolve([]);
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it('shares one account probe between watcher ticks and concurrent snapshots', async () => {
|
||||
const probe = Promise.withResolvers<AccountLoginState[]>();
|
||||
const detectAccounts = vi.fn(() => probe.promise);
|
||||
@@ -234,6 +386,86 @@ describe('HookManager periodic account re-probe', () => {
|
||||
}
|
||||
});
|
||||
|
||||
it.each(['pipe-down', 'client-close', 'logout'] as const)(
|
||||
're-probes after %s and observes later login data changes',
|
||||
async (event) => {
|
||||
let accounts: AccountLoginState[] = [
|
||||
{ uin: '10001', uid: 'u_a', nickname: 'Alice', pid: 4242 },
|
||||
];
|
||||
const detectAccounts = vi.fn(async () => accounts);
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
livePipes: [4242],
|
||||
detectAccounts,
|
||||
});
|
||||
const now = vi.spyOn(Date, 'now');
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
const client = ctx.clientFactory.mock.results[0]!.value as EventEmitter;
|
||||
client.emit('loginState', { loggedIn: true, uin: '10001', uinNumber: 10001n });
|
||||
await ctx.manager.listProcesses();
|
||||
accounts = [];
|
||||
|
||||
if (event === 'pipe-down') {
|
||||
ctx.setLivePipes([]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
} else if (event === 'client-close') {
|
||||
client.emit('close');
|
||||
} else {
|
||||
client.emit('loginState', { loggedIn: false, uin: '0', uinNumber: 0n });
|
||||
}
|
||||
|
||||
await flush();
|
||||
expect((await ctx.manager.listProcesses())[0]!.account).toBeNull();
|
||||
accounts = [{ uin: '10002', uid: 'u_b', nickname: 'Bob', pid: 4242 }];
|
||||
now.mockReturnValue(Date.now() + 6000);
|
||||
ctx.notifyAccountChange();
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
expect((await ctx.manager.listProcesses())[0]!.account?.uin).toBe('10002');
|
||||
} finally {
|
||||
now.mockRestore();
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
it('re-probes when another process appears and when it exits', async () => {
|
||||
let nickname = 'Alice';
|
||||
const detectAccounts = vi.fn(async (): Promise<AccountLoginState[]> => [
|
||||
{ uin: '10001', uid: 'u_a', nickname, pid: 4242 },
|
||||
{ uin: '10002', uid: 'u_b', nickname: 'Bob', pid: 5151 },
|
||||
]);
|
||||
const ctx = makeManager({ processes: [4242], livePipes: [4242], detectAccounts });
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
const client = ctx.clientFactory.mock.results[0]!.value as EventEmitter;
|
||||
client.emit('loginState', { loggedIn: true, uin: '10001', uinNumber: 10001n });
|
||||
await ctx.manager.listProcesses();
|
||||
nickname = 'Updated';
|
||||
ctx.setProcesses([4242, 5151]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
expect((await ctx.manager.listProcesses()).map((info) => info.account)).toEqual([
|
||||
{ uin: '10001', nickname: 'Updated' },
|
||||
{ uin: '10002', nickname: 'Bob' },
|
||||
]);
|
||||
nickname = 'Final';
|
||||
ctx.setProcesses([4242]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await flush();
|
||||
const list = await ctx.manager.listProcesses();
|
||||
expect(list).toHaveLength(1);
|
||||
expect(list[0]!.account?.nickname).toBe('Final');
|
||||
} finally {
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it('keeps all process labels when an operation reads just one process', async () => {
|
||||
const accounts: AccountLoginState[] = [
|
||||
{ uin: '10001', uid: 'u_a', nickname: 'Alice', pid: 4242 },
|
||||
@@ -246,8 +478,8 @@ describe('HookManager periodic account re-probe', () => {
|
||||
|
||||
try {
|
||||
await ctx.manager.listProcesses();
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
expect((await ctx.manager.refreshProcess(4242)).account?.uin).toBe('10001');
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await flush();
|
||||
@@ -282,17 +514,13 @@ describe('HookManager periodic account re-probe', () => {
|
||||
}
|
||||
});
|
||||
|
||||
// A login can happen with no hook edge at all (QQ signs in after SnowLuma
|
||||
// started, or before the hook was injected), so no session status changes
|
||||
// and nothing pushes a fresh processes snapshot. These cover the watcher
|
||||
// pass that re-reads the account labels and invalidates when they move.
|
||||
// Login database changes can reveal login before the hook is loaded.
|
||||
|
||||
it('publishes when a process gains an account label', async () => {
|
||||
let accounts: AccountLoginState[] = [{ uin: '1', uid: 'u1', nickname: 'A', pid: null }];
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
detectAccounts: async () => accounts,
|
||||
accountReprobeIntervalMs: 0,
|
||||
});
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
@@ -300,7 +528,7 @@ describe('HookManager periodic account re-probe', () => {
|
||||
|
||||
// QQ finished signing in: the account's nt_msg.db is now held by 4242.
|
||||
accounts = [{ uin: '1', uid: 'u1', nickname: 'A', pid: 4242 }];
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
ctx.notifyAccountChange();
|
||||
await flush();
|
||||
await flush();
|
||||
|
||||
@@ -317,14 +545,12 @@ describe('HookManager periodic account re-probe', () => {
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
detectAccounts,
|
||||
accountReprobeIntervalMs: 0,
|
||||
});
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
ctx.onSessionsChanged.mockClear();
|
||||
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
ctx.notifyAccountChange();
|
||||
await flush();
|
||||
await flush();
|
||||
|
||||
@@ -340,7 +566,6 @@ describe('HookManager periodic account re-probe', () => {
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
detectAccounts: async () => accounts,
|
||||
accountReprobeIntervalMs: 0,
|
||||
});
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
@@ -352,7 +577,7 @@ describe('HookManager periodic account re-probe', () => {
|
||||
{ uin: '1', uid: 'u1', nickname: 'A', pid: null },
|
||||
{ uin: '2', uid: 'u2', nickname: 'B', pid: null },
|
||||
];
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
ctx.notifyAccountChange();
|
||||
await flush();
|
||||
await flush();
|
||||
|
||||
@@ -361,24 +586,89 @@ describe('HookManager periodic account re-probe', () => {
|
||||
ctx.manager.dispose();
|
||||
});
|
||||
|
||||
it('throttles the probe to the configured interval', async () => {
|
||||
it('does not poll unlabelled, unloaded processes even after the old interval expires', async () => {
|
||||
const detectAccounts = vi.fn(async () => [] as AccountLoginState[]);
|
||||
const ctx = makeManager({
|
||||
processes: [4242],
|
||||
detectAccounts,
|
||||
accountReprobeIntervalMs: 60_000,
|
||||
});
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
const now = vi.spyOn(Date, 'now');
|
||||
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await flush();
|
||||
try {
|
||||
await ctx.manager.listProcesses();
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
const startedAt = Date.now();
|
||||
|
||||
expect(detectAccounts.mock.calls.length).toBe(baseline);
|
||||
for (let tick = 1; tick <= 10; tick++) {
|
||||
now.mockReturnValue(startedAt + tick * 6000);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
expect((await ctx.manager.listProcesses())[0]!.account).toBeNull();
|
||||
}
|
||||
|
||||
ctx.manager.dispose();
|
||||
expect(detectAccounts).toHaveBeenCalledTimes(baseline);
|
||||
} finally {
|
||||
now.mockRestore();
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it('does not re-probe a mixed set of online and unloaded processes', async () => {
|
||||
const detectAccounts = vi.fn(async (): Promise<AccountLoginState[]> => [
|
||||
{ uin: '10001', uid: 'u_a', nickname: 'Alice', pid: 4242 },
|
||||
]);
|
||||
const ctx = makeManager({
|
||||
processes: [4242, 5151],
|
||||
livePipes: [4242],
|
||||
detectAccounts,
|
||||
});
|
||||
const now = vi.spyOn(Date, 'now');
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
const client = ctx.clientFactory.mock.results[0]!.value as EventEmitter;
|
||||
client.emit('loginState', { loggedIn: true, uin: '10001', uinNumber: 10001n });
|
||||
expect((await ctx.manager.listProcesses()).map((info) => info.status)).toEqual([
|
||||
'online',
|
||||
'available',
|
||||
]);
|
||||
const baseline = detectAccounts.mock.calls.length;
|
||||
now.mockReturnValue(Date.now() + 60_000);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await ctx.manager.listProcesses();
|
||||
expect(detectAccounts).toHaveBeenCalledTimes(baseline);
|
||||
} finally {
|
||||
now.mockRestore();
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it('releases file subscriptions when the process set changes and the manager stops', async () => {
|
||||
const ctx = makeManager({ processes: [4242] });
|
||||
|
||||
try {
|
||||
await ctx.pipeWatcher.start();
|
||||
expect(ctx.watchAccounts).toHaveBeenLastCalledWith([4242], expect.any(Function));
|
||||
const firstStop = ctx.watchAccounts.mock.results.at(-1)!.value;
|
||||
ctx.setProcesses([4242, 5151]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
expect(firstStop).toHaveBeenCalledOnce();
|
||||
expect(ctx.watchAccounts).toHaveBeenLastCalledWith([4242, 5151], expect.any(Function));
|
||||
const secondStop = ctx.watchAccounts.mock.results.at(-1)!.value;
|
||||
ctx.setProcesses([5151]);
|
||||
await ctx.pipeWatcher.tickNow();
|
||||
await flush();
|
||||
expect(secondStop).toHaveBeenCalledOnce();
|
||||
expect(ctx.watchAccounts).toHaveBeenLastCalledWith([5151], expect.any(Function));
|
||||
const finalStop = ctx.watchAccounts.mock.results.at(-1)!.value;
|
||||
ctx.manager.dispose();
|
||||
expect(finalStop).toHaveBeenCalledOnce();
|
||||
} finally {
|
||||
ctx.manager.dispose();
|
||||
ctx.pipeWatcher.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
it('keeps working when detection fails, and reports the failure once', async () => {
|
||||
@@ -387,7 +677,6 @@ describe('HookManager periodic account re-probe', () => {
|
||||
detectAccounts: async () => {
|
||||
throw new Error('login.db unreadable');
|
||||
},
|
||||
accountReprobeIntervalMs: 0,
|
||||
});
|
||||
await ctx.pipeWatcher.start();
|
||||
await flush();
|
||||
|
||||
@@ -80,6 +80,7 @@ function makeManager(opts: {
|
||||
listProcesses: async () => pids.map((pid) => ({ pid, name: 'qq', path: '' })),
|
||||
// Detection reads QQ's own data directories; tests stay off the host.
|
||||
detectAccounts: opts.detectAccounts ?? (async () => []),
|
||||
watchAccounts: () => () => {},
|
||||
});
|
||||
return {
|
||||
manager,
|
||||
|
||||
@@ -72,6 +72,7 @@ describe('HookManager — Docker reconnect-without-login leak guard', () => {
|
||||
autoLoadOnDiscovery: true,
|
||||
listProcesses: async () => [{ pid: PID, name: 'qq', path: '' }],
|
||||
detectAccounts: async () => [],
|
||||
watchAccounts: () => () => {},
|
||||
});
|
||||
|
||||
// Initial discovery + first connect.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { afterEach, describe, it, expect, vi } from 'vitest';
|
||||
import { afterEach, beforeEach, describe, it, expect, vi } from 'vitest';
|
||||
import { EventEmitter } from 'events';
|
||||
import { HookSession } from '../src/hook-session';
|
||||
import type { ManualMapHandle } from '../src/injector';
|
||||
@@ -30,6 +30,7 @@ class FakeClient extends EventEmitter {
|
||||
isClosed = false;
|
||||
isLoggedIn = false;
|
||||
shouldFailConnect = false;
|
||||
runtimeErrorOnConnect = false;
|
||||
nativeReadyOnIdentityHint = false;
|
||||
identityHintFailures = 0;
|
||||
sendError: Error | null = null;
|
||||
@@ -38,6 +39,10 @@ class FakeClient extends EventEmitter {
|
||||
private loginState = { loggedIn: false, uin: '0', uinNumber: 0n };
|
||||
|
||||
async connectAll(_opts: { recv: boolean }): Promise<void> {
|
||||
if (this.runtimeErrorOnConnect) {
|
||||
this.emit('runtimeError', new Error('QQ service unavailable'));
|
||||
}
|
||||
|
||||
if (this.shouldFailConnect) {
|
||||
throw new Error('connect failed');
|
||||
}
|
||||
@@ -102,10 +107,12 @@ function makeSession(
|
||||
pid?: number;
|
||||
pipeLive?: boolean;
|
||||
clientFailsConnect?: boolean;
|
||||
runtimeErrorOnConnect?: boolean;
|
||||
onPacket?: PacketSink;
|
||||
detectLoginUin?: (pid: number) => Promise<string | null>;
|
||||
nativeReadyOnIdentityHint?: boolean;
|
||||
identityHintFailures?: number;
|
||||
connectClient?: (client: FakeClient) => Promise<void>;
|
||||
} = {},
|
||||
) {
|
||||
const pid = opts.pid ?? 1234;
|
||||
@@ -123,6 +130,7 @@ function makeSession(
|
||||
injector,
|
||||
makeClient: () => {
|
||||
const c = new FakeClient();
|
||||
c.runtimeErrorOnConnect = opts.runtimeErrorOnConnect ?? false;
|
||||
|
||||
if (opts.clientFailsConnect) {
|
||||
c.shouldFailConnect = true;
|
||||
@@ -130,6 +138,11 @@ function makeSession(
|
||||
|
||||
c.nativeReadyOnIdentityHint = opts.nativeReadyOnIdentityHint ?? false;
|
||||
c.identityHintFailures = opts.identityHintFailures ?? 0;
|
||||
|
||||
if (opts.connectClient) {
|
||||
c.connectAll = () => opts.connectClient!(c);
|
||||
}
|
||||
|
||||
clients.push(c);
|
||||
// Cast: FakeClient mirrors only the surface HookSession touches.
|
||||
return c as unknown as QqHookClient;
|
||||
@@ -152,6 +165,77 @@ function makeSession(
|
||||
|
||||
const flush = () => new Promise<void>((r) => setImmediate(r));
|
||||
|
||||
describe('HookSession runtime failure', () => {
|
||||
it('retains an initialization error instead of waiting for login', async () => {
|
||||
const { session } = makeSession({ pipeLive: true, runtimeErrorOnConnect: true });
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'error',
|
||||
error: 'QQ service unavailable',
|
||||
connected: false,
|
||||
});
|
||||
session.dispose();
|
||||
});
|
||||
|
||||
it('keeps a late runtime error visible across refresh and login snapshots', async () => {
|
||||
const { session, currentClient, setPipeLive } = makeSession({ pipeLive: true });
|
||||
const disconnect = vi.fn();
|
||||
session.on('disconnected', disconnect);
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
currentClient().fireLogin('10001');
|
||||
currentClient().emit('runtimeError', new Error('QQ service unavailable'));
|
||||
currentClient().emit('error', new Error('connection closed'));
|
||||
expect(session.error).toBe('QQ service unavailable');
|
||||
currentClient().fireLogin('10001');
|
||||
await session.refresh();
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'error',
|
||||
error: 'QQ service unavailable',
|
||||
loggedIn: false,
|
||||
});
|
||||
setPipeLive(false);
|
||||
await session.refresh();
|
||||
expect(disconnect).toHaveBeenCalledExactlyOnceWith(true);
|
||||
setPipeLive(true);
|
||||
await session.refresh();
|
||||
currentClient().fireLogin('10001');
|
||||
expect(session.toInfo()).toMatchObject({ status: 'online', loggedIn: true, error: '' });
|
||||
session.dispose();
|
||||
});
|
||||
|
||||
it('retains the failure when the pipe closes and discards an in-flight login lookup', async () => {
|
||||
let resolveLogin!: (uin: string) => void;
|
||||
const { session, currentClient, setPipeLive } = makeSession({
|
||||
pipeLive: true,
|
||||
detectLoginUin: () =>
|
||||
new Promise((resolve) => {
|
||||
resolveLogin = resolve;
|
||||
}),
|
||||
});
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
const client = currentClient();
|
||||
client.emit('runtimeError', new Error('QQ service unavailable'));
|
||||
resolveLogin('10001');
|
||||
await flush();
|
||||
expect(client.loginIdentityHints).toEqual([]);
|
||||
setPipeLive(false);
|
||||
await session.refresh();
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'error',
|
||||
error: 'QQ service unavailable',
|
||||
loggedIn: false,
|
||||
connected: false,
|
||||
});
|
||||
session.dispose();
|
||||
});
|
||||
});
|
||||
|
||||
describe('HookSession — runtime TRACE', () => {
|
||||
it('records injection and existing-pipe load branches with unique terminals', async () => {
|
||||
const entries: LogEntry[] = [];
|
||||
@@ -521,6 +605,322 @@ describe('HookSession — load', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('HookSession — initial connection deadline', () => {
|
||||
const timeoutMs = 60_000;
|
||||
const sessions: HookSession[] = [];
|
||||
|
||||
function setup(opts: Parameters<typeof makeSession>[0] = {}) {
|
||||
const ctx = makeSession(opts);
|
||||
sessions.push(ctx.session);
|
||||
return ctx;
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout', 'Date'] });
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
for (const session of sessions.splice(0)) {
|
||||
session.dispose();
|
||||
}
|
||||
|
||||
vi.useRealTimers();
|
||||
});
|
||||
|
||||
it('reports a missing channel without losing the loaded component or clearing the error on refresh', async () => {
|
||||
const { session } = setup();
|
||||
const changed = vi.fn();
|
||||
session.on('status-changed', changed);
|
||||
|
||||
await expect(session.load()).resolves.toMatchObject({ status: 'connecting' });
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1);
|
||||
expect(session.status).toBe('connecting');
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'error',
|
||||
injected: true,
|
||||
connected: false,
|
||||
error: expect.stringContaining('首次连接超时'),
|
||||
});
|
||||
const error = session.error;
|
||||
expect(changed).toHaveBeenLastCalledWith('error', error);
|
||||
|
||||
session.onPipeDown();
|
||||
await expect(session.refresh()).resolves.toMatchObject({ status: 'error', error });
|
||||
});
|
||||
|
||||
it('unloads with the original handle after a timeout, including a failed unload retry', async () => {
|
||||
const { session, injector } = setup();
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
expect(session.status).toBe('error');
|
||||
injector.unload.mockRejectedValueOnce(new Error('unload rejected'));
|
||||
|
||||
await expect(session.unload()).resolves.toMatchObject({
|
||||
status: 'error',
|
||||
injected: true,
|
||||
error: 'unload rejected',
|
||||
});
|
||||
await expect(session.unload()).resolves.toMatchObject({
|
||||
status: 'available',
|
||||
injected: false,
|
||||
error: '',
|
||||
});
|
||||
expect(injector.unload).toHaveBeenNthCalledWith(1, session.pid, DUMMY_HANDLE);
|
||||
expect(injector.unload).toHaveBeenNthCalledWith(2, session.pid, DUMMY_HANDLE);
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
expect(session.status).toBe('available');
|
||||
});
|
||||
|
||||
it('retries the connection after timeout without loading the component twice', async () => {
|
||||
const { session, injector, setPipeLive } = setup();
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
expect(session.status).toBe('error');
|
||||
|
||||
await expect(session.load()).resolves.toMatchObject({
|
||||
status: 'connecting',
|
||||
injected: true,
|
||||
error: '',
|
||||
});
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1);
|
||||
expect(session.status).toBe('connecting');
|
||||
setPipeLive(true);
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
|
||||
expect(session.toInfo()).toMatchObject({ status: 'loaded', error: '', loggedIn: false });
|
||||
expect(injector.inject).toHaveBeenCalledOnce();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs * 2);
|
||||
expect(session.status).toBe('loaded');
|
||||
});
|
||||
|
||||
it('can time out again after an explicit retry', async () => {
|
||||
const { session, injector } = setup();
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
expect(session.status).toBe('error');
|
||||
expect(session.error).toContain('首次连接超时');
|
||||
expect(injector.inject).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('accepts a late channel without a manual retry and retains the timeout across failed handshakes', async () => {
|
||||
let failConnect = true;
|
||||
const { session, injector, setPipeLive } = setup({
|
||||
connectClient: async () => {
|
||||
if (failConnect) {
|
||||
throw new Error('connect failed');
|
||||
}
|
||||
},
|
||||
});
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
const error = session.error;
|
||||
expect(error).toContain('首次连接超时');
|
||||
setPipeLive(true);
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
expect(session.toInfo()).toMatchObject({ status: 'error', error });
|
||||
|
||||
failConnect = false;
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
expect(session.toInfo()).toMatchObject({ status: 'loaded', error: '', connected: true });
|
||||
expect(injector.inject).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('bounds a stalled handshake by the remaining initial budget and permits unload before it finishes', async () => {
|
||||
let finishConnect!: () => void;
|
||||
const { session, currentClient, injector, setPipeLive } = setup({
|
||||
connectClient: () =>
|
||||
new Promise<void>((resolve) => {
|
||||
finishConnect = resolve;
|
||||
}),
|
||||
});
|
||||
const login = vi.fn();
|
||||
const disconnected = vi.fn();
|
||||
session.on('login', login);
|
||||
session.on('disconnected', disconnected);
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1000);
|
||||
setPipeLive(true);
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
currentClient().fireLogin('10001');
|
||||
// Login and packets can arrive together before connectAll settles.
|
||||
// Preserve their ordering, but revoke this binding if the handshake fails.
|
||||
expect(login).toHaveBeenCalledOnce();
|
||||
await vi.advanceTimersByTimeAsync(1000);
|
||||
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'error',
|
||||
connected: false,
|
||||
loggedIn: false,
|
||||
});
|
||||
expect(session.error).toContain('首次连接超时');
|
||||
expect(currentClient().isClosed).toBe(true);
|
||||
expect(disconnected).toHaveBeenCalledExactlyOnceWith(true);
|
||||
setPipeLive(false);
|
||||
await expect(session.unload()).resolves.toMatchObject({
|
||||
status: 'available',
|
||||
injected: false,
|
||||
});
|
||||
expect(injector.unload).toHaveBeenCalledExactlyOnceWith(session.pid, DUMMY_HANDLE);
|
||||
|
||||
finishConnect();
|
||||
await flush();
|
||||
expect(session.toInfo()).toMatchObject({
|
||||
status: 'available',
|
||||
connected: false,
|
||||
loggedIn: false,
|
||||
});
|
||||
expect(login).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('coalesces watcher retries so they cannot queue ahead of unload after a stalled handshake', async () => {
|
||||
const { session, injector, clients } = setup({
|
||||
connectClient: () => new Promise<void>(() => {}),
|
||||
});
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
|
||||
for (let tick = 0; tick < 40; tick++) {
|
||||
session.onPipeUp();
|
||||
}
|
||||
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
let result: Awaited<ReturnType<HookSession['unload']>> | undefined;
|
||||
const unloading = session.unload().then((info) => {
|
||||
result = info;
|
||||
});
|
||||
await flush();
|
||||
expect(result).toMatchObject({ status: 'available', injected: false });
|
||||
expect(clients).toHaveLength(1);
|
||||
expect(injector.unload).toHaveBeenCalledExactlyOnceWith(session.pid, DUMMY_HANDLE);
|
||||
await unloading;
|
||||
});
|
||||
|
||||
it('starts the deadline after loading completes and repeated load calls do not postpone it', async () => {
|
||||
const { session, injector } = setup();
|
||||
let finishLoading!: (value: {
|
||||
method: 'loadModuleManual';
|
||||
handle: ManualMapHandle;
|
||||
}) => void;
|
||||
injector.inject.mockReturnValueOnce(
|
||||
new Promise((resolve) => {
|
||||
finishLoading = resolve;
|
||||
}),
|
||||
);
|
||||
const loading = session.load();
|
||||
await flush();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs * 2);
|
||||
expect(session.status).toBe('loading');
|
||||
|
||||
finishLoading({ method: 'loadModuleManual', handle: DUMMY_HANDLE });
|
||||
await loading;
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1);
|
||||
await session.load();
|
||||
expect(session.status).toBe('connecting');
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
expect(session.status).toBe('error');
|
||||
expect(injector.inject).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('unloads immediately if a late connection attempt is still handshaking after timeout', async () => {
|
||||
const { session, currentClient, injector } = setup({
|
||||
connectClient: () => new Promise<void>(() => {}),
|
||||
});
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs);
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
let result: Awaited<ReturnType<HookSession['unload']>> | undefined;
|
||||
const unloading = session.unload().then((info) => {
|
||||
result = info;
|
||||
});
|
||||
await flush();
|
||||
expect(result).toMatchObject({ status: 'available', injected: false });
|
||||
expect(currentClient().isClosed).toBe(true);
|
||||
expect(injector.unload).toHaveBeenCalledExactlyOnceWith(session.pid, DUMMY_HANDLE);
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
await unloading;
|
||||
});
|
||||
|
||||
it('cancels the deadline on unload and gives a new load a full budget', async () => {
|
||||
const { session, injector } = setup();
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1);
|
||||
await session.unload();
|
||||
await session.load();
|
||||
await vi.advanceTimersByTimeAsync(1);
|
||||
expect(session.status).toBe('connecting');
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs - 1);
|
||||
expect(session.status).toBe('error');
|
||||
expect(injector.inject).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it.each(['dispose', 'process-gone'] as const)(
|
||||
'cancels a pending deadline on %s',
|
||||
async (event) => {
|
||||
const { session } = setup();
|
||||
const changed = vi.fn();
|
||||
await session.load();
|
||||
session.on('status-changed', changed);
|
||||
|
||||
if (event === 'dispose') {
|
||||
session.dispose();
|
||||
} else {
|
||||
session.notifyProcessGone();
|
||||
await flush();
|
||||
}
|
||||
|
||||
changed.mockClear();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs * 2);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
expect(session.error).toBe('');
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
},
|
||||
);
|
||||
|
||||
it('does not let a disposed connection finish or retain its timer', async () => {
|
||||
let finishConnect!: () => void;
|
||||
const { session, currentClient } = setup({
|
||||
pipeLive: true,
|
||||
connectClient: () =>
|
||||
new Promise<void>((resolve) => {
|
||||
finishConnect = resolve;
|
||||
}),
|
||||
});
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
session.dispose();
|
||||
await flush();
|
||||
expect(currentClient().isClosed).toBe(true);
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
finishConnect();
|
||||
await flush();
|
||||
expect(session.toInfo()).toMatchObject({ connected: false, loggedIn: false });
|
||||
});
|
||||
|
||||
it('does not use the initial deadline as a login or later disconnection timeout', async () => {
|
||||
const { session, setPipeLive } = setup({ pipeLive: true });
|
||||
session.onPipeUp();
|
||||
await flush();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs * 2);
|
||||
expect(session.toInfo()).toMatchObject({ status: 'loaded', loggedIn: false, error: '' });
|
||||
|
||||
setPipeLive(false);
|
||||
session.onPipeDown();
|
||||
await flush();
|
||||
await vi.advanceTimersByTimeAsync(timeoutMs * 2);
|
||||
expect(session.toInfo()).toMatchObject({ status: 'connecting', error: '' });
|
||||
});
|
||||
});
|
||||
|
||||
describe('HookSession — pipe up/down → connect lifecycle', () => {
|
||||
it('onPipeUp after load: client connects → status loaded', async () => {
|
||||
const ctx = makeSession({ pipeLive: true });
|
||||
@@ -929,6 +1329,42 @@ describe('HookSession — pipe-down must not clobber a settled error', () => {
|
||||
});
|
||||
|
||||
describe('HookSession — packet forwarding', () => {
|
||||
it('forwards client receipts only for the active account without changing direction', async () => {
|
||||
const onPacket = vi.fn();
|
||||
const ctx = makeSession({ pipeLive: true, onPacket });
|
||||
await ctx.session.load();
|
||||
ctx.session.onPipeUp();
|
||||
await flush();
|
||||
ctx.currentClient().fireLogin('10001');
|
||||
const receipt: QqHookPacket = {
|
||||
seq: 42,
|
||||
error: 0,
|
||||
cmd: 'ClientMessageReceipt',
|
||||
uin: '10001',
|
||||
source: 'client-message',
|
||||
body: Buffer.from([1, 2, 3]),
|
||||
};
|
||||
|
||||
for (const uin of ['', '0', '20002']) {
|
||||
ctx.currentClient().firePacket({ ...receipt, uin });
|
||||
}
|
||||
|
||||
expect(onPacket).not.toHaveBeenCalled();
|
||||
ctx.currentClient().firePacket(receipt);
|
||||
expect(onPacket).toHaveBeenCalledExactlyOnceWith(
|
||||
expect.objectContaining({
|
||||
pid: 1234,
|
||||
uin: '10001',
|
||||
source: 'client-message',
|
||||
fromClient: false,
|
||||
}),
|
||||
);
|
||||
ctx.currentClient().fireLogin('20002');
|
||||
ctx.currentClient().firePacket(receipt);
|
||||
expect(onPacket).toHaveBeenCalledOnce();
|
||||
await ctx.session.dispose();
|
||||
});
|
||||
|
||||
// These tests cover the field-rename + filter logic that used to live
|
||||
// inside the deleted NtqqHandler.onHookPacket. Inlining it here means
|
||||
// we can exercise the transformation with a plain vi.fn() sink, no
|
||||
|
||||
86
packages/bridge/tests/qq-account-watch.integration.test.ts
Normal file
86
packages/bridge/tests/qq-account-watch.integration.test.ts
Normal file
@@ -0,0 +1,86 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { mkdtemp, mkdir, rename, rm, writeFile } from 'node:fs/promises';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { setTimeout as delay } from 'node:timers/promises';
|
||||
import { watchAccountFiles } from '../src/qq-account/watch';
|
||||
|
||||
// Keep native filesystem coverage aligned with qqDataRootsForPid's supported platforms.
|
||||
// macOS is only a development host here: fs.watch() can return before FSEvents
|
||||
// registration, losing immediate writes. Deterministic logic tests run on every OS.
|
||||
describe.skipIf(process.platform !== 'win32' && process.platform !== 'linux')(
|
||||
'account file changes on supported filesystems',
|
||||
() => {
|
||||
let root: string;
|
||||
const subscriptions: Array<() => void> = [];
|
||||
|
||||
beforeEach(async () => {
|
||||
root = await mkdtemp(path.join(os.tmpdir(), 'snowluma-account-watch-'));
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
for (const stop of subscriptions.splice(0)) {
|
||||
stop();
|
||||
}
|
||||
|
||||
await rm(root, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
function subscribe(dbPaths = [path.join(root, 'login.db')]) {
|
||||
const changed = vi.fn();
|
||||
subscriptions.push(watchAccountFiles(dbPaths, changed));
|
||||
return changed;
|
||||
}
|
||||
|
||||
it('observes database and WAL changes while ignoring message data and SHM', async () => {
|
||||
const dbPath = path.join(root, 'login.db');
|
||||
const changed = subscribe([dbPath, dbPath]);
|
||||
await writeFile(dbPath, 'login');
|
||||
await vi.waitFor(() => expect(changed).toHaveBeenCalled());
|
||||
const afterDatabase = changed.mock.calls.length;
|
||||
await writeFile(`${dbPath}-wal`, 'wal');
|
||||
await vi.waitFor(() =>
|
||||
expect(changed.mock.calls.length).toBeGreaterThan(afterDatabase),
|
||||
);
|
||||
const afterWal = changed.mock.calls.length;
|
||||
await writeFile(path.join(root, 'nt_msg.db'), 'message');
|
||||
await writeFile(`${dbPath}-shm`, 'shared memory');
|
||||
await delay(350);
|
||||
expect(changed).toHaveBeenCalledTimes(afterWal);
|
||||
});
|
||||
|
||||
it('observes database replacement and WAL recreation', async () => {
|
||||
const dbPath = path.join(root, 'login.db');
|
||||
await writeFile(dbPath, 'initial');
|
||||
const changed = subscribe();
|
||||
await writeFile(path.join(root, 'replacement'), 'replacement');
|
||||
await rename(path.join(root, 'replacement'), dbPath);
|
||||
await vi.waitFor(() => expect(changed).toHaveBeenCalled());
|
||||
const afterReplacement = changed.mock.calls.length;
|
||||
await writeFile(dbPath, 'updated');
|
||||
await vi.waitFor(() =>
|
||||
expect(changed.mock.calls.length).toBeGreaterThan(afterReplacement),
|
||||
);
|
||||
const afterUpdate = changed.mock.calls.length;
|
||||
await writeFile(`${dbPath}-wal`, 'wal');
|
||||
await vi.waitFor(() => expect(changed.mock.calls.length).toBeGreaterThan(afterUpdate));
|
||||
const afterWal = changed.mock.calls.length;
|
||||
await rm(`${dbPath}-wal`);
|
||||
await writeFile(`${dbPath}-wal`, 'new wal');
|
||||
await vi.waitFor(() => expect(changed.mock.calls.length).toBeGreaterThan(afterWal));
|
||||
});
|
||||
|
||||
it('starts watching login data created after QQ process discovery', async () => {
|
||||
const dbPath = path.join(root, 'QQ', 'global', 'nt_db', 'login.db');
|
||||
const changed = subscribe([dbPath]);
|
||||
await mkdir(path.dirname(dbPath), { recursive: true });
|
||||
await writeFile(dbPath, 'initial');
|
||||
await vi.waitFor(() => expect(changed).toHaveBeenCalled());
|
||||
const afterDatabase = changed.mock.calls.length;
|
||||
await writeFile(`${dbPath}-wal`, 'login');
|
||||
await vi.waitFor(() =>
|
||||
expect(changed.mock.calls.length).toBeGreaterThan(afterDatabase),
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
253
packages/bridge/tests/qq-account-watch.test.ts
Normal file
253
packages/bridge/tests/qq-account-watch.test.ts
Normal file
@@ -0,0 +1,253 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { EventEmitter } from 'node:events';
|
||||
import type { FSWatcher, WatchListener } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { createLogger } from '@snowluma/common/logger';
|
||||
import { watchAccountChangesForPids, watchAccountFiles } from '../src/qq-account/watch';
|
||||
|
||||
const files = vi.hoisted(() => ({
|
||||
watch: vi.fn<
|
||||
(
|
||||
directory: string,
|
||||
options: { persistent: boolean },
|
||||
listener: WatchListener<string>,
|
||||
) => FSWatcher
|
||||
>(),
|
||||
}));
|
||||
|
||||
vi.mock('node:fs', async (importOriginal) => ({
|
||||
...(await importOriginal<typeof import('node:fs')>()),
|
||||
watch: files.watch,
|
||||
}));
|
||||
|
||||
class TestWatcher extends EventEmitter implements FSWatcher {
|
||||
// Keep callbacks reachable after close to exercise queued, stale events.
|
||||
close = vi.fn();
|
||||
ref() {
|
||||
return this;
|
||||
}
|
||||
unref() {
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
const root = path.resolve('account-watch-fixture');
|
||||
const directories = new Set<string>();
|
||||
const watchers: TestWatcher[] = [];
|
||||
const subscriptions: Array<() => void> = [];
|
||||
const platform = process.platform;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
directories.add(root);
|
||||
files.watch.mockImplementation((directory, _options, listener) => {
|
||||
if (!directories.has(directory)) {
|
||||
throw Object.assign(new Error('directory missing'), { code: 'ENOENT' });
|
||||
}
|
||||
|
||||
const watcher = new TestWatcher();
|
||||
watcher.on('change', listener);
|
||||
watchers.push(watcher);
|
||||
return watcher;
|
||||
});
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
for (const stop of subscriptions.splice(0)) {
|
||||
stop();
|
||||
}
|
||||
|
||||
Object.defineProperty(process, 'platform', { value: platform, configurable: true });
|
||||
watchers.length = 0;
|
||||
directories.clear();
|
||||
files.watch.mockReset();
|
||||
vi.useRealTimers();
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
function subscribe(dbPaths = [path.join(root, 'login.db')]) {
|
||||
const changed = vi.fn();
|
||||
const log = createLogger('AccountWatchTest');
|
||||
const warning = vi.spyOn(log, 'warn');
|
||||
const stop = watchAccountFiles(dbPaths, changed, log);
|
||||
subscriptions.push(stop);
|
||||
return { changed, stop, warning };
|
||||
}
|
||||
|
||||
// Native filesystem delivery is covered separately on the production platforms.
|
||||
// These tests control event ordering and the debounce clock, not OS startup timing.
|
||||
describe('account file changes', () => {
|
||||
it('coalesces login database and WAL changes while ignoring message data and SHM', () => {
|
||||
const dbPath = path.join(root, 'login.db');
|
||||
const { changed } = subscribe([dbPath, dbPath]);
|
||||
expect(files.watch).toHaveBeenCalledExactlyOnceWith(
|
||||
root,
|
||||
{ persistent: false },
|
||||
expect.any(Function),
|
||||
);
|
||||
const watcher = watchers[0]!;
|
||||
watcher.emit('change', 'change', 'login.db');
|
||||
vi.advanceTimersByTime(100);
|
||||
watcher.emit('change', 'change', 'login.db-wal');
|
||||
vi.advanceTimersByTime(249);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
watcher.emit('change', 'change', 'nt_msg.db');
|
||||
watcher.emit('change', 'change', 'login.db-shm');
|
||||
vi.advanceTimersByTime(1);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('keeps the directory watch across database replacement and WAL recreation', () => {
|
||||
const { changed } = subscribe();
|
||||
const watcher = watchers[0]!;
|
||||
watcher.emit('change', 'rename', 'replacement');
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
watcher.emit('change', 'rename', 'login.db');
|
||||
vi.advanceTimersByTime(250);
|
||||
watcher.emit('change', 'change', 'login.db');
|
||||
vi.advanceTimersByTime(250);
|
||||
watcher.emit('change', 'rename', 'login.db-wal');
|
||||
vi.advanceTimersByTime(250);
|
||||
watcher.emit('change', 'rename', 'login.db-wal');
|
||||
watcher.emit('change', 'rename', 'login.db-wal');
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledTimes(4);
|
||||
expect(files.watch).toHaveBeenCalledOnce();
|
||||
expect(watcher.close).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('moves to newly created directories one level at a time', () => {
|
||||
const dbDirectory = path.join(root, 'QQ', 'global', 'nt_db');
|
||||
const { changed } = subscribe([path.join(dbDirectory, 'login.db')]);
|
||||
const ancestor = watchers[0]!;
|
||||
const attempts = files.watch.mock.calls.length;
|
||||
ancestor.emit('change', 'rename', 'unrelated');
|
||||
ancestor.emit('change', 'change', 'login.db-wal');
|
||||
expect(files.watch).toHaveBeenCalledTimes(attempts);
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
|
||||
let directory = root;
|
||||
|
||||
for (const segment of ['QQ', 'global', 'nt_db']) {
|
||||
directory = path.join(directory, segment);
|
||||
directories.add(directory);
|
||||
const previous = watchers.at(-1)!;
|
||||
previous.emit('change', 'rename', segment);
|
||||
expect(previous.close).toHaveBeenCalledOnce();
|
||||
expect(files.watch).toHaveBeenLastCalledWith(
|
||||
directory,
|
||||
{ persistent: false },
|
||||
expect.any(Function),
|
||||
);
|
||||
}
|
||||
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
watchers.at(-1)!.emit('change', 'change', 'login.db-wal');
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it.each(['QQ', null])(
|
||||
'observes an entire new directory tree from a %s ancestor event',
|
||||
(filename) => {
|
||||
const dbDirectory = path.join(root, 'QQ', 'global', 'nt_db');
|
||||
const { changed, warning } = subscribe([path.join(dbDirectory, 'login.db')]);
|
||||
const ancestor = watchers[0]!;
|
||||
directories.add(dbDirectory);
|
||||
ancestor.emit('change', 'rename', filename);
|
||||
expect(ancestor.close).toHaveBeenCalledOnce();
|
||||
expect(files.watch).toHaveBeenLastCalledWith(
|
||||
dbDirectory,
|
||||
{ persistent: false },
|
||||
expect.any(Function),
|
||||
);
|
||||
const attempts = files.watch.mock.calls.length;
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
|
||||
ancestor.emit('change', 'rename', 'QQ');
|
||||
ancestor.emit('error', new Error('late error'));
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(files.watch).toHaveBeenCalledTimes(attempts);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
expect(warning).not.toHaveBeenCalled();
|
||||
watchers.at(-1)!.emit('change', 'change', 'login.db-wal');
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledTimes(2);
|
||||
},
|
||||
);
|
||||
|
||||
it('notifies when the filesystem does not supply a filename', () => {
|
||||
const { changed } = subscribe();
|
||||
watchers[0]!.emit('change', 'change', null);
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('closes every watcher and cancels pending notifications on disposal', () => {
|
||||
const { changed, stop, warning } = subscribe([
|
||||
path.join(root, 'login.db'),
|
||||
path.join(root, 'other', 'login.db'),
|
||||
]);
|
||||
expect(watchers).toHaveLength(2);
|
||||
watchers[0]!.emit('change', 'change', 'login.db');
|
||||
vi.advanceTimersByTime(30);
|
||||
expect(vi.getTimerCount()).toBe(1);
|
||||
stop();
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
|
||||
for (const watcher of watchers) {
|
||||
expect(watcher.close).toHaveBeenCalledOnce();
|
||||
watcher.emit('change', 'rename', null);
|
||||
watcher.emit('error', new Error('late error'));
|
||||
}
|
||||
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
expect(warning).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('reports watch failures without starting a polling fallback', () => {
|
||||
files.watch.mockImplementationOnce(() => {
|
||||
throw Object.assign(new Error('access denied'), { code: 'EACCES' });
|
||||
});
|
||||
const { changed, warning } = subscribe();
|
||||
expect(warning).toHaveBeenCalledWith(
|
||||
'account watch failed: path=%s err=%s',
|
||||
path.join(root, 'login.db'),
|
||||
'access denied',
|
||||
);
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
vi.advanceTimersByTime(1000);
|
||||
expect(files.watch).toHaveBeenCalledOnce();
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('reports asynchronous watch errors and closes the failed watcher', () => {
|
||||
const { changed, warning } = subscribe();
|
||||
const watcher = watchers[0]!;
|
||||
watcher.emit('error', new Error('watch unavailable'));
|
||||
expect(watcher.close).toHaveBeenCalledOnce();
|
||||
expect(warning).toHaveBeenCalledWith(
|
||||
'account watch failed: path=%s err=%s',
|
||||
path.join(root, 'login.db'),
|
||||
'watch unavailable',
|
||||
);
|
||||
watcher.emit('change', 'change', 'login.db');
|
||||
vi.advanceTimersByTime(250);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does not start account file watchers through the production entry point on macOS', () => {
|
||||
Object.defineProperty(process, 'platform', { value: 'darwin', configurable: true });
|
||||
const changed = vi.fn();
|
||||
subscriptions.push(watchAccountChangesForPids([123], changed));
|
||||
expect(files.watch).not.toHaveBeenCalled();
|
||||
expect(vi.getTimerCount()).toBe(0);
|
||||
expect(changed).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
@@ -12,6 +12,8 @@ import {
|
||||
type LogEntry,
|
||||
} from '@snowluma/common/logger';
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { CLIENT_MESSAGE_RECEIPT_CMD } from '@snowluma/common/protocol-types';
|
||||
import { HookSession } from '../src/hook-session';
|
||||
import {
|
||||
HEADER_SIZE,
|
||||
listLiveLinuxPipePids,
|
||||
@@ -84,6 +86,7 @@ function readSendFrame(payload: Buffer): {
|
||||
function mockControlPipe(
|
||||
pid: number,
|
||||
onWrite: (socket: net.Socket, payload: Buffer) => void,
|
||||
...startupFrames: Buffer[]
|
||||
): ReturnType<typeof vi.spyOn> {
|
||||
return vi.spyOn(net, 'createConnection').mockImplementation((() => {
|
||||
const socket = new Duplex({
|
||||
@@ -100,10 +103,13 @@ function mockControlPipe(
|
||||
queueMicrotask(() =>
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({
|
||||
op: PipeOp.hello,
|
||||
value0: BigInt(pid),
|
||||
}),
|
||||
Buffer.concat([
|
||||
pipeFrame({
|
||||
op: PipeOp.hello,
|
||||
value0: BigInt(pid),
|
||||
}),
|
||||
...startupFrames,
|
||||
]),
|
||||
),
|
||||
);
|
||||
});
|
||||
@@ -117,6 +123,144 @@ function traceMessages(entries: LogEntry[]): string[] {
|
||||
.map((entry) => entry.message);
|
||||
}
|
||||
|
||||
describe('initial connection timeout cleanup', () => {
|
||||
it.each(['socket', 'control-hello', 'recv-hello'] as const)(
|
||||
'closes a stalled %s connection and allows unloading',
|
||||
async (phase) => {
|
||||
vi.useFakeTimers({ toFake: ['setTimeout', 'clearTimeout', 'Date'] });
|
||||
const sockets: net.Socket[] = [];
|
||||
const connection = vi.spyOn(net, 'createConnection').mockImplementation((() => {
|
||||
const socket = new Duplex({
|
||||
read() {},
|
||||
write(_chunk, _encoding, callback) {
|
||||
callback();
|
||||
},
|
||||
}) as net.Socket;
|
||||
sockets.push(socket);
|
||||
const control = sockets.length === 1;
|
||||
|
||||
if (phase !== 'socket') {
|
||||
queueMicrotask(() => {
|
||||
socket.emit('connect');
|
||||
|
||||
if (control && phase === 'recv-hello') {
|
||||
queueMicrotask(() =>
|
||||
socket.emit('data', pipeFrame({ op: PipeOp.hello })),
|
||||
);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
return socket;
|
||||
}) as typeof net.createConnection);
|
||||
const handle = { base: 0n, entry: 0n, exceptionTable: 0n, size: 0 };
|
||||
const unload = vi.fn(async () => {});
|
||||
const session = new HookSession(778905, {
|
||||
injector: {
|
||||
inject: async () => ({ method: 'loadModuleManual', handle }),
|
||||
unload,
|
||||
},
|
||||
makeClient: (pid) => new QqHookClient(pid),
|
||||
pipeWatcher: { isPipeLive: () => false },
|
||||
detectLoginUin: async () => null,
|
||||
});
|
||||
|
||||
try {
|
||||
await session.load();
|
||||
session.onPipeUp();
|
||||
await new Promise<void>((resolve) => setImmediate(resolve));
|
||||
expect(sockets).toHaveLength(phase === 'recv-hello' ? 2 : 1);
|
||||
await vi.advanceTimersByTimeAsync(60_000);
|
||||
expect(session.toInfo()).toMatchObject({ status: 'error', injected: true });
|
||||
expect(session.error).toContain('首次连接超时');
|
||||
expect(sockets.every((socket) => socket.destroyed)).toBe(true);
|
||||
await expect(session.unload()).resolves.toMatchObject({ status: 'available' });
|
||||
expect(unload).toHaveBeenCalledExactlyOnceWith(session.pid, handle);
|
||||
} finally {
|
||||
session.dispose();
|
||||
|
||||
for (const socket of sockets) {
|
||||
socket.destroy();
|
||||
}
|
||||
|
||||
connection.mockRestore();
|
||||
vi.useRealTimers();
|
||||
}
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
describe('runtime initialization failures', () => {
|
||||
const failureFrame = pipeFrame({
|
||||
op: PipeOp.error,
|
||||
cmd: 'runtime',
|
||||
status: -1,
|
||||
message: 'QQ service unavailable',
|
||||
});
|
||||
|
||||
it('rejects startup when a runtime failure follows hello in the same read', async () => {
|
||||
const connection = mockControlPipe(778901, () => {}, failureFrame);
|
||||
const client = new QqHookClient(778901);
|
||||
const failure = vi.fn();
|
||||
client.on('runtimeError', failure);
|
||||
|
||||
try {
|
||||
await expect(client.connect()).rejects.toThrow('QQ service unavailable');
|
||||
expect(failure).toHaveBeenCalledExactlyOnceWith(
|
||||
expect.objectContaining({ status: -1, requestId: 0 }),
|
||||
);
|
||||
} finally {
|
||||
client.close();
|
||||
connection.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('rejects pending and future requests on a runtime failure', async () => {
|
||||
const connection = mockControlPipe(778902, (socket) => {
|
||||
queueMicrotask(() => socket.emit('data', failureFrame));
|
||||
});
|
||||
const client = new QqHookClient(778902);
|
||||
|
||||
try {
|
||||
await expect(client.sendAndWait('Test', Buffer.alloc(0))).rejects.toThrow(
|
||||
'QQ service unavailable',
|
||||
);
|
||||
await expect(client.sendAndWait('Test', Buffer.alloc(0))).rejects.toThrow(
|
||||
'QQ service unavailable',
|
||||
);
|
||||
await expect(client.startRecv()).rejects.toThrow('QQ service unavailable');
|
||||
await expect(client.waitForLogin()).rejects.toThrow('QQ service unavailable');
|
||||
} finally {
|
||||
client.close();
|
||||
connection.mockRestore();
|
||||
}
|
||||
});
|
||||
|
||||
it('rejects login and queued writes when the runtime fails as a connection resumes', async () => {
|
||||
const onWrite = vi.fn();
|
||||
const sockets = mockControlPipe(778903, onWrite);
|
||||
const client = new QqHookClient(778903);
|
||||
|
||||
try {
|
||||
await client.connect();
|
||||
const waiting = client.waitForLogin({ timeoutMs: 100 });
|
||||
const sending = client.sendNoReply('Test', Buffer.alloc(0), { ackTimeoutMs: 100 });
|
||||
const settled = Promise.allSettled([waiting, sending]);
|
||||
sockets.mock.results[0]!.value.emit('data', failureFrame);
|
||||
|
||||
const expected = {
|
||||
status: 'rejected',
|
||||
reason: expect.objectContaining({ message: 'QQ service unavailable' }),
|
||||
};
|
||||
expect(await settled).toEqual([expected, expected]);
|
||||
expect(onWrite).not.toHaveBeenCalled();
|
||||
} finally {
|
||||
client.close();
|
||||
sockets.mockRestore();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
function runtimeTrace(entries: LogEntry[]): LogEntry[] {
|
||||
return entries.filter((entry) => entry.level === 'trace' && entry.scope === 'QQHook.Runtime');
|
||||
}
|
||||
@@ -147,6 +291,122 @@ describe('QqHookClient login wait lifecycle', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('QqHookClient client message receipts', () => {
|
||||
it('preserves receipt provenance and failure status separately from normal packets', async () => {
|
||||
const sockets = mockControlPipe(12345, () => {});
|
||||
const client = new QqHookClient(12345);
|
||||
const onPacket = vi.fn();
|
||||
|
||||
try {
|
||||
await client.startRecv(onPacket);
|
||||
const socket = sockets.mock.results[0]!.value;
|
||||
const body = Buffer.from([1, 2, 3]);
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({ op: PipeOp.clientMessageReceipt, value0: 42n, message: '10001', body }),
|
||||
);
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({
|
||||
op: PipeOp.clientMessageReceipt,
|
||||
value0: 43n,
|
||||
message: '10001',
|
||||
status: -1,
|
||||
}),
|
||||
);
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({
|
||||
op: PipeOp.recvPacket,
|
||||
value0: 44n,
|
||||
message: '10001',
|
||||
cmd: CLIENT_MESSAGE_RECEIPT_CMD,
|
||||
body,
|
||||
}),
|
||||
);
|
||||
|
||||
expect(onPacket.mock.calls.map(([packet]) => packet)).toEqual([
|
||||
{
|
||||
seq: 42,
|
||||
error: 0,
|
||||
cmd: CLIENT_MESSAGE_RECEIPT_CMD,
|
||||
uin: '10001',
|
||||
body,
|
||||
source: 'client-message',
|
||||
},
|
||||
{
|
||||
seq: 43,
|
||||
error: -1,
|
||||
cmd: CLIENT_MESSAGE_RECEIPT_CMD,
|
||||
uin: '10001',
|
||||
body: Buffer.alloc(0),
|
||||
source: 'client-message',
|
||||
},
|
||||
{ seq: 44, error: 0, cmd: CLIENT_MESSAGE_RECEIPT_CMD, uin: '10001', body },
|
||||
]);
|
||||
} finally {
|
||||
client.close();
|
||||
}
|
||||
});
|
||||
|
||||
it('reports unsupported capability and invalid envelopes without breaking normal receive', async () => {
|
||||
const entries: LogEntry[] = [];
|
||||
setLogLevel('warn');
|
||||
const unsubscribe = subscribeLogs((entry) => entries.push(entry));
|
||||
const sockets = mockControlPipe(12345, () => {});
|
||||
const client = new QqHookClient(12345);
|
||||
const onPacket = vi.fn();
|
||||
|
||||
try {
|
||||
await client.startRecv(onPacket);
|
||||
const socket = sockets.mock.results[0]!.value;
|
||||
socket.emit('data', pipeFrame({ op: PipeOp.clientMessageState, status: -1 }));
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({ op: PipeOp.clientMessageState, status: -1, value0: 42n }),
|
||||
);
|
||||
const warning = 'Client private-message reporting is unavailable: PID=12345 status=-1';
|
||||
expect(entries.map((entry) => entry.message)).toEqual([
|
||||
warning,
|
||||
`${warning} reason=42`,
|
||||
]);
|
||||
|
||||
for (const patch of [
|
||||
{ value0: 0n },
|
||||
{ value0: BigInt(Number.MAX_SAFE_INTEGER) + 1n },
|
||||
{ message: '' },
|
||||
{ cmd: 'unexpected' },
|
||||
{ requestId: 1 },
|
||||
]) {
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({
|
||||
op: PipeOp.clientMessageReceipt,
|
||||
value0: 42n,
|
||||
message: '10001',
|
||||
...patch,
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
expect(onPacket).not.toHaveBeenCalled();
|
||||
expect(
|
||||
entries.filter(
|
||||
(entry) => entry.scope === 'QQHook.Runtime' && entry.level === 'warn',
|
||||
),
|
||||
).toHaveLength(7);
|
||||
socket.emit(
|
||||
'data',
|
||||
pipeFrame({ op: PipeOp.recvPacket, cmd: 'normal', message: '10001', value0: 44n }),
|
||||
);
|
||||
expect(onPacket).toHaveBeenCalledOnce();
|
||||
} finally {
|
||||
client.close();
|
||||
unsubscribe();
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('listLiveLinuxPipePids', () => {
|
||||
it('ignores stale-looking control socket names when the probe rejects them', async () => {
|
||||
const runtimeDir = await makeRuntimeDir();
|
||||
|
||||
@@ -1,13 +1,21 @@
|
||||
{
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"name": "@snowluma/common",
|
||||
"version": "2.0.1",
|
||||
"version": "2.4.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"description": "SnowLuma shared infrastructure — leaf-package utilities with zero business dependencies. Logger / hex codec / log file transport / log line summariser / packet sender wire-protocol types / runtime config loader. Consumed by @snowluma/protocol, @snowluma/core, and @snowluma/onebot. Per-file subpath exports keep import sites unambiguous and let the bundler tree-shake aggressively (importing `@snowluma/common/hex` doesn't pull in `node:fs` from the logger transport).",
|
||||
"main": "./src/index.ts",
|
||||
"types": "./src/index.ts",
|
||||
"exports": {
|
||||
"./webui-target": {
|
||||
"types": "./src/webui-target.ts",
|
||||
"default": "./src/webui-target.ts"
|
||||
},
|
||||
"./update-source": {
|
||||
"types": "./src/update-source.ts",
|
||||
"default": "./src/update-source.ts"
|
||||
},
|
||||
"./semver": {
|
||||
"types": "./src/semver.ts",
|
||||
"default": "./src/semver.ts"
|
||||
@@ -101,7 +109,7 @@
|
||||
"@types/node": "catalog:",
|
||||
"@types/semver": "7.7.1",
|
||||
"typescript": "catalog:",
|
||||
"vitest": "^4.1.4"
|
||||
"vitest": "4.1.12"
|
||||
},
|
||||
"dependencies": {
|
||||
"@zxcvbn-ts/core": "^4.1.2",
|
||||
@@ -110,6 +118,6 @@
|
||||
"semver": "7.7.4"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
"node": "^24.22.1 || >=26.12.1"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
export const CLIENT_MESSAGE_RECEIPT_CMD = 'ClientMessageReceipt';
|
||||
|
||||
export interface PacketInfo {
|
||||
pid: number;
|
||||
uin: string;
|
||||
@@ -6,6 +8,7 @@ export interface PacketInfo {
|
||||
seqId: number;
|
||||
retCode: number;
|
||||
fromClient: boolean;
|
||||
source?: 'client-message';
|
||||
body: Uint8Array;
|
||||
}
|
||||
export type PacketSink = (packet: PacketInfo) => void;
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { isObject } from './coerce';
|
||||
import { normalizeUpdateSourceConfig, type UpdateSourceConfig } from './update-source';
|
||||
|
||||
export interface RuntimeConfig {
|
||||
updateSource?: UpdateSourceConfig;
|
||||
webuiPort?: number;
|
||||
/** When true, every newly-discovered QQ process gets auto-injected by
|
||||
* the HookManager. Also overridable at runtime via SNOWLUMA_HOOK_AUTOLOAD.
|
||||
@@ -43,6 +45,9 @@ export const MAX_LOG_RETAIN_DAYS = Math.floor(Number.MAX_SAFE_INTEGER / (24 * 60
|
||||
export function normalizeRuntimeConfig(parsed: unknown): RuntimeConfig {
|
||||
const obj = isObject(parsed) ? parsed : {};
|
||||
return {
|
||||
...(obj.updateSource === undefined
|
||||
? {}
|
||||
: { updateSource: normalizeUpdateSourceConfig(obj.updateSource) }),
|
||||
webuiPort: normalizePort(obj.webuiPort ?? DEFAULT_WEBUI_PORT, DEFAULT_WEBUI_PORT),
|
||||
hookAutoLoad: normalizeBool(obj.hookAutoLoad, false),
|
||||
webuiHost: normalizeHost(obj.webuiHost),
|
||||
@@ -217,7 +222,8 @@ function sameRuntimeConfig(parsed: Record<string, unknown>, n: RuntimeConfig): b
|
||||
parsed.trustProxy === n.trustProxy &&
|
||||
parsed.logMaxTotalMb === n.logMaxTotalMb &&
|
||||
parsed.logRetainDays === n.logRetainDays &&
|
||||
parsed.logPerUin === n.logPerUin
|
||||
parsed.logPerUin === n.logPerUin &&
|
||||
JSON.stringify(parsed.updateSource) === JSON.stringify(n.updateSource)
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
60
packages/common/src/update-source.ts
Normal file
60
packages/common/src/update-source.ts
Normal file
@@ -0,0 +1,60 @@
|
||||
export interface UpdateSourceConfig {
|
||||
mode: 'auto' | 'direct' | 'mirror';
|
||||
mirror: string;
|
||||
mirrors: string[];
|
||||
}
|
||||
|
||||
export function normalizeMirrorUrl(value: unknown): string {
|
||||
if (typeof value !== 'string' || value.length > 2048) {
|
||||
throw new Error('镜像地址必须是 HTTP(S) URL');
|
||||
}
|
||||
|
||||
let url: URL;
|
||||
|
||||
try {
|
||||
url = new URL(value.trim());
|
||||
} catch {
|
||||
throw new Error('镜像地址必须是 HTTP(S) URL');
|
||||
}
|
||||
|
||||
if (
|
||||
!['http:', 'https:'].includes(url.protocol) ||
|
||||
url.username ||
|
||||
url.password ||
|
||||
url.search ||
|
||||
url.hash
|
||||
) {
|
||||
throw new Error('镜像地址仅支持 HTTP(S),不能包含账号、密码、查询参数或片段');
|
||||
}
|
||||
|
||||
return url.href.replace(/\/+$/, '');
|
||||
}
|
||||
|
||||
export function normalizeUpdateSourceConfig(value: unknown): UpdateSourceConfig {
|
||||
if (!value || typeof value !== 'object' || Array.isArray(value)) {
|
||||
throw new Error('更新来源必须是对象');
|
||||
}
|
||||
|
||||
if (
|
||||
!('mode' in value) ||
|
||||
(value.mode !== 'auto' && value.mode !== 'direct' && value.mode !== 'mirror')
|
||||
) {
|
||||
throw new Error('更新来源模式无效');
|
||||
}
|
||||
|
||||
if (!('mirrors' in value) || !Array.isArray(value.mirrors) || value.mirrors.length > 16) {
|
||||
throw new Error('自动筛选最多支持 16 个镜像');
|
||||
}
|
||||
|
||||
const mirror = 'mirror' in value && value.mirror !== '' ? normalizeMirrorUrl(value.mirror) : '';
|
||||
|
||||
if (value.mode === 'mirror' && !mirror) {
|
||||
throw new Error('请指定镜像地址');
|
||||
}
|
||||
|
||||
return {
|
||||
mode: value.mode,
|
||||
mirror,
|
||||
mirrors: [...new Set(value.mirrors.map(normalizeMirrorUrl))],
|
||||
};
|
||||
}
|
||||
100
packages/common/src/webui-target.ts
Normal file
100
packages/common/src/webui-target.ts
Normal file
@@ -0,0 +1,100 @@
|
||||
/** Browser-safe contract shared by startup, the WebUI and embedding hosts.
|
||||
* Targets are deployment choices; they never belong in the saved UI preferences. */
|
||||
export const WEBUI_TARGETS = {
|
||||
maibot: {
|
||||
label: '麦麦 / 一键包',
|
||||
styles: ['millennium'],
|
||||
defaultStyle: 'millennium',
|
||||
},
|
||||
} as const;
|
||||
|
||||
export type WebuiTarget = keyof typeof WEBUI_TARGETS;
|
||||
export type WebuiColorMode = 'light' | 'dark' | 'system';
|
||||
|
||||
export type WebuiPresentation = {
|
||||
[T in WebuiTarget]: {
|
||||
version: 1;
|
||||
target: T;
|
||||
style: (typeof WEBUI_TARGETS)[T]['styles'][number];
|
||||
mode: WebuiColorMode;
|
||||
};
|
||||
}[WebuiTarget];
|
||||
|
||||
/** null releases the override for this document, without changing deployment opt-in. */
|
||||
export type WebuiPresentationUpdate = WebuiPresentation | { version: 1; target: null };
|
||||
export const WEBUI_PRESENTATION_EVENT = 'snowluma:host-appearance';
|
||||
export const WEBUI_TARGET_BOOTSTRAP_ID = 'snowluma-webui-target';
|
||||
|
||||
export function resolveWebuiTarget(raw: string | undefined): WebuiTarget | null {
|
||||
if (raw === undefined || raw.trim() === '') {
|
||||
return null;
|
||||
}
|
||||
|
||||
const value = raw.trim();
|
||||
|
||||
if (!Object.hasOwn(WEBUI_TARGETS, value)) {
|
||||
throw new Error(
|
||||
`Invalid SNOWLUMA_WEBUI_TARGET: ${JSON.stringify(value)}. Expected ${Object.keys(WEBUI_TARGETS).join(', ')} or an empty value.`,
|
||||
);
|
||||
}
|
||||
|
||||
return value as WebuiTarget;
|
||||
}
|
||||
|
||||
export function defaultWebuiPresentation(target: WebuiTarget): WebuiPresentation {
|
||||
return { version: 1, target, style: WEBUI_TARGETS[target].defaultStyle, mode: 'system' };
|
||||
}
|
||||
|
||||
export function parseWebuiPresentation(value: unknown): WebuiPresentationUpdate {
|
||||
if (
|
||||
!value ||
|
||||
typeof value !== 'object' ||
|
||||
!('version' in value) ||
|
||||
value.version !== 1 ||
|
||||
!('target' in value)
|
||||
) {
|
||||
throw new TypeError('Invalid host appearance: expected a version 1 presentation');
|
||||
}
|
||||
|
||||
if (value.target === null) {
|
||||
return { version: 1, target: null };
|
||||
}
|
||||
|
||||
if (typeof value.target !== 'string' || !Object.hasOwn(WEBUI_TARGETS, value.target)) {
|
||||
throw new TypeError('Invalid host appearance target');
|
||||
}
|
||||
|
||||
const target = value.target as WebuiTarget;
|
||||
const styles: readonly string[] = WEBUI_TARGETS[target].styles;
|
||||
|
||||
if (!('style' in value) || typeof value.style !== 'string' || !styles.includes(value.style)) {
|
||||
throw new TypeError(`Invalid host appearance style for ${target}`);
|
||||
}
|
||||
|
||||
if (
|
||||
!('mode' in value) ||
|
||||
(value.mode !== 'light' && value.mode !== 'dark' && value.mode !== 'system')
|
||||
) {
|
||||
throw new TypeError('Invalid host appearance color mode');
|
||||
}
|
||||
|
||||
// Both discriminants have been checked against the same target registry.
|
||||
return { version: 1, target, style: value.style, mode: value.mode } as WebuiPresentation;
|
||||
}
|
||||
|
||||
/** Inject before the cached pre-paint theme script. Default HTML stays byte-for-byte intact. */
|
||||
export function injectWebuiTarget(html: string, target: WebuiTarget | null): string {
|
||||
if (target === null) {
|
||||
return html;
|
||||
}
|
||||
|
||||
if (!html.includes('<head>')) {
|
||||
throw new Error('WebUI HTML is missing <head>; cannot inject runtime target');
|
||||
}
|
||||
|
||||
const json = JSON.stringify(defaultWebuiPresentation(target)).replaceAll('<', '\\u003c');
|
||||
return html.replace(
|
||||
'<head>',
|
||||
`<head>\n <script id="${WEBUI_TARGET_BOOTSTRAP_ID}" type="application/json">${json}</script>`,
|
||||
);
|
||||
}
|
||||
54
packages/common/tests/update-source.test.ts
Normal file
54
packages/common/tests/update-source.test.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { normalizeMirrorUrl, normalizeUpdateSourceConfig } from '../src/update-source';
|
||||
import { normalizeRuntimeConfig } from '../src/runtime';
|
||||
|
||||
describe('update source configuration', () => {
|
||||
it('normalizes proxy prefixes, deduplicates mirrors and retains order', () => {
|
||||
expect(
|
||||
normalizeUpdateSourceConfig({
|
||||
mode: 'auto',
|
||||
mirror: '',
|
||||
mirrors: [
|
||||
' https://EXAMPLE.com/proxy/ ',
|
||||
'https://example.com/proxy',
|
||||
'https://other.example',
|
||||
],
|
||||
}),
|
||||
).toEqual({
|
||||
mode: 'auto',
|
||||
mirror: '',
|
||||
mirrors: ['https://example.com/proxy', 'https://other.example'],
|
||||
});
|
||||
});
|
||||
|
||||
it.each([
|
||||
'',
|
||||
'file:///tmp/x',
|
||||
'ftp://example.com',
|
||||
'https://user:secret@example.com',
|
||||
'https://example.com/?token=a',
|
||||
'https://example.com/#a',
|
||||
null,
|
||||
])('rejects invalid mirror %s', (url) => {
|
||||
expect(() => normalizeMirrorUrl(url)).toThrow();
|
||||
});
|
||||
|
||||
it.each([
|
||||
null,
|
||||
[],
|
||||
{ mode: ['auto'], mirrors: [] },
|
||||
{ mode: 'mirror', mirror: '', mirrors: [] },
|
||||
{ mode: 'auto', mirrors: Array(17).fill('https://example.com') },
|
||||
])('rejects invalid configuration %j', (config) => {
|
||||
expect(() => normalizeUpdateSourceConfig(config)).toThrow();
|
||||
});
|
||||
|
||||
it('retains configured update sources when normalizing runtime settings', () => {
|
||||
const updateSource = { mode: 'direct', mirror: '', mirrors: [] };
|
||||
expect(normalizeRuntimeConfig({ updateSource, webuiPort: 7777 })).toMatchObject({
|
||||
updateSource,
|
||||
webuiPort: 7777,
|
||||
});
|
||||
expect(normalizeRuntimeConfig({})).not.toHaveProperty('updateSource');
|
||||
});
|
||||
});
|
||||
51
packages/common/tests/webui-target.test.ts
Normal file
51
packages/common/tests/webui-target.test.ts
Normal file
@@ -0,0 +1,51 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import {
|
||||
defaultWebuiPresentation,
|
||||
injectWebuiTarget,
|
||||
parseWebuiPresentation,
|
||||
resolveWebuiTarget,
|
||||
} from '../src/webui-target';
|
||||
|
||||
describe('deployment presentation contract', () => {
|
||||
it('requires explicit opt-in and rejects misspelled deployments', () => {
|
||||
expect(resolveWebuiTarget(undefined)).toBeNull();
|
||||
expect(resolveWebuiTarget(' ')).toBeNull();
|
||||
expect(resolveWebuiTarget('maibot')).toBe('maibot');
|
||||
expect(() => resolveWebuiTarget('mai-bot')).toThrow('SNOWLUMA_WEBUI_TARGET');
|
||||
expect(() => resolveWebuiTarget('__proto__')).toThrow('SNOWLUMA_WEBUI_TARGET');
|
||||
});
|
||||
|
||||
it('keeps the unconfigured document intact and injects before cached appearance', () => {
|
||||
const html = '<html><head><script>readSavedAppearance()</script></head></html>';
|
||||
expect(injectWebuiTarget(html, null)).toBe(html);
|
||||
const injected = injectWebuiTarget(html, 'maibot');
|
||||
expect(injected.indexOf('snowluma-webui-target')).toBeLessThan(
|
||||
injected.indexOf('readSavedAppearance'),
|
||||
);
|
||||
expect(injected).toContain(JSON.stringify(defaultWebuiPresentation('maibot')));
|
||||
expect(() => injectWebuiTarget('broken html', 'maibot')).toThrow('missing <head>');
|
||||
});
|
||||
|
||||
it('validates the version, target, style and color mode without accepting arbitrary CSS', () => {
|
||||
const valid = defaultWebuiPresentation('maibot');
|
||||
expect(parseWebuiPresentation(valid)).toEqual(valid);
|
||||
expect(
|
||||
parseWebuiPresentation({ ...valid, mode: 'dark', css: 'body{display:none}' }),
|
||||
).toEqual({ ...valid, mode: 'dark' });
|
||||
expect(parseWebuiPresentation({ version: 1, target: null })).toEqual({
|
||||
version: 1,
|
||||
target: null,
|
||||
});
|
||||
|
||||
for (const input of [
|
||||
null,
|
||||
{},
|
||||
{ ...valid, version: 2 },
|
||||
{ ...valid, target: 'other' },
|
||||
{ ...valid, style: 'modern' },
|
||||
{ ...valid, mode: 'blue' },
|
||||
]) {
|
||||
expect(() => parseWebuiPresentation(input)).toThrow();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"name": "@snowluma/core",
|
||||
"version": "2.0.1",
|
||||
"version": "2.4.0",
|
||||
"description": "SnowLuma core - NTQQ packet sniffer with Node.js native addon",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
@@ -53,19 +53,18 @@
|
||||
"tar": "^7.5.22"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@hono/node-server": "^1.19.15",
|
||||
"@rollup/plugin-node-resolve": "^16.0.3",
|
||||
"@hono/node-server": "^2.1.4",
|
||||
"@types/node": "catalog:",
|
||||
"cross-env": "^10.1.0",
|
||||
"hono": "^4.12.34",
|
||||
"hono": "^4.13.11",
|
||||
"tsx": "^4.21.0",
|
||||
"typescript": "catalog:",
|
||||
"vite": "catalog:",
|
||||
"vite-plugin-cp": "^6.0.3",
|
||||
"vitest": "^4.1.4",
|
||||
"vitest": "4.1.12",
|
||||
"@snowluma/sqlite": "workspace:*"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
"node": "^24.22.1 || >=26.12.1"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import { GroupInviteTracker } from '@snowluma/protocol/group-invite-tracker';
|
||||
import { isSelfGroupInvitation } from '@snowluma/protocol/qq-info';
|
||||
import { FetchDownloadRkeys } from '@snowluma/protocol/oidb-services/contacts/fetch-download-rkeys';
|
||||
import {
|
||||
FetchFriendListPage,
|
||||
@@ -42,6 +44,7 @@ import type {
|
||||
FriendInfo,
|
||||
GroupMemberInfo,
|
||||
GroupRequestInfo,
|
||||
PublicProfileFields,
|
||||
QQGroupInfo,
|
||||
UserProfileInfo,
|
||||
} from '@snowluma/protocol/qq-info';
|
||||
@@ -92,6 +95,13 @@ function normalizeGroupRequestSequence(
|
||||
}
|
||||
|
||||
const MEMBER_LIST_TTL_MS = 60_000;
|
||||
const FRIEND_PROFILE_TTL_MS = 5 * 60_000;
|
||||
const FRIEND_PROFILE_CONCURRENCY = 4;
|
||||
|
||||
export interface FriendListOptions {
|
||||
/** Explicitly query profiles; ordinary roster refreshes never fan out. */
|
||||
withProfile?: boolean;
|
||||
}
|
||||
|
||||
export class ContactsApi {
|
||||
/**
|
||||
@@ -109,9 +119,16 @@ export class ContactsApi {
|
||||
load: (groupId) => this.fetchGroupMemberListUncached(groupId),
|
||||
});
|
||||
private robotUinRangesPromise_: Promise<RobotUinRangeSnapshot> | null = null;
|
||||
/** groupUin → approval msgseq from a private qun.invite card. Written
|
||||
* only by IncomingPacketPipeline (and tests). OneBot reads get/find. */
|
||||
private readonly groupInviteCardSeqs_ = new Map<number, number>();
|
||||
readonly groupInvites = new GroupInviteTracker();
|
||||
private friendRosterGeneration = 0;
|
||||
private rememberedFriendRosterGeneration = 0;
|
||||
private activeProfiles = 0;
|
||||
private readonly profileWaiters: (() => void)[] = [];
|
||||
private readonly friendProfiles: SingleFlightCache<number, PublicProfileFields> =
|
||||
createSingleFlightCache({
|
||||
ttlMs: FRIEND_PROFILE_TTL_MS,
|
||||
load: (uin) => this.loadFriendProfile(uin),
|
||||
});
|
||||
|
||||
constructor(private readonly ctx: BridgeContext) {}
|
||||
|
||||
@@ -177,7 +194,73 @@ export class ContactsApi {
|
||||
return SendTuwenArk.invoke(this.ctx, params);
|
||||
}
|
||||
|
||||
private async fetchFriendRoster(): Promise<FriendRoster> {
|
||||
private async loadFriendProfile(uin: number): Promise<PublicProfileFields> {
|
||||
if (this.activeProfiles >= FRIEND_PROFILE_CONCURRENCY) {
|
||||
await new Promise<void>((resolve) => this.profileWaiters.push(resolve));
|
||||
} else {
|
||||
this.activeProfiles++;
|
||||
}
|
||||
|
||||
try {
|
||||
const profile = await this.fetchUserProfile(uin);
|
||||
|
||||
return profile.profile ?? {};
|
||||
} catch (cause) {
|
||||
log.warn(
|
||||
'friend profile query failed: user=%d error=%s',
|
||||
uin,
|
||||
cause instanceof Error ? cause.message : String(cause),
|
||||
);
|
||||
throw new Error(`friend profile query failed for ${uin}`, { cause });
|
||||
} finally {
|
||||
const next = this.profileWaiters.shift();
|
||||
|
||||
if (next) {
|
||||
next();
|
||||
} else {
|
||||
this.activeProfiles--;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private async enrichFriendProfiles(entries: FriendListPageEntry[]): Promise<void> {
|
||||
const started = Date.now();
|
||||
|
||||
for (let offset = 0; offset < entries.length; offset += FRIEND_PROFILE_CONCURRENCY) {
|
||||
const batch = entries.slice(offset, offset + FRIEND_PROFILE_CONCURRENCY);
|
||||
const results = await Promise.allSettled(
|
||||
batch.map(async ({ friend }) => {
|
||||
const extra = await this.friendProfiles.get(friend.uin);
|
||||
friend.profile = { ...structuredClone(extra), ...friend.profile };
|
||||
}),
|
||||
);
|
||||
const errors = results.filter(
|
||||
(result): result is PromiseRejectedResult => result.status === 'rejected',
|
||||
);
|
||||
|
||||
if (errors.length > 0) {
|
||||
log.warn(
|
||||
'friend profile enrichment failed: batch=%d failures=%d elapsedMs=%d',
|
||||
offset,
|
||||
errors.length,
|
||||
Date.now() - started,
|
||||
);
|
||||
throw new AggregateError(
|
||||
errors.map((result) => result.reason),
|
||||
'friend profile enrichment failed',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
log.debug(
|
||||
'friend profiles loaded: friends=%d elapsedMs=%d',
|
||||
entries.length,
|
||||
Date.now() - started,
|
||||
);
|
||||
}
|
||||
|
||||
private async fetchFriendRoster(options: FriendListOptions = {}): Promise<FriendRoster> {
|
||||
const generation = ++this.friendRosterGeneration;
|
||||
const entries: FriendListPageEntry[] = [];
|
||||
const categories = new Map<number, FriendListPageCategory>();
|
||||
const seenCookies = new Set<string>();
|
||||
@@ -207,18 +290,25 @@ export class ContactsApi {
|
||||
cookie = next;
|
||||
}
|
||||
|
||||
const friends = entries.map((entry) => entry.friend);
|
||||
this.ctx.identity.rememberFriends(friends);
|
||||
if (options.withProfile) {
|
||||
await this.enrichFriendProfiles(entries);
|
||||
}
|
||||
|
||||
if (generation > this.rememberedFriendRosterGeneration) {
|
||||
this.ctx.identity.rememberFriends(entries.map((entry) => entry.friend));
|
||||
this.rememberedFriendRosterGeneration = generation;
|
||||
}
|
||||
|
||||
return { entries, categories: [...categories.values()] };
|
||||
}
|
||||
|
||||
async fetchFriendList(): Promise<FriendInfo[]> {
|
||||
const roster = await this.fetchFriendRoster();
|
||||
async fetchFriendList(options: FriendListOptions = {}): Promise<FriendInfo[]> {
|
||||
const roster = await this.fetchFriendRoster(options);
|
||||
return roster.entries.map((entry) => entry.friend);
|
||||
}
|
||||
|
||||
async fetchFriendCategories(): Promise<FriendCategoryInfo[]> {
|
||||
const roster = await this.fetchFriendRoster();
|
||||
async fetchFriendCategories(options: FriendListOptions = {}): Promise<FriendCategoryInfo[]> {
|
||||
const roster = await this.fetchFriendRoster(options);
|
||||
const buckets = new Map(
|
||||
roster.categories.map((category) => [category.categoryId, [] as FriendInfo[]]),
|
||||
);
|
||||
@@ -581,30 +671,51 @@ export class ContactsApi {
|
||||
return requests;
|
||||
}
|
||||
|
||||
/** Live observation write. IncomingPacketPipeline and tests only. */
|
||||
rememberGroupInviteCardSequence(groupUin: number, sequence: number): void {
|
||||
if (groupUin > 0 && sequence > 0) {
|
||||
this.groupInviteCardSeqs_.set(groupUin, sequence);
|
||||
async resolveGroupJoinRequest(
|
||||
groupId: number,
|
||||
uid: string,
|
||||
subType: 'add' | 'invite',
|
||||
invitedUid?: string,
|
||||
): Promise<GroupRequestInfo | null> {
|
||||
const [main, filtered] = await Promise.allSettled([
|
||||
this.fetchGroupRequestsByUid(false),
|
||||
this.fetchGroupRequestsByUid(true),
|
||||
]);
|
||||
|
||||
if (main.status === 'rejected') {
|
||||
throw main.reason;
|
||||
}
|
||||
|
||||
if (filtered.status === 'rejected') {
|
||||
throw filtered.reason;
|
||||
}
|
||||
|
||||
return (
|
||||
[...main.value, ...filtered.value].find((request) => {
|
||||
if (request.groupId !== groupId || request.state !== 1) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return subType === 'add'
|
||||
? request.eventType === 1 && request.targetUid === uid
|
||||
: (isSelfGroupInvitation(request) || request.eventType === 22) &&
|
||||
request.invitorUid === uid &&
|
||||
request.targetUid === invitedUid;
|
||||
}) ?? null
|
||||
);
|
||||
}
|
||||
|
||||
/** Returns whether this live card introduces a new approval sequence. */
|
||||
rememberGroupInviteCardSequence(groupId: number, sequence: number): boolean {
|
||||
return this.groupInvites.receiveCard(groupId, sequence);
|
||||
}
|
||||
|
||||
/** The approval msgseq captured from a private "qun.invite" card for this
|
||||
* group, or undefined if none was seen. `set_group_add_request` uses it to
|
||||
* approve a bot self-invite via 0x10c8 (eventType=2). See issue #125. */
|
||||
getGroupInviteCardSequence(groupId: number): number | undefined {
|
||||
return this.groupInviteCardSeqs_.get(groupId);
|
||||
return this.groupInvites.getCardSequence(groupId);
|
||||
}
|
||||
|
||||
/** Resolve the group for a private invite-card msgseq. Numeric OneBot flags
|
||||
* use this path because the card sequence is absent from 0x10C0. */
|
||||
findGroupInviteCardGroupBySequence(sequence: number): number | undefined {
|
||||
for (const [groupUin, rememberedSequence] of this.groupInviteCardSeqs_) {
|
||||
if (rememberedSequence === sequence) {
|
||||
return groupUin;
|
||||
}
|
||||
}
|
||||
|
||||
return undefined;
|
||||
findGroupInviteCardGroupBySequence(sequence: number, groupId?: number): number | undefined {
|
||||
return this.groupInvites.findCardGroup(sequence, groupId);
|
||||
}
|
||||
|
||||
async fetchDownloadRKeys(): Promise<DownloadRKeyInfo[]> {
|
||||
|
||||
69
packages/core/src/bridge/apis/forward-cache.ts
Normal file
69
packages/core/src/bridge/apis/forward-cache.ts
Normal file
@@ -0,0 +1,69 @@
|
||||
import { createLogger } from '@snowluma/common/logger';
|
||||
import type { ForwardNodePayload } from '@snowluma/protocol/events';
|
||||
|
||||
const MAX_CACHED_FORWARDS = 512;
|
||||
const log = createLogger('Bridge.Forward');
|
||||
type ForwardLayers = Map<string, ForwardNodePayload[]>;
|
||||
|
||||
interface ForwardCacheHit {
|
||||
rootId: string;
|
||||
resId: string;
|
||||
layers: ForwardLayers;
|
||||
nodes: ForwardNodePayload[];
|
||||
}
|
||||
|
||||
/** Nested results share the lifetime and recency of the result that supplied them. */
|
||||
export class ForwardResultCache {
|
||||
private readonly entries = new Map<string, ForwardLayers>();
|
||||
|
||||
get(resId: string): ForwardCacheHit | undefined {
|
||||
let hit: ForwardCacheHit | undefined;
|
||||
|
||||
// A nested result can be supplied by several retained outer results.
|
||||
for (const [rootId, layers] of this.entries) {
|
||||
const nodes = layers.get(resId);
|
||||
|
||||
if (nodes) {
|
||||
hit = { rootId, resId, layers, nodes };
|
||||
}
|
||||
}
|
||||
|
||||
if (hit) {
|
||||
this.entries.delete(hit.rootId);
|
||||
this.entries.set(hit.rootId, hit.layers);
|
||||
}
|
||||
|
||||
return hit;
|
||||
}
|
||||
|
||||
set(rootId: string, layers: ReadonlyMap<string, ForwardNodePayload[]>): void {
|
||||
if (!layers.has(rootId)) {
|
||||
throw new Error('forward cache entry is missing its outer result');
|
||||
}
|
||||
|
||||
this.entries.delete(rootId);
|
||||
this.entries.set(rootId, new Map(layers));
|
||||
|
||||
while (this.entries.size > MAX_CACHED_FORWARDS) {
|
||||
const oldest = this.entries.entries().next().value!;
|
||||
this.entries.delete(oldest[0]);
|
||||
log.trace(
|
||||
'forward cache evicted: res_id=%s layers=%d remaining=%d',
|
||||
oldest[0],
|
||||
oldest[1].size,
|
||||
this.entries.size,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
update(hit: ForwardCacheHit, nodes: ForwardNodePayload[]): void {
|
||||
// Enrichment may finish after eviction or replacement. It must not revive
|
||||
// an old result or turn a nested result into an independent cache entry.
|
||||
if (
|
||||
this.entries.get(hit.rootId) === hit.layers &&
|
||||
hit.layers.get(hit.resId) === hit.nodes
|
||||
) {
|
||||
hit.layers.set(hit.resId, nodes);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -25,16 +25,15 @@ import { randomUUID } from 'crypto';
|
||||
import { gunzipSync, gzipSync } from 'zlib';
|
||||
import type { Bridge } from '../bridge';
|
||||
import type { BridgeContext, UploadedFileMeta } from '../bridge-context';
|
||||
import { ForwardResultCache } from './forward-cache';
|
||||
import { resolveSelfUid, toInt } from './shared';
|
||||
|
||||
function asBridge(ctx: BridgeContext): Bridge {
|
||||
return ctx as unknown as Bridge;
|
||||
}
|
||||
|
||||
// Module-scoped cache, keyed by res_id. Survives only for the lifetime
|
||||
// of the process — that's enough because OneBot clients typically
|
||||
// resolve a forward immediately after receiving the parent message.
|
||||
const forwardResCache = new Map<string, ForwardNodePayload[]>();
|
||||
// Share within a bridge without retaining disconnected accounts.
|
||||
const forwardCaches = new WeakMap<BridgeContext, ForwardResultCache>();
|
||||
|
||||
const log = createLogger('Bridge.Forward');
|
||||
|
||||
@@ -77,6 +76,7 @@ interface ForwardUploadResult {
|
||||
// callers concatenate these to their own actions list so the
|
||||
// outermost upload carries the full tree.
|
||||
innerActions: ForwardInnerAction[];
|
||||
cachedLayers: Map<string, ForwardNodePayload[]>;
|
||||
}
|
||||
|
||||
// Local hex-decode helper — avoids importing the heavyweight `pipeline`
|
||||
@@ -353,7 +353,18 @@ function assertNoWindowShakeInForward(nodes: ForwardNodePayload[]): void {
|
||||
}
|
||||
|
||||
export class ForwardApi {
|
||||
constructor(private readonly ctx: BridgeContext) {}
|
||||
private readonly cache: ForwardResultCache;
|
||||
|
||||
constructor(private readonly ctx: BridgeContext) {
|
||||
let cache = forwardCaches.get(ctx);
|
||||
|
||||
if (!cache) {
|
||||
cache = new ForwardResultCache();
|
||||
forwardCaches.set(ctx, cache);
|
||||
}
|
||||
|
||||
this.cache = cache;
|
||||
}
|
||||
|
||||
async upload(nodes: ForwardNodePayload[], groupId?: number, userId?: number): Promise<string> {
|
||||
// Reject the complete recursive tree before identity resolution, media
|
||||
@@ -367,7 +378,8 @@ export class ForwardApi {
|
||||
assertPrivateForwardFileCapacity(nodes);
|
||||
}
|
||||
|
||||
const { resId } = await this.uploadRecursive(nodes, groupId, userId);
|
||||
const { resId, cachedLayers } = await this.uploadRecursive(nodes, groupId, userId);
|
||||
this.cache.set(resId, cachedLayers);
|
||||
return resId;
|
||||
}
|
||||
|
||||
@@ -593,6 +605,7 @@ export class ForwardApi {
|
||||
// — see `dev/NapCatQQ/.../SendMsg.ts:241-246` + the `uniseq` round-
|
||||
// trip in `dev/NapCatQQ/.../forward-msg-builder.ts:94`.
|
||||
const myInnerActions: ForwardInnerAction[] = [];
|
||||
const cachedLayers = new Map<string, ForwardNodePayload[]>();
|
||||
const processedNodes: ForwardNodePayload[] = [];
|
||||
const isGroup = groupId !== undefined;
|
||||
|
||||
@@ -605,6 +618,11 @@ export class ForwardApi {
|
||||
// and `inner.innerActions` already contains deeper layers.
|
||||
myInnerActions.push({ uuid: inner.uuid, msgBody: inner.msgBody });
|
||||
myInnerActions.push(...inner.innerActions);
|
||||
|
||||
for (const [resId, cached] of inner.cachedLayers) {
|
||||
cachedLayers.set(resId, cached);
|
||||
}
|
||||
|
||||
// Replace the inner placeholder element with a forward preview
|
||||
// pointing at the inner res_id. `forwardUuid: inner.uuid`
|
||||
// baked into the LightApp JSON's `meta.detail.uniseq` is what
|
||||
@@ -692,7 +710,7 @@ export class ForwardApi {
|
||||
throw new Error('upload forward message response missing res_id');
|
||||
}
|
||||
|
||||
forwardResCache.set(
|
||||
cachedLayers.set(
|
||||
resId,
|
||||
uploadReadyNodes.map((node) => ({
|
||||
...cloneNodeWithElements(node, node.elements.map(cacheableForwardElement)),
|
||||
@@ -714,20 +732,21 @@ export class ForwardApi {
|
||||
// from (1) — no separate fetch needed.
|
||||
uuid: randomUUID(),
|
||||
innerActions: myInnerActions,
|
||||
cachedLayers,
|
||||
};
|
||||
}
|
||||
|
||||
async fetch(resId: string): Promise<ForwardNodePayload[]> {
|
||||
const bridge = asBridge(this.ctx);
|
||||
const cached = forwardResCache.get(resId);
|
||||
const cached = this.cache.get(resId);
|
||||
|
||||
if (cached) {
|
||||
const nodes = cloneNodes(cached);
|
||||
const nodes = cloneNodes(cached.nodes);
|
||||
|
||||
// Inner nodes seeded by consumePiggybacks are cached un-enriched; enrich
|
||||
// Bundled inner nodes are cached un-enriched; enrich
|
||||
// on read (a no-op once names are present) and persist so later hits skip.
|
||||
if (await this.enrichSenders(nodes)) {
|
||||
forwardResCache.set(resId, cloneNodes(nodes));
|
||||
this.cache.update(cached, cloneNodes(nodes));
|
||||
}
|
||||
|
||||
return nodes;
|
||||
@@ -820,9 +839,7 @@ export class ForwardApi {
|
||||
// matching piggyback body, decode it into inner nodes, and seed
|
||||
// the cache by the inner resId so a follow-up `fetch(innerResId)`
|
||||
// hits the cache instead of the wire.
|
||||
if (piggybackByUuid.size > 0) {
|
||||
this.consumePiggybacks(nodes, piggybackByUuid);
|
||||
}
|
||||
const cachedLayers = this.collectForwardLayers(resId, nodes, piggybackByUuid);
|
||||
|
||||
// Fill sender nickname/card for nodes the SsoRecvLongMsg payload left empty
|
||||
// or stamped with the "QQ用户" placeholder (#174) — the long-msg member name
|
||||
@@ -830,7 +847,8 @@ export class ForwardApi {
|
||||
await this.enrichSenders(nodes);
|
||||
|
||||
if (nodes.length > 0) {
|
||||
forwardResCache.set(resId, cloneNodes(nodes));
|
||||
cachedLayers.set(resId, cloneNodes(nodes));
|
||||
this.cache.set(resId, cachedLayers);
|
||||
}
|
||||
|
||||
return nodes;
|
||||
@@ -1017,20 +1035,22 @@ export class ForwardApi {
|
||||
return out;
|
||||
}
|
||||
|
||||
/** Recursively resolve forward previews against the piggyback table.
|
||||
/** Resolve forward previews against the piggyback table.
|
||||
* For every `{type: 'forward', resId, forwardUuid}` element we find,
|
||||
* look up the uniseq in the piggyback map; if hit, decode the
|
||||
* inner msgBody and cache it by inner resId, then descend into that
|
||||
* inner layer to resolve deeper nestings carried in the SAME
|
||||
* piggyback set (NapCat hoists the entire tree's piggybacks onto
|
||||
* the outermost action list). */
|
||||
private consumePiggybacks(
|
||||
private collectForwardLayers(
|
||||
resId: string,
|
||||
nodes: ForwardNodePayload[],
|
||||
piggybackByUuid: Map<string, PushMsgBody[]>,
|
||||
): void {
|
||||
const seen = new Set<string>();
|
||||
): Map<string, ForwardNodePayload[]> {
|
||||
const layers = new Map([[resId, cloneNodes(nodes)]]);
|
||||
const decodedByUuid = new Map<string, ForwardNodePayload[]>();
|
||||
|
||||
const visit = (chain: ForwardNodePayload[]): void => {
|
||||
for (const chain of layers.values()) {
|
||||
for (const node of chain) {
|
||||
for (const elem of node.elements) {
|
||||
if (elem.type !== 'forward') {
|
||||
@@ -1040,25 +1060,33 @@ export class ForwardApi {
|
||||
const uuid = elem.forwardUuid;
|
||||
const innerResId = elem.resId;
|
||||
|
||||
if (!uuid || !innerResId || seen.has(uuid)) {
|
||||
if (!uuid || !innerResId || layers.has(innerResId)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const body = piggybackByUuid.get(uuid);
|
||||
const body =
|
||||
piggybackByUuid.get(uuid) ??
|
||||
(uuid.startsWith('MultiMsg_')
|
||||
? piggybackByUuid.get(uuid.slice('MultiMsg_'.length))
|
||||
: undefined);
|
||||
|
||||
if (!body) {
|
||||
continue;
|
||||
}
|
||||
|
||||
seen.add(uuid);
|
||||
const innerNodes = this.decodeMsgBodiesToNodes(body);
|
||||
forwardResCache.set(innerResId, cloneNodes(innerNodes));
|
||||
visit(innerNodes);
|
||||
let innerNodes = decodedByUuid.get(uuid);
|
||||
|
||||
if (!innerNodes) {
|
||||
innerNodes = cloneNodes(this.decodeMsgBodiesToNodes(body));
|
||||
decodedByUuid.set(uuid, innerNodes);
|
||||
}
|
||||
|
||||
layers.set(innerResId, innerNodes);
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
visit(nodes);
|
||||
return layers;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -8,6 +8,14 @@ import { MuteMember } from '@snowluma/protocol/oidb-services/group-admin/mute-me
|
||||
import { SetAddOption } from '@snowluma/protocol/oidb-services/group-admin/set-add-option';
|
||||
import { SetAddRequest } from '@snowluma/protocol/oidb-services/group-admin/set-add-request';
|
||||
import { SetAdmin } from '@snowluma/protocol/oidb-services/group-admin/set-admin';
|
||||
import { GetAdminPermissions } from '@snowluma/protocol/oidb-services/group-admin/get-admin-permissions';
|
||||
import { GetAdminReceiveVerify } from '@snowluma/protocol/oidb-services/group-admin/get-admin-receive-verify';
|
||||
import {
|
||||
SetAdminPermissions,
|
||||
type GroupAdminPermissionPatch,
|
||||
} from '@snowluma/protocol/oidb-services/group-admin/set-admin-permissions';
|
||||
import { SetAdminReceiveVerify } from '@snowluma/protocol/oidb-services/group-admin/set-admin-receive-verify';
|
||||
import { createLogger } from '@snowluma/common/logger';
|
||||
import { SetGroupName } from '@snowluma/protocol/oidb-services/group-admin/set-group-name';
|
||||
import { SetGroupRemark } from '@snowluma/protocol/oidb-services/group-admin/set-group-remark';
|
||||
import { SetMemberCard } from '@snowluma/protocol/oidb-services/group-admin/set-member-card';
|
||||
@@ -39,6 +47,8 @@ import { ModifyGroupExtInfo } from '@snowluma/protocol/oidb-services/group-admin
|
||||
import { OidbError } from '@snowluma/protocol/oidb-service';
|
||||
import type { BridgeContext } from '../bridge-context';
|
||||
|
||||
const log = createLogger('Bridge.GroupAdmin');
|
||||
|
||||
/** QQ only accepts this write from the group owner (#411). */
|
||||
export const MEMBER_PERMISSIONS_OWNER_ONLY =
|
||||
'only the group owner can change group member permissions';
|
||||
@@ -343,6 +353,62 @@ export class GroupAdminApi {
|
||||
return SetAdmin.invoke(this.ctx, { groupId, userId, enable });
|
||||
}
|
||||
|
||||
async getAdminPermissions(groupId: number, userId: number) {
|
||||
const logger = log.child({ uin: Number(this.ctx.identity.uin) });
|
||||
logger.debug('Reading administrator permissions group=%s user=%s', groupId, userId);
|
||||
const [snapshot, receiveVerify] = await Promise.all([
|
||||
GetAdminPermissions.invoke(this.ctx, { groupId, userId }),
|
||||
GetAdminReceiveVerify.invoke(this.ctx, { groupId, userId }),
|
||||
]);
|
||||
logger.debug(
|
||||
'Administrator permissions received group=%s user=%s recall=%s kick=%s limit=%s receiveVerify=%s',
|
||||
groupId,
|
||||
userId,
|
||||
snapshot.recallMemberMessage,
|
||||
snapshot.kickMember,
|
||||
snapshot.kickMemberPerDay,
|
||||
receiveVerify,
|
||||
);
|
||||
return {
|
||||
group_id: groupId,
|
||||
user_id: userId,
|
||||
recall_member_message: snapshot.recallMemberMessage,
|
||||
kick_member: snapshot.kickMember,
|
||||
kick_member_per_day: snapshot.kickMemberPerDay,
|
||||
receive_verify: receiveVerify,
|
||||
};
|
||||
}
|
||||
|
||||
async setAdminPermissions(
|
||||
groupId: number,
|
||||
userId: number,
|
||||
patch: GroupAdminPermissionPatch,
|
||||
): Promise<void> {
|
||||
const logger = log.child({ uin: Number(this.ctx.identity.uin) });
|
||||
logger.debug(
|
||||
'Setting administrator permissions group=%s user=%s recall=%s kick=%s limit=%s',
|
||||
groupId,
|
||||
userId,
|
||||
patch.recallMemberMessage,
|
||||
patch.kickMember,
|
||||
patch.kickMemberPerDay,
|
||||
);
|
||||
await SetAdminPermissions.invoke(this.ctx, { groupId, userId, ...patch });
|
||||
logger.debug('Administrator permissions acknowledged group=%s user=%s', groupId, userId);
|
||||
}
|
||||
|
||||
async setAdminReceiveVerify(groupId: number, userId: number, enable: boolean): Promise<void> {
|
||||
const logger = log.child({ uin: Number(this.ctx.identity.uin) });
|
||||
logger.debug(
|
||||
'Setting administrator receive-verify group=%s user=%s enable=%s',
|
||||
groupId,
|
||||
userId,
|
||||
enable,
|
||||
);
|
||||
await SetAdminReceiveVerify.invoke(this.ctx, { groupId, userId, enable });
|
||||
logger.debug('Administrator receive-verify confirmed group=%s user=%s', groupId, userId);
|
||||
}
|
||||
|
||||
setCard(groupId: number, userId: number, card: string): Promise<void> {
|
||||
return SetMemberCard.invoke(this.ctx, { groupId, userId, card });
|
||||
}
|
||||
|
||||
@@ -400,14 +400,11 @@ export class GroupFileApi {
|
||||
try {
|
||||
await this.publish(groupId, fileId);
|
||||
} catch (err) {
|
||||
// The bytes are already on the server and the fileId is valid —
|
||||
// fail loud but don't lose the upload result the action handler
|
||||
// committed to returning. Callers can still resolve the file by
|
||||
// id; they'll just have to re-publish it themselves.
|
||||
log.warn(
|
||||
'group file uploaded (fileId=%s) but chat post failed: %s',
|
||||
fileId,
|
||||
err instanceof Error ? err.message : String(err),
|
||||
// Keep the completed upload identifiable, but a requested chat
|
||||
// publication must not be reported as a successful send.
|
||||
throw new Error(
|
||||
`group file uploaded (fileId=${fileId}) but chat post failed: ${err instanceof Error ? err.message : String(err)}`,
|
||||
{ cause: err },
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@ import type {
|
||||
SsoReadedReportReq,
|
||||
SsoReadedReportResp,
|
||||
} from '@snowluma/proto-defs/oidb-actions/base';
|
||||
import { buildSendElems } from '@snowluma/protocol/element-builder';
|
||||
import { buildSendElems, encodePrivateRichText } from '@snowluma/protocol/element-builder';
|
||||
import { assertWindowShakeSendPolicy } from '@snowluma/protocol/element-manifest';
|
||||
import { FinalizeOfflineFile } from '@snowluma/protocol/oidb-services/group-file/finalize-offline-file';
|
||||
import { datalineTextFromElements, encodeDatalineText } from '@snowluma/protocol/dataline/codec';
|
||||
@@ -22,7 +22,7 @@ import {
|
||||
fetchC2cRoamMessagePage,
|
||||
fetchGroupMessageRange,
|
||||
} from '@snowluma/protocol/msg-push';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import { type bytes, protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import { createLogger } from '@snowluma/common/logger';
|
||||
import type { SendPacketResult } from '@snowluma/common/packet-sender';
|
||||
import type { BridgeContext } from '../bridge-context';
|
||||
@@ -254,6 +254,7 @@ type FriendMessage = Extract<QQEventVariant, { kind: 'friend_message' }>;
|
||||
// ── Group-history fetch guards (the server frequency-limits / kicks abusive
|
||||
// pulls, so keep each request small, bound the loop, and space the sends). ──
|
||||
const HISTORY_MAX_COUNT = 200; // hard cap on messages returned per call
|
||||
const PRIVATE_HISTORY_PAGE_SIZE = 100;
|
||||
const HISTORY_CHUNK_SEQ = 30; // sequence span per server request (small packet)
|
||||
const HISTORY_MAX_REQUESTS = 12; // bound the walk-back loop
|
||||
const HISTORY_MIN_GAP_MS = 300; // minimum spacing between SsoGetGroupMsg sends
|
||||
@@ -547,15 +548,15 @@ export class MessageApi {
|
||||
userUid = await this.ctx.resolveUserUid(userUin);
|
||||
}
|
||||
|
||||
const protoElems = await buildSendElems(elements, {
|
||||
bridge: this.ctx as unknown as Bridge,
|
||||
const richText = await encodePrivateRichText(elements, {
|
||||
bridge: this.ctx,
|
||||
userUid,
|
||||
scene: 'direct-private',
|
||||
});
|
||||
const random = this.ctx.nextMessageRandom();
|
||||
const clientSeq = this.ctx.nextClientSequence();
|
||||
|
||||
const request = protobuf_encode<SendMessageRequest>({
|
||||
const request = protobuf_encode<SendMessageRequest<bytes>>({
|
||||
routingHead: {
|
||||
c2c: {
|
||||
uin: userUin,
|
||||
@@ -567,11 +568,7 @@ export class MessageApi {
|
||||
subType: 0,
|
||||
c2cCmd: 11,
|
||||
},
|
||||
messageBody: {
|
||||
richText: {
|
||||
elems: protoElems,
|
||||
},
|
||||
},
|
||||
messageBody: { richText },
|
||||
clientSequence: clientSeq,
|
||||
random,
|
||||
syncCookie: new Uint8Array(0),
|
||||
@@ -1543,7 +1540,7 @@ export class MessageApi {
|
||||
selfUin,
|
||||
friendUid,
|
||||
cursor.time,
|
||||
want - collected.size,
|
||||
Math.min(want - collected.size, PRIVATE_HISTORY_PAGE_SIZE),
|
||||
cursor.random,
|
||||
),
|
||||
);
|
||||
@@ -1564,7 +1561,7 @@ export class MessageApi {
|
||||
break;
|
||||
}
|
||||
|
||||
if (page.cursor.time === 0 && page.cursor.random === 0) {
|
||||
if (page.isComplete || (page.cursor.time === 0 && page.cursor.random === 0)) {
|
||||
reachedEnd = true;
|
||||
break;
|
||||
}
|
||||
@@ -1572,11 +1569,6 @@ export class MessageApi {
|
||||
const nextCursorKey = `${page.cursor.time}:${page.cursor.random}`;
|
||||
|
||||
if (seenCursors.has(nextCursorKey)) {
|
||||
if (page.messages.length === 0) {
|
||||
reachedEnd = true;
|
||||
break;
|
||||
}
|
||||
|
||||
throw new Error(
|
||||
`private roam history cursor did not advance from ${cursor.time}/${cursor.random}`,
|
||||
);
|
||||
|
||||
@@ -1,33 +1,187 @@
|
||||
import type { JsonObject } from '@snowluma/common/json';
|
||||
import {
|
||||
commentQzoneMsg,
|
||||
deleteQzoneMsg,
|
||||
getQzoneFeeds,
|
||||
getQzoneMsgDetail,
|
||||
getQzoneMsgList,
|
||||
getQzoneProfile,
|
||||
publishQzoneMsg,
|
||||
replyQzoneComment,
|
||||
setQzoneBlack,
|
||||
setQzoneLike,
|
||||
setQzoneProfile,
|
||||
updateQzoneMsgRight,
|
||||
uploadQzoneImageFromSource,
|
||||
type QzoneCommentResult,
|
||||
type QzoneFeedsResult,
|
||||
type QzoneFeedsPage,
|
||||
type QzoneMsgDetailResult,
|
||||
type QzoneMsgListResult,
|
||||
type QzoneProfile,
|
||||
type QzoneProfileUpdate,
|
||||
type QzonePublishResult,
|
||||
type QzoneReplyTarget,
|
||||
type QzoneUpdateRightResult,
|
||||
type QzoneUploadImageResult,
|
||||
} from '@snowluma/protocol/web/qzone';
|
||||
import {
|
||||
getQzonePublicCapabilities,
|
||||
getQzoneHomeFeeds,
|
||||
getQzoneFeedDetail,
|
||||
type QzoneFeedDetail,
|
||||
getQzoneShareArk,
|
||||
type QzoneShareArk,
|
||||
getQzonePublicFeeds,
|
||||
getQzonePublicFeedDetail,
|
||||
getQzonePublicComments,
|
||||
getQzonePublicReplies,
|
||||
setQzonePublicUpvote,
|
||||
setQzonePublicLike,
|
||||
setQzonePublicCommentLike,
|
||||
commentQzonePublicFeed,
|
||||
replyQzonePublicFeed,
|
||||
deleteQzonePublicComment,
|
||||
deleteQzonePublicReply,
|
||||
setQzonePublicFollow,
|
||||
forwardQzonePublicFeed,
|
||||
type QzonePublicContent,
|
||||
type QzonePublicFeedsPage,
|
||||
} from '@snowluma/protocol/web/qzone-public';
|
||||
import type { BridgeContext } from '../bridge-context';
|
||||
|
||||
/**
|
||||
* Personal QQ-Zone (个人空间) web API: 说说 (feed) read/write, likes,
|
||||
* comments, image upload — all over the cookie-backed qzone.qq.com CGIs,
|
||||
* Personal QQ-Zone (个人空间) web API: 说说, public recommendations, likes,
|
||||
* comments and image upload over the cookie-backed Qzone web interfaces,
|
||||
* reusing the same `getCookies('qzone.qq.com')` plumbing as GroupAlbumApi.
|
||||
* Distinct from the group-album surface, which lives on GroupAlbumApi.
|
||||
*/
|
||||
export class QzoneApi {
|
||||
constructor(private readonly ctx: BridgeContext) {}
|
||||
|
||||
async getProfile(targetUin?: number): Promise<QzoneProfile> {
|
||||
const cookieObject = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzoneProfile(cookieObject, this.ctx.identity.uin, targetUin?.toString());
|
||||
}
|
||||
|
||||
async setProfile(profile: QzoneProfileUpdate): Promise<void> {
|
||||
const cookieObject = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
await setQzoneProfile(cookieObject, this.ctx.identity.uin, profile);
|
||||
}
|
||||
|
||||
async getPublicCapabilities(): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzonePublicCapabilities(cookies, this.ctx.identity.uin);
|
||||
}
|
||||
|
||||
async getPublicFeeds(cursor?: string): Promise<QzonePublicFeedsPage> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzonePublicFeeds(cookies, this.ctx.identity.uin, cursor);
|
||||
}
|
||||
|
||||
async getHomeFeeds(targetUin?: number, cursor?: string): Promise<QzonePublicFeedsPage> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzoneHomeFeeds(cookies, this.ctx.identity.uin, targetUin?.toString(), cursor);
|
||||
}
|
||||
|
||||
async getFeedDetail(tid: string): Promise<QzoneFeedDetail> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzoneFeedDetail(cookies, tid);
|
||||
}
|
||||
|
||||
async getShareArk(feed: JsonObject): Promise<QzoneShareArk> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzoneShareArk(cookies, feed);
|
||||
}
|
||||
|
||||
async getPublicFeedDetail(feed: JsonObject): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzonePublicFeedDetail(cookies, feed);
|
||||
}
|
||||
|
||||
async getPublicComments(feed: JsonObject, cursor: string): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzonePublicComments(cookies, feed, cursor);
|
||||
}
|
||||
|
||||
async getPublicReplies(
|
||||
feed: JsonObject,
|
||||
comment: JsonObject,
|
||||
cursor = '',
|
||||
pageSize = 20,
|
||||
): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzonePublicReplies(cookies, feed, comment, cursor, pageSize);
|
||||
}
|
||||
|
||||
async setPublicUpvote(feed: JsonObject, enable = true): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return setQzonePublicUpvote(cookies, feed, enable);
|
||||
}
|
||||
|
||||
async setPublicLike(feed: JsonObject, enable = true): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return setQzonePublicLike(cookies, feed, enable);
|
||||
}
|
||||
|
||||
async setPublicCommentLike(
|
||||
feed: JsonObject,
|
||||
comment: JsonObject,
|
||||
enable = true,
|
||||
reply?: JsonObject,
|
||||
): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return setQzonePublicCommentLike(cookies, feed, comment, enable, reply);
|
||||
}
|
||||
|
||||
async commentPublicFeed(feed: JsonObject, content: QzonePublicContent): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
const user = {
|
||||
uin: this.ctx.identity.uin,
|
||||
uid: this.ctx.identity.selfUid ?? '',
|
||||
nick: this.ctx.identity.nickname,
|
||||
};
|
||||
return commentQzonePublicFeed(cookies, feed, user, content);
|
||||
}
|
||||
|
||||
async replyPublicFeed(
|
||||
feed: JsonObject,
|
||||
comment: JsonObject,
|
||||
content: QzonePublicContent,
|
||||
reply?: JsonObject,
|
||||
): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
const user = {
|
||||
uin: this.ctx.identity.uin,
|
||||
uid: this.ctx.identity.selfUid ?? '',
|
||||
nick: this.ctx.identity.nickname,
|
||||
};
|
||||
return replyQzonePublicFeed(cookies, feed, user, comment, content, reply);
|
||||
}
|
||||
|
||||
async deletePublicComment(feed: JsonObject, comment: JsonObject): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return deleteQzonePublicComment(cookies, feed, comment);
|
||||
}
|
||||
|
||||
async deletePublicReply(
|
||||
feed: JsonObject,
|
||||
comment: JsonObject,
|
||||
reply: JsonObject,
|
||||
): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return deleteQzonePublicReply(cookies, feed, comment, reply);
|
||||
}
|
||||
|
||||
async setPublicFollow(feed: JsonObject, enable = true): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return setQzonePublicFollow(cookies, feed, enable);
|
||||
}
|
||||
|
||||
async forwardPublicFeed(feed: JsonObject, reason = ''): Promise<JsonObject> {
|
||||
const cookies = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return forwardQzonePublicFeed(cookies, feed, reason);
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取说说列表。`targetUin` 省略时取机器人自己的空间。
|
||||
* `pos` 为起始偏移,`num` 为本页数量(服务端上限约 20/页)。
|
||||
@@ -51,12 +205,12 @@ export class QzoneApi {
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取好友动态(feed)。`pageNum` 为 1 起的页码,`count` 为本页数量。
|
||||
* 获取好友动态。页码调用从首页顺序定位;续页优先传上一页的 cursor。
|
||||
* 始终以机器人自己的身份拉取好友动态。
|
||||
*/
|
||||
async getFeeds(pageNum = 1, count = 10): Promise<QzoneFeedsResult> {
|
||||
async getFeeds(pageNum = 1, count = 10, cursor?: string): Promise<QzoneFeedsPage> {
|
||||
const cookieObject = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
return getQzoneFeeds(cookieObject, this.ctx.identity.uin, pageNum, count);
|
||||
return getQzoneFeeds(cookieObject, this.ctx.identity.uin, pageNum, count, cursor);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -133,6 +287,7 @@ export class QzoneApi {
|
||||
* 始终以机器人身份发表评论。返回新评论 id(尽力而为)。
|
||||
* `richType` / `richval`: 带图评论时传 richType=1 和图片直链 URL
|
||||
* (从 uploadImageFromSource 的 url 字段获取)。
|
||||
* `reply` 指定父评论及可选回复对象;楼中楼回复仅支持文字。
|
||||
*/
|
||||
async comment(
|
||||
tid: string,
|
||||
@@ -140,10 +295,20 @@ export class QzoneApi {
|
||||
targetUin: number | undefined,
|
||||
richType?: number,
|
||||
richval?: string,
|
||||
reply?: QzoneReplyTarget,
|
||||
): Promise<QzoneCommentResult> {
|
||||
if (reply !== undefined && (richType !== undefined || richval !== undefined)) {
|
||||
throw new Error('images are not supported for Qzone comment replies');
|
||||
}
|
||||
|
||||
const selfUin = this.ctx.identity.uin;
|
||||
const owner = targetUin && targetUin > 0 ? targetUin.toString() : selfUin;
|
||||
const cookieObject = await this.ctx.apis.web.getCookies('qzone.qq.com');
|
||||
|
||||
if (reply !== undefined) {
|
||||
return replyQzoneComment(cookieObject, selfUin, owner, tid, content, reply);
|
||||
}
|
||||
|
||||
return commentQzoneMsg(cookieObject, selfUin, owner, tid, content, richType, richval);
|
||||
}
|
||||
|
||||
|
||||
@@ -4,7 +4,13 @@ import { packetTimeoutMs } from '@snowluma/bridge/packet-timeout';
|
||||
import type { PacketInfo } from '@snowluma/common/protocol-types';
|
||||
import { BridgeEventBus } from '@snowluma/protocol/event-bus';
|
||||
import { IdentityService } from '@snowluma/protocol/identity-service';
|
||||
import { MSG_PUSH_CMD, parseMsgPushOrThrow, SysMsgDedup } from '@snowluma/protocol/msg-push';
|
||||
import {
|
||||
MSG_PUSH_CMD,
|
||||
parseMsgPushOrThrow,
|
||||
SysMsgDedup,
|
||||
decodeClientMessageReceipt,
|
||||
fetchClientMessage,
|
||||
} from '@snowluma/protocol/msg-push';
|
||||
import { KICK_NT_CMD, parseKickNT } from '@snowluma/protocol/kick-nt';
|
||||
import { IncomingPacketPipeline, type CmdParser } from '@snowluma/protocol/packet-pipeline';
|
||||
import type { OnlineDeviceInfo } from '@snowluma/protocol/events';
|
||||
@@ -38,6 +44,10 @@ export class Bridge implements BridgeInterface {
|
||||
private onlineClients_: readonly Readonly<OnlineDeviceInfo>[] | null = null;
|
||||
private disposePromise_: Promise<void> | null = null;
|
||||
private readonly pendingPackets_ = new Set<Promise<void>>();
|
||||
private readonly clientMessageTasks_ = new Map<
|
||||
string,
|
||||
{ connection: ProcessConnection; work: Promise<void> }
|
||||
>();
|
||||
private rosterWarmupStarted_ = false;
|
||||
private settleRosterWarmup!: (result: RosterWarmupResult) => void;
|
||||
private readonly rosterWarmup = new Promise<RosterWarmupResult>((resolve) => {
|
||||
@@ -61,72 +71,9 @@ export class Bridge implements BridgeInterface {
|
||||
fetchGroupMemberList: async (groupId) => {
|
||||
await this.apis.contacts.fetchGroupMemberList(groupId);
|
||||
},
|
||||
resolveGroupJoinRequest: async (groupId, uid, subType) => {
|
||||
const [main, filtered] = await Promise.allSettled([
|
||||
this.apis.contacts.fetchGroupRequestsByUid(false),
|
||||
this.apis.contacts.fetchGroupRequestsByUid(true),
|
||||
]);
|
||||
|
||||
if (main.status === 'rejected') {
|
||||
log.warn(
|
||||
'group-request enrichment main inbox failed: group=%d uid=%s err=%s',
|
||||
groupId,
|
||||
uid,
|
||||
main.reason instanceof Error ? main.reason.message : String(main.reason),
|
||||
);
|
||||
}
|
||||
|
||||
if (filtered.status === 'rejected') {
|
||||
log.warn(
|
||||
'group-request enrichment filtered inbox failed: group=%d uid=%s err=%s',
|
||||
groupId,
|
||||
uid,
|
||||
filtered.reason instanceof Error
|
||||
? filtered.reason.message
|
||||
: String(filtered.reason),
|
||||
);
|
||||
}
|
||||
|
||||
if (main.status === 'rejected' && filtered.status === 'rejected') {
|
||||
throw new Error('failed to fetch group requests from both inboxes');
|
||||
}
|
||||
|
||||
const requests = [
|
||||
...(main.status === 'fulfilled' ? main.value : []),
|
||||
...(filtered.status === 'fulfilled' ? filtered.value : []),
|
||||
];
|
||||
const matches = requests.filter((r) => {
|
||||
if (r.groupId !== groupId) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return subType === 'invite' ? r.invitorUid === uid : r.targetUid === uid;
|
||||
});
|
||||
|
||||
if (subType === 'invite') {
|
||||
return matches.find((r) => r.notifyType === 1) ?? matches[0] ?? null;
|
||||
}
|
||||
|
||||
return matches.find((r) => r.notifyType === 7) ?? matches[0] ?? null;
|
||||
},
|
||||
resolveGroupInviteCardSequence: async (groupId) => {
|
||||
const deadline = Date.now() + 1_000;
|
||||
|
||||
do {
|
||||
const sequence = this.apis.contacts.getGroupInviteCardSequence(groupId);
|
||||
|
||||
if (sequence) {
|
||||
return sequence;
|
||||
}
|
||||
|
||||
await new Promise((resolve) => setTimeout(resolve, 25));
|
||||
} while (Date.now() < deadline);
|
||||
|
||||
return null;
|
||||
},
|
||||
rememberGroupInviteCardSequence: (groupUin, sequence) => {
|
||||
this.apis.contacts.rememberGroupInviteCardSequence(groupUin, sequence);
|
||||
},
|
||||
resolveGroupJoinRequest: (groupId, uid, subType, invitedUid) =>
|
||||
this.apis.contacts.resolveGroupJoinRequest(groupId, uid, subType, invitedUid),
|
||||
groupInvites: this.apis.contacts.groupInvites,
|
||||
});
|
||||
this.pipeline.registerCmd(MSG_PUSH_CMD, (pkt, identity) =>
|
||||
parseMsgPushOrThrow(pkt, identity, this.sysMsgDedup_),
|
||||
@@ -173,9 +120,13 @@ export class Bridge implements BridgeInterface {
|
||||
|
||||
bindPid(pid: number, client: PacketSender): void {
|
||||
const previous = this.activeConnection;
|
||||
const existing = this.connections.get(pid);
|
||||
this.connections.delete(pid);
|
||||
// A new login stays healthy until the watchdog confirms a failure.
|
||||
this.connections.set(pid, { pid, client, receiveHealthy: true });
|
||||
const connection =
|
||||
existing?.client === client ? existing : { pid, client, receiveHealthy: true };
|
||||
connection.receiveHealthy = true;
|
||||
this.connections.set(pid, connection);
|
||||
|
||||
if (previous?.pid !== pid || previous.client !== client) {
|
||||
runtimeLog.trace(
|
||||
@@ -252,12 +203,85 @@ export class Bridge implements BridgeInterface {
|
||||
return Promise.reject(new Error('Bridge is disposed'));
|
||||
}
|
||||
|
||||
const work = this.identity.initialization.then(() => this.pipeline.process(pkt));
|
||||
const connection = this.connections.get(pkt.pid);
|
||||
const work = this.identity.initialization.then(() =>
|
||||
pkt.source === 'client-message'
|
||||
? this.processClientMessage(pkt, connection)
|
||||
: this.pipeline.process(pkt),
|
||||
);
|
||||
this.pendingPackets_.add(work);
|
||||
void work.finally(() => this.pendingPackets_.delete(work)).catch(() => undefined);
|
||||
return work;
|
||||
}
|
||||
|
||||
private async processClientMessage(
|
||||
pkt: PacketInfo,
|
||||
connection: ProcessConnection | undefined,
|
||||
): Promise<void> {
|
||||
const requireConnection = (): ProcessConnection => {
|
||||
if (
|
||||
this.disposePromise_ ||
|
||||
!connection ||
|
||||
this.connections.get(pkt.pid) !== connection
|
||||
) {
|
||||
throw new Error('Client message receipt belongs to an inactive connection');
|
||||
}
|
||||
|
||||
return connection;
|
||||
};
|
||||
|
||||
const current = requireConnection();
|
||||
const receipt = decodeClientMessageReceipt(pkt, this.identity.uin);
|
||||
const key = JSON.stringify([
|
||||
pkt.pid,
|
||||
receipt.peerUid,
|
||||
receipt.sequence,
|
||||
receipt.clientSequence,
|
||||
receipt.timestamp,
|
||||
]);
|
||||
const pending = this.clientMessageTasks_.get(key);
|
||||
|
||||
if (pending?.connection === current) {
|
||||
return pending.work;
|
||||
}
|
||||
|
||||
if (this.clientMessageTasks_.size >= 256) {
|
||||
throw new Error('Too many pending client message lookups');
|
||||
}
|
||||
|
||||
runtimeLog.trace(
|
||||
'client_message_lookup_start uin=%j pid=%d seqId=%d',
|
||||
this.identity.uin,
|
||||
pkt.pid,
|
||||
pkt.seqId,
|
||||
);
|
||||
const work = (async () => {
|
||||
const source: PacketSender = {
|
||||
sendPacket: (cmd, body, timeout) =>
|
||||
requireConnection().client.sendPacket(cmd, body, timeout),
|
||||
};
|
||||
const event = await fetchClientMessage(source, this.identity, receipt);
|
||||
requireConnection();
|
||||
await this.pipeline.processEvents(pkt, [event]);
|
||||
runtimeLog.trace(
|
||||
'client_message_lookup_complete uin=%j pid=%d seqId=%d',
|
||||
this.identity.uin,
|
||||
pkt.pid,
|
||||
pkt.seqId,
|
||||
);
|
||||
})();
|
||||
const task = { connection: current, work };
|
||||
this.clientMessageTasks_.set(key, task);
|
||||
|
||||
try {
|
||||
await work;
|
||||
} finally {
|
||||
if (this.clientMessageTasks_.get(key) === task) {
|
||||
this.clientMessageTasks_.delete(key);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
rememberUploadedFile(meta: UploadedFileMeta): void {
|
||||
if (!meta.fileId) {
|
||||
return;
|
||||
|
||||
@@ -434,7 +434,13 @@ export class BridgeManager implements BridgeSessionSource {
|
||||
}
|
||||
|
||||
const closing = this.closingSessions_.get(uin);
|
||||
const beforeOpen = closing ? Promise.all(closing).then(() => undefined) : undefined;
|
||||
// allSettled, not all: a failed close stays in the bookkeeping (so
|
||||
// dispose can still report it) but must not reject this gate — a
|
||||
// rejected gate would keep the identity DB of every future session
|
||||
// for this UIN closed until the process restarts.
|
||||
const beforeOpen = closing
|
||||
? Promise.allSettled(closing).then(() => undefined)
|
||||
: undefined;
|
||||
const bridge = new Bridge(IdentityService.openForUin(uin, 'data', beforeOpen));
|
||||
this.bridges.set(uin, bridge);
|
||||
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { getRuntimeIntegrity, HookManager } from '@snowluma/bridge';
|
||||
import { APP_VERSION } from '@snowluma/common/version';
|
||||
import { configureFileTransport } from '@snowluma/common/log-file-transport';
|
||||
import { closeLogger, createLogger } from '@snowluma/common/logger';
|
||||
import {
|
||||
@@ -23,7 +22,6 @@ import { createNotificationManager } from './notifications/manager';
|
||||
import { createStateWiring } from './webui/state-wiring';
|
||||
import { initWebUI } from './webui/server';
|
||||
import { bindSystemFaceCatalog } from './sys-face-catalog';
|
||||
import { startNativeStageSync, tempStagePath } from './native-stage-sync';
|
||||
import { logRuntimeIntegrity } from './runtime-integrity-log';
|
||||
import { RESTART_EXIT_CODE, runApplication } from './update/startup';
|
||||
|
||||
@@ -60,11 +58,6 @@ async function main() {
|
||||
});
|
||||
log.info('SnowLuma starting');
|
||||
logRuntimeIntegrity(await getRuntimeIntegrity());
|
||||
const stopNativeStageSync = startNativeStageSync({
|
||||
version: APP_VERSION,
|
||||
dataDir: 'data',
|
||||
tempPath: tempStagePath(),
|
||||
});
|
||||
|
||||
// One-shot: lift a legacy per-UIN musicSignUrl into the global store before
|
||||
// any session (and thus any per-UIN config rewrite) can drop it.
|
||||
@@ -193,16 +186,6 @@ async function main() {
|
||||
);
|
||||
}
|
||||
|
||||
try {
|
||||
stopNativeStageSync.stop();
|
||||
} catch (error) {
|
||||
exitCode = 1;
|
||||
log.error(
|
||||
'stage sync shutdown failed: %s',
|
||||
error instanceof Error ? error.message : String(error),
|
||||
);
|
||||
}
|
||||
|
||||
try {
|
||||
hookManager.dispose();
|
||||
} catch (error) {
|
||||
|
||||
@@ -1,347 +0,0 @@
|
||||
import {
|
||||
readFileSync,
|
||||
writeFileSync,
|
||||
mkdirSync,
|
||||
statSync,
|
||||
openSync,
|
||||
readSync,
|
||||
closeSync,
|
||||
fstatSync,
|
||||
} from 'node:fs';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { createLogger, type Logger } from '@snowluma/common/logger';
|
||||
|
||||
export const STAGE_FILE_NAME = 's7.log';
|
||||
export const MIRROR_LIMIT_BYTES = 1024 * 1024;
|
||||
|
||||
const VERSION_HEADER = /^v\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/;
|
||||
|
||||
export function isVersionHeader(line: string): boolean {
|
||||
return VERSION_HEADER.test(line);
|
||||
}
|
||||
|
||||
export function lineSeverity(line: string): 'info' | 'error' {
|
||||
const parts = line.trim().split(/\s+/);
|
||||
return parts.length >= 4 && parts[3] === '1' ? 'error' : 'info';
|
||||
}
|
||||
|
||||
export function publicLine(version: string, raw: string): string {
|
||||
return `${version} ${raw.trim()}`;
|
||||
}
|
||||
|
||||
function byteSize(lines: readonly string[]): number {
|
||||
if (lines.length === 0) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
return Buffer.byteLength(`${lines.join('\n')}\n`, 'utf8');
|
||||
}
|
||||
|
||||
export function trimMirror(text: string, limit = MIRROR_LIMIT_BYTES): string {
|
||||
const lines = text.split('\n').filter((line) => line.length > 0);
|
||||
const size = () => byteSize(lines);
|
||||
|
||||
while (lines.length > 0 && size() > limit) {
|
||||
const body = lines.findIndex((line) => !isVersionHeader(line));
|
||||
|
||||
if (body >= 0) {
|
||||
lines.splice(body, 1);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (lines.length <= 1) {
|
||||
break;
|
||||
}
|
||||
|
||||
lines.shift();
|
||||
}
|
||||
|
||||
if (lines.length === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return `${lines.join('\n')}\n`;
|
||||
}
|
||||
|
||||
export function appendEvents(
|
||||
mirror: string,
|
||||
version: string,
|
||||
events: readonly string[],
|
||||
limit = MIRROR_LIMIT_BYTES,
|
||||
): string {
|
||||
const fresh = events.map((line) => line.trim()).filter((line) => line.length > 0);
|
||||
|
||||
if (fresh.length === 0) {
|
||||
return mirror;
|
||||
}
|
||||
|
||||
const header = `v${version}`;
|
||||
const lines = mirror.split('\n').filter((line) => line.length > 0);
|
||||
let lastHeader = '';
|
||||
|
||||
for (const line of lines) {
|
||||
if (isVersionHeader(line)) {
|
||||
lastHeader = line;
|
||||
}
|
||||
}
|
||||
|
||||
const next = [...lines];
|
||||
|
||||
if (lastHeader !== header) {
|
||||
next.push(header);
|
||||
}
|
||||
|
||||
next.push(...fresh);
|
||||
return trimMirror(`${next.join('\n')}\n`, limit);
|
||||
}
|
||||
|
||||
export function tempStagePath(
|
||||
platform = process.platform,
|
||||
env: NodeJS.ProcessEnv = process.env,
|
||||
): string {
|
||||
if (platform === 'win32') {
|
||||
const base = env.TMP || env.TEMP || os.tmpdir();
|
||||
return path.join(base, STAGE_FILE_NAME);
|
||||
}
|
||||
|
||||
const uid = typeof process.getuid === 'function' ? process.getuid() : 0;
|
||||
return `/tmp/sl-${uid}/${STAGE_FILE_NAME}`;
|
||||
}
|
||||
|
||||
export function errorCode(error: unknown): string {
|
||||
if (error && typeof error === 'object' && 'code' in error) {
|
||||
const code = (error as { code?: unknown }).code;
|
||||
|
||||
if (typeof code === 'string' && code) {
|
||||
return code;
|
||||
}
|
||||
}
|
||||
|
||||
return 'ERR';
|
||||
}
|
||||
|
||||
export interface StageSyncOptions {
|
||||
version: string;
|
||||
dataDir: string;
|
||||
tempPath: string;
|
||||
log?: Logger;
|
||||
intervalMs?: number;
|
||||
}
|
||||
|
||||
interface IngestResult {
|
||||
mirror: string;
|
||||
offset: number;
|
||||
lines: string[];
|
||||
missing: boolean;
|
||||
errorCode?: string;
|
||||
}
|
||||
|
||||
export function ingestTemp(args: {
|
||||
tempText: string;
|
||||
offset: number;
|
||||
mirror: string;
|
||||
version: string;
|
||||
missing?: boolean;
|
||||
errorCode?: string;
|
||||
}): IngestResult {
|
||||
if (args.missing) {
|
||||
return { mirror: args.mirror, offset: args.offset, lines: [], missing: true };
|
||||
}
|
||||
|
||||
if (args.errorCode) {
|
||||
return {
|
||||
mirror: args.mirror,
|
||||
offset: args.offset,
|
||||
lines: [],
|
||||
missing: false,
|
||||
errorCode: args.errorCode,
|
||||
};
|
||||
}
|
||||
|
||||
const start = args.offset > args.tempText.length ? 0 : args.offset;
|
||||
const chunk = args.tempText.slice(start);
|
||||
const newline = chunk.lastIndexOf('\n');
|
||||
|
||||
if (newline < 0) {
|
||||
return { mirror: args.mirror, offset: start, lines: [], missing: false };
|
||||
}
|
||||
|
||||
const complete = chunk.slice(0, newline + 1);
|
||||
const lines = complete
|
||||
.split('\n')
|
||||
.map((line) => line.trim())
|
||||
.filter((line) => line.length > 0);
|
||||
return {
|
||||
mirror: appendEvents(args.mirror, args.version, lines),
|
||||
offset: start + newline + 1,
|
||||
lines,
|
||||
missing: false,
|
||||
};
|
||||
}
|
||||
|
||||
function readOffset(file: string): number {
|
||||
try {
|
||||
const raw = readFileSync(file, 'utf8').trim();
|
||||
const value = Number(raw);
|
||||
return Number.isSafeInteger(value) && value >= 0 ? value : 0;
|
||||
} catch {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
function readTemp(file: string): { text: string; missing: boolean; errorCode?: string } {
|
||||
let fd: number | undefined;
|
||||
|
||||
try {
|
||||
fd = openSync(file, 'r');
|
||||
const info = fstatSync(fd);
|
||||
const size = info.size;
|
||||
|
||||
if (size > 8 * 1024 * 1024) {
|
||||
return { text: '', missing: false, errorCode: 'E2BIG' };
|
||||
}
|
||||
|
||||
const buf = Buffer.alloc(size);
|
||||
let got = 0;
|
||||
|
||||
while (got < size) {
|
||||
const n = readSync(fd, buf, got, size - got, got);
|
||||
|
||||
if (n <= 0) {
|
||||
break;
|
||||
}
|
||||
|
||||
got += n;
|
||||
}
|
||||
|
||||
return { text: buf.subarray(0, got).toString('utf8'), missing: false };
|
||||
} catch (error) {
|
||||
const code = errorCode(error);
|
||||
|
||||
if (code === 'ENOENT') {
|
||||
return { text: '', missing: true };
|
||||
}
|
||||
|
||||
return { text: '', missing: false, errorCode: code };
|
||||
} finally {
|
||||
if (fd !== undefined) {
|
||||
closeSync(fd);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function startNativeStageSync(options: StageSyncOptions): { stop: () => void } {
|
||||
const log = options.log ?? createLogger('native');
|
||||
const mirrorPath = path.join(options.dataDir, STAGE_FILE_NAME);
|
||||
const offsetPath = path.join(options.dataDir, 's7.off');
|
||||
let offset = readOffset(offsetPath);
|
||||
let failed = false;
|
||||
let stopped = false;
|
||||
|
||||
const tick = () => {
|
||||
if (stopped) {
|
||||
return;
|
||||
}
|
||||
|
||||
let tempSize = 0;
|
||||
|
||||
try {
|
||||
tempSize = statSync(options.tempPath).size;
|
||||
} catch (error) {
|
||||
const code = errorCode(error);
|
||||
|
||||
if (code === 'ENOENT') {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!failed) {
|
||||
failed = true;
|
||||
log.error('sync failed %s', code);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (tempSize < offset) {
|
||||
offset = 0;
|
||||
}
|
||||
|
||||
const temp = readTemp(options.tempPath);
|
||||
|
||||
if (temp.missing) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (temp.errorCode) {
|
||||
if (!failed) {
|
||||
failed = true;
|
||||
log.error('sync failed %s', temp.errorCode);
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
let mirror = '';
|
||||
|
||||
try {
|
||||
mirror = readFileSync(mirrorPath, 'utf8');
|
||||
} catch (error) {
|
||||
if (errorCode(error) !== 'ENOENT') {
|
||||
if (!failed) {
|
||||
failed = true;
|
||||
log.error('sync failed %s', errorCode(error));
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
const ingested = ingestTemp({
|
||||
tempText: temp.text,
|
||||
offset,
|
||||
mirror,
|
||||
version: options.version,
|
||||
});
|
||||
|
||||
if (ingested.lines.length === 0 && ingested.offset === offset) {
|
||||
failed = false;
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
mkdirSync(options.dataDir, { recursive: true });
|
||||
writeFileSync(mirrorPath, ingested.mirror);
|
||||
writeFileSync(offsetPath, `${ingested.offset}\n`);
|
||||
offset = ingested.offset;
|
||||
failed = false;
|
||||
} catch (error) {
|
||||
if (!failed) {
|
||||
failed = true;
|
||||
log.error('sync failed %s', errorCode(error));
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
for (const line of ingested.lines) {
|
||||
const text = publicLine(options.version, line);
|
||||
|
||||
if (lineSeverity(line) === 'error') {
|
||||
log.error('%s', text);
|
||||
} else {
|
||||
log.info('%s', text);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
tick();
|
||||
const timer = setInterval(tick, options.intervalMs ?? 500);
|
||||
timer.unref();
|
||||
return {
|
||||
stop() {
|
||||
stopped = true;
|
||||
clearInterval(timer);
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -2,10 +2,12 @@ import { APP_VERSION } from '@snowluma/common/version';
|
||||
import { compareVersions, parseVersion } from '@snowluma/common/semver';
|
||||
import { createLogger } from '@snowluma/common/logger';
|
||||
import { createSingleFlightCache } from '@snowluma/common/single-flight-cache';
|
||||
import type { UpdateSourceConfig } from '@snowluma/common/update-source';
|
||||
import { fetchRelease } from './release';
|
||||
import { readUpdateSource } from './sources';
|
||||
|
||||
const log = createLogger('Update');
|
||||
|
||||
const LATEST_RELEASE_URL = 'https://api.github.com/repos/SnowLuma/SnowLuma/releases/latest';
|
||||
const CACHE_TTL_MS = 6 * 60 * 60 * 1000; // 6h — comfortably under the rate limit
|
||||
const FETCH_TIMEOUT_MS = 8_000;
|
||||
const NOTES_MAX = 4_000; // cap the release-body we hand back to the client
|
||||
@@ -29,13 +31,6 @@ export interface UpdateCheckResult {
|
||||
error?: string;
|
||||
}
|
||||
|
||||
interface GithubRelease {
|
||||
tag_name?: string;
|
||||
html_url?: string;
|
||||
body?: string;
|
||||
published_at?: string;
|
||||
}
|
||||
|
||||
function isEnabled(): boolean {
|
||||
const v = (process.env.SNOWLUMA_UPDATE_CHECK ?? '').trim().toLowerCase();
|
||||
return v !== '0' && v !== 'false' && v !== 'off' && v !== 'no';
|
||||
@@ -47,8 +42,10 @@ function isEnabled(): boolean {
|
||||
const updateCache = createSingleFlightCache<string, UpdateCheckResult>({
|
||||
ttlMs: CACHE_TTL_MS,
|
||||
shouldCache: (r) => !r.error,
|
||||
load: async (current) => {
|
||||
const result = await fetchLatest(current);
|
||||
load: async (key) => {
|
||||
// This key is constructed below from our version and normalized settings.
|
||||
const [current, source] = JSON.parse(key) as [string, UpdateSourceConfig];
|
||||
const result = await fetchLatest(current, source);
|
||||
|
||||
if (result.error) {
|
||||
log.debug('update check failed: %s', result.error);
|
||||
@@ -60,7 +57,10 @@ const updateCache = createSingleFlightCache<string, UpdateCheckResult>({
|
||||
},
|
||||
});
|
||||
|
||||
async function fetchLatest(current: string): Promise<UpdateCheckResult> {
|
||||
async function fetchLatest(
|
||||
current: string,
|
||||
source: UpdateSourceConfig,
|
||||
): Promise<UpdateCheckResult> {
|
||||
const base: UpdateCheckResult = {
|
||||
current,
|
||||
latest: null,
|
||||
@@ -74,21 +74,19 @@ async function fetchLatest(current: string): Promise<UpdateCheckResult> {
|
||||
try {
|
||||
// `/releases/latest` already excludes drafts and prereleases, so this is
|
||||
// stable-channel by construction.
|
||||
const res = await fetch(LATEST_RELEASE_URL, {
|
||||
headers: {
|
||||
Accept: 'application/vnd.github+json',
|
||||
'User-Agent': `SnowLuma/${current}`,
|
||||
'X-GitHub-Api-Version': '2022-11-28',
|
||||
},
|
||||
signal: AbortSignal.timeout(FETCH_TIMEOUT_MS),
|
||||
});
|
||||
const { data: rel } = await fetchRelease(
|
||||
undefined,
|
||||
source,
|
||||
`SnowLuma/${current}`,
|
||||
FETCH_TIMEOUT_MS,
|
||||
);
|
||||
|
||||
if (!res.ok) {
|
||||
return { ...base, error: `github ${res.status}` };
|
||||
if (!rel || typeof rel !== 'object' || Array.isArray(rel)) {
|
||||
return { ...base, error: 'invalid release info' };
|
||||
}
|
||||
|
||||
const rel = (await res.json()) as GithubRelease;
|
||||
const tag = typeof rel.tag_name === 'string' ? rel.tag_name.trim() : '';
|
||||
const tag =
|
||||
'tag_name' in rel && typeof rel.tag_name === 'string' ? rel.tag_name.trim() : '';
|
||||
|
||||
if (!tag) {
|
||||
return { ...base, error: 'no tag' };
|
||||
@@ -104,9 +102,15 @@ async function fetchLatest(current: string): Promise<UpdateCheckResult> {
|
||||
current,
|
||||
latest,
|
||||
hasUpdate: compareVersions(latest, current) > 0,
|
||||
htmlUrl: rel.html_url ?? null,
|
||||
notes: rel.body ? rel.body.slice(0, NOTES_MAX) : null,
|
||||
publishedAt: rel.published_at ?? null,
|
||||
htmlUrl: 'html_url' in rel && typeof rel.html_url === 'string' ? rel.html_url : null,
|
||||
notes:
|
||||
'body' in rel && typeof rel.body === 'string' && rel.body
|
||||
? rel.body.slice(0, NOTES_MAX)
|
||||
: null,
|
||||
publishedAt:
|
||||
'published_at' in rel && typeof rel.published_at === 'string'
|
||||
? rel.published_at
|
||||
: null,
|
||||
checkedAt: Date.now(),
|
||||
};
|
||||
} catch (e) {
|
||||
@@ -120,14 +124,26 @@ async function fetchLatest(current: string): Promise<UpdateCheckResult> {
|
||||
* failures come back as a result with `error` set and `hasUpdate: false`, and
|
||||
* are not cached so the next check retries.
|
||||
*/
|
||||
export async function getUpdateInfo(force = false): Promise<UpdateCheckResult> {
|
||||
export async function getUpdateInfo(
|
||||
force = false,
|
||||
source?: UpdateSourceConfig,
|
||||
): Promise<UpdateCheckResult> {
|
||||
const current = APP_VERSION;
|
||||
|
||||
if (!isEnabled()) {
|
||||
return { ...emptyResult(current), error: 'disabled' };
|
||||
}
|
||||
|
||||
return updateCache.get(current, { force });
|
||||
try {
|
||||
return await updateCache.get(JSON.stringify([current, source ?? readUpdateSource()]), {
|
||||
force,
|
||||
});
|
||||
} catch (error) {
|
||||
return {
|
||||
...emptyResult(current),
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
function emptyResult(current: string): UpdateCheckResult {
|
||||
|
||||
@@ -1,43 +1,30 @@
|
||||
import { createHash } from 'node:crypto';
|
||||
import { createWriteStream } from 'node:fs';
|
||||
import { mkdir, readFile, writeFile } from 'node:fs/promises';
|
||||
import { mkdir, readFile, writeFile, rm } from 'node:fs/promises';
|
||||
import path from 'node:path';
|
||||
import { Readable, Transform } from 'node:stream';
|
||||
import { pipeline } from 'node:stream/promises';
|
||||
import { unzipSync } from 'fflate';
|
||||
import { x as extractTar } from 'tar';
|
||||
import { isRuntimeEntry, readManifest } from './files';
|
||||
import { assetName, fetchRelease } from './release';
|
||||
export { assetName } from './release';
|
||||
import { readUpdateSource, sourceUrls } from './sources';
|
||||
import type { UpdateSourceConfig } from '@snowluma/common/update-source';
|
||||
|
||||
interface ReleaseAsset {
|
||||
url: string;
|
||||
size: number;
|
||||
size: number | null;
|
||||
digest: string;
|
||||
}
|
||||
|
||||
export function assetName(version: string, target: string): string {
|
||||
const platform = target.replace('win32', 'win');
|
||||
return `SnowLuma-v${version}-${platform}-lite.${target.startsWith('win32') ? 'zip' : 'tar.gz'}`;
|
||||
}
|
||||
|
||||
async function releaseAsset(version: string, target: string): Promise<ReleaseAsset> {
|
||||
async function releaseAsset(
|
||||
version: string,
|
||||
target: string,
|
||||
source: UpdateSourceConfig,
|
||||
): Promise<ReleaseAsset> {
|
||||
const name = assetName(version, target);
|
||||
const response = await fetch(
|
||||
`https://api.github.com/repos/SnowLuma/SnowLuma/releases/tags/v${version}`,
|
||||
{
|
||||
headers: {
|
||||
Accept: 'application/vnd.github+json',
|
||||
'User-Agent': 'SnowLuma',
|
||||
'X-GitHub-Api-Version': '2022-11-28',
|
||||
},
|
||||
signal: AbortSignal.timeout(15_000),
|
||||
},
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
throw new Error(`获取更新失败: GitHub ${response.status}`);
|
||||
}
|
||||
|
||||
const release: unknown = await response.json();
|
||||
const { data: release, fromPage } = await fetchRelease(version, source);
|
||||
|
||||
if (
|
||||
!release ||
|
||||
@@ -58,9 +45,10 @@ async function releaseAsset(version: string, target: string): Promise<ReleaseAss
|
||||
!asset ||
|
||||
typeof asset !== 'object' ||
|
||||
!('size' in asset) ||
|
||||
typeof asset.size !== 'number' ||
|
||||
!Number.isSafeInteger(asset.size) ||
|
||||
asset.size <= 0 ||
|
||||
!(
|
||||
(fromPage && asset.size === null) ||
|
||||
(typeof asset.size === 'number' && Number.isSafeInteger(asset.size) && asset.size > 0)
|
||||
) ||
|
||||
!('digest' in asset) ||
|
||||
typeof asset.digest !== 'string' ||
|
||||
!/^sha256:[a-f0-9]{64}$/.test(asset.digest)
|
||||
@@ -94,37 +82,98 @@ export async function downloadUpdate(
|
||||
directory: string,
|
||||
version: string,
|
||||
target: string,
|
||||
source = readUpdateSource(),
|
||||
): Promise<void> {
|
||||
const asset = await releaseAsset(version, target);
|
||||
const response = await fetch(asset.url, { signal: AbortSignal.timeout(10 * 60_000) });
|
||||
|
||||
if (!response.ok || !response.body) {
|
||||
throw new Error(`下载更新失败: HTTP ${response.status}`);
|
||||
}
|
||||
|
||||
const asset = await releaseAsset(version, target, source);
|
||||
const archive = path.join(directory, 'archive');
|
||||
const hash = createHash('sha256');
|
||||
let received = 0;
|
||||
await pipeline(
|
||||
Readable.fromWeb(response.body),
|
||||
new Transform({
|
||||
transform(chunk: Buffer, _encoding, callback) {
|
||||
received += chunk.length;
|
||||
const urls = sourceUrls(asset.url, source);
|
||||
const failures: string[] = [];
|
||||
|
||||
if (received > asset.size) {
|
||||
callback(new Error('更新包大小不匹配'));
|
||||
return;
|
||||
}
|
||||
for (const [index, url] of urls.entries()) {
|
||||
let created = false;
|
||||
|
||||
hash.update(chunk);
|
||||
callback(null, chunk);
|
||||
},
|
||||
}),
|
||||
createWriteStream(archive, { flags: 'wx' }),
|
||||
);
|
||||
try {
|
||||
const headersTimeout = new AbortController();
|
||||
const timer = setTimeout(() => headersTimeout.abort(), 8_000);
|
||||
let response: Response;
|
||||
|
||||
if (received !== asset.size || `sha256:${hash.digest('hex')}` !== asset.digest) {
|
||||
throw new Error('更新包校验失败');
|
||||
try {
|
||||
response = await fetch(url, {
|
||||
signal: AbortSignal.any([
|
||||
headersTimeout.signal,
|
||||
AbortSignal.timeout(10 * 60_000),
|
||||
]),
|
||||
});
|
||||
} finally {
|
||||
clearTimeout(timer);
|
||||
}
|
||||
|
||||
if (!response.ok || !response.body) {
|
||||
await response.body?.cancel();
|
||||
throw new Error(`下载更新失败: HTTP ${response.status}`);
|
||||
}
|
||||
|
||||
if (/text\/html/i.test(response.headers.get('content-type') ?? '')) {
|
||||
await response.body.cancel();
|
||||
throw new Error('下载源返回了 HTML 页面,而不是更新包');
|
||||
}
|
||||
|
||||
const hash = createHash('sha256');
|
||||
const length = response.headers.get('content-length');
|
||||
const size =
|
||||
asset.size ?? (length === null ? null : /^\d+$/.test(length) ? Number(length) : 0);
|
||||
|
||||
if (size !== null && (!Number.isSafeInteger(size) || size <= 0)) {
|
||||
await response.body.cancel();
|
||||
throw new Error('下载源返回了无效的更新包大小');
|
||||
}
|
||||
|
||||
let received = 0;
|
||||
const output = createWriteStream(archive, { flags: 'wx' });
|
||||
output.once('open', () => {
|
||||
created = true;
|
||||
});
|
||||
await pipeline(
|
||||
Readable.fromWeb(response.body),
|
||||
new Transform({
|
||||
transform(chunk: Buffer, _encoding, callback) {
|
||||
received += chunk.length;
|
||||
|
||||
if (received > (size ?? 256 * 1024 * 1024)) {
|
||||
callback(new Error('更新包大小不匹配'));
|
||||
return;
|
||||
}
|
||||
|
||||
hash.update(chunk);
|
||||
callback(null, chunk);
|
||||
},
|
||||
}),
|
||||
output,
|
||||
);
|
||||
|
||||
if (
|
||||
(size !== null && received !== size) ||
|
||||
`sha256:${hash.digest('hex')}` !== asset.digest
|
||||
) {
|
||||
throw new Error('更新包校验失败');
|
||||
}
|
||||
|
||||
break;
|
||||
} catch (error) {
|
||||
if (error && typeof error === 'object' && 'code' in error && error.code === 'EEXIST') {
|
||||
throw error;
|
||||
}
|
||||
|
||||
failures.push(error instanceof Error ? error.message : String(error));
|
||||
|
||||
if (index === urls.length - 1) {
|
||||
throw new Error([...new Set(failures)].join(';'));
|
||||
}
|
||||
|
||||
if (created) {
|
||||
await rm(archive);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const payload = path.join(directory, 'payload');
|
||||
|
||||
196
packages/core/src/update/release.ts
Normal file
196
packages/core/src/update/release.ts
Normal file
@@ -0,0 +1,196 @@
|
||||
import { parseVersion } from '@snowluma/common/semver';
|
||||
import type { UpdateSourceConfig } from '@snowluma/common/update-source';
|
||||
import { RELEASE_ROOT, sourceUrls } from './sources';
|
||||
|
||||
export function assetName(version: string, target: string): string {
|
||||
const platform = target.replace('win32', 'win');
|
||||
return `SnowLuma-v${version}-${platform}-lite.${target.startsWith('win32') ? 'zip' : 'tar.gz'}`;
|
||||
}
|
||||
|
||||
async function readText(response: Response, limit: number): Promise<string> {
|
||||
if (!response.body) {
|
||||
throw new Error('发布信息为空');
|
||||
}
|
||||
|
||||
const reader = response.body.getReader();
|
||||
const chunks: Uint8Array[] = [];
|
||||
let size = 0;
|
||||
|
||||
try {
|
||||
for (;;) {
|
||||
const { value, done } = await reader.read();
|
||||
|
||||
if (done) {
|
||||
break;
|
||||
}
|
||||
|
||||
size += value.length;
|
||||
|
||||
if (size > limit) {
|
||||
await reader.cancel();
|
||||
throw new Error('发布信息过大');
|
||||
}
|
||||
|
||||
chunks.push(value);
|
||||
}
|
||||
} finally {
|
||||
reader.releaseLock();
|
||||
}
|
||||
|
||||
return Buffer.concat(chunks).toString('utf8');
|
||||
}
|
||||
|
||||
function attribute(tag: string, name: string): string | undefined {
|
||||
return new RegExp(`\\s${name}\\s*=\\s*(["'])(.*?)\\1`, 'i')
|
||||
.exec(tag)?.[2]
|
||||
.replaceAll('&', '&')
|
||||
.replaceAll(''', "'")
|
||||
.replaceAll('"', '"');
|
||||
}
|
||||
|
||||
export function parseLatestReleasePage(html: string) {
|
||||
const meta = html
|
||||
.match(/<meta\b[^>]*>/gi)
|
||||
?.find((tag) => attribute(tag, 'property') === 'og:url');
|
||||
const canonical = meta && attribute(meta, 'content');
|
||||
|
||||
if (!canonical) {
|
||||
throw new Error('发布页面缺少版本信息');
|
||||
}
|
||||
|
||||
const url = new URL(canonical, 'https://github.com');
|
||||
const tag = /^\/SnowLuma\/SnowLuma\/releases\/tag\/([^/]+)$/.exec(url.pathname)?.[1];
|
||||
const decoded = tag && decodeURIComponent(tag);
|
||||
const version = decoded?.startsWith('v') ? decoded.slice(1) : undefined;
|
||||
const parsed = parseVersion(version);
|
||||
|
||||
if (url.origin !== 'https://github.com' || !parsed || parsed.prerelease.length) {
|
||||
throw new Error('发布页面不是 SnowLuma 正式版本');
|
||||
}
|
||||
|
||||
return { tag_name: `v${parsed.raw}`, html_url: `${RELEASE_ROOT}/tag/v${parsed.raw}` };
|
||||
}
|
||||
|
||||
/** Match the digest in the same asset row; never borrow a neighbouring asset's hash. */
|
||||
export function parseReleaseAssetsPage(html: string, version: string) {
|
||||
const assets: { name: string; size: null; digest: string }[] = [];
|
||||
const expected = ['win32-x64', 'linux-x64', 'linux-arm64'].map((target) =>
|
||||
assetName(version, target),
|
||||
);
|
||||
|
||||
for (const row of html.match(/<li\b[^>]*>[\s\S]*?<\/li>/gi) ?? []) {
|
||||
const links = row.match(/<a\b[^>]*>/gi) ?? [];
|
||||
const name = expected.find((candidate) =>
|
||||
links.some((link) => {
|
||||
const href = attribute(link, 'href');
|
||||
return (
|
||||
href === `/SnowLuma/SnowLuma/releases/download/v${version}/${candidate}` ||
|
||||
href === `${RELEASE_ROOT}/download/v${version}/${candidate}`
|
||||
);
|
||||
}),
|
||||
);
|
||||
|
||||
if (!name) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const digests = (row.match(/<clipboard-copy\b[^>]*>/gi) ?? [])
|
||||
.map((tag) => attribute(tag, 'value'))
|
||||
.filter((value): value is string =>
|
||||
Boolean(value && /^sha256:[a-f0-9]{64}$/.test(value)),
|
||||
);
|
||||
|
||||
if (digests.length !== 1 || assets.some((asset) => asset.name === name)) {
|
||||
throw new Error('发布页面缺少唯一的文件校验信息');
|
||||
}
|
||||
|
||||
// GitHub renders a rounded size in HTML. Verify the exact digest even
|
||||
// when a proxy streams the asset without Content-Length.
|
||||
assets.push({ name, size: null, digest: digests[0]! });
|
||||
}
|
||||
|
||||
if (!assets.length) {
|
||||
throw new Error('发布页面没有可验证的更新包');
|
||||
}
|
||||
|
||||
return { tag_name: `v${version}`, assets };
|
||||
}
|
||||
|
||||
export interface ReleaseResult {
|
||||
data: unknown;
|
||||
fromPage: boolean;
|
||||
}
|
||||
|
||||
export async function fetchRelease(
|
||||
version: string | undefined,
|
||||
source: UpdateSourceConfig,
|
||||
userAgent = 'SnowLuma',
|
||||
timeoutMs = 8_000,
|
||||
): Promise<ReleaseResult> {
|
||||
const apiUrl = `https://api.github.com/repos/SnowLuma/SnowLuma/releases/${version ? `tags/v${version}` : 'latest'}`;
|
||||
let primaryError: unknown;
|
||||
|
||||
try {
|
||||
const response = await fetch(apiUrl, {
|
||||
headers: {
|
||||
Accept: 'application/vnd.github+json',
|
||||
'User-Agent': userAgent,
|
||||
'X-GitHub-Api-Version': '2022-11-28',
|
||||
},
|
||||
signal: AbortSignal.timeout(timeoutMs),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
await response.body?.cancel();
|
||||
throw new Error(`GitHub ${response.status}`);
|
||||
}
|
||||
|
||||
return {
|
||||
data: JSON.parse(await readText(response, 256 * 1024)) as unknown,
|
||||
fromPage: false,
|
||||
};
|
||||
} catch (error) {
|
||||
primaryError = error;
|
||||
}
|
||||
|
||||
const originalUrl = version
|
||||
? `${RELEASE_ROOT}/expanded_assets/v${version}`
|
||||
: `${RELEASE_ROOT}/latest`;
|
||||
const controller = new AbortController();
|
||||
|
||||
try {
|
||||
// Only a parsed release page can win. Fast errors and HTML interstitials
|
||||
// cannot cancel a slower working source.
|
||||
// Download proxies often only support assets. Always retain GitHub's
|
||||
// release page for version/digest lookup, even with a pinned download mirror.
|
||||
const urls = [...new Set([originalUrl, ...sourceUrls(originalUrl, source)])];
|
||||
const data = await Promise.any(
|
||||
urls.map(async (url) => {
|
||||
const response = await fetch(url, {
|
||||
signal: AbortSignal.any([controller.signal, AbortSignal.timeout(timeoutMs)]),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
await response.body?.cancel();
|
||||
throw new Error(`HTTP ${response.status}`);
|
||||
}
|
||||
|
||||
const html = await readText(response, 1024 * 1024);
|
||||
return version
|
||||
? parseReleaseAssetsPage(html, version)
|
||||
: parseLatestReleasePage(html);
|
||||
}),
|
||||
);
|
||||
return { data, fromPage: true };
|
||||
} catch (error) {
|
||||
const failures = error instanceof AggregateError ? error.errors : [error];
|
||||
const details = [primaryError, ...failures]
|
||||
.filter(Boolean)
|
||||
.map((failure: unknown) =>
|
||||
failure instanceof Error ? failure.message : String(failure),
|
||||
);
|
||||
throw new Error(`${[...new Set(details)].join(';')};请在更新来源中检测或指定可用镜像`);
|
||||
} finally {
|
||||
controller.abort();
|
||||
}
|
||||
}
|
||||
125
packages/core/src/update/sources.ts
Normal file
125
packages/core/src/update/sources.ts
Normal file
@@ -0,0 +1,125 @@
|
||||
import { APP_VERSION } from '@snowluma/common/version';
|
||||
import { readRuntimeConfig, updateRuntimeConfig } from '@snowluma/common/runtime';
|
||||
import {
|
||||
normalizeUpdateSourceConfig,
|
||||
type UpdateSourceConfig,
|
||||
} from '@snowluma/common/update-source';
|
||||
|
||||
export const RELEASE_ROOT = 'https://github.com/SnowLuma/SnowLuma/releases';
|
||||
export const DEFAULT_UPDATE_SOURCE: UpdateSourceConfig = {
|
||||
mode: 'auto',
|
||||
mirror: '',
|
||||
mirrors: [
|
||||
'https://ghfast.top',
|
||||
'https://ghproxy.net',
|
||||
'https://gh-proxy.com',
|
||||
'https://github.chenc.dev',
|
||||
'https://fastgit.cc',
|
||||
'https://gh.noki.icu',
|
||||
'https://cors.isteed.cc',
|
||||
'https://gh-proxy.org',
|
||||
'https://githubproxy.gohj99.site',
|
||||
'https://github.xxlab.tech',
|
||||
],
|
||||
};
|
||||
|
||||
export function readUpdateSource(): UpdateSourceConfig {
|
||||
return normalizeUpdateSourceConfig(readRuntimeConfig().updateSource ?? DEFAULT_UPDATE_SOURCE);
|
||||
}
|
||||
|
||||
export function saveUpdateSource(value: unknown): UpdateSourceConfig {
|
||||
const config = normalizeUpdateSourceConfig(value);
|
||||
updateRuntimeConfig({ updateSource: config });
|
||||
return config;
|
||||
}
|
||||
|
||||
export function sourceUrls(url: string, config: UpdateSourceConfig): string[] {
|
||||
if (config.mode === 'direct') {
|
||||
return [url];
|
||||
}
|
||||
|
||||
if (config.mode === 'mirror') {
|
||||
return [`${config.mirror}/${url}`];
|
||||
}
|
||||
|
||||
return [url, ...config.mirrors.map((mirror) => `${mirror}/${url}`)];
|
||||
}
|
||||
|
||||
export interface MirrorProbeResult {
|
||||
mirror: string;
|
||||
available: boolean;
|
||||
latencyMs: number;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
export async function testUpdateSources(value: unknown): Promise<MirrorProbeResult[]> {
|
||||
const config = normalizeUpdateSourceConfig(value);
|
||||
const mirrors = [
|
||||
...new Set(['', ...config.mirrors, ...(config.mirror ? [config.mirror] : [])]),
|
||||
];
|
||||
const target = process.platform === 'win32' ? 'win-x64' : `linux-${process.arch}`;
|
||||
const extension = process.platform === 'win32' ? 'zip' : 'tar.gz';
|
||||
const probeUrl = `${RELEASE_ROOT}/download/v${APP_VERSION}/SnowLuma-v${APP_VERSION}-${target}-lite.${extension}`;
|
||||
const results = await Promise.all(
|
||||
mirrors.map(async (mirror): Promise<MirrorProbeResult> => {
|
||||
const start = performance.now();
|
||||
|
||||
try {
|
||||
const response = await fetch(mirror ? `${mirror}/${probeUrl}` : probeUrl, {
|
||||
headers: { Range: 'bytes=0-3' },
|
||||
signal: AbortSignal.timeout(5_000),
|
||||
});
|
||||
|
||||
if (!response.ok || !response.body) {
|
||||
await response.body?.cancel();
|
||||
throw new Error(`HTTP ${response.status}`);
|
||||
}
|
||||
|
||||
if (/text\/html/i.test(response.headers.get('content-type') ?? '')) {
|
||||
await response.body.cancel();
|
||||
throw new Error('返回了 HTML 页面,而不是更新包');
|
||||
}
|
||||
|
||||
const reader = response.body.getReader();
|
||||
const prefix: number[] = [];
|
||||
|
||||
try {
|
||||
while (prefix.length < 4) {
|
||||
const { value, done } = await reader.read();
|
||||
|
||||
if (done) {
|
||||
break;
|
||||
}
|
||||
|
||||
prefix.push(...value.subarray(0, 4 - prefix.length));
|
||||
}
|
||||
} finally {
|
||||
await reader.cancel();
|
||||
reader.releaseLock();
|
||||
}
|
||||
|
||||
const signature = extension === 'zip' ? [0x50, 0x4b, 0x03, 0x04] : [0x1f, 0x8b];
|
||||
|
||||
if (!signature.every((byte, index) => prefix[index] === byte)) {
|
||||
throw new Error('返回内容不是有效的更新包');
|
||||
}
|
||||
|
||||
return {
|
||||
mirror,
|
||||
available: true,
|
||||
latencyMs: Math.round(performance.now() - start),
|
||||
};
|
||||
} catch (error) {
|
||||
return {
|
||||
mirror,
|
||||
available: false,
|
||||
latencyMs: Math.round(performance.now() - start),
|
||||
error: error instanceof Error ? error.message : String(error),
|
||||
};
|
||||
}
|
||||
}),
|
||||
);
|
||||
return results.sort(
|
||||
(a, b) => Number(b.available) - Number(a.available) || a.latencyMs - b.latencyMs,
|
||||
);
|
||||
}
|
||||
@@ -527,6 +527,10 @@ function prepareGlobalSettingsJson(
|
||||
const normalized = normalizeGlobalSettings(raw);
|
||||
const canonical: Record<string, unknown> = { rkey: normalized.rkey };
|
||||
|
||||
if (isPlainObject(raw) && Object.prototype.hasOwnProperty.call(raw, 'videoUploadConcurrency')) {
|
||||
canonical.videoUploadConcurrency = normalized.videoUploadConcurrency;
|
||||
}
|
||||
|
||||
// Missing is the existing one-shot migration sentinel: startup scans legacy
|
||||
// onebot*.json only until snowluma.json first carries this key.
|
||||
if (isPlainObject(raw) && Object.prototype.hasOwnProperty.call(raw, 'musicSignUrl')) {
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { APP_VERSION } from '@snowluma/common/version';
|
||||
import { serve } from '@hono/node-server';
|
||||
import { serveStatic } from '@hono/node-server/serve-static';
|
||||
import { resolveWebuiTarget } from '@snowluma/common/webui-target';
|
||||
import { registerStaticFrontend } from './static-frontend';
|
||||
import type { HookManager, HookProcessInfo } from '@snowluma/bridge';
|
||||
import { getRuntimeIntegrity, hasLowProcessIntegrity } from '@snowluma/bridge';
|
||||
import {
|
||||
@@ -636,6 +637,15 @@ export async function initWebUI(
|
||||
updateRoot?: string;
|
||||
} = {},
|
||||
): Promise<{ port: number; stop: () => Promise<void> }> {
|
||||
const webuiTarget = resolveWebuiTarget(process.env.SNOWLUMA_WEBUI_TARGET);
|
||||
|
||||
if (webuiTarget) {
|
||||
log.info(
|
||||
'presentation target enabled: %s (runtime override; saved appearance is preserved)',
|
||||
webuiTarget,
|
||||
);
|
||||
}
|
||||
|
||||
const host = listener.host || '127.0.0.1';
|
||||
const tlsEnabled = listener.tlsEnabled === true;
|
||||
const bootCheck = checkListenerExposure({
|
||||
@@ -2163,6 +2173,11 @@ export async function initWebUI(
|
||||
'save global config failed: %s',
|
||||
err instanceof Error ? err.message : String(err),
|
||||
);
|
||||
|
||||
if (err instanceof RangeError) {
|
||||
return c.json({ success: false, message: err.message }, 400);
|
||||
}
|
||||
|
||||
return c.json({ success: false, message: '保存失败,请检查服务器日志' }, 500);
|
||||
}
|
||||
});
|
||||
@@ -2267,29 +2282,7 @@ export async function initWebUI(
|
||||
// Build path is relative to the bundled / dev __dirname. SPA fallback to
|
||||
// index.html so client-side routes (if any) keep working.
|
||||
const staticRoot = path.resolve(__dirname, 'client');
|
||||
app.use('/*', serveStatic({ root: staticRoot }));
|
||||
|
||||
const indexHtmlPath = path.join(staticRoot, 'index.html');
|
||||
app.get('*', (c) => {
|
||||
// SPA fallback: only for navigations that didn't hit a static asset.
|
||||
if (
|
||||
c.req.path.startsWith('/api/') ||
|
||||
c.req.path.startsWith('/avatar/') ||
|
||||
c.req.path.startsWith('/ui-asset/')
|
||||
) {
|
||||
return c.text('not found', 404);
|
||||
}
|
||||
|
||||
if (existsSync(indexHtmlPath)) {
|
||||
const html = readFileSync(indexHtmlPath, 'utf8');
|
||||
return c.html(html);
|
||||
}
|
||||
|
||||
return c.text(
|
||||
'WebUI client bundle not found. Run `pnpm --filter webui build` (or use the dev server on :5178).',
|
||||
404,
|
||||
);
|
||||
});
|
||||
registerStaticFrontend(app, staticRoot, webuiTarget);
|
||||
|
||||
const finalPort = await findAvailablePort(desiredPort, { host });
|
||||
|
||||
|
||||
34
packages/core/src/webui/static-frontend.ts
Normal file
34
packages/core/src/webui/static-frontend.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import { existsSync, readFileSync } from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import type { Hono, Context } from 'hono';
|
||||
import { serveStatic } from '@hono/node-server/serve-static';
|
||||
import { injectWebuiTarget, type WebuiTarget } from '@snowluma/common/webui-target';
|
||||
|
||||
/** All document entry paths share runtime injection, including direct index.html requests. */
|
||||
export function registerStaticFrontend(app: Hono, root: string, target: WebuiTarget | null): void {
|
||||
const indexPath = path.join(root, 'index.html');
|
||||
|
||||
const document = (c: Context) => {
|
||||
if (!existsSync(indexPath)) {
|
||||
return c.text(
|
||||
'WebUI client bundle not found. Run `pnpm --filter webui build` (or use the dev server on :5178).',
|
||||
404,
|
||||
);
|
||||
}
|
||||
|
||||
// A packaged frontend can be reused with a different deployment target on restart.
|
||||
c.header('Cache-Control', 'no-store');
|
||||
return c.html(injectWebuiTarget(readFileSync(indexPath, 'utf8'), target));
|
||||
};
|
||||
|
||||
app.get('/', document);
|
||||
app.get('/index.html', document);
|
||||
app.use('/*', serveStatic({ root }));
|
||||
app.get('*', (c) => {
|
||||
if (['/api/', '/avatar/', '/ui-asset/'].some((prefix) => c.req.path.startsWith(prefix))) {
|
||||
return c.text('not found', 404);
|
||||
}
|
||||
|
||||
return document(c);
|
||||
});
|
||||
}
|
||||
@@ -44,7 +44,7 @@ export type SidebarStyle = 'follow' | 'panel' | 'accent';
|
||||
export type BackgroundType = 'none' | 'solid' | 'gradient' | 'image';
|
||||
export type Density = 'cozy' | 'compact';
|
||||
export type TimeFormat = '12h' | '24h';
|
||||
/** Full color scheme. 'default' keeps the sky theme (driven by `mode`); the
|
||||
/** Full color scheme. 'default' keeps the lavender theme (driven by `mode`); the
|
||||
* Catppuccin flavors are complete palettes that also fix light/dark. */
|
||||
export type Palette =
|
||||
| 'default'
|
||||
@@ -85,7 +85,7 @@ export interface UiAppearance {
|
||||
accentCustom: string;
|
||||
accentScope: AccentScope;
|
||||
darkIntensity: DarkIntensity;
|
||||
/** Full color scheme; 'default' = the built-in sky theme. */
|
||||
/** Full color scheme; 'default' = the built-in lavender theme. */
|
||||
palette: Palette;
|
||||
sidebarStyle: SidebarStyle;
|
||||
background: UiBackground;
|
||||
@@ -203,12 +203,12 @@ export interface UiConfig {
|
||||
}
|
||||
|
||||
// ─── Defaults ────────────────────────────────────────────────────────────
|
||||
// Mirror the pre-existing ThemeContext defaults so an upgrade is a no-op
|
||||
// visually until the operator changes something.
|
||||
// Keep these defaults aligned with ThemeContext. Saved appearance choices
|
||||
// are normalized independently and remain the operator's preference.
|
||||
|
||||
const DEFAULT_BACKGROUND: UiBackground = {
|
||||
type: 'none',
|
||||
color: '#0ea5e9',
|
||||
color: '#b99ae6',
|
||||
gradient: 'none',
|
||||
imageOpacity: 0.15,
|
||||
imageBlur: 0,
|
||||
@@ -220,8 +220,8 @@ const DEFAULT_BACKGROUND: UiBackground = {
|
||||
const DEFAULT_APPEARANCE: UiAppearance = {
|
||||
mode: 'system',
|
||||
accentMode: 'preset',
|
||||
accentPreset: 'sky',
|
||||
accentCustom: '#38bdf8',
|
||||
accentPreset: 'lavender',
|
||||
accentCustom: '#8561bd',
|
||||
accentScope: 'global',
|
||||
darkIntensity: 'soft',
|
||||
palette: 'default',
|
||||
|
||||
@@ -1,10 +1,52 @@
|
||||
import { Hono } from 'hono';
|
||||
import type { HttpBindings } from '@hono/node-server';
|
||||
import type { UpdateService } from '../update/service';
|
||||
import { readUpdateSource, saveUpdateSource, testUpdateSources } from '../update/sources';
|
||||
import {
|
||||
normalizeUpdateSourceConfig,
|
||||
type UpdateSourceConfig,
|
||||
} from '@snowluma/common/update-source';
|
||||
|
||||
export function updateRoutes(service: UpdateService, restart: () => void) {
|
||||
const app = new Hono<{ Bindings: HttpBindings }>();
|
||||
app.get('/status', (c) => c.json(service.status()));
|
||||
app.get('/sources', (c) => {
|
||||
try {
|
||||
return c.json({ config: readUpdateSource() });
|
||||
} catch (error) {
|
||||
return c.json({ message: error instanceof Error ? error.message : String(error) }, 500);
|
||||
}
|
||||
});
|
||||
app.post('/sources', async (c) => {
|
||||
let config: UpdateSourceConfig;
|
||||
|
||||
try {
|
||||
config = normalizeUpdateSourceConfig(await c.req.json());
|
||||
} catch (error) {
|
||||
return c.json({ message: error instanceof Error ? error.message : String(error) }, 400);
|
||||
}
|
||||
|
||||
try {
|
||||
saveUpdateSource(config);
|
||||
return c.json({
|
||||
config,
|
||||
saved: true,
|
||||
applied: true,
|
||||
online: true,
|
||||
errors: [],
|
||||
message: '更新来源已保存',
|
||||
});
|
||||
} catch (error) {
|
||||
return c.json({ message: error instanceof Error ? error.message : String(error) }, 500);
|
||||
}
|
||||
});
|
||||
app.post('/sources/test', async (c) => {
|
||||
try {
|
||||
return c.json({ results: await testUpdateSources(await c.req.json()) });
|
||||
} catch (error) {
|
||||
return c.json({ message: error instanceof Error ? error.message : String(error) }, 400);
|
||||
}
|
||||
});
|
||||
app.post('/download', async (c) => {
|
||||
let body: unknown;
|
||||
|
||||
|
||||
@@ -67,8 +67,8 @@ function friend(
|
||||
type: 1,
|
||||
layer1: {
|
||||
properties: [
|
||||
{ code: 20002, value: nickname },
|
||||
{ code: 103, value: remark },
|
||||
{ code: 20002, value: Buffer.from(nickname) },
|
||||
{ code: 103, value: Buffer.from(remark) },
|
||||
],
|
||||
},
|
||||
},
|
||||
@@ -478,8 +478,8 @@ describe('apis/contacts / categorized friend roster', () => {
|
||||
]);
|
||||
|
||||
await expect(api.fetchFriendList()).resolves.toEqual([
|
||||
{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '' },
|
||||
{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A' },
|
||||
{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '', categoryId: 0 },
|
||||
{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A', categoryId: 7 },
|
||||
]);
|
||||
expect(sendRawPacket).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
@@ -508,14 +508,16 @@ describe('apis/contacts / categorized friend roster', () => {
|
||||
categoryName: '我的好友',
|
||||
memberCount: 1,
|
||||
sortId: 0,
|
||||
friends: [{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '' }],
|
||||
friends: [
|
||||
{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '', categoryId: 0 },
|
||||
],
|
||||
},
|
||||
{
|
||||
categoryId: 7,
|
||||
categoryName: 'Work',
|
||||
memberCount: 1,
|
||||
sortId: 1,
|
||||
friends: [{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A' }],
|
||||
friends: [{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A', categoryId: 7 }],
|
||||
},
|
||||
{
|
||||
categoryId: 9,
|
||||
@@ -533,8 +535,8 @@ describe('apis/contacts / categorized friend roster', () => {
|
||||
expect(secondRequest.body?.cookie).toEqual(cookie);
|
||||
expect(rememberFriends).toHaveBeenCalledOnce();
|
||||
expect(rememberFriends).toHaveBeenCalledWith([
|
||||
{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '' },
|
||||
{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A' },
|
||||
{ uin: 10001, uid: 'u1', nickname: 'Default', remark: '', categoryId: 0 },
|
||||
{ uin: 10002, uid: 'u2', nickname: 'Alice', remark: 'A', categoryId: 7 },
|
||||
]);
|
||||
});
|
||||
|
||||
@@ -754,12 +756,20 @@ describe('apis/contacts / invite-card pending application', () => {
|
||||
const api = new ContactsApi({ identity: { uin: '10001' } } as any);
|
||||
expect(api.getGroupInviteCardSequence(12345)).toBeUndefined();
|
||||
|
||||
api.rememberGroupInviteCardSequence(12345, 778899);
|
||||
api.rememberGroupInviteCardSequence(0, 1);
|
||||
api.rememberGroupInviteCardSequence(1, 0);
|
||||
expect(api.rememberGroupInviteCardSequence(12345, 778899)).toBe(true);
|
||||
expect(api.rememberGroupInviteCardSequence(12345, 778899)).toBe(false);
|
||||
|
||||
expect(api.getGroupInviteCardSequence(12345)).toBe(778899);
|
||||
expect(api.findGroupInviteCardGroupBySequence(778899)).toBe(12345);
|
||||
expect(api.findGroupInviteCardGroupBySequence(1)).toBeUndefined();
|
||||
});
|
||||
|
||||
it('requires a group when different groups have the same card sequence', () => {
|
||||
const api = new ContactsApi({ identity: { uin: '10001' } } as any);
|
||||
api.rememberGroupInviteCardSequence(12345, 778899);
|
||||
api.rememberGroupInviteCardSequence(67890, 778899);
|
||||
|
||||
expect(() => api.findGroupInviteCardGroupBySequence(778899)).toThrow('multiple groups');
|
||||
expect(api.findGroupInviteCardGroupBySequence(778899, 67890)).toBe(67890);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -6,7 +6,7 @@ import { ForwardApi } from '../../src/bridge/apis/forward';
|
||||
import { mockBridge } from './_helpers';
|
||||
|
||||
vi.mock('@snowluma/protocol/highway/image-upload', () => ({ uploadImageMsgInfo: vi.fn() }));
|
||||
vi.mock('@snowluma/protocol/highway/ptt-upload', () => ({ uploadPttMsgInfo: vi.fn() }));
|
||||
vi.mock('@snowluma/protocol/highway/ptt-upload', () => ({ uploadPtt: vi.fn() }));
|
||||
vi.mock('@snowluma/protocol/highway/video-upload', () => ({ uploadVideoMsgInfo: vi.fn() }));
|
||||
|
||||
describe('forward metadata through upload and cached reads', () => {
|
||||
|
||||
@@ -35,7 +35,7 @@ function message(...elems: Elem[]): PushMsgBody {
|
||||
};
|
||||
}
|
||||
|
||||
function setup(downloads: Map<string, LongMsgResult>) {
|
||||
function setup(downloads: Map<string, LongMsgResult>, selfUin = '10001') {
|
||||
const requested: string[] = [];
|
||||
const bridge = mockBridge({
|
||||
sendRawPacket: vi.fn(async (command: string, bytes: Uint8Array) => {
|
||||
@@ -61,21 +61,194 @@ function setup(downloads: Map<string, LongMsgResult>) {
|
||||
};
|
||||
}),
|
||||
});
|
||||
bridge.identity.uin = selfUin;
|
||||
const forward = new ForwardApi(bridge as unknown as BridgeContext);
|
||||
const ctx = {
|
||||
selfId: 10001,
|
||||
selfId: Number(selfUin),
|
||||
bridge: { apis: { forward } },
|
||||
converterCtx: {
|
||||
selfId: 10001,
|
||||
selfId: Number(selfUin),
|
||||
imageUrlResolver: null,
|
||||
mediaUrlResolver: null,
|
||||
messageIdResolver: null,
|
||||
mediaSegmentSink: null,
|
||||
},
|
||||
} as unknown as OneBotInstanceContext;
|
||||
return { api: buildApiContext(ctx), requested };
|
||||
return { api: buildApiContext(ctx), requested, bridge, forward };
|
||||
}
|
||||
|
||||
function plainResult(text: string): LongMsgResult {
|
||||
return {
|
||||
action: [
|
||||
{
|
||||
actionCommand: 'MultiMsg',
|
||||
actionData: { msgBody: [message({ text: { str: text } })] },
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
function nestedResult(inner: string, key: string, body?: PushMsgBody): LongMsgResult {
|
||||
return {
|
||||
action: [
|
||||
{
|
||||
actionCommand: 'MultiMsg',
|
||||
actionData: { msgBody: [message(forwardCard('xml', inner, key))] },
|
||||
},
|
||||
{
|
||||
actionCommand: key,
|
||||
actionData: { msgBody: [body ?? message({ text: { str: 'inner content' } })] },
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
async function fillCache(
|
||||
api: ReturnType<typeof setup>['api'],
|
||||
downloads: Map<string, LongMsgResult>,
|
||||
prefix: string,
|
||||
count: number,
|
||||
): Promise<void> {
|
||||
for (let index = 0; index < count; index++) {
|
||||
const id = `${prefix}-${index}`;
|
||||
downloads.set(id, plainResult(id));
|
||||
await api.getForwardMsg(id);
|
||||
}
|
||||
}
|
||||
|
||||
describe('get_forward_msg / cache lifetime', () => {
|
||||
it('bounds cached results while refreshing recently read results', async () => {
|
||||
const downloads = new Map([
|
||||
['cache-cold', plainResult('cold')],
|
||||
['cache-hot', plainResult('hot')],
|
||||
]);
|
||||
const { api, requested } = setup(downloads);
|
||||
await api.getForwardMsg('cache-cold');
|
||||
await api.getForwardMsg('cache-hot');
|
||||
await fillCache(api, downloads, 'cache-pressure', 510);
|
||||
await api.getForwardMsg('cache-hot');
|
||||
await fillCache(api, downloads, 'cache-overflow', 1);
|
||||
requested.length = 0;
|
||||
await api.getForwardMsg('cache-hot');
|
||||
await api.getForwardMsg('cache-cold');
|
||||
expect(requested).toEqual(['cache-cold']);
|
||||
});
|
||||
|
||||
it('isolates cached content between bridge accounts', async () => {
|
||||
const first = setup(new Map([['same-resource', plainResult('account one')]]));
|
||||
const second = setup(new Map([['same-resource', plainResult('account two')]]), '10002');
|
||||
await first.api.getForwardMsg('same-resource');
|
||||
expect((await second.api.getForwardMsg('same-resource'))[0]?.message).toEqual([
|
||||
{ type: 'text', data: { text: 'account two' } },
|
||||
]);
|
||||
expect(second.requested).toEqual(['same-resource']);
|
||||
});
|
||||
|
||||
it('keeps nested results with a hot outer result under cache pressure', async () => {
|
||||
const downloads = new Map([['hot-outer', nestedResult('hot-inner', 'hot-inner-key')]]);
|
||||
const { api, requested } = setup(downloads);
|
||||
await api.getForwardMsg('hot-outer');
|
||||
await fillCache(api, downloads, 'nested-pressure', 511);
|
||||
await api.getForwardMsg('hot-inner');
|
||||
await fillCache(api, downloads, 'nested-overflow', 1);
|
||||
requested.length = 0;
|
||||
expect((await api.getForwardMsg('hot-outer'))[0]?.message).toEqual([
|
||||
{ type: 'forward', data: { id: 'hot-inner' } },
|
||||
]);
|
||||
expect((await api.getForwardMsg('hot-inner'))[0]?.message).toEqual([
|
||||
{ type: 'text', data: { text: 'inner content' } },
|
||||
]);
|
||||
expect(requested).toEqual([]);
|
||||
});
|
||||
|
||||
it('keeps an inner result attached to its outer result after sender enrichment', async () => {
|
||||
const nameless = message({ text: { str: 'unnamed sender' } });
|
||||
nameless.responseHead!.grp!.memberCard = '';
|
||||
const downloads = new Map([
|
||||
['enrich-outer', nestedResult('enrich-inner', 'enrich-key', nameless)],
|
||||
]);
|
||||
const { api, requested, bridge } = setup(downloads);
|
||||
bridge.apis.contacts.fetchGroupMemberList.mockResolvedValue([
|
||||
{ uin: 20002, nickname: 'resolved nickname', card: 'resolved card' },
|
||||
]);
|
||||
await api.getForwardMsg('enrich-outer');
|
||||
await fillCache(api, downloads, 'enrich-pressure', 511);
|
||||
requested.length = 0;
|
||||
expect((await api.getForwardMsg('enrich-inner'))[0]).toMatchObject({
|
||||
sender: { nickname: 'resolved card' },
|
||||
});
|
||||
expect(bridge.apis.contacts.fetchGroupMemberList).toHaveBeenCalledOnce();
|
||||
await api.getForwardMsg('enrich-outer');
|
||||
await api.getForwardMsg('enrich-inner');
|
||||
expect(bridge.apis.contacts.fetchGroupMemberList).toHaveBeenCalledOnce();
|
||||
expect(requested).toEqual([]);
|
||||
});
|
||||
|
||||
it('retains a shared inner result while another containing outer result remains cached', async () => {
|
||||
const downloads = new Map([
|
||||
['shared-outer-a', nestedResult('shared-inner', 'shared-key-a')],
|
||||
['shared-outer-b', nestedResult('shared-inner', 'shared-key-b')],
|
||||
]);
|
||||
const { api, requested } = setup(downloads);
|
||||
await api.getForwardMsg('shared-outer-a');
|
||||
await api.getForwardMsg('shared-outer-b');
|
||||
await fillCache(api, downloads, 'shared-pressure', 510);
|
||||
await api.getForwardMsg('shared-outer-a');
|
||||
await fillCache(api, downloads, 'shared-overflow', 1);
|
||||
requested.length = 0;
|
||||
expect((await api.getForwardMsg('shared-inner'))[0]?.message).toEqual([
|
||||
{ type: 'text', data: { text: 'inner content' } },
|
||||
]);
|
||||
expect(requested).toEqual([]);
|
||||
});
|
||||
|
||||
it('restores all nested results when an evicted outer result is downloaded again', async () => {
|
||||
const downloads = new Map([
|
||||
['restore-outer', nestedResult('restore-inner', 'restore-key')],
|
||||
]);
|
||||
const { api, requested } = setup(downloads);
|
||||
await api.getForwardMsg('restore-outer');
|
||||
await api.getForwardMsg('restore-inner');
|
||||
await fillCache(api, downloads, 'restore-pressure', 512);
|
||||
requested.length = 0;
|
||||
await api.getForwardMsg('restore-outer');
|
||||
expect((await api.getForwardMsg('restore-inner'))[0]?.message).toEqual([
|
||||
{ type: 'text', data: { text: 'inner content' } },
|
||||
]);
|
||||
expect(requested).toEqual(['restore-outer']);
|
||||
});
|
||||
|
||||
it('does not resurrect evicted nested results when enrichment finishes late', async () => {
|
||||
const nameless = message({ text: { str: 'late sender' } });
|
||||
nameless.responseHead!.grp!.memberCard = '';
|
||||
const downloads = new Map([
|
||||
['late-outer', nestedResult('late-inner', 'late-key', nameless)],
|
||||
]);
|
||||
const { api, requested, bridge } = setup(downloads);
|
||||
const members = [{ uin: 20002, nickname: 'late name', card: '' }];
|
||||
let finishEnrichment!: () => void;
|
||||
const enrichment = new Promise<typeof members>((resolve) => {
|
||||
finishEnrichment = () => resolve(members);
|
||||
});
|
||||
bridge.apis.contacts.fetchGroupMemberList.mockReturnValueOnce(enrichment);
|
||||
await api.getForwardMsg('late-outer');
|
||||
const pending = api.getForwardMsg('late-inner');
|
||||
await vi.waitFor(() =>
|
||||
expect(bridge.apis.contacts.fetchGroupMemberList).toHaveBeenCalledOnce(),
|
||||
);
|
||||
await fillCache(api, downloads, 'late-pressure', 512);
|
||||
finishEnrichment();
|
||||
expect((await pending)[0]).toMatchObject({ sender: { nickname: 'late name' } });
|
||||
requested.length = 0;
|
||||
await expect(api.getForwardMsg('late-inner')).rejects.toThrow('payload is empty');
|
||||
await api.getForwardMsg('late-outer');
|
||||
expect((await api.getForwardMsg('late-inner'))[0]?.message).toEqual([
|
||||
{ type: 'text', data: { text: 'late sender' } },
|
||||
]);
|
||||
expect(requested).toEqual(['late-inner', 'late-outer']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('get_forward_msg / nested downloads (#529)', () => {
|
||||
it.each(['xml', 'lightApp'] as const)(
|
||||
'resolves siblings and three levels of %s forwards from one outer payload',
|
||||
|
||||
@@ -33,13 +33,14 @@ vi.mock('@snowluma/protocol/highway/image-upload', () => ({
|
||||
uploadImageMsgInfo: vi.fn(async () => new Uint8Array()),
|
||||
}));
|
||||
vi.mock('@snowluma/protocol/highway/ptt-upload', () => ({
|
||||
uploadPttMsgInfo: vi.fn(async () => new Uint8Array()),
|
||||
uploadPtt: vi.fn(async () => ({ msgInfo: new Uint8Array() })),
|
||||
}));
|
||||
vi.mock('@snowluma/protocol/highway/video-upload', () => ({
|
||||
uploadVideoMsgInfo: vi.fn(async () => new Uint8Array()),
|
||||
}));
|
||||
|
||||
import { ForwardApi } from '../../src/bridge/apis/forward';
|
||||
import type { BridgeContext } from '../../src/bridge/bridge-context';
|
||||
import { mockBridge } from './_helpers';
|
||||
|
||||
function uploadResponseWithResId(resId: string) {
|
||||
@@ -107,6 +108,49 @@ function findLightAppJson(msgBody: PushMsgBody[]): {
|
||||
}
|
||||
|
||||
describe('forward / nested upload wire alignment', () => {
|
||||
it('bounds uploaded results while keeping a recently read nested upload together', async () => {
|
||||
let sequence = 0;
|
||||
const sendRawPacket = vi.fn(async (command: string) => {
|
||||
if (command !== 'trpc.group.long_msg_interface.MsgService.SsoSendLongMsg') {
|
||||
throw new Error('test cache miss');
|
||||
}
|
||||
|
||||
return uploadResponseWithResId(`upload-cache-${++sequence}`);
|
||||
});
|
||||
const bridge = mockBridge({ sendRawPacket });
|
||||
const forward = new ForwardApi(bridge as unknown as BridgeContext);
|
||||
const outer = await forward.upload([
|
||||
{
|
||||
userUin: 111,
|
||||
nickname: 'outer',
|
||||
elements: [],
|
||||
innerForward: [
|
||||
{
|
||||
userUin: 222,
|
||||
nickname: 'inner',
|
||||
elements: [{ type: 'text', text: 'nested upload' }],
|
||||
},
|
||||
],
|
||||
},
|
||||
]);
|
||||
const filler = [{ userUin: 111, nickname: 'filler', elements: [] }];
|
||||
|
||||
for (let index = 0; index < 511; index++) {
|
||||
await forward.upload(filler);
|
||||
}
|
||||
|
||||
await forward.fetch('upload-cache-1');
|
||||
await forward.upload(filler);
|
||||
const uploadedCount = sendRawPacket.mock.calls.length;
|
||||
const sameBridgeApi = new ForwardApi(bridge as unknown as BridgeContext);
|
||||
expect((await sameBridgeApi.fetch(outer))[0]?.elements[0]?.resId).toBe('upload-cache-1');
|
||||
expect((await sameBridgeApi.fetch('upload-cache-1'))[0]?.elements).toEqual([
|
||||
{ type: 'text', text: 'nested upload' },
|
||||
]);
|
||||
expect(sendRawPacket).toHaveBeenCalledTimes(uploadedCount);
|
||||
await expect(forward.fetch('upload-cache-3')).rejects.toThrow('test cache miss');
|
||||
});
|
||||
|
||||
it('outer LongMsgResult contains both MultiMsg and the inner uuid piggyback action', async () => {
|
||||
// Inner upload returns inner-res; outer upload returns outer-res.
|
||||
const responses = ['inner-res', 'outer-res'];
|
||||
|
||||
188
packages/core/tests/actions/forward-resid-less.test.ts
Normal file
188
packages/core/tests/actions/forward-resid-less.test.ts
Normal file
@@ -0,0 +1,188 @@
|
||||
import { describe, expect, it, vi } from 'vitest';
|
||||
import { deflateSync, gunzipSync, gzipSync } from 'node:zlib';
|
||||
import type { Elem } from '@snowluma/proto-defs/element';
|
||||
import type {
|
||||
LongMsgResult,
|
||||
RecvLongMsgReq,
|
||||
RecvLongMsgResp,
|
||||
SendLongMsgReq,
|
||||
SendLongMsgResp,
|
||||
} from '@snowluma/proto-defs/longmsg';
|
||||
import type { PushMsgBody } from '@snowluma/proto-defs/message';
|
||||
import { buildApiContext, type OneBotInstanceContext } from '@snowluma/onebot/instance-context';
|
||||
import type { MessageElement } from '@snowluma/protocol/events';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import { ForwardApi } from '../../src/bridge/apis/forward';
|
||||
import type { BridgeContext } from '../../src/bridge/bridge-context';
|
||||
import { mockBridge } from './_helpers';
|
||||
|
||||
const OUTER_RES_ID = 'outer-resid';
|
||||
const INNER_UUID = 'C125CE25-AE7E-4E1A-ABDC-9750918162EB';
|
||||
const INNER_FILE_NAME = `MultiMsg_${INNER_UUID}`;
|
||||
|
||||
function packetResult(responseData: Uint8Array) {
|
||||
return {
|
||||
success: true,
|
||||
gotResponse: true,
|
||||
errorCode: 0,
|
||||
errorMessage: '',
|
||||
responseData: Buffer.from(responseData),
|
||||
};
|
||||
}
|
||||
|
||||
function residLessForwardCard(): Elem {
|
||||
const xml =
|
||||
`<msg serviceID="35" templateID="1" action="viewMultiMsg" ` +
|
||||
`m_fileName="${INNER_FILE_NAME}" tSum="2" flag="3" />`;
|
||||
const data = Buffer.concat([Buffer.from([1]), deflateSync(Buffer.from(xml))]);
|
||||
return { richMsg: { serviceId: 35, template1: data } };
|
||||
}
|
||||
|
||||
function message(...elems: Elem[]): PushMsgBody {
|
||||
return {
|
||||
responseHead: {
|
||||
fromUin: 20002,
|
||||
fromUid: 'sender-uid',
|
||||
grp: { groupUin: 12345, memberCard: 'alice' },
|
||||
},
|
||||
contentHead: { msgType: 82, sequence: 10, timestamp: 1700000000 },
|
||||
body: { richText: { elems } },
|
||||
};
|
||||
}
|
||||
|
||||
function outerResult(innerActionCommand?: string): LongMsgResult {
|
||||
return {
|
||||
action: [
|
||||
{
|
||||
actionCommand: 'MultiMsg',
|
||||
actionData: { msgBody: [message(residLessForwardCard())] },
|
||||
},
|
||||
...(innerActionCommand
|
||||
? [
|
||||
{
|
||||
actionCommand: innerActionCommand,
|
||||
actionData: {
|
||||
msgBody: [
|
||||
message({ text: { str: 'inner one' } }),
|
||||
message({ text: { str: 'inner two' } }),
|
||||
],
|
||||
},
|
||||
},
|
||||
]
|
||||
: []),
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
function setup(innerActionCommand?: string) {
|
||||
const requested: string[] = [];
|
||||
const uploads: SendLongMsgReq[] = [];
|
||||
const sendRawPacket = vi.fn(async (command: string, bytes: Uint8Array) => {
|
||||
if (command.endsWith('SsoRecvLongMsg')) {
|
||||
const resId = protobuf_decode<RecvLongMsgReq>(bytes).info!.resId!;
|
||||
requested.push(resId);
|
||||
return packetResult(
|
||||
protobuf_encode<RecvLongMsgResp>({
|
||||
result: {
|
||||
resId,
|
||||
payload:
|
||||
resId === OUTER_RES_ID
|
||||
? gzipSync(
|
||||
protobuf_encode<LongMsgResult>(
|
||||
outerResult(innerActionCommand),
|
||||
),
|
||||
)
|
||||
: undefined,
|
||||
},
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
expect(command).toMatch(/SsoSendLongMsg$/);
|
||||
const upload = protobuf_decode<SendLongMsgReq>(bytes);
|
||||
uploads.push(upload);
|
||||
return packetResult(
|
||||
protobuf_encode<SendLongMsgResp>({ result: { resId: `rebuilt-${uploads.length}` } }),
|
||||
);
|
||||
});
|
||||
const bridge = mockBridge({ sendRawPacket });
|
||||
const forward = new ForwardApi(bridge as unknown as BridgeContext);
|
||||
const sendGroup = vi.fn(async (_groupId: number, _elements: MessageElement[]) => ({
|
||||
messageId: 1,
|
||||
sequence: 2,
|
||||
clientSequence: 3,
|
||||
random: 4,
|
||||
timestamp: 1700000001,
|
||||
}));
|
||||
const ctx = {
|
||||
selfId: 10001,
|
||||
bridge: {
|
||||
identity: { nickname: 'SnowLuma' },
|
||||
apis: { forward, message: { sendGroup } },
|
||||
},
|
||||
messageStore: {
|
||||
findEvent: () => ({
|
||||
message: [{ type: 'forward', data: { id: OUTER_RES_ID } }],
|
||||
}),
|
||||
storeEvent: vi.fn(),
|
||||
},
|
||||
converterCtx: {
|
||||
selfId: 10001,
|
||||
imageUrlResolver: null,
|
||||
mediaUrlResolver: null,
|
||||
messageIdResolver: null,
|
||||
mediaSegmentSink: null,
|
||||
},
|
||||
cacheMessageMeta: vi.fn(),
|
||||
dispatchEvent: vi.fn(),
|
||||
} as unknown as OneBotInstanceContext;
|
||||
|
||||
return { api: buildApiContext(ctx), requested, uploads, sendGroup };
|
||||
}
|
||||
|
||||
describe('resid-less nested forwards (#589)', () => {
|
||||
it.each([INNER_UUID, INNER_FILE_NAME])(
|
||||
'resolves an outer piggyback keyed by %s without another download',
|
||||
async (innerActionCommand) => {
|
||||
const { api, requested } = setup(innerActionCommand);
|
||||
const outer = await api.getForwardMsg(OUTER_RES_ID);
|
||||
expect(outer[0]?.message).toEqual([{ type: 'forward', data: { id: INNER_FILE_NAME } }]);
|
||||
|
||||
const inner = await api.getForwardMsg(INNER_FILE_NAME);
|
||||
expect(inner.map((node) => node.message)).toEqual([
|
||||
[{ type: 'text', data: { text: 'inner one' } }],
|
||||
[{ type: 'text', data: { text: 'inner two' } }],
|
||||
]);
|
||||
expect(requested).toEqual([OUTER_RES_ID]);
|
||||
},
|
||||
);
|
||||
|
||||
it('rebuilds both layers before sending to another group', async () => {
|
||||
const { api, requested, uploads, sendGroup } = setup(INNER_UUID);
|
||||
await expect(api.forwardSingleMsg(77, { groupId: 65432 })).resolves.toHaveProperty(
|
||||
'messageId',
|
||||
);
|
||||
|
||||
expect(requested).toEqual([OUTER_RES_ID]);
|
||||
expect(uploads).toHaveLength(2);
|
||||
const outerBytes = gunzipSync(Buffer.from(uploads[1]!.info!.payload!));
|
||||
const outer = protobuf_decode<LongMsgResult>(outerBytes);
|
||||
expect(outer.action).toHaveLength(2);
|
||||
expect(outerBytes.toString()).not.toContain(INNER_FILE_NAME);
|
||||
expect(sendGroup).toHaveBeenCalledOnce();
|
||||
expect(sendGroup.mock.calls[0]![1]).toEqual([
|
||||
expect.objectContaining({ type: 'forward', resId: 'rebuilt-2' }),
|
||||
]);
|
||||
});
|
||||
|
||||
it('fails before upload or send when the inner piggyback is unavailable', async () => {
|
||||
const { api, requested, uploads, sendGroup } = setup();
|
||||
await expect(api.forwardSingleMsg(77, { groupId: 65432 })).rejects.toThrow(
|
||||
'download forward message payload is empty',
|
||||
);
|
||||
|
||||
expect(requested).toEqual([OUTER_RES_ID, INNER_FILE_NAME]);
|
||||
expect(uploads).toHaveLength(0);
|
||||
expect(sendGroup).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
242
packages/core/tests/actions/friend-profiles.test.ts
Normal file
242
packages/core/tests/actions/friend-profiles.test.ts
Normal file
@@ -0,0 +1,242 @@
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import type {
|
||||
OidbBase,
|
||||
OidbFriend,
|
||||
OidbSvcTrpcTcp0xFD4_1Response,
|
||||
} from '@snowluma/proto-defs/oidb';
|
||||
import type {
|
||||
OidbUserInfoRequest,
|
||||
OidbUserInfoResponse,
|
||||
} from '@snowluma/proto-defs/oidb-actions/base';
|
||||
import { IdentityService } from '@snowluma/protocol/identity-service';
|
||||
import { Bridge } from '../../src/bridge/bridge';
|
||||
|
||||
function deferred() {
|
||||
let resolve!: () => void;
|
||||
let reject!: (reason: Error) => void;
|
||||
const promise = new Promise<void>((yes, no) => {
|
||||
resolve = yes;
|
||||
reject = no;
|
||||
});
|
||||
return { promise, resolve, reject };
|
||||
}
|
||||
|
||||
const bridges: Bridge[] = [];
|
||||
afterEach(async () => {
|
||||
await Promise.all(bridges.splice(0).map((bridge) => bridge.dispose()));
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
function friend(uin: number, name = 'Roster'): OidbFriend {
|
||||
return {
|
||||
uin,
|
||||
uid: `u_${uin}`,
|
||||
customGroup: 7,
|
||||
additional: [
|
||||
{
|
||||
type: 1,
|
||||
layer1: {
|
||||
properties: [
|
||||
{ code: 20002, value: Buffer.from(name) },
|
||||
{ code: 102, value: Buffer.from('') },
|
||||
],
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
function setup(roster: () => OidbFriend[], load: (uin: number) => Promise<void> = async () => {}) {
|
||||
const bridge = new Bridge(IdentityService.memory('90001'));
|
||||
bridges.push(bridge);
|
||||
const profileCalls: number[] = [];
|
||||
let active = 0;
|
||||
let peak = 0;
|
||||
const send = vi.spyOn(bridge, 'sendRawPacket').mockImplementation(async (cmd, payload) => {
|
||||
let responseData: Uint8Array;
|
||||
|
||||
if (cmd === 'OidbSvcTrpcTcp.0xfd4_1') {
|
||||
const friends = roster();
|
||||
responseData = protobuf_encode<OidbBase<OidbSvcTrpcTcp0xFD4_1Response>>({
|
||||
body: {
|
||||
friends,
|
||||
categories: [
|
||||
{ categoryId: 7, categoryName: 'Friends', memberCount: friends.length },
|
||||
],
|
||||
},
|
||||
});
|
||||
} else if (cmd === 'OidbSvcTrpcTcp.0xfe1_2') {
|
||||
const uin = protobuf_decode<OidbBase<OidbUserInfoRequest>>(payload).body!.uin!;
|
||||
profileCalls.push(uin);
|
||||
peak = Math.max(peak, ++active);
|
||||
|
||||
try {
|
||||
await load(uin);
|
||||
} finally {
|
||||
active--;
|
||||
}
|
||||
|
||||
responseData = protobuf_encode<OidbBase<OidbUserInfoResponse>>({
|
||||
body: {
|
||||
body: {
|
||||
uin,
|
||||
uid: `u_${uin}`,
|
||||
properties: {
|
||||
bytesProperties: [
|
||||
{ code: 102, value: Buffer.from('Profile sign') },
|
||||
{ code: 20020, value: Buffer.from('City') },
|
||||
],
|
||||
numberProperties: [
|
||||
{ number1: 20037, number2: 0 },
|
||||
{ number1: 41756, number2: 0 },
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
} else {
|
||||
throw new Error(`unexpected request ${cmd}`);
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
gotResponse: true,
|
||||
errorCode: 0,
|
||||
errorMessage: '',
|
||||
responseData: Buffer.from(responseData),
|
||||
};
|
||||
});
|
||||
return {
|
||||
bridge,
|
||||
api: bridge.apis.contacts,
|
||||
send,
|
||||
profileCalls,
|
||||
peak: () => peak,
|
||||
active: () => active,
|
||||
};
|
||||
}
|
||||
|
||||
describe('explicit friend profile enrichment', () => {
|
||||
it('does not fan out on a cold 160-friend ordinary or categorized list', async () => {
|
||||
const { api, profileCalls, send } = setup(() =>
|
||||
Array.from({ length: 160 }, (_, i) => friend(10000 + i)),
|
||||
);
|
||||
expect(await api.fetchFriendList()).toHaveLength(160);
|
||||
expect((await api.fetchFriendCategories())[0]?.friends).toHaveLength(160);
|
||||
expect(profileCalls).toEqual([]);
|
||||
expect(send).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it('shares the cache across list forms, preserves roster values and isolates accounts', async () => {
|
||||
let now = Date.now();
|
||||
vi.spyOn(Date, 'now').mockImplementation(() => now);
|
||||
const one = setup(() => [friend(10001)]);
|
||||
const first = await one.api.fetchFriendList({ withProfile: true });
|
||||
expect(first[0]).toMatchObject({
|
||||
nickname: 'Roster',
|
||||
profile: { sign: '', age: 0, vipFlag: false, city: 'City' },
|
||||
});
|
||||
first[0]!.profile!.city = 'caller mutation';
|
||||
const grouped = await one.api.fetchFriendCategories({ withProfile: true });
|
||||
expect(grouped[0]?.friends[0]?.profile?.city).toBe('City');
|
||||
expect(one.profileCalls).toEqual([10001]);
|
||||
const two = setup(() => [friend(10001)]);
|
||||
await two.api.fetchFriendList({ withProfile: true });
|
||||
expect(two.profileCalls).toEqual([10001]);
|
||||
now += 300_001;
|
||||
await one.api.fetchFriendList({ withProfile: true });
|
||||
expect(one.profileCalls).toEqual([10001, 10001]);
|
||||
});
|
||||
|
||||
it('deduplicates overlapping lists and caps total concurrent queries at four', async () => {
|
||||
const gates = new Map<number, ReturnType<typeof deferred>>();
|
||||
let page = 0;
|
||||
const { api, profileCalls, peak } = setup(
|
||||
() => (page++ === 0 ? [1, 2, 3, 4] : [3, 4, 5, 6]).map((id) => friend(10000 + id)),
|
||||
(uin) => {
|
||||
const gate = deferred();
|
||||
gates.set(uin, gate);
|
||||
return gate.promise;
|
||||
},
|
||||
);
|
||||
const first = api.fetchFriendList({ withProfile: true });
|
||||
const second = api.fetchFriendCategories({ withProfile: true });
|
||||
await vi.waitFor(() => expect(profileCalls).toHaveLength(4));
|
||||
|
||||
for (const gate of gates.values()) {
|
||||
gate.resolve();
|
||||
}
|
||||
|
||||
await vi.waitFor(() => expect(profileCalls).toHaveLength(6));
|
||||
|
||||
for (const gate of gates.values()) {
|
||||
gate.resolve();
|
||||
}
|
||||
|
||||
await Promise.all([first, second]);
|
||||
expect(new Set(profileCalls).size).toBe(6);
|
||||
expect(peak()).toBe(4);
|
||||
});
|
||||
|
||||
it('drains a failed batch, surfaces the failure and retries only on a later request', async () => {
|
||||
const gates = new Map<number, ReturnType<typeof deferred>>();
|
||||
let blocking = true;
|
||||
const { api, bridge, profileCalls, active } = setup(
|
||||
() => [1, 2, 3, 4, 5].map((id) => friend(10000 + id)),
|
||||
(uin) => {
|
||||
if (!blocking) {
|
||||
return Promise.resolve();
|
||||
}
|
||||
|
||||
const gate = deferred();
|
||||
gates.set(uin, gate);
|
||||
return gate.promise;
|
||||
},
|
||||
);
|
||||
let finished = false;
|
||||
const result = api.fetchFriendList({ withProfile: true });
|
||||
const checked = expect(result).rejects.toThrow('friend profile enrichment failed');
|
||||
void result.then(
|
||||
() => {
|
||||
finished = true;
|
||||
},
|
||||
() => {
|
||||
finished = true;
|
||||
},
|
||||
);
|
||||
await vi.waitFor(() => expect(profileCalls).toHaveLength(4));
|
||||
gates.get(10001)!.reject(new Error('synthetic timeout'));
|
||||
await Promise.resolve();
|
||||
expect(finished).toBe(false);
|
||||
|
||||
for (const [uin, gate] of gates) {
|
||||
if (uin !== 10001) {
|
||||
gate.resolve();
|
||||
}
|
||||
}
|
||||
|
||||
await checked;
|
||||
expect(active()).toBe(0);
|
||||
expect(profileCalls).toHaveLength(4);
|
||||
expect(bridge.identity.friends).toEqual([]);
|
||||
blocking = false;
|
||||
await api.fetchFriendList({ withProfile: true });
|
||||
expect(profileCalls).toEqual([10001, 10002, 10003, 10004, 10001, 10005]);
|
||||
});
|
||||
|
||||
it('does not let a slow enriched snapshot replace a newer ordinary roster', async () => {
|
||||
const gate = deferred();
|
||||
let page = 0;
|
||||
const { api, bridge, profileCalls } = setup(
|
||||
() => [friend(10001, page++ === 0 ? 'Old' : 'New')],
|
||||
() => gate.promise,
|
||||
);
|
||||
const old = api.fetchFriendList({ withProfile: true });
|
||||
await vi.waitFor(() => expect(profileCalls).toHaveLength(1));
|
||||
await api.fetchFriendList();
|
||||
gate.resolve();
|
||||
expect((await old)[0]?.nickname).toBe('Old');
|
||||
expect(bridge.identity.findFriend(10001)?.nickname).toBe('New');
|
||||
});
|
||||
});
|
||||
@@ -2,6 +2,14 @@ import { describe, it, expect, vi } from 'vitest';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import type { OidbBase, OidbSvcTrpcTcp0x88D_0Response } from '@snowluma/proto-defs/oidb';
|
||||
import type { OidbGetGroupExtResp } from '@snowluma/proto-defs/oidb-actions/group-ext';
|
||||
import type {
|
||||
GetGroupAdminPermissionsResponse,
|
||||
GetGroupAdminReceiveVerifyResponse,
|
||||
SetGroupAdminPermissionsRequest,
|
||||
SetGroupAdminReceiveVerifyRequest,
|
||||
SetGroupAdminReceiveVerifyResponse,
|
||||
} from '@snowluma/proto-defs/oidb-actions/group-admin-permissions';
|
||||
import type { BridgeContext } from '../../src/bridge/bridge-context';
|
||||
import type {
|
||||
Oidb0x8a0Req,
|
||||
Oidb0x8a7Resp,
|
||||
@@ -113,6 +121,160 @@ function packRobotExt(robotMemberSwitch?: number, robotMemberExamine?: number) {
|
||||
}
|
||||
|
||||
describe('apis/group-admin', () => {
|
||||
it.each([
|
||||
[0, true],
|
||||
[64, false],
|
||||
[undefined, null],
|
||||
] as const)(
|
||||
'maps receive-verification state %s without inventing missing permissions',
|
||||
async (flag, enabled) => {
|
||||
const bridge = mockBridge();
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
protobuf_encode<OidbBase<GetGroupAdminPermissionsResponse>>({
|
||||
body: {
|
||||
groupCode: 12345n,
|
||||
members: [
|
||||
{
|
||||
memberUin: 67890n,
|
||||
ext: { permissions: { items: [{ item: 1, value: 2 }] } },
|
||||
},
|
||||
],
|
||||
},
|
||||
}),
|
||||
),
|
||||
);
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
protobuf_encode<OidbBase<GetGroupAdminReceiveVerifyResponse>>({
|
||||
body: {
|
||||
groupCode: 12345n,
|
||||
members: [
|
||||
{
|
||||
identity: { uid: 'resolved-uid', uin: 67890n },
|
||||
memberFlagExt: flag,
|
||||
},
|
||||
],
|
||||
},
|
||||
}),
|
||||
),
|
||||
);
|
||||
await expect(
|
||||
new GroupAdminApi(bridge as unknown as BridgeContext).getAdminPermissions(
|
||||
12345,
|
||||
67890,
|
||||
),
|
||||
).resolves.toEqual({
|
||||
group_id: 12345,
|
||||
user_id: 67890,
|
||||
recall_member_message: null,
|
||||
kick_member: false,
|
||||
kick_member_per_day: null,
|
||||
receive_verify: enabled,
|
||||
});
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledTimes(2);
|
||||
expect(bridge.resolveUserUid).toHaveBeenCalledExactlyOnceWith(67890, 12345);
|
||||
},
|
||||
);
|
||||
|
||||
it.each(['OidbSvcTrpcTcp.0x9164_2', 'OidbSvcTrpcTcp.0xfe7_4'])(
|
||||
'rejects the combined snapshot when %s fails',
|
||||
async (failedCommand) => {
|
||||
const bridge = mockBridge();
|
||||
bridge.sendRawPacket.mockImplementation(async (command: string) => {
|
||||
if (command === failedCommand) {
|
||||
return packOidbFail(1287);
|
||||
}
|
||||
|
||||
if (command === 'OidbSvcTrpcTcp.0x9164_2') {
|
||||
return packResponse(
|
||||
protobuf_encode<OidbBase<GetGroupAdminPermissionsResponse>>({
|
||||
body: { groupCode: 12345n, members: [{ memberUin: 67890n }] },
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
return packResponse(
|
||||
protobuf_encode<OidbBase<GetGroupAdminReceiveVerifyResponse>>({
|
||||
body: {
|
||||
groupCode: 12345n,
|
||||
members: [{ identity: { uid: 'resolved-uid' }, memberFlagExt: 0 }],
|
||||
},
|
||||
}),
|
||||
);
|
||||
});
|
||||
await expect(
|
||||
new GroupAdminApi(bridge as unknown as BridgeContext).getAdminPermissions(
|
||||
12345,
|
||||
67890,
|
||||
),
|
||||
).rejects.toThrow('OIDB error 1287');
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledTimes(2);
|
||||
},
|
||||
);
|
||||
|
||||
it('propagates identity resolution failures when reading administrator permissions', async () => {
|
||||
const bridge = mockBridge();
|
||||
bridge.resolveUserUid.mockRejectedValueOnce(new Error('identity unavailable'));
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
protobuf_encode<OidbBase<GetGroupAdminPermissionsResponse>>({
|
||||
body: { groupCode: 12345n, members: [{ memberUin: 67890n }] },
|
||||
}),
|
||||
),
|
||||
);
|
||||
await expect(
|
||||
new GroupAdminApi(bridge as unknown as BridgeContext).getAdminPermissions(12345, 67890),
|
||||
).rejects.toThrow('identity unavailable');
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('writes administrator capabilities and receive-verification through separate services', async () => {
|
||||
const bridge = mockBridge();
|
||||
const api = new GroupAdminApi(bridge as unknown as BridgeContext);
|
||||
await api.setAdminPermissions(12345, 67890, { recallMemberMessage: false });
|
||||
const [permissionCmd, permissionBytes] = bridge.sendRawPacket.mock.calls[0]!;
|
||||
expect(permissionCmd).toBe('OidbSvcTrpcTcp.0x9c1c_2');
|
||||
expect(
|
||||
protobuf_decode<OidbBase<SetGroupAdminPermissionsRequest>>(permissionBytes).body,
|
||||
).toEqual({
|
||||
groupCode: 12345n,
|
||||
memberUin: 67890n,
|
||||
permissions: [{ item: 2, value: 2, extra: null }],
|
||||
});
|
||||
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
protobuf_encode<OidbBase<SetGroupAdminReceiveVerifyResponse>>({
|
||||
body: { groupCode: 12345n, result: { successfulUins: [67890n] } },
|
||||
}),
|
||||
),
|
||||
);
|
||||
await api.setAdminReceiveVerify(12345, 67890, false);
|
||||
const [verifyCmd, verifyBytes] = bridge.sendRawPacket.mock.calls[1]!;
|
||||
expect(verifyCmd).toBe('OidbSvcTrpcTcp.0x904_1');
|
||||
expect(
|
||||
protobuf_decode<OidbBase<SetGroupAdminReceiveVerifyRequest>>(verifyBytes).body,
|
||||
).toEqual({
|
||||
groupCode: 12345n,
|
||||
operation: { adminUins: [67890n], authority: 1, operate: 0 },
|
||||
});
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledTimes(2);
|
||||
expect(bridge.resolveUserUid).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does not swallow an unconfirmed receive-verification response', async () => {
|
||||
const bridge = mockBridge();
|
||||
await expect(
|
||||
new GroupAdminApi(bridge as unknown as BridgeContext).setAdminReceiveVerify(
|
||||
12345,
|
||||
67890,
|
||||
true,
|
||||
),
|
||||
).rejects.toThrow('missing or mismatched group');
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('muteMember resolves UID and dispatches 0x1253_1', async () => {
|
||||
const bridge = mockBridge();
|
||||
await new GroupAdminApi(bridge as any).muteMember(12345, 67890, 600);
|
||||
|
||||
@@ -287,7 +287,7 @@ describe('apis/group-file', () => {
|
||||
expect(publishSpy).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('upload returns success even when the chat post fails (file is still uploaded)', async () => {
|
||||
it('upload reports chat publication failure while retaining the completed file identity', async () => {
|
||||
const bridge = mockBridge();
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
@@ -297,14 +297,63 @@ describe('apis/group-file', () => {
|
||||
),
|
||||
);
|
||||
const api = new GroupFileApi(bridge as any);
|
||||
const publishSpy = vi
|
||||
.spyOn(api, 'publish')
|
||||
.mockRejectedValueOnce(new Error('message rejected'));
|
||||
const out = await api.upload(12345, '/path/file.bin');
|
||||
expect(out).toEqual({ fileId: 'fid-tolerant' });
|
||||
const cause = new Error('message rejected');
|
||||
const publishSpy = vi.spyOn(api, 'publish').mockRejectedValueOnce(cause);
|
||||
await expect(api.upload(12345, '/path/file.bin')).rejects.toMatchObject({
|
||||
message:
|
||||
'group file uploaded (fileId=fid-tolerant) but chat post failed: message rejected',
|
||||
cause,
|
||||
});
|
||||
expect(publishSpy).toHaveBeenCalledOnce();
|
||||
const staged = await vi.mocked(stageMod.stageSourceToDisk).mock.results.at(-1)!.value;
|
||||
expect(staged.cleanup).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it.each([true, false])(
|
||||
'publishes only after the upload is confirmed (confirmed=%s)',
|
||||
async (confirmed) => {
|
||||
const bridge = mockBridge();
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
packResponse(
|
||||
protobuf_encode<OidbBase<OidbGroupFileResp>>({
|
||||
body: {
|
||||
upload: {
|
||||
fileId: 'fid-confirm',
|
||||
uploadIp: '127.0.0.1',
|
||||
uploadPort: 443,
|
||||
fileKey: new Uint8Array([1]),
|
||||
checkKey: new Uint8Array([2]),
|
||||
},
|
||||
},
|
||||
}),
|
||||
),
|
||||
);
|
||||
const api = new GroupFileApi(bridge as any);
|
||||
const publishSpy = vi.spyOn(api, 'publish').mockResolvedValue();
|
||||
const failure = new Error('highway upload transport failed; current chunk unconfirmed');
|
||||
vi.mocked(highwayClient.uploadHighwayHttp).mockImplementationOnce(async () => {
|
||||
expect(publishSpy).not.toHaveBeenCalled();
|
||||
|
||||
if (!confirmed) {
|
||||
throw failure;
|
||||
}
|
||||
});
|
||||
const upload = api.upload(12345, 'base64://AQID', 'confirmed.txt');
|
||||
|
||||
if (confirmed) {
|
||||
await expect(upload).resolves.toEqual({ fileId: 'fid-confirm' });
|
||||
expect(publishSpy).toHaveBeenCalledExactlyOnceWith(12345, 'fid-confirm');
|
||||
} else {
|
||||
await expect(upload).rejects.toBe(failure);
|
||||
expect(publishSpy).not.toHaveBeenCalled();
|
||||
}
|
||||
|
||||
expect(highwayClient.uploadHighwayHttp).toHaveBeenCalledOnce();
|
||||
expect(bridge.sendRawPacket).toHaveBeenCalledOnce();
|
||||
expect(highwayClient.fetchHighwaySession).toHaveBeenCalledOnce();
|
||||
},
|
||||
);
|
||||
|
||||
it('upload caches the upload metadata for later resend by file_id', async () => {
|
||||
const bridge = mockBridge();
|
||||
bridge.sendRawPacket.mockResolvedValueOnce(
|
||||
|
||||
@@ -352,12 +352,12 @@ describe('apis/profile', () => {
|
||||
errorCode: 0,
|
||||
errorMessage: '',
|
||||
responseData: Buffer.from(
|
||||
protobuf_encode<OidbBase<Oidb0xe17Resp>>({
|
||||
body: {
|
||||
jsonBody: JSON.stringify({
|
||||
rpt_block_list: [{ uin: 10001 }, { uin: 10002 }],
|
||||
}),
|
||||
} as any,
|
||||
protobuf_encode<Oidb0xe17Resp>({
|
||||
jsonBody: JSON.stringify({
|
||||
ActionStatus: 'OK',
|
||||
ErrorCode: 0,
|
||||
rpt_block_list: [{ uin: 10001 }, { uin: 10002 }],
|
||||
}),
|
||||
}),
|
||||
),
|
||||
});
|
||||
|
||||
214
packages/core/tests/actions/qzone-public.test.ts
Normal file
214
packages/core/tests/actions/qzone-public.test.ts
Normal file
@@ -0,0 +1,214 @@
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import * as qzonePublic from '@snowluma/protocol/web/qzone-public';
|
||||
import { QzoneApi } from '../../src/bridge/apis/qzone';
|
||||
import { mockApiHub, mockBridge } from './_helpers';
|
||||
|
||||
const cookies = { p_skey: 'PSK' };
|
||||
const feed = {
|
||||
cell_common: { union_id: { feed_id: 'opaque-id' } },
|
||||
cell_feed_transfer: { future: true },
|
||||
};
|
||||
const comment = { id: 'comment-id', user: { uid: 'commenter' }, unknown: [1, 2] };
|
||||
const reply = { id: 'reply-id', user: { uid: 'recipient' } };
|
||||
const content = [{ type: 0, content: 'text', future: { enabled: true } }];
|
||||
const user = { uin: '10001', uid: 'self-uid', nick: 'self-nick' };
|
||||
const result = { feeds: [], has_more: false, next_cursor: null, unknown: { preserved: true } };
|
||||
|
||||
function makeApi() {
|
||||
const getCookies = vi.fn().mockResolvedValue(cookies);
|
||||
const bridge = mockBridge({ apis: { ...mockApiHub(), web: { getCookies } } as never });
|
||||
return { api: new QzoneApi(bridge as never), bridge, getCookies };
|
||||
}
|
||||
|
||||
const cases = [
|
||||
{
|
||||
method: 'getQzoneHomeFeeds',
|
||||
invoke: (api: QzoneApi) => api.getHomeFeeds(20002, 'cursor'),
|
||||
args: [cookies, '10001', '20002', 'cursor'],
|
||||
},
|
||||
{
|
||||
method: 'getQzonePublicCapabilities',
|
||||
invoke: (api: QzoneApi) => api.getPublicCapabilities(),
|
||||
args: [cookies, '10001'],
|
||||
},
|
||||
{
|
||||
method: 'getQzonePublicFeeds',
|
||||
invoke: (api: QzoneApi) => api.getPublicFeeds('cursor'),
|
||||
args: [cookies, '10001', 'cursor'],
|
||||
},
|
||||
{
|
||||
method: 'getQzonePublicFeedDetail',
|
||||
invoke: (api: QzoneApi) => api.getPublicFeedDetail(feed),
|
||||
args: [cookies, feed],
|
||||
},
|
||||
{
|
||||
method: 'getQzonePublicComments',
|
||||
invoke: (api: QzoneApi) => api.getPublicComments(feed, 'cursor'),
|
||||
args: [cookies, feed, 'cursor'],
|
||||
},
|
||||
{
|
||||
method: 'getQzonePublicReplies',
|
||||
invoke: (api: QzoneApi) => api.getPublicReplies(feed, comment, 'cursor', 5),
|
||||
args: [cookies, feed, comment, 'cursor', 5],
|
||||
},
|
||||
{
|
||||
method: 'setQzonePublicUpvote',
|
||||
invoke: (api: QzoneApi) => api.setPublicUpvote(feed, false),
|
||||
args: [cookies, feed, false],
|
||||
},
|
||||
{
|
||||
method: 'setQzonePublicLike',
|
||||
invoke: (api: QzoneApi) => api.setPublicLike(feed, false),
|
||||
args: [cookies, feed, false],
|
||||
},
|
||||
{
|
||||
method: 'setQzonePublicCommentLike',
|
||||
invoke: (api: QzoneApi) => api.setPublicCommentLike(feed, comment, false, reply),
|
||||
args: [cookies, feed, comment, false, reply],
|
||||
},
|
||||
{
|
||||
method: 'commentQzonePublicFeed',
|
||||
invoke: (api: QzoneApi) => api.commentPublicFeed(feed, content),
|
||||
args: [cookies, feed, user, content],
|
||||
},
|
||||
{
|
||||
method: 'replyQzonePublicFeed',
|
||||
invoke: (api: QzoneApi) => api.replyPublicFeed(feed, comment, content, reply),
|
||||
args: [cookies, feed, user, comment, content, reply],
|
||||
},
|
||||
{
|
||||
method: 'deleteQzonePublicComment',
|
||||
invoke: (api: QzoneApi) => api.deletePublicComment(feed, comment),
|
||||
args: [cookies, feed, comment],
|
||||
},
|
||||
{
|
||||
method: 'deleteQzonePublicReply',
|
||||
invoke: (api: QzoneApi) => api.deletePublicReply(feed, comment, reply),
|
||||
args: [cookies, feed, comment, reply],
|
||||
},
|
||||
{
|
||||
method: 'setQzonePublicFollow',
|
||||
invoke: (api: QzoneApi) => api.setPublicFollow(feed, false),
|
||||
args: [cookies, feed, false],
|
||||
},
|
||||
{
|
||||
method: 'forwardQzonePublicFeed',
|
||||
invoke: (api: QzoneApi) => api.forwardPublicFeed(feed, 'reason'),
|
||||
args: [cookies, feed, 'reason'],
|
||||
},
|
||||
] as const;
|
||||
|
||||
describe('apis/qzone public', () => {
|
||||
afterEach(() => vi.restoreAllMocks());
|
||||
|
||||
it('reads a post by tid using current-account credentials', async () => {
|
||||
const { api, getCookies } = makeApi();
|
||||
const tid = '1127000000f1536501000000';
|
||||
const detail = { feed, attach_info: 'comments-next' };
|
||||
const request = vi.spyOn(qzonePublic, 'getQzoneFeedDetail').mockResolvedValue(detail);
|
||||
|
||||
expect(await api.getFeedDetail(tid)).toBe(detail);
|
||||
expect(getCookies).toHaveBeenCalledExactlyOnceWith('qzone.qq.com');
|
||||
expect(request).toHaveBeenCalledExactlyOnceWith(cookies, tid);
|
||||
});
|
||||
|
||||
it('propagates feed detail and cookie failures without replay', async () => {
|
||||
const { api, getCookies } = makeApi();
|
||||
const request = vi
|
||||
.spyOn(qzonePublic, 'getQzoneFeedDetail')
|
||||
.mockRejectedValue(new Error('denied'));
|
||||
|
||||
await expect(api.getFeedDetail('1127000000f1536501000000')).rejects.toThrow('denied');
|
||||
getCookies.mockRejectedValueOnce(new Error('cookie failure'));
|
||||
await expect(api.getFeedDetail('1127000000f1536501000000')).rejects.toThrow(
|
||||
'cookie failure',
|
||||
);
|
||||
expect(request).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('generates a share card with the account cookies and preserves its notice', async () => {
|
||||
const { api, getCookies } = makeApi();
|
||||
const card = { ark: '{}', requires_confirmation: true, notice: '所有人可见' };
|
||||
const request = vi.spyOn(qzonePublic, 'getQzoneShareArk').mockResolvedValue(card);
|
||||
expect(await api.getShareArk(feed)).toBe(card);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(request).toHaveBeenCalledExactlyOnceWith(cookies, feed);
|
||||
request.mockRejectedValueOnce(new Error('share denied'));
|
||||
await expect(api.getShareArk(feed)).rejects.toThrow('share denied');
|
||||
});
|
||||
|
||||
it.each(cases)(
|
||||
'$method uses current-account cookies and preserves upstream objects',
|
||||
async ({ method, invoke, args }) => {
|
||||
const { api, getCookies } = makeApi();
|
||||
const request = vi.spyOn(qzonePublic, method).mockResolvedValue(result);
|
||||
|
||||
expect(await invoke(api)).toBe(result);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(request).toHaveBeenCalledExactlyOnceWith(...args);
|
||||
},
|
||||
);
|
||||
|
||||
it.each(cases)(
|
||||
'$method propagates cookie and upstream failures without replay',
|
||||
async ({ method, invoke }) => {
|
||||
const { api, getCookies } = makeApi();
|
||||
const request = vi
|
||||
.spyOn(qzonePublic, method)
|
||||
.mockRejectedValue(new Error('upstream denied'));
|
||||
|
||||
await expect(invoke(api)).rejects.toThrow('upstream denied');
|
||||
getCookies.mockRejectedValueOnce(new Error('cookie failure'));
|
||||
await expect(invoke(api)).rejects.toThrow('cookie failure');
|
||||
expect(request).toHaveBeenCalledTimes(1);
|
||||
},
|
||||
);
|
||||
|
||||
it('keeps documented defaults and omits an optional reply target', async () => {
|
||||
const { api } = makeApi();
|
||||
const feeds = vi.spyOn(qzonePublic, 'getQzonePublicFeeds').mockResolvedValue(result);
|
||||
const replies = vi.spyOn(qzonePublic, 'getQzonePublicReplies').mockResolvedValue(result);
|
||||
const upvote = vi.spyOn(qzonePublic, 'setQzonePublicUpvote').mockResolvedValue(result);
|
||||
const like = vi.spyOn(qzonePublic, 'setQzonePublicLike').mockResolvedValue(result);
|
||||
const commentLike = vi
|
||||
.spyOn(qzonePublic, 'setQzonePublicCommentLike')
|
||||
.mockResolvedValue(result);
|
||||
const follow = vi.spyOn(qzonePublic, 'setQzonePublicFollow').mockResolvedValue(result);
|
||||
const forward = vi.spyOn(qzonePublic, 'forwardQzonePublicFeed').mockResolvedValue(result);
|
||||
const replyRequest = vi
|
||||
.spyOn(qzonePublic, 'replyQzonePublicFeed')
|
||||
.mockResolvedValue(result);
|
||||
|
||||
await api.getPublicFeeds();
|
||||
await api.getPublicReplies(feed, comment);
|
||||
await api.setPublicUpvote(feed);
|
||||
await api.setPublicLike(feed);
|
||||
await api.setPublicCommentLike(feed, comment);
|
||||
await api.setPublicFollow(feed);
|
||||
await api.forwardPublicFeed(feed);
|
||||
await api.replyPublicFeed(feed, comment, 'text');
|
||||
|
||||
expect(feeds).toHaveBeenCalledWith(cookies, '10001', undefined);
|
||||
expect(replies).toHaveBeenCalledWith(cookies, feed, comment, '', 20);
|
||||
expect(upvote).toHaveBeenCalledWith(cookies, feed, true);
|
||||
expect(like).toHaveBeenCalledWith(cookies, feed, true);
|
||||
expect(commentLike).toHaveBeenCalledWith(cookies, feed, comment, true, undefined);
|
||||
expect(follow).toHaveBeenCalledWith(cookies, feed, true);
|
||||
expect(forward).toHaveBeenCalledWith(cookies, feed, '');
|
||||
expect(replyRequest).toHaveBeenCalledWith(cookies, feed, user, comment, 'text', undefined);
|
||||
});
|
||||
|
||||
it('binds comment authors to the current account even when its uid is unavailable', async () => {
|
||||
const { api, bridge } = makeApi();
|
||||
Object.assign(bridge.identity, { selfUid: undefined });
|
||||
const request = vi.spyOn(qzonePublic, 'commentQzonePublicFeed').mockResolvedValue(result);
|
||||
|
||||
await api.commentPublicFeed(feed, 'text');
|
||||
expect(request).toHaveBeenCalledWith(
|
||||
cookies,
|
||||
feed,
|
||||
{ uin: '10001', uid: '', nick: 'self-nick' },
|
||||
'text',
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -20,6 +20,61 @@ describe('apis/qzone', () => {
|
||||
return { bridge, getCookies, fetchSpy };
|
||||
}
|
||||
|
||||
it.each([undefined, 20002])(
|
||||
'getProfile reads owner %s with the current account credentials',
|
||||
async (targetUin) => {
|
||||
const { bridge, getCookies } = bridgeWithWeb();
|
||||
const profile = { name: 'My space', description: 'Notes' };
|
||||
const getProfile = vi.spyOn(qzoneWeb, 'getQzoneProfile').mockResolvedValue(profile);
|
||||
|
||||
expect(await new QzoneApi(bridge as never).getProfile(targetUin)).toEqual(profile);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(getProfile).toHaveBeenCalledWith(
|
||||
{ p_skey: 'PSK' },
|
||||
'10001',
|
||||
targetUin?.toString(),
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
it('getProfile propagates cookie and protocol failures', async () => {
|
||||
const { bridge, getCookies } = bridgeWithWeb();
|
||||
const api = new QzoneApi(bridge as never);
|
||||
const getProfile = vi
|
||||
.spyOn(qzoneWeb, 'getQzoneProfile')
|
||||
.mockRejectedValue(new Error('denied'));
|
||||
|
||||
await expect(api.getProfile(20002)).rejects.toThrow('denied');
|
||||
getCookies.mockRejectedValueOnce(new Error('cookie failure'));
|
||||
await expect(api.getProfile()).rejects.toThrow('cookie failure');
|
||||
expect(getProfile).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it.each([{ name: 'New name' }, { description: '' }, { name: '', description: 'New notes' }])(
|
||||
'setProfile writes only the supplied fields to the current account (%j)',
|
||||
async (profile) => {
|
||||
const { bridge, getCookies } = bridgeWithWeb();
|
||||
const setProfile = vi.spyOn(qzoneWeb, 'setQzoneProfile').mockResolvedValue();
|
||||
|
||||
await new QzoneApi(bridge as never).setProfile(profile);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(setProfile).toHaveBeenCalledWith({ p_skey: 'PSK' }, '10001', profile);
|
||||
},
|
||||
);
|
||||
|
||||
it('setProfile propagates cookie and protocol failures', async () => {
|
||||
const { bridge, getCookies } = bridgeWithWeb();
|
||||
const api = new QzoneApi(bridge as never);
|
||||
const setProfile = vi
|
||||
.spyOn(qzoneWeb, 'setQzoneProfile')
|
||||
.mockRejectedValue(new Error('captcha required'));
|
||||
|
||||
await expect(api.setProfile({ name: 'New name' })).rejects.toThrow('captcha required');
|
||||
getCookies.mockRejectedValueOnce(new Error('cookie failure'));
|
||||
await expect(api.setProfile({ description: 'Notes' })).rejects.toThrow('cookie failure');
|
||||
expect(setProfile).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it.each([undefined, 20002])(
|
||||
'getMsgDetail uses current-account credentials for owner %s',
|
||||
async (targetUin) => {
|
||||
@@ -77,10 +132,18 @@ describe('apis/qzone', () => {
|
||||
const bridge = mockBridge({ apis: { ...mockApiHub(), web: { getCookies } } as never });
|
||||
const feedsSpy = vi
|
||||
.spyOn(qzoneWeb, 'getQzoneFeeds')
|
||||
.mockResolvedValue({ feeds: [], has_more: false });
|
||||
.mockResolvedValue({ feeds: [], has_more: false, next_cursor: null });
|
||||
await new QzoneApi(bridge as never).getFeeds(3, 20);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(feedsSpy).toHaveBeenCalledWith({ p_skey: 'PSK' }, '10001', 3, 20);
|
||||
expect(feedsSpy).toHaveBeenCalledWith({ p_skey: 'PSK' }, '10001', 3, 20, undefined);
|
||||
await new QzoneApi(bridge as never).getFeeds(1, 20, 'opaque-cursor');
|
||||
expect(feedsSpy).toHaveBeenLastCalledWith(
|
||||
{ p_skey: 'PSK' },
|
||||
'10001',
|
||||
1,
|
||||
20,
|
||||
'opaque-cursor',
|
||||
);
|
||||
});
|
||||
|
||||
it('uploadImageFromSource uploads from file:// http:// base64:// and returns richval + url', async () => {
|
||||
@@ -290,4 +353,53 @@ describe('apis/qzone', () => {
|
||||
richval,
|
||||
);
|
||||
});
|
||||
|
||||
it.each([undefined, 20002])(
|
||||
'routes replies with the account cookies and post owner (%s)',
|
||||
async (targetUin) => {
|
||||
const getCookies = vi.fn(async () => ({ p_skey: 'PSK' }));
|
||||
const bridge = mockBridge({ apis: { ...mockApiHub(), web: { getCookies } } as never });
|
||||
const target = {
|
||||
commentId: '0',
|
||||
commentUin: '30003',
|
||||
replyTo: { uin: '40004', name: 'Reader' },
|
||||
};
|
||||
const result = { comment_id: '8', parent_comment_id: '0', parent_comment_uin: 30003 };
|
||||
const replySpy = vi.spyOn(qzoneWeb, 'replyQzoneComment').mockResolvedValue(result);
|
||||
const commentSpy = vi.spyOn(qzoneWeb, 'commentQzoneMsg');
|
||||
|
||||
const out = await new QzoneApi(bridge as never).comment(
|
||||
'TIDX',
|
||||
'Reply',
|
||||
targetUin,
|
||||
undefined,
|
||||
undefined,
|
||||
target,
|
||||
);
|
||||
|
||||
expect(out).toEqual(result);
|
||||
expect(getCookies).toHaveBeenCalledWith('qzone.qq.com');
|
||||
expect(replySpy).toHaveBeenCalledWith(
|
||||
{ p_skey: 'PSK' },
|
||||
'10001',
|
||||
String(targetUin ?? 10001),
|
||||
'TIDX',
|
||||
'Reply',
|
||||
target,
|
||||
);
|
||||
expect(commentSpy).not.toHaveBeenCalled();
|
||||
},
|
||||
);
|
||||
|
||||
it('rejects reply images before acquiring cookies or sending', async () => {
|
||||
const getCookies = vi.fn();
|
||||
const bridge = mockBridge({ apis: { ...mockApiHub(), web: { getCookies } } as never });
|
||||
await expect(
|
||||
new QzoneApi(bridge as never).comment('TIDX', 'Reply', undefined, 1, 'URL', {
|
||||
commentId: '0',
|
||||
commentUin: '30003',
|
||||
}),
|
||||
).rejects.toThrow('images are not supported');
|
||||
expect(getCookies).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
234
packages/core/tests/bridge-client-message.test.ts
Normal file
234
packages/core/tests/bridge-client-message.test.ts
Normal file
@@ -0,0 +1,234 @@
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { CLIENT_MESSAGE_RECEIPT_CMD, type PacketInfo } from '@snowluma/common/protocol-types';
|
||||
import type { PacketSender, SendPacketResult } from '@snowluma/common/packet-sender';
|
||||
import type { SendMessageResponse } from '@snowluma/proto-defs/action';
|
||||
import type { SsoGetC2cMsgResponse } from '@snowluma/proto-defs/get-c2c-msg';
|
||||
import { protobuf_encode } from '@snowluma/proton';
|
||||
import { IdentityService } from '@snowluma/protocol/identity-service';
|
||||
import { Bridge } from '../src/bridge/bridge';
|
||||
|
||||
const bridges: Bridge[] = [];
|
||||
const timestamp = 1_700_000_000;
|
||||
|
||||
function deferred<T>() {
|
||||
let resolve!: (value: T) => void;
|
||||
const promise = new Promise<T>((accept) => {
|
||||
resolve = accept;
|
||||
});
|
||||
return { promise, resolve };
|
||||
}
|
||||
|
||||
afterEach(async () => {
|
||||
await Promise.all(bridges.splice(0).map((bridge) => bridge.dispose()));
|
||||
vi.useRealTimers();
|
||||
vi.restoreAllMocks();
|
||||
});
|
||||
|
||||
function packet(): PacketInfo {
|
||||
const uid = Buffer.from('u_test_peer');
|
||||
const header = Buffer.alloc(8);
|
||||
header[0] = 1;
|
||||
header[1] = uid.length;
|
||||
header.writeUInt32LE(9, 4);
|
||||
return {
|
||||
pid: 1234,
|
||||
uin: '10001',
|
||||
source: 'client-message',
|
||||
serviceCmd: CLIENT_MESSAGE_RECEIPT_CMD,
|
||||
seqId: 42,
|
||||
retCode: 0,
|
||||
fromClient: false,
|
||||
body: Buffer.concat([
|
||||
header,
|
||||
uid,
|
||||
protobuf_encode<SendMessageResponse>({ privateSequence: 87, timestamp1: timestamp }),
|
||||
]),
|
||||
};
|
||||
}
|
||||
|
||||
function response(): SendPacketResult {
|
||||
return {
|
||||
success: true,
|
||||
gotResponse: true,
|
||||
errorCode: 0,
|
||||
errorMessage: '',
|
||||
responseData: Buffer.from(
|
||||
protobuf_encode<SsoGetC2cMsgResponse>({
|
||||
friendUid: 'u_test_peer',
|
||||
messages: [
|
||||
{
|
||||
responseHead: {
|
||||
fromUin: 10001,
|
||||
fromUid: 'u_test_self',
|
||||
toUin: 20002,
|
||||
toUid: 'u_test_peer',
|
||||
},
|
||||
contentHead: {
|
||||
msgType: 166,
|
||||
sequence: 9,
|
||||
ntMsgSeq: 87,
|
||||
timestamp,
|
||||
msgId: 123456,
|
||||
},
|
||||
body: { richText: { elems: [{ text: { str: 'hello' } }] } },
|
||||
},
|
||||
],
|
||||
}),
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
async function setup() {
|
||||
const bridge = new Bridge(IdentityService.memory('10001'));
|
||||
bridges.push(bridge);
|
||||
vi.spyOn(bridge.apis.contacts, 'fetchFriendList').mockResolvedValue([
|
||||
{ uin: 10001, uid: 'u_test_self', nickname: 'self', remark: '' },
|
||||
]);
|
||||
vi.spyOn(bridge.apis.contacts, 'fetchGroupList').mockResolvedValue([]);
|
||||
const sendPacket = vi.fn<PacketSender['sendPacket']>(async () => response());
|
||||
const sender = { sendPacket };
|
||||
bridge.bindPid(1234, sender);
|
||||
await bridge.whenRosterWarmupSettled();
|
||||
const received = vi.fn();
|
||||
bridge.events.on('friend_message', received);
|
||||
return { bridge, sendPacket, sender, received };
|
||||
}
|
||||
|
||||
describe('Bridge client message recovery', () => {
|
||||
it('does not retry a delayed lookup on a detached or replacement connection', async () => {
|
||||
const ctx = await setup();
|
||||
vi.useFakeTimers();
|
||||
ctx.sendPacket.mockResolvedValue({
|
||||
...response(),
|
||||
responseData: Buffer.from(
|
||||
protobuf_encode<SsoGetC2cMsgResponse>({
|
||||
result: 100000301,
|
||||
friendUid: 'u_test_peer',
|
||||
}),
|
||||
),
|
||||
});
|
||||
const work = ctx.bridge.onPacket(packet());
|
||||
const rejected = expect(work).rejects.toThrow('inactive connection');
|
||||
await vi.advanceTimersByTimeAsync(0);
|
||||
expect(ctx.sendPacket).toHaveBeenCalledOnce();
|
||||
ctx.bridge.detachPid(1234);
|
||||
const replacement = vi.fn<PacketSender['sendPacket']>();
|
||||
ctx.bridge.bindPid(1234, { sendPacket: replacement });
|
||||
await vi.runAllTimersAsync();
|
||||
await rejected;
|
||||
expect(ctx.sendPacket).toHaveBeenCalledOnce();
|
||||
expect(replacement).not.toHaveBeenCalled();
|
||||
expect(ctx.received).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('dispatches confirmed content through the normal event pipeline', async () => {
|
||||
const ctx = await setup();
|
||||
await ctx.bridge.onPacket(packet());
|
||||
expect(ctx.sendPacket).toHaveBeenCalledOnce();
|
||||
expect(ctx.received).toHaveBeenCalledOnce();
|
||||
expect(ctx.received).toHaveBeenCalledWith(
|
||||
expect.objectContaining({
|
||||
kind: 'friend_message',
|
||||
selfUin: 10001,
|
||||
senderUin: 10001,
|
||||
peerUin: 20002,
|
||||
ntMsgSeq: 87,
|
||||
clientSeq: 9,
|
||||
elements: [{ type: 'text', text: 'hello' }],
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it('does not treat an ordinary packet with the same command as a receipt', async () => {
|
||||
const ctx = await setup();
|
||||
const ordinary = packet();
|
||||
delete ordinary.source;
|
||||
await ctx.bridge.onPacket(ordinary);
|
||||
expect(ctx.sendPacket).not.toHaveBeenCalled();
|
||||
expect(ctx.received).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('shares an in-flight lookup across repeated receipts and ordinary PID observations', async () => {
|
||||
const ctx = await setup();
|
||||
const result = deferred<SendPacketResult>();
|
||||
const started = deferred<void>();
|
||||
ctx.sendPacket.mockImplementation(() => {
|
||||
started.resolve();
|
||||
return result.promise;
|
||||
});
|
||||
const first = ctx.bridge.onPacket(packet());
|
||||
await started.promise;
|
||||
ctx.bridge.bindPid(1234, ctx.sender);
|
||||
const duplicate = ctx.bridge.onPacket(packet());
|
||||
await Promise.resolve();
|
||||
result.resolve(response());
|
||||
await Promise.all([first, duplicate]);
|
||||
expect(ctx.sendPacket).toHaveBeenCalledOnce();
|
||||
expect(ctx.received).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it.each(['detach', 'replace', 'reattach', 'dispose'] as const)(
|
||||
'rejects a lookup completed after %s',
|
||||
async (action) => {
|
||||
const ctx = await setup();
|
||||
const result = deferred<SendPacketResult>();
|
||||
const started = deferred<void>();
|
||||
ctx.sendPacket.mockImplementation(() => {
|
||||
started.resolve();
|
||||
return result.promise;
|
||||
});
|
||||
const work = ctx.bridge.onPacket(packet());
|
||||
const rejected = expect(work).rejects.toThrow('inactive connection');
|
||||
await started.promise;
|
||||
let disposal: Promise<void> | undefined;
|
||||
|
||||
if (action === 'dispose') {
|
||||
disposal = ctx.bridge.dispose();
|
||||
} else if (action === 'replace') {
|
||||
ctx.bridge.bindPid(1234, { sendPacket: vi.fn() });
|
||||
} else {
|
||||
ctx.bridge.detachPid(1234);
|
||||
|
||||
if (action === 'reattach') {
|
||||
ctx.bridge.bindPid(1234, ctx.sender);
|
||||
}
|
||||
}
|
||||
|
||||
result.resolve(response());
|
||||
await rejected;
|
||||
await disposal;
|
||||
expect(ctx.received).not.toHaveBeenCalled();
|
||||
},
|
||||
);
|
||||
|
||||
it('queries the originating connection even when another process is active', async () => {
|
||||
const ctx = await setup();
|
||||
const other = { sendPacket: vi.fn<PacketSender['sendPacket']>() };
|
||||
ctx.bridge.bindPid(4321, other);
|
||||
await ctx.bridge.onPacket(packet());
|
||||
expect(ctx.sendPacket).toHaveBeenCalledOnce();
|
||||
expect(other.sendPacket).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('rejects unavailable, detached and wrong-account receipts before querying', async () => {
|
||||
const ctx = await setup();
|
||||
await expect(ctx.bridge.onPacket({ ...packet(), retCode: -1 })).rejects.toThrow(
|
||||
'unavailable',
|
||||
);
|
||||
await expect(ctx.bridge.onPacket({ ...packet(), uin: '20002' })).rejects.toThrow('account');
|
||||
ctx.bridge.detachPid(1234);
|
||||
await expect(ctx.bridge.onPacket(packet())).rejects.toThrow('inactive connection');
|
||||
expect(ctx.sendPacket).not.toHaveBeenCalled();
|
||||
expect(ctx.received).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('surfaces lookup failure and allows a later receipt to retry', async () => {
|
||||
const ctx = await setup();
|
||||
ctx.sendPacket.mockRejectedValueOnce(new Error('lookup failed'));
|
||||
await expect(ctx.bridge.onPacket(packet())).rejects.toThrow('lookup failed');
|
||||
expect(ctx.received).not.toHaveBeenCalled();
|
||||
await ctx.bridge.onPacket(packet());
|
||||
expect(ctx.sendPacket).toHaveBeenCalledTimes(2);
|
||||
expect(ctx.received).toHaveBeenCalledOnce();
|
||||
});
|
||||
});
|
||||
@@ -115,6 +115,55 @@ describe('BridgeManager shutdown', () => {
|
||||
}
|
||||
});
|
||||
|
||||
it('reopening is not poisoned by an already-failed close', async () => {
|
||||
const failing = deferred();
|
||||
manager.onHookLogin(101, '10001', sender);
|
||||
vi.spyOn(manager.getBridge('10001')!.identity, 'close').mockReturnValue(failing.promise);
|
||||
manager.onPidDisconnected(101);
|
||||
failing.reject(new Error('close failed'));
|
||||
await nextTurn();
|
||||
|
||||
// The failed close stays in the bookkeeping (dispose still reports
|
||||
// it), but the reopening gate must absorb the rejection instead of
|
||||
// passing it down — a rejected gate would keep the identity DB of
|
||||
// every future session for this UIN closed until process restart.
|
||||
manager.onHookLogin(202, '10001', sender);
|
||||
const beforeOpen = vi.mocked(IdentityService.openForUin).mock.calls.at(-1)![2]!;
|
||||
await expect(beforeOpen).resolves.toBeUndefined();
|
||||
});
|
||||
|
||||
it('reopening waits for all closes to settle even when one of them fails', async () => {
|
||||
const failing = deferred();
|
||||
const slow = deferred();
|
||||
manager.onHookLogin(101, '10001', sender);
|
||||
vi.spyOn(manager.getBridge('10001')!.identity, 'close').mockReturnValue(failing.promise);
|
||||
manager.onPidDisconnected(101);
|
||||
manager.onHookLogin(202, '10001', sender);
|
||||
vi.spyOn(manager.getBridge('10001')!.identity, 'close').mockReturnValue(slow.promise);
|
||||
manager.onPidDisconnected(202);
|
||||
|
||||
failing.reject(new Error('close failed'));
|
||||
await nextTurn();
|
||||
|
||||
manager.onHookLogin(303, '10001', sender);
|
||||
const beforeOpen = vi.mocked(IdentityService.openForUin).mock.calls.at(-1)![2]!;
|
||||
let ready = false;
|
||||
const opening = beforeOpen.then(() => {
|
||||
ready = true;
|
||||
});
|
||||
|
||||
try {
|
||||
await nextTurn();
|
||||
// Still waiting for the pending close...
|
||||
expect(ready).toBe(false);
|
||||
} finally {
|
||||
slow.resolve();
|
||||
}
|
||||
|
||||
// ...and the already-failed close must not reject the gate.
|
||||
await opening;
|
||||
});
|
||||
|
||||
it('ignores late transport callbacks after shutdown starts', async () => {
|
||||
const shutdown = manager.dispose();
|
||||
manager.onHookLogin(101, '10001', sender);
|
||||
|
||||
@@ -2,7 +2,11 @@ import { describe, expect, it, vi } from 'vitest';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import type { SendPacketResult } from '@snowluma/common/packet-sender';
|
||||
import type { DatalineMsgBody, DatalineTextMsg } from '@snowluma/proto-defs/dataline';
|
||||
import type { SendMessageRequest, SendMessageResponse } from '@snowluma/proto-defs/action';
|
||||
import type {
|
||||
SendMessageRequest,
|
||||
SendMessageResponse,
|
||||
SendRichText,
|
||||
} from '@snowluma/proto-defs/action';
|
||||
import type { FileExtra } from '@snowluma/proto-defs/message';
|
||||
import { DATALINE_UIN_PHONE } from '@snowluma/protocol/dataline/device-contacts';
|
||||
import type { OidbBase } from '@snowluma/proto-defs/oidb';
|
||||
@@ -10,6 +14,9 @@ import type { OidbOfflineFileFinalizeResp } from '@snowluma/proto-defs/oidb-acti
|
||||
|
||||
vi.mock('@snowluma/protocol/element-builder', () => ({
|
||||
buildSendElems: vi.fn(async () => [{ text: { str: 'stub media elem' } }]),
|
||||
encodePrivateRichText: vi.fn(async () =>
|
||||
protobuf_encode<SendRichText>({ elems: [{ text: { str: 'stub media elem' } }] }),
|
||||
),
|
||||
}));
|
||||
|
||||
// Imported statically (not via `await import` inside each `it`) so the heavy
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import type { SendRichText } from '@snowluma/proto-defs/action';
|
||||
// Regression test for the c2c-vs-group businessType asymmetry that made
|
||||
// private-chat video / record sends bounce with `send private message
|
||||
// rejected: result=79`. The receive-side decoder
|
||||
@@ -22,15 +23,16 @@ vi.mock('@snowluma/protocol/highway/image-upload', () => ({
|
||||
uploadImageMsgInfo: vi.fn(async () => new Uint8Array([7, 8, 9])),
|
||||
}));
|
||||
vi.mock('@snowluma/protocol/highway/ptt-upload', () => ({
|
||||
uploadPttMsgInfo: vi.fn(async () => new Uint8Array([4, 5, 6])),
|
||||
uploadPtt: vi.fn(async () => ({ msgInfo: new Uint8Array([4, 5, 6]) })),
|
||||
}));
|
||||
vi.mock('@snowluma/protocol/highway/video-upload', () => ({
|
||||
uploadVideoMsgInfo: vi.fn(async () => new Uint8Array([1, 2, 3])),
|
||||
}));
|
||||
|
||||
import { protobuf_encode } from '@snowluma/proton';
|
||||
import { type bytes, type pb, protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import type { MsgInfo } from '@snowluma/proto-defs/element';
|
||||
import { buildSendElems } from '@snowluma/protocol/element-builder';
|
||||
import { buildSendElems, encodePrivateRichText } from '@snowluma/protocol/element-builder';
|
||||
import { uploadPtt } from '@snowluma/protocol/highway/ptt-upload';
|
||||
import { MessageElementValidationError } from '@snowluma/protocol/element-manifest';
|
||||
import { uploadImageMsgInfo } from '@snowluma/protocol/highway/image-upload';
|
||||
import { uploadVideoMsgInfo } from '@snowluma/protocol/highway/video-upload';
|
||||
@@ -569,3 +571,33 @@ describe('element-builder / forward preview', () => {
|
||||
).rejects.toBeInstanceOf(MessageElementValidationError);
|
||||
});
|
||||
});
|
||||
|
||||
describe('private voice compatibility', () => {
|
||||
const context = { bridge: fakeBridge, userUid: 'u_peer', scene: 'direct-private' } as const;
|
||||
const record = { type: 'record', url: 'voice.amr' } as const;
|
||||
const modern = Uint8Array.of(4, 5, 6);
|
||||
|
||||
it('keeps all modern clips when one legacy voice slot cannot represent the message', async () => {
|
||||
const compat = protobuf_encode<{ ptt?: pb<4, bytes> }>({ ptt: Uint8Array.of(8, 4) });
|
||||
vi.mocked(uploadPtt)
|
||||
.mockResolvedValueOnce({ msgInfo: modern, compatQMsg: compat })
|
||||
.mockResolvedValueOnce({ msgInfo: modern, compatQMsg: compat });
|
||||
const rich = await encodePrivateRichText([record, record], context);
|
||||
expect(protobuf_decode<{ ptt?: pb<4, bytes> }>(rich).ptt).toBeNull();
|
||||
expect(protobuf_decode<SendRichText>(rich).elems).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('sends modern voice when no compatibility data is available and rejects malformed data', async () => {
|
||||
vi.mocked(uploadPtt).mockResolvedValueOnce({ msgInfo: modern });
|
||||
expect(
|
||||
protobuf_decode<SendRichText>(await encodePrivateRichText([record], context)).elems,
|
||||
).toHaveLength(1);
|
||||
vi.mocked(uploadPtt).mockResolvedValueOnce({
|
||||
msgInfo: modern,
|
||||
compatQMsg: Uint8Array.of(0x12, 0),
|
||||
});
|
||||
await expect(encodePrivateRichText([record], context)).rejects.toThrow(
|
||||
'incomplete playback information',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
14
packages/core/tests/fixtures/issue-614-private-voice-upload.hex
vendored
Normal file
14
packages/core/tests/fixtures/issue-614-private-voice-upload.hex
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
08ed241064180022ef0412ec0432b9020af6010af3010a7d08fb3d122030303030303030303030303030303030303030
|
||||
303030303030303030303030301a28303030303030303030303030303030303030303030303030303030303030303030
|
||||
30303030303030222430303030303030303030303030303030303030303030303030303030303030302e616d722a0408
|
||||
032001400312637878787878787878787878787878787878787878787878787878787878787878787878787878787878
|
||||
787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878
|
||||
7878787878787878787818012081808080012881800138fa0a123e0a0612047465737412001a3208818080800110012a
|
||||
22081e121e0505050505050505050505050505050505050505050505050505050505055a040800380042ad02122baa02
|
||||
289a0125aa0322081e121e05050505050505050505050505050505050505050505050505050505050522fd0108041081
|
||||
808080011a97017878787878787878787878787878787878787878787878787878787878787878787878787878787878
|
||||
787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878
|
||||
787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878787878
|
||||
78787878787878787878787878782210000000000000000000000000000000002a243030303030303030303030303030
|
||||
3030303030303030303030303030303030302e616d7230fb3d3a16000000000000000000000000000000000000000000
|
||||
005801980103e80101
|
||||
@@ -208,6 +208,56 @@ describe('MessageApi history pagination', () => {
|
||||
expect(result.map((message) => message.ntMsgSeq)).toEqual([63213, 63214, 63215]);
|
||||
});
|
||||
|
||||
it('splits a 200-message private history request into bounded pages', async () => {
|
||||
mockC2cRoamFetch.mockImplementation(
|
||||
async (_sender, _identity, _self, _friend, time, count) => ({
|
||||
messages: Array.from({ length: count }, (_, index) => ({
|
||||
...gm(time - index),
|
||||
kind: 'friend_message',
|
||||
ntMsgSeq: time - index,
|
||||
})),
|
||||
cursor: { time: time - count, random: 1 },
|
||||
isComplete: false,
|
||||
}),
|
||||
);
|
||||
const result = await runHistory(
|
||||
new MessageApi(ctx).getC2cLatestHistory('u_friend', 200, 10001, 1000),
|
||||
);
|
||||
expect(result).toHaveLength(200);
|
||||
expect(mockC2cRoamFetch.mock.calls.map((call) => call[5])).toEqual([100, 100]);
|
||||
expect(result.map((message) => message.ntMsgSeq)).toEqual(
|
||||
Array.from({ length: 200 }, (_, index) => 801 + index),
|
||||
);
|
||||
});
|
||||
|
||||
it('honors completion even when the last page still includes a cursor', async () => {
|
||||
mockC2cRoamFetch.mockResolvedValue({
|
||||
messages: [{ ...gm(1), kind: 'friend_message', ntMsgSeq: 1 }],
|
||||
cursor: { time: 100, random: 2 },
|
||||
isComplete: true,
|
||||
});
|
||||
const result = await runHistory(
|
||||
new MessageApi(ctx).getC2cLatestHistory('u_friend', 20, 10001, 1000),
|
||||
);
|
||||
expect(result).toHaveLength(1);
|
||||
expect(mockC2cRoamFetch).toHaveBeenCalledOnce();
|
||||
});
|
||||
|
||||
it('does not return partial history after a later request fails', async () => {
|
||||
mockC2cRoamFetch
|
||||
.mockResolvedValueOnce({
|
||||
messages: [{ ...gm(1), kind: 'friend_message', ntMsgSeq: 1 }],
|
||||
cursor: { time: 100, random: 2 },
|
||||
isComplete: false,
|
||||
})
|
||||
.mockRejectedValueOnce(new Error('SsoGetRoamMsg failed: result=123'));
|
||||
const assertion = expect(
|
||||
new MessageApi(ctx).getC2cLatestHistory('u_friend', 20, 10001, 1000),
|
||||
).rejects.toThrow('result=123');
|
||||
await vi.runAllTimersAsync();
|
||||
await assertion;
|
||||
});
|
||||
|
||||
it('rejects a stalled private roam cursor instead of returning a partial page', async () => {
|
||||
mockC2cRoamFetch.mockResolvedValue({
|
||||
cursor: { time: 1700000100, random: 0 },
|
||||
|
||||
@@ -15,8 +15,9 @@
|
||||
// 一连接,但仍全部成功。
|
||||
|
||||
import { getLogLevel, setLogLevel, subscribeLogs, type LogEntry } from '@snowluma/common/logger';
|
||||
import type { HttpConn0x6FF501Response } from '@snowluma/proto-defs/highway';
|
||||
import { protobuf_encode } from '@snowluma/proton';
|
||||
import type { HttpConn0x6FF501Response, ReqDataHighwayHead } from '@snowluma/proto-defs/highway';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import { unpackHighwayFrame } from '@snowluma/protocol/highway/utils';
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { EventEmitter } from 'events';
|
||||
|
||||
@@ -79,6 +80,8 @@ class FakeSocket extends EventEmitter {
|
||||
writable = true;
|
||||
posts = 0;
|
||||
headers: string[] = [];
|
||||
frames: Buffer[] = [];
|
||||
closeBeforeResponse = false;
|
||||
connectFailure?: Error | 'timeout';
|
||||
private connectTimer?: ReturnType<typeof setTimeout>;
|
||||
private buf = Buffer.alloc(0);
|
||||
@@ -141,6 +144,7 @@ class FakeSocket extends EventEmitter {
|
||||
}
|
||||
|
||||
this.headers.push(s.slice(0, he));
|
||||
this.frames.push(Buffer.from(this.buf.subarray(he + 4, total)));
|
||||
this.buf = this.buf.subarray(total);
|
||||
this.posts += 1;
|
||||
const thisPost = this.posts;
|
||||
@@ -157,6 +161,14 @@ class FakeSocket extends EventEmitter {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.closeBeforeResponse) {
|
||||
this.writable = false;
|
||||
this.readableEnded = true;
|
||||
this.emit('end');
|
||||
this.emit('close');
|
||||
return;
|
||||
}
|
||||
|
||||
if (thisPost === this.errorAfterPartialOnPost) {
|
||||
const full = httpWrap(this.responseFrame);
|
||||
this.emit('data', full.subarray(0, full.length - 3));
|
||||
@@ -443,7 +455,7 @@ describe('fetchHighwaySession trace lifecycle', () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe('Highway initial connection selection', () => {
|
||||
describe('Highway connection selection', () => {
|
||||
afterEach(() => {
|
||||
vi.useRealTimers();
|
||||
vi.restoreAllMocks();
|
||||
@@ -582,24 +594,160 @@ describe('Highway initial connection selection', () => {
|
||||
expect(source.closeCount).toBe(1);
|
||||
});
|
||||
|
||||
it('stays on the selected node after data was sent without an acknowledgement', async () => {
|
||||
it.each([0, HIGHWAY_BLOCK_SIZE])(
|
||||
'retries only the unconfirmed chunk at offset %i on the next node',
|
||||
async (offset) => {
|
||||
vi.useFakeTimers();
|
||||
installFactory(() => {
|
||||
const host = createConnectionMock.mock.lastCall?.[0].host;
|
||||
const socket = new FakeSocket(
|
||||
buildEmptyHighwayResponseFrame(),
|
||||
'keepalive',
|
||||
host === '192.0.2.1' && offset > 0 ? 2 : -1,
|
||||
);
|
||||
socket.closeBeforeResponse = host === '192.0.2.1' && offset === 0;
|
||||
return socket;
|
||||
});
|
||||
const session = sessionWithCandidates();
|
||||
const original = structuredClone(session);
|
||||
const source = new RecordingChunkSource(offset + 80);
|
||||
const extend = new Uint8Array([0x12, 0x34]);
|
||||
const upload = uploadHighwayHttp(
|
||||
makeBridge(),
|
||||
session,
|
||||
71,
|
||||
source,
|
||||
new Uint8Array(16),
|
||||
extend,
|
||||
);
|
||||
const completed = expect(upload).resolves.toBeUndefined();
|
||||
await Promise.all([completed, vi.runAllTimersAsync()]);
|
||||
expect(createConnectionMock.mock.calls.map(([options]) => options)).toEqual(
|
||||
session.servers,
|
||||
);
|
||||
const [failed, recovered] = createdSockets as FakeSocket[];
|
||||
expect(recovered!.posts).toBe(1);
|
||||
const first = unpackHighwayFrame(failed!.frames.at(-1)!);
|
||||
const retry = unpackHighwayFrame(recovered!.frames[0]!);
|
||||
const firstHead = protobuf_decode<ReqDataHighwayHead>(first.head);
|
||||
const retryHead = protobuf_decode<ReqDataHighwayHead>(retry.head);
|
||||
expect(retry.body).toEqual(first.body);
|
||||
expect(retryHead).toEqual({
|
||||
...firstHead,
|
||||
msgBaseHead: { ...firstHead.msgBaseHead, retryTimes: 1 },
|
||||
});
|
||||
expect(retryHead.msgSegHead?.dataOffset ?? 0n).toBe(BigInt(offset));
|
||||
expect(retryHead.bytesReqExtendInfo).toEqual(Buffer.from(extend));
|
||||
expect(source.reads).toEqual(
|
||||
offset === 0
|
||||
? [{ offset: 0, length: 80 }]
|
||||
: [
|
||||
{ offset: 0, length: HIGHWAY_BLOCK_SIZE },
|
||||
{ offset, length: 80 },
|
||||
],
|
||||
);
|
||||
expect(source.closeCount).toBe(1);
|
||||
expect(session).toEqual(original);
|
||||
expect((createdSockets as FakeSocket[]).every((socket) => socket.destroyed)).toBe(true);
|
||||
},
|
||||
);
|
||||
|
||||
it('bounds retries across nodes and reports the unconfirmed chunk without advancing progress', async () => {
|
||||
vi.useFakeTimers();
|
||||
installFactory(
|
||||
(idx) =>
|
||||
new FakeSocket(buildEmptyHighwayResponseFrame(), 'keepalive', idx === 0 ? 1 : -1),
|
||||
);
|
||||
installFactory(() => {
|
||||
const socket = new FakeSocket(buildEmptyHighwayResponseFrame(), 'keepalive');
|
||||
socket.closeBeforeResponse = true;
|
||||
return socket;
|
||||
});
|
||||
const session = sessionWithCandidates();
|
||||
const source = new RecordingChunkSource(80);
|
||||
const entries: LogEntry[] = [];
|
||||
setLogLevel('trace');
|
||||
const unsubscribe = subscribeLogs((entry) => entries.push(entry));
|
||||
|
||||
try {
|
||||
const upload = uploadHighwayHttp(
|
||||
makeBridge(),
|
||||
session,
|
||||
71,
|
||||
source,
|
||||
new Uint8Array(16),
|
||||
new Uint8Array(),
|
||||
);
|
||||
const failed = expect(upload).rejects.toThrow(
|
||||
/transport failed after 3 attempts.*acknowledgedBytes=0.*unconfirmed/,
|
||||
);
|
||||
await Promise.all([failed, vi.runAllTimersAsync()]);
|
||||
expect(createConnectionMock.mock.calls.map(([options]) => options)).toEqual([
|
||||
session.servers[0],
|
||||
session.servers[1],
|
||||
session.servers[0],
|
||||
]);
|
||||
expect(source.reads).toEqual([{ offset: 0, length: 80 }]);
|
||||
expect(source.closeCount).toBe(1);
|
||||
const terminals = highwayTrace(entries).filter((entry) =>
|
||||
entry.message.startsWith('highway_put_terminal '),
|
||||
);
|
||||
expect(terminals).toHaveLength(1);
|
||||
expect(terminals[0]!.message).toContain('outcome=failed reason=transport_exhausted');
|
||||
expect(terminals[0]!.message).toContain('uploadedBytes=0');
|
||||
expect((createdSockets as FakeSocket[]).every((socket) => socket.destroyed)).toBe(true);
|
||||
} finally {
|
||||
unsubscribe();
|
||||
}
|
||||
});
|
||||
|
||||
it('continues after the actual failed node and skips candidates that cannot reconnect', async () => {
|
||||
vi.useFakeTimers();
|
||||
installFactory(() => {
|
||||
const host = createConnectionMock.mock.lastCall?.[0].host;
|
||||
const socket = new FakeSocket(buildEmptyHighwayResponseFrame(), 'keepalive');
|
||||
|
||||
if (host === '192.0.2.1') {
|
||||
socket.connectFailure = new Error('ECONNREFUSED');
|
||||
} else if (host === '192.0.2.2') {
|
||||
socket.closeBeforeResponse = true;
|
||||
} else if (host === '192.0.2.3') {
|
||||
socket.connectFailure = 'timeout';
|
||||
}
|
||||
|
||||
return socket;
|
||||
});
|
||||
const session = {
|
||||
...makeSession(),
|
||||
servers: Array.from({ length: 4 }, (_, i) => ({ host: `192.0.2.${i + 1}`, port: 443 })),
|
||||
};
|
||||
const source = new RecordingChunkSource(80);
|
||||
const upload = uploadHighwayHttp(
|
||||
makeBridge(),
|
||||
session,
|
||||
1004,
|
||||
new RecordingChunkSource(1),
|
||||
71,
|
||||
source,
|
||||
new Uint8Array(16),
|
||||
new Uint8Array(),
|
||||
);
|
||||
await Promise.all([expect(upload).resolves.toBeUndefined(), vi.runAllTimersAsync()]);
|
||||
expect(createConnectionMock.mock.calls.map(([options]) => options)).toEqual(
|
||||
session.servers,
|
||||
);
|
||||
expect((createdSockets as FakeSocket[]).map((socket) => socket.posts)).toEqual([
|
||||
0, 1, 0, 1,
|
||||
]);
|
||||
expect(source.reads).toEqual([{ offset: 0, length: 80 }]);
|
||||
expect(source.closeCount).toBe(1);
|
||||
});
|
||||
|
||||
it('keeps the successful node when the peer closes after acknowledgement', async () => {
|
||||
installFactory(() => new FakeSocket(buildEmptyHighwayResponseFrame(), 'closeafter'));
|
||||
const session = sessionWithCandidates();
|
||||
await uploadHighwayHttp(
|
||||
makeBridge(),
|
||||
session,
|
||||
71,
|
||||
new RecordingChunkSource(HIGHWAY_BLOCK_SIZE + 80),
|
||||
new Uint8Array(16),
|
||||
new Uint8Array(),
|
||||
);
|
||||
const completed = expect(upload).resolves.toBeUndefined();
|
||||
await vi.runAllTimersAsync();
|
||||
await completed;
|
||||
expect(createConnectionMock.mock.calls.map(([options]) => options)).toEqual([
|
||||
session.servers[0],
|
||||
session.servers[0],
|
||||
|
||||
471
packages/core/tests/highway/highway-parallel.test.ts
Normal file
471
packages/core/tests/highway/highway-parallel.test.ts
Normal file
@@ -0,0 +1,471 @@
|
||||
import { EventEmitter } from 'node:events';
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { getLogLevel, setLogLevel, subscribeLogs, type LogEntry } from '@snowluma/common/logger';
|
||||
import type { ReqDataHighwayHead, RespDataHighwayHead } from '@snowluma/proto-defs/highway';
|
||||
import { protobuf_decode, protobuf_encode } from '@snowluma/proton';
|
||||
import type { BridgeContext } from '@snowluma/protocol/bridge-context';
|
||||
import { packHighwayFrame, unpackHighwayFrame, computeMd5 } from '@snowluma/protocol/highway/utils';
|
||||
import {
|
||||
uploadHighwayHttp,
|
||||
type ChunkSource,
|
||||
type HighwaySession,
|
||||
} from '@snowluma/protocol/highway';
|
||||
|
||||
const { connect } = vi.hoisted(() => ({ connect: vi.fn() }));
|
||||
vi.mock('net', () => ({ default: { createConnection: connect } }));
|
||||
const BLOCK = 1024 * 1024;
|
||||
const bridge = { identity: { uin: '10001' } } as unknown as BridgeContext;
|
||||
const session: HighwaySession = {
|
||||
sigSession: new Uint8Array([1]),
|
||||
sessionKey: new Uint8Array(),
|
||||
servers: [
|
||||
{ host: '192.0.2.1', port: 80 },
|
||||
{ host: '192.0.2.2', port: 80 },
|
||||
],
|
||||
};
|
||||
const turn = () => new Promise<void>((resolve) => setImmediate(resolve));
|
||||
|
||||
interface Request {
|
||||
socket: TestSocket;
|
||||
head: ReqDataHighwayHead;
|
||||
bytes: Uint8Array;
|
||||
offset: number;
|
||||
respond(override?: RespDataHighwayHead): void;
|
||||
frame(bytes: Uint8Array): void;
|
||||
disconnect(): void;
|
||||
}
|
||||
let requests: Request[];
|
||||
let sockets: TestSocket[];
|
||||
let active: Set<Request>;
|
||||
let peak: number;
|
||||
let onRequest: (request: Request) => void;
|
||||
|
||||
class TestSocket extends EventEmitter {
|
||||
destroyed = false;
|
||||
readableEnded = false;
|
||||
writable = true;
|
||||
private buffer = Buffer.alloc(0);
|
||||
setTimeout() {
|
||||
return this;
|
||||
}
|
||||
write(data: Uint8Array, callback: (error?: Error) => void): boolean {
|
||||
if (this.destroyed) {
|
||||
callback(new Error('socket closed'));
|
||||
return false;
|
||||
}
|
||||
|
||||
this.buffer = Buffer.concat([this.buffer, data]);
|
||||
const end = this.buffer.indexOf('\r\n\r\n');
|
||||
|
||||
if (end >= 0) {
|
||||
const length = Number(
|
||||
this.buffer
|
||||
.subarray(0, end)
|
||||
.toString()
|
||||
.match(/Content-Length: (\d+)/i)![1],
|
||||
);
|
||||
|
||||
if (this.buffer.length >= end + 4 + length) {
|
||||
const { head, body } = unpackHighwayFrame(
|
||||
this.buffer.subarray(end + 4, end + 4 + length),
|
||||
);
|
||||
const decoded = protobuf_decode<ReqDataHighwayHead>(head);
|
||||
this.buffer = this.buffer.subarray(end + 4 + length);
|
||||
const request: Request = {
|
||||
socket: this,
|
||||
head: decoded,
|
||||
bytes: body,
|
||||
offset: Number(decoded.msgSegHead?.dataOffset ?? 0n),
|
||||
frame: (frame) => {
|
||||
if (this.destroyed) {
|
||||
throw new Error('reply on destroyed socket');
|
||||
}
|
||||
|
||||
active.delete(request);
|
||||
this.emit(
|
||||
'data',
|
||||
Buffer.concat([
|
||||
Buffer.from(
|
||||
`HTTP/1.1 200 OK\r\nContent-Length: ${frame.length}\r\n\r\n`,
|
||||
),
|
||||
frame,
|
||||
]),
|
||||
);
|
||||
},
|
||||
respond: (override = {}) =>
|
||||
request.frame(
|
||||
packHighwayFrame(
|
||||
protobuf_encode<RespDataHighwayHead>({
|
||||
msgBaseHead: { seq: decoded.msgBaseHead?.seq },
|
||||
msgSegHead: {
|
||||
filesize: decoded.msgSegHead?.filesize,
|
||||
dataOffset: decoded.msgSegHead?.dataOffset,
|
||||
dataLength: decoded.msgSegHead?.dataLength,
|
||||
},
|
||||
...override,
|
||||
}),
|
||||
new Uint8Array(),
|
||||
),
|
||||
),
|
||||
disconnect: () => this.emit('error', new Error('ECONNRESET')),
|
||||
};
|
||||
expect([...active].some((item) => item.socket === this)).toBe(false);
|
||||
requests.push(request);
|
||||
active.add(request);
|
||||
peak = Math.max(peak, active.size);
|
||||
// Deliberately respond before the write callback. Real fast peers
|
||||
// can reply while socket.write is still completing.
|
||||
onRequest(request);
|
||||
}
|
||||
}
|
||||
|
||||
callback();
|
||||
return true;
|
||||
}
|
||||
destroy() {
|
||||
if (!this.destroyed) {
|
||||
this.destroyed = true;
|
||||
this.writable = false;
|
||||
|
||||
for (const request of active) {
|
||||
if (request.socket === this) {
|
||||
active.delete(request);
|
||||
}
|
||||
}
|
||||
|
||||
queueMicrotask(() => this.emit('close'));
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
class Source implements ChunkSource {
|
||||
reads: number[] = [];
|
||||
closes = 0;
|
||||
constructor(readonly size: number) {}
|
||||
async read(offset: number, length: number) {
|
||||
this.reads.push(offset);
|
||||
return new Uint8Array(length).fill(offset / BLOCK + 1);
|
||||
}
|
||||
async close() {
|
||||
this.closes += 1;
|
||||
}
|
||||
}
|
||||
|
||||
function upload(source: ChunkSource, concurrency: number) {
|
||||
return uploadHighwayHttp(bridge, session, 1005, source, new Uint8Array(16), new Uint8Array(), {
|
||||
concurrency,
|
||||
});
|
||||
}
|
||||
|
||||
const level = getLogLevel();
|
||||
beforeEach(() => {
|
||||
requests = [];
|
||||
sockets = [];
|
||||
active = new Set();
|
||||
peak = 0;
|
||||
|
||||
onRequest = () => {};
|
||||
|
||||
connect.mockReset().mockImplementation((_options, listener) => {
|
||||
const socket = new TestSocket();
|
||||
sockets.push(socket);
|
||||
setImmediate(listener);
|
||||
return socket;
|
||||
});
|
||||
});
|
||||
afterEach(() => {
|
||||
setLogLevel(level);
|
||||
|
||||
for (const socket of sockets) {
|
||||
socket.destroy();
|
||||
}
|
||||
});
|
||||
|
||||
describe('bounded parallel highway uploads', () => {
|
||||
it.each([2, 3, 4])(
|
||||
'uses %i connections, accepts out-of-order acknowledgements and sends the tail last',
|
||||
async (concurrency) => {
|
||||
const source = new Source(6 * BLOCK + 17);
|
||||
const confirmed = new Set<number>();
|
||||
|
||||
const checkAndAck = (request: Request) => {
|
||||
if (request.offset === 6 * BLOCK) {
|
||||
expect(confirmed.size).toBe(6);
|
||||
}
|
||||
|
||||
expect(request.bytes.every((byte) => byte === request.offset / BLOCK + 1)).toBe(
|
||||
true,
|
||||
);
|
||||
expect(Buffer.from(request.head.msgSegHead!.md5!)).toEqual(
|
||||
Buffer.from(computeMd5(request.bytes)),
|
||||
);
|
||||
confirmed.add(request.offset);
|
||||
request.respond();
|
||||
};
|
||||
|
||||
const result = upload(source, concurrency);
|
||||
await vi.waitFor(() => expect(requests).toHaveLength(concurrency));
|
||||
expect(source.closes).toBe(0);
|
||||
onRequest = checkAndAck;
|
||||
|
||||
for (const request of [...active].reverse()) {
|
||||
checkAndAck(request);
|
||||
}
|
||||
|
||||
await result;
|
||||
expect(peak).toBe(concurrency);
|
||||
expect(sockets).toHaveLength(concurrency);
|
||||
expect(requests).toHaveLength(7);
|
||||
expect(new Set(requests.map((request) => request.head.msgBaseHead?.seq)).size).toBe(7);
|
||||
expect(source.closes).toBe(1);
|
||||
expect(sockets.every((socket) => socket.destroyed)).toBe(true);
|
||||
},
|
||||
);
|
||||
|
||||
it('logs confirmed bytes separately from the contiguous prefix after out-of-order replies', async () => {
|
||||
const entries: LogEntry[] = [];
|
||||
setLogLevel('trace');
|
||||
const unsubscribe = subscribeLogs((entry) => entries.push(entry));
|
||||
const source = new Source(3 * BLOCK + 1);
|
||||
|
||||
try {
|
||||
const result = upload(source, 3);
|
||||
await vi.waitFor(() => expect(requests).toHaveLength(3));
|
||||
requests[2].respond();
|
||||
await vi.waitFor(() =>
|
||||
expect(
|
||||
entries.some((entry) =>
|
||||
entry.message.includes('acknowledgedBytes=1048576 contiguousBytes=0'),
|
||||
),
|
||||
).toBe(true),
|
||||
);
|
||||
expect(requests).toHaveLength(3);
|
||||
onRequest = (request) => request.respond();
|
||||
requests[1].respond();
|
||||
requests[0].respond();
|
||||
await result;
|
||||
const terminal = entries.filter((entry) =>
|
||||
entry.message.startsWith('highway_put_terminal '),
|
||||
);
|
||||
expect(terminal).toHaveLength(1);
|
||||
expect(terminal[0]?.message).toContain(`uploadedBytes=${source.size}`);
|
||||
} finally {
|
||||
unsubscribe();
|
||||
}
|
||||
});
|
||||
|
||||
it('surfaces repeated backpressure after the retry budget is exhausted', async () => {
|
||||
const source = new Source(4 * BLOCK);
|
||||
|
||||
onRequest = (request) => {
|
||||
if (request.offset === 0) {
|
||||
request.respond({ errorCode: 102902 });
|
||||
} else {
|
||||
request.respond();
|
||||
}
|
||||
};
|
||||
|
||||
await expect(upload(source, 3)).rejects.toThrow(/error_code=102902/);
|
||||
expect(requests.filter((request) => request.offset === 0)).toHaveLength(8);
|
||||
expect(requests.some((request) => request.offset === 3 * BLOCK)).toBe(false);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
|
||||
it('limits lookahead behind a slow chunk and recovers an idle connection failure', async () => {
|
||||
const source = new Source(14 * BLOCK + 1);
|
||||
|
||||
onRequest = (request) => {
|
||||
if (request.offset !== 0) {
|
||||
request.respond();
|
||||
}
|
||||
};
|
||||
|
||||
const result = upload(source, 4);
|
||||
await vi.waitFor(() => expect(requests).toHaveLength(10));
|
||||
await turn();
|
||||
expect(Math.max(...requests.map((request) => request.offset))).toBe(9 * BLOCK);
|
||||
const idle = sockets.find(
|
||||
(socket) => ![...active].some((request) => request.socket === socket),
|
||||
)!;
|
||||
idle.emit('error', new Error('idle connection reset'));
|
||||
onRequest = (request) => request.respond();
|
||||
requests[0].respond();
|
||||
await result;
|
||||
expect(requests).toHaveLength(15);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
|
||||
it('retries only the unconfirmed range after a transport failure', async () => {
|
||||
const source = new Source(6 * BLOCK);
|
||||
let failed = false;
|
||||
|
||||
onRequest = (request) => {
|
||||
if (request.offset === BLOCK && !failed) {
|
||||
failed = true;
|
||||
request.disconnect();
|
||||
} else {
|
||||
request.respond();
|
||||
}
|
||||
};
|
||||
|
||||
await upload(source, 3);
|
||||
const retried = requests.filter((request) => request.offset === BLOCK);
|
||||
expect(retried).toHaveLength(2);
|
||||
expect(retried[1].bytes).toEqual(retried[0].bytes);
|
||||
expect(retried[1].head.msgBaseHead?.retryTimes).toBe(1);
|
||||
expect(retried[1].head.msgBaseHead?.seq).not.toBe(retried[0].head.msgBaseHead?.seq);
|
||||
expect(source.reads).toHaveLength(6);
|
||||
expect(requests.filter((request) => request.offset !== BLOCK)).toHaveLength(5);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
|
||||
it.each([102902, 302902])(
|
||||
'drains in-flight requests and reduces concurrency on %i',
|
||||
async (code) => {
|
||||
const source = new Source(7 * BLOCK);
|
||||
const entries: LogEntry[] = [];
|
||||
const unsubscribe = subscribeLogs((entry) => entries.push(entry));
|
||||
|
||||
try {
|
||||
const result = upload(source, 4);
|
||||
await vi.waitFor(() => expect(requests).toHaveLength(4));
|
||||
requests[0].respond({ errorCode: code });
|
||||
await vi.waitFor(() =>
|
||||
expect(
|
||||
entries.some((entry) =>
|
||||
entry.message.includes('reducing concurrency from 4 to 1'),
|
||||
),
|
||||
).toBe(true),
|
||||
);
|
||||
await turn();
|
||||
expect(requests).toHaveLength(4);
|
||||
let afterDrainPeak = 0;
|
||||
|
||||
onRequest = (request) => {
|
||||
afterDrainPeak = Math.max(afterDrainPeak, active.size);
|
||||
request.respond();
|
||||
};
|
||||
|
||||
for (const request of [...active]) {
|
||||
request.respond();
|
||||
}
|
||||
|
||||
await result;
|
||||
expect(afterDrainPeak).toBe(1);
|
||||
expect(requests.filter((request) => request.offset === 0)).toHaveLength(2);
|
||||
expect(requests).toHaveLength(8);
|
||||
expect(source.closes).toBe(1);
|
||||
} finally {
|
||||
unsubscribe();
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
it.each([
|
||||
{ msgBaseHead: { seq: 999 } },
|
||||
{ msgSegHead: { dataOffset: 99n } },
|
||||
{ msgSegHead: { dataLength: 99 } },
|
||||
{ msgSegHead: { filesize: 99n } },
|
||||
])('rejects mismatched acknowledgements without retrying (case %#)', async (response) => {
|
||||
const source = new Source(4 * BLOCK);
|
||||
onRequest = (request) => request.respond(response);
|
||||
await expect(upload(source, 3)).rejects.toThrow(/acknowledgement mismatch/);
|
||||
expect(requests.every((request) => (request.head.msgBaseHead?.retryTimes ?? 0) === 0)).toBe(
|
||||
true,
|
||||
);
|
||||
expect(requests.some((request) => request.offset === 3 * BLOCK)).toBe(false);
|
||||
expect(source.closes).toBe(1);
|
||||
expect(sockets.every((socket) => socket.destroyed)).toBe(true);
|
||||
});
|
||||
|
||||
it('rejects segment-level errors even when the top-level code is zero', async () => {
|
||||
const source = new Source(4 * BLOCK);
|
||||
onRequest = (request) => request.respond({ msgSegHead: { retCode: 921 } });
|
||||
await expect(upload(source, 3)).rejects.toThrow(/segRetCode=921/);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
|
||||
it('stops peers on rejection and waits for pending source reads before closing', async () => {
|
||||
let release!: () => void;
|
||||
let reading = false;
|
||||
const source = new Source(5 * BLOCK);
|
||||
const read = source.read.bind(source);
|
||||
|
||||
source.read = async (offset, length) => {
|
||||
if (offset === BLOCK) {
|
||||
reading = true;
|
||||
await new Promise<void>((resolve) => {
|
||||
release = resolve;
|
||||
});
|
||||
reading = false;
|
||||
}
|
||||
|
||||
return read(offset, length);
|
||||
};
|
||||
|
||||
const close = vi.spyOn(source, 'close').mockImplementation(async () => {
|
||||
expect(reading).toBe(false);
|
||||
});
|
||||
const result = upload(source, 3);
|
||||
const rejected = expect(result).rejects.toThrow(/error_code=921/);
|
||||
await vi.waitFor(() => expect(requests).toHaveLength(2));
|
||||
requests.find((request) => request.offset === 0)!.respond({ errorCode: 921 });
|
||||
await turn();
|
||||
expect(close).not.toHaveBeenCalled();
|
||||
release();
|
||||
await rejected;
|
||||
expect(close).toHaveBeenCalledTimes(1);
|
||||
expect(requests).toHaveLength(2);
|
||||
expect(sockets.every((socket) => socket.destroyed)).toBe(true);
|
||||
});
|
||||
|
||||
it('stops after bounded transport retries without sending the final chunk', async () => {
|
||||
const source = new Source(5 * BLOCK);
|
||||
|
||||
onRequest = (request) => {
|
||||
if (request.offset === 0) {
|
||||
request.disconnect();
|
||||
} else {
|
||||
request.respond();
|
||||
}
|
||||
};
|
||||
|
||||
await expect(upload(source, 3)).rejects.toThrow(/transport failed after 3 attempts/);
|
||||
expect(requests.filter((request) => request.offset === 0)).toHaveLength(3);
|
||||
expect(requests.some((request) => request.offset === 4 * BLOCK)).toBe(false);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
|
||||
it.each([1, BLOCK + 1, 2 * BLOCK])('keeps a %i-byte upload on one connection', async (size) => {
|
||||
onRequest = (request) => request.respond();
|
||||
await upload(new Source(size), 4);
|
||||
expect(peak).toBe(1);
|
||||
expect(sockets).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('keeps legacy success responses without echo fields compatible', async () => {
|
||||
onRequest = (request) => request.respond({ msgBaseHead: undefined, msgSegHead: undefined });
|
||||
await upload(new Source(4 * BLOCK), 3);
|
||||
expect(requests).toHaveLength(4);
|
||||
});
|
||||
|
||||
it.each([0, 5, -1, 1.5, NaN])(
|
||||
'rejects invalid concurrency %s and closes the source',
|
||||
async (concurrency) => {
|
||||
const source = new Source(4 * BLOCK);
|
||||
await expect(upload(source, concurrency)).rejects.toThrow(/integer from 1 to 4/);
|
||||
expect(source.closes).toBe(1);
|
||||
expect(requests).toHaveLength(0);
|
||||
},
|
||||
);
|
||||
|
||||
it('rejects short reads instead of acknowledging bytes that were not uploaded', async () => {
|
||||
const source = new Source(4 * BLOCK);
|
||||
source.read = async () => new Uint8Array(1);
|
||||
await expect(upload(source, 3)).rejects.toThrow(/expected 1048576/);
|
||||
expect(requests).toHaveLength(0);
|
||||
expect(source.closes).toBe(1);
|
||||
});
|
||||
});
|
||||
@@ -132,6 +132,36 @@ describe('pipeline — runNtv2Upload', () => {
|
||||
setLogLevel(previousLogLevel);
|
||||
});
|
||||
|
||||
it('passes concurrency only for the sub-file that explicitly opts in', async () => {
|
||||
const bridge = makeBridge({
|
||||
responseData: encodeOidbResponse({
|
||||
upload: {
|
||||
uKey: 'main-key',
|
||||
subFileInfos: [{ uKey: 'cover-key' }],
|
||||
msgInfo: { msgInfoBody: [{}, {}], extBizInfo: {} },
|
||||
},
|
||||
}),
|
||||
});
|
||||
const media = {
|
||||
bytes: new Uint8Array([1]),
|
||||
md5: new Uint8Array(16),
|
||||
sha1: new Uint8Array(20),
|
||||
};
|
||||
await runNtv2Upload(
|
||||
baseParams({
|
||||
bridge,
|
||||
uploads: [
|
||||
{ ...media, source: 'top', cmdId: 1005, concurrency: 4 },
|
||||
{ ...media, source: 0, cmdId: 1006 },
|
||||
],
|
||||
}),
|
||||
);
|
||||
const calls = vi.mocked(highway.uploadHighwayHttp).mock.calls;
|
||||
expect(calls).toHaveLength(2);
|
||||
expect(calls[0]?.[6]).toEqual({ concurrency: 4 });
|
||||
expect(calls[1]?.[6]).toBeUndefined();
|
||||
});
|
||||
|
||||
it('records fast-upload selection and one completed media terminal', async () => {
|
||||
const bridge = makeBridge({
|
||||
responseData: encodeOidbResponse({
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
import {
|
||||
getVideoUploadConcurrency,
|
||||
setVideoUploadConcurrency,
|
||||
} from '@snowluma/protocol/highway/upload-settings';
|
||||
// video-upload tests cover the fingerprint (fast-upload) path. The
|
||||
// regular load path exercises ffmpeg + the OS temp dir + a streaming
|
||||
// SHA1 implementation; that machinery has its own seams worth testing
|
||||
@@ -9,7 +13,7 @@
|
||||
// fastOnlyError difference (main has it; thumb doesn't — FALLBACK_THUMB
|
||||
// always provides bytes), and the video-specific OIDB fields.
|
||||
|
||||
import { describe, it, expect, vi, beforeEach } from 'vitest';
|
||||
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
|
||||
import { promises as fsp } from 'fs';
|
||||
import fs from 'fs';
|
||||
import os from 'os';
|
||||
@@ -44,11 +48,27 @@ const FINGERPRINT = {
|
||||
} as any;
|
||||
|
||||
describe('video-upload', () => {
|
||||
afterEach(() => setVideoUploadConcurrency(1));
|
||||
beforeEach(() => {
|
||||
vi.mocked(pipeline.runNtv2Upload).mockClear();
|
||||
vi.mocked(pipeline.finalizeMediaMsgInfo).mockClear();
|
||||
});
|
||||
|
||||
it('snapshots the global concurrency for video bodies without parallelizing covers', async () => {
|
||||
expect(getVideoUploadConcurrency()).toBe(1);
|
||||
setVideoUploadConcurrency(4);
|
||||
const first = uploadVideoMsgInfo({} as any, true, 12345, FINGERPRINT);
|
||||
setVideoUploadConcurrency(2);
|
||||
await first;
|
||||
const firstUpload = vi.mocked(pipeline.runNtv2Upload).mock.calls[0]![0];
|
||||
expect(firstUpload.uploads[0]!.concurrency).toBe(4);
|
||||
expect(firstUpload.uploads[1]!.concurrency).toBeUndefined();
|
||||
await uploadVideoMsgInfo({} as any, false, 'recipient-uid', FINGERPRINT);
|
||||
const secondUpload = vi.mocked(pipeline.runNtv2Upload).mock.calls[1]![0];
|
||||
expect(secondUpload.uploads[0]!.concurrency).toBe(2);
|
||||
expect(secondUpload.uploads[1]!.concurrency).toBeUndefined();
|
||||
});
|
||||
|
||||
it('retains successful upload metadata for self-sent history', async () => {
|
||||
const node = { fileUuid: 'uploaded-resource', storeId: 1, info: { fileSize: 1234 } };
|
||||
vi.mocked(pipeline.runNtv2Upload).mockResolvedValueOnce({
|
||||
|
||||
@@ -2,6 +2,7 @@ import { describe, expect, it, vi } from 'vitest';
|
||||
import { protobuf_encode } from '@snowluma/proton';
|
||||
import { parseMsgPush, MSG_PUSH_CMD } from '@snowluma/protocol/msg-push';
|
||||
import { IdentityService } from '@snowluma/protocol/identity-service';
|
||||
import { GroupInviteTracker } from '@snowluma/protocol/group-invite-tracker';
|
||||
import { IncomingPacketPipeline } from '@snowluma/protocol/packet-pipeline';
|
||||
import { BridgeEventBus } from '@snowluma/protocol/event-bus';
|
||||
import type { GroupMemberInfo, QQGroupInfo } from '@snowluma/protocol/qq-info';
|
||||
@@ -529,6 +530,7 @@ describe('parseMsgPush Event0x210 subType=364 (friend remark synchronization)',
|
||||
fetchGroupList: vi.fn(async () => {}),
|
||||
fetchGroupMemberList: vi.fn(async () => {}),
|
||||
resolveGroupJoinRequest: vi.fn(async () => null),
|
||||
groupInvites: new GroupInviteTracker(),
|
||||
});
|
||||
pipeline.registerCmd(MSG_PUSH_CMD, parseMsgPush);
|
||||
|
||||
@@ -1027,6 +1029,7 @@ describe('parseMsgPush PkgType 44 (group admin set/unset) keeps the member cache
|
||||
fetchGroupList: vi.fn(async () => {}),
|
||||
fetchGroupMemberList: vi.fn(async () => {}),
|
||||
resolveGroupJoinRequest: vi.fn(async () => null),
|
||||
groupInvites: new GroupInviteTracker(),
|
||||
});
|
||||
pipeline.registerCmd(MSG_PUSH_CMD, parseMsgPush);
|
||||
await pipeline.process(packet);
|
||||
|
||||
@@ -1,65 +0,0 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import {
|
||||
appendEvents,
|
||||
ingestTemp,
|
||||
lineSeverity,
|
||||
publicLine,
|
||||
trimMirror,
|
||||
} from '../src/native-stage-sync';
|
||||
|
||||
const VERSION = '1.14.22';
|
||||
const EVENT = 'a'.repeat(64);
|
||||
const infoLine = `2026-10-09T00:00:00Z 42 1 0 ${EVENT}`;
|
||||
const failLine = `2026-10-09T00:00:01Z 42 1 1 ${EVENT} ${'b'.repeat(16)}=7`;
|
||||
|
||||
describe('native stage sync', () => {
|
||||
it('keeps a version marker and copies the record without extra wording', () => {
|
||||
const mirror = appendEvents('', VERSION, [infoLine, failLine]);
|
||||
expect(mirror.startsWith(`v${VERSION}\n`)).toBe(true);
|
||||
expect(mirror).toContain(infoLine);
|
||||
expect(mirror).toContain(failLine);
|
||||
const shown = [publicLine(VERSION, infoLine), publicLine(VERSION, failLine)].join('\n');
|
||||
expect(shown).toBe(`${VERSION} ${infoLine}\n${VERSION} ${failLine}`);
|
||||
});
|
||||
|
||||
it('opens a new version section without dropping the previous marker', () => {
|
||||
const first = appendEvents('', '1.14.22', [infoLine]);
|
||||
const second = appendEvents(first, '1.14.23', [failLine]);
|
||||
expect(second).toContain('v1.14.22\n');
|
||||
expect(second).toContain('v1.14.23\n');
|
||||
expect(second.indexOf('v1.14.22')).toBeLessThan(second.indexOf(infoLine));
|
||||
expect(second.indexOf('v1.14.23')).toBeLessThan(second.indexOf(failLine));
|
||||
});
|
||||
|
||||
it('drops the oldest record first and keeps the version marker', () => {
|
||||
const long = `2026-10-09T00:00:00Z 1 1 0 ${'c'.repeat(64)} ${'d'.repeat(40)}`;
|
||||
let mirror = appendEvents('', VERSION, [long, long, long], 80);
|
||||
mirror = trimMirror(mirror, 80);
|
||||
expect(mirror).toContain(`v${VERSION}`);
|
||||
expect(mirror.split('\n').filter((line) => line.startsWith('2026')).length).toBeLessThan(3);
|
||||
});
|
||||
|
||||
it('treats severity 1 as a failure and ignores a missing file', () => {
|
||||
expect(lineSeverity(failLine)).toBe('error');
|
||||
expect(lineSeverity(infoLine)).toBe('info');
|
||||
const ingested = ingestTemp({
|
||||
tempText: `${infoLine}\n${failLine}\npartial`,
|
||||
offset: 0,
|
||||
mirror: '',
|
||||
version: VERSION,
|
||||
});
|
||||
expect(ingested.lines).toEqual([infoLine, failLine]);
|
||||
expect(ingested.mirror).toContain(`v${VERSION}\n`);
|
||||
expect(ingested.offset).toBe(`${infoLine}\n${failLine}\n`.length);
|
||||
const missing = ingestTemp({
|
||||
tempText: '',
|
||||
offset: 4,
|
||||
mirror: 'keep',
|
||||
version: VERSION,
|
||||
missing: true,
|
||||
});
|
||||
expect(missing.mirror).toBe('keep');
|
||||
expect(missing.lines).toEqual([]);
|
||||
expect(missing.errorCode).toBeUndefined();
|
||||
});
|
||||
});
|
||||
91
packages/core/tests/private-voice-wire.test.ts
Normal file
91
packages/core/tests/private-voice-wire.test.ts
Normal file
@@ -0,0 +1,91 @@
|
||||
import { readFileSync } from 'node:fs';
|
||||
import type { SendPacketResult } from '@snowluma/common/packet-sender';
|
||||
import type { SendMessageResponse } from '@snowluma/proto-defs/action';
|
||||
import type { Elem } from '@snowluma/proto-defs/element';
|
||||
import type { OidbBase } from '@snowluma/proto-defs/oidb';
|
||||
import { IdentityService } from '@snowluma/protocol/identity-service';
|
||||
import {
|
||||
type bytes,
|
||||
type pb,
|
||||
type pb_repeated,
|
||||
protobuf_decode,
|
||||
protobuf_encode,
|
||||
} from '@snowluma/proton';
|
||||
import { expect, it } from 'vitest';
|
||||
import { Bridge } from '../src/bridge/bridge';
|
||||
|
||||
interface VoiceParts {
|
||||
elems?: pb_repeated<2, bytes>;
|
||||
ptt?: pb<4, bytes>;
|
||||
}
|
||||
|
||||
interface UploadReply {
|
||||
upload?: pb<2, { compat?: pb<8, bytes> }>;
|
||||
}
|
||||
|
||||
interface OutgoingMessage {
|
||||
body?: pb<3, { richText?: pb<1, VoiceParts> }>;
|
||||
}
|
||||
|
||||
it('preserves the private voice returned for older clients alongside the modern voice', async () => {
|
||||
// The upload reply from #614, with identifiers redacted and transport credentials removed.
|
||||
const upload = Buffer.from(
|
||||
readFileSync(
|
||||
new URL('./fixtures/issue-614-private-voice-upload.hex', import.meta.url),
|
||||
'utf8',
|
||||
).replace(/\s/g, ''),
|
||||
'hex',
|
||||
);
|
||||
const captured = protobuf_decode<OidbBase<UploadReply>>(Uint8Array.from(upload)).body!.upload!
|
||||
.compat!;
|
||||
const expected = protobuf_decode<VoiceParts>(captured);
|
||||
expect(captured).toHaveLength(301);
|
||||
expect(expected.ptt).toHaveLength(253);
|
||||
let sent: VoiceParts | undefined;
|
||||
|
||||
class VoiceBridge extends Bridge {
|
||||
override async resolveUserUid(): Promise<string> {
|
||||
return 'u_peer';
|
||||
}
|
||||
|
||||
override async sendRawPacket(cmd: string, body: Uint8Array): Promise<SendPacketResult> {
|
||||
let response: Uint8Array;
|
||||
|
||||
if (cmd === 'OidbSvcTrpcTcp.0x126d_100') {
|
||||
response = upload;
|
||||
} else if (cmd === 'MessageSvc.PbSendMsg') {
|
||||
sent = protobuf_decode<OutgoingMessage>(body).body!.richText!;
|
||||
response = protobuf_encode<SendMessageResponse>({ privateSequence: 88 });
|
||||
} else {
|
||||
throw new Error(`Unexpected packet ${cmd}`);
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
gotResponse: true,
|
||||
errorCode: 0,
|
||||
errorMessage: '',
|
||||
responseData: Buffer.from(response),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const bridge = new VoiceBridge(IdentityService.memory('10000'));
|
||||
await bridge.apis.message.sendPrivate(10001, [
|
||||
{
|
||||
type: 'record',
|
||||
noByteFallback: true,
|
||||
fileSize: 7931,
|
||||
duration: 3,
|
||||
md5Hex: '0'.repeat(32),
|
||||
sha1Hex: '0'.repeat(40),
|
||||
fileName: 'voice.amr',
|
||||
},
|
||||
]);
|
||||
expect(protobuf_decode<Elem>(sent!.elems![0]!).commonElem).toMatchObject({
|
||||
serviceType: 48,
|
||||
businessType: 12,
|
||||
});
|
||||
expect(sent!.ptt).toEqual(expected.ptt);
|
||||
expect(sent!.elems!.slice(1)).toEqual(expected.elems);
|
||||
});
|
||||
@@ -1,4 +1,5 @@
|
||||
import { createRequire } from 'node:module';
|
||||
import { readFileSync, readdirSync } from 'node:fs';
|
||||
import { describe, expect, it } from 'vitest';
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
@@ -9,17 +10,48 @@ const { SUPPORTED_NODE_RANGE, isSupportedNodeVersion } =
|
||||
};
|
||||
|
||||
describe('runtime Node.js preflight', () => {
|
||||
it('accepts the documented minimum and newer versions', () => {
|
||||
expect(SUPPORTED_NODE_RANGE).toBe('>=24');
|
||||
expect(isSupportedNodeVersion('24.0.0')).toBe(true);
|
||||
expect(isSupportedNodeVersion('24.21.0')).toBe(true);
|
||||
expect(isSupportedNodeVersion('26.0.0')).toBe(true);
|
||||
it.each(['24.22.1', '24.22.2', '24.23.0', '24.22.1+vendor.1', '26.12.1', '26.13.0', '27.0.0'])(
|
||||
'accepts patched stable Node.js %s',
|
||||
(version) => {
|
||||
expect(isSupportedNodeVersion(version)).toBe(true);
|
||||
},
|
||||
);
|
||||
|
||||
it.each([
|
||||
'22.23.4',
|
||||
'23.99.99',
|
||||
'24.0.0',
|
||||
'24.21.0',
|
||||
'24.22.0',
|
||||
'25.99.99',
|
||||
'26.0.0',
|
||||
'26.11.99',
|
||||
'26.12.0',
|
||||
'24.22.1-rc.1',
|
||||
'26.12.1-rc.1',
|
||||
'not-a-version',
|
||||
])('rejects unpatched, unsupported or malformed Node.js %s', (version) => {
|
||||
expect(isSupportedNodeVersion(version)).toBe(false);
|
||||
});
|
||||
|
||||
it('rejects older and malformed versions', () => {
|
||||
expect(isSupportedNodeVersion('22.99.99')).toBe(false);
|
||||
expect(isSupportedNodeVersion('23.99.99')).toBe(false);
|
||||
expect(isSupportedNodeVersion('21.99.99')).toBe(false);
|
||||
expect(isSupportedNodeVersion('not-a-version')).toBe(false);
|
||||
it('keeps workspace requirements and the bundled runtime baseline aligned', () => {
|
||||
expect(SUPPORTED_NODE_RANGE).toBe('^24.22.1 || >=26.12.1');
|
||||
const root = new URL('../../../', import.meta.url);
|
||||
const packages = readdirSync(new URL('packages/', root), { withFileTypes: true });
|
||||
const manifests = [
|
||||
new URL('package.json', root),
|
||||
...packages
|
||||
.filter((entry) => entry.isDirectory())
|
||||
.map((entry) => new URL(`packages/${entry.name}/package.json`, root)),
|
||||
];
|
||||
|
||||
for (const manifest of manifests) {
|
||||
const pkg = JSON.parse(readFileSync(manifest, 'utf8'));
|
||||
expect(pkg.engines.node, manifest.pathname).toBe(SUPPORTED_NODE_RANGE);
|
||||
}
|
||||
|
||||
const baseline = readFileSync(new URL('.node-version', root), 'utf8').trim();
|
||||
expect(baseline).toBe('24.22.1');
|
||||
expect(isSupportedNodeVersion(baseline)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -5,10 +5,14 @@ import path from 'node:path';
|
||||
import { zipSync } from 'fflate';
|
||||
import { c as createTar } from 'tar';
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { archivePath, assetName, downloadUpdate } from '../src/update/download';
|
||||
import { archivePath, assetName, downloadUpdate as download } from '../src/update/download';
|
||||
import { readManifest } from '../src/update/files';
|
||||
import { releaseFixture } from './helpers/update-fixture';
|
||||
|
||||
const direct = { mode: 'direct', mirror: '', mirrors: [] } as const;
|
||||
const downloadUpdate = (directory: string, version: string, target: string) =>
|
||||
download(directory, version, target, { ...direct, mirrors: [] });
|
||||
|
||||
let root: string;
|
||||
beforeEach(async () => {
|
||||
root = await mkdtemp(path.join(os.tmpdir(), 'snowluma-download-test-'));
|
||||
@@ -43,6 +47,105 @@ function mockRelease(bytes: Uint8Array, target: string, digest?: string) {
|
||||
}
|
||||
|
||||
describe('release downloads', () => {
|
||||
it.each(['403', 'html', 'corrupt', 'interrupted'])(
|
||||
'cleans and retries a %s response through a mirror using HTML release checksums',
|
||||
async (failure) => {
|
||||
const manifest = await releaseFixture(path.join(root, 'source'), '2.0.0', 'win32-x64');
|
||||
const bytes = zipSync({
|
||||
'release.json': new TextEncoder().encode(JSON.stringify(manifest)),
|
||||
'app.mjs': new TextEncoder().encode('verified payload'),
|
||||
});
|
||||
const name = assetName('2.0.0', 'win32-x64');
|
||||
const digest = createHash('sha256').update(bytes).digest('hex');
|
||||
const fetchMock = vi.fn<typeof fetch>(async (input) => {
|
||||
const url = String(input);
|
||||
|
||||
if (url.includes('api.github.com')) {
|
||||
return new Response('rate limited', { status: 403 });
|
||||
}
|
||||
|
||||
if (url.includes('/expanded_assets/')) {
|
||||
return new Response(
|
||||
`<li><a href="/SnowLuma/SnowLuma/releases/download/v2.0.0/${name}">asset</a><clipboard-copy value="sha256:${digest}"></clipboard-copy></li>`,
|
||||
);
|
||||
}
|
||||
|
||||
if (url.startsWith('https://working.example/')) {
|
||||
// Mirrors may stream a verified archive without Content-Length.
|
||||
return new Response(new Uint8Array(bytes));
|
||||
}
|
||||
|
||||
if (failure === '403') {
|
||||
return new Response('blocked', { status: 403 });
|
||||
}
|
||||
|
||||
if (failure === 'html') {
|
||||
return new Response('<html>challenge</html>', {
|
||||
headers: { 'Content-Type': 'text/html' },
|
||||
});
|
||||
}
|
||||
|
||||
if (failure === 'interrupted') {
|
||||
let sent = false;
|
||||
return new Response(
|
||||
new ReadableStream({
|
||||
pull(controller) {
|
||||
if (sent) {
|
||||
controller.error(new Error('connection reset'));
|
||||
} else {
|
||||
controller.enqueue(new Uint8Array([1, 2, 3]));
|
||||
sent = true;
|
||||
}
|
||||
},
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
return new Response('corrupt archive');
|
||||
});
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
await download(root, '2.0.0', 'win32-x64', {
|
||||
mode: 'auto',
|
||||
mirror: '',
|
||||
mirrors: ['https://working.example'],
|
||||
});
|
||||
expect(await readFile(path.join(root, 'archive'))).toEqual(Buffer.from(bytes));
|
||||
expect(await readFile(path.join(root, 'payload/app.mjs'), 'utf8')).toBe(
|
||||
'verified payload',
|
||||
);
|
||||
expect(
|
||||
fetchMock.mock.calls
|
||||
.filter(([url]) => String(url).includes('/download/'))
|
||||
.map(([url]) => String(url)),
|
||||
).toEqual([
|
||||
`https://github.com/SnowLuma/SnowLuma/releases/download/v2.0.0/${name}`,
|
||||
`https://working.example/https://github.com/SnowLuma/SnowLuma/releases/download/v2.0.0/${name}`,
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
it('does not try other download sources in pinned mode', async () => {
|
||||
const bytes = new Uint8Array([1, 2, 3]);
|
||||
const fetchMock = mockRelease(bytes, 'win32-x64');
|
||||
const original = fetchMock.getMockImplementation()!;
|
||||
fetchMock.mockImplementation(async (input) =>
|
||||
String(input).includes('api.github.com')
|
||||
? original(input)
|
||||
: new Response('blocked', { status: 403 }),
|
||||
);
|
||||
await expect(
|
||||
download(root, '2.0.0', 'win32-x64', {
|
||||
mode: 'mirror',
|
||||
mirror: 'https://pinned.example',
|
||||
mirrors: ['https://other.example'],
|
||||
}),
|
||||
).rejects.toThrow('HTTP 403');
|
||||
expect(fetchMock.mock.calls.map(([url]) => url)).toEqual([
|
||||
'https://api.github.com/repos/SnowLuma/SnowLuma/releases/tags/v2.0.0',
|
||||
`https://pinned.example/https://github.com/SnowLuma/SnowLuma/releases/download/v2.0.0/${assetName('2.0.0', 'win32-x64')}`,
|
||||
]);
|
||||
expect(await readdir(root)).toEqual([]);
|
||||
});
|
||||
it.each(['win32-x64', 'linux-x64', 'linux-arm64'])(
|
||||
'downloads and validates the %s lite package',
|
||||
async (target) => {
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { spawn } from 'node:child_process';
|
||||
import { cp, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
|
||||
import { cp, mkdtemp, readFile, realpath, rm, writeFile } from 'node:fs/promises';
|
||||
import { builtinModules } from 'node:module';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
@@ -14,7 +14,8 @@ let root: string;
|
||||
let staging: string;
|
||||
|
||||
beforeAll(async () => {
|
||||
compiled = await mkdtemp(path.join(os.tmpdir(), 'snowluma-entry-build-'));
|
||||
// Module resolution uses canonical paths, including when the temp directory is a symlink.
|
||||
compiled = await realpath(await mkdtemp(path.join(os.tmpdir(), 'snowluma-entry-build-')));
|
||||
const loaded = await loadConfigFromFile(
|
||||
{ command: 'build', mode: 'production' },
|
||||
fileURLToPath(new URL('../vite.config.ts', import.meta.url)),
|
||||
@@ -114,7 +115,7 @@ afterAll(async () => {
|
||||
await rm(compiled, { recursive: true, force: true });
|
||||
});
|
||||
beforeEach(async () => {
|
||||
root = await mkdtemp(path.join(os.tmpdir(), 'snowluma-entry-test-'));
|
||||
root = await realpath(await mkdtemp(path.join(os.tmpdir(), 'snowluma-entry-test-')));
|
||||
staging = await updateDirectory(root);
|
||||
await releaseFixture(root, '1.0.0');
|
||||
await cp(path.join(compiled, '1.0.0/index.mjs'), path.join(root, 'index.mjs'));
|
||||
@@ -158,7 +159,7 @@ describe('packaged startup', () => {
|
||||
expect(JSON.parse(result.output)).toEqual({
|
||||
version: '1.0.0',
|
||||
node: process.execPath,
|
||||
cwd: os.tmpdir(),
|
||||
cwd: await realpath(os.tmpdir()),
|
||||
args: ['value with spaces'],
|
||||
oldAlive: false,
|
||||
});
|
||||
|
||||
126
packages/core/tests/update-release.test.ts
Normal file
126
packages/core/tests/update-release.test.ts
Normal file
@@ -0,0 +1,126 @@
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import type { UpdateSourceConfig } from '@snowluma/common/update-source';
|
||||
import {
|
||||
assetName,
|
||||
fetchRelease,
|
||||
parseLatestReleasePage,
|
||||
parseReleaseAssetsPage,
|
||||
} from '../src/update/release';
|
||||
|
||||
const direct: UpdateSourceConfig = { mode: 'direct', mirror: '', mirrors: [] };
|
||||
const latest =
|
||||
'<meta property="og:url" content="https://github.com/SnowLuma/SnowLuma/releases/tag/v2.0.1">';
|
||||
const digest = `sha256:${'a'.repeat(64)}`;
|
||||
const name = assetName('2.0.1', 'win32-x64');
|
||||
const row = `<li><a href="/SnowLuma/SnowLuma/releases/download/v2.0.1/${name}">${name}</a><clipboard-copy value="${digest}"></clipboard-copy></li>`;
|
||||
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
describe('existing GitHub release pages', () => {
|
||||
it('reads the canonical stable release without a new metadata asset', () => {
|
||||
expect(parseLatestReleasePage(latest)).toEqual({
|
||||
tag_name: 'v2.0.1',
|
||||
html_url: 'https://github.com/SnowLuma/SnowLuma/releases/tag/v2.0.1',
|
||||
});
|
||||
expect(parseLatestReleasePage(latest.replace('https://github.com', '')).tag_name).toBe(
|
||||
'v2.0.1',
|
||||
);
|
||||
});
|
||||
|
||||
it.each([
|
||||
'<html>please sign in</html>',
|
||||
latest.replace('github.com', 'unrelated.example'),
|
||||
latest.replace('/SnowLuma/SnowLuma/', '/other/project/'),
|
||||
latest.replace('v2.0.1', 'v02.0.1'),
|
||||
latest.replace('v2.0.1', 'v2.0.1-rc.1'),
|
||||
])('rejects non-release or invalid version pages', (html) => {
|
||||
expect(() => parseLatestReleasePage(html)).toThrow();
|
||||
});
|
||||
|
||||
it('matches an asset with its own digest, ignoring rounded HTML sizes', () => {
|
||||
expect(parseReleaseAssetsPage(row, '2.0.1')).toEqual({
|
||||
tag_name: 'v2.0.1',
|
||||
assets: [{ name, size: null, digest }],
|
||||
});
|
||||
});
|
||||
|
||||
it.each([
|
||||
row.replace('v2.0.1/', 'v2.0.0/'),
|
||||
row.replace(digest, 'unavailable'),
|
||||
row + row,
|
||||
row.replace(`<clipboard-copy value="${digest}"></clipboard-copy>`, '') +
|
||||
`<li><clipboard-copy value="${digest}"></clipboard-copy></li>`,
|
||||
])('rejects absent, ambiguous or neighbouring checksum data', (html) => {
|
||||
expect(() => parseReleaseAssetsPage(html, '2.0.1')).toThrow();
|
||||
});
|
||||
|
||||
it('falls back from API 403 to the existing release page', async () => {
|
||||
const fetchMock = vi.fn<typeof fetch>(async (url) =>
|
||||
String(url).includes('api.github.com')
|
||||
? new Response('rate limited', { status: 403 })
|
||||
: new Response(latest),
|
||||
);
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
expect(await fetchRelease(undefined, direct)).toMatchObject({
|
||||
fromPage: true,
|
||||
data: { tag_name: 'v2.0.1' },
|
||||
});
|
||||
expect(fetchMock.mock.calls.map(([url]) => url)).toEqual([
|
||||
'https://api.github.com/repos/SnowLuma/SnowLuma/releases/latest',
|
||||
'https://github.com/SnowLuma/SnowLuma/releases/latest',
|
||||
]);
|
||||
});
|
||||
|
||||
it('waits for a valid mirror page after fast invalid responses and cancels other requests', async () => {
|
||||
let finish!: (response: Response) => void;
|
||||
const pending = new Promise<Response>((resolve) => {
|
||||
finish = resolve;
|
||||
});
|
||||
const fetchMock = vi.fn<typeof fetch>(async (url) => {
|
||||
if (String(url).startsWith('https://working.example/')) {
|
||||
return pending;
|
||||
}
|
||||
|
||||
return new Response('HTML challenge');
|
||||
});
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
const result = fetchRelease('2.0.1', {
|
||||
...direct,
|
||||
mode: 'auto',
|
||||
mirrors: ['https://bad.example', 'https://working.example'],
|
||||
});
|
||||
await vi.waitFor(() => expect(fetchMock).toHaveBeenCalledTimes(4));
|
||||
finish(new Response(row));
|
||||
expect(await result).toMatchObject({
|
||||
fromPage: true,
|
||||
data: { assets: [{ name, digest }] },
|
||||
});
|
||||
expect(fetchMock.mock.calls.slice(1).every(([, options]) => options?.signal?.aborted)).toBe(
|
||||
true,
|
||||
);
|
||||
});
|
||||
|
||||
it('keeps direct release lookup when the pinned download mirror cannot serve pages', async () => {
|
||||
const fetchMock = vi.fn<typeof fetch>(async (url) =>
|
||||
String(url) === 'https://github.com/SnowLuma/SnowLuma/releases/latest'
|
||||
? new Response(latest)
|
||||
: new Response('blocked', { status: 403 }),
|
||||
);
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
expect(
|
||||
await fetchRelease(undefined, {
|
||||
...direct,
|
||||
mode: 'mirror',
|
||||
mirror: 'https://files.example',
|
||||
}),
|
||||
).toMatchObject({ data: { tag_name: 'v2.0.1' } });
|
||||
});
|
||||
|
||||
it('rejects oversized release responses', async () => {
|
||||
vi.stubGlobal(
|
||||
'fetch',
|
||||
vi.fn(async () => new Response('x'.repeat(1024 * 1024 + 1))),
|
||||
);
|
||||
await expect(fetchRelease(undefined, direct)).rejects.toThrow('发布信息过大');
|
||||
});
|
||||
});
|
||||
105
packages/core/tests/update-source-routes.test.ts
Normal file
105
packages/core/tests/update-source-routes.test.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
import fs from 'node:fs';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { readRuntimeConfig, updateRuntimeConfig } from '@snowluma/common/runtime';
|
||||
import { createUpdateService } from '../src/update/service';
|
||||
import { updateRoutes } from '../src/webui/update-routes';
|
||||
|
||||
let directory: string;
|
||||
let previous: string;
|
||||
beforeEach(() => {
|
||||
directory = fs.mkdtempSync(path.join(os.tmpdir(), 'snowluma-update-sources-'));
|
||||
previous = process.cwd();
|
||||
process.chdir(directory);
|
||||
});
|
||||
afterEach(() => {
|
||||
process.chdir(previous);
|
||||
vi.restoreAllMocks();
|
||||
vi.unstubAllGlobals();
|
||||
fs.rmSync(directory, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
async function routes() {
|
||||
return updateRoutes(await createUpdateService(undefined, '2.0.1'), vi.fn());
|
||||
}
|
||||
|
||||
describe('update source routes', () => {
|
||||
it('returns a JSON error when persisted source settings are invalid', async () => {
|
||||
fs.mkdirSync('config');
|
||||
fs.writeFileSync(
|
||||
'config/runtime.json',
|
||||
JSON.stringify({ updateSource: { mode: 'invalid' } }),
|
||||
);
|
||||
const response = await (await routes()).request('/sources');
|
||||
expect(response.status).toBe(500);
|
||||
expect(response.headers.get('content-type')).toContain('application/json');
|
||||
expect(await response.json()).toMatchObject({
|
||||
message: expect.stringContaining('模式无效'),
|
||||
});
|
||||
});
|
||||
it('persists settings for subsequent reads without changing other runtime values', async () => {
|
||||
updateRuntimeConfig({ webuiPort: 6789, webuiHost: '127.0.0.2' });
|
||||
const app = await routes();
|
||||
const config = {
|
||||
mode: 'mirror',
|
||||
mirror: 'https://example.com/proxy/',
|
||||
mirrors: ['https://second.example/'],
|
||||
};
|
||||
const response = await app.request('/sources', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(config),
|
||||
});
|
||||
expect(response.status).toBe(200);
|
||||
const normalized = {
|
||||
...config,
|
||||
mirror: 'https://example.com/proxy',
|
||||
mirrors: ['https://second.example'],
|
||||
};
|
||||
expect(await response.json()).toMatchObject({
|
||||
config: normalized,
|
||||
saved: true,
|
||||
applied: true,
|
||||
errors: [],
|
||||
});
|
||||
expect(readRuntimeConfig()).toMatchObject({
|
||||
updateSource: normalized,
|
||||
webuiPort: 6789,
|
||||
webuiHost: '127.0.0.2',
|
||||
});
|
||||
expect(await (await app.request('/sources')).json()).toEqual({ config: normalized });
|
||||
});
|
||||
|
||||
it.each(['not json', '{}', '[]', '{"mode":"mirror","mirrors":[]}'])(
|
||||
'rejects malformed input without saving or fetching: %s',
|
||||
async (body) => {
|
||||
const fetchMock = vi.fn();
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
const app = await routes();
|
||||
|
||||
for (const endpoint of ['/sources', '/sources/test']) {
|
||||
expect((await app.request(endpoint, { method: 'POST', body })).status).toBe(400);
|
||||
}
|
||||
|
||||
expect(fetchMock).not.toHaveBeenCalled();
|
||||
expect(fs.existsSync('config/runtime.json')).toBe(false);
|
||||
},
|
||||
);
|
||||
|
||||
it('reports a persistence failure without claiming the config was saved', async () => {
|
||||
updateRuntimeConfig({ webuiPort: 6789 });
|
||||
const before = fs.readFileSync('config/runtime.json', 'utf8');
|
||||
vi.spyOn(fs, 'renameSync').mockImplementationOnce(() => {
|
||||
throw new Error('disk replacement failed');
|
||||
});
|
||||
const response = await (
|
||||
await routes()
|
||||
).request('/sources', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ mode: 'direct', mirror: '', mirrors: [] }),
|
||||
});
|
||||
expect(response.status).toBe(500);
|
||||
expect(await response.json()).toEqual({ message: 'disk replacement failed' });
|
||||
expect(fs.readFileSync('config/runtime.json', 'utf8')).toBe(before);
|
||||
});
|
||||
});
|
||||
81
packages/core/tests/update-sources.test.ts
Normal file
81
packages/core/tests/update-sources.test.ts
Normal file
@@ -0,0 +1,81 @@
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { DEFAULT_UPDATE_SOURCE, sourceUrls, testUpdateSources } from '../src/update/sources';
|
||||
import type { UpdateSourceConfig } from '@snowluma/common/update-source';
|
||||
|
||||
const config: UpdateSourceConfig = {
|
||||
mode: 'auto',
|
||||
mirror: '',
|
||||
mirrors: [
|
||||
'https://good.example',
|
||||
'https://html.example',
|
||||
'https://fake.example',
|
||||
'https://failed.example',
|
||||
],
|
||||
};
|
||||
afterEach(() => vi.unstubAllGlobals());
|
||||
|
||||
describe('update mirror selection', () => {
|
||||
it('uses direct, ordered fallback or only the pinned mirror for downloads', () => {
|
||||
const url = 'https://github.com/project/asset';
|
||||
expect(sourceUrls(url, config)).toEqual([
|
||||
url,
|
||||
...config.mirrors.map((mirror) => `${mirror}/${url}`),
|
||||
]);
|
||||
expect(sourceUrls(url, { ...config, mode: 'direct' })).toEqual([url]);
|
||||
expect(
|
||||
sourceUrls(url, { ...config, mode: 'mirror', mirror: 'https://pinned.example/proxy' }),
|
||||
).toEqual([`https://pinned.example/proxy/${url}`]);
|
||||
expect(DEFAULT_UPDATE_SOURCE.mirrors.length).toBeGreaterThanOrEqual(7);
|
||||
});
|
||||
|
||||
it('probes actual archive prefixes, rejects HTML even with a binary content type, and cancels bodies', async () => {
|
||||
const cancelled = vi.fn();
|
||||
const signature =
|
||||
process.platform === 'win32' ? [0x50, 0x4b, 0x03, 0x04] : [0x1f, 0x8b, 0x08, 0];
|
||||
const fetchMock = vi.fn<typeof fetch>(async (url) => {
|
||||
if (String(url).startsWith('https://html.example')) {
|
||||
return new Response('<html>blocked</html>', {
|
||||
headers: { 'Content-Type': 'text/html' },
|
||||
});
|
||||
}
|
||||
|
||||
if (String(url).startsWith('https://fake.example')) {
|
||||
return new Response('<html>blocked</html>', {
|
||||
headers: { 'Content-Type': 'application/octet-stream' },
|
||||
});
|
||||
}
|
||||
|
||||
if (String(url).startsWith('https://failed.example')) {
|
||||
return new Response('blocked', { status: 403 });
|
||||
}
|
||||
|
||||
return new Response(
|
||||
new ReadableStream({
|
||||
start(controller) {
|
||||
controller.enqueue(new Uint8Array(signature));
|
||||
},
|
||||
cancel: cancelled,
|
||||
}),
|
||||
);
|
||||
});
|
||||
vi.stubGlobal('fetch', fetchMock);
|
||||
const results = await testUpdateSources(config);
|
||||
expect(
|
||||
results
|
||||
.filter((result) => result.available)
|
||||
.map((result) => result.mirror)
|
||||
.sort(),
|
||||
).toEqual(['', 'https://good.example']);
|
||||
expect(results.filter((result) => !result.available)).toHaveLength(3);
|
||||
expect(results.at(-1)?.available).toBe(false);
|
||||
expect(cancelled).toHaveBeenCalledTimes(2);
|
||||
expect(
|
||||
fetchMock.mock.calls.every(
|
||||
([, options]) =>
|
||||
options?.headers &&
|
||||
'Range' in options.headers &&
|
||||
options.headers.Range === 'bytes=0-3',
|
||||
),
|
||||
).toBe(true);
|
||||
});
|
||||
});
|
||||
@@ -679,6 +679,23 @@ describe('prepareRestorePlan — strict semantic preflight', () => {
|
||||
expect(canonical.webuiTls.enabled).toBe(false);
|
||||
});
|
||||
|
||||
it('preserves video concurrency in backups and rejects invalid restored values', () => {
|
||||
const prepare = (videoUploadConcurrency: number) =>
|
||||
prepareRestorePlan(
|
||||
backupWith({
|
||||
'snowluma.json': {
|
||||
encoding: 'utf8',
|
||||
data: JSON.stringify({ videoUploadConcurrency }),
|
||||
},
|
||||
}),
|
||||
{ restoreCredentials: false, readCurrent: () => null },
|
||||
);
|
||||
expect(JSON.parse(prepare(4).restore[0].data.toString('utf8')).videoUploadConcurrency).toBe(
|
||||
4,
|
||||
);
|
||||
expect(() => prepare(5)).toThrow(/videoUploadConcurrency/);
|
||||
});
|
||||
|
||||
it('accepts owner-supported whitespace trimming without accepting changed values', () => {
|
||||
const prepared = prepareRestorePlan(
|
||||
backupWith({
|
||||
|
||||
78
packages/core/tests/webui-static-frontend.test.ts
Normal file
78
packages/core/tests/webui-static-frontend.test.ts
Normal file
@@ -0,0 +1,78 @@
|
||||
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||||
import { Hono } from 'hono';
|
||||
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs';
|
||||
import { tmpdir } from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { registerStaticFrontend } from '../src/webui/static-frontend';
|
||||
|
||||
let root: string;
|
||||
const html = '<!doctype html><html><head><title>SnowLuma</title></head><body>app</body></html>';
|
||||
|
||||
beforeEach(() => {
|
||||
root = mkdtempSync(path.join(tmpdir(), 'snowluma-presentation-'));
|
||||
writeFileSync(path.join(root, 'index.html'), html);
|
||||
writeFileSync(path.join(root, 'asset.js'), 'window.asset = true;');
|
||||
});
|
||||
|
||||
afterEach(() => rmSync(root, { recursive: true, force: true }));
|
||||
|
||||
describe('runtime target document delivery', () => {
|
||||
it.each(['/', '/index.html', '/settings?tab=appearance'])(
|
||||
'injects on %s before authentication',
|
||||
async (url) => {
|
||||
const app = new Hono();
|
||||
registerStaticFrontend(app, root, 'maibot');
|
||||
const response = await app.request(url);
|
||||
expect(response.status).toBe(200);
|
||||
expect(response.headers.get('cache-control')).toBe('no-store');
|
||||
expect(await response.text()).toContain('"target":"maibot"');
|
||||
},
|
||||
);
|
||||
|
||||
it('reuses the exact same built frontend for an unconfigured deployment', async () => {
|
||||
const app = new Hono();
|
||||
registerStaticFrontend(app, root, null);
|
||||
expect(await (await app.request('/index.html')).text()).toBe(html);
|
||||
});
|
||||
|
||||
it('does not inject into assets or API error responses', async () => {
|
||||
const app = new Hono();
|
||||
registerStaticFrontend(app, root, 'maibot');
|
||||
expect(await (await app.request('/asset.js')).text()).toBe('window.asset = true;');
|
||||
|
||||
for (const url of ['/api/missing', '/avatar/missing', '/ui-asset/missing']) {
|
||||
expect((await app.request(url)).status).toBe(404);
|
||||
}
|
||||
});
|
||||
|
||||
it('does not serve a protected static path through a second percent decode', async () => {
|
||||
mkdirSync(path.join(root, 'admin'));
|
||||
writeFileSync(path.join(root, 'admin', 'private.txt'), 'protected fixture');
|
||||
const app = new Hono();
|
||||
app.use('/admin/*', async (c) => c.text('unauthorized', 401));
|
||||
registerStaticFrontend(app, root, null);
|
||||
|
||||
for (const url of ['/admin/private.txt', '/%61dmin/private.txt']) {
|
||||
const response = await app.request(url);
|
||||
expect(response.status).toBe(401);
|
||||
expect(await response.text()).toBe('unauthorized');
|
||||
}
|
||||
|
||||
// The router sees /%61dmin; decoding again would reach /admin
|
||||
// after the middleware for that prefix has already been skipped.
|
||||
const response = await app.request('/%%36%31dmin/private.txt');
|
||||
expect(await response.text()).toBe(html);
|
||||
});
|
||||
|
||||
it.each(['hello world.js', '图标.js'])(
|
||||
'still serves ordinarily encoded asset names: %s',
|
||||
async (filename) => {
|
||||
writeFileSync(path.join(root, filename), 'window.encodedAsset = true;');
|
||||
const app = new Hono();
|
||||
registerStaticFrontend(app, root, null);
|
||||
const response = await app.request(`/${encodeURIComponent(filename)}`);
|
||||
expect(response.status).toBe(200);
|
||||
expect(await response.text()).toBe('window.encodedAsset = true;');
|
||||
},
|
||||
);
|
||||
});
|
||||
@@ -1,5 +1,8 @@
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { getUpdateInfo } from '../src/update/check';
|
||||
import { getUpdateInfo as checkUpdate } from '../src/update/check';
|
||||
|
||||
const getUpdateInfo = (force = false) =>
|
||||
checkUpdate(force, { mode: 'direct', mirror: '', mirrors: [] });
|
||||
|
||||
const LATEST_RELEASE_URL = 'https://api.github.com/repos/SnowLuma/SnowLuma/releases/latest';
|
||||
const NOTES_MAX = 4_000;
|
||||
@@ -85,7 +88,7 @@ describe('getUpdateInfo', () => {
|
||||
htmlUrl: null,
|
||||
notes: null,
|
||||
publishedAt: null,
|
||||
error: 'ECONNRESET',
|
||||
error: expect.stringContaining('ECONNRESET'),
|
||||
});
|
||||
|
||||
fetchMock.mockImplementation(async () => jsonResponse({ tag_name: 'v1.0.0' }));
|
||||
@@ -93,7 +96,7 @@ describe('getUpdateInfo', () => {
|
||||
expect(ok.latest).toBe('1.0.0');
|
||||
expect(ok.hasUpdate).toBe(true);
|
||||
expect(ok.error).toBeUndefined();
|
||||
expect(fetchMock).toHaveBeenCalledTimes(2);
|
||||
expect(fetchMock).toHaveBeenCalledTimes(3);
|
||||
});
|
||||
|
||||
it.each(['', '1', 'true', 'yes', 'on', ' '] as const)(
|
||||
@@ -190,7 +193,7 @@ describe('getUpdateInfo', () => {
|
||||
htmlUrl: null,
|
||||
notes: null,
|
||||
publishedAt: null,
|
||||
error: 'github 403',
|
||||
error: expect.stringContaining('GitHub 403'),
|
||||
});
|
||||
});
|
||||
|
||||
@@ -230,7 +233,7 @@ describe('getUpdateInfo', () => {
|
||||
throw new Error('getaddrinfo ENOTFOUND');
|
||||
});
|
||||
const result = await getUpdateInfo(true);
|
||||
expect(result.error).toBe('getaddrinfo ENOTFOUND');
|
||||
expect(result.error).toContain('getaddrinfo ENOTFOUND');
|
||||
expect(result.hasUpdate).toBe(false);
|
||||
});
|
||||
|
||||
@@ -239,7 +242,7 @@ describe('getUpdateInfo', () => {
|
||||
throw 'timeout';
|
||||
});
|
||||
const result = await getUpdateInfo(true);
|
||||
expect(result.error).toBe('network error');
|
||||
expect(result.error).toContain('timeout');
|
||||
expect(result.hasUpdate).toBe(false);
|
||||
});
|
||||
|
||||
@@ -257,7 +260,7 @@ describe('getUpdateInfo', () => {
|
||||
throw new Error('boom');
|
||||
});
|
||||
await expect(getUpdateInfo(true)).resolves.toMatchObject({
|
||||
error: 'boom',
|
||||
error: expect.stringContaining('boom'),
|
||||
hasUpdate: false,
|
||||
});
|
||||
});
|
||||
@@ -298,12 +301,12 @@ describe('getUpdateInfo', () => {
|
||||
throw new Error('boom');
|
||||
});
|
||||
const bad = await getUpdateInfo(true);
|
||||
expect(bad.error).toBe('boom');
|
||||
expect(bad.error).toContain('boom');
|
||||
|
||||
const cached = await getUpdateInfo();
|
||||
expect(cached).toBe(good);
|
||||
expect(cached.error).toBeUndefined();
|
||||
expect(fetchMock).toHaveBeenCalledTimes(2);
|
||||
expect(fetchMock).toHaveBeenCalledTimes(3);
|
||||
});
|
||||
|
||||
it('collapses concurrent checks onto one fetch', async () => {
|
||||
@@ -332,4 +335,15 @@ describe('getUpdateInfo', () => {
|
||||
});
|
||||
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it('does not reuse the previous source configuration cache after a mirror change', async () => {
|
||||
const source = { mode: 'auto', mirror: '', mirrors: ['https://first.example'] } as const;
|
||||
const fetchMock = mockFetch(async () => jsonResponse({ tag_name: 'v3.0.0' }));
|
||||
const first = await checkUpdate(false, { ...source, mirrors: [...source.mirrors] });
|
||||
fetchMock.mockImplementation(async () => jsonResponse({ tag_name: 'v3.0.1' }));
|
||||
const second = await checkUpdate(false, { ...source, mirrors: ['https://second.example'] });
|
||||
expect(first.latest).toBe('3.0.0');
|
||||
expect(second.latest).toBe('3.0.1');
|
||||
expect(fetchMock).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
});
|
||||
|
||||
391
packages/mcp/AGENT_FEATURES.md
Normal file
391
packages/mcp/AGENT_FEATURES.md
Normal file
@@ -0,0 +1,391 @@
|
||||
# MCP agent features
|
||||
|
||||
These additions preserve the existing tool names, action parameters, text results,
|
||||
and read/write gates. No endpoint is contacted by catalog tools or by a local
|
||||
runtime overview. The action catalog remains a bundled snapshot, not a claim
|
||||
about the connected server's capabilities.
|
||||
|
||||
## Protocol compatibility and catalog caching
|
||||
|
||||
The same `snowluma-mcp` stdio command accepts MCP `2026-07-28` clients and
|
||||
older clients using the `initialize` handshake. The official server SDK selects
|
||||
the protocol for the connection. Modern clients can use `server/discover` and
|
||||
per-request metadata without initialization; legacy clients keep their existing
|
||||
configuration. This does not add a publicly listening MCP HTTP endpoint.
|
||||
|
||||
Modern replies carry the protocol's completion and server metadata. Cache hints
|
||||
depend on whether a response contains static catalog data or private live state:
|
||||
|
||||
| Response | Lifetime | Scope |
|
||||
| ----------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| `tools/list` | Five minutes | `private`; mode and client capabilities affect tool metadata and availability. |
|
||||
| `resources/list` | Five minutes, or zero when events are enabled | `private`; UI capability and active event resources affect the list. |
|
||||
| `resources/templates/list` | Five minutes | `public`; the bundled template list is static. |
|
||||
| `resources/read` for the action catalog or message UI | Five minutes | `public`; these are bundled static assets. |
|
||||
| `resources/read` for event resources | Zero | `private`; these contain account events and connection state. |
|
||||
|
||||
These are client cache hints, not a server-side result cache. Tool calls,
|
||||
including the runtime overview, never receive these hints. The SDK omits
|
||||
modern-only result fields for legacy clients. Unsupported protocol revisions
|
||||
are rejected before action execution; they do not trigger an action retry.
|
||||
|
||||
## Call tracing
|
||||
|
||||
Every tool invocation gets a W3C trace context. Clients can supply `traceparent`
|
||||
and optional `tracestate` in the tool request's `_meta`:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "query_action",
|
||||
"arguments": { "action": "get_status" },
|
||||
"_meta": {
|
||||
"traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
MCP preserves a valid caller trace ID and creates a new span ID for each call.
|
||||
Without a valid parent it creates an independent trace. The returned
|
||||
`_meta.traceparent` identifies that call, including tool errors; the existing
|
||||
text and structured result envelopes remain unchanged. This works with both
|
||||
protocol generations.
|
||||
|
||||
Ordinary requests, streams, automatic upload chunks, and upload cleanup forward
|
||||
the call context in HTTP headers, never in OneBot action parameters. Concurrent
|
||||
calls keep independent headers. To follow a call, match its traceparent in MCP
|
||||
stderr diagnostics with SnowLuma's `http_trace` entry, then follow that entry's
|
||||
existing `req#` through action lifecycle logs. SnowLuma correlation requires
|
||||
TRACE logging and a valid authenticated HTTP request; the remote trace ID does
|
||||
not replace its local request ID. No telemetry exporter is installed.
|
||||
|
||||
MCP's call diagnostics contain the known tool name, traceparent, outcome, failure
|
||||
category and duration, not message contents, tokens, file paths or arbitrary metadata.
|
||||
`tracestate` is validated with a maximum of 512 characters and 32 members; it is
|
||||
forwarded but not logged. Invalid trace metadata produces a fixed diagnostic and
|
||||
does not reject an otherwise valid action. `baggage` is neither forwarded nor
|
||||
logged. Trace identifiers are correlation data, not authentication or permission.
|
||||
|
||||
## Optional execution services
|
||||
|
||||
Existing configurations keep working. Input completion and message previews are
|
||||
additive tools; event connections and durable tasks require explicit configuration.
|
||||
For example, set these variables in the MCP client's server environment, replacing
|
||||
addresses, credentials and paths with the intended SnowLuma instance:
|
||||
|
||||
```json
|
||||
{
|
||||
"SNOWLUMA_MCP_MODE": "write",
|
||||
"SNOWLUMA_MCP_ENDPOINT": "http://127.0.0.1:3000/",
|
||||
"SNOWLUMA_MCP_TOKEN": "<your access token>",
|
||||
"SNOWLUMA_MCP_EVENTS_URL": "ws://127.0.0.1:3001/event",
|
||||
"SNOWLUMA_MCP_TASK_DIR": "/absolute/private/mcp-tasks",
|
||||
"SNOWLUMA_MCP_UPLOAD_ROOT": "/absolute/allowed/uploads"
|
||||
}
|
||||
```
|
||||
|
||||
The HTTP and WebSocket addresses are independently configured server endpoints;
|
||||
the WebSocket address is never guessed from the HTTP address. Events reuse
|
||||
`SNOWLUMA_MCP_TOKEN` in an authorization header. Upload and task directories are
|
||||
on the MCP host. Omit services that are not needed. Docs mode remains offline.
|
||||
|
||||
## Completing missing parameters
|
||||
|
||||
`query_action_with_input` and `invoke_action_with_input` use the same arguments,
|
||||
action lookup and mode gates as `query_action` and `invoke_action`. The existing
|
||||
tools continue to behave exactly as before. The additional tools ask for input
|
||||
only when a field listed in the action catalog's top-level `required` array is
|
||||
absent; they do not infer conditional requirements or optional values.
|
||||
|
||||
For example, `invoke_action_with_input` with
|
||||
`{"action":"send_group_msg","params":{"group_id":20001}}` asks for the
|
||||
missing message. The form contains one `params_json` string, whose contents are
|
||||
a JSON object such as `{"message":"Hello"}`. The answer is validated against
|
||||
the missing fields' catalog schemas before normal action execution. Already
|
||||
provided fields, the action name and execution options cannot be overwritten;
|
||||
extra answer fields are rejected. A declined, cancelled or invalid answer does
|
||||
not execute the action.
|
||||
|
||||
Clients must advertise form elicitation support. Modern clients receive
|
||||
`resultType: "input_required"` and resume using the SDK's request-state and input
|
||||
response mechanism. Legacy clients with elicitation support use the SDK's
|
||||
`elicitation/create` flow. Clients without form support receive a tool error and
|
||||
can provide complete arguments to the original tools instead.
|
||||
|
||||
Continuation state is signed, tied to the original tool and arguments, expires
|
||||
after ten minutes and is consumed once before execution. Concurrent or repeated
|
||||
answers cannot execute the same continuation twice. A runtime holds at most 256
|
||||
pending prompts; restart invalidates them rather than replaying work. Completed
|
||||
arguments bypass the input round entirely. This feature is not a general approval
|
||||
gate and does not add confirmation prompts to existing action calls.
|
||||
|
||||
## Live event resources
|
||||
|
||||
With `SNOWLUMA_MCP_EVENTS_URL` configured, read and write modes expose
|
||||
`subscribe_events` and `unsubscribe_events`. The URL must use `ws:` or `wss:`
|
||||
without embedded credentials, query parameters or fragments. Listing tools or
|
||||
resources does not connect; only `subscribe_events` opens the event connection.
|
||||
|
||||
```json
|
||||
{
|
||||
"self_id": 10001,
|
||||
"types": ["message", "notice"],
|
||||
"group_ids": [20001],
|
||||
"user_ids": [30001]
|
||||
}
|
||||
```
|
||||
|
||||
Use the expected logged-in account for required `self_id`; obtain it through
|
||||
`get_login_info` if necessary. Every incoming event must match this account.
|
||||
An account mismatch or malformed event stops the connection and is surfaced.
|
||||
The optional types are `message`, `notice` and `request`; omitted types mean all
|
||||
three. `message_sent` is included in the message category. Group and user filters
|
||||
are combined with AND, so a group filter excludes events without a matching
|
||||
`group_id`. Each ID filter accepts at most 100 distinct positive integers.
|
||||
|
||||
The result contains a canonical `snowluma://onebot/events/<id>` resource URI.
|
||||
Read it with `resources/read`; use `?after=<next_cursor>` on subsequent reads to
|
||||
obtain newer buffered entries. Cursors belong to that one resource. The response
|
||||
includes `status`, `next_cursor`, `oldest_cursor`, `dropped_events`, `gap` and
|
||||
`notification_failed`. Reads do not consume events. Only events received after
|
||||
subscription creation are available; this is not message-history storage.
|
||||
|
||||
Each resource retains at most 256 events and 1 MiB of event data. One runtime
|
||||
supports at most 16 resources, sharing one account connection. Incoming frames
|
||||
are limited to 256 KiB. Buffer eviction and disconnection remain visible through
|
||||
the cursor/gap and status fields; the service does not silently reconnect or
|
||||
claim missing events were recovered. Release existing resources before changing
|
||||
accounts or creating a new connection after disconnection.
|
||||
|
||||
For updates, use the **canonical URI without `?after`**:
|
||||
|
||||
- Modern clients use `subscriptions/listen` with `resourceSubscriptions: [uri]`
|
||||
(the TypeScript SDK exposes `client.listen(...)`). Closing that notification
|
||||
stream does not release the event buffer; call `unsubscribe_events` explicitly.
|
||||
- Legacy clients first call `resources/subscribe` with the canonical URI, then
|
||||
receive `notifications/resources/updated`. `resources/unsubscribe` also releases
|
||||
that event resource. The explicit unsubscribe tool works for both generations.
|
||||
|
||||
An update notification indicates that the resource changed; fetch the resource
|
||||
to read its data. Releasing the last resource closes the WebSocket. Closing the
|
||||
MCP connection releases its event resources and buffers. No event operation
|
||||
executes a OneBot business action or sends a QQ message.
|
||||
|
||||
## Persistent background transfers
|
||||
|
||||
Set an absolute `SNOWLUMA_MCP_TASK_DIR` and use write mode to enable persistent
|
||||
tasks. Task tools additionally require MCP `2026-07-28` clients advertising
|
||||
`extensions: {"io.modelcontextprotocol/tasks": {}}`. Legacy clients keep the
|
||||
existing synchronous execution tools; this server does not expose the obsolete
|
||||
`tasks/list` or `tasks/result` protocol methods.
|
||||
|
||||
`invoke_action_background` takes the same arguments as `invoke_action`, but only
|
||||
accepts catalog actions marked as streams. For example, it can run
|
||||
`upload_file_stream` with `execution.input_file` inside the configured upload root.
|
||||
It writes the task record before starting work and returns a `resultType: "task"`
|
||||
handle. Ordinary actions continue through the existing tools. The current
|
||||
background transfer entry does not automatically combine with `_with_input`;
|
||||
provide the required transfer parameters before starting it.
|
||||
|
||||
- `tasks/get` with `{ "taskId": "..." }` returns current state and, when finished,
|
||||
the saved result or error. A `completed` task can contain a failed business
|
||||
response: inspect the nested result's diagnostics, `status` and `retcode`.
|
||||
- `tasks/cancel` requests cooperative cancellation. Cancellation does not undo
|
||||
remote effects, and a successful completion already in flight may win the race.
|
||||
Poll the task again for its final state.
|
||||
- `tasks/update` accepts input responses only for outstanding task input requests.
|
||||
It is the protocol lifecycle endpoint, not an arbitrary task-editing API. The
|
||||
current background transfer entry does not itself request interactive input.
|
||||
- `list_tasks` is an MCP tool returning task metadata without result bodies. It
|
||||
accepts optional `cursor` and `limit` (1–100; default 50) and returns `nextCursor`
|
||||
when another page is available.
|
||||
|
||||
Task handles advertise `pollIntervalMs: 1000` and `ttlMs: null`. Results survive
|
||||
restart and are not automatically expired or deleted. Restart marks unfinished
|
||||
work failed with an explicit **unknown remote outcome** message; it never
|
||||
replays the operation. This persists transfer status/results, not resumable
|
||||
upload or download execution. There are at most four concurrent tasks and a
|
||||
16 MiB limit on each persisted task record.
|
||||
|
||||
Storage uses an exclusive runtime lease, private directories/files (0700/0600 on
|
||||
POSIX) and validated records. Corruption, permission errors and write failures
|
||||
remain errors. The directory is bound to a digest of the effective mode, endpoint
|
||||
and token; changing that configuration rejects reuse of the directory. Choose a
|
||||
new private directory for the new configuration and retain the old history.
|
||||
Credentials are not stored in the scope record, but task results can contain
|
||||
private account data and should be protected accordingly.
|
||||
|
||||
## Message preview panel
|
||||
|
||||
`preview_message` is available in every mode and only constructs a draft:
|
||||
|
||||
```json
|
||||
{
|
||||
"message_type": "group",
|
||||
"target_id": 20001,
|
||||
"text": "Hello",
|
||||
"reply_to": -123456
|
||||
}
|
||||
```
|
||||
|
||||
Use `private` for a private conversation. `target_id` must be a positive safe
|
||||
integer; optional `reply_to` is a non-zero signed 32-bit message ID. The preview
|
||||
supports literal text and optional quoted replies, not media rendering. Text
|
||||
that resembles message control codes remains literal text.
|
||||
|
||||
Every client receives the same readable text draft, `can_send` flag and
|
||||
corresponding `invoke_action` arguments. Only clients advertising the MCP Apps
|
||||
extension `io.modelcontextprotocol/ui` with MIME type
|
||||
`text/html;profile=mcp-app` receive the tool's UI metadata and listed UI resource.
|
||||
The panel is a bundled, self-contained HTML asset built with the official Apps
|
||||
client. It loads no external scripts, fonts or media, opens no network connection
|
||||
of its own and displays external text without interpreting it as HTML. A missing
|
||||
packaged asset is a visible packaging error.
|
||||
|
||||
Loading the panel sends nothing. Its send button calls the existing
|
||||
`invoke_action` through the host only after the user clicks, and the server's
|
||||
write gate still applies. Read/docs mode or a host without server-tool support
|
||||
keeps sending disabled. The panel prevents duplicate clicks and does not retry
|
||||
failed or uncertain sends; create a new draft only after checking the outcome.
|
||||
Successful acknowledgement is not proof of delivery or rendering in QQ.
|
||||
|
||||
## Action result schemas and examples
|
||||
|
||||
`get_action` and `snowluma://onebot/actions` include `returnsSchema` and
|
||||
`examples` for every bundled action, including aliases. Both are authored beside
|
||||
the OneBot action definition and copied into the generated catalog. List/search
|
||||
responses remain compact; use `get_action` to retrieve the complete contract.
|
||||
|
||||
`returnsSchema` describes successful OneBot **`data`**, not the full OneBot
|
||||
envelope or the MCP `structuredContent` wrapper. Check `status` and `retcode`
|
||||
before reading it. For stream actions, the schema describes each successful
|
||||
frame's `data`; MCP downloads instead return saved-file metadata and generic
|
||||
streams return a frame collection. Error frames and failed envelopes are not
|
||||
successful results. Unsupported actions use `{ "not": {} }` because they have no
|
||||
successful result. Compatibility placeholders explicitly document their limits.
|
||||
|
||||
Each example has `summary`, `params`, and optional `notes` explaining prerequisites
|
||||
and identifier sources. These are illustrative calls, never run by catalog tools.
|
||||
Replace example account/group IDs, opaque handles and paths with values from the
|
||||
current account before execution. Notes identify operations with multiple steps,
|
||||
such as completing an upload after all chunks have been acknowledged.
|
||||
|
||||
For example, `get_action({ "name": "get_msg" })` documents signed message IDs:
|
||||
|
||||
```json
|
||||
{
|
||||
"action": "get_msg",
|
||||
"params": { "message_id": -123456 }
|
||||
}
|
||||
```
|
||||
|
||||
Pass this object to `query_action` with a real message ID. Writes and streams use
|
||||
`invoke_action` in write mode. For automatic upload, pass
|
||||
`{ "action": "upload_file_stream", "execution": { "input_file": "/allowed/hello.txt" } }`
|
||||
to `invoke_action`, with a real file inside the configured upload root. Ordinary
|
||||
action paths refer to the SnowLuma server, whereas `execution.input_file` and MCP
|
||||
download paths refer to the MCP host.
|
||||
|
||||
Do not substitute zero for a signed message ID. Resource-only forward uploads
|
||||
and flash shares have a documented `message_id: 0` sentinel; it cannot be used
|
||||
for message lookup or recall. Also preserve `null` versus `{}`, optional fields,
|
||||
and decimal strings such as media `file_size` exactly as documented.
|
||||
|
||||
## Structured results
|
||||
|
||||
Completed tool results use the advertised `outputSchema` and return
|
||||
`structuredContent` alongside the existing `content` text block. Modern
|
||||
`input_required` and background task handles are protocol continuations; inspect
|
||||
their `resultType` first and obtain the completed result through the relevant
|
||||
continuation or task lifecycle:
|
||||
|
||||
```json
|
||||
{
|
||||
"result": { "status": "ok", "retcode": 0, "data": { "message_id": -123 } },
|
||||
"diagnostics": { "outcome": "success" }
|
||||
}
|
||||
```
|
||||
|
||||
`result` is the original payload, including arrays such as the category list.
|
||||
It is `null` for an MCP tool error. `diagnostics.outcome` is `success`, `failed`,
|
||||
or `unknown`; failures can include `kind`, `message`, and `next_step`.
|
||||
|
||||
Ordinary OneBot business failures still return their original envelope without
|
||||
setting `isError`. Their structured diagnostics indicate failure. An asynchronous
|
||||
acknowledgement or a response that does not confirm success has outcome `unknown`.
|
||||
Transport errors and existing tool/stream errors still set `isError: true`.
|
||||
Error categories describe known causes; unclassified execution errors are not
|
||||
guessed from message strings. Neither tool execution nor connection checks retry
|
||||
automatically. Negative message IDs remain valid and are preserved unchanged.
|
||||
|
||||
## Search, filters, and pagination
|
||||
|
||||
`search_actions` retains its original case-insensitive substring matching and
|
||||
catalog order unless `match: "keywords"` is requested. Keyword mode combines
|
||||
space-separated terms with AND, recognizes a small set of common Chinese/English
|
||||
synonyms, and ranks exact action names or aliases first.
|
||||
|
||||
```json
|
||||
{
|
||||
"query": "群 禁言",
|
||||
"match": "keywords",
|
||||
"read_only": false,
|
||||
"stream": false,
|
||||
"limit": 10,
|
||||
"offset": 0
|
||||
}
|
||||
```
|
||||
|
||||
Both `list_actions` and `search_actions` accept optional `category`, `read_only`,
|
||||
`stream`, `limit` (1–200), and `offset` (non-negative integer). Omitting pagination
|
||||
returns the complete matching list and preserves `{count, actions}`. With `limit`
|
||||
or `offset`, `count` is the returned page size, `total` is the matching count, and
|
||||
`next_offset` is the next page offset or `null`. Pagination applies to the bundled
|
||||
catalog; it does not issue server requests.
|
||||
|
||||
## Runtime overview
|
||||
|
||||
`get_runtime_info({})` returns:
|
||||
|
||||
- The effective `mode`, `execution_enabled`, and `write_enabled`.
|
||||
- The bundled catalog version and action count. `server_support` remains
|
||||
`unknown`; a matching version alone does not prove action support.
|
||||
- In execution mode, effective request timeout, file size and directory quota
|
||||
limits, concurrent stream limit, download directory, upload root, and whether
|
||||
automatic upload is enabled. In docs mode, `transport` is `null`.
|
||||
- `connection_checked: false`. Local configuration is not proof of a live login.
|
||||
|
||||
The overview does not expose the endpoint, access token, or authorization headers.
|
||||
Configured file paths are paths on the MCP host. All stream actions still require
|
||||
write mode; `upload_enabled` describes the configured file root, not permission
|
||||
to bypass that gate.
|
||||
|
||||
`get_runtime_info({"check_connection": true})` is available only in read/write
|
||||
mode with a client. It explicitly queries `get_login_info`, `get_status`, and
|
||||
`get_version_info`, using the ordinary read-only execution gate. Each entry under
|
||||
`checks` contains its original response and diagnostics. Partial failures remain
|
||||
visible. Check the returned status data for online state; a successful HTTP
|
||||
exchange alone does not establish that the account is online.
|
||||
|
||||
## Cancellation and progress
|
||||
|
||||
MCP cancellation now reaches ordinary HTTP calls as well as stream actions,
|
||||
including response-body reads. Ordinary calls retain their request timeout;
|
||||
streams retain separate connection and per-read idle timeouts. A cancelled call
|
||||
does not automatically retry. Cancellation or timeout can leave a remote write's
|
||||
outcome unknown: stopping the wait does not undo an operation already received
|
||||
by SnowLuma.
|
||||
|
||||
When a caller includes `_meta.progressToken`, stream execution emits standard
|
||||
`notifications/progress` notifications with the same token. File downloads report
|
||||
decoded bytes written; automatic uploads report bytes acknowledged by the server.
|
||||
Generic streams report accepted frame counts. A total is included only when a
|
||||
positive file size is known. Empty files and unknown-size downloads omit it.
|
||||
|
||||
Notifications are limited to one per 250 ms, plus the final pending update before
|
||||
a successful response. Values increase, notifications stop on cancellation or
|
||||
completion, and callers without a progress token receive none. Notification
|
||||
delivery failures are surfaced. Progress describes transferred data, not final
|
||||
commit: only a successful tool result confirms file validation and completion.
|
||||
|
||||
The existing file containment, quotas, partial-file cleanup and upload-reset
|
||||
behavior are unchanged. File bytes never appear in progress messages.
|
||||
9
packages/mcp/apps/message-preview.ts
Normal file
9
packages/mcp/apps/message-preview.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
import { App } from '@modelcontextprotocol/ext-apps';
|
||||
import { mountMessagePreview } from './preview-view.js';
|
||||
|
||||
const app = new App(
|
||||
{ name: 'SnowLuma 消息预览', version: '1.0.0' },
|
||||
{},
|
||||
{ strict: true, autoResize: true },
|
||||
);
|
||||
mountMessagePreview(app, document);
|
||||
196
packages/mcp/apps/preview-view.ts
Normal file
196
packages/mcp/apps/preview-view.ts
Normal file
@@ -0,0 +1,196 @@
|
||||
import type { App } from '@modelcontextprotocol/ext-apps';
|
||||
|
||||
export type PreviewApp = Pick<
|
||||
App,
|
||||
| 'ontoolresult'
|
||||
| 'ontoolcancelled'
|
||||
| 'onerror'
|
||||
| 'onclose'
|
||||
| 'connect'
|
||||
| 'getHostCapabilities'
|
||||
| 'callServerTool'
|
||||
>;
|
||||
|
||||
function record(value: unknown): value is Record<string, unknown> {
|
||||
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
||||
}
|
||||
|
||||
interface Draft {
|
||||
message_type: 'group' | 'private';
|
||||
target_id: number;
|
||||
text: string;
|
||||
reply_to?: number;
|
||||
}
|
||||
|
||||
function parseDraft(value: unknown): Draft | undefined {
|
||||
if (
|
||||
!record(value) ||
|
||||
(value.message_type !== 'group' && value.message_type !== 'private') ||
|
||||
typeof value.target_id !== 'number' ||
|
||||
!Number.isSafeInteger(value.target_id) ||
|
||||
value.target_id <= 0 ||
|
||||
typeof value.text !== 'string' ||
|
||||
value.text.trim().length === 0 ||
|
||||
(value.reply_to !== undefined &&
|
||||
(typeof value.reply_to !== 'number' ||
|
||||
!Number.isInteger(value.reply_to) ||
|
||||
value.reply_to === 0 ||
|
||||
value.reply_to < -2147483648 ||
|
||||
value.reply_to > 2147483647))
|
||||
) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return {
|
||||
message_type: value.message_type,
|
||||
target_id: value.target_id,
|
||||
text: value.text,
|
||||
...(value.reply_to !== undefined ? { reply_to: value.reply_to } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
export function mountMessagePreview(app: PreviewApp, document: Document): void {
|
||||
const element = (id: string) => {
|
||||
const value = document.getElementById(id);
|
||||
|
||||
if (!value) {
|
||||
throw new Error(`Missing preview element: ${id}`);
|
||||
}
|
||||
|
||||
return value;
|
||||
};
|
||||
|
||||
const target = element('target');
|
||||
const body = element('message');
|
||||
const reply = element('reply');
|
||||
const status = element('status');
|
||||
const send = element('send') as HTMLButtonElement;
|
||||
const cancel = element('cancel') as HTMLButtonElement;
|
||||
let draft: Draft | undefined;
|
||||
let canSend = false;
|
||||
let connected = false;
|
||||
let attempted = false;
|
||||
let cancelled = false;
|
||||
|
||||
const update = () => {
|
||||
send.disabled = !connected || !canSend || !draft || attempted || cancelled;
|
||||
cancel.disabled = !draft || attempted || cancelled;
|
||||
};
|
||||
|
||||
const stop = (message: string) => {
|
||||
connected = false;
|
||||
status.textContent = message;
|
||||
update();
|
||||
};
|
||||
|
||||
app.ontoolresult = (result) => {
|
||||
// A host may repeat delivery on restoration; never re-arm a sent draft.
|
||||
if (attempted || cancelled) {
|
||||
return;
|
||||
}
|
||||
|
||||
const data = record(result.structuredContent) ? result.structuredContent.result : undefined;
|
||||
draft = !result.isError && record(data) ? parseDraft(data.draft) : undefined;
|
||||
canSend = record(data) && data.can_send === true;
|
||||
|
||||
if (!draft) {
|
||||
target.textContent = '未收到有效草稿';
|
||||
body.textContent = '';
|
||||
reply.textContent = '';
|
||||
status.textContent = '草稿无效,请重新创建。';
|
||||
update();
|
||||
return;
|
||||
}
|
||||
|
||||
target.textContent = `${draft.message_type === 'group' ? '群聊' : '私聊'} · ${draft.target_id}`;
|
||||
body.textContent = draft.text;
|
||||
reply.textContent = draft.reply_to === undefined ? '' : `引用消息:${draft.reply_to}`;
|
||||
status.textContent = canSend
|
||||
? '消息尚未发送,请核对收件人和正文。'
|
||||
: '当前连接仅允许预览。';
|
||||
update();
|
||||
};
|
||||
|
||||
app.ontoolcancelled = () => {
|
||||
cancelled = true;
|
||||
status.textContent = '此草稿已取消。';
|
||||
update();
|
||||
};
|
||||
|
||||
app.onerror = () => stop('连接出现错误。请重新打开预览;发送状态需以会话为准。');
|
||||
app.onclose = () => stop('连接已断开。请重新打开预览;发送状态需以会话为准。');
|
||||
cancel.addEventListener('click', () => {
|
||||
if (attempted) {
|
||||
return;
|
||||
}
|
||||
|
||||
cancelled = true;
|
||||
status.textContent = '此草稿已取消,未发送消息。';
|
||||
update();
|
||||
});
|
||||
send.addEventListener('click', async () => {
|
||||
if (!connected || !canSend || !draft || attempted || cancelled) {
|
||||
return;
|
||||
}
|
||||
|
||||
attempted = true;
|
||||
update();
|
||||
status.textContent = '正在发送…';
|
||||
const message: Array<{ type: string; data: Record<string, string> }> = [];
|
||||
|
||||
if (draft.reply_to !== undefined) {
|
||||
message.push({ type: 'reply', data: { id: String(draft.reply_to) } });
|
||||
}
|
||||
|
||||
message.push({ type: 'text', data: { text: draft.text } });
|
||||
|
||||
try {
|
||||
const result = await app.callServerTool({
|
||||
name: 'invoke_action',
|
||||
arguments: {
|
||||
action: draft.message_type === 'group' ? 'send_group_msg' : 'send_private_msg',
|
||||
params: {
|
||||
[draft.message_type === 'group' ? 'group_id' : 'user_id']: draft.target_id,
|
||||
message,
|
||||
},
|
||||
},
|
||||
});
|
||||
const structured = result.structuredContent;
|
||||
const envelope = record(structured) ? structured.result : undefined;
|
||||
const diagnostics = record(structured) ? structured.diagnostics : undefined;
|
||||
|
||||
if (
|
||||
!result.isError &&
|
||||
record(envelope) &&
|
||||
envelope.status === 'ok' &&
|
||||
envelope.retcode === 0
|
||||
) {
|
||||
const data = envelope.data;
|
||||
const messageId = record(data) ? data.message_id : undefined;
|
||||
status.textContent =
|
||||
typeof messageId === 'number' && Number.isInteger(messageId)
|
||||
? `服务端已接受消息。消息编号:${messageId}`
|
||||
: '服务端已接受消息。';
|
||||
} else if (record(diagnostics) && diagnostics.outcome === 'failed') {
|
||||
status.textContent = `发送失败:${typeof diagnostics.message === 'string' ? diagnostics.message : '服务端拒绝了请求。'} 如需重试,请创建新草稿。`;
|
||||
} else {
|
||||
status.textContent = '发送状态尚未确认。请先检查会话,不要重复发送。';
|
||||
}
|
||||
} catch {
|
||||
status.textContent = '发送状态尚未确认。请先检查会话,不要重复发送。';
|
||||
}
|
||||
});
|
||||
update();
|
||||
void app.connect().then(
|
||||
() => {
|
||||
connected = app.getHostCapabilities()?.serverTools !== undefined;
|
||||
|
||||
if (!connected) {
|
||||
status.textContent = '当前客户端仅支持预览,不能从面板发送。';
|
||||
}
|
||||
|
||||
update();
|
||||
},
|
||||
() => stop('无法连接到消息服务。请重新打开预览。'),
|
||||
);
|
||||
}
|
||||
9
packages/mcp/apps/tsconfig.json
Normal file
9
packages/mcp/apps/tsconfig.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"extends": "../../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"lib": ["ES2022", "DOM"],
|
||||
"noEmit": true,
|
||||
"types": []
|
||||
},
|
||||
"include": ["*.ts"]
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"license": "SEE LICENSE IN LICENSE",
|
||||
"name": "@snowluma/mcp",
|
||||
"version": "2.0.1",
|
||||
"version": "2.4.0",
|
||||
"description": "MCP server exposing the SnowLuma OneBot action catalog (docs + JSON Schemas) and optional execution to LLM clients.",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@@ -20,15 +20,16 @@
|
||||
"types": "./dist/server.d.ts",
|
||||
"files": [
|
||||
"dist",
|
||||
"README.md"
|
||||
"README.md",
|
||||
"AGENT_FEATURES.md"
|
||||
],
|
||||
"scripts": {
|
||||
"clean": "node -e \"const fs=require('node:fs');fs.rmSync('dist',{recursive:true,force:true})\"",
|
||||
"gen": "vitest run scripts/gen-catalog.test.ts",
|
||||
"prebuild": "pnpm run clean && pnpm run gen",
|
||||
"build": "tsc -p tsconfig.json",
|
||||
"build": "tsc -p tsconfig.json && node scripts/build-message-app.mjs",
|
||||
"prepack": "pnpm run build",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"typecheck": "tsc --noEmit && tsc -p apps/tsconfig.json",
|
||||
"test": "vitest run",
|
||||
"start": "node dist/server.js"
|
||||
},
|
||||
@@ -40,18 +41,23 @@
|
||||
"qq"
|
||||
],
|
||||
"dependencies": {
|
||||
"@modelcontextprotocol/sdk": "^1.0.0"
|
||||
"@modelcontextprotocol/server": "^2.3.1",
|
||||
"ws": "^8.21.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@modelcontextprotocol/client": "^2.3.1",
|
||||
"@modelcontextprotocol/sdk": "^1.32.0",
|
||||
"@snowluma/onebot": "workspace:*",
|
||||
"@snowluma/proton": "workspace:*",
|
||||
"@types/node": "catalog:",
|
||||
"typescript": "catalog:",
|
||||
"vite": "catalog:",
|
||||
"vitest": "^4.1.4"
|
||||
"vitest": "4.1.12",
|
||||
"@types/ws": "^8.18.1",
|
||||
"@modelcontextprotocol/ext-apps": "^2.0.3"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
"node": "^24.22.1 || >=26.12.1"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
|
||||
48
packages/mcp/scripts/build-message-app.mjs
Normal file
48
packages/mcp/scripts/build-message-app.mjs
Normal file
@@ -0,0 +1,48 @@
|
||||
import { createHash } from 'node:crypto';
|
||||
import { mkdir, writeFile } from 'node:fs/promises';
|
||||
import { dirname, join, resolve } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { build } from 'vite';
|
||||
|
||||
const packageRoot = fileURLToPath(new URL('../', import.meta.url));
|
||||
const style = `
|
||||
:root{color-scheme:light dark;font-family:system-ui,sans-serif;color:var(--color-text-primary,#20242d);background:var(--color-background-primary,#fff)}
|
||||
*{box-sizing:border-box}body{margin:0;padding:24px;max-width:760px}h1{font-size:21px;margin:0 0 18px}#target{font-size:14px;font-weight:650;margin:0 0 14px}#message{white-space:pre-wrap;overflow-wrap:anywhere;font:inherit;line-height:1.6;margin:0;padding:18px;border:1px solid var(--color-border-primary,#d7dce3);border-radius:10px}#reply{font-size:13px;margin:12px 0;color:var(--color-text-secondary,#626b78)}#status{font-size:14px;line-height:1.5;margin:18px 0}footer{display:flex;gap:10px;flex-wrap:wrap}button{font:inherit;font-size:14px;border:1px solid var(--color-border-primary,#bbc4d0);border-radius:8px;padding:10px 16px;cursor:pointer;background:var(--color-background-primary,#fff);color:inherit}#send{background:#2252a5;color:white;border-color:#2252a5}button:disabled{opacity:.55;cursor:default}button:focus-visible{outline:3px solid #8eb7ff;outline-offset:3px}@media(prefers-color-scheme:dark){:root{color:var(--color-text-primary,#e8ecf3);background:var(--color-background-primary,#1b1e24)}#reply{color:var(--color-text-secondary,#b3bdcb)}button{background:var(--color-background-primary,#1b1e24)}}
|
||||
`.trim();
|
||||
|
||||
export async function buildMessageApp(outDir = join(packageRoot, 'dist')) {
|
||||
const result = await build({
|
||||
configFile: false,
|
||||
root: packageRoot,
|
||||
logLevel: 'error',
|
||||
build: {
|
||||
write: false,
|
||||
sourcemap: false,
|
||||
lib: {
|
||||
entry: join(packageRoot, 'apps/message-preview.ts'),
|
||||
name: 'SnowLumaMessagePreview',
|
||||
formats: ['iife'],
|
||||
},
|
||||
},
|
||||
});
|
||||
const outputs = Array.isArray(result) ? result.flatMap((item) => item.output) : result.output;
|
||||
|
||||
if (outputs.length !== 1 || outputs[0].type !== 'chunk') {
|
||||
throw new Error('Message app must build to a single self-contained script');
|
||||
}
|
||||
|
||||
const script = outputs[0].code.replace(/<\/script/gi, '<\\/script');
|
||||
const hash = (source) => createHash('sha256').update(source).digest('base64');
|
||||
const csp = `default-src 'none'; script-src 'sha256-${hash(script)}'; style-src 'sha256-${hash(style)}'; connect-src 'none'; frame-src 'none'; object-src 'none'; base-uri 'none'; form-action 'none'`;
|
||||
const html = `<!doctype html>
|
||||
<html lang="zh-CN"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="Content-Security-Policy" content="${csp}"><title>消息草稿预览</title><style>${style}</style></head>
|
||||
<body><main><h1>消息草稿预览</h1><p id="target">正在载入草稿…</p><pre id="message"></pre><p id="reply"></p><p id="status" role="status" aria-live="polite">消息尚未发送。</p><footer><button id="send" type="button" disabled>发送这条消息</button><button id="cancel" type="button" disabled>取消草稿</button></footer></main><script>${script}</script></body></html>`;
|
||||
const filename = join(outDir, 'message-app.html');
|
||||
await mkdir(dirname(filename), { recursive: true });
|
||||
await writeFile(filename, html, 'utf8');
|
||||
return filename;
|
||||
}
|
||||
|
||||
if (process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
|
||||
await buildMessageApp();
|
||||
}
|
||||
@@ -18,6 +18,8 @@ it('generates src/generated/catalog.ts from the live action specs', () => {
|
||||
for (const a of actions) {
|
||||
expect(a.inputSchema).toBeTypeOf('object');
|
||||
expect(a.name).toBeTruthy();
|
||||
expect(a.returnsSchema, `${a.name} result schema`).toBeTypeOf('object');
|
||||
expect(a.examples?.length, `${a.name} invocation examples`).toBeGreaterThan(0);
|
||||
}
|
||||
|
||||
const body =
|
||||
|
||||
@@ -2,16 +2,16 @@
|
||||
//
|
||||
// The OneBot v11 HTTP action protocol is trivial — POST `{ action, params }` to
|
||||
// the endpoint, read back the JSON envelope — so the MCP talks to it directly
|
||||
// with `fetch`. We deliberately do NOT depend on @snowluma/sdk here: its
|
||||
// published dist is bundler-targeted ESM (extensionless relative imports) that
|
||||
// native `node` cannot resolve without a bundler, and this package is a plain
|
||||
// `tsc`-built stdio bin. The wire shape — not a shared client type — is the seam
|
||||
// (ADR-0005); tests inject a fake `ActionClient` (or a fake `fetch`).
|
||||
// with `fetch`. This client also owns MCP-host file admission and bounded stream
|
||||
// summaries. The wire shape — not a shared client type — is the seam (ADR-0005);
|
||||
// tests inject a fake `ActionClient` (or a fake `fetch`).
|
||||
|
||||
import fs from 'node:fs';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
import { createHash, randomUUID } from 'node:crypto';
|
||||
import { ActionCallError } from './results.js';
|
||||
import type { TraceContext } from './tracing.js';
|
||||
|
||||
const DEFAULT_TIMEOUT_MS = 30_000;
|
||||
const DEFAULT_MAX_STREAM_BYTES = 4 * 1024 * 1024 * 1024;
|
||||
@@ -27,7 +27,7 @@ const MAX_FILE_CHUNKS = 200_000;
|
||||
const RESET_TIMEOUT_MS = 5_000;
|
||||
const MAX_ACTIVE_STREAMS = 4;
|
||||
const INTERNAL_STREAM_CALL = Symbol('snowluma.mcp.internalStreamCall');
|
||||
const MCP_UPLOAD_OWNED_FIELDS = [
|
||||
export const MCP_UPLOAD_OWNED_FIELDS = [
|
||||
'stream_id',
|
||||
'chunk_data',
|
||||
'chunk_index',
|
||||
@@ -102,9 +102,14 @@ export interface OneBotEnvelope {
|
||||
}
|
||||
|
||||
export interface ActionClient {
|
||||
readonly info?: ClientInfo;
|
||||
/** Send one OneBot action; resolves the full envelope (even on retcode≠0),
|
||||
* rejects only on transport-level failure (timeout / connection / bad body). */
|
||||
call(action: string, params: Record<string, unknown>): Promise<OneBotEnvelope>;
|
||||
call(
|
||||
action: string,
|
||||
params: Record<string, unknown>,
|
||||
options?: CallOptions,
|
||||
): Promise<OneBotEnvelope>;
|
||||
/** Execute a Stream Action over the HTTP multi-frame transport. */
|
||||
callStream(
|
||||
action: string,
|
||||
@@ -113,11 +118,42 @@ export interface ActionClient {
|
||||
): Promise<StreamCallResult>;
|
||||
}
|
||||
|
||||
export interface StreamCallOptions {
|
||||
export interface ClientInfo {
|
||||
timeout_ms: number;
|
||||
max_stream_bytes: number;
|
||||
download_quota_bytes: number;
|
||||
max_active_streams: number;
|
||||
download_directory: string;
|
||||
upload_root: string | null;
|
||||
upload_enabled: boolean;
|
||||
}
|
||||
|
||||
export interface TransferProgress {
|
||||
progress: number;
|
||||
total?: number;
|
||||
message: string;
|
||||
}
|
||||
|
||||
export interface CallOptions {
|
||||
signal?: AbortSignal;
|
||||
trace?: TraceContext;
|
||||
}
|
||||
|
||||
function requestHeaders(
|
||||
base: Record<string, string>,
|
||||
trace?: TraceContext,
|
||||
): Record<string, string> {
|
||||
return {
|
||||
...base,
|
||||
...(trace ? { traceparent: trace.traceparent } : {}),
|
||||
...(trace?.tracestate ? { tracestate: trace.tracestate } : {}),
|
||||
};
|
||||
}
|
||||
|
||||
export interface StreamCallOptions extends CallOptions {
|
||||
/** MCP-host file to upload. Only valid for upload_file_stream. */
|
||||
inputFile?: string;
|
||||
/** Cancellation from the originating MCP request. */
|
||||
signal?: AbortSignal;
|
||||
onProgress?: (progress: TransferProgress) => Promise<void>;
|
||||
}
|
||||
|
||||
type InternalStreamCallOptions = StreamCallOptions & { [INTERNAL_STREAM_CALL]?: true };
|
||||
@@ -346,7 +382,10 @@ function abortReason(signal: AbortSignal): string {
|
||||
|
||||
function throwIfCancelled(signal: AbortSignal | undefined, action: string, stage: string): void {
|
||||
if (signal?.aborted) {
|
||||
throw new Error(`action ${action} stream ${stage}: cancelled: ${abortReason(signal)}`);
|
||||
throw new ActionCallError(
|
||||
`action ${action} stream ${stage}: cancelled: ${abortReason(signal)}`,
|
||||
'cancelled',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -360,8 +399,9 @@ async function readWithIdleTimeout(
|
||||
frameIndex: number,
|
||||
): Promise<ByteStreamReadResult> {
|
||||
if (callerSignal?.aborted) {
|
||||
throw new Error(
|
||||
throw new ActionCallError(
|
||||
`action ${action} stream read frame ${frameIndex}: cancelled: ${abortReason(callerSignal)}`,
|
||||
'cancelled',
|
||||
);
|
||||
}
|
||||
|
||||
@@ -382,8 +422,9 @@ async function readWithIdleTimeout(
|
||||
const onAbort = (): void =>
|
||||
finish(() =>
|
||||
reject(
|
||||
new Error(
|
||||
new ActionCallError(
|
||||
`action ${action} stream read frame ${frameIndex}: cancelled: ${callerSignal ? abortReason(callerSignal) : 'aborted'}`,
|
||||
'cancelled',
|
||||
),
|
||||
),
|
||||
);
|
||||
@@ -391,8 +432,9 @@ async function readWithIdleTimeout(
|
||||
() =>
|
||||
finish(() =>
|
||||
reject(
|
||||
new Error(
|
||||
new ActionCallError(
|
||||
`action ${action} stream read frame ${frameIndex}: idle timeout after ${timeoutMs}ms`,
|
||||
'timeout',
|
||||
),
|
||||
),
|
||||
),
|
||||
@@ -418,6 +460,7 @@ async function uploadLocalFile(
|
||||
maxStreamBytes: number,
|
||||
callerSignal: AbortSignal | undefined,
|
||||
post: (params: Record<string, unknown>, signal?: AbortSignal) => Promise<StreamCallResult>,
|
||||
onProgress?: StreamCallOptions['onProgress'],
|
||||
): Promise<UploadStreamResult> {
|
||||
const streamId = randomUUID();
|
||||
let handle: fs.promises.FileHandle | undefined;
|
||||
@@ -442,6 +485,11 @@ async function uploadLocalFile(
|
||||
}
|
||||
|
||||
const totalChunks = Math.max(1, Math.ceil(initial.size / UPLOAD_CHUNK_BYTES));
|
||||
await onProgress?.({
|
||||
progress: 0,
|
||||
...(initial.size > 0 ? { total: initial.size } : {}),
|
||||
message: '上传开始(字节)',
|
||||
});
|
||||
const baseParams = { ...params };
|
||||
|
||||
for (const key of MCP_UPLOAD_OWNED_FIELDS) {
|
||||
@@ -507,6 +555,12 @@ async function uploadLocalFile(
|
||||
`unexpected chunk acknowledgement: ${JSON.stringify(ack.terminal)}`,
|
||||
);
|
||||
}
|
||||
|
||||
await onProgress?.({
|
||||
progress: bytesRead,
|
||||
...(initial.size > 0 ? { total: initial.size } : {}),
|
||||
message: '已确认上传(字节);等待最终校验',
|
||||
});
|
||||
}
|
||||
|
||||
stage = 'verify input';
|
||||
@@ -605,6 +659,7 @@ async function uploadLocalFile(
|
||||
|
||||
throw new Error(
|
||||
`action ${action} stream ${stage}: ${detail}${closeFailure}${resetFailure}`,
|
||||
{ cause: error },
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -667,36 +722,75 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
let client: ActionClient;
|
||||
let activeStreams = 0;
|
||||
client = {
|
||||
async call(action, params) {
|
||||
let res: Response;
|
||||
info: Object.freeze({
|
||||
timeout_ms: timeoutMs,
|
||||
max_stream_bytes: maxStreamBytes,
|
||||
download_quota_bytes: 2 * maxStreamBytes,
|
||||
max_active_streams: MAX_ACTIVE_STREAMS,
|
||||
download_directory: streamDir,
|
||||
upload_root: uploadRoot ?? null,
|
||||
upload_enabled: uploadRoot !== undefined,
|
||||
}),
|
||||
async call(action, params, options) {
|
||||
const deadline = new AbortController();
|
||||
const signal = options?.signal
|
||||
? AbortSignal.any([options.signal, deadline.signal])
|
||||
: deadline.signal;
|
||||
const timer = setTimeout(
|
||||
() => deadline.abort(new Error(`timeout after ${timeoutMs}ms`)),
|
||||
timeoutMs,
|
||||
);
|
||||
timer.unref();
|
||||
|
||||
try {
|
||||
res = await fetchImpl(opts.endpoint, {
|
||||
signal.throwIfAborted();
|
||||
const res = await fetchImpl(opts.endpoint, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
headers: requestHeaders(headers, options?.trace),
|
||||
body: JSON.stringify({ action, params }),
|
||||
signal: AbortSignal.timeout(timeoutMs),
|
||||
signal,
|
||||
});
|
||||
const text = await res.text();
|
||||
signal.throwIfAborted();
|
||||
let parsed: unknown;
|
||||
|
||||
try {
|
||||
parsed = text ? JSON.parse(text) : null;
|
||||
} catch {
|
||||
throw new ActionCallError(
|
||||
`OneBot returned non-JSON (HTTP ${res.status})`,
|
||||
res.status === 401 || res.status === 403
|
||||
? 'authentication'
|
||||
: 'invalid_response',
|
||||
);
|
||||
}
|
||||
|
||||
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
||||
throw new ActionCallError(
|
||||
`OneBot returned an unexpected response (HTTP ${res.status})`,
|
||||
'invalid_response',
|
||||
);
|
||||
}
|
||||
|
||||
return parsed as OneBotEnvelope;
|
||||
} catch (error) {
|
||||
throw new Error(
|
||||
if (error instanceof ActionCallError) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
const kind = options?.signal?.aborted
|
||||
? 'cancelled'
|
||||
: deadline.signal.aborted
|
||||
? 'timeout'
|
||||
: 'transport';
|
||||
throw new ActionCallError(
|
||||
`action ${action} request: ${error instanceof Error ? error.message : String(error)}`,
|
||||
kind,
|
||||
{ cause: error },
|
||||
);
|
||||
} finally {
|
||||
clearTimeout(timer);
|
||||
}
|
||||
|
||||
const text = await res.text();
|
||||
let parsed: unknown;
|
||||
|
||||
try {
|
||||
parsed = text ? JSON.parse(text) : null;
|
||||
} catch {
|
||||
throw new Error(`OneBot returned non-JSON (HTTP ${res.status})`);
|
||||
}
|
||||
|
||||
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
||||
throw new Error(`OneBot returned an unexpected response (HTTP ${res.status})`);
|
||||
}
|
||||
|
||||
return parsed as OneBotEnvelope;
|
||||
},
|
||||
async callStream(action, params, options) {
|
||||
const internalOptions = options as InternalStreamCallOptions | undefined;
|
||||
@@ -761,8 +855,10 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
(uploadParams, signal) =>
|
||||
client.callStream(action, uploadParams, {
|
||||
...(signal ? { signal } : {}),
|
||||
...(options.trace ? { trace: options.trace } : {}),
|
||||
[INTERNAL_STREAM_CALL]: true,
|
||||
} as InternalStreamCallOptions),
|
||||
options.onProgress,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -782,9 +878,10 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
}
|
||||
|
||||
try {
|
||||
throwIfCancelled(options?.signal, action, 'connection');
|
||||
res = await fetchImpl(opts.endpoint, {
|
||||
method: 'POST',
|
||||
headers,
|
||||
headers: requestHeaders(headers, options?.trace),
|
||||
body: JSON.stringify({ action, params }),
|
||||
signal: requestSignal,
|
||||
});
|
||||
@@ -796,14 +893,23 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
: error instanceof Error
|
||||
? error.message
|
||||
: String(error);
|
||||
throw new Error(`action ${action} stream connection: ${detail}`);
|
||||
throw new ActionCallError(
|
||||
`action ${action} stream connection: ${detail}`,
|
||||
options?.signal?.aborted
|
||||
? 'cancelled'
|
||||
: connectionController.signal.aborted
|
||||
? 'timeout'
|
||||
: 'transport',
|
||||
{ cause: error },
|
||||
);
|
||||
} finally {
|
||||
clearTimeout(connectionTimer);
|
||||
}
|
||||
|
||||
if (!res.ok) {
|
||||
throw new Error(
|
||||
throw new ActionCallError(
|
||||
`action ${action} stream HTTP: unexpected status ${res.status}`,
|
||||
res.status === 401 || res.status === 403 ? 'authentication' : 'transport',
|
||||
);
|
||||
}
|
||||
|
||||
@@ -833,6 +939,7 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
frame: OneBotEnvelope,
|
||||
rawBytes: number,
|
||||
): Promise<void> => {
|
||||
throwIfCancelled(options?.signal, action, `frame ${frameIndex}`);
|
||||
const data = record(frame.data);
|
||||
const dataType = data?.data_type;
|
||||
const resetAck =
|
||||
@@ -942,6 +1049,12 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
throw error;
|
||||
}
|
||||
|
||||
await options?.onProgress?.({
|
||||
progress: 0,
|
||||
...(declaredSize !== undefined ? { total: declaredSize } : {}),
|
||||
message: '下载开始(字节)',
|
||||
});
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1008,6 +1121,11 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
fileHash.update(chunk);
|
||||
fileBytes += chunk.length;
|
||||
fileChunks++;
|
||||
await options?.onProgress?.({
|
||||
progress: fileBytes,
|
||||
...(declaredSize !== undefined ? { total: declaredSize } : {}),
|
||||
message: '已接收下载(字节);等待最终校验',
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1046,6 +1164,11 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
if (data?.type === 'response') {
|
||||
genericTerminalIndex = frameIndex;
|
||||
}
|
||||
|
||||
await options?.onProgress?.({
|
||||
progress: frames.length,
|
||||
message: '已接收数据帧',
|
||||
});
|
||||
};
|
||||
|
||||
try {
|
||||
@@ -1112,6 +1235,7 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
|
||||
throw new Error(
|
||||
`action ${action} stream frame ${frameIndex}: frame handling failed: ${detail}`,
|
||||
{ cause: error },
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1173,6 +1297,7 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
}
|
||||
|
||||
const sha256 = fileHash.digest('hex');
|
||||
throwIfCancelled(options?.signal, action, 'commit download');
|
||||
await fileHandle.close();
|
||||
fileHandle = undefined;
|
||||
await fs.promises.rename(partPath!, finalPath!);
|
||||
@@ -1243,7 +1368,7 @@ export function makeHttpClient(opts: HttpClientOptions): ActionClient {
|
||||
const suffix = cleanupErrors.length
|
||||
? `; cleanup failed (${cleanupErrors.join('; ')})`
|
||||
: '';
|
||||
throw new Error(base + suffix);
|
||||
throw new Error(base + suffix, { cause: error });
|
||||
} finally {
|
||||
reader.releaseLock();
|
||||
}
|
||||
|
||||
119
packages/mcp/src/discovery.ts
Normal file
119
packages/mcp/src/discovery.ts
Normal file
@@ -0,0 +1,119 @@
|
||||
import type { CatalogAction } from './types.js';
|
||||
|
||||
export const FILTER_PROPERTIES = {
|
||||
category: { type: 'string', description: '按分类过滤,如 群管理 / 消息 / 好友' },
|
||||
read_only: { type: 'boolean', description: '只返回指定读写类型的动作' },
|
||||
stream: { type: 'boolean', description: '只返回指定流式类型的动作' },
|
||||
limit: {
|
||||
type: 'integer',
|
||||
minimum: 1,
|
||||
maximum: 200,
|
||||
description: '每页数量;省略时返回全部匹配项',
|
||||
},
|
||||
offset: { type: 'integer', minimum: 0, description: '跳过的匹配项数量,默认 0' },
|
||||
};
|
||||
|
||||
const SYNONYMS = [
|
||||
['历史消息', '消息历史', 'history'],
|
||||
['群聊', '群', 'group'],
|
||||
['私聊', '好友', 'private', 'friend'],
|
||||
['禁言', 'ban', 'mute'],
|
||||
['撤回', '撤销消息', 'delete_msg', 'recall'],
|
||||
['图片', 'image', 'photo'],
|
||||
['语音', 'record', 'voice'],
|
||||
['文件', 'file'],
|
||||
['上传', 'upload'],
|
||||
['下载', 'download'],
|
||||
];
|
||||
|
||||
export function lite(action: CatalogAction) {
|
||||
return {
|
||||
name: action.name,
|
||||
category: action.category,
|
||||
summary: action.summary,
|
||||
aliases: action.aliases,
|
||||
readOnly: action.readOnly,
|
||||
stream: action.stream ?? false,
|
||||
};
|
||||
}
|
||||
|
||||
/** Optional controls must not change legacy matching, order or response fields. */
|
||||
export function discover(actions: CatalogAction[], args: Record<string, unknown>, search: boolean) {
|
||||
for (const key of ['read_only', 'stream']) {
|
||||
if (args[key] !== undefined && typeof args[key] !== 'boolean') {
|
||||
throw new Error(`${key} 必须是布尔值。`);
|
||||
}
|
||||
}
|
||||
|
||||
for (const key of ['limit', 'offset']) {
|
||||
const value = args[key];
|
||||
|
||||
if (
|
||||
value !== undefined &&
|
||||
(typeof value !== 'number' ||
|
||||
!Number.isSafeInteger(value) ||
|
||||
value < (key === 'limit' ? 1 : 0) ||
|
||||
(key === 'limit' && value > 200))
|
||||
) {
|
||||
throw new Error(`${key} 必须是有效整数(limit 为 1–200,offset 不小于 0)。`);
|
||||
}
|
||||
}
|
||||
|
||||
if (args.match !== undefined && args.match !== 'substring' && args.match !== 'keywords') {
|
||||
throw new Error('match 必须为 substring 或 keywords。');
|
||||
}
|
||||
|
||||
const query = (typeof args.query === 'string' ? args.query : '').toLowerCase();
|
||||
const category = typeof args.category === 'string' ? args.category : undefined;
|
||||
const keywords = query.trim().split(/\s+/u).filter(Boolean);
|
||||
let list = actions.filter((action) => {
|
||||
if (
|
||||
(category && action.category !== category) ||
|
||||
(args.read_only !== undefined && action.readOnly !== args.read_only) ||
|
||||
(args.stream !== undefined && (action.stream ?? false) !== args.stream)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!search) {
|
||||
return true;
|
||||
}
|
||||
|
||||
const fields = [action.name, action.summary ?? '', ...action.aliases].map((s) =>
|
||||
s.toLowerCase(),
|
||||
);
|
||||
|
||||
if (args.match !== 'keywords') {
|
||||
return fields.some((field) => field.includes(query));
|
||||
}
|
||||
|
||||
return keywords.every((keyword) => {
|
||||
const alternatives = SYNONYMS.find((group) => group.includes(keyword)) ?? [keyword];
|
||||
return alternatives.some((alternative) =>
|
||||
fields.some((field) => field.includes(alternative)),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
if (search && args.match === 'keywords') {
|
||||
const exact = (action: CatalogAction) =>
|
||||
action.name.toLowerCase() === query.trim() ||
|
||||
action.aliases.some((alias) => alias.toLowerCase() === query.trim());
|
||||
list = list.sort((a, b) => Number(exact(b)) - Number(exact(a)));
|
||||
}
|
||||
|
||||
const offset = typeof args.offset === 'number' ? args.offset : 0;
|
||||
const limit = typeof args.limit === 'number' ? args.limit : list.length;
|
||||
const page = list.slice(offset, offset + limit).map(lite);
|
||||
const paginated = args.limit !== undefined || args.offset !== undefined;
|
||||
return {
|
||||
count: page.length,
|
||||
actions: page,
|
||||
...(paginated
|
||||
? {
|
||||
total: list.length,
|
||||
next_offset: offset + page.length < list.length ? offset + page.length : null,
|
||||
}
|
||||
: {}),
|
||||
};
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user