Skip to content

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

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

package api

import (
	"bytes"
	"encoding/json"
	"image"
	"image/png"
	"io"
	"mime/multipart"
	"net/http"
	"net/http/httptest"
	"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 TestAPIContractOCREncryptedAssetAliases(t *testing.T) {
	setupAssetContractWorkspace(t)
	const boxID = "20261001010000-abcdefg"
	directory := filepath.Join(util.DataDir, boxID, ".siyuan")
	if err := os.MkdirAll(directory, 0755); err != nil {
		t.Fatal(err)
	}
	box := conf.NewBoxConf()
	box.Encrypted = true
	content, err := json.Marshal(box)
	if err != nil {
		t.Fatal(err)
	}
	if err = os.WriteFile(filepath.Join(directory, "conf.json"), content, 0600); err != nil {
		t.Fatal(err)
	}
	const path = "assets/missing-encrypted.png"
	util.SetAssetText(path, "ordinary text")
	t.Cleanup(func() { util.RemoveAssetText(path) })
	engine := gin.New()
	engine.POST("/api/asset/getImageOCRText", getImageOCRText)
	engine.POST("/api/asset/setImageOCRText", setImageOCRText)
	engine.POST("/api/asset/ocr", ocr)
	for _, suffix := range []string{"?box=" + boxID, "?box=" + boxID + "#fragment"} {
		for _, route := range []string{"getImageOCRText", "setImageOCRText", "ocr"} {
			body, _ := json.Marshal(map[string]string{"path": path + suffix, "text": "private text"})
			recorder := httptest.NewRecorder()
			url := "/api/asset/" + route
			engine.ServeHTTP(recorder, httptest.NewRequest("POST", url, bytes.NewReader(body)))
			requireAPIContract(t, "POST", url, recorder)
			var response struct {
				Code int
				Data struct {
					Text   string
					Failed bool
				}
			}
			if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Data.Text != "" || response.Data.Failed || (route == "ocr" && response.Code == 0) {
				t.Fatalf("encrypted OCR alias: %s, %v", recorder.Body.String(), err)
			}
			if util.GetAssetText(path) != "ordinary text" {
				t.Fatal("encrypted OCR write changed shared text")
			}
		}
	}
}

func TestAPIContractOCRNotebookIsolation(t *testing.T) {
	assets := setupAssetContractWorkspace(t)
	const name = "ocr-notebook-contract.png"
	const path = "assets/" + name
	const firstBox = "20261001021001-abcdefg"
	const secondBox = "20261001021002-abcdefg"
	boxConfig, err := json.Marshal(conf.NewBoxConf())
	if err != nil {
		t.Fatal(err)
	}
	for _, boxID := range []string{firstBox, secondBox} {
		for name, content := range map[string][]byte{".siyuan/conf.json": boxConfig, path: []byte(boxID)} {
			filename := filepath.Join(util.DataDir, boxID, filepath.FromSlash(name))
			if err = os.MkdirAll(filepath.Dir(filename), 0755); err != nil {
				t.Fatal(err)
			}
			if err = os.WriteFile(filename, content, 0644); err != nil {
				t.Fatal(err)
			}
		}
	}
	if err = os.WriteFile(filepath.Join(assets, name), []byte("global image"), 0644); err != nil {
		t.Fatal(err)
	}
	engine := gin.New()
	engine.POST("/api/asset/setImageOCRText", setImageOCRText)
	engine.POST("/api/asset/getImageOCRText", getImageOCRText)
	results := map[string]string{path: "global OCR", path + "?box=" + firstBox: "first notebook OCR", path + "?box=" + secondBox: "second notebook OCR"}
	for reference, text := range results {
		t.Cleanup(func() { util.RemoveAssetText(reference) })
		body, _ := json.Marshal(map[string]string{"path": reference + "#preview", "text": text})
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/setImageOCRText", bytes.NewReader(body)))
		requireAPIContract(t, "POST", "/api/asset/setImageOCRText", recorder)
		var response struct{ Code int }
		if err = json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 0 {
			t.Fatalf("set OCR: %s, %v", recorder.Body.String(), err)
		}
	}
	for reference, want := range results {
		body, _ := json.Marshal(map[string]string{"path": reference + "#different-preview"})
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/getImageOCRText", bytes.NewReader(body)))
		requireAPIContract(t, "POST", "/api/asset/getImageOCRText", recorder)
		var response struct {
			Code int
			Data apicontract.AssetTextData
		}
		if err = json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 0 || response.Data.Text != want {
			t.Fatalf("get OCR for %s: %s, %v", reference, recorder.Body.String(), err)
		}
	}
}

