跨端: 接手 pi 的两个 WebUI 开项——默认值统一到服务端契约 12/4;缓存键按账号(含一次性迁移)
pi 问"这两个开项谁执行",我接了(他那边无 shell,我这边改过 WebUI)。两件都是他读源码读出来的实缺陷。 ## 1 默认值:不是审美,是**服务端契约**(pi 更正了自己上一封) `server/internal/models/models.go` 的 `DefaultAppearance()` 明写 `BgDim: 12, BgBlur: 4`, 且注释宣称"与客户端 backgroundStore / themeStore 的默认值一致"——而 WebUI 的 `backgroundStore.ts` 是 `dim: 24, blur: 8`,**那句注释是假的**;`lib/appearance.ts` 的 `clamp(..., 12, 4)` 又是另一套。**同一份代码里两个"默认值"**,走哪条路就落哪个数。 后果不是"两处代码不一样"这么轻:服务端"没有记录"时客户端以本地为准推上去, 于是**新账号的初始外观由第一个同步它的客户端决定**(先 WebUI 登录存 24/8, 先鸿蒙登录存 12/4)——同一个账号,压暗强度取决于谁先到。 改法:新增 `src/lib/appearanceDefaults.ts` 作为**唯一来源**(DEFAULT_DIM/DEFAULT_BLUR/ 上限),`backgroundStore` 与 `lib/appearance` 都引用它,字面量全部消失。 ## 2 缓存键按账号(含旧全局键的一次性迁移) `STORAGE_KEY = 'agentmail.background'` → `storageKey(accountId)` = 前缀 + 账号; 写盘只走 `storageKey()`;旧全局键**只作为迁移源**:当前账号首次读到它时接管并存进自己的键, 然后**立刻删除**(否则下一个账号继续从它"继承",等于把刚修的缺陷留在原地); 未登录时不迁移(旧值不能送给一个还不知道是谁的账号)。 配套顺序:`appearanceSync` 在账号切换时**先 `reloadForAccount()` 再 `pull()`** —— 服务端"没有记录"时 `pull()` 会"以本地为准推上去",那时"本地"必须已经是本账号的值。 ## 3 判据(新增第 13 个判据文件 appearance-defaults) `test/appearance-defaults.test.mjs`:**去 Go 源码里读** `DefaultAppearance()` 的四个字段, 再比对三处(WebUI 常量、store 的 DEFAULT_BACKGROUND 不许有字面量、鸿蒙 Appearance 的字段默认值); 另两条钉"键按账号、不许退回全局键、旧键必须被删除"与"重读在 pull 之前"。 这样服务端那句注释是**可核对**的,不是承诺。 顺带更正:`Wallpaper.ts` 里"WebUI 默认 24"的注释已过时 → 改 12 并写明缘由; `harmony-appearance` 里"WebUI 是全局键"的前提失效 → 改为断言两端都按账号分键。 ## 验证 `npm test` 退出码 0(13 个判据文件全绿 + vitest 263 passed,原 258 + 新增 5 条行为测试: 键隔离、迁移一次并删除、未登录不迁移、默认值=12/4)。
This commit is contained in:
153
client/electron/test/appearance-defaults.test.mjs
Normal file
153
client/electron/test/appearance-defaults.test.mjs
Normal file
@ -0,0 +1,153 @@
|
||||
// 外观的**服务端契约**与**本机缓存的键**:两个客户端的默认值必须等于服务端那三个数,
|
||||
// 缓存键必须按账号分。
|
||||
//
|
||||
// 为什么值得单独一个判据文件:
|
||||
// 1. 服务端 `DefaultAppearance()` 的注释宣称"与客户端 backgroundStore / themeStore 的
|
||||
// 默认值一致" —— 在 WebUI 用 24/8 时那句话**是假的**(pi 2026-09-14 更正了自己
|
||||
// 上一封"数值是审美"的说法:它是契约问题)。这条判据把那句注释变成**可核对**的。
|
||||
// 2. 默认值决定"新账号的初始外观":服务端"没有记录"时客户端以本地为准推上去,
|
||||
// 于是**谁先同步谁决定**。24/8 与 12/4 的差别不是审美,是同一个账号在不同客户端
|
||||
// 登录会得到不同的压暗强度。
|
||||
// 3. 缓存键是"换账号串味"的成因(全局键 → saved=false 时把上一个账号的外观推上去)。
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import { test } from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
|
||||
// 与其它判据同一个约定:HERE = client/electron/test,ROOT = 仓库根
|
||||
const HERE = dirname(fileURLToPath(import.meta.url));
|
||||
const ROOT = join(HERE, '..', '..', '..');
|
||||
const SERVER_MODELS = join(ROOT, 'server/internal/models/models.go');
|
||||
const ETS = join(ROOT, 'client/harmony/entry/src/main/ets');
|
||||
|
||||
/** 从 Go 源码里读服务端契约(不复制一份数字到判据里 —— 那又会变成"两处各写一套") */
|
||||
function serverDefaults() {
|
||||
const src = readFileSync(SERVER_MODELS, 'utf8');
|
||||
// 只取 DefaultAppearance 函数体,避免匹配到别的结构体字面量
|
||||
const at = src.indexOf('func DefaultAppearance()');
|
||||
assert.ok(at > 0, '服务端要有 DefaultAppearance()');
|
||||
let depth = 0;
|
||||
let end = at;
|
||||
for (let i = src.indexOf('{', at); i < src.length; i++) {
|
||||
if (src[i] === '{') depth++;
|
||||
else if (src[i] === '}') { depth--; if (depth === 0) { end = i; break; } }
|
||||
}
|
||||
const body = src.slice(at, end + 1);
|
||||
const dim = /BgDim:\s*(\d+)/.exec(body);
|
||||
const blur = /BgBlur:\s*(\d+)/.exec(body);
|
||||
const theme = /Theme:\s*"([^"]+)"/.exec(body);
|
||||
const kind = /BgKind:\s*"([^"]+)"/.exec(body);
|
||||
const preset = /BgPresetID:\s*"([^"]+)"/.exec(body);
|
||||
assert.ok(dim && blur && theme && kind && preset, `DefaultAppearance 里这几个字段都要有(实际:${body})`);
|
||||
return {
|
||||
dim: Number(dim[1]),
|
||||
blur: Number(blur[1]),
|
||||
theme: theme[1],
|
||||
kind: kind[1],
|
||||
preset: preset[1]
|
||||
};
|
||||
}
|
||||
|
||||
test('★ 默认外观 = 服务端契约(去 Go 源码里读,不在判据里写死数字)', () => {
|
||||
const s = serverDefaults();
|
||||
assert.deepEqual([s.dim, s.blur], [12, 4], '服务端 DefaultAppearance 是 12/4(权威值)');
|
||||
|
||||
// WebUI:默认值必须来自共享常量,且等于服务端
|
||||
const defaults = readFileSync(join(ROOT, 'client/electron/src/lib/appearanceDefaults.ts'), 'utf8');
|
||||
assert.match(defaults, new RegExp(`DEFAULT_DIM = ${s.dim}\\b`), `DEFAULT_DIM 要等于服务端的 BgDim=${s.dim}`);
|
||||
assert.match(defaults, new RegExp(`DEFAULT_BLUR = ${s.blur}\\b`), `DEFAULT_BLUR 要等于服务端的 BgBlur=${s.blur}`);
|
||||
// 严格:store 里不许再自写一套数字(原来这里写的是 24/8,与服务端不一致)
|
||||
const store = readFileSync(join(ROOT, 'client/electron/src/stores/backgroundStore.ts'), 'utf8');
|
||||
const defBlock = /export const DEFAULT_BACKGROUND: BackgroundState = \{[\s\S]*?\};/.exec(store);
|
||||
assert.ok(defBlock, 'DEFAULT_BACKGROUND 要能取到');
|
||||
assert.match(defBlock[0], /dim:\s*DEFAULT_DIM/, 'dim 要引用共享常量,不许自写字面量');
|
||||
assert.match(defBlock[0], /blur:\s*DEFAULT_BLUR/, 'blur 要引用共享常量');
|
||||
assert.ok(!/dim:\s*\d/.test(defBlock[0]), `DEFAULT_BACKGROUND 里不许再出现数字字面量(现在:${defBlock[0].replace(/\s+/g, ' ')})`);
|
||||
// 同步层的兜底值也要引用同一常量(原来 clamp(..., 12, 4) 是另写的一份)
|
||||
const lib = readFileSync(join(ROOT, 'client/electron/src/lib/appearance.ts'), 'utf8');
|
||||
const clamps = [...lib.matchAll(/clamp\([^)]*\)/g)].map(m => m[0]);
|
||||
assert.ok(clamps.length >= 4, `clamp 调用要能取到(实际 ${clamps.length} 处)`);
|
||||
for (const c of clamps) {
|
||||
assert.ok(!/,\s*\d+\s*\)$/.test(c), `clamp 的兜底值要引用常量,不许写死:${c}`);
|
||||
}
|
||||
|
||||
// 鸿蒙:默认值(在 AppearanceResponse 的字段默认值里)与预设也要与服务端对得上
|
||||
const ap = readFileSync(join(ETS, 'model/Appearance.ts'), 'utf8');
|
||||
assert.match(ap, new RegExp(`bg_dim: number = ${s.dim}\\b`), `鸿蒙默认压暗要等于服务端 BgDim=${s.dim}`);
|
||||
assert.match(ap, new RegExp(`bg_blur: number = ${s.blur}\\b`), `鸿蒙默认模糊要等于服务端 BgBlur=${s.blur}`);
|
||||
assert.match(ap, new RegExp(`theme: string = '${s.theme}'`), `鸿蒙默认主题要等于服务端 Theme=${s.theme}`);
|
||||
const wp = readFileSync(join(ETS, 'model/Wallpaper.ts'), 'utf8');
|
||||
assert.match(wp, new RegExp(`'${s.preset}'`), `服务端默认预设 ${s.preset} 要在鸿蒙的预设清单里`);
|
||||
|
||||
// 服务端那句注释现在是**事实**(它宣称"与客户端默认值一致")—— 这条就是它的核对器
|
||||
const models = readFileSync(SERVER_MODELS, 'utf8');
|
||||
const comment = /\/\/ DefaultAppearance[\s\S]{0,200}?func DefaultAppearance/.exec(models);
|
||||
assert.ok(comment, 'DefaultAppearance 上面要有说明注释');
|
||||
assert.match(comment[0], /一致/, '注释仍在宣称"与客户端默认值一致"(本判据负责让它为真)');
|
||||
});
|
||||
|
||||
test('★ 缓存键按账号分:两端的键都带账号,且都不许退回全局键', () => {
|
||||
const store = readFileSync(join(ROOT, 'client/electron/src/stores/backgroundStore.ts'), 'utf8');
|
||||
// 键函数:必须把 accountId 拼进去(按块取函数体,不看调用点 —— "配对/解析"那条)
|
||||
const at = store.indexOf('export function storageKey(');
|
||||
assert.ok(at > 0, '要有 storageKey 函数');
|
||||
let depth = 0;
|
||||
let end = at;
|
||||
for (let i = store.indexOf('{', at); i < store.length; i++) {
|
||||
if (store[i] === '{') depth++;
|
||||
else if (store[i] === '}') { depth--; if (depth === 0) { end = i; break; } }
|
||||
}
|
||||
const body = store.slice(at, end + 1);
|
||||
assert.match(body, /STORAGE_KEY_PREFIX[\s\S]*accountId|accountId[\s\S]*STORAGE_KEY_PREFIX/,
|
||||
`取键函数必须把账号拼进键里(现在:${body.replace(/\s+/g, ' ')})`);
|
||||
/*
|
||||
* 不许写死键名:写入的键只能是 `storageKey()`,或由它算出来的变量(迁移时写 `key`)。
|
||||
* 我第一版写成"只允许字面量 setItem(storageKey(" —— 结果把迁移那次合法写入
|
||||
* (`setItem(key, legacy)`,key 就是按账号的键)也判红了;判据要钉**键的来源**,
|
||||
* 不是调用的字面形状。
|
||||
*/
|
||||
const badWrites = [...store.matchAll(/setItem\(([^,)]+)/g)]
|
||||
.map(m => m[1].trim())
|
||||
.filter(k => !/^storageKey\(/.test(k) && k !== 'key');
|
||||
assert.deepEqual(badWrites, [], `写入的键必须来自 storageKey()(现在这些不是:${badWrites.join('、')})`);
|
||||
assert.match(store, /removeItem\(LEGACY_STORAGE_KEY\)/, '旧全局键要被删除(否则下一个账号继续从它继承)');
|
||||
// 读/写都要走按账号的键(`key` 由 storageKey() 算出,见函数开头)
|
||||
assert.match(store, /const key = storageKey\(accountId\)/, '键要先按账号算出来');
|
||||
assert.match(store, /let raw = localStorage\.getItem\(key\)/, '读缓存要按账号的键');
|
||||
assert.match(store, /localStorage\.setItem\(storageKey\(\), JSON\.stringify\(state\)\)/, '写缓存要按账号的键');
|
||||
|
||||
// 鸿蒙侧:键同样带账号(两边形状一致,这条差异已经消除)
|
||||
const ets = readFileSync(join(ETS, 'common/AppearanceStore.ets'), 'utf8');
|
||||
const eAt = ets.indexOf('prefKey(accountId: string)');
|
||||
assert.ok(eAt > 0, '鸿蒙要有按账号取键的函数');
|
||||
let d2 = 0;
|
||||
let e2 = eAt;
|
||||
for (let i = ets.indexOf('{', eAt); i < ets.length; i++) {
|
||||
if (ets[i] === '{') d2++;
|
||||
else if (ets[i] === '}') { d2--; if (d2 === 0) { e2 = i; break; } }
|
||||
}
|
||||
assert.match(ets.slice(eAt, e2 + 1), /KEY_PREFIX\s*\+\s*accountId/, '鸿蒙的键也要拼账号');
|
||||
});
|
||||
|
||||
test('★ 切账号的顺序:**先按新账号重读本地**,再拉服务端', () => {
|
||||
/*
|
||||
* 服务端"没有记录"时 `pull()` 会"以本地为准推上去"——所以重读必须在前,
|
||||
* 否则推上去的是上一个账号的外观(全局键时代就是这个现象,而且写进了服务端)。
|
||||
*/
|
||||
const sync = readFileSync(join(ROOT, 'client/electron/src/stores/appearanceSync.ts'), 'utf8');
|
||||
const sub = /activeId !== prev\.activeId\)[\s\S]{0,400}?\}\);/.exec(sync);
|
||||
assert.ok(sub, '要能取到账号切换的处理块');
|
||||
const block = sub[0];
|
||||
const reloadAt = block.indexOf('reloadForAccount()');
|
||||
const pullAt = block.indexOf('.pull()');
|
||||
assert.ok(reloadAt > 0, `切换账号要先重读本账号的缓存:${block.replace(/\s+/g, ' ')}`);
|
||||
assert.ok(pullAt > 0, '切换账号仍然要拉服务端');
|
||||
assert.ok(reloadAt < pullAt, 'reloadForAccount() 必须在 pull() 之前(顺序就是这条判据的全部意义)');
|
||||
// 重读本身不许落盘(它只是把本账号已有的值读回来,不是用户的改动)
|
||||
const store = readFileSync(join(ROOT, 'client/electron/src/stores/backgroundStore.ts'), 'utf8');
|
||||
const rAt = store.indexOf('reloadForAccount: () => {');
|
||||
assert.ok(rAt > 0, 'store 要提供 reloadForAccount');
|
||||
const rBlock = store.slice(rAt, store.indexOf('}', store.indexOf('set(next)', rAt)));
|
||||
assert.ok(!/persist\(/.test(rBlock), '重读不许写盘');
|
||||
});
|
||||
Reference in New Issue
Block a user