Skip to content

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

18.9 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"
	"context"
	"encoding/json"
	"io"
	"mime/multipart"
	"net/http"
	"net/http/httptest"
	"reflect"
	"strings"
	"testing"
	"time"

	ginSessions "github.com/gin-contrib/sessions"
	"github.com/gin-contrib/sessions/cookie"
	"github.com/gin-gonic/gin"
	"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 systemContractRequest(t *testing.T, method, route string, handler gin.HandlerFunc, body io.Reader) *httptest.ResponseRecorder {
	t.Helper()
	gin.SetMode(gin.TestMode)
	router := gin.New()
	router.Use(ginSessions.Sessions("system-contract", cookie.NewStore([]byte("system-contract-session-key"))))
	router.Handle(method, "/api/system/"+route, handler)
	recorder := httptest.NewRecorder()
	request := httptest.NewRequest(method, "/api/system/"+route, body)
	request.Header.Set("Content-Type", "application/json")
	router.ServeHTTP(recorder, request)
	requireAPIContract(t, method, "/api/system/"+route, recorder)
	return recorder
}

func TestAPIContractSystemCompleteConfiguration(t *testing.T) {
	for _, populated := range []bool{false, true} {
		source := new(model.AppConf)
		if populated {
			fillSettingPayload(reflect.ValueOf(source).Elem())
		}
		payload, err := systemConfPayload(source)
		if err != nil {
			t.Fatal(err)
		}
		before, err := json.Marshal(source)
		if err != nil {
			t.Fatal(err)
		}
		after, err := json.Marshal(payload)
		if err != nil {
			t.Fatal(err)
		}
		// 配置字段顺序不属于 JSON 契约,递归比较字段和值。
		var sourceJSON, payloadJSON any
		decoder := json.NewDecoder(bytes.NewReader(before))
		decoder.UseNumber()
		if err := decoder.Decode(&sourceJSON); err != nil {
			t.Fatal(err)
		}
		decoder = json.NewDecoder(bytes.NewReader(after))
		decoder.UseNumber()
		if err := decoder.Decode(&payloadJSON); err != nil {
			t.Fatal(err)
		}
		delete(sourceJSON.(map[string]any), "confVersion")
		if _, exposed := payloadJSON.(map[string]any)["confVersion"]; exposed {
			t.Fatal("internal configuration version was exposed")
		}
		if !reflect.DeepEqual(sourceJSON, payloadJSON) {
			t.Fatalf("complete configuration changed:\n%s\n%s", before, after)
		}
		body, err := json.Marshal(apicontract.Success(apicontract.SystemConfData{Conf: payload}))
		if err != nil {
			t.Fatal(err)
		}
		recorder := httptest.NewRecorder()
		recorder.Header().Set("Content-Type", "application/json")
		recorder.Write(body)
		requireAPIContract(t, "POST", "/api/system/getConf", recorder)
	}
	compareSettingPayload(t, "", systemOnboardingPayload)
	compareSettingPayload(t, "", systemFontPayload)
	compareSettingPayload(t, "", systemCustomFontPayload)
}

func TestAPIContractSystemDownloadUpdate(t *testing.T) {
	previousConf := model.Conf
	model.Conf = model.NewAppConf()
	t.Cleanup(func() { model.Conf = previousConf })
	for _, body := range []string{`{}`, `{"version":null}`, `{"version":42}`, `{"version":""}`} {
		recorder := systemContractRequest(t, "POST", "downloadUpdate", downloadUpdate, strings.NewReader(body))
		var result struct {
			Code int `json:"code"`
			Data any `json:"data"`
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &result); err != nil {
			t.Fatal(err)
		}
		if result.Code != -1 || result.Data != nil {
			t.Fatalf("invalid update version accepted: %s", recorder.Body.String())
		}
	}
}