func TestAPIContractOCRPermissions(t *testing.T) {
	setupAssetContractWorkspace(t)
	previousReadOnly := util.ReadOnly
	t.Cleanup(func() { util.ReadOnly = previousReadOnly })
	for _, route := range []struct {
		path    string
		write   bool
		handler gin.HandlerFunc
	}{
		{"/api/asset/getOCRConfig", false, getOCRConfig},
		{"/api/asset/setOCRConfig", true, setOCRConfig},
		{"/api/asset/importOCRModels", true, importOCRModels},
		{"/api/ai/ocr", true, aiOCR},
	} {
		for _, role := range []model.Role{model.RoleReader, model.RoleEditor, model.RoleAdministrator} {
			for _, readonly := range []bool{false, true} {
				util.ReadOnly = readonly
				called := false
				engine := gin.New()
				engine.Use(func(c *gin.Context) { c.Set(model.RoleContextKey, role) })
				handlers := []gin.HandlerFunc{model.CheckAuth, model.CheckAdminRole}
				if route.write {
					handlers = append(handlers, model.CheckReadonly)
				}
				handlers = append(handlers, func(c *gin.Context) { called = true; route.handler(c) })
				engine.POST(route.path, handlers...)
				engine.ServeHTTP(httptest.NewRecorder(), httptest.NewRequest("POST", route.path, strings.NewReader(`{}`)))
				if called != (role == model.RoleAdministrator && (!readonly || !route.write)) {
					t.Fatalf("unexpected authorization: %s, %v, readonly=%v, called=%v", route.path, role, readonly, called)
				}
			}
		}
	}
}

func TestAPIContractOCRNativeImportAndHeadlessRecognition(t *testing.T) {
	models := os.Getenv("SIYUAN_OCR_TEST_ASSETS")
	if models == "" || os.Getenv("SIYUAN_OCR_TEST_LIBRARY") == "" {
		t.Skip("native OCR resources are not configured")
	}
	assets := setupAssetContractWorkspace(t)
	previousWorking, previousTemp, previousConf := util.WorkingDir, util.TempDir, util.ConfDir
	util.WorkingDir = filepath.Dir(filepath.Dir(filepath.Dir(models)))
	util.TempDir, util.ConfDir = t.TempDir(), t.TempDir()
	t.Cleanup(func() { util.WorkingDir, util.TempDir, util.ConfDir = previousWorking, previousTemp, previousConf })
	model.Conf.OCR.Store(&conf.OCR{Provider: "paddleocr", Model: "tiny", Auto: true})
	engine := gin.New()
	engine.POST("/api/asset/importOCRModels", importOCRModels)
	engine.POST("/api/asset/ocr", ocr)
	connection := connectSettingNotifications(t, engine)
	upload := func(invalid bool) apicontract.OCRModel {
		t.Helper()
		var body bytes.Buffer
		writer := multipart.NewWriter(&body)
		for field, name := range map[string]string{"detector": "det/inference.onnx", "detectorConfig": "det/inference.yml", "recognizer": "rec/inference.onnx", "recognizerConfig": "rec/inference.yml"} {
			part, err := writer.CreateFormFile(field, "../../untrusted-"+filepath.Base(name))
			if err != nil {
				t.Fatal(err)
			}
			if invalid && field == "recognizer" {
				_, err = part.Write([]byte("invalid ONNX"))
			} else {
				file, openErr := os.Open(filepath.Join(models, "tiny", filepath.FromSlash(name)))
				if openErr != nil {
					t.Fatal(openErr)
				}
				_, err = io.Copy(part, file)
				file.Close()
			}
			if err != nil {
				t.Fatal(err)
			}
		}
		if err := writer.Close(); err != nil {
			t.Fatal(err)
		}
		request := httptest.NewRequest("POST", "/api/asset/importOCRModels", &body)
		request.Header.Set("Content-Type", writer.FormDataContentType())
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, request)
		if request.MultipartForm != nil {
			defer request.MultipartForm.RemoveAll()
		}
		requireAPIContract(t, "POST", request.URL.Path, recorder)
		var response struct {
			Code int
			Data apicontract.OCRModel
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
			t.Fatal(err)
		}
		if (response.Code != 0) != invalid {
			t.Fatalf("import: %s", recorder.Body.String())
		}
		return response.Data
	}
	imported := upload(false)
	if err := connection.SetReadDeadline(time.Now().Add(5 * time.Second)); err != nil {
		t.Fatal(err)
	}
	var notification struct{ Cmd string }
	if err := connection.ReadJSON(&notification); err != nil || notification.Cmd != "ocrChanged" {
		t.Fatalf("model import notification: %+v, %v", notification, err)
	}
	if len(imported.ID) != 64 || imported.BuiltIn {
		t.Fatalf("invalid model result: %+v", imported)
	}
	if duplicate := upload(false); duplicate.ID != imported.ID {
		t.Fatal("duplicate upload changed model identity")
	}
	if err := model.Conf.SetOCR(conf.OCR{Provider: "paddleocr", Model: imported.ID, Auto: true}); err != nil {
		t.Fatal(err)
	}
	file, err := os.Create(filepath.Join(assets, "headless.png"))
	if err != nil {
		t.Fatal(err)
	}
	if err = png.Encode(file, image.NewRGBA(image.Rect(0, 0, 100, 100))); err != nil {
		t.Fatal(err)
	}
	file.Close()
	recorder := httptest.NewRecorder()
	engine.ServeHTTP(recorder, httptest.NewRequest(http.MethodPost, "/api/asset/ocr", strings.NewReader(`{"path":"assets/headless.png"}`)))
	requireAPIContract(t, "POST", "/api/asset/ocr", recorder)
	var result struct {
		Code int
		Data apicontract.AssetOCRData
	}
	if err = json.Unmarshal(recorder.Body.Bytes(), &result); err != nil || result.Code != 0 || result.Data.OCRJSON == nil {
		t.Fatalf("headless API: %s, %v", recorder.Body.String(), err)
	}
	if !util.ExistsAssetText("assets/headless.png") {
		t.Fatal("successful empty result was not saved")
	}
	t.Cleanup(func() { util.RemoveAssetText("assets/headless.png") })
	upload(true)
	entries, err := os.ReadDir(filepath.Join(util.DataDir, "ocr", "models"))
	if err != nil || len(entries) != 1 {
		t.Fatalf("invalid import published files: %v, %v", entries, err)
	}
	entries, err = os.ReadDir(util.TempDir)
	if err != nil || len(entries) != 0 {
		t.Fatalf("import leaked staging files: %v, %v", entries, err)
	}
}

