Skip to content

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

:zap: Improve desktop settings window opening performance https://github.com/siyuan-note/siyuan/issues/20029

Danielfb934eec79a3
diff --git a/app/src/config/assets.test.ts b/app/src/config/assets.test.ts
new file mode 100644
index 0000000000..dd99acd6a3
--- /dev/null
+++ b/app/src/config/assets.test.ts
@@ -0,0 +1,87 @@
+import * as assert from "node:assert/strict";
+import {readFileSync} from "node:fs";
+import {test} from "node:test";
+import {runInNewContext} from "node:vm";
+import {ModuleKind, ScriptTarget, transpileModule} from "typescript";
+
+const createAssets = () => {
+ const code = transpileModule(readFileSync("src/config/assets.ts", "utf8"), {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+ }).outputText;
+ let complete: () => void;
+ let fail: (error: Error) => void;
+ let loading = new Promise<void>((resolve, reject) => { complete = resolve; fail = reject; });
+ let mounted = 0;
+ let errors = 0;
+ const searched: string[] = [];
+ const context = {
+ exports: {} as {
+ mountAssetsTab: (root: any, keywords: string, app: any) => Promise<void>;
+ unmountAssetsTab: (root: any) => void;
+ assets: {genHTML: () => string; bindEvent: () => void};
+ },
+ Lute: undefined as unknown,
+ console: {error: () => {}},
+ window: {siyuan: {languages: {_kernel: {258: "Operation failed"}}}},
+ require: (name: string) => {
+ if (name === "../protyle/util/lute") return {ensureLute: () => loading};
+ if (name === "../dialog/message") return {showMessage: () => errors++};
+ if (name === "./setting/mount") return {switchSettingPanelSubTab: (_root: any, keywords: string) => searched.push(keywords)};
+ if (name === "./ocr") return {ocrSearchStrings: (): string[] => []};
+ return {};
+ },
+ };
+ runInNewContext(code + "\nexports.assets = assets;", context);
+ context.exports.assets.genHTML = () => "preview";
+ context.exports.assets.bindEvent = () => mounted++;
+ return {
+ api: context.exports, mounted: () => mounted, errors: () => errors, searched,
+ complete: () => { context.Lute = {}; complete(); }, fail: () => fail(new Error("network")),
+ retry: () => loading = new Promise<void>((resolve, reject) => { complete = resolve; fail = reject; }),
+ };
+};
+
+test("assets preview waits for Lute and repeated mounts use the latest search", async () => {
+ const assets = createAssets();
+ const root = {innerHTML: "", isConnected: true};
+ const first = assets.api.mountAssetsTab(root, "old", {});
+ const second = assets.api.mountAssetsTab(root, "new", {});
+ assert.equal(assets.mounted(), 0);
+ assert.equal(root.innerHTML, "");
+ assets.complete();
+ await Promise.all([first, second]);
+ assert.equal(assets.mounted(), 1);
+ assert.deepEqual(assets.searched, ["new"]);
+});
+
+test("closing or replacing an assets panel while Lute loads cancels its preview", async () => {
+ for (const action of ["unmount", "detach", "replace"]) {
+ const assets = createAssets();
+ const root = {innerHTML: "", isConnected: true};
+ const pending = assets.api.mountAssetsTab(root, "", {});
+ let replacement: Promise<void>;
+ if (action === "unmount") assets.api.unmountAssetsTab(root);
+ if (action === "detach") root.isConnected = false;
+ if (action === "replace") replacement = assets.api.mountAssetsTab({innerHTML: "", isConnected: true}, "", {});
+ assets.complete();
+ await Promise.all([pending, replacement]);
+ assert.equal(root.innerHTML, "");
+ assert.equal(assets.mounted(), action === "replace" ? 1 : 0);
+ }
+});
+
+test("a failed assets dependency reports an error and permits another mount", async () => {
+ const assets = createAssets();
+ const root = {innerHTML: "", isConnected: true};
+ const pending = assets.api.mountAssetsTab(root, "", {});
+ assets.fail();
+ await pending;
+ assert.equal(assets.errors(), 1);
+ assert.equal(assets.mounted(), 0);
+ assert.equal(root.innerHTML, "");
+ assets.retry();
+ const retried = assets.api.mountAssetsTab(root, "", {});
+ assets.complete();
+ await retried;
+ assert.equal(assets.mounted(), 1);
+});
diff --git a/app/src/config/assets.ts b/app/src/config/assets.ts
index 5e8d9db99e..9262ad0f26 100644
--- a/app/src/config/assets.ts
+++ b/app/src/config/assets.ts
@@ -14,6 +14,7 @@ import {writeText} from "../protyle/util/compatibility";
import {Constants} from "../constants";
import {showMessage} from "../dialog/message";
import {Protyle} from "../protyle";
+import {ensureLute} from "../protyle/util/lute";
import type {App} from "../index";
import {disabledProtyle, onGet} from "../protyle/util/onGet";
import {removeLoading} from "../protyle/ui/initUI";
@@ -35,19 +36,38 @@ export const collectAssetsTabSearchStrings = (): string[] => [
...ocrSearchStrings(),
];
+const pendingAssetsMounts = new WeakMap<Element, object>();
+
/** 资源 Tab 挂载(面板页,不走注册表渲染) */
-export const mountAssetsTab = (root: HTMLElement, keywords?: string, app?: App) => {
+export const mountAssetsTab = async (root: HTMLElement, keywords?: string, app?: App) => {
if (assets.element && assets.element !== root) {
unmountAssetsTab(assets.element);
}
+ assets.element = root;
+ if (!root.innerHTML && app && typeof Lute === "undefined") {
+ const pending = {};
+ pendingAssetsMounts.set(root, pending);
+ try {
+ await ensureLute();
+ } catch (error) {
+ if (pendingAssetsMounts.get(root) === pending && root.isConnected) {
+ pendingAssetsMounts.delete(root);
+ console.error("Could not initialize assets settings", error);
+ showMessage(window.siyuan.languages._kernel["258"], 6000, "error");
+ }
+ return;
+ }
+ // 等待引擎期间关闭面板或再次挂载时,只保留最新的挂载请求。
+ if (pendingAssetsMounts.get(root) !== pending || assets.element !== root || !root.isConnected) {
+ return;
+ }
+ pendingAssetsMounts.delete(root);
+ }
if (root.innerHTML === "") {
- assets.element = root;
root.innerHTML = assets.genHTML();
if (app) {
assets.bindEvent(app);
}
- } else {
- assets.element = root;
}
if (keywords) {
switchSettingPanelSubTab(root, keywords, [
@@ -61,6 +81,7 @@ export const mountAssetsTab = (root: HTMLElement, keywords?: string, app?: App)
/** 释放资源 Tab 内嵌编辑器及根节点引用 */
export const unmountAssetsTab = (root: Element) => {
+ pendingAssetsMounts.delete(root);
if (assets.element !== root) {
return;
}
diff --git a/app/src/config/render/render.test.ts b/app/src/config/render/render.test.ts
index 052d488f3c..95004e39ff 100644
--- a/app/src/config/render/render.test.ts
+++ b/app/src/config/render/render.test.ts
@@ -21,9 +21,7 @@ describe("genNumberInputHtml", () => {
describe("genStackHtml", () => {
it("disables spell checking for technical fields while preserving the editor preference for prose", () => {
- if (typeof Lute === "undefined") {
- require("../../../stage/protyle/js/lute/lute.min.js");
- }
+ assert.equal(typeof Lute, "undefined");
const originalWindow = Object.getOwnPropertyDescriptor(globalThis, "window");
try {
for (const enabled of [true, false]) {
@@ -53,9 +51,7 @@ describe("genStackHtml", () => {
});
it("escapes textarea closing tags and literal character references", () => {
- if (typeof Lute === "undefined") {
- require("../../../stage/protyle/js/lute/lute.min.js");
- }
+ assert.equal(typeof Lute, "undefined");
const originalWindow = Object.getOwnPropertyDescriptor(globalThis, "window");
Object.defineProperty(globalThis, "window", {
configurable: true,
diff --git a/app/src/config/render/render.ts b/app/src/config/render/render.ts
index 8ce0f12506..74ca9deaae 100644
--- a/app/src/config/render/render.ts
+++ b/app/src/config/render/render.ts
@@ -9,7 +9,7 @@ import {
type StackRight,
type SwitchQueryItem
} from "./parts";
-import {escapeAttr} from "../../util/escape";
+import {escapeHTMLStr, escapeAttr} from "../../util/escape";
import {buildRangeValues} from "../setting/domIO";
import {genConfigItemMainHtml, genConfigItemName, genSwitchRow} from "./fragments";
@@ -69,15 +69,15 @@ const genTextBlockFieldHtml = (
spellcheck = window.siyuan.config.editor.spellcheck,
): string => {
if (mode === "textarea") {
- return `<textarea class="b3-text-field fn__block" id="${id}" spellcheck="${spellcheck}">${Lute.EscapeHTMLStr(value)}</textarea>`;
+ return `<textarea class="b3-text-field fn__block" id="${id}" spellcheck="${spellcheck}">${escapeHTMLStr(value)}</textarea>`;
}
if (mode === "input-password") {
return `<div class="b3-form__icona fn__block">
- <input id="${id}" type="password" spellcheck="false" class="b3-text-field b3-form__icona-input" value="${Lute.EscapeHTMLStr(value)}">
+ <input id="${id}" type="password" spellcheck="false" class="b3-text-field b3-form__icona-input" value="${escapeHTMLStr(value)}">
<svg class="b3-form__icona-icon" data-action="togglePassword" style="user-select: none;"><use xlink:href="#iconEye"></use></svg>
</div>`;
}
- return `<input class="b3-text-field fn__block" id="${id}" type="text" spellcheck="${spellcheck}" value="${Lute.EscapeHTMLStr(value)}"/>`;
+ return `<input class="b3-text-field fn__block" id="${id}" type="text" spellcheck="${spellcheck}" value="${escapeHTMLStr(value)}"/>`;
};
const genSwitchQueryItemHtml = (item: SwitchQueryItem): string => {
@@ -133,9 +133,9 @@ export const genTextPairHtml = (
`<div class="fn__flex b3-label config-item">
${genConfigItemMainHtml(title, desc)}
<span class="fn__space"></span>
- <input class="b3-text-field fn__flex-center fn__size96" id="${left.id}" value="${Lute.EscapeHTMLStr(left.readConfig() as string)}">
+ <input class="b3-text-field fn__flex-center fn__size96" id="${left.id}" value="${escapeHTMLStr(left.readConfig() as string)}">
<span class="fn__space"></span>
- <input class="b3-text-field fn__flex-center fn__size96" id="${right.id}" value="${Lute.EscapeHTMLStr(right.readConfig() as string)}">
+ <input class="b3-text-field fn__flex-center fn__size96" id="${right.id}" value="${escapeHTMLStr(right.readConfig() as string)}">
</div>`;
const genStackRight = (r: StackRight): string => {
@@ -230,7 +230,7 @@ const renderControlParts = (parts: RowPart[]): string => {
return `<div class="fn__flex b3-label config-item">
${genConfigItemMainHtml(title, desc ?? "")}
<span class="fn__space"></span>
- <input class="b3-text-field fn__flex-center fn__size200" id="${control.id}"${control.spellcheck === undefined ? "" : ` spellcheck="${control.spellcheck}"`} value="${Lute.EscapeHTMLStr(control.readConfig() as string)}"/>
+ <input class="b3-text-field fn__flex-center fn__size200" id="${control.id}"${control.spellcheck === undefined ? "" : ` spellcheck="${control.spellcheck}"`} value="${escapeHTMLStr(control.readConfig() as string)}"/>
</div>`;
case "textBlock": {
return `<div class="b3-label config-item">
diff --git a/app/src/config/search/dialog.ts b/app/src/config/search/dialog.ts
index ac975becc7..76fe0141c5 100644
--- a/app/src/config/search/dialog.ts
+++ b/app/src/config/search/dialog.ts
@@ -44,7 +44,7 @@ export const switchSettingTab = (
search = {keywords, visibleItemIds, visibleGroupIds, unavailableItems};
}
}
- void getSettingTab(tabId).mount(containerElement, search, app);
+ return getSettingTab(tabId).mount(containerElement, search, app);
};
const syncSettingSearch = (dialogElement: HTMLElement, app: App) => {
diff --git a/app/src/config/setting/window.ts b/app/src/config/setting/window.ts
index ef14013d89..12e5d23067 100644
--- a/app/src/config/setting/window.ts
+++ b/app/src/config/setting/window.ts
@@ -9,6 +9,7 @@ import {fetchSyncPost} from "../../util/fetch";
import {addBaseURL, redirectToCheckAuth, setNoteBook} from "../../util/pathName";
import {getLocalStorage, initNativeDialogOverride, initWindowOpenOverride, isMac, isWindows} from "../../protyle/util/compatibility";
import {addScriptSync} from "../../protyle/util/addScript";
+import {ensureLute} from "../../protyle/util/lute";
import {loadDesktopHostConnection, initDesktopHost} from "../../boot/onGetConfig";
import {loadLanguages} from "../../boot/loadLanguages";
import {systemConfig} from "../systemConfig";
@@ -53,10 +54,13 @@ const initialize = async () => {
const next = command;
command = undefined;
if (next.tab) {
- switchSettingTab(dialog.element, host.app, next.tab);
+ const mounted = switchSettingTab(dialog.element, host.app, next.tab);
const url = new URL(location.href);
url.searchParams.set("tab", next.tab);
history.replaceState(null, "", url);
+ if (next.tab === "assets") {
+ await mounted;
+ }
}
if (next.readme) {
const {type, from, resource} = next.readme;
@@ -118,18 +122,24 @@ const initialize = async () => {
window.siyuan.config = systemConfig(response.data.conf);
window.siyuan.isPublish = response.data.isPublish;
await loadDesktopHostConnection();
- await Promise.all([
+ const [user, emoji] = await Promise.all([
+ fetchSyncPost("/api/setting/getCloudUser", {cached: true}),
+ fetchSyncPost("/api/system/getEmojiConf", {}),
setNoteBook(),
new Promise<void>(resolve => getLocalStorage(resolve)),
- addScriptSync(`${Constants.PROTYLE_CDN}/js/lute/lute.min.js?v=${Constants.SIYUAN_VERSION}`, "protyleLuteScript"),
- ]);
- await addScriptSync(`${Constants.PROTYLE_CDN}/js/protyle-html.js?v=${Constants.SIYUAN_VERSION}`, "protyleWcHtmlScript");
- await new Promise<void>(resolve => {
- void loadLanguages(window.siyuan.config.appearance.lang, Constants.SIYUAN_VERSION, languages => {
+ addScriptSync(`${Constants.PROTYLE_CDN}/js/protyle-html.js?v=${Constants.SIYUAN_VERSION}`, "protyleWcHtmlScript"),
+ loadLanguages(window.siyuan.config.appearance.lang, Constants.SIYUAN_VERSION, languages => {
window.siyuan.languages = languages;
- resolve();
- });
- });
+ }),
+ host.plugin ? ensureLute() : Promise.resolve(),
+ ]);
+ if (!window.siyuan.languages || !window.DOMPurify) {
+ throw new Error("Could not load settings window dependencies");
+ }
+ window.siyuan.user = user.data && "userId" in user.data ? user.data : null;
+ if (Array.isArray(emoji.data)) {
+ window.siyuan.emojis = emoji.data;
+ }
window.siyuan.menus = new Menus(host.app);
await initDesktopHost();
ipcRenderer.on(Constants.SIYUAN_SEND_WINDOWS, (_event, data: IWebSocketData) => onWindowsMsg(data));
@@ -147,12 +157,6 @@ const initialize = async () => {
const zoom = window.siyuan.storage[Constants.LOCAL_ZOOM];
const position = Constants.SIZE_ZOOM.find(item => item.zoom === zoom)?.position;
if (position) ipcRenderer.send(Constants.SIYUAN_CMD, {cmd: "setTrafficLightPosition", zoom, position});
- const user = await fetchSyncPost("/api/setting/getCloudUser", {cached: true});
- window.siyuan.user = user.data && "userId" in user.data ? user.data : null;
- const emoji = await fetchSyncPost("/api/system/getEmojiConf", {});
- if (Array.isArray(emoji.data)) {
- window.siyuan.emojis = emoji.data;
- }
await waitForSettingsWindowPaint(async () => {
await loadAssets(window.siyuan.config.appearance);
await setInlineStyle();
@@ -170,6 +174,9 @@ const initialize = async () => {
});
} else {
const tab = getSettingTabDefs().find(def => def.id === new URLSearchParams(location.search).get("tab"))?.id;
+ if (tab === "assets") {
+ await ensureLute();
+ }
dialog = openSettingDialog(host.app, tab);
dialog.element.querySelectorAll(".config__side .b3-list-item").forEach(item => {
item.addEventListener("click", () => {
diff --git a/app/src/config/tabs/accessRuntime.ts b/app/src/config/tabs/accessRuntime.ts
index 4ba099e800..a79ab513bb 100644
--- a/app/src/config/tabs/accessRuntime.ts
+++ b/app/src/config/tabs/accessRuntime.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../util/escape";
import {fetchPost} from "../../util/fetch";
import {isMobile} from "../../util/functions";
@@ -93,14 +94,14 @@ export const renderPublishAuthAccounts = () => {
: '<span data-action="remove" class="block__icon block__icon--show"><svg><use xlink:href="#iconTrashcan"></use></svg></span>';
const listItemHtml = window.siyuan.config.publish.auth.accounts.map((account, index) => `
<li class="b3-label b3-label--inner fn__flex" data-index="${index}">
- <input class="b3-text-field fn__block" data-name="username" value="${Lute.EscapeHTMLStr(account.username)}" placeholder="${window.siyuan.languages.userName}">
+ <input class="b3-text-field fn__block" data-name="username" value="${escapeHTMLStr(account.username)}" placeholder="${window.siyuan.languages.userName}">
<span class="fn__space"></span>
<div class="b3-form__icona fn__block">
- <input class="b3-text-field fn__block b3-form__icona-input" type="password" data-name="password" value="${Lute.EscapeHTMLStr(account.password)}" placeholder="${window.siyuan.languages.password}">
+ <input class="b3-text-field fn__block b3-form__icona-input" type="password" data-name="password" value="${escapeHTMLStr(account.password)}" placeholder="${window.siyuan.languages.password}">
<svg class="b3-form__icona-icon" data-action="togglePassword"><use xlink:href="#iconEye"></use></svg>
</div>
<span class="fn__space"></span>
- <input class="b3-text-field fn__block" data-name="memo" value="${Lute.EscapeHTMLStr(account.memo)}" placeholder="${window.siyuan.languages.memo}">
+ <input class="b3-text-field fn__block" data-name="memo" value="${escapeHTMLStr(account.memo)}" placeholder="${window.siyuan.languages.memo}">
<span class="fn__space"></span>
${removeButtonHtml}
</li>`).join("");
@@ -116,7 +117,7 @@ export const sendAccessSetting = (controlId: string, value: unknown) => {
window.siyuan.config.api.token = token;
const tokenTipEl = accessTabElement?.querySelector(`#${CSS.escape("api.token")}`)?.closest(".config-item")?.querySelector(".b3-label__text");
if (tokenTipEl) {
- tokenTipEl.innerHTML = window.siyuan.languages.about14.replace("${token}", Lute.EscapeHTMLStr(token));
+ tokenTipEl.innerHTML = window.siyuan.languages.about14.replace("${token}", escapeHTMLStr(token));
}
});
break;
diff --git a/app/src/config/tabs/accessTab.ts b/app/src/config/tabs/accessTab.ts
index a12d759d69..5c60c3a056 100644
--- a/app/src/config/tabs/accessTab.ts
+++ b/app/src/config/tabs/accessTab.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../util/escape";
import type {SettingTabBuilder} from "../setting/builder";
import {fetchPost, fetchSyncPost} from "../../util/fetch";
import {ContractFormData} from "../../util/contractFormData";
@@ -101,7 +102,7 @@ const mountOIDCButton = (root: HTMLElement) => {
}
root.querySelector("#oidcConfig")?.addEventListener("click", () => {
const config = window.siyuan.config.oidc;
- const escape = (value: string) => Lute.EscapeHTMLStr(value);
+ const escape = (value: string) => escapeHTMLStr(value);
let destroyOIDCDialog: () => void = () => undefined;
const dialog = new Dialog({
title: window.siyuan.languages.oidcLogin,
diff --git a/app/src/config/tabs/ai/aiProviderUi.ts b/app/src/config/tabs/ai/aiProviderUi.ts
index 1be96725fd..c67d77c4e7 100644
--- a/app/src/config/tabs/ai/aiProviderUi.ts
+++ b/app/src/config/tabs/ai/aiProviderUi.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../../util/escape";
import type {AIModelTestData} from "../../../types/api";
import {bindPasswordIconaToggle, genConfigItemMainHtml} from "../../render/fragments";
import {confirmDialog} from "../../../dialog/confirmDialog";
@@ -32,7 +33,7 @@ export interface IGroupedModelPicker {
const PROVIDER_CATEGORIES = ["official", "aggregator", "local", "custom"] as const;
-const escapeHTML = (value: string) => Lute.EscapeHTMLStr(value ?? "");
+const escapeHTML = (value: string) => escapeHTMLStr(value ?? "");
const cloneProvider = (provider: Config.IProvider): Config.IProvider =>
JSON.parse(JSON.stringify(provider)) as Config.IProvider;
diff --git a/app/src/config/tabs/ai/aiUi.ts b/app/src/config/tabs/ai/aiUi.ts
index e544eeb737..4c128eba1a 100644
--- a/app/src/config/tabs/ai/aiUi.ts
+++ b/app/src/config/tabs/ai/aiUi.ts
@@ -4,7 +4,7 @@ import {showMessage} from "../../../dialog/message";
import {Constants} from "../../../constants";
import {isMobile} from "../../../util/functions";
import {fetchPost} from "../../../util/fetch";
-import {escapeHtml} from "../../../util/escape";
+import {escapeHTMLStr, escapeHtml} from "../../../util/escape";
import {aiConfigApi} from "./aiRuntime";
import {openByMobile} from "../../../editor/openLink";
import {canOpenExternalURL} from "../../../util/hostCapabilities";
@@ -361,7 +361,7 @@ export const getModelPickerKeywords = (group: ModelPickerGroup): string[] => {
const showDeleteConfirm = (title: string, onConfirm: () => void) => {
confirmDialog(
window.siyuan.languages.deleteOpConfirm,
- window.siyuan.languages.confirmDeleteTip.replace("${x}", Lute.EscapeHTMLStr(title)),
+ window.siyuan.languages.confirmDeleteTip.replace("${x}", escapeHTMLStr(title)),
onConfirm,
undefined,
true,
@@ -423,7 +423,7 @@ const mountAddMcpServerButton = (root: HTMLElement, block: HTMLElement) => {
groupTitle.insertAdjacentHTML("beforeend", `<span class="fn__flex-1"></span>
<button class="b3-button b3-button--outline fn__flex-center fn__size200" data-type="addAiMcpServer">
<svg class="b3-button__icon"><use xlink:href="#iconAdd"></use></svg>
- <span>${Lute.EscapeHTMLStr(window.siyuan.languages.addAiMcpServer)}</span>
+ <span>${escapeHTMLStr(window.siyuan.languages.addAiMcpServer)}</span>
</button>`);
(groupTitle.lastElementChild as HTMLButtonElement).addEventListener("click", (event) => {
openMcpServerDialog(root, null);
@@ -643,14 +643,14 @@ const renderMcpServerList = (root: HTMLElement) => {
return;
}
const serversHtml = servers.map((server) => {
- return `<div class="b3-list-item b3-list-item--narrow${hideActionClass}" data-type="aiMcpServer" data-mcp-server-id="${Lute.EscapeHTMLStr(server.id)}" data-mcp-server-name="${Lute.EscapeHTMLStr(server.name)}">
- <span class="mcp-status-dot b3-tooltips b3-tooltips__n" data-mcp-status-id="${Lute.EscapeHTMLStr(server.id)}" aria-label="${server.enabled ? window.siyuan.languages.mcpStatusConnecting : window.siyuan.languages.mcpStatusDisabled}" style="display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;flex-shrink:0;margin-right:4px;"><span style="display:inline-block;width:8px;height:8px;border-radius:50%;background-color:${server.enabled ? "#d97706" : "var(--b3-theme-on-surface-light)"};"></span></span>
- <span class="b3-list-item__text">${Lute.EscapeHTMLStr(server.name)}</span>
- <span class="ft__on-surface fn__flex-center" data-mcp-tools-count="${Lute.EscapeHTMLStr(server.id)}" style="font-size:12px;margin-right:8px;"></span>
- <span data-type="authorizeAiMcpServer" data-mcp-authorize-id="${Lute.EscapeHTMLStr(server.id)}" class="fn__none b3-list-item__action b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.mcpAuthorize}">
+ return `<div class="b3-list-item b3-list-item--narrow${hideActionClass}" data-type="aiMcpServer" data-mcp-server-id="${escapeHTMLStr(server.id)}" data-mcp-server-name="${escapeHTMLStr(server.name)}">
+ <span class="mcp-status-dot b3-tooltips b3-tooltips__n" data-mcp-status-id="${escapeHTMLStr(server.id)}" aria-label="${server.enabled ? window.siyuan.languages.mcpStatusConnecting : window.siyuan.languages.mcpStatusDisabled}" style="display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;flex-shrink:0;margin-right:4px;"><span style="display:inline-block;width:8px;height:8px;border-radius:50%;background-color:${server.enabled ? "#d97706" : "var(--b3-theme-on-surface-light)"};"></span></span>
+ <span class="b3-list-item__text">${escapeHTMLStr(server.name)}</span>
+ <span class="ft__on-surface fn__flex-center" data-mcp-tools-count="${escapeHTMLStr(server.id)}" style="font-size:12px;margin-right:8px;"></span>
+ <span data-type="authorizeAiMcpServer" data-mcp-authorize-id="${escapeHTMLStr(server.id)}" class="fn__none b3-list-item__action b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.mcpAuthorize}">
<svg><use xlink:href="#iconKey"></use></svg>
</span>
- <span data-type="disconnectAiMcpOAuth" data-mcp-disconnect-oauth-id="${Lute.EscapeHTMLStr(server.id)}" class="fn__none b3-list-item__action b3-list-item__action--warning b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.mcpDisconnectAuthorization}">
+ <span data-type="disconnectAiMcpOAuth" data-mcp-disconnect-oauth-id="${escapeHTMLStr(server.id)}" class="fn__none b3-list-item__action b3-list-item__action--warning b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.mcpDisconnectAuthorization}">
<svg><use xlink:href="#iconLinkOff"></use></svg>
</span>
<span data-type="deleteAiMcpServer" class="b3-list-item__action b3-list-item__action--warning b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.delete}">
@@ -703,11 +703,11 @@ const renderEnvironmentVariableOptions = (availableNames: string[], selectedName
? `<span class="b3-list-item__meta">${window.siyuan.languages.aiMcpEnvSensitive}</span>`
: "")
: `<span class="b3-list-item__meta">${window.siyuan.languages.aiMcpEnvUnavailable}</span>`;
- return `<label class="b3-list-item b3-list-item--narrow" data-mcp-env-option="${Lute.EscapeHTMLStr(name)}">
- <span class="b3-list-item__text">${Lute.EscapeHTMLStr(name)}</span>
+ return `<label class="b3-list-item b3-list-item--narrow" data-mcp-env-option="${escapeHTMLStr(name)}">
+ <span class="b3-list-item__text">${escapeHTMLStr(name)}</span>
${status}
<span class="fn__space--small"></span>
- <input class="b3-switch" type="checkbox" aria-label="${Lute.EscapeHTMLStr(name)}" data-mcp-inherit-env="${Lute.EscapeHTMLStr(name)}"${selected.has(key) ? " checked" : ""}>
+ <input class="b3-switch" type="checkbox" aria-label="${escapeHTMLStr(name)}" data-mcp-inherit-env="${escapeHTMLStr(name)}"${selected.has(key) ? " checked" : ""}>
</label>`;
}).join("");
};
@@ -731,9 +731,9 @@ const parseStringRecord = (value: string, invalidMessage: string): Record<string
const renderMcpEnvironmentRow = (name = "", value = "") => `<div data-mcp-env-row>
<div class="fn__flex">
- <input class="b3-text-field fn__flex-1" data-mcp-env-name type="text" spellcheck="false" placeholder="NAME" value="${Lute.EscapeHTMLStr(name)}">
+ <input class="b3-text-field fn__flex-1" data-mcp-env-name type="text" spellcheck="false" placeholder="NAME" value="${escapeHTMLStr(name)}">
<span class="fn__space"></span>
- <input class="b3-text-field fn__flex-1" data-mcp-env-value type="text" spellcheck="false" placeholder="{{secrets.NAME}}" value="${Lute.EscapeHTMLStr(value)}">
+ <input class="b3-text-field fn__flex-1" data-mcp-env-value type="text" spellcheck="false" placeholder="{{secrets.NAME}}" value="${escapeHTMLStr(value)}">
<span class="fn__space--small"></span>
<button class="block__icon block__icon--show block__icon--warning" data-type="deleteMcpEnvironmentVariable" type="button" aria-label="${window.siyuan.languages.delete}">
<svg><use xlink:href="#iconTrashcan"></use></svg>
@@ -807,7 +807,7 @@ const openMcpServerDialogWithEnvironment = (root: HTMLElement, serverName: strin
<div class="config-name">${window.siyuan.languages.aiMcpServerName}</div>
<div class="b3-label__text">${window.siyuan.languages.aiMcpServerNameTip}</div>
<div class="fn__hr"></div>
- <input class="b3-text-field fn__block" id="aiMcpServerName" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initialServer.name)}"/>
+ <input class="b3-text-field fn__block" id="aiMcpServerName" type="text" spellcheck="false" value="${escapeHTMLStr(initialServer.name)}"/>
</div>
<div class="b3-label b3-label--inner">
<div class="config-name">${window.siyuan.languages.connectionType}</div>
@@ -821,13 +821,13 @@ const openMcpServerDialogWithEnvironment = (root: HTMLElement, serverName: strin
<div class="config-name">${window.siyuan.languages.command}</div>
<div class="b3-label__text">${window.siyuan.languages.aiMcpCommandTip}</div>
<div class="fn__hr"></div>
- <input class="b3-text-field fn__block" id="aiMcpServerCommand" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initialServer.command)}"/>
+ <input class="b3-text-field fn__block" id="aiMcpServerCommand" type="text" spellcheck="false" value="${escapeHTMLStr(initialServer.command)}"/>
</div>
<div class="b3-label b3-label--inner${mcpTypeHidden("stdio")}" data-mcp-type="stdio">
<div class="config-name">${window.siyuan.languages.args}</div>
<div class="b3-label__text">${window.siyuan.languages.aiMcpArgsTip}</div>
<div class="fn__hr"></div>
- <textarea spellcheck="false" class="b3-text-field fn__block" id="aiMcpServerArgs" rows="4" style="resize: vertical;">${Lute.EscapeHTMLStr(argsText)}</textarea>
+ <textarea spellcheck="false" class="b3-text-field fn__block" id="aiMcpServerArgs" rows="4" style="resize: vertical;">${escapeHTMLStr(argsText)}</textarea>
</div>
<div class="b3-label b3-label--inner${mcpTypeHidden("stdio")}" data-mcp-type="stdio">
<div class="config-name">${window.siyuan.languages.aiMcpInheritEnv}</div>
@@ -855,13 +855,13 @@ const openMcpServerDialogWithEnvironment = (root: HTMLElement, serverName: strin
<div class="config-name">URL</div>
<div class="b3-label__text">${window.siyuan.languages.aiMcpUrlTip}</div>
<div class="fn__hr"></div>
- <input class="b3-text-field fn__block" id="aiMcpServerUrl" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initialServer.url)}"/>
+ <input class="b3-text-field fn__block" id="aiMcpServerUrl" type="text" spellcheck="false" value="${escapeHTMLStr(initialServer.url)}"/>
</div>
<div class="b3-label b3-label--inner${mcpTypeHidden("http")}" data-mcp-type="http">
<div class="config-name">${window.siyuan.languages.aiMcpHttpHeaders}</div>
<div class="b3-label__text">${window.siyuan.languages.fillJsonObject}</div>
<div class="fn__hr"></div>
- <textarea spellcheck="false" class="b3-text-field fn__block" id="aiMcpServerHeaders" rows="3" style="resize: vertical;" placeholder='{"Authorization":"Bearer ..."}'>${Lute.EscapeHTMLStr(headersText)}</textarea>
+ <textarea spellcheck="false" class="b3-text-field fn__block" id="aiMcpServerHeaders" rows="3" style="resize: vertical;" placeholder='{"Authorization":"Bearer ..."}'>${escapeHTMLStr(headersText)}</textarea>
</div>
<div class="b3-label b3-label--inner fn__flex${mcpTypeHidden("http")}" data-mcp-type="http">
<div class="fn__flex-1">
diff --git a/app/src/config/tabs/ai/mcpOAuthUi.ts b/app/src/config/tabs/ai/mcpOAuthUi.ts
index 5267c7a4c5..7c6e1191f9 100644
--- a/app/src/config/tabs/ai/mcpOAuthUi.ts
+++ b/app/src/config/tabs/ai/mcpOAuthUi.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../../util/escape";
import {fetchSyncPost} from "../../../util/fetch";
import {showMessage} from "../../../dialog/message";
@@ -9,7 +10,7 @@ export const mountMcpOAuth = (root: HTMLElement) => {
return;
}
const lang = window.siyuan.languages;
- const escape = Lute.EscapeHTMLStr;
+ const escape = escapeHTMLStr;
const input = (field: string, label: string, value = "", readonly = false) =>
`<label class="fn__block">${escape(label)}<input class="b3-text-field fn__block" data-field="${field}" value="${escape(value)}" ${readonly ? "readonly" : ""} spellcheck="false"></label><div class="fn__hr"></div>`;
diff --git a/app/src/config/tabs/appTab.ts b/app/src/config/tabs/appTab.ts
index 163546a748..0f98f7029a 100644
--- a/app/src/config/tabs/appTab.ts
+++ b/app/src/config/tabs/appTab.ts
@@ -22,7 +22,7 @@ import {Dialog} from "../../dialog";
import {openInputDialog} from "../../dialog/inputDialog";
import {isInMobileApp} from "../../protyle/util/compatibility";
import {pathPosix} from "../../util/pathName";
-import {escapeAttr, escapeHtml} from "../../util/escape";
+import {escapeHTMLStr, escapeAttr, escapeHtml} from "../../util/escape";
/// #endif
/// #if !BROWSER
import {afterExport} from "../../protyle/export/util";
@@ -365,9 +365,9 @@ const genNetworkProxyHtml = (): string => {
<option value="http" ${proxy.scheme === "http" ? "selected" : ""}>HTTP</option>
</select>
<span class="fn__space"></span>
- <input spellcheck="false" id="networkProxyHost" placeholder="user:pass@IP" class="b3-text-field fn__flex-1" value="${Lute.EscapeHTMLStr(proxy.host)}"/>
+ <input spellcheck="false" id="networkProxyHost" placeholder="user:pass@IP" class="b3-text-field fn__flex-1" value="${escapeHTMLStr(proxy.host)}"/>
<span class="fn__space"></span>
- <input id="networkProxyPort" placeholder="Port" class="b3-text-field fn__flex-1" value="${Lute.EscapeHTMLStr(proxy.port)}" type="number"/>
+ <input id="networkProxyPort" placeholder="Port" class="b3-text-field fn__flex-1" value="${escapeHTMLStr(proxy.port)}" type="number"/>
<span class="fn__space"></span>
<button id="networkProxyConfirm" class="b3-button fn__size200 b3-button--outline">${window.siyuan.languages.confirm}</button>
</div>
diff --git a/app/src/config/tabs/exportTab.ts b/app/src/config/tabs/exportTab.ts
index 72d5f0b1f1..90a9ff3614 100644
--- a/app/src/config/tabs/exportTab.ts
+++ b/app/src/config/tabs/exportTab.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../util/escape";
/// #if !BROWSER
import {ipcRenderer} from "electron";
import {useShell} from "../../util/pathName";
@@ -148,7 +149,7 @@ const registerExportPandocGroup = (tab: SettingTabBuilder) => {
afterMount: mountExportPandocStack,
}, (stack) => {
const pandocBinLabel = window.siyuan.config.export.pandocBin ?
- Lute.EscapeHTMLStr(window.siyuan.config.export.pandocBin) : `${window.siyuan.languages.builtIn} Pandoc`;
+ escapeHTMLStr(window.siyuan.config.export.pandocBin) : `${window.siyuan.languages.builtIn} Pandoc`;
stack.title(`${window.siyuan.languages.export19}<span class="fn__space"></span><a href="javascript:void(0)" id="pandocBinPathDisplay" style="word-break: break-all">${pandocBinLabel}</a>`);
stack.button({
id: "pandocBinReset",
diff --git a/app/src/config/tabs/secretsVariablesUi.ts b/app/src/config/tabs/secretsVariablesUi.ts
index acef1be9ee..c16c781412 100644
--- a/app/src/config/tabs/secretsVariablesUi.ts
+++ b/app/src/config/tabs/secretsVariablesUi.ts
@@ -1,3 +1,4 @@
+import {escapeHTMLStr} from "../../util/escape";
import {bindPasswordIconaToggle} from "../render/fragments";
import {Dialog} from "../../dialog";
import {confirmDialog} from "../../dialog/confirmDialog";
@@ -227,8 +228,8 @@ const renderNamedItemList = (options: RenderNamedItemListOptions) => {
return;
}
const html = items.map((item) => {
- return `<div class="b3-list-item b3-list-item--narrow${hideActionClass}" ${dataAttr}="${Lute.EscapeHTMLStr(item.name)}">
- <span class="b3-list-item__text">${Lute.EscapeHTMLStr(item.name)}</span>
+ return `<div class="b3-list-item b3-list-item--narrow${hideActionClass}" ${dataAttr}="${escapeHTMLStr(item.name)}">
+ <span class="b3-list-item__text">${escapeHTMLStr(item.name)}</span>
<span data-type="${deleteType}" class="b3-list-item__action b3-list-item__action--warning b3-tooltips b3-tooltips__w" aria-label="${window.siyuan.languages.delete}">
<svg><use xlink:href="#iconTrashcan"></use></svg>
</span>
@@ -272,12 +273,12 @@ const openItemDialog = (options: OpenItemDialogOptions) => {
const valueInputHtml = isSecret
? `<div class="b3-form__icona fn__block">
- <input id="itemValue" type="password" class="b3-text-field b3-form__icona-input" spellcheck="false" value="${Lute.EscapeHTMLStr(initial.value)}">
+ <input id="itemValue" type="password" class="b3-text-field b3-form__icona-input" spellcheck="false" value="${escapeHTMLStr(initial.value)}">
<svg class="b3-form__icona-icon" data-action="togglePassword" style="user-select: none;">
<use xlink:href="#iconEye"></use>
</svg>
</div>`
- : `<input class="b3-text-field fn__block" id="itemValue" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initial.value)}"/>`;
+ : `<input class="b3-text-field fn__block" id="itemValue" type="text" spellcheck="false" value="${escapeHTMLStr(initial.value)}"/>`;
const initialHosts: string[] = isSecret ? (initial.allowedHosts ?? []) : [];
const hostsInputHtml = isSecret
@@ -285,7 +286,7 @@ const openItemDialog = (options: OpenItemDialogOptions) => {
<div class="config-name">${window.siyuan.languages.secretAllowedHosts}</div>
<div class="b3-label__text">${window.siyuan.languages.secretAllowedHostsTip}</div>
<div class="fn__hr"></div>
- <input class="b3-text-field fn__block" id="itemAllowedHosts" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initialHosts.join(", "))}"/>
+ <input class="b3-text-field fn__block" id="itemAllowedHosts" type="text" spellcheck="false" value="${escapeHTMLStr(initialHosts.join(", "))}"/>
</div>`
: "";
@@ -297,7 +298,7 @@ const openItemDialog = (options: OpenItemDialogOptions) => {
<div class="config-name">${isSecret ? window.siyuan.languages.secretName : window.siyuan.languages.variableName}</div>
<div class="b3-label__text">${isSecret ? window.siyuan.languages.secretNameTip : window.siyuan.languages.variableNameTip}</div>
<div class="fn__hr"></div>
- <input class="b3-text-field fn__block" id="itemName" type="text" spellcheck="false" value="${Lute.EscapeHTMLStr(initial.name)}"/>
+ <input class="b3-text-field fn__block" id="itemName" type="text" spellcheck="false" value="${escapeHTMLStr(initial.name)}"/>
</div>
${hostsInputHtml}
<div class="b3-label b3-label--inner">
@@ -355,7 +356,7 @@ const openItemDialog = (options: OpenItemDialogOptions) => {
const showDeleteConfirm = (title: string, onConfirm: () => void) => {
confirmDialog(
window.siyuan.languages.deleteOpConfirm,
- window.siyuan.languages.confirmDeleteTip.replace("${x}", Lute.EscapeHTMLStr(title)),
+ window.siyuan.languages.confirmDeleteTip.replace("${x}", escapeHTMLStr(title)),
onConfirm,
undefined,
true,
diff --git a/app/src/protyle/util/addScript.test.ts b/app/src/protyle/util/addScript.test.ts
new file mode 100644
index 0000000000..cfcfc20b7d
--- /dev/null
+++ b/app/src/protyle/util/addScript.test.ts
@@ -0,0 +1,78 @@
+import * as assert from "node:assert/strict";
+import {readFileSync} from "node:fs";
+import {test} from "node:test";
+import {runInNewContext} from "node:vm";
+import {ModuleKind, ScriptTarget, transpileModule} from "typescript";
+
+const createLoader = () => {
+ const code = transpileModule(readFileSync("src/protyle/util/addScript.ts", "utf8"), {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+ }).outputText;
+ const elements: Array<Record<string, any>> = [];
+ let reloads = 0;
+ const context = {
+ exports: {} as {addScriptSync: (path: string, id: string) => Promise<boolean>},
+ document: {
+ getElementById: (id: string) => elements.find(element => element.id === id),
+ createElement: () => {
+ const element: Record<string, any> = {remove: () => elements.splice(elements.indexOf(element), 1)};
+ return element;
+ },
+ head: {appendChild: (element: Record<string, any>) => elements.push(element)},
+ },
+ window: {location: {reload: () => reloads++}},
+ Lute: undefined as unknown,
+ };
+ runInNewContext(code, context);
+ return {loader: context.exports, elements, context, reloads: () => reloads};
+};
+
+test("ordered external scripts share pending work and wait for load completion", async () => {
+ const {loader, elements} = createLoader();
+ const first = loader.addScriptSync("/lute.js", "engine");
+ const second = loader.addScriptSync("/lute.js", "engine");
+ let completed = false;
+ void second.then(() => completed = true);
+ await Promise.resolve();
+ assert.equal(completed, false);
+ assert.equal(elements.length, 1);
+ assert.equal(elements[0].src, "/lute.js");
+ assert.equal(elements[0].async, false);
+ assert.equal(elements[0].text, undefined);
+ elements[0].onload();
+ assert.deepEqual(await Promise.all([first, second]), [true, true]);
+ assert.equal(await loader.addScriptSync("/lute.js", "engine"), false);
+});
+
+test("failed external scripts release concurrent callers and can be retried", async () => {
+ const {loader, elements} = createLoader();
+ const first = loader.addScriptSync("/missing.js", "engine");
+ const second = loader.addScriptSync("/missing.js", "engine");
+ elements[0].onerror();
+ assert.deepEqual(await Promise.all([first, second]), [false, false]);
+ assert.equal(elements.length, 0);
+ const retried = loader.addScriptSync("/loaded.js", "engine");
+ elements[0].onload();
+ assert.equal(await retried, true);
+});
+
+test("non-Lute scripts can load before Lute without reloading the page", async () => {
+ const {loader, elements, reloads} = createLoader();
+ const html = loader.addScriptSync("/protyle-html.js", "protyleWcHtmlScript");
+ elements[0].onload();
+ await html;
+ assert.equal(reloads(), 0);
+ const lute = loader.addScriptSync("/lute.js", "protyleLuteScript");
+ elements[1].onload();
+ await lute;
+ assert.equal(reloads(), 1);
+});
+
+test("a successfully initialized Lute does not reload the page", async () => {
+ const {loader, elements, context, reloads} = createLoader();
+ const pending = loader.addScriptSync("/lute.js", "protyleLuteScript");
+ context.Lute = {};
+ elements[0].onload();
+ await pending;
+ assert.equal(reloads(), 0);
+});
diff --git a/app/src/protyle/util/addScript.ts b/app/src/protyle/util/addScript.ts
index 3f5c9f3577..0845c21e36 100644
--- a/app/src/protyle/util/addScript.ts
+++ b/app/src/protyle/util/addScript.ts
@@ -1,45 +1,35 @@
-import {isRemoteKernel} from "../../util/hostCapabilities";
+const pendingScripts = new Map<string, Promise<boolean>>();
export const addScriptSync = async (path: string, id: string) => {
+ if (pendingScripts.has(id)) {
+ return pendingScripts.get(id);
+ }
if (document.getElementById(id)) {
return false;
}
- if (isRemoteKernel()) {
- return new Promise<boolean>((resolve) => {
- const scriptElement = document.createElement("script");
- scriptElement.type = "text/javascript";
- scriptElement.src = path;
- scriptElement.async = false;
- scriptElement.id = id;
- scriptElement.onload = () => {
- if (typeof Lute === "undefined") {
- // 鸿蒙系统上第一次加载会出现 Lute 未定义的情况,重新载入一次就好了,暂时没找到原因,先这样处理
- window.location.reload();
- }
- resolve(true);
- };
- scriptElement.onerror = () => {
- scriptElement.remove();
- resolve(false);
- };
- document.head.appendChild(scriptElement);
- });
- }
- const xhrObj = new XMLHttpRequest();
- xhrObj.open("GET", path, false);
- xhrObj.setRequestHeader("Accept",
- "text/javascript, application/javascript, application/ecmascript, application/x-ecmascript, */*; q=0.01");
- xhrObj.send("");
- const scriptElement = document.createElement("script");
- scriptElement.type = "text/javascript";
- scriptElement.text = xhrObj.responseText;
- scriptElement.id = id;
- document.head.appendChild(scriptElement);
- if (typeof Lute === "undefined") {
- // 鸿蒙系统上第一次加载会出现 Lute 未定义的情况,重新载入一次就好了,暂时没找到原因,先这样处理
- window.location.reload();
- }
- return true;
+ const pending = new Promise<boolean>((resolve) => {
+ const scriptElement = document.createElement("script");
+ scriptElement.type = "text/javascript";
+ scriptElement.src = path;
+ scriptElement.async = false;
+ scriptElement.id = id;
+ scriptElement.onload = () => {
+ pendingScripts.delete(id);
+ if (id === "protyleLuteScript" && typeof Lute === "undefined") {
+ // 鸿蒙系统上首次加载可能没有初始化 Lute,重新载入页面恢复编辑器。
+ window.location.reload();
+ }
+ resolve(true);
+ };
+ scriptElement.onerror = () => {
+ pendingScripts.delete(id);
+ scriptElement.remove();
+ resolve(false);
+ };
+ document.head.appendChild(scriptElement);
+ });
+ pendingScripts.set(id, pending);
+ return pending;
};
export const addScript = (path: string, id: string) => {
diff --git a/app/src/protyle/util/lute.ts b/app/src/protyle/util/lute.ts
new file mode 100644
index 0000000000..2419b99733
--- /dev/null
+++ b/app/src/protyle/util/lute.ts
@@ -0,0 +1,13 @@
+import {Constants} from "../../constants";
+import {addScriptSync} from "./addScript";
+
+// 创建编辑器或执行依赖 Lute 的扩展脚本前,等待引擎加载完成。
+export const ensureLute = async () => {
+ if (typeof Lute !== "undefined") {
+ return;
+ }
+ await addScriptSync(`${Constants.PROTYLE_CDN}/js/lute/lute.min.js?v=${Constants.SIYUAN_VERSION}`, "protyleLuteScript");
+ if (typeof Lute === "undefined") {
+ throw new Error("Could not load Lute");
+ }
+};
diff --git a/app/src/util/appearanceAssets.test.ts b/app/src/util/appearanceAssets.test.ts
index c9e2dae2c5..535a61217a 100644
--- a/app/src/util/appearanceAssets.test.ts
+++ b/app/src/util/appearanceAssets.test.ts
@@ -8,7 +8,7 @@ import * as themeCompatibility from "./themeCompatibility";
const {parse} = require("ifdef-loader/preprocessor");
-const createAssets = () => {
+const createAssets = (ensureLute: () => Promise<void> = async () => {}) => {
const source = readFileSync(resolve(process.cwd(), "src/util/assets.ts"), "utf8");
const processed = parse(source, {MOBILE: false, BROWSER: true}, false, true);
const code = transpileModule(processed, {compilerOptions: {module: ModuleKind.CommonJS}}).outputText;
@@ -79,12 +79,27 @@ const createAssets = () => {
elements[id]?.setAttribute("src", url);
}};
}
+ if (name === "../protyle/util/lute") {
+ return {ensureLute};
+ }
return new Proxy({}, {get: () => (): undefined => undefined});
},
});
return {assets: moduleExports, appearance, elements, errors, scriptURLs, removedElements};
};
+test("third-party appearance scripts wait for Lute before execution", async () => {
+ let complete: () => void;
+ const pending = new Promise<void>(resolve => complete = resolve);
+ const {assets, appearance, scriptURLs} = createAssets(() => pending);
+ appearance.themeJS = true;
+ const loaded = assets.loadAssets(appearance);
+ assert.deepEqual(scriptURLs, []);
+ complete();
+ await loaded;
+ assert.ok(scriptURLs.some(url => url.startsWith("/appearance/themes/custom/theme.js")));
+});
+
test("missing appearance packages use built-in resources without replacing the saved choices", async () => {
const {assets, appearance, elements, scriptURLs, removedElements} = createAssets();
appearance.lightThemes = [];
diff --git a/app/src/util/assets.ts b/app/src/util/assets.ts
index 94d7176df2..e3b7c17c90 100644
--- a/app/src/util/assets.ts
+++ b/app/src/util/assets.ts
@@ -1,6 +1,7 @@
import {Constants} from "../constants";
import {getBodyGradientImage} from "./bodyGradient";
import {addScript} from "../protyle/util/addScript";
+import {ensureLute} from "../protyle/util/lute";
import {addStyle} from "../protyle/util/addStyle";
import {getAllEditor, getAllModels} from "../layout/getAll";
import {invalidateHeadingNumberMeasurements} from "../protyle/util/headingNumberCore";
@@ -247,6 +248,11 @@ export const loadAssets = async (appearance: Config.IAppearance) => {
const themeScriptAddress = `/appearance/themes/${themeName}/theme.js?v=${appearancePackageVersion("themes", themeName, data.themeVer)}`;
const themeScriptURL = new URL(themeScriptAddress, window.location.href).href;
const themeScriptElements = getThemeScriptElements();
+ const iconName = data.icon === "litheness" || data.icons?.some(icon => icon.name === data.icon) ? data.icon : "litheness";
+ if ((data.themeJS && themeSupported) || iconName !== "litheness") {
+ // 第三方主题和图标脚本可以调用编辑器引擎,执行前确保 Lute 已就绪。
+ await ensureLute();
+ }
if (!data.themeJS || !themeSupported) {
removeThemeScriptElements();
} else if (!themeScriptElements.some((item) => item.src === themeScriptURL)) {
@@ -255,7 +261,6 @@ export const loadAssets = async (appearance: Config.IAppearance) => {
}
// load icons
- const iconName = data.icon === "litheness" || data.icons?.some(icon => icon.name === data.icon) ? data.icon : "litheness";
const isBuiltInIcon = iconName === "litheness";
const iconScriptElement = document.getElementById("iconScript");
const iconDefaultScriptElement = document.getElementById("iconDefaultScript");
diff --git a/app/src/util/escape.test.ts b/app/src/util/escape.test.ts
index bd660b518d..87058a3ab3 100644
--- a/app/src/util/escape.test.ts
+++ b/app/src/util/escape.test.ts
@@ -1,6 +1,17 @@
import {describe, it} from "node:test";
import * as assert from "node:assert/strict";
-import {escapeSearchHighlight, stripSearchMark} from "./escape";
+import {escapeHTMLStr, escapeSearchHighlight, stripSearchMark} from "./escape";
+
+describe("escape HTML strings", () => {
+ it("matches the bundled Lute engine for text and double-quoted attributes", () => {
+ require("../../stage/protyle/js/lute/lute.min.js");
+ for (const value of ["", "plain text", "&<>\"'", "&amp; &#39; &quot;", "</textarea><img src=\"x\">",
+ "中文、日本語、😀\n\t'quoted'"]) {
+ assert.equal(escapeHTMLStr(value), Lute.EscapeHTMLStr(value));
+ }
+ assert.equal(escapeHTMLStr("&<>\"'"), "&amp;&lt;&gt;&quot;'");
+ });
+});
describe("strip search mark", () => {
it("removes search highlights without decoding escaped block names", () => {
diff --git a/app/src/util/escape.ts b/app/src/util/escape.ts
index 7fc575fd8f..b5cf1c10d0 100644
--- a/app/src/util/escape.ts
+++ b/app/src/util/escape.ts
@@ -1,3 +1,8 @@
+// 转义 HTML 文本和双引号属性值,保持 Lute.EscapeHTMLStr 的字符替换规则。
+export const escapeHTMLStr = (html: string) => {
+ return html.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+};
+
export const escapeHtml = (html: string) => {
if (!html) {
return html;
diff --git a/app/tests/scriptLoading.test.js b/app/tests/scriptLoading.test.js
new file mode 100644
index 0000000000..55ebff0642
--- /dev/null
+++ b/app/tests/scriptLoading.test.js
@@ -0,0 +1,102 @@
+const assert = require("node:assert/strict");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+
+const runCases = async sources => {
+ const check = require("node:assert/strict");
+ const load = (code, modules = {}) => {
+ const exports = {};
+ new Function("require", "exports", code)(name => modules[name], exports);
+ return exports;
+ };
+ const loader = load(sources.loader);
+ const {ensureLute} = load(sources.lute, {
+ "./addScript": loader,
+ "../../constants": {Constants: {PROTYLE_CDN: "/stage/protyle", SIYUAN_VERSION: "test"}},
+ });
+ check.equal(typeof window.Lute, "undefined");
+ await loader.addScriptSync("/stage/protyle/js/protyle-html.js", "protyleWcHtmlScript");
+ check.equal(typeof window.Lute, "undefined");
+ check.ok(customElements.get("protyle-html"));
+ check.equal(window.DOMPurify.sanitize('<img src="x" onerror="alert(1)"><script>alert(1)</script>'), '<img src="x">');
+ const first = ensureLute();
+ const second = ensureLute();
+ check.equal(document.querySelectorAll("#protyleLuteScript").length, 1);
+ await Promise.all([first, second]);
+ const script = document.getElementById("protyleLuteScript");
+ check.ok(script.src.endsWith("/stage/protyle/js/lute/lute.min.js?v=test"));
+ check.equal(script.textContent, "");
+ check.equal(window.Lute.EscapeHTMLStr('<input value="&">'), "&lt;input value=&quot;&amp;&quot;&gt;");
+ check.match(window.Lute.New().Md2HTML("**preview**"), /<strong>preview<\/strong>/);
+ check.equal(await loader.addScriptSync("/missing.js", "failedScript"), false);
+ check.equal(document.getElementById("failedScript"), null);
+ check.equal(await loader.addScriptSync("/retry.js", "failedScript"), true);
+ check.equal(window.scriptRetried, true);
+};
+
+if (process.versions.electron && process.type === "browser") {
+ const {app, BrowserWindow} = require("electron");
+ const http = require("node:http");
+ const ts = require("typescript");
+ app.setPath("userData", process.argv[2]);
+ app.commandLine.appendSwitch("disable-gpu");
+ app.whenReady().then(async () => {
+ const requests = new Map();
+ const server = http.createServer((request, response) => {
+ const pathname = new URL(request.url, "http://localhost").pathname;
+ requests.set(pathname, (requests.get(pathname) || 0) + 1);
+ if (pathname.startsWith("/stage/protyle/")) {
+ response.setHeader("Content-Type", "text/javascript; charset=utf-8");
+ const content = fs.readFileSync(path.join(__dirname, "..", pathname));
+ setTimeout(() => response.end(content), 30);
+ } else if (pathname === "/retry.js") {
+ response.setHeader("Content-Type", "text/javascript; charset=utf-8");
+ response.end("window.scriptRetried = true;");
+ } else if (pathname === "/missing.js") {
+ response.writeHead(404);
+ response.end();
+ } else {
+ response.setHeader("Content-Type", "text/html; charset=utf-8");
+ response.end("<html><head></head><body></body></html>");
+ }
+ });
+ await new Promise(resolve => server.listen(0, "127.0.0.1", resolve));
+ const win = new BrowserWindow({show: false, webPreferences: {nodeIntegration: true, contextIsolation: false}});
+ let exitCode = 0;
+ try {
+ const compile = file => ts.transpileModule(fs.readFileSync(path.join(__dirname, "../src/protyle/util", file), "utf8"), {
+ compilerOptions: {module: ts.ModuleKind.CommonJS, target: ts.ScriptTarget.ES2021},
+ }).outputText;
+ await win.loadURL("http://127.0.0.1:" + server.address().port);
+ await win.webContents.executeJavaScript(`(${runCases.toString()})(${JSON.stringify({loader: compile("addScript.ts"), lute: compile("lute.ts")})})`);
+ assert.equal(requests.get("/stage/protyle/js/lute/lute.min.js"), 1);
+ assert.equal(requests.get("/stage/protyle/js/protyle-html.js"), 1);
+ } catch (error) {
+ console.error(error);
+ exitCode = 1;
+ } finally {
+ win.destroy();
+ server.close();
+ app.exit(exitCode);
+ }
+ }).catch(error => {
+ console.error(error);
+ app.exit(1);
+ });
+} else {
+ require("node:test").test("external scripts initialize the sanitizer and Lute in Electron and retry failed loads", {
+ timeout: 45000,
+ }, async () => {
+ const profile = fs.mkdtempSync(path.join(os.tmpdir(), "siyuan-script-loading-"));
+ const env = {...process.env};
+ delete env.ELECTRON_RUN_AS_NODE;
+ try {
+ await require("node:util").promisify(require("node:child_process").execFile)(require("electron"),
+ [__filename, profile], {env, windowsHide: true, timeout: 40000});
+ } finally {
+ assert.equal(path.dirname(path.resolve(profile)), path.resolve(os.tmpdir()));
+ fs.rmSync(profile, {recursive: true, force: true, maxRetries: 5, retryDelay: 100});
+ }
+ });
+}
diff --git a/app/tests/settingsBoot.test.js b/app/tests/settingsBoot.test.js
new file mode 100644
index 0000000000..b92d90b682
--- /dev/null
+++ b/app/tests/settingsBoot.test.js
@@ -0,0 +1,129 @@
+const assert = require("node:assert/strict");
+const {readFileSync} = require("node:fs");
+const {test} = require("node:test");
+const {runInNewContext} = require("node:vm");
+const {ModuleKind, ScriptTarget, transpileModule} = require("typescript");
+
+const createBoot = (plugin = false, failed = "") => {
+ const source = readFileSync("src/config/setting/window.ts", "utf8");
+ const code = transpileModule(source.slice(0, source.indexOf("void initialize().catch")) + "\nexport {initialize};", {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+ }).outputText;
+ const pending = new Map();
+ const calls = [];
+ let luteLoaded = false;
+ let command;
+ const wait = name => {
+ calls.push(name);
+ return new Promise(resolve => pending.set(name, resolve));
+ };
+ const host = {app: {}, plugin: plugin ? {name: "Plugin", mount: create => {
+ assert.equal(luteLoaded, true);
+ create({items: []});
+ }} : undefined};
+ const window = {
+ opener: {location: {origin: "http://localhost"}, dispatchEvent: event => event.detail(host)},
+ addEventListener() {},
+ DOMPurify: undefined,
+ };
+ const constants = {PROTYLE_CDN: "/stage/protyle", SIYUAN_VERSION: "test", LOCAL_ZOOM: "zoom", SIZE_ZOOM: []};
+ const modules = {
+ "electron": {ipcRenderer: {on: (name, callback) => {
+ if (name === "siyuan-settings-command") command = callback;
+ }, send: name => calls.push(name), invoke: async () => false}, webFrame: {setZoomFactor() {}}},
+ "../../constants": {Constants: constants},
+ "../../layout/Model": {Model: class {
+ ws = {close() {}};
+ connect() {}
+ flushMainMessages() {}
+ }},
+ "../../menus": {Menus: class {}},
+ "../../util/genID": {genUUID: () => "id"},
+ "../../util/fetch": {fetchSyncPost: async (url, data) => {
+ if (url === "/api/system/getConf") return {code: 0, data: {conf: {appearance: {lang: "en"}}}};
+ if (url === "/api/setting/getCloudUser") {
+ assert.equal(data.cached, true);
+ await wait("user");
+ return {data: {userId: "user"}};
+ }
+ assert.equal(url, "/api/system/getEmojiConf");
+ await wait("emoji");
+ return {data: []};
+ }},
+ "../../util/pathName": {addBaseURL() {}, setNoteBook: () => wait("notebooks")},
+ "../../protyle/util/compatibility": {getLocalStorage: callback => {
+ void wait("storage").then(() => { window.siyuan.storage = {zoom: 1}; callback(); });
+ }, isWindows: () => true, isMac: () => false, initNativeDialogOverride() {}, initWindowOpenOverride() {}},
+ "../../protyle/util/addScript": {addScriptSync: async (_path, id) => {
+ assert.equal(id, "protyleWcHtmlScript");
+ await wait("html");
+ if (failed !== "html") window.DOMPurify = {};
+ return failed !== "html";
+ }},
+ "../../protyle/util/lute": {ensureLute: async () => { await wait("lute"); luteLoaded = true; }},
+ "../../boot/onGetConfig": {loadDesktopHostConnection: async () => {}, initDesktopHost: async () => {}},
+ "../../boot/loadLanguages": {loadLanguages: async (_lang, _version, callback) => {
+ await wait("languages");
+ if (failed !== "languages") callback({config: "Settings"});
+ }},
+ "../systemConfig": {systemConfig: config => config},
+ "../index": {openSettingDialog: () => {
+ assert.equal(window.siyuan.user.userId, "user");
+ calls.push("render");
+ return {element: {querySelectorAll: () => []}};
+ }},
+ "./tabs": {getSettingTabDefs: () => []},
+ "../search/dialog": {switchSettingTab: () => wait("assets")},
+ "./windowPaint": {waitForSettingsWindowPaint: async render => render()},
+ "../../plugin/Setting": {Setting: class {addItem() {} open() { calls.push("render"); }}},
+ };
+ const context = {exports: {}, window, document: {body: {classList: {toggle() {}}}, addEventListener() {}},
+ location: {search: "?settingsWindowToken=test", origin: "http://localhost", href: "http://localhost/settings"},
+ URL, URLSearchParams, history: {replaceState() {}},
+ CustomEvent: class {constructor(_name, options) { this.detail = options.detail; }},
+ require: name => modules[name] || new Proxy({}, {get: () => () => {}})};
+ window.location = context.location;
+ runInNewContext(code, context);
+ return {initialize: context.exports.initialize, calls, pending, command: next => command({}, next)};
+};
+
+for (const plugin of [false, true]) {
+ test(`settings start independent requests together and wait before showing (plugin=${plugin})`, async () => {
+ const boot = createBoot(plugin);
+ const initialized = boot.initialize();
+ await new Promise(resolve => setImmediate(resolve));
+ assert.deepEqual(boot.calls, ["user", "emoji", "notebooks", "storage", "html", "languages", ...(plugin ? ["lute"] : [])]);
+ for (const [name, complete] of boot.pending) if (name !== "user") complete();
+ await new Promise(resolve => setImmediate(resolve));
+ assert.equal(boot.calls.includes("render"), false);
+ boot.pending.get("user")();
+ await initialized;
+ assert.ok(boot.calls.indexOf("render") < boot.calls.indexOf("siyuan-settings-ready"));
+ });
+}
+
+test("opening directly into assets waits for its preview before showing settings", async () => {
+ const boot = createBoot();
+ const initialized = boot.initialize();
+ await new Promise(resolve => setImmediate(resolve));
+ boot.command({tab: "assets"});
+ for (const complete of boot.pending.values()) complete();
+ await new Promise(resolve => setImmediate(resolve));
+ assert.equal(boot.calls.includes("assets"), true);
+ assert.equal(boot.calls.includes("siyuan-settings-ready"), false);
+ boot.pending.get("assets")();
+ await initialized;
+ assert.equal(boot.calls.includes("siyuan-settings-ready"), true);
+});
+
+for (const failed of ["html", "languages"]) {
+ test(`settings initialization stops when ${failed} fails`, async () => {
+ const boot = createBoot(false, failed);
+ const initialized = boot.initialize();
+ await new Promise(resolve => setImmediate(resolve));
+ for (const complete of boot.pending.values()) complete();
+ await assert.rejects(initialized, /Could not load settings window dependencies/);
+ assert.equal(boot.calls.includes("render"), false);
+ assert.equal(boot.calls.includes("siyuan-settings-ready"), false);
+ });
+}