func TestAPIContractSystemRuntimeInfo(t *testing.T) {
	previousWorkspace, previousContainer := util.WorkspaceDir, util.Container
	util.WorkspaceDir = "/private/runtime-info-workspace"
	util.Container = "android"
	t.Cleanup(func() { util.WorkspaceDir, util.Container = previousWorkspace, previousContainer })
	for _, body := range []string{"", "{}"} {
		recorder := systemContractRequest(t, "POST", "getRuntimeInfo", getRuntimeInfo, strings.NewReader(body))
		var result struct {
			Code int                               `json:"code"`
			Data apicontract.SystemRuntimeInfoData `json:"data"`
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &result); err != nil {
			t.Fatal(err)
		}
		if result.Code != 0 {
			t.Fatalf("runtime info failed: %s", recorder.Body.String())
		}
		for _, field := range []string{"SiYuan " + util.Ver, "Kernel:", "Kernel OS:", "CPU logical cores:", "System memory:", "Kernel memory (RSS):", "Kernel Go heap:", "Workspace storage: unknown"} {
			if !strings.Contains(result.Data.Text, field) {
				t.Errorf("missing diagnostic field %q: %s", field, result.Data.Text)
			}
		}
		if strings.Contains(result.Data.Text, util.WorkspaceDir) {
			t.Fatal("runtime info exposes workspace path")
		}
	}
}

func TestAPIContractSystemOIDCStructCompatibility(t *testing.T) {
	for _, body := range []string{`null`, `{}`, `{"Scopes":null,"claimRules":[null,{"values":[null]}]}`, `{"provider":"google","unknown":1e1000}`, `{"clientID":17}`, `{"claimRules":{}}`, `{} {}`, ``} {
		before := conf.NewOIDC()
		beforeErr := json.NewDecoder(strings.NewReader(body)).Decode(before)
		request, err := apicontract.SystemSetOIDC.Decode(strings.NewReader(body))
		if err != nil {
			t.Fatal(err)
		}
		if (beforeErr == nil) != (request.ParseError() == nil) {
			t.Fatalf("OIDC struct binding changed for %s: %v / %v", body, beforeErr, request.ParseError())
		}
		if beforeErr == nil && !reflect.DeepEqual(before, model.SystemOIDCConfig(request.SystemOIDC)) {
			t.Fatalf("OIDC default, null or field matching changed for %s", body)
		}
	}
}

func TestAPIContractSystemExitCompatibility(t *testing.T) {
	previousClose, previousFinish, previousConf := closeSystem, finishSystemExit, model.Conf
	model.Conf = model.NewAppConf()
	t.Cleanup(func() { closeSystem, finishSystemExit, model.Conf = previousClose, previousFinish, previousConf })
	for _, code := range []int{0, 1, 2} {
		for _, body := range []string{`{}`, `{"recoverExit":null}`, `{"force":true,"execInstallPkg":2.9,"setCurrentWorkspace":false}`} {
			called := false
			finished := false
			finishSystemExit = func() { finished = true }
			closeSystem = func(ctx context.Context, force, current bool, install int) (int, string) {
				called = true
				defaults := body == `{}` || body == `{"recoverExit":null}`
				if defaults && (force || !current || install != 0) || !defaults && (!force || current || install != 2) {
					t.Fatalf("exit defaults or numeric truncation changed: %v %v %d", force, current, install)
				}
				return code, "installer"
			}
			recorder := systemContractRequest(t, "POST", "exit", exit, strings.NewReader(body))
			if finished != (code == 0) {
				t.Fatalf("server shutdown changed for exit code %d: %v", code, finished)
			}
			var result struct {
				Code int                        `json:"code"`
				Data apicontract.SystemExitData `json:"data"`
			}
			if err := json.Unmarshal(recorder.Body.Bytes(), &result); err != nil || !called || result.Code != code || result.Data.InstallPkgPath != "installer" || result.Data.CloseTimeout != 0 {
				t.Fatalf("exit response changed: %s (%v)", recorder.Body.String(), err)
			}
		}
	}
}

