Skip to content

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

:bug: Scope unused asset hints to the requesting frontend https://github.com/siyuan-note/siyuan/issues/20067

Daniel20e1af003b07
diff --git a/app/src/config/assets.test.ts b/app/src/config/assets.test.ts
index dd99acd6a3..7dd2a1bceb 100644
--- a/app/src/config/assets.test.ts
+++ b/app/src/config/assets.test.ts
@@ -85,3 +85,55 @@ test("a failed assets dependency reports an error and permits another mount", as
await retried;
assert.equal(assets.mounted(), 1);
});
+
+test("initial and repeated unused asset queries identify their own desktop or mobile frontend", () => {
+ for (const mobile of [false, true]) {
+ const code = transpileModule(readFileSync("src/config/assets.ts", "utf8"), {
+ compilerOptions: {module: ModuleKind.CommonJS, target: ScriptTarget.ES2021},
+ }).outputText;
+ const requests: {url: string; headers: Record<string, string>}[] = [];
+ let click: (event: any) => void;
+ const classList = {contains: (value: string) => value === "item", add: () => {}, remove: () => {}};
+ const preview = {classList, removeAttribute: () => {}};
+ const list = {nextElementSibling: preview, addEventListener: () => {}, querySelector: (): null => null};
+ const panel = {classList, getAttribute: () => "remove"};
+ const root = {
+ classList,
+ querySelector: (selector: string) => selector.includes("config-assets__list") ? list : {classList},
+ querySelectorAll: () => [panel],
+ addEventListener: (_name: string, callback: typeof click) => { click = callback; },
+ };
+ const context = {
+ exports: {} as {assets: {element: typeof root; bindEvent: (app: any) => void}},
+ MutationObserver: class {observe() {} disconnect() {}},
+ require: (name: string) => {
+ if (name === "../util/fetch") return {
+ fetchPost: (url: string, _data: any, _callback: any, headers: Record<string, string>) => {
+ requests.push({url, headers});
+ },
+ };
+ if (name === "../util/fetchAppId") return {SIYUAN_APP_ID_HEADER: "X-SiYuan-App-ID"};
+ if (name === "../constants") return {Constants: {SIYUAN_APPID: "this-window"}};
+ if (name === "../util/functions") return {isMobile: () => mobile};
+ if (name === "./ocr") return {mountOCRSettings: () => {}};
+ if (name === "./assetPreview") return {AssetPreview: class {clear() {}}};
+ if (name === "../protyle") return {Protyle: class {protyle = {};}};
+ if (name === "../protyle/util/onGet") return {disabledProtyle: () => {}};
+ if (name === "../protyle/ui/initUI") return {removeLoading: () => {}};
+ return {};
+ },
+ };
+ runInNewContext(code + "\nexports.assets = assets;", context);
+ context.exports.assets.element = root;
+ context.exports.assets.bindEvent({appId: "settings-host-window"});
+ click({
+ target: {classList, getAttribute: () => "remove", isEqualNode: () => false},
+ preventDefault: () => {}, stopPropagation: () => {},
+ });
+ assert.equal(requests.length, 2);
+ requests.forEach(request => {
+ assert.equal(request.url, "/api/asset/getUnusedAssets");
+ assert.equal(request.headers["X-SiYuan-App-ID"], "this-window");
+ });
+ }
+});
diff --git a/app/src/config/assets.ts b/app/src/config/assets.ts
index 13d0eadd77..05f89bef29 100644
--- a/app/src/config/assets.ts
+++ b/app/src/config/assets.ts
@@ -4,6 +4,7 @@ import {confirmDialog} from "../dialog/confirmDialog";
import {isBrowser, isMobile} from "../util/functions";
import {hasClosestByClassName} from "../protyle/util/hasClosest";
import {fetchPost} from "../util/fetch";
+import {SIYUAN_APP_ID_HEADER} from "../util/fetchAppId";
/// #if !MOBILE
import {getAllModels} from "../layout/getAll";
import * as path from "path";
@@ -257,7 +258,7 @@ const assets = {
if (type === "remove") {
fetchPost("/api/asset/getUnusedAssets", {}, response => {
assets._renderList(response.data, assetsListElement, "unrefAssets");
- });
+ }, {[SIYUAN_APP_ID_HEADER]: Constants.SIYUAN_APPID});
} else if (!item.getAttribute("data-init")) {
if (type === "removeAV") {
fetchPost("/api/av/getUnusedAttributeViews", {}, response => {
@@ -427,7 +428,7 @@ const assets = {
}
fetchPost("/api/asset/getUnusedAssets", {}, response => {
assets._renderList(response.data, assetsListElement, "unrefAssets");
- });
+ }, {[SIYUAN_APP_ID_HEADER]: Constants.SIYUAN_APPID});
},
_renderList: (data: {
item: string,
diff --git a/kernel/api/asset.go b/kernel/api/asset.go
index 93c6bbe75f..efd16dcb5c 100644
--- a/kernel/api/asset.go
+++ b/kernel/api/asset.go
@@ -359,7 +359,8 @@ var getUnusedAssets = contractHandler(apicontract.GetUnusedAssets, func(c *gin.C
const maxUnusedAssets = 512
if total > maxUnusedAssets {
unusedAssets = unusedAssets[:maxUnusedAssets]
- util.PushMsg(fmt.Sprintf(model.Conf.Language(251), total, maxUnusedAssets), 5000)
+ // 提示仅发送给发起查询的前端;未提供应用标识的调用保留广播行为。
+ util.PushMsgWithApp(c.GetHeader("X-SiYuan-App-ID"), fmt.Sprintf(model.Conf.Language(251), total, maxUnusedAssets), 5000)
}
return apicontract.Success(assetUnusedItems(unusedAssets))
diff --git a/kernel/api/asset_notification_test.go b/kernel/api/asset_notification_test.go
new file mode 100644
index 0000000000..926a3fdbd5
--- /dev/null
+++ b/kernel/api/asset_notification_test.go
@@ -0,0 +1,131 @@
+package api
+
+import (
+ "encoding/json"
+ "fmt"
+ "net/http/httptest"
+ "net/url"
+ "os"
+ "path/filepath"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/gin-gonic/gin"
+ "github.com/gorilla/websocket"
+ "github.com/olahol/melody"
+ "github.com/siyuan-note/siyuan/kernel/apicontract"
+ "github.com/siyuan-note/siyuan/kernel/conf"
+ "github.com/siyuan-note/siyuan/kernel/model"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func TestAPIContractUnusedAssetNotificationScope(t *testing.T) {
+ for _, test := range []struct {
+ name string
+ count int
+ app string
+ want []int
+ }{
+ {name: "below limit", count: 511, app: "first", want: []int{0, 0, 0, 0}},
+ {name: "at limit", count: 512, app: "first", want: []int{0, 0, 0, 0}},
+ {name: "first frontend", count: 513, app: "first", want: []int{1, 0, 0, 0}},
+ {name: "second frontend", count: 513, app: "second", want: []int{0, 1, 0, 0}},
+ {name: "legacy caller", count: 513, want: []int{1, 1, 0, 0}},
+ {name: "absent frontend", count: 513, app: "closed", want: []int{0, 0, 0, 0}},
+ } {
+ t.Run(test.name, func(t *testing.T) {
+ assets := setupAssetContractWorkspace(t)
+ model.Conf.FileTree = conf.NewFileTree()
+ for i := 0; i < test.count; i++ {
+ if err := os.WriteFile(filepath.Join(assets, fmt.Sprintf("unused-%04d.txt", i)), []byte("unused"), 0644); err != nil {
+ t.Fatal(err)
+ }
+ }
+ push := melody.New()
+ connected := make(chan *melody.Session, 1)
+ push.HandleConnect(func(session *melody.Session) {
+ if session.Request.URL.Query().Get("publish") == "true" {
+ session.Set("isPublish", true)
+ }
+ util.AddPushChan(session)
+ connected <- session
+ })
+ push.HandleDisconnect(util.RemovePushChan)
+ engine := gin.New()
+ engine.POST("/api/asset/getUnusedAssets", getUnusedAssets)
+ engine.GET("/ws", func(c *gin.Context) { _ = push.HandleRequest(c.Writer, c.Request) })
+ server := httptest.NewServer(engine)
+ t.Cleanup(func() { _ = push.Close(); server.Close() })
+ var connections []*websocket.Conn
+ appPrefix := t.TempDir() + "-"
+ for _, query := range []string{
+ "app=" + url.QueryEscape(appPrefix+"first") + "&id=main&type=main",
+ "app=" + url.QueryEscape(appPrefix+"second") + "&id=main&type=main",
+ "app=" + url.QueryEscape(appPrefix+"first") + "&id=published&type=main&publish=true",
+ "app=" + url.QueryEscape(appPrefix+"first") + "&id=tree&type=filetree",
+ } {
+ connection, response, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(server.URL, "http")+"/ws?"+query, nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+ _ = response.Body.Close()
+ t.Cleanup(func() { _ = connection.Close() })
+ select {
+ case session := <-connected:
+ t.Cleanup(func() { util.RemovePushChan(session) })
+ case <-time.After(5 * time.Second):
+ t.Fatal("notification connection was not registered")
+ }
+ connections = append(connections, connection)
+ }
+ request := httptest.NewRequest("POST", "/api/asset/getUnusedAssets", strings.NewReader(`{}`))
+ if test.app != "" {
+ request.Header.Set("X-SiYuan-App-ID", appPrefix+test.app)
+ }
+ recorder := httptest.NewRecorder()
+ engine.ServeHTTP(recorder, request)
+ requireAPIContract(t, "POST", "/api/asset/getUnusedAssets", recorder)
+ var response struct {
+ Code int
+ Data []apicontract.AssetUnusedItem
+ }
+ if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 0 || len(response.Data) != min(test.count, 512) {
+ t.Fatalf("unexpected query response: %s, %v", recorder.Body.String(), err)
+ }
+ // 屏障与提示使用同一连接队列,验证未收到提示时无需等待超时。
+ if err := push.Broadcast([]byte(`{"cmd":"barrier"}`)); err != nil {
+ t.Fatal(err)
+ }
+ for i, connection := range connections {
+ if err := connection.SetReadDeadline(time.Now().Add(5 * time.Second)); err != nil {
+ t.Fatal(err)
+ }
+ count := 0
+ for {
+ var event struct {
+ Cmd string
+ Code int
+ Data struct {
+ ID string
+ CloseTimeout int
+ }
+ }
+ if err := connection.ReadJSON(&event); err != nil {
+ t.Fatal(err)
+ }
+ if event.Cmd == "barrier" {
+ break
+ }
+ if event.Cmd != "msg" || event.Code != 0 || event.Data.ID == "" || event.Data.CloseTimeout != 5000 {
+ t.Fatalf("unexpected notification: %+v", event)
+ }
+ count++
+ }
+ if count != test.want[i] {
+ t.Fatalf("connection %d received %d notifications, want %d", i, count, test.want[i])
+ }
+ }
+ })
+ }
+}
diff --git a/kernel/apicontract/contracts.go b/kernel/apicontract/contracts.go
index 826b24882f..b3d8c95a8c 100644
--- a/kernel/apicontract/contracts.go
+++ b/kernel/apicontract/contracts.go
@@ -871,6 +871,7 @@ var RemoveUnusedAsset = define[AssetPathRequest, AssetPathData]("removeUnusedAss
var RemoveUnusedAssets = define[EmptyRequest, AssetPathsData]("removeUnusedAssets", "/api/asset/removeUnusedAssets", NoBody, ResponseOptions{}, "POST")
// 扫描失败返回标准错误,不将失败表示为成功的空列表。
+// 可选请求头 X-SiYuan-App-ID 将截断提示限定到对应前端,未提供时保留广播行为。
var GetUnusedAssets = define[EmptyRequest, []*AssetUnusedItem]("getUnusedAssets", "/api/asset/getUnusedAssets", NoBody, ResponseOptions{}, "POST")
var GetMissingAssets = define[EmptyRequest, []*AssetUnusedItem]("getMissingAssets", "/api/asset/getMissingAssets", NoBody, ResponseOptions{}, "POST")