Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Preserve affected frontend test coverage https://github.com/siyuan-note/siyuan/pull/21030

Danieleaa026794d1b
diff --git a/app/scripts/test-changed.mjs b/app/scripts/test-changed.mjs
index 54c0fa1226..e17ecbda5c 100644
--- a/app/scripts/test-changed.mjs
+++ b/app/scripts/test-changed.mjs
@@ -27,19 +27,22 @@ export const scanReferences = (text) => {
for (const match of text.matchAll(/(?:from|require\s*\(|import\s*\()\s*["']([^"'\n]+)["']/g)) {
references.add(match[1]);
}
- for (const match of text.matchAll(/["']((?:\.\.?\/)?(?:src|tests|electron|scripts)\/[^"'\n]+?\.(?:ts|js|mjs|scss|tpl))["']/g)) {
+ for (const match of text.matchAll(/["']((?:(?:\.\.?\/)+)?[^"'\n:*?<>|]+?\.(?:ts|js|mjs|scss|tpl))["']/g)) {
references.add(match[1]);
}
return [...references];
};
// 把说明符或路径字面量解析成 app 内的绝对路径;外部模块返回 undefined。
-export const resolveReference = (fromFile, reference, root = appRoot) => {
+export const resolveReference = (fromFile, reference, root = appRoot, knownFiles = new Set()) => {
let base;
if (reference.startsWith(".")) {
base = path.resolve(path.dirname(fromFile), reference);
} else if (/^(?:src|tests|electron|scripts)\//.test(reference)) {
base = path.resolve(root, reference);
+ } else if (moduleExtensions.some(extension => reference.endsWith(extension)) && !reference.includes("/")) {
+ // path.join(__dirname, "source.ts") 以测试所在目录为基准。
+ base = path.resolve(path.dirname(fromFile), reference);
} else {
return undefined;
}
@@ -51,11 +54,12 @@ export const resolveReference = (fromFile, reference, root = appRoot) => {
if (base.endsWith(".js")) {
candidates.push(base.replace(/\.js$/, ".ts"));
}
- return candidates.find(candidate => existsSync(candidate) && statSync(candidate).isFile());
+ return candidates.find(candidate => knownFiles.has(candidate) ||
+ (existsSync(candidate) && statSync(candidate).isFile()));
};
// 收集 file -> 它直接引用的文件的依赖边。
-export const buildGraph = (files, root = appRoot) => {
+export const buildGraph = (files, root = appRoot, knownFiles = new Set(files)) => {
const edges = new Map();
for (const file of files) {
let text;
@@ -66,7 +70,7 @@ export const buildGraph = (files, root = appRoot) => {
}
const targets = new Set();
for (const reference of scanReferences(text)) {
- const resolved = resolveReference(file, reference, root);
+ const resolved = resolveReference(file, reference, root, knownFiles);
if (resolved && resolved !== file) {
targets.add(resolved);
}
@@ -78,16 +82,23 @@ export const buildGraph = (files, root = appRoot) => {
// 从改动文件出发反向遍历,找出直接或间接引用它们的测试文件。
export const selectTests = (changedFiles, allFiles, root = appRoot) => {
+ const changed = new Set(changedFiles.map(file => path.resolve(file)));
+ // 依赖与转译配置影响所有测试,不能仅靠源码引用图推导。
+ if ([...changed].some(file => path.dirname(file) === root &&
+ (/^tsconfig(?:\..+)?\.json$/.test(path.basename(file)) ||
+ ["package.json", "pnpm-lock.yaml"].includes(path.basename(file))))) {
+ return allFiles.filter(isTestFile).sort();
+ }
const reverse = new Map();
- for (const [file, targets] of buildGraph(allFiles, root)) {
+ // 删除的源文件也保留依赖边,避免删除操作被误报为没有受影响的测试。
+ for (const [file, targets] of buildGraph(allFiles, root, new Set([...allFiles, ...changed]))) {
for (const target of targets) {
const list = reverse.get(target) ?? [];
list.push(file);
reverse.set(target, list);
}
}
- const changed = new Set(changedFiles.map(file => path.resolve(file)));
- const selected = new Set([...changed].filter(isTestFile));
+ const selected = new Set([...changed].filter(file => isTestFile(file) && existsSync(file)));
const visited = new Set(changed);
const queue = [...changed];
while (queue.length > 0) {
@@ -113,14 +124,14 @@ export const listFiles = () => testRoots
const repositoryRoot = path.resolve(appRoot, "..");
-const changedFiles = (base) => {
+export const changedFiles = (base, root = repositoryRoot) => {
// `git diff --name-only <base>` 覆盖已提交的分支改动,未跟踪文件需单独收集。
- const run = (arguments_) => execFileSync("git", arguments_, {cwd: repositoryRoot, encoding: "utf8"});
+ const run = (arguments_) => execFileSync("git", arguments_, {cwd: root, encoding: "utf8"});
const files = [
- ...run(["diff", "--name-only", base]).split("\n"),
- ...run(["ls-files", "--others", "--exclude-standard"]).split("\n"),
+ ...run(["diff", "--name-only", "--no-renames", "-z", base, "--"]).split("\0"),
+ ...run(["ls-files", "--others", "--exclude-standard", "-z"]).split("\0"),
].filter(Boolean);
- return files.map(file => path.resolve(repositoryRoot, file)).filter(file => existsSync(file));
+ return files.map(file => path.resolve(root, file));
};
const main = () => {
@@ -128,7 +139,7 @@ const main = () => {
const baseIndex = arguments_.indexOf("--base");
const base = baseIndex >= 0 ? arguments_[baseIndex + 1] : "HEAD";
const touched = changedFiles(base).filter(file =>
- testRoots.some(root => file.startsWith(path.join(appRoot, root) + path.sep)));
+ file.startsWith(appRoot + path.sep));
if (touched.length === 0) {
console.log("src/tests/electron/scripts 没有改动");
return 0;
diff --git a/app/scripts/test-changed.test.js b/app/scripts/test-changed.test.js
index 9241353dab..a7942be55c 100644
--- a/app/scripts/test-changed.test.js
+++ b/app/scripts/test-changed.test.js
@@ -3,7 +3,8 @@ const fs = require("node:fs");
const os = require("node:os");
const path = require("node:path");
const {test} = require("node:test");
-const {selectTests, scanReferences} = require("./test-changed.mjs");
+const {execFileSync} = require("node:child_process");
+const {selectTests, scanReferences, changedFiles} = require("./test-changed.mjs");
const fixture = t => {
const root = fs.mkdtempSync(path.join(os.tmpdir(), "siyuan-test-changed-"));
@@ -55,3 +56,61 @@ test("an undetectable dependency reports no tests instead of guessing", t => {
const testFile = write("src/source.test.ts", "// 只由运行期字符串拼接决定加载目标\nconst name = \"source\";");
assert.deepEqual(selectTests([source], [source, testFile], root), []);
});
+
+test("relative and sibling source literals select their loading tests", t => {
+ const {root, write} = fixture(t);
+ const source = write("src/source.ts", "export const value = 1;");
+ const parentLoader = write("src/nested/parent.test.ts",
+ 'readFileSync(path.join(__dirname, "../source.ts"), "utf8");');
+ const siblingLoader = write("src/sibling.test.ts",
+ 'readFileSync(path.join(__dirname, "source.ts"), "utf8");');
+ assert.deepEqual(selectTests([source], [source, parentLoader, siblingLoader], root),
+ [parentLoader, siblingLoader].sort());
+});
+
+test("deleted sources still select importers without trying to run deleted tests", t => {
+ const {root, write} = fixture(t);
+ const removed = write("src/source.ts", "export const value = 1;");
+ const imported = write("src/imported.test.ts", 'import {value} from "./source";');
+ const loaded = write("src/loaded.test.ts", 'load("src/source.ts");');
+ const deletedTest = write("src/deleted.test.ts", "");
+ fs.unlinkSync(removed);
+ fs.unlinkSync(deletedTest);
+ assert.deepEqual(selectTests([removed, deletedTest], [imported, loaded], root), [imported, loaded].sort());
+});
+
+test("git paths preserve Unicode, whitespace and deleted entries", t => {
+ const {root, write} = fixture(t);
+ const run = (...args) => execFileSync("git", args, {cwd: root});
+ const source = write("src/路径 with spaces.ts", "export const value = 1;");
+ run("init", "--quiet");
+ run("add", ".");
+ const tree = run("write-tree").toString("utf8").trim();
+ fs.unlinkSync(source);
+ const added = write("src/新增.ts", "export {};");
+ assert.deepEqual(changedFiles(tree, root).sort(), [source, added].sort());
+});
+
+test("renames keep the old path so stale importers are selected", t => {
+ const {root, write} = fixture(t);
+ const run = (...args) => execFileSync("git", args, {cwd: root});
+ const source = write("src/source.ts", "export const value = 1;");
+ const importer = write("src/source.test.ts", 'import {value} from "./source";');
+ run("init", "--quiet");
+ run("add", ".");
+ const tree = run("write-tree").toString("utf8").trim();
+ run("mv", "src/source.ts", "src/moved.ts");
+ const touched = changedFiles(tree, root);
+ assert.ok(touched.includes(source));
+ assert.deepEqual(selectTests(touched, [importer, path.join(root, "src/moved.ts")], root), [importer]);
+});
+
+test("dependency and transpiler configuration changes select the whole suite", t => {
+ const {root, write} = fixture(t);
+ const first = write("src/first.test.ts", "");
+ const second = write("tests/second.test.js", "");
+ const source = write("src/unrelated.ts", "export {};");
+ for (const name of ["package.json", "pnpm-lock.yaml", "tsconfig.json", "tsconfig.typecheck.json"]) {
+ assert.deepEqual(selectTests([path.join(root, name)], [first, second, source], root), [first, second].sort());
+ }
+});
diff --git a/app/src/config/tabs/compactMode.test.ts b/app/src/config/tabs/compactMode.test.ts
index eef8a47969..433b009826 100644
--- a/app/src/config/tabs/compactMode.test.ts
+++ b/app/src/config/tabs/compactMode.test.ts
@@ -6,7 +6,8 @@ import {ModuleKind, transpileModule} from "typescript";
const fixture = (frontend = "desktop", nativeBridge = {}) => {
const appearance = {compactMode: false};
- const siyuan = {config: {appearance, readonly: false}, isPublish: false, isReady: true};
+ const siyuan = {config: {appearance, readonly: false}, isPublish: false, isReady: true,
+ storage: {"local-compact-mode": true, "local-menu-mouse-scroll": true}};
const attributes = new Map<string, string>();
const input = {checked: false};
const saved: unknown[][] = [];
@@ -30,6 +31,18 @@ const fixture = (frontend = "desktop", nativeBridge = {}) => {
setFrontend: (value: string) => {frontend = value;}};
};
+test("compactMode ignores retired KV values and reads confirmed configuration updates", () => {
+ const f = fixture();
+ f.api.applyCompactMode();
+ assert.equal(f.input.checked, false);
+ f.appearance.compactMode = true;
+ f.api.applyCompactMode();
+ assert.equal(f.input.checked, true);
+ f.appearance.compactMode = false;
+ f.api.applyCompactMode();
+ assert.equal(f.input.checked, false);
+});
+
test("compactMode saves through the appearance namespace without optimistic config mutation", async () => {
const f = fixture();
await f.api.setCompactModeEnabled(true);
diff --git a/app/src/config/tabs/menuMouseScroll.test.ts b/app/src/config/tabs/menuMouseScroll.test.ts
index 7cb2f2f2db..70d956e7c3 100644
--- a/app/src/config/tabs/menuMouseScroll.test.ts
+++ b/app/src/config/tabs/menuMouseScroll.test.ts
@@ -6,7 +6,8 @@ import {ModuleKind, transpileModule} from "typescript";
const fixture = (frontend = "desktop", mobileApp = false) => {
const appearance = {menuMouseScroll: false};
- const siyuan = {config: {appearance, readonly: false}, isPublish: false, isReady: true};
+ const siyuan = {config: {appearance, readonly: false}, isPublish: false, isReady: true,
+ storage: {"local-compact-mode": true, "local-menu-mouse-scroll": true}};
const attributes = new Map<string, string>();
const input = {checked: false};
const saved: unknown[][] = [];
@@ -29,6 +30,18 @@ const fixture = (frontend = "desktop", mobileApp = false) => {
return {api: exports, appearance, siyuan, saved, events, input, attributes};
};
+test("menuMouseScroll ignores retired KV values and reads confirmed configuration updates", () => {
+ const f = fixture();
+ f.api.syncMenuMouseScroll();
+ assert.equal(f.input.checked, false);
+ f.appearance.menuMouseScroll = true;
+ f.api.syncMenuMouseScroll();
+ assert.equal(f.input.checked, true);
+ f.appearance.menuMouseScroll = false;
+ f.api.syncMenuMouseScroll();
+ assert.equal(f.input.checked, false);
+});
+
test("menuMouseScroll saves through the appearance namespace without optimistic config mutation", async () => {
const f = fixture();
await f.api.setMenuMouseScrollEnabled(true);
diff --git a/app/src/editor/pdfAssetLink.test.ts b/app/src/editor/pdfAssetLink.test.ts
index e74b34c146..8e474eaeee 100644
--- a/app/src/editor/pdfAssetLink.test.ts
+++ b/app/src/editor/pdfAssetLink.test.ts
@@ -24,6 +24,20 @@ describe("PDF asset link resolution", () => {
});
});
+ it("preserves non-page parameters when page is first", () => {
+ assert.deepEqual(resolvePdfAssetLink("assets/document.pdf?page=3&box=20240101000000-abcdefg&dataPath=%2Fdocs%2Fnote.sy"), {
+ linkAddress: "assets/document.pdf?box=20240101000000-abcdefg&dataPath=%2Fdocs%2Fnote.sy",
+ pdfParams: 3,
+ });
+ });
+
+ it("preserves non-page parameters when page is last", () => {
+ assert.deepEqual(resolvePdfAssetLink("assets/document.pdf?box=20240101000000-abcdefg&dataPath=%2Fdocs%2Fnote.sy&page=4"), {
+ linkAddress: "assets/document.pdf?box=20240101000000-abcdefg&dataPath=%2Fdocs%2Fnote.sy",
+ pdfParams: 4,
+ });
+ });
+
it("preserves non-page parameters when page is in the middle", () => {
assert.deepEqual(resolvePdfAssetLink("assets/document.pdf?box=20240101000000-abcdefg&page=5&dataPath=%2Fdocs%2Fnote.sy"), {
linkAddress: "assets/document.pdf?box=20240101000000-abcdefg&dataPath=%2Fdocs%2Fnote.sy",
diff --git a/app/src/protyle/render/mathRenderSecurity.test.ts b/app/src/protyle/render/mathRenderSecurity.test.ts
index 6e4dfac50d..17fe34d65b 100644
--- a/app/src/protyle/render/mathRenderSecurity.test.ts
+++ b/app/src/protyle/render/mathRenderSecurity.test.ts
@@ -36,6 +36,12 @@ describe("math render security", () => {
}), /Invalid attribute name/);
});
+ it("enforces expansion limits inside expanded macro definitions", () => {
+ assert.throws(() => katex.renderToString("\\def\\a{xxxxxxxxxx}\\edef\\b{\\a\\a\\a\\a}", {
+ maxExpand: 20,
+ }), /Too many expansions/);
+ });
+
it("always disables trusted KaTeX commands for safe fragments", () => {
assert.deepEqual(getMathRenderSecurity(false, true), {trust: false, sanitize: true});
assert.deepEqual(getMathRenderSecurity(true, true), {trust: false, sanitize: true});
diff --git a/app/src/protyle/util/storageStartup.test.ts b/app/src/protyle/util/storageStartup.test.ts
index 115dad71b8..4182f3e606 100644
--- a/app/src/protyle/util/storageStartup.test.ts
+++ b/app/src/protyle/util/storageStartup.test.ts
@@ -53,6 +53,13 @@ const loadZoom = (value: unknown) => {
return zoom;
};
+test("reader and control preferences no longer create defaults in local storage", () => {
+ const storage = loadStorage({});
+ for (const key of ["local-mobile-bars", "local-outline", "local-pdftheme", "local-recent-docs"]) {
+ assert.equal(Object.prototype.hasOwnProperty.call(storage, key), false, key);
+ }
+});
+
test("startup storage uses the current mobile bottom bar default without sharing mutable slots", () => {
const first = loadStorage({})[Constants.LOCAL_MOBILE_BOTTOM_BAR];
const second = loadStorage({})[Constants.LOCAL_MOBILE_BOTTOM_BAR];