func TestAPIContractSystemExitRecovery(t *testing.T) {
	previousClose, previousRecover, previousFinish, previousConf := closeSystem, recoverSystemExit, finishSystemExit, model.Conf
	t.Cleanup(func() {
		closeSystem, recoverSystemExit, finishSystemExit, model.Conf = previousClose, previousRecover, previousFinish, previousConf
	})
	model.Conf = model.NewAppConf()
	closeSystem = func(context.Context, bool, bool, int) (int, string) {
		t.Fatal("recovery bypassed guards")
		return 0, ""
	}
	for _, forced := range []bool{false, true} {
		for _, code := range []int{-1, 0, 1, 3} {
			called := false
			finished := false
			finishSystemExit = func() { finished = true }
			recoverSystemExit = func(pid int, startedAt int64, force bool) (int, string) {
				called = true
				if pid != 123 || startedAt != 456 || force != forced {
					t.Fatalf("wrong recovery identity: %d %d", pid, startedAt)
				}
				return code, ""
			}
			body := `{"force":true,"execInstallPkg":2,"recoverExit":{"pid":123,"startedAt":456}}`
			if forced {
				body = `{"force":false,"execInstallPkg":2,"recoverExit":{"pid":123,"startedAt":456,"force":true}}`
			}
			recorder := systemContractRequest(t, "POST", "exit", exit, strings.NewReader(body))
			var result struct {
				Code int `json:"code"`
			}
			if err := json.Unmarshal(recorder.Body.Bytes(), &result); err != nil || !called || result.Code != code {
				t.Fatalf("unexpected recovery response: %s", recorder.Body.String())
			}
			requireAPIContract(t, "POST", "/api/system/exit", recorder)
			if finished != (code == 0) {
				t.Fatalf("server shutdown changed for recovery code %d: %v", code, finished)
			}
		}
	}
}

