Skip to content

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

14.2 KB
Raw Blame
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later

//go:build fts5

package model

import (
	"errors"
	"slices"
	"strings"
	"testing"

	"github.com/88250/lute/ast"
	"github.com/88250/lute/parse"
	"github.com/siyuan-note/siyuan/kernel/av"
	"github.com/siyuan-note/siyuan/kernel/filesys"
	"github.com/siyuan-note/siyuan/kernel/sql"
	"github.com/siyuan-note/siyuan/kernel/treenode"
)

func TestAttributeViewDeletedBlockUndoRedo(t *testing.T) {
	for _, mode := range []string{"block", "container", "batch"} {
		t.Run(mode, func(t *testing.T) {
			fixture, before, tx := setupAttributeViewDeletedBlockTest(t, mode)
			if err := PerformTxSync(tx); err != nil {
				t.Fatal(err)
			}
			entry := GlobalUndoLog.Peek(fixture.sourceID)
			if entry == nil || len(entry.undoOperations) <= len(tx.DoOperations) {
				t.Fatal("database restoration was not recorded after the block operations")
			}
			for range 3 {
				deleted := readAttributeViewItemsTest(t, before.ID)
				for _, primary := range before.GetBlockKeyValues().Values {
					if !primary.IsDetached && deleted.GetBlockValue(primary.BlockID) != nil {
						t.Fatal("deleted block remains in the database")
					}
				}
				replayAttributeViewFieldsTest(t, entry.UndoOperationsForReplay())
				assertAttributeViewFieldsTest(t, before, readAttributeViewItemsTest(t, before.ID))
				tree, err := LoadTreeByBlockID(fixture.sourceID)
				if err != nil {
					t.Fatal(err)
				}
				for _, primary := range before.GetBlockKeyValues().Values {
					if primary.IsDetached {
						continue
					}
					node := treenode.GetNodeInTree(tree, primary.Block.ID)
					if node == nil || !strings.Contains(node.IALAttr(av.NodeAttrNameAvs), before.ID) {
						t.Fatal("restored block lost its database binding")
					}
				}
				replayAttributeViewFieldsTest(t, entry.DoOperationsForReplay())
			}
		})
	}
}

func TestAttributeViewDeletedBlockGroupedUndoRedo(t *testing.T) {
	fixture, before, tx := setupAttributeViewDeletedBlockTest(t, "block")
	groupKey := before.KeyValues[2].Key
	view := before.Views[0]
	view.Table.Columns = append(view.Table.Columns, &av.ViewTableColumn{BaseField: &av.BaseField{ID: groupKey.ID}})
	view.Group = &av.ViewGroup{Field: groupKey.ID, Method: av.GroupMethodValue, Order: av.GroupOrderAsc}
	regenAttrViewGroups(before)
	if err := av.SaveAttributeView(before); err != nil {
		t.Fatal(err)
	}

	boundItemID := before.GetBlockKeyValues().Values[0].BlockID
	if err := PerformTxSync(tx); err != nil {
		t.Fatal(err)
	}
	entry := GlobalUndoLog.Peek(fixture.sourceID)
	if entry == nil {
		t.Fatal("grouped database deletion did not enter the undo log")
	}
	deleted := readAttributeViewItemsTest(t, before.ID)
	if deleted.GetBlockValue(boundItemID) != nil {
		t.Fatal("deleted block remains in the grouped database")
	}
	group := deleted.Views[0].GetGroupByGroupValue("private field contents")
	if group == nil || slices.Contains(group.GroupItemIDs, boundItemID) {
		t.Fatal("grouped database retained the deleted item")
	}

	replayAttributeViewFieldsTest(t, entry.UndoOperationsForReplay())
	restored := readAttributeViewItemsTest(t, before.ID)
	assertAttributeViewFieldsTest(t, before, restored)
	group = restored.Views[0].GetGroupByGroupValue("private field contents")
	if group == nil || !slices.Contains(group.GroupItemIDs, boundItemID) {
		t.Fatal("undo did not restore the grouped item")
	}

	replayAttributeViewFieldsTest(t, entry.DoOperationsForReplay())
	redone := readAttributeViewItemsTest(t, before.ID)
	if redone.GetBlockValue(boundItemID) != nil {
		t.Fatal("redo retained the deleted grouped item")
	}
	group = redone.Views[0].GetGroupByGroupValue("private field contents")
	if group == nil || slices.Contains(group.GroupItemIDs, boundItemID) {
		t.Fatal("redo did not regenerate the grouped items")
	}
}

