Skip to content

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

:bug: Stabilize unreferenced asset previews https://github.com/siyuan-note/siyuan/issues/20047

Danielad91ee460039
diff --git a/app/src/asset/anno.ts b/app/src/asset/anno.ts
index c0d7ba9033..77f49e4c47 100644
--- a/app/src/asset/anno.ts
+++ b/app/src/asset/anno.ts
@@ -892,7 +892,8 @@ export const getPdfInstance = (element: HTMLElement) => {
export const getHighlight = (element: HTMLElement) => {
const pdfInstance: any = getPdfInstance(element);
- if (!pdfInstance) {
+ // 未引用资源预览仍注册实例以支持键盘操作,但不访问批注文件。
+ if (!pdfInstance || pdfInstance.appConfig.previewOnly) {
return;
}
element.parentElement.querySelector(":scope > .pdf__rects")?.remove();
diff --git a/app/src/asset/pdf/viewer.js b/app/src/asset/pdf/viewer.js
index 9495f077b0..671aeaf457 100644
--- a/app/src/asset/pdf/viewer.js
+++ b/app/src/asset/pdf/viewer.js
@@ -248,6 +248,7 @@ function webViewerLoad(file, element, pdfPage, annoId, previewOnly = false) {
pdf.annoId = annoId
const config = getViewerConfiguration(element);
config.file = file;
+ config.previewOnly = previewOnly;
if (typeof PDFJSDev !== "undefined" && PDFJSDev.test("GENERIC")) {
// Give custom implementations of the default viewer a simpler way to
// set various `AppOptions`, by dispatching an event once all viewer
diff --git a/app/src/assets/template/app/settings.tpl b/app/src/assets/template/app/settings.tpl
index 61cdb9c7e7..e7b3d65aac 100644
--- a/app/src/assets/template/app/settings.tpl
+++ b/app/src/assets/template/app/settings.tpl
@@ -5,6 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SiYuan</title>
<link id="protyleKatexStyle" rel="stylesheet" href="../../protyle/js/katex/katex.min.css?v=0.16.9">
+ <script src="../../protyle/js/pdf/pdf.min.mjs?v=4.8.69" type="module"></script>
</head>
<body class="fn__flex-column body--settings">
<div id="commonMenu" class="b3-menu fn__none">
diff --git a/app/src/config/assets.ts b/app/src/config/assets.ts
index 05f89bef29..a305eb2300 100644
--- a/app/src/config/assets.ts
+++ b/app/src/config/assets.ts
@@ -187,6 +187,7 @@ const assets = {
};
const clearAssetPreview = () => {
preview.clear();
+ assetsListElement.querySelector(".b3-list-item--focus")?.classList.remove("b3-list-item--focus");
hideMobilePreview(assetsListElement, assetsPreviewElement);
};
const visibilityObserver = new MutationObserver(() => {
@@ -278,13 +279,15 @@ const assets = {
event.preventDefault();
event.stopPropagation();
break;
- } else if (mobile && target.getAttribute("data-tab-type") === "unrefAssets") {
+ } else if (target.getAttribute("data-tab-type") === "unrefAssets") {
const selected = target.classList.contains("b3-list-item--focus");
- clearAssetPreview();
+ assetsListElement.querySelector(".b3-list-item--focus")?.classList.remove("b3-list-item--focus");
if (!selected) {
target.classList.add("b3-list-item--focus");
assetsPreviewElement.classList.remove("fn__none");
preview.show(target.dataset.path || "", target.dataset.item);
+ } else if (mobile) {
+ clearAssetPreview();
}
event.preventDefault();
event.stopPropagation();
@@ -419,6 +422,9 @@ const assets = {
if (!mobile) {
assetsListElement.addEventListener("mouseover", (event) => {
+ if (assetsListElement.querySelector(".b3-list-item--focus")) {
+ return;
+ }
const liElement = hasClosestByClassName(event.target as Element, "b3-list-item");
if (liElement && liElement.getAttribute("data-item") !== assetsPreviewElement.getAttribute("data-item")) {
const item = liElement.getAttribute("data-item");
diff --git a/app/tests/assetPreview.test.js b/app/tests/assetPreview.test.js
index db51351f95..9c512c67ba 100644
--- a/app/tests/assetPreview.test.js
+++ b/app/tests/assetPreview.test.js
@@ -15,6 +15,9 @@ const sources = () => {
previewPath: compile("asset/previewPath.ts"),
escape: compile("util/escape.ts"),
viewer: compile("asset/pdf/viewer.js"),
+ annotations: compile("asset/anno.ts"),
+ annotationRuntime: compile("asset/annoRuntime.ts"),
+ textLayer: compile("asset/pdf/text_layer_builder.js"),
viewerTemplate: compile("asset/pdf/viewerTemplate.ts"),
pdfTheme: compile("asset/pdfViewer.ts"),
mobilePDF: compile("mobile/pdf.ts"),
@@ -247,7 +250,8 @@ const runCases = async source => {
"../protyle/util/onGet": {disabledProtyle: () => {}},
"../protyle/ui/initUI": {removeLoading: () => {}},
"../util/fetch": {fetchPost: (url, _data, callback) => {
- if (url.endsWith("getUnusedAssets")) callback({data: [{item: "assets/note.txt", path: "assets/note.txt"}]});
+ if (url.endsWith("getUnusedAssets")) callback({data: ["note.txt", "other.txt", "audio.mp3", "book.pdf"].map(name =>
+ ({item: "assets/" + name, path: "assets/" + name}))});
}},
});
const root = document.createElement("div");
@@ -261,6 +265,42 @@ const runCases = async source => {
item.dispatchEvent(new MouseEvent(isMobile ? "click" : "mouseover", {bubbles: true}));
await new Promise(resolve => setTimeout(resolve, 300));
check.match(panel.textContent, /Settings preview/);
+ if (!isMobile) {
+ const items = root.querySelectorAll('[data-tab-type="unrefAssets"]');
+ const current = panel.firstElementChild;
+ item.click();
+ check.equal(item.classList.contains("b3-list-item--focus"), true);
+ items[1].dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ await settle();
+ check.equal(panel.firstElementChild, current);
+ items[1].click();
+ await settle();
+ check.equal(panel.dataset.item, "assets/other.txt");
+ check.equal(item.classList.contains("b3-list-item--focus"), false);
+ check.equal(items[1].classList.contains("b3-list-item--focus"), true);
+ items[1].click();
+ check.equal(items[1].classList.contains("b3-list-item--focus"), false);
+ item.dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ await new Promise(resolve => setTimeout(resolve, 300));
+ check.equal(panel.dataset.item, "assets/note.txt");
+ items[2].click();
+ const audio = panel.querySelector("audio");
+ check.ok(audio);
+ item.dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ items[2].click();
+ check.equal(panel.querySelector("audio"), audio);
+ items[3].click();
+ const button = panel.querySelector("button");
+ item.dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ check.equal(panel.querySelector("button"), button);
+ button.click();
+ await settle();
+ const pdf = panel.firstElementChild;
+ item.dispatchEvent(new MouseEvent("mouseover", {bubbles: true}));
+ check.equal(panel.firstElementChild, pdf);
+ item.click();
+ await settle();
+ }
for (const themeCSS of source.themes) {
theme.textContent = themeCSS;
panel.style.fontSize = "32px";
@@ -291,6 +331,7 @@ const runCases = async source => {
await settle();
check.equal(panel.textContent, "");
check.equal(panel.hasAttribute("data-item"), false);
+ check.equal(root.querySelector('.config-assets[data-type="remove"] .b3-list-item--focus'), null);
assetsAPI.unmountAssetsTab(root);
root.remove();
}
@@ -320,12 +361,50 @@ const runCases = async source => {
undefined, undefined, true);
check.equal(annotations, 0);
check.equal(registrations, 1);
+ check.equal(readonly.appConfig.previewOnly, true);
check.equal(viewerElement.querySelector("button").classList.contains("fn__none"), true);
await readonly.destroy();
await readonly.destroy();
check.equal(cleanup, 1);
- await viewerAPI.webViewerLoad("assets/normal.pdf", viewerElement).destroy();
+ const normal = viewerAPI.webViewerLoad("assets/normal.pdf", viewerElement);
+ check.equal(normal.appConfig.previewOnly, false);
+ await normal.destroy();
check.equal(annotations, 1);
+ const runtime = load(source.annotationRuntime);
+ const annotationRequests = [];
+ const anno = load(source.annotations, {
+ "./annoRuntime": runtime,
+ "../layout/getAll": {getAllModels: () => ({asset: []})},
+ "../util/fetch": {fetchPost: (...args) => annotationRequests.push(args)},
+ });
+ const {TextLayerBuilder} = load(source.textLayer, {
+ "../anno": anno,
+ "./pdfjs": {TextLayer: class {
+ textDivs = [];
+ textContentItemsStr = [];
+ render() { return Promise.resolve(); }
+ update() {}
+ cancel() {}
+ }},
+ });
+ for (const name of ["normal", "\u4e2d\u6587", "with space", "literal%20name", "hash#name"]) {
+ const element = document.createElement("div");
+ const page = document.createElement("div");
+ page.dataset.pageNumber = "1";
+ element.append(page);
+ document.body.append(element);
+ const instance = {appConfig: {previewOnly: true,
+ file: new URL("assets/" + encodeURIComponent(name) + ".pdf?dataPath=box%2Fassets%2Ffile.pdf", "http://localhost").href}};
+ runtime.registerPdfInstance(element, instance);
+ const layer = new TextLayerBuilder({pdfPage: {streamTextContent() {}}, onAppend: div => page.append(div)});
+ await layer.render({});
+ await layer.render({});
+ check.equal(anno.getPdfInstance(layer.div), instance);
+ check.equal(annotationRequests.length, 0);
+ layer.cancel();
+ runtime.destroyAnno(element);
+ element.remove();
+ }
preview.clear();
return "Asset preview cases passed";
};
diff --git a/app/tests/scriptLoading.test.js b/app/tests/scriptLoading.test.js
index 55ebff0642..60a170502b 100644
--- a/app/tests/scriptLoading.test.js
+++ b/app/tests/scriptLoading.test.js
@@ -46,7 +46,15 @@ if (process.versions.electron && process.type === "browser") {
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/")) {
+ if (pathname === "/stage/build/app/settings.html") {
+ const template = fs.readFileSync(path.join(__dirname, "../src/assets/template/app/settings.tpl"), "utf8");
+ response.setHeader("Content-Type", "text/html; charset=utf-8");
+ response.end(template.replace("</head>", '<script defer src="/settings-bootstrap.js"></script></head>'));
+ } else if (pathname === "/settings-bootstrap.js") {
+ const bridge = fs.readFileSync(path.join(__dirname, "../src/asset/pdf/pdfjs.js"), "utf8");
+ response.setHeader("Content-Type", "text/javascript; charset=utf-8");
+ response.end(`window.settingsPDFSnapshot = (() => { const module = {}; ${bridge}\nreturn module.exports; })();`);
+ } else 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);
@@ -72,6 +80,10 @@ if (process.versions.electron && process.type === "browser") {
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);
+ await win.loadURL("http://127.0.0.1:" + server.address().port + "/stage/build/app/settings.html");
+ assert.equal(await win.webContents.executeJavaScript("typeof window.settingsPDFSnapshot?.AnnotationEditorType.DISABLE"),
+ "number");
+ assert.equal(await win.webContents.executeJavaScript("window.settingsPDFSnapshot === window.pdfjsLib"), true);
} catch (error) {
console.error(error);
exitCode = 1;
@@ -85,7 +97,7 @@ if (process.versions.electron && process.type === "browser") {
app.exit(1);
});
} else {
- require("node:test").test("external scripts initialize the sanitizer and Lute in Electron and retry failed loads", {
+ require("node:test").test("external scripts initialize the sanitizer, Lute and settings PDF.js in Electron", {
timeout: 45000,
}, async () => {
const profile = fs.mkdtempSync(path.join(os.tmpdir(), "siyuan-script-loading-"));