func TestAPIContractSystemExitAfterCleanupAndWrite(t *testing.T) {
	previousClose, previousFinish := closeSystem, finishSystemExit
	t.Cleanup(func() { closeSystem, finishSystemExit = previousClose, previousFinish })
	cleanupFinished := false
	closeSystem = func(context.Context, bool, bool, int) (int, string) {
		defer func() {
			// 覆盖退出末尾清理超过 500 毫秒的情况。
			time.Sleep(650 * time.Millisecond)
			cleanupFinished = true
		}()
		return 0, ""
	}
	recorder := httptest.NewRecorder()
	finishCalls := 0
	finishSystemExit = func() {
		finishCalls++
		if !cleanupFinished {
			t.Fatal("server shutdown started before deferred cleanup finished")
		}
		var response struct {
			Code int                        `json:"code"`
			Data apicontract.SystemExitData `json:"data"`
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 0 {
			t.Fatalf("server shutdown started before success response was written: %s (%v)", recorder.Body.String(), err)
		}
	}
	router := gin.New()
	router.POST("/api/system/exit", exit)
	router.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/system/exit", strings.NewReader(`{}`)))
	if finishCalls != 1 {
		t.Fatalf("expected one server shutdown after response, got %d", finishCalls)
	}
	requireAPIContract(t, "POST", "/api/system/exit", recorder)
}

func TestAPIContractSystemExitCancellationContext(t *testing.T) {
	previousClose, previousFinish, previousConf := closeSystem, finishSystemExit, model.Conf
	t.Cleanup(func() { closeSystem, finishSystemExit, model.Conf = previousClose, previousFinish, previousConf })
	model.Conf = model.NewAppConf()
	ctx, cancel := context.WithCancel(context.Background())
	closeSystem = func(actual context.Context, force, current bool, install int) (int, string) {
		if actual != ctx {
			t.Fatal("exit sync did not receive the request context")
		}
		cancel()
		if actual.Err() != context.Canceled {
			t.Fatal("request cancellation did not reach exit sync")
		}
		return 1, ""
	}
	finishSystemExit = func() { t.Fatal("canceled sync shut down the kernel") }
	router := gin.New()
	router.Use(model.ControlConcurrency)
	router.POST("/api/system/exit", exit)
	recorder := httptest.NewRecorder()
	router.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/system/exit", strings.NewReader(`{}`)).WithContext(ctx))
	requireAPIContract(t, "POST", "/api/system/exit", recorder)
	var response struct {
		Code int `json:"code"`
	}
	if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil || response.Code != 1 {
		t.Fatalf("cancellation reported successful sync: %s (%v)", recorder.Body.String(), err)
	}
}

func TestAPIContractSystemExitCancelThenForce(t *testing.T) {
	previousClose, previousFinish, previousConf := closeSystem, finishSystemExit, model.Conf
	t.Cleanup(func() { closeSystem, finishSystemExit, model.Conf = previousClose, previousFinish, previousConf })
	model.Conf = model.NewAppConf()
	started, canceled := make(chan struct{}), make(chan struct{})
	closeSystem = func(ctx context.Context, force, current bool, install int) (int, string) {
		if !force {
			close(started)
			<-ctx.Done()
			close(canceled)
			return 1, ""
		}
		select {
		case <-canceled:
		default:
			t.Error("force cleanup overtook the canceled synchronization")
		}
		return 0, ""
	}
	finished := make(chan struct{}, 1)
	finishSystemExit = func() { finished <- struct{}{} }
	router := gin.New()
	router.Use(model.ControlConcurrency)
	router.POST("/api/system/exit", exit)
	server := httptest.NewServer(router)
	defer server.Close()
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	done := make(chan error, 1)
	go func() {
		request, err := http.NewRequestWithContext(ctx, "POST", server.URL+"/api/system/exit", strings.NewReader(`{}`))
		if err != nil {
			done <- err
			return
		}
		response, err := http.DefaultClient.Do(request)
		if response != nil {
			response.Body.Close()
		}
		done <- err
	}()
	select {
	case <-started:
	case <-time.After(3 * time.Second):
		t.Fatal("normal exit did not start")
	}
	cancel()
	select {
	case <-done:
	case <-time.After(3 * time.Second):
		t.Fatal("canceled request did not finish")
	}
	client := &http.Client{Timeout: 3 * time.Second}
	response, err := client.Post(server.URL+"/api/system/exit", "application/json", strings.NewReader(`{"force":true,"execInstallPkg":1}`))
	if err != nil {
		t.Fatalf("force exit remained blocked by the canceled request: %v", err)
	}
	defer response.Body.Close()
	var result struct {
		Code int `json:"code"`
	}
	if err = json.NewDecoder(response.Body).Decode(&result); err != nil || result.Code != 0 {
		t.Fatalf("unexpected force cleanup response: %+v (%v)", result, err)
	}
	select {
	case <-finished:
	case <-time.After(3 * time.Second):
		t.Fatal("force cleanup did not complete shutdown")
	}
}

func TestAPIContractSystemAuthenticationAdmission(t *testing.T) {
	previousConf, previousWrong, previousContainer, previousReadonly := model.Conf, util.WrongAuthCount, util.Container, util.ReadOnly
	model.Conf = model.NewAppConf()
	model.Conf.AccessAuthCode = "correct-password"
	t.Cleanup(func() {
		model.Conf, util.WrongAuthCount, util.Container, util.ReadOnly = previousConf, previousWrong, previousContainer, previousReadonly
	})
	util.WrongAuthCount = 0
	recorder := systemContractRequest(t, "POST", "loginAuth", loginAuth, strings.NewReader(`{"authCode":"correct-password","captcha":{},"rememberMe":"ignored"}`))
	if !strings.Contains(recorder.Body.String(), `"code":0`) {
		t.Fatalf("unused captcha and ignored rememberMe rejected: %s", recorder.Body.String())
	}
	util.WrongAuthCount = 100
	recorder = systemContractRequest(t, "POST", "loginAuth", loginAuth, strings.NewReader(`{"authCode":{}}`))
	if !strings.Contains(recorder.Body.String(), `"code":1`) {
		t.Fatalf("captcha admission must precede authCode decoding: %s", recorder.Body.String())
	}
	util.Container = util.ContainerDocker
	systemContractRequest(t, "POST", "setAccessAuthCode", setAccessAuthCode, &systemUnreadBody{t: t})
	util.ReadOnly = true
	systemContractRequest(t, "POST", "setUILayout", setUILayout, &systemUnreadBody{t: t})
	model.Conf.OIDC.Enabled = false
	systemContractRequest(t, "POST", "oidc/start", oidcStart, &systemUnreadBody{t: t})
}

type systemUnreadBody struct{ t *testing.T }

func (b *systemUnreadBody) Read([]byte) (int, error) {
	b.t.Fatal("admission read the request body")
	return 0, io.EOF
}

func TestAPIContractSystemRawResponses(t *testing.T) {
	previousConf := model.Conf
	model.Conf = model.NewAppConf()
	t.Cleanup(func() { model.Conf = previousConf })
	recorder := systemContractRequest(t, "GET", "getCaptcha", getCaptcha, nil)
	if recorder.Code != 200 || !bytes.HasPrefix(recorder.Body.Bytes(), []byte("\x89PNG\r\n\x1a\n")) {
		t.Fatalf("captcha is not PNG: %d %q", recorder.Code, recorder.Body.Bytes())
	}
	recorder = systemContractRequest(t, "GET", "getBootAppearance", getBootAppearance, nil)
	if recorder.Code != 403 || recorder.Body.Len() != 0 {
		t.Fatalf("remote boot appearance must be empty 403: %d %s", recorder.Code, recorder.Body.String())
	}
	recorder = systemContractRequest(t, "POST", "uiproc", addUIProcess, nil)
	if recorder.Code != 200 || recorder.Body.Len() != 0 {
		t.Fatalf("UI registration must remain empty 200: %d %s", recorder.Code, recorder.Body.String())
	}
	recorder = systemContractRequest(t, "GET", "oidc/callback", oidcCallback, nil)
	if !strings.HasPrefix(recorder.Header().Get("Content-Type"), "text/html") || recorder.Header().Get("Cache-Control") != "no-store" || !strings.Contains(recorder.Header().Get("Content-Security-Policy"), "frame-ancestors 'none'") {
		t.Fatalf("OIDC failure page headers changed: %v", recorder.Header())
	}
	ctx, cancel := context.WithCancel(context.Background())
	cancel()
	recorder = httptest.NewRecorder()
	c, _ := gin.CreateTestContext(recorder)
	c.Request = httptest.NewRequest(http.MethodGet, "/api/system/bootProgressSSE", nil).WithContext(ctx)
	bootProgressSSE(c)
	if !strings.HasPrefix(recorder.Body.String(), "data: ") || !strings.HasSuffix(recorder.Body.String(), "\n\n") {
		t.Fatalf("initial unnamed SSE frame was lost: %q", recorder.Body.String())
	}
	requireAPIContract(t, "GET", "/api/system/bootProgressSSE", recorder)
}

func TestAPIContractUIProcessQueryParameters(t *testing.T) {
	const pid = "2147483001"
	util.UIProcessIDs.Delete(pid)
	t.Cleanup(func() { util.UIProcessIDs.Delete(pid) })
	engine := gin.New()
	engine.POST("/api/system/uiproc", addUIProcess)
	for _, query := range []string{"", "?pid=" + pid} {
		recorder := httptest.NewRecorder()
		engine.ServeHTTP(recorder, httptest.NewRequest("POST", "/api/system/uiproc"+query, strings.NewReader(`{"pid":"`+pid+`"}`)))
		requireAPIContract(t, "POST", "/api/system/uiproc", recorder)
		if recorder.Code != http.StatusOK || recorder.Body.Len() != 0 {
			t.Fatalf("UI registration response changed: %d %s", recorder.Code, recorder.Body.String())
		}
		_, registered := util.UIProcessIDs.Load(pid)
		if registered != (query != "") {
			t.Fatalf("registration must use URL query parameters: query=%q registered=%v", query, registered)
		}
	}
}

func TestAPIContractSystemUploadErrors(t *testing.T) {
	previousConf := model.Conf
	model.Conf = model.NewAppConf()
	t.Cleanup(func() { model.Conf = previousConf })
	for _, test := range []struct {
		route   string
		handler gin.HandlerFunc
		code    int
		message string
	}{
		{"importConf", importConf, -1, "invalid upload file"},
		{"importCustomFont", importCustomFont, 400, "Field [file] must not be empty"},
		{"importTLSCABundle", importTLSCABundle, -1, "[file] is required: " + http.ErrMissingFile.Error()},
		{"addCustomEmoji", addCustomEmoji, 400, "field [file] or [url] must not be empty"},
	} {
		var body bytes.Buffer
		writer := multipart.NewWriter(&body)
		if err := writer.Close(); err != nil {
			t.Fatal(err)
		}
		recorder := httptest.NewRecorder()
		c, _ := gin.CreateTestContext(recorder)
		c.Request = httptest.NewRequest("POST", "/api/system/"+test.route, &body)
		c.Request.Header.Set("Content-Type", writer.FormDataContentType())
		test.handler(c)
		var result struct {
			Code int    `json:"code"`
			Msg  string `json:"msg"`
		}
		if err := json.Unmarshal(recorder.Body.Bytes(), &result); err != nil || result.Code != test.code || result.Msg != test.message {
			t.Fatalf("%s missing upload changed: %s (%v)", test.route, recorder.Body.String(), err)
		}
		requireAPIContract(t, "POST", "/api/system/"+test.route, recorder)
	}
}