接手 pi 的 WebUI 开项途中踩到三个坑,都已修好并配判据(承接 e94313f)。 ## 坑 1:`npm run build 2>&1 | tail -4 && electron-builder …` 吞掉构建失败 pipeline 的退出码是 `tail` 的 → 构建失败、`&&` 照样往下走、electron-builder **拿旧的 dist 打了新包**。而所有判据都是绿的: - vitest 绿(见坑 2);packaging 绿(它比 dist vs 安装包,两边都是旧的,自然一致)。 新增判据:**dist 必须比 src 新**(build-stamp)。变异:`touch` 一个 src 文件 → 红; 重新 `npm run build` → 绿。错误信息写明"注意别把它的退出码丢在管道里"。 已重构建 + 重打包(deb 与 app.asar 同批,15:19)。 ## 坑 2:测试通过 ≠ 能打包 真正的失败:`AGGREGATE_ID` / `isUsableAccount` 被我当成 `accountStore` 的导出 (它们住在 `lib/accounts.ts`)。vitest 263 条全绿,生产构建直接报 `"AGGREGATE_ID" is not exported by "src/stores/accountStore.ts"` —— 测试运行时对缺的具名导出是宽容的(拿到 undefined)。**生产构建是一道独立的门。** ## 坑 3:判据写成"窗口式",被自己的变异测试抓住两次 `appearance-defaults` 的"取键函数必须把账号拼进去": 1. 第一版从 `export function` 切到 `}` → **参数表里的 accountId 满足了正则**, 把实现退回全局键仍然全绿(假判据!); 2. 第二版只取函数体 → `return accountId ? PREFIX : PREFIX;`(提了一下没用)又骗过去; 3. 第三版要求**同一个表达式里既有常量又有账号的插值/拼接**: 两种退化都红,合法的 `PREFIX + accountId` 写法仍然绿。 三种变异都验过(红/红/绿),还原后基线绿。 ## 文档 §7.12 两行改为「已修」并写明依据(默认值=服务端契约;缓存键差异已消除,旧全局键 只作一次性迁移源);新增 §7.20 记这三个坑与推论(产物是 gitignore 的, "源码修好"≠"用户手上那个包修好")。 ## 验证 `npm test` 退出码 0(13 个判据文件全绿 + vitest 263 passed); `hvigorw assembleHap` BUILD SUCCESSFUL;`npm run build` + electron-builder 均 exit 0。
179 lines
11 KiB
JavaScript
179 lines
11 KiB
JavaScript
// 外观的**服务端契约**与**本机缓存的键**:两个客户端的默认值必须等于服务端那三个数,
|
||
// 缓存键必须按账号分。
|
||
//
|
||
// 为什么值得单独一个判据文件:
|
||
// 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 函数');
|
||
/*
|
||
* ⚠️ 只取**函数体**(第一个 `{` 到配对的 `}`),不能把签名一起算进来 ——
|
||
* 我第一版就是从 `export function` 开始切、然后在整段里找 `accountId … STORAGE_KEY_PREFIX`,
|
||
* 结果**变异测试抓出了这个判据是假的**:把实现改成 `return STORAGE_KEY_PREFIX;`(退回全局键)
|
||
* 时它依然绿,因为参数表里的 `accountId` 已经满足了那个正则。
|
||
* 这正是本仓规范第 1 条(判结构要配对/解析,不要靠邻接与窗口)—— 我写规范时没想到
|
||
* 它的适用对象也包括"这个函数自己有没有把账号拼进去"。
|
||
*/
|
||
const bodyStart = store.indexOf('{', at);
|
||
let depth = 0;
|
||
let end = at;
|
||
for (let i = bodyStart; i < store.length; i++) {
|
||
if (store[i] === '{') depth++;
|
||
else if (store[i] === '}') { depth--; if (depth === 0) { end = i; break; } }
|
||
}
|
||
const body = store.slice(bodyStart + 1, end);
|
||
/*
|
||
* 仍然不能用"两个词离得近"来判:第二次变异(`return accountId ? STORAGE_KEY_PREFIX : STORAGE_KEY_PREFIX;`
|
||
* ——提了一下 accountId 但根本没用它)又把松正则骗过去了。
|
||
* 要求**同一个表达式里**既出现常量又插值/拼接账号:模板字面量 `` `a${b}` `` 或 `a + b`。
|
||
* 这样"提到"与"用上"就分开了。
|
||
*/
|
||
const exprs = [
|
||
...[...body.matchAll(/`[^`]*`/g)].map(m => m[0]),
|
||
...[...body.matchAll(/[^;\n{}]*\+[^;\n{}]*/g)].map(m => m[0])
|
||
];
|
||
const joins = exprs.filter(e => e.includes('STORAGE_KEY_PREFIX') && e.includes('accountId'));
|
||
assert.ok(joins.length > 0,
|
||
`取键的函数体里必须**真的**把账号拼进键(模板插值或 + 拼接)。现在函数体是:${body.replace(/\s+/g, ' ').trim()}`);
|
||
/*
|
||
* 行为面由 vitest 兜底(`test/stores/background.test.ts` 直接断言
|
||
* storageKey('acct-a') === 'agentmail.background.acct-a' 且两个账号不相等)——
|
||
* 静态判据只负责"形状",值对不对由真跑一遍的函数说了算。
|
||
*/
|
||
/*
|
||
* 不许写死键名:写入的键只能是 `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), '重读不许写盘');
|
||
});
|