func TestAttributeViewDeletedBlockWriteFailure(t *testing.T) {
	fixture, before, tx := setupAttributeViewDeletedBlockTest(t, "container")
	tx.writeTransactionTree = func(*parse.Tree) error { return errors.New("injected block write failure") }
	if err := PerformTxSync(tx); err == nil {
		t.Fatal("failed deletion succeeded")
	}
	assertAttributeViewFieldsTest(t, before, readAttributeViewItemsTest(t, before.ID))
	tree, err := LoadTreeByBlockID(fixture.sourceID)
	if err != nil || treenode.GetNodeInTree(tree, tx.DoOperations[0].ID) == nil {
		t.Fatalf("failed deletion did not restore the document: %v", err)
	}
}

func TestAttributeViewDeletedBlockStaticText(t *testing.T) {
	fixture, before, tx := setupAttributeViewDeletedBlockTest(t, "block")
	primary := before.GetBlockKeyValues().Values[0]
	primary.Block.RefSubtype, primary.Block.Content = "s", "Static label"
	tree, err := LoadTreeByBlockID(fixture.sourceID)
	if err != nil {
		t.Fatal(err)
	}
	node := treenode.GetNodeInTree(tree, primary.Block.ID)
	node.SetIALAttr(av.NodeAttrViewStaticText+"-"+before.ID, primary.Block.Content)
	if _, err = filesys.WriteTree(tree); err != nil {
		t.Fatal(err)
	}
	if err = av.SaveAttributeView(before); err != nil {
		t.Fatal(err)
	}
	if err := PerformTxSync(tx); err != nil {
		t.Fatal(err)
	}
	replayAttributeViewFieldsTest(t, GlobalUndoLog.Peek(fixture.sourceID).UndoOperationsForReplay())
	tree, err = LoadTreeByBlockID(fixture.sourceID)
	if err != nil {
		t.Fatal(err)
	}
	node = treenode.GetNodeInTree(tree, primary.Block.ID)
	if got := node.IALAttr(av.NodeAttrViewStaticText + "-" + before.ID); got != primary.Block.Content {
		t.Fatalf("block undo lost the static database text: %q", got)
	}
	assertAttributeViewFieldsTest(t, before, readAttributeViewItemsTest(t, before.ID))
}

func TestAttributeViewDeletedBlockPreservesLaterEdits(t *testing.T) {
	fixture, before, tx := setupAttributeViewDeletedBlockTest(t, "block")
	if err := PerformTxSync(tx); err != nil {
		t.Fatal(err)
	}
	current := readAttributeViewItemsTest(t, before.ID)
	added := before.GetBlockKeyValues().Values[1].Clone()
	added.ID, added.BlockID = ast.NewNodeID(), ast.NewNodeID()
	for _, view := range []*av.AttributeView{before, current} {
		view.Name = "Later database name"
		view.GetBlockKeyValues().Values = append(view.GetBlockKeyValues().Values, added.Clone())
		for _, layout := range view.Views {
			layout.ItemIDs = append(layout.ItemIDs, added.BlockID)
		}
	}
	if err := av.SaveAttributeView(current); err != nil {
		t.Fatal(err)
	}
	replayAttributeViewFieldsTest(t, GlobalUndoLog.Peek(fixture.sourceID).UndoOperationsForReplay())
	assertAttributeViewFieldsTest(t, before, readAttributeViewItemsTest(t, before.ID))
}

func TestAttributeViewDeletedBlockUndoConflict(t *testing.T) {
	fixture, before, tx := setupAttributeViewDeletedBlockTest(t, "block")
	if err := PerformTxSync(tx); err != nil {
		t.Fatal(err)
	}
	current := readAttributeViewItemsTest(t, before.ID)
	current.KeyValues[2].Key.Type = av.KeyTypeNumber
	if err := av.SaveAttributeView(current); err != nil {
		t.Fatal(err)
	}
	if err := PerformTxSync(&Transaction{DoOperations: GlobalUndoLog.Peek(fixture.sourceID).UndoOperationsForReplay(), isReplay: true}); err == nil {
		t.Fatal("undo overwrote a changed field type")
	}
	assertAttributeViewFieldsTest(t, current, readAttributeViewItemsTest(t, before.ID))
	tree, err := LoadTreeByBlockID(fixture.sourceID)
	if err != nil || treenode.GetNodeInTree(tree, tx.DoOperations[0].ID) != nil {
		t.Fatalf("failed undo left a partially restored block: %v", err)
	}
}