func TestAPIContractOCRSettings(t *testing.T) {
	setupAssetContractWorkspace(t)
	previousConfDir := util.ConfDir
	util.ConfDir = t.TempDir()
	t.Cleanup(func() { util.ConfDir = previousConfDir })
	engine := gin.New()
	engine.POST("/api/asset/getOCRConfig", getOCRConfig)
	engine.POST("/api/asset/setOCRConfig", setOCRConfig)
	get := httptest.NewRecorder()
	engine.ServeHTTP(get, httptest.NewRequest("POST", "/api/asset/getOCRConfig", strings.NewReader(`{}`)))
	requireAPIContract(t, "POST", "/api/asset/getOCRConfig", get)
	var result struct{ Data apicontract.OCRConfigData }
	if err := json.Unmarshal(get.Body.Bytes(), &result); err != nil {
		t.Fatal(err)
	}
	if result.Data.Config.Provider != "paddleocr" || result.Data.Config.Model != "tiny" || result.Data.Config.Auto || len(result.Data.Models) != 1 || result.Data.Models[0].ID != "tiny" || !result.Data.Models[0].BuiltIn || len(result.Data.Providers) != 2 {
		t.Fatalf("unexpected defaults: %+v", result.Data)
	}
	path := "assets/preserved.png"
	util.SetAssetText(path, "existing text")
	t.Cleanup(func() { util.RemoveAssetText(path) })
	for _, test := range []struct {
		body    string
		success bool
	}{
		{`{"provider":"tesseract","model":"tiny","auto":false}`, true},
		{`{"provider":"tesseract","model":"small","auto":false}`, true},
		{`{"provider":"unknown","model":"tiny","auto":true}`, false},
		{`{"provider":"paddleocr","model":"../../outside","auto":true}`, false},
		{`{"provider":"tesseract","model":"tiny","auto":"false"}`, false},
		// 合并写入:省略的必填字段取当前配置,请求仍可成功
		{`{"provider":"tesseract","model":"tiny"}`, true},
	} {
		previousRevision := model.ConfSettingRevision.Load()
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/setOCRConfig", strings.NewReader(test.body)))
		requireAPIContract(t, "POST", "/api/asset/setOCRConfig", recorder)
		var response struct {
			Code int
			Data *apicontract.SettingOCR
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
			t.Fatal(err)
		}
		if (response.Code == 0) != test.success {
			t.Fatalf("body=%s response=%s", test.body, recorder.Body.String())
		}
		if test.success && (response.Data == nil || response.Data.Model != "tiny" || model.Conf.GetOCR().Model != "tiny") {
			t.Fatalf("legacy model was not normalized in response and configuration: %s", recorder.Body.String())
		}
		expectedRevision := previousRevision
		if test.success {
			expectedRevision++
		}
		if model.ConfSettingRevision.Load() != expectedRevision {
			t.Fatalf("OCR setting revision: got %d, want %d", model.ConfSettingRevision.Load(), expectedRevision)
		}
		if util.GetAssetText(path) != "existing text" {
			t.Fatal("configuration update changed existing OCR text")
		}
	}
	data, err := os.ReadFile(filepath.Join(util.ConfDir, "conf.json"))
	if err != nil {
		t.Fatal(err)
	}
	var saved struct {
		OCR conf.OCR `json:"ocr"`
	}
	if err = json.Unmarshal(data, &saved); err != nil {
		t.Fatal(err)
	}
	if saved.OCR.Auto || saved.OCR.Model != "tiny" {
		t.Fatalf("settings were not persisted: %+v", saved.OCR)
	}
}

