Skip to content

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

:art: Reuse standard sync checkout progress overlay https://github.com/siyuan-note/siyuan/issues/20763

Danielede986d1d9c5
diff --git a/app/src/assets/scss/component/_dialog.scss b/app/src/assets/scss/component/_dialog.scss
index 8b231c2457..53ec27f510 100644
--- a/app/src/assets/scss/component/_dialog.scss
+++ b/app/src/assets/scss/component/_dialog.scss
@@ -165,4 +165,28 @@
padding: 10px;
border-radius: var(--b3-border-radius-b);
}
+
+ &__progress-label {
+ text-align: right;
+ }
+
+ &__progress {
+ margin: 8px 0;
+ height: 8px;
+ border-radius: var(--b3-border-radius);
+ overflow: hidden;
+ background-color: #fff;
+ }
+
+ &__progressbar {
+ height: 100%;
+ background-color: var(--b3-theme-primary);
+ transition: var(--b3-transition);
+ }
+
+ &__progress--indeterminate > .b3-dialog__progressbar {
+ background-image: linear-gradient(-45deg, rgba(255, 255, 255, .2) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, .2) 50%, rgba(255, 255, 255, .2) 75%, transparent 75%, transparent);
+ animation: stripMove 450ms linear infinite;
+ background-size: 50px 50px;
+ }
}
diff --git a/app/src/assets/scss/component/_sync-checkout.scss b/app/src/assets/scss/component/_sync-checkout.scss
index 4c52689677..0fe925081b 100644
--- a/app/src/assets/scss/component/_sync-checkout.scss
+++ b/app/src/assets/scss/component/_sync-checkout.scss
@@ -16,23 +16,17 @@
opacity: 1;
}
- &__progress {
- width: 100%;
- margin: 16px 0;
- accent-color: var(--b3-theme-primary);
- }
-
&__details {
- margin-bottom: 16px;
+ margin-bottom: 12px;
}
&__notice {
- margin-bottom: 16px;
+ margin-bottom: 12px;
}
&__actions {
flex-wrap: wrap;
- justify-content: space-between;
+ justify-content: flex-end;
gap: 8px;
.b3-button {
@@ -61,6 +55,26 @@
top: auto;
bottom: 16px;
transform: translateX(-50%);
+ display: flex;
+ flex-wrap: wrap;
+ align-items: center;
+ gap: 12px;
+ width: max-content;
}
+
+ .sync-checkout__notice {
+ flex: 1 1 200px;
+ margin-bottom: 0;
+ }
+
+ .sync-checkout__actions {
+ margin-left: auto;
+ }
+ }
+}
+
+@media (max-width: 600px) {
+ .sync-checkout__panel {
+ width: calc(100vw - 32px);
}
}
diff --git a/app/src/dialog/progress.ts b/app/src/dialog/progress.ts
index 31e4e29bf5..6a86721633 100644
--- a/app/src/dialog/progress.ts
+++ b/app/src/dialog/progress.ts
@@ -1,4 +1,23 @@
-import {escapeHtml} from "../util/escape";
+export const getProgressContentHTML = () => `<div class="b3-dialog__progress-label"></div>
+<div class="b3-dialog__progress" role="progressbar" aria-valuemin="0" aria-valuemax="100"><div class="b3-dialog__progressbar"></div></div>
+<div data-type="message" class="ft__breakword" role="status"></div>`;
+
+export const updateProgressContent = (element: Element, message: string, current?: number, total?: number,
+ label: "count" | "percent" = "count") => {
+ const safeCurrent = Number.isFinite(Number(current)) ? Math.max(0, Number(current)) : 0;
+ const safeTotal = Number(total);
+ const determinate = Number.isFinite(safeTotal) && safeTotal > 0;
+ const percent = determinate ? Math.max(0, Math.min(100, safeCurrent / safeTotal * 100)) : 0;
+ const counter = element.querySelector(".b3-dialog__progress-label");
+ counter.classList.toggle("fn__none", !determinate);
+ counter.textContent = determinate ? label === "percent" ? `${Math.floor(percent)}%` : `${safeCurrent}/${safeTotal}` : "";
+ const progress = element.querySelector<HTMLElement>(".b3-dialog__progress");
+ progress.classList.toggle("b3-dialog__progress--indeterminate", !determinate);
+ if (determinate) progress.setAttribute("aria-valuenow", String(percent));
+ else progress.removeAttribute("aria-valuenow");
+ progress.querySelector<HTMLElement>(".b3-dialog__progressbar").style.width = determinate ? `${percent}%` : "100%";
+ element.querySelector('[data-type="message"]').textContent = message;
+};
export const progressLoading = (data: IWebSocketData, id = "progress") => {
let progressElement = document.getElementById(id);
@@ -15,25 +34,16 @@ export const progressLoading = (data: IWebSocketData, id = "progress") => {
}
// code 0: 有进度;1: 无进度;2: 关闭
if (data.code === 0) {
- const current = Number(data.data.current);
- const total = Number(data.data.total);
- const safeCurrent = Number.isFinite(current) ? current : 0;
- const safeTotal = Number.isFinite(total) && total > 0 ? total : 1;
progressElement.innerHTML = `<div class="b3-dialog__scrim" style="opacity: 1"></div>
-<div class="b3-dialog__loading">
- <div style="text-align: right">${safeCurrent}/${safeTotal}</div>
- <div style="margin: 8px 0;height: 8px;border-radius: var(--b3-border-radius);overflow: hidden;background-color:#fff;"><div style="width: ${safeCurrent / safeTotal * 100}%;transition: var(--b3-transition);background-color: var(--b3-theme-primary);height: 8px;"></div></div>
- <div class="ft__breakword">${escapeHtml(data.msg)}</div>
-</div>`;
+<div class="b3-dialog__loading">${getProgressContentHTML()}</div>`;
+ updateProgressContent(progressElement.lastElementChild, data.msg, data.data.current, data.data.total);
} else if (data.code === 1) {
if (progressElement.lastElementChild) {
- progressElement.lastElementChild.lastElementChild.innerHTML = escapeHtml(data.msg);
+ progressElement.lastElementChild.lastElementChild.textContent = data.msg;
} else {
progressElement.innerHTML = `<div class="b3-dialog__scrim" style="opacity: 1"></div>
-<div class="b3-dialog__loading">
- <div style="margin: 8px 0;height: 8px;border-radius: var(--b3-border-radius);overflow: hidden;background-color:#fff;"><div style="background-color: var(--b3-theme-primary);height: 8px;background-image: linear-gradient(-45deg, rgba(255, 255, 255, 0.2) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.2) 50%, rgba(255, 255, 255, 0.2) 75%, transparent 75%, transparent);animation: stripMove 450ms linear infinite;background-size: 50px 50px;"></div></div>
- <div class="ft__breakword">${escapeHtml(data.msg)}</div>
-</div>`;
+<div class="b3-dialog__loading">${getProgressContentHTML()}</div>`;
+ updateProgressContent(progressElement.lastElementChild, data.msg);
}
}
};
diff --git a/app/src/sync/checkoutProgress.ts b/app/src/sync/checkoutProgress.ts
index d6c5f2e95e..c383723c8d 100644
--- a/app/src/sync/checkoutProgress.ts
+++ b/app/src/sync/checkoutProgress.ts
@@ -6,6 +6,7 @@ import {reloadProtyleAndWait} from "../protyle/util/reload";
import {waitForSyncReloads} from "../util/reloadSync";
import {flushPendingEditorSaves, getEditorSaveFailureVersion} from "../protyle/util/editorSave";
import type {SyncCheckoutState} from "../types/api";
+import {getProgressContentHTML, updateProgressContent} from "../dialog/progress";
type CheckoutState = SyncCheckoutState & {compact: boolean; expanded: boolean};
let state: CheckoutState | undefined;
@@ -71,14 +72,11 @@ const render = () => {
root.style.zIndex = String(++window.siyuan.zIndex);
document.body.appendChild(root);
root.innerHTML = `<div class="b3-dialog__scrim sync-checkout__scrim"></div>
-<div class="sync-checkout__panel b3-dialog__loading" role="dialog" aria-label="${escapeHtml(window.siyuan.languages.sync)}" tabindex="-1">
- <div class="sync-checkout__details">
- <div data-type="message" class="ft__breakword" role="status"></div>
- <progress class="sync-checkout__progress" max="100"></progress>
- </div>
- <div class="sync-checkout__notice ft__secondary">${escapeHtml(window.siyuan.languages._kernel[436])}</div>
+<div class="sync-checkout__panel b3-dialog__loading" role="dialog" aria-label="${escapeHtml(window.siyuan.languages.sync)}">
+ <div class="sync-checkout__details">${getProgressContentHTML()}</div>
+ <div class="sync-checkout__notice ft__smaller">${escapeHtml(window.siyuan.languages._kernel[436])}</div>
<div class="fn__flex sync-checkout__actions">
- <button class="b3-button b3-button--outline b3-button--wrap" data-action="toggle"><svg class="b3-button__icon"><use xlink:href="#iconRefresh"></use></svg><span></span></button>
+ <button class="b3-button b3-button--cancel b3-button--wrap" data-action="toggle"><span></span></button>
<button class="b3-button b3-button--cancel b3-button--wrap" data-action="cancel">${escapeHtml(window.siyuan.languages.cancel)}</button>
</div>
</div>`;
@@ -118,16 +116,13 @@ const render = () => {
root.classList.toggle("sync-checkout--compact", state.compact || !state.blocking);
root.querySelector(".sync-checkout__details").classList.toggle("fn__none", state.compact);
root.querySelector(".sync-checkout__notice").classList.toggle("fn__none", !state.blocking);
- root.querySelector('[data-type="message"]').textContent = state.message;
- const progress = root.querySelector<HTMLProgressElement>("progress");
- if (state.total > 0) progress.value = Math.max(0, Math.min(100, state.current / state.total * 100));
- else progress.removeAttribute("value");
+ updateProgressContent(root, state.message, state.current, state.total, "percent");
root.querySelector('[data-action="toggle"] span').textContent = state.compact ?
- window.siyuan.languages.sync : window.siyuan.languages.collapseSyncDetails;
+ window.siyuan.languages.expand : window.siyuan.languages.collapseSyncDetails;
root.querySelector<HTMLButtonElement>('[data-action="cancel"]').disabled = state.canceling;
if (state.blocking && !root.contains(document.activeElement)) {
previousFocus ||= document.activeElement as HTMLElement;
- panel.focus();
+ root.querySelector<HTMLButtonElement>('[data-action="toggle"]').focus();
}
};
@@ -228,7 +223,7 @@ export const syncCheckoutProgress = (data: IWebSocketData) => {
const next: CheckoutState = {...incoming, phase: incoming.phase || "applying", blocking: incoming.blocking !== false,
message: incoming.message || data.msg || "", current: Number(incoming.current) || 0, total: Number(incoming.total) || 0,
canceling: Boolean(incoming.canceling), upsertRootIDs: incoming.upsertRootIDs || [], removeRootIDs: incoming.removeRootIDs || [],
- compact: same ? state.compact : true, expanded: same ? state.expanded : false};
+ compact: same ? state.compact : false, expanded: same ? state.expanded : false};
if (same && state.blocking && !next.blocking) {
finish({...state, revision: nextRevision, upsertRootIDs: next.upsertRootIDs, removeRootIDs: next.removeRootIDs}, next);
return;
diff --git a/app/tests/checkoutProgress.test.js b/app/tests/checkoutProgress.test.js
index 4838324df9..106b4948df 100644
--- a/app/tests/checkoutProgress.test.js
+++ b/app/tests/checkoutProgress.test.js
@@ -15,25 +15,49 @@ const run = async () => {
}).outputText;
const source = compile("sync/checkoutProgress.ts");
const escape = compile("util/escape.ts");
+ const progressContent = compile("dialog/progress.ts");
const sass = require("sass");
- const css = ["dialog", "button", "sync-checkout"].map(name => sass.compile(path.join(__dirname,
- `../src/assets/scss/component/_${name}.scss`)).css).join("\n");
+ const css = ["component/_dialog.scss", "component/_button.scss", "component/_sync-checkout.scss", "util/_function.scss"]
+ .map(file => sass.compile(path.join(__dirname, "../src/assets/scss", file)).css).join("\n");
try {
for (const [width, height, font, dark] of [[1100, 720, 16, false], [1100, 720, 24, true], [360, 640, 24, false], [640, 360, 24, true]]) {
win.setContentSize(width, height);
await win.loadURL("data:text/html,<html><body><input id='editor' value='original'></body></html>");
await win.webContents.insertCSS(css + `
:root {--b3-theme-primary:#357;--b3-mask-background:#0008;--b3-theme-background:${dark ? "#222" : "#fff"};
- --b3-theme-on-surface:${dark ? "#eee" : "#222"};--b3-theme-surface:#888;--b3-border-radius:4px;--b3-border-radius-b:8px;}
- body,button {font-size:${font}px;} .fn__none {display:none;} .fn__flex {display:flex;align-items:center;}
- .fn__flex-1 {flex:1;} .fn__space {width:8px;} .b3-button {background-color:rgb(90,100,110);}
- .ft__breakword {word-break:break-all;}
+ --b3-theme-on-surface:${dark ? "#9aa0a6" : "#5f6368"};--b3-theme-secondary:${dark ? "#f3a92f" : "#ff9200"};
+ --b3-theme-surface:#888;--b3-border-radius:4px;--b3-border-radius-b:8px;}
+ body,button {font-size:${font}px;}
#editor {position:fixed;left:8px;top:8px;}`);
+ const themeOverride = await win.webContents.insertCSS(".b3-button {background-color:rgb(90,100,110);}");
const result = await win.webContents.executeJavaScript(`(async () => {
const assert = require("node:assert/strict");
- window.siyuan = {zIndex:100,languages:{sync:"Sync",collapseSyncDetails:"Hide details",cancel:"Cancel",_kernel:{436:"Applying synchronized changes"}}};
+ window.siyuan = {zIndex:100,languages:{sync:"Sync",expand:"Expand",collapseSyncDetails:"Hide details",cancel:"Cancel",_kernel:{436:"Applying synchronized changes"}}};
const escapeExports = {};
new Function("exports", ${JSON.stringify(escape)})(escapeExports);
+ const progressExports = {};
+ new Function("exports", ${JSON.stringify(progressContent)})(progressExports);
+ progressExports.progressLoading({code:0,msg:"<img src=x>",data:{current:1,total:10}},"standard-progress");
+ const standard = document.getElementById("standard-progress");
+ assert.equal(standard.querySelector(".b3-dialog__progress-label").textContent,"1/10");
+ assert.equal(standard.querySelector('[role="progressbar"]').getAttribute("aria-valuenow"),"10");
+ assert.equal(standard.querySelector('[data-type="message"]').textContent,"<img src=x>");
+ assert.equal(standard.querySelector("img"),null);
+ const sharedBarHeight = getComputedStyle(standard.querySelector(".b3-dialog__progress")).height;
+ const sharedColor = getComputedStyle(standard.querySelector(".b3-dialog__loading")).color;
+ assert.equal(sharedBarHeight,"8px");
+ progressExports.progressLoading({code:0,msg:"overrun",data:{current:999,total:10}},"standard-progress");
+ assert.equal(standard.querySelector(".b3-dialog__progressbar").style.width,"100%");
+ progressExports.progressLoading({code:0,msg:"unknown",data:{current:NaN,total:0}},"standard-progress");
+ assert.equal(standard.querySelector('[role="progressbar"]').hasAttribute("aria-valuenow"),false);
+ assert.ok(standard.querySelector(".b3-dialog__progress--indeterminate"));
+ progressExports.progressLoading({code:1,msg:"Waiting"},"other-progress");
+ progressExports.progressLoading({code:1,msg:"<img src=y>"},"other-progress");
+ assert.equal(document.querySelector('#other-progress [data-type="message"]').textContent,"<img src=y>");
+ assert.equal(document.querySelector("#other-progress img"),null);
+ progressExports.progressLoading({code:2},"standard-progress");
+ assert.ok(document.getElementById("other-progress"),"closing sync progress removed another task");
+ progressExports.progressLoading({code:2},"other-progress");
const calls = [];
const flushes = [];
const titles = [];
@@ -56,6 +80,7 @@ const run = async () => {
const runtime = {};
new Function("exports","require","window",${JSON.stringify(source)})(runtime, name => {
if (name.includes("escape")) return escapeExports;
+ if (name === "../dialog/progress") return progressExports;
if (name.includes("constants")) return {Constants:{SIYUAN_APPID:"app"}};
if (name.includes("getAll")) return {getAllEditor:() => editors};
if (name.includes("editorSave")) return {getEditorSaveFailureVersion:() => 0,flushPendingEditorSaves:() => pendingRequests};
@@ -88,6 +113,12 @@ const run = async () => {
progress("first",0,2,"preparing",{token:"window-token"});
root = document.getElementById("sync-checkout-progress");
assert.ok(root && root.contains(document.activeElement));
+ assert.equal(root.classList.contains("sync-checkout--compact"),false,"local checkout should open the existing full progress view");
+ assert.equal(root.querySelector(".sync-checkout__panel").hasAttribute("tabindex"),false,"the progress panel must not acquire a focus outline");
+ assert.equal(document.activeElement,root.querySelector('[data-action="toggle"]'));
+ assert.equal(getComputedStyle(root.querySelector(".sync-checkout__panel")).color,sharedColor);
+ assert.equal(getComputedStyle(root.querySelector(".sync-checkout__notice")).color,sharedColor,"sync notice should use the normal progress text color");
+ assert.equal(getComputedStyle(root.querySelector(".b3-dialog__progress")).height,sharedBarHeight);
await tick();
assert.deepEqual(flushes,["desktop","mobile","secondary"]);
assert.deepEqual(titles,flushes);
@@ -106,7 +137,8 @@ const run = async () => {
assert.equal(document.activeElement,root.querySelector('[data-action="cancel"]'));
assert.equal(root.querySelector("img"),null);
assert.equal(root.querySelector('[data-type="message"]').textContent,"<img src=x onerror='window.compromised=true'>");
- assert.equal(root.querySelector("progress").value,10);
+ assert.equal(root.querySelector('[role="progressbar"]').getAttribute("aria-valuenow"),"10");
+ assert.equal(root.querySelector(".b3-dialog__progress-label").textContent,"10%");
assert.equal(getComputedStyle(root.querySelector("button")).backgroundColor,"rgb(90, 100, 110)");
for (const type of ["beforeinput","paste","drop","keydown"]) {
const event = type === "keydown" ? new KeyboardEvent(type,{key:"a",bubbles:true,cancelable:true}) : new Event(type,{bubbles:true,cancelable:true});
@@ -116,14 +148,16 @@ const run = async () => {
root.querySelector('[data-action="toggle"]').click();
assert.ok(root.classList.contains("sync-checkout--compact"));
assert.ok(root.querySelector(".sync-checkout__details").classList.contains("fn__none"));
+ assert.equal(getComputedStyle(root.querySelector(".sync-checkout__notice")).color,sharedColor,"collapsed sync notice should use the normal progress text color");
assert.equal(editor.dispatchEvent(new Event("beforeinput",{bubbles:true,cancelable:true})),false);
assert.ok(document.elementFromPoint(12,12).classList.contains("sync-checkout__scrim"));
progress("first",0,3,"applying",{current:9,message:"Still restoring"});
assert.ok(root.classList.contains("sync-checkout--compact"));
root.querySelector('[data-action="toggle"]').click();
- assert.equal(root.querySelector("progress").value,90);
+ assert.equal(root.querySelector('[role="progressbar"]').getAttribute("aria-valuenow"),"90");
const panel = root.querySelector(".sync-checkout__panel").getBoundingClientRect();
assert.ok(panel.left>=0 && panel.right<=innerWidth && panel.top>=0 && panel.bottom<=innerHeight,JSON.stringify(panel));
+ if (innerWidth <= 600) assert.ok(panel.width >= innerWidth - 40,"narrow progress view wastes available width");
assert.ok(root.querySelector(".sync-checkout__panel").scrollWidth <= Math.ceil(panel.width),"narrow panel has horizontal overflow");
root.querySelectorAll("button").forEach(button => {
const rect = button.getBoundingClientRect();
@@ -183,11 +217,19 @@ const run = async () => {
assert.equal(document.getElementById("sync-checkout-progress"),null);
progress("second",0,3,"applying",{current:999,message:"Restoring /assets/long-resource-file-name.bin (1/60): 4.60 GB / 10.50 GB, 32 MB/s, 00:03:12 remaining"});
runtime.openSyncCheckoutProgress();
- assert.equal(document.querySelector("progress").value,100);
+ assert.equal(document.querySelector('[role="progressbar"]').getAttribute("aria-valuenow"),"100");
+ assert.equal(document.querySelector(".b3-dialog__progressbar").style.width,"100%");
assert.equal(document.querySelector('[data-action="cancel"]').disabled,false);
+ progress("second",0,3,"applying",{total:0});
+ assert.equal(document.querySelector('[role="progressbar"]').hasAttribute("aria-valuenow"),false);
+ assert.ok(document.querySelector(".b3-dialog__progress--indeterminate"));
+ progress("second",0,3,"applying",{current:460,total:1050,
+ message:"Restoring /assets/long-resource-file-name.bin (1/60): 4.60 GB / 10.50 GB, 32 MB/s, 00:03:12 remaining"});
+ assert.equal(document.querySelector(".b3-dialog__progress--indeterminate"),null);
return "passed";
})()`);
assert.equal(result, "passed");
+ await win.webContents.removeInsertedCSS(themeOverride);
await new Promise(resolve => setTimeout(resolve, 200));
if (process.env.SIYUAN_CHECKOUT_CAPTURE) {
mkdirSync(process.env.SIYUAN_CHECKOUT_CAPTURE, {recursive: true});