func TestAttributeViewDeletedBlockUndoRelations(t *testing.T) {
	for _, self := range []bool{false, true} {
		t.Run(map[bool]string{false: "other database", true: "same database"}[self], func(t *testing.T) {
			fixture, source, tx := setupAttributeViewDeletedBlockTest(t, "container")
			dest, backID, targetID := addDeletedBlockTestRelation(t, source, self)
			keptID := source.GetBlockKeyValues().Values[2].BlockID
			back := dest.GetValue(backID, targetID)
			back.Relation.BlockIDs = append([]string{keptID}, back.Relation.BlockIDs...)
			if err := av.SaveAttributeView(dest); err != nil {
				t.Fatal(err)
			}
			if err := PerformTxSync(tx); err != nil {
				t.Fatal(err)
			}
			entry := GlobalUndoLog.Peek(fixture.sourceID)
			for range 2 {
				back := readAttributeViewItemsTest(t, dest.ID).GetValue(backID, targetID)
				if !slices.Equal(back.Relation.BlockIDs, []string{keptID}) {
					t.Fatalf("deletion retained stale back relations: %v", back.Relation.BlockIDs)
				}
				for _, id := range []string{source.ID, dest.ID} {
					rendered := readAttributeViewItemsTest(t, id)
					for _, view := range rendered.Views {
						sql.RenderView(rendered, view, "", false)
					}
					if err := av.SaveAttributeView(rendered); err != nil {
						t.Fatal(err)
					}
				}
				replayAttributeViewFieldsTest(t, entry.UndoOperationsForReplay())
				assertAttributeViewFieldsTest(t, source, readAttributeViewItemsTest(t, source.ID))
				back = readAttributeViewItemsTest(t, dest.ID).GetValue(backID, targetID)
				if !slices.Equal(back.Relation.BlockIDs, dest.GetValue(backID, targetID).Relation.BlockIDs) {
					t.Fatal("block undo did not restore the back relation")
				}
				replayAttributeViewFieldsTest(t, entry.DoOperationsForReplay())
			}
		})
	}
}

func addDeletedBlockTestRelation(t *testing.T, source *av.AttributeView, self bool) (*av.AttributeView, string, string) {
	t.Helper()
	dest := av.NewAttributeView(ast.NewNodeID())
	if self {
		dest = source
	} else {
		primary := source.GetBlockKeyValues().Values[3].Clone()
		primary.ID, primary.KeyID, primary.BlockID = ast.NewNodeID(), dest.GetBlockKeyValues().Key.ID, ast.NewNodeID()
		dest.GetBlockKeyValues().Values = []*av.Value{primary}
	}
	targetID := dest.GetBlockKeyValues().Values[len(dest.GetBlockKeyValues().Values)-1].BlockID
	keyID, backID := ast.NewNodeID(), ast.NewNodeID()
	relation := &av.KeyValues{Key: &av.Key{ID: keyID, Type: av.KeyTypeRelation,
		Relation: &av.Relation{AvID: dest.ID, IsTwoWay: true, BackKeyID: backID}}}
	var itemIDs []string
	for _, primary := range source.GetBlockKeyValues().Values[:2] {
		itemIDs = append(itemIDs, primary.BlockID)
		relation.Values = append(relation.Values, &av.Value{ID: ast.NewNodeID(), KeyID: keyID, BlockID: primary.BlockID,
			Type: av.KeyTypeRelation, Relation: &av.ValueRelation{BlockIDs: []string{targetID}}})
	}
	back := &av.KeyValues{Key: &av.Key{ID: backID, Type: av.KeyTypeRelation,
		Relation: &av.Relation{AvID: source.ID, IsTwoWay: true, BackKeyID: keyID}},
		Values: []*av.Value{{ID: ast.NewNodeID(), KeyID: backID, BlockID: targetID,
			Type: av.KeyTypeRelation, Relation: &av.ValueRelation{BlockIDs: itemIDs}}}}
	source.KeyValues = append(source.KeyValues, relation)
	dest.KeyValues = append(dest.KeyValues, back)
	for _, view := range []*av.AttributeView{source, dest} {
		if err := av.SaveAttributeView(view); err != nil {
			t.Fatal(err)
		}
	}
	av.UpsertAvBackRel(source.ID, dest.ID)
	av.UpsertAvBackRel(dest.ID, source.ID)
	return dest, backID, targetID
}