func TestAPIContractOCRThresholdPersistence(t *testing.T) {
	setupAssetContractWorkspace(t)
	previousConfDir := util.ConfDir
	util.ConfDir = t.TempDir()
	t.Cleanup(func() { util.ConfDir = previousConfDir })
	engine := gin.New()
	engine.POST("/api/asset/setOCRConfig", setOCRConfig)
	path := "assets/threshold-preserved.png"
	util.SetAssetText(path, "existing result")
	t.Cleanup(func() { util.RemoveAssetText(path) })
	for _, test := range []struct {
		fields  string
		success bool
		custom  bool
	}{
		{`,"thresholds":{"detection":0.4,"box":0.7,"recognition":0.9}`, true, true},
		// 省略的阈值保持当前值
		{"", true, true},
		{`,"thresholds":{"detection":0,"box":0.7,"recognition":0.9}`, false, true},
		{`,"thresholds":{"detection":0.4,"box":1,"recognition":0.9}`, false, true},
		{`,"thresholds":{"detection":0.4,"box":0.7,"recognition":1.1}`, false, true},
		// null 表示恢复默认值
		{`,"thresholds":{"detection":null,"box":null,"recognition":null}`, true, false},
		{`,"thresholds":null`, true, false},
	} {
		body := `{"provider":"tesseract","model":"tiny","auto":false` + test.fields + `}`
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/setOCRConfig", strings.NewReader(body)))
		requireAPIContract(t, "POST", "/api/asset/setOCRConfig", recorder)
		var response struct {
			Code int
			Data *apicontract.SettingOCR
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
			t.Fatal(err)
		}
		if (response.Code == 0) != test.success {
			t.Fatalf("%s: %s", body, recorder.Body.String())
		}
		got := model.Conf.GetOCR().Thresholds
		if test.custom {
			if got.Detection == nil || *got.Detection != 0.4 || got.Box == nil || *got.Box != 0.7 || got.Recognition == nil || *got.Recognition != 0.9 {
				t.Fatalf("saved thresholds lost for %q: %+v", test.fields, got)
			}
		} else if got != (conf.OCRThresholds{}) {
			t.Fatalf("reset did not restore defaults for %q: %+v", test.fields, got)
		}
		persisted, err := os.ReadFile(filepath.Join(util.ConfDir, "conf.json"))
		if err != nil {
			t.Fatal(err)
		}
		var saved struct{ OCR conf.OCR }
		if err = json.Unmarshal(persisted, &saved); err != nil {
			t.Fatal(err)
		}
		want, _ := json.Marshal(got)
		actual, _ := json.Marshal(saved.OCR.Thresholds)
		if !bytes.Equal(want, actual) {
			t.Fatalf("persisted thresholds %s != %s", actual, want)
		}
		if test.success {
			actual, _ = json.Marshal(response.Data.Thresholds)
			if !bytes.Equal(want, actual) {
				t.Fatalf("response lost thresholds: %s", actual)
			}
		}
		if util.GetAssetText(path) != "existing result" {
			t.Fatal("threshold update rewrote existing OCR")
		}
	}
}

