Skip to content

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

:bug: Reject stale tag and bookmark batch writes https://github.com/siyuan-note/siyuan/issues/21007

Daniel5b99c1346cea
diff --git a/kernel/model/batch_mutation.go b/kernel/model/batch_mutation.go
new file mode 100644
index 0000000000..555bd72d6b
--- /dev/null
+++ b/kernel/model/batch_mutation.go
@@ -0,0 +1,18 @@
+package model
+
+import (
+ "github.com/88250/lute/parse"
+ "github.com/siyuan-note/siyuan/kernel/filesys"
+ "github.com/siyuan-note/siyuan/kernel/treenode"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+// Keep the authenticated tree and exact on-disk bytes from the same read.
+// writeReplacementTree compares this snapshot before publishing any changes.
+func loadBatchMutationTree(rootID string) (*parse.Tree, []byte, error) {
+ bt := treenode.GetBlockTree(rootID)
+ if bt == nil {
+ return nil, nil, ErrBlockNotFound
+ }
+ return filesys.LoadTreeSnapshot(bt.BoxID, bt.Path, util.NewLute())
+}
diff --git a/kernel/model/batch_mutation_fts5_test.go b/kernel/model/batch_mutation_fts5_test.go
new file mode 100644
index 0000000000..b71ee26a4c
--- /dev/null
+++ b/kernel/model/batch_mutation_fts5_test.go
@@ -0,0 +1,75 @@
+//go:build fts5
+
+package model
+
+import (
+ "bytes"
+ "errors"
+ "os"
+ "path/filepath"
+ "testing"
+
+ "github.com/88250/lute/ast"
+ "github.com/siyuan-note/siyuan/kernel/filesys"
+ "github.com/siyuan-note/siyuan/kernel/sql"
+ "github.com/siyuan-note/siyuan/kernel/treenode"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func TestTagAndBookmarkMutationsRejectConcurrentEdits(t *testing.T) {
+ for _, action := range []string{"renameTag", "removeTag", "renameBookmark", "removeBookmark"} {
+ t.Run(action, func(t *testing.T) {
+ fixture := setupStructureTransactionTest(t)
+ setupFoldTransactionDatabase(t, fixture)
+ tree, err := LoadTreeByBlockID(fixture.sourceID)
+ if err != nil {
+ t.Fatal(err)
+ }
+ paragraph := treenode.NewParagraph(ast.NewNodeID())
+ paragraph.SetIALAttr("bookmark", "review")
+ paragraph.AppendChild(&ast.Node{Type: ast.NodeTextMark, TextMarkType: "tag", TextMarkTextContent: "review"})
+ tree.Root.AppendChild(paragraph)
+ if err = writeTreeUpsertQueue(tree); err != nil {
+ t.Fatal(err)
+ }
+ treenode.UpsertBlockTree(tree)
+ sql.FlushQueue()
+ var edited []byte
+ filename := filepath.Join(util.DataDir, tree.Box, tree.Path)
+ concurrentEdit := func() {
+ current, err := filesys.LoadTree(tree.Box, tree.Path, util.NewLute())
+ if err != nil {
+ t.Fatal(err)
+ }
+ p := treenode.NewParagraph(ast.NewNodeID())
+ p.AppendChild(&ast.Node{Type: ast.NodeText, Tokens: []byte("unrelated committed edit")})
+ current.Root.AppendChild(p)
+ if err := indexWriteTreeUpsertQueue(current); err != nil {
+ t.Fatal(err)
+ }
+ sql.FlushQueue()
+ edited, err = os.ReadFile(filename)
+ if err != nil {
+ t.Fatal(err)
+ }
+ }
+ switch action {
+ case "renameTag":
+ err = renameTag("review", "done", concurrentEdit)
+ case "removeTag":
+ err = removeTag("review", concurrentEdit)
+ case "renameBookmark":
+ err = renameBookmark("review", "done", concurrentEdit)
+ case "removeBookmark":
+ err = removeBookmark("review", concurrentEdit)
+ }
+ if !errors.Is(err, util.ErrFileChanged) {
+ t.Fatalf("stale mutation was accepted: %v", err)
+ }
+ actual, err := os.ReadFile(filename)
+ if err != nil || len(edited) == 0 || !bytes.Equal(actual, edited) {
+ t.Fatalf("concurrent edit was overwritten: %v", err)
+ }
+ })
+ }
+}
diff --git a/kernel/model/bookmark.go b/kernel/model/bookmark.go
index 3b1e0a9769..e0a483384f 100644
--- a/kernel/model/bookmark.go
+++ b/kernel/model/bookmark.go
@@ -25,17 +25,19 @@ import (
"strings"
"github.com/88250/gulu"
- "github.com/88250/lute/parse"
"github.com/gin-gonic/gin"
"github.com/siyuan-note/logging"
"github.com/siyuan-note/siyuan/kernel/av"
- "github.com/siyuan-note/siyuan/kernel/cache"
"github.com/siyuan-note/siyuan/kernel/sql"
"github.com/siyuan-note/siyuan/kernel/treenode"
"github.com/siyuan-note/siyuan/kernel/util"
)
func RemoveBookmark(bookmark string) (err error) {
+ return removeBookmark(bookmark, nil)
+}
+
+func removeBookmark(bookmark string, beforeCommit func()) (err error) {
util.PushEndlessProgress(Conf.Language(116))
defer util.PushClearProgress()
@@ -56,7 +58,7 @@ func RemoveBookmark(bookmark string) (err error) {
for treeID, blocks := range treeBlocks {
util.PushEndlessProgress("[" + treeID + "]")
- tree, e := LoadTreeByBlockID(treeID)
+ tree, original, e := loadBatchMutationTree(treeID)
if nil != e {
return e
}
@@ -71,7 +73,6 @@ func RemoveBookmark(bookmark string) (err error) {
// 前端按纯文本回传标签,存储态为转义形态,比较前统一还原
if bookmarkAttrVal := node.IALAttr("bookmark"); bookmarkAttrVal == html.UnescapeString(bookmark) {
node.RemoveIALAttr("bookmark")
- cache.PutBlockIALInBox(node.ID, tree.Box, parse.IAL2Map(node.KramdownIAL))
changed = true
}
}
@@ -79,7 +80,10 @@ func RemoveBookmark(bookmark string) (err error) {
if changed {
generateTreeHistory(tree, historyDir)
util.PushEndlessProgress(fmt.Sprintf(Conf.Language(111), util.EscapeHTML(treenode.ReadDocumentTitle(tree.Root).Text)))
- if err = writeTreeUpsertQueue(tree); err != nil {
+ if beforeCommit != nil {
+ beforeCommit()
+ }
+ if err = writeReplacementTree(tree, original, "", false); err != nil {
util.ClearPushProgress(100)
return
}
@@ -96,6 +100,10 @@ func RemoveBookmark(bookmark string) (err error) {
}
func RenameBookmark(oldBookmark, newBookmark string) (err error) {
+ return renameBookmark(oldBookmark, newBookmark, nil)
+}
+
+func renameBookmark(oldBookmark, newBookmark string, beforeCommit func()) (err error) {
if invalidChar := treenode.ContainsMarker(newBookmark); "" != invalidChar {
return fmt.Errorf(Conf.Language(112), invalidChar)
}
@@ -129,7 +137,7 @@ func RenameBookmark(oldBookmark, newBookmark string) (err error) {
for treeID, blocks := range treeBlocks {
util.PushEndlessProgress("[" + treeID + "]")
- tree, e := LoadTreeByBlockID(treeID)
+ tree, original, e := loadBatchMutationTree(treeID)
if nil != e {
return e
}
@@ -144,7 +152,6 @@ func RenameBookmark(oldBookmark, newBookmark string) (err error) {
// 前端按纯文本回传旧标签,存储态为转义形态,比较前统一还原
if bookmarkAttrVal := node.IALAttr("bookmark"); bookmarkAttrVal == html.UnescapeString(oldBookmark) {
node.SetIALAttr("bookmark", newBookmark)
- cache.PutBlockIALInBox(node.ID, tree.Box, parse.IAL2Map(node.KramdownIAL))
changed = true
}
}
@@ -152,7 +159,10 @@ func RenameBookmark(oldBookmark, newBookmark string) (err error) {
if changed {
generateTreeHistory(tree, historyDir)
util.PushEndlessProgress(fmt.Sprintf(Conf.Language(111), util.EscapeHTML(treenode.ReadDocumentTitle(tree.Root).Text)))
- if err = writeTreeUpsertQueue(tree); err != nil {
+ if beforeCommit != nil {
+ beforeCommit()
+ }
+ if err = writeReplacementTree(tree, original, "", false); err != nil {
util.ClearPushProgress(100)
return
}
diff --git a/kernel/model/tag.go b/kernel/model/tag.go
index a4f92afd37..da91630cdb 100644
--- a/kernel/model/tag.go
+++ b/kernel/model/tag.go
@@ -33,6 +33,10 @@ import (
)
func RemoveTag(label string) (err error) {
+ return removeTag(label, nil)
+}
+
+func removeTag(label string, beforeCommit func()) (err error) {
util.PushEndlessProgress(Conf.Language(116))
util.RandomSleep(1000, 2000)
@@ -55,7 +59,7 @@ func RemoveTag(label string) (err error) {
for treeID, blocks := range treeBlocks {
util.PushEndlessProgress("[" + treeID + "]")
- tree, e := LoadTreeByBlockIDWithReindex(treeID)
+ tree, original, e := loadBatchMutationTree(treeID)
if nil != e {
util.ClearPushProgress(100)
return e
@@ -102,7 +106,10 @@ func RemoveTag(label string) (err error) {
}
finishTitles()
util.PushEndlessProgress(fmt.Sprintf(Conf.Language(111), util.EscapeHTML(treenode.ReadDocumentTitle(tree.Root).Text)))
- if err = writeTreeUpsertQueue(tree); err != nil {
+ if beforeCommit != nil {
+ beforeCommit()
+ }
+ if err = writeReplacementTree(tree, original, "", false); err != nil {
util.ClearPushProgress(100)
return
}
@@ -126,6 +133,10 @@ func RemoveTag(label string) (err error) {
}
func RenameTag(oldLabel, newLabel string) (err error) {
+ return renameTag(oldLabel, newLabel, nil)
+}
+
+func renameTag(oldLabel, newLabel string, beforeCommit func()) (err error) {
if invalidChar := treenode.ContainsMarker(newLabel); "" != invalidChar {
return fmt.Errorf(Conf.Language(112), invalidChar)
}
@@ -164,7 +175,7 @@ func RenameTag(oldLabel, newLabel string) (err error) {
for treeID, blocks := range treeBlocks {
util.PushEndlessProgress("[" + treeID + "]")
- tree, e := LoadTreeByBlockIDWithReindex(treeID)
+ tree, original, e := loadBatchMutationTree(treeID)
if nil != e {
util.ClearPushProgress(100)
return e
@@ -209,7 +220,10 @@ func RenameTag(oldLabel, newLabel string) (err error) {
updateNodes[node.ID] = node
}
util.PushEndlessProgress(fmt.Sprintf(Conf.Language(111), util.EscapeHTML(treenode.ReadDocumentTitle(tree.Root).Text)))
- if err = writeTreeUpsertQueue(tree); err != nil {
+ if beforeCommit != nil {
+ beforeCommit()
+ }
+ if err = writeReplacementTree(tree, original, "", false); err != nil {
util.ClearPushProgress(100)
return
}