func TestAttributeViewDeletedBlockRelationsWriteFailure(t *testing.T) {
	fixture, source, tx := setupAttributeViewDeletedBlockTest(t, "container")
	dest, _, _ := addDeletedBlockTestRelation(t, source, false)
	tx.writeTransactionTree = func(*parse.Tree) error { return errors.New("injected document write failure") }
	if err := PerformTxSync(tx); err == nil {
		t.Fatal("failed deletion succeeded")
	}
	assertAttributeViewFieldsTest(t, source, readAttributeViewItemsTest(t, source.ID))
	assertAttributeViewFieldsTest(t, dest, readAttributeViewItemsTest(t, dest.ID))
	tree, err := LoadTreeByBlockID(fixture.sourceID)
	if err != nil || treenode.GetNodeInTree(tree, tx.DoOperations[0].ID) == nil {
		t.Fatalf("failed deletion did not restore the document: %v", err)
	}
}

func TestAttributeViewDeletedBlockOneWayRelations(t *testing.T) {
	fixture, source, tx := setupAttributeViewDeletedBlockTest(t, "block")
	dest, backID, targetID := addDeletedBlockTestRelation(t, source, false)
	for _, view := range []*av.AttributeView{source, dest} {
		for _, kv := range view.KeyValues {
			if kv.Key.Relation != nil {
				kv.Key.Relation.IsTwoWay = false
			}
		}
		if err := av.SaveAttributeView(view); err != nil {
			t.Fatal(err)
		}
	}
	if err := PerformTxSync(tx); err != nil {
		t.Fatal(err)
	}
	got := readAttributeViewItemsTest(t, dest.ID).GetValue(backID, targetID).Relation.BlockIDs
	expected := dest.GetValue(backID, targetID).Relation.BlockIDs[1:]
	if !slices.Equal(got, expected) {
		t.Fatalf("one-way relation retained a deleted entry: %v", got)
	}
	replayAttributeViewFieldsTest(t, GlobalUndoLog.Peek(fixture.sourceID).UndoOperationsForReplay())
	assertAttributeViewFieldsTest(t, source, readAttributeViewItemsTest(t, source.ID))
	assertAttributeViewFieldsTest(t, dest, readAttributeViewItemsTest(t, dest.ID))
}

func setupAttributeViewDeletedBlockTest(t *testing.T, mode string) (*fileOperationTestFixture, *av.AttributeView, *Transaction) {
	t.Helper()
	fixture, source, _, _ := setupAttributeViewItemsTest(t, false)
	tree, err := LoadTreeByBlockID(fixture.sourceID)
	if err != nil {
		t.Fatal(err)
	}
	var nodes []*ast.Node
	count := 1
	switch mode {
	case "container":
		count = 2
	case "batch":
		count = 32
	}
	for i := 0; i < count; i++ {
		node := treenode.NewParagraph(ast.NewNodeID())
		node.AppendChild(&ast.Node{Type: ast.NodeText, Tokens: []byte("Bound paragraph")})
		if i < len(source.GetBlockKeyValues().Values) {
			primary := source.GetBlockKeyValues().Values[i]
			primary.IsDetached, primary.Block.ID = false, node.ID
			primary.Block.Content, primary.Block.RefSubtype = "Bound paragraph", "d"
			node.SetIALAttr(av.NodeAttrNameAvs, source.ID)
		}
		tree.Root.AppendChild(node)
		nodes = append(nodes, node)
	}
	if mode == "container" {
		container := &ast.Node{Type: ast.NodeBlockquote, ID: ast.NewNodeID()}
		container.SetIALAttr("id", container.ID)
		tree.Root.AppendChild(container)
		for _, node := range nodes {
			node.Unlink()
			container.AppendChild(node)
		}
		nodes = []*ast.Node{container}
	}
	if _, err = filesys.WriteTree(tree); err != nil {
		t.Fatal(err)
	}
	treenode.UpsertBlockTree(tree)
	sql.IndexTreeQueue(tree)
	sql.FlushQueue()
	if err = av.SaveAttributeView(source); err != nil {
		t.Fatal(err)
	}
	tx := &Transaction{fromAPI: true}
	for _, node := range nodes {
		tx.DoOperations = append(tx.DoOperations, &Operation{Action: "delete", ID: node.ID})
		tx.UndoOperations = append(tx.UndoOperations, &Operation{Action: "insert", ID: node.ID,
			PreviousID: node.Previous.ID, Data: GetBlockDOM(node.ID)})
	}
	return fixture, readAttributeViewItemsTest(t, source.ID), tx
}