// connectSettingNotifications 建立 main 会话并返回可读取推送的连接,供各设置通知测试共用。
func connectSettingNotifications(t *testing.T, engine *gin.Engine) *websocket.Conn {
	t.Helper()
	push := melody.New()
	connected := make(chan *melody.Session, 1)
	push.HandleConnect(func(session *melody.Session) {
		util.AddPushChan(session)
		connected <- session
	})
	push.HandleDisconnect(util.RemovePushChan)
	engine.GET("/ws", func(c *gin.Context) { _ = push.HandleRequest(c.Writer, c.Request) })
	server := httptest.NewServer(engine)
	t.Cleanup(func() { push.Close(); server.Close() })
	endpoint := "ws" + strings.TrimPrefix(server.URL, "http") + "/ws?app=" + t.Name() + "&id=settings-notifications&type=main"
	connection, response, err := websocket.DefaultDialer.Dial(endpoint, 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("settings WebSocket did not connect")
	}
	return connection
}

func TestAPIContractOCRSettingsNotifications(t *testing.T) {
	setupAssetContractWorkspace(t)
	previousConfDir := util.ConfDir
	util.ConfDir = t.TempDir()
	t.Cleanup(func() { util.ConfDir = previousConfDir })
	engine := gin.New()
	engine.POST("/api/asset/setOCRConfig", setOCRConfig)
	connection := connectSettingNotifications(t, engine)
	for _, auto := range []bool{true, false} {
		body, err := json.Marshal(apicontract.SettingOCR{Provider: "tesseract", Model: "tiny", Auto: auto})
		if err != nil {
			t.Fatal(err)
		}
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/setOCRConfig", bytes.NewReader(body)))
		requireAPIContract(t, "POST", "/api/asset/setOCRConfig", recorder)
		if err = connection.SetReadDeadline(time.Now().Add(5 * time.Second)); err != nil {
			t.Fatal(err)
		}
		var event struct {
			Cmd  string
			Data map[string]json.RawMessage
		}
		if err = connection.ReadJSON(&event); err != nil {
			t.Fatal(err)
		}
		if event.Cmd != "settingChanged" || string(event.Data["namespace"]) != `"ocr"` || len(event.Data) != 2 {
			t.Fatalf("OCR update must only notify its configuration namespace: %+v", event)
		}
	}
}

func TestAPIContractOCRFailurePreservesText(t *testing.T) {
	assets := setupAssetContractWorkspace(t)
	path := "assets/failure.png"
	if err := os.WriteFile(filepath.Join(assets, "failure.png"), []byte("invalid image"), 0644); err != nil {
		t.Fatal(err)
	}
	model.Conf.OCR.Store(&conf.OCR{Provider: "paddleocr", Model: "tiny"})
	util.SetAssetText(path, "previous result")
	t.Cleanup(func() { util.RemoveAssetText(path) })
	engine := gin.New()
	engine.POST("/api/asset/ocr", ocr)
	engine.POST("/api/asset/getImageOCRText", getImageOCRText)
	engine.POST("/api/asset/setImageOCRText", setImageOCRText)
	recorder := httptest.NewRecorder()
	engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/asset/ocr", strings.NewReader(`{"path":"assets/failure.png"}`)))
	requireAPIContract(t, "POST", "/api/asset/ocr", recorder)
	var response struct{ Code int }
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
		t.Fatal(err)
	}
	if response.Code == 0 || util.GetAssetText(path) != "previous result" {
		t.Fatalf("failed OCR replaced text: %s", recorder.Body.String())
	}
	var result apicontract.ImageOCRTextData
	if requestOCRProvider(t, engine, "/api/asset/getImageOCRText", `{"path":"assets/failure.png#preview"}`, &result) != 0 ||
		result.Text != "previous result" || !result.Failed {
		t.Fatalf("recognition failure was not reported with saved text: %+v", result)
	}
	if requestOCRProvider(t, engine, "/api/asset/getImageOCRText", `{}`, &result) != 0 || result.Text != "" || result.Failed {
		t.Fatalf("missing path inherited a failure: %+v", result)
	}
	if requestOCRProvider(t, engine, "/api/asset/setImageOCRText", `{"path":"assets/failure.png#preview","text":""}`, nil) != 0 {
		t.Fatal("saving empty text failed")
	}
	if requestOCRProvider(t, engine, "/api/asset/getImageOCRText", `{"path":"assets/failure.png"}`, &result) != 0 ||
		result.Text != "" || result.Failed {
		t.Fatalf("empty saved text retained a recognition failure: %+v", result)
	}
}