Skip to content

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

:perf: Serialize each WebSocket broadcast only once https://github.com/siyuan-note/siyuan/issues/20360

Daniel4230c81e4756
diff --git a/kernel/util/websocket.go b/kernel/util/websocket.go
index 506a321bd3..d44aff09f4 100644
--- a/kernel/util/websocket.go
+++ b/kernel/util/websocket.go
@@ -42,6 +42,7 @@ var (
)
func BroadcastByTypeAndExcludeApp(excludeApp, typ, cmd string, code int, msg string, data any) {
+ payload := broadcastPayload(cmd, code, msg, data)
sessions.Range(func(key, value any) bool {
appSessions := value.(*sync.Map)
if key == excludeApp {
@@ -54,12 +55,7 @@ func BroadcastByTypeAndExcludeApp(excludeApp, typ, cmd string, code int, msg str
return true
}
if t, ok := session.Get("type"); ok && typ == t {
- event := NewResult()
- event.Cmd = cmd
- event.Code = code
- event.Msg = msg
- event.Data = data
- session.Write(event.Bytes())
+ session.Write(payload())
}
return true
})
@@ -72,6 +68,7 @@ func BroadcastByTypeAndApp(typ, app, cmd string, code int, msg string, data any)
if !ok {
return
}
+ payload := broadcastPayload(cmd, code, msg, data)
appSessions.(*sync.Map).Range(func(key, value any) bool {
session := value.(*melody.Session)
@@ -79,12 +76,7 @@ func BroadcastByTypeAndApp(typ, app, cmd string, code int, msg string, data any)
return true
}
if t, ok := session.Get("type"); ok && typ == t {
- event := NewResult()
- event.Cmd = cmd
- event.Code = code
- event.Msg = msg
- event.Data = data
- session.Write(event.Bytes())
+ session.Write(payload())
}
return true
})
@@ -93,16 +85,21 @@ func BroadcastByTypeAndApp(typ, app, cmd string, code int, msg string, data any)
// BroadcastByType 广播所有实例上 typ 类型的会话。
func BroadcastByType(typ, cmd string, code int, msg string, data any) {
typeSessions := SessionsByType(typ)
+ payload := broadcastPayload(cmd, code, msg, data)
for _, sess := range typeSessions {
- event := NewResult()
- event.Cmd = cmd
- event.Code = code
- event.Msg = msg
- event.Data = data
- sess.Write(event.Bytes())
+ sess.Write(payload())
}
}
+// broadcastPayload 仅在找到目标会话时序列化,同一次广播共享结果。
+func broadcastPayload(cmd string, code int, msg string, data any) func() []byte {
+ return sync.OnceValue(func() []byte {
+ event := NewResult()
+ event.Cmd, event.Code, event.Msg, event.Data = cmd, code, msg, data
+ return event.Bytes()
+ })
+}
+
func SessionsByType(typ string) (ret []*melody.Session) {
return sessionsByType(typ, false)
}
diff --git a/kernel/util/websocket_serialization_test.go b/kernel/util/websocket_serialization_test.go
new file mode 100644
index 0000000000..aa8920456d
--- /dev/null
+++ b/kernel/util/websocket_serialization_test.go
@@ -0,0 +1,46 @@
+package util
+
+import "testing"
+
+type countedBroadcastData struct{ count int }
+
+func (data *countedBroadcastData) MarshalJSON() ([]byte, error) {
+ data.count++
+ return []byte(`{"id":"shared"}`), nil
+}
+
+func TestBroadcastSerializesOnceAndPreservesScope(t *testing.T) {
+ for _, mode := range []string{"all", "exclude", "app", "absent"} {
+ t.Run(mode, func(t *testing.T) {
+ hub := newNotificationTestHub(t)
+ data := &countedBroadcastData{}
+ switch mode {
+ case "all":
+ BroadcastByType("main", "shared", 0, "", data)
+ case "exclude":
+ BroadcastByTypeAndExcludeApp(hub.first, "main", "shared", 0, "", data)
+ case "app":
+ BroadcastByTypeAndApp("main", hub.first, "shared", 0, "", data)
+ case "absent":
+ BroadcastByType("absent", "shared", 0, "", data)
+ }
+ wantCount := 1
+ if mode == "absent" {
+ wantCount = 0
+ }
+ if data.count != wantCount {
+ t.Fatalf("serialized %d times, want %d", data.count, wantCount)
+ }
+ for i, events := range hub.readEvents(t) {
+ want := mode == "all" && i < 2 || mode == "exclude" && i == 1 || mode == "app" && i == 0
+ if want {
+ if len(events) != 1 || events[0].Cmd != "shared" || events[0].Data.ID != "shared" {
+ t.Fatalf("client %d received %+v", i, events)
+ }
+ } else if len(events) != 0 {
+ t.Fatalf("excluded client %d received %+v", i, events)
+ }
+ }
+ })
+ }
+}