Skip to content

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

:sparkles: Show loading indicators while initializing mindmaps

Daniel87dbc16a7b49
diff --git a/app/src/protyle/render/listMindmap/index.ts b/app/src/protyle/render/listMindmap/index.ts
index 7c4c3e99c4..bb98f6c332 100644
--- a/app/src/protyle/render/listMindmap/index.ts
+++ b/app/src/protyle/render/listMindmap/index.ts
@@ -637,10 +637,42 @@ export const initListMindmaps = (owner: IProtyle) => {
const root = owner.wysiwyg.element;
const instances = new Map<HTMLElement, ListMindmapController>();
const loading = new WeakSet<HTMLElement>();
+ const placeholders = new Map<HTMLElement, HTMLElement>();
+ const failed = new WeakSet<HTMLElement>();
const newlyCreated = new WeakSet<HTMLElement>();
let pendingFocus: {listID: string, candidateIDs: string[]};
let frame = 0;
let disposed = false;
+ const clearPlaceholder = (list: HTMLElement) => {
+ placeholders.get(list)?.remove();
+ placeholders.delete(list);
+ if (!instances.has(list)) {
+ list.removeAttribute("data-mindmap-view-rendered");
+ }
+ };
+ const prepare = () => {
+ const lists = new Set(getListMindmapElements(root));
+ placeholders.forEach((host, list) => {
+ if (!lists.has(list)) {
+ clearPlaceholder(list);
+ }
+ });
+ lists.forEach(list => {
+ if (instances.has(list) || failed.has(list) || placeholders.has(list)) {
+ return;
+ }
+ // 在浏览器绘制正文前占位,补齐源块期间沿用脑图的尺寸和公共加载动画。
+ const host = document.createElement("div");
+ host.className = "mindmap-view";
+ host.contentEditable = "false";
+ host.setAttribute("aria-busy", "true");
+ host.innerHTML = '<div class="fn__loading"><img width="64" src="/stage/loading-pure.svg" alt=""></div>';
+ syncListMindmapHeight(list, host);
+ placeholders.set(list, host);
+ list.appendChild(host);
+ list.dataset.mindmapViewRendered = "true";
+ });
+ };
const refresh = () => {
if (disposed) {
return;
@@ -655,13 +687,14 @@ export const initListMindmaps = (owner: IProtyle) => {
instance.refresh();
} catch (error) {
console.error(error);
+ failed.add(list);
instance.destroy();
instances.delete(list);
}
}
});
lists.forEach(list => {
- if (instances.has(list) || loading.has(list)) {
+ if (instances.has(list) || loading.has(list) || failed.has(list)) {
return;
}
const mount = () => {
@@ -672,12 +705,15 @@ export const initListMindmaps = (owner: IProtyle) => {
try {
const instance = new ListMindmapController(owner, list);
instances.set(list, instance);
+ placeholders.delete(list);
if (pendingFocus?.listID === list.dataset.nodeId) {
instance.focusNode(pendingFocus.candidateIDs);
pendingFocus = undefined;
}
} catch (error) {
console.error(error);
+ failed.add(list);
+ clearPlaceholder(list);
list.querySelector(":scope > .mindmap-view")?.remove();
list.removeAttribute("data-mindmap-view-rendered");
}
@@ -690,8 +726,15 @@ export const initListMindmaps = (owner: IProtyle) => {
mount();
} else if (complete === "changed") {
retry = true;
+ } else {
+ failed.add(list);
+ clearPlaceholder(list);
}
- }).catch(error => console.error(error)).finally(() => {
+ }).catch(error => {
+ console.error(error);
+ failed.add(list);
+ clearPlaceholder(list);
+ }).finally(() => {
loading.delete(list);
if (retry) {
schedule();
@@ -704,6 +747,9 @@ export const initListMindmaps = (owner: IProtyle) => {
});
};
const schedule = () => {
+ if (!disposed) {
+ prepare();
+ }
if (!frame && !disposed) {
frame = requestAnimationFrame(() => {
frame = 0;
@@ -748,6 +794,7 @@ export const initListMindmaps = (owner: IProtyle) => {
cancelAnimationFrame(frame);
instances.forEach(instance => instance.destroy());
instances.clear();
+ placeholders.forEach((host, list) => clearPlaceholder(list));
}});
schedule();
};
diff --git a/app/src/protyle/render/listMindmap/loading.test.ts b/app/src/protyle/render/listMindmap/loading.test.ts
new file mode 100644
index 0000000000..b7a3837b96
--- /dev/null
+++ b/app/src/protyle/render/listMindmap/loading.test.ts
@@ -0,0 +1,147 @@
+import * as assert from "node:assert/strict";
+import {execFile} from "node:child_process";
+import {mkdtempSync, readFileSync, rmSync, writeFileSync} from "node:fs";
+import {tmpdir} from "node:os";
+import * as path from "node:path";
+import {promisify} from "node:util";
+import test from "node:test";
+import {ScriptTarget, transpileModule} from "typescript";
+
+const browserCases = async (source: string, css: string) => {
+ const check = require("node:assert/strict");
+ const style = document.createElement("style");
+ style.textContent = css;
+ document.head.appendChild(style);
+ const roots = new WeakMap();
+ const frames = new Map<number, FrameRequestCallback>();
+ let sequence = 0;
+ let resolveLoad: (result: string) => void;
+ let requests = 0;
+ const errors: Error[] = [];
+ const dependencies = {
+ console: {error: (error: Error) => errors.push(error)},
+ roots,
+ Constants: {CUSTOM_SY_LIST_MINDMAP: "custom-sy-list-mindmap", ATTRIBUTE_EDITING: "data-editing"},
+ getListMindmapElements: (root: Element) => Array.from(root.querySelectorAll('[data-type="NodeMindmap"]')),
+ syncListMindmapHeight: (list: HTMLElement, host: HTMLElement) => {
+ host.style.setProperty("--mindmap-view-height", list.style.height);
+ },
+ canEdit: () => true,
+ completeList: () => {
+ requests++;
+ return new Promise<string>(resolve => { resolveLoad = resolve; });
+ },
+ registerListMindmapRoot: () => () => {},
+ requestAnimationFrame: (callback: FrameRequestCallback) => {
+ frames.set(++sequence, callback);
+ return sequence;
+ },
+ cancelAnimationFrame: (id: number) => frames.delete(id),
+ ListMindmapController: class {
+ constructor(owner: IProtyle, list: HTMLElement) {
+ list.querySelector(".mindmap-view")?.remove();
+ list.insertAdjacentHTML("beforeend", '<div class="mindmap-view">Rendered</div>');
+ }
+ refresh() {}
+ destroy() {}
+ },
+ };
+ const init = new Function(...Object.keys(dependencies), source + "; return initListMindmaps;")(...Object.values(dependencies));
+ const flush = async () => {
+ for (let i = 0; i < 8; i++) {
+ await Promise.resolve();
+ }
+ };
+ const frame = async () => {
+ const callbacks = Array.from(frames.values());
+ frames.clear();
+ callbacks.forEach(callback => callback(0));
+ await flush();
+ };
+ for (const result of ["complete", "failed", "changed", "destroy"]) {
+ const root = document.createElement("div");
+ root.className = "protyle-wysiwyg";
+ document.body.appendChild(root);
+ const owner = {wysiwyg: {element: root}};
+ init(owner);
+ root.innerHTML = '<div data-type="NodeTabs"><div data-type="NodeMindmap" data-node-id="map" style="height:320px">' +
+ '<div class="mindmap-item" data-type="NodeMindmapItem" data-node-id="item">Source text</div></div></div>';
+ await flush();
+ const list = root.querySelector<HTMLElement>('[data-type="NodeMindmap"]');
+ const item = list.firstElementChild;
+ check.equal(getComputedStyle(item).display, "none", "Source must be hidden before the first frame");
+ check.equal(list.querySelector(".mindmap-view").getBoundingClientRect().height, 320);
+ check.equal(list.querySelectorAll('[aria-busy="true"]').length, 1);
+ await frame();
+ const previousRequests = requests;
+ if (result === "destroy") {
+ roots.get(owner).destroy();
+ }
+ resolveLoad(result === "destroy" ? "complete" : result);
+ await flush();
+ if (result === "changed") {
+ check.equal(list.querySelectorAll('[aria-busy="true"]').length, 1);
+ await frame();
+ resolveLoad("complete");
+ await flush();
+ }
+ if (result === "failed" || result === "destroy") {
+ check.notEqual(getComputedStyle(item).display, "none");
+ check.equal(list.querySelector(".mindmap-view"), null);
+ await frame();
+ check.equal(requests, previousRequests, "Failure must not cause a request loop");
+ } else {
+ check.ok(list.querySelector(".mindmap-view"), `${result}: ${list.outerHTML}`);
+ check.equal(list.querySelector(".mindmap-view").textContent, "Rendered");
+ check.equal(list.querySelector('[aria-busy="true"]'), null);
+ check.equal(getComputedStyle(item).display, "none");
+ }
+ roots.get(owner).destroy();
+ root.remove();
+ }
+ check.deepEqual(errors, []);
+ return "Mindmap loading cases passed";
+};
+
+test("mindmap loading hides source before paint and recovers after failure or disposal", {
+ skip: process.platform === "linux" && !process.env.DISPLAY && !process.env.WAYLAND_DISPLAY,
+ timeout: 30000,
+}, async () => {
+ const text = readFileSync(path.join(__dirname, "index.ts"), "utf8");
+ const source = transpileModule(text.slice(text.indexOf("export const initListMindmaps ="),
+ text.indexOf("export const destroyListMindmaps =")).replace(/^export /gm, ""), {
+ compilerOptions: {target: ScriptTarget.ES2021},
+ }).outputText;
+ const css = require("sass").compile(path.resolve(__dirname, "../../../assets/scss/base.scss"), {
+ logger: require("sass").Logger.silent,
+ }).css;
+ const temporary = mkdtempSync(path.join(tmpdir(), "siyuan-mindmap-loading-"));
+ const script = path.join(temporary, "run.cjs");
+ writeFileSync(script, `const {app, BrowserWindow} = require("electron");
+app.setPath("userData", ${JSON.stringify(path.join(temporary, "profile"))});
+app.commandLine.appendSwitch("disable-gpu");
+app.whenReady().then(async () => {
+ const win = new BrowserWindow({show: false, webPreferences: {nodeIntegration: true, contextIsolation: false}});
+ try {
+ await win.loadURL("data:text/html,<html><body></body></html>");
+ console.log(await win.webContents.executeJavaScript(${JSON.stringify(
+ `const __name = value => value; (${browserCases.toString()})(${JSON.stringify(source)}, ${JSON.stringify(css)})`)}));
+ win.destroy();
+ app.exit(0);
+ } catch (error) {
+ console.error(error);
+ win.destroy();
+ app.exit(1);
+ }
+});`, "utf8");
+ const env = {...process.env};
+ delete env.ELECTRON_RUN_AS_NODE;
+ try {
+ const result = await promisify(execFile)(require("electron") as unknown as string, [script], {
+ env, timeout: 25000, windowsHide: true,
+ });
+ assert.match(result.stdout, /Mindmap loading cases passed/);
+ } finally {
+ rmSync(temporary, {recursive: true, force: true});
+ }
+});