Files
skillshare/internal/server/handler_mcp_check_test.go
Willie 6a9e9efbe2 fix(server): release the config lock before slow plugin, Pi and MCP reads (#747)
Every /api/ request reloads config under the write lock of s.mu. The
Plugins page's inventory (Agent CLIs) and update check (network) held
the read lock for their whole run, and Go's RWMutex makes later readers
queue behind a waiting writer. Switching pages or reloading while a
check ran froze the whole dashboard until the check finished.

Build each service under the read lock and release it before the slow
work: plugin list, discover and preview; Pi extensions view and
preview, which run the Pi CLI; and MCP check, which looks up hosts and
probes servers live. Writes still take the write lock, and apply paths
still compare revisions, so a read that races a write is refused at
apply time rather than applied.
2026-11-02 15:13:01 +08:00

151 lines
5.1 KiB
Go

package server
import (
"encoding/json"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
"testing"
)
func writeMCPSource(t *testing.T, s *Server, mcp string) {
t.Helper()
f, err := os.OpenFile(s.configPath(), os.O_APPEND|os.O_WRONLY, 0644)
if err != nil {
t.Fatal(err)
}
defer f.Close()
if _, err := f.WriteString(mcp); err != nil {
t.Fatal(err)
}
}
func TestMCPCheckReportsFindingsWithOK(t *testing.T) {
s, _ := newTestServerWithExtras(t, nil, "")
t.Setenv("HOME", t.TempDir())
t.Setenv("CLAUDE_CONFIG_DIR", "")
t.Setenv("SKILLSHARE_TEST_UNSET_TOKEN", "")
writeMCPSource(t, s, "mcp:\n targets: [claude]\n servers:\n docs:\n url: https://mcp.skillshare.invalid/mcp\n bearerToken: {fromEnv: SKILLSHARE_TEST_UNSET_TOKEN}\n")
w := httptest.NewRecorder()
s.handleMCPCheck(w, httptest.NewRequest(http.MethodGet, "/api/mcp/check?dns=0", nil))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
var report struct {
Servers []struct {
Name string `json:"name"`
OK bool `json:"ok"`
Findings []struct {
Level string `json:"level"`
Check string `json:"check"`
Subject string `json:"subject"`
} `json:"findings"`
} `json:"servers"`
Summary struct {
Errors int `json:"errors"`
} `json:"summary"`
}
if err := json.Unmarshal(w.Body.Bytes(), &report); err != nil {
t.Fatal(err)
}
if len(report.Servers) != 1 || report.Servers[0].OK || report.Summary.Errors != 1 {
t.Fatalf("the unset token must be one error: %s", w.Body.String())
}
for _, f := range report.Servers[0].Findings {
if f.Check == "dns" {
t.Fatalf("dns=0 must skip host lookups: %s", w.Body.String())
}
if f.Check == "env" && f.Subject != "SKILLSHARE_TEST_UNSET_TOKEN" {
t.Fatalf("env subject = %q", f.Subject)
}
}
}
func TestMCPCheckFailsWhenCheckCannotRun(t *testing.T) {
s, _ := newTestServerWithExtras(t, nil, "")
writeMCPSource(t, s, "mcp:\n servers: [not, a, map]\n")
w := httptest.NewRecorder()
s.handleMCPCheck(w, httptest.NewRequest(http.MethodGet, "/api/mcp/check", nil))
if w.Code < 400 || !strings.Contains(w.Body.String(), "error") {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
}
func probeDraft(t *testing.T, s *Server, server string) map[string]any {
t.Helper()
w := httptest.NewRecorder()
s.handleMCPProbe(w, httptest.NewRequest(http.MethodPost, "/api/mcp/probe", strings.NewReader(`{"mutation":{"name":"docs","server":`+server+`}}`)))
if w.Code != http.StatusOK {
t.Fatalf("status = %d body = %s", w.Code, w.Body.String())
}
var result map[string]any
if err := json.Unmarshal(w.Body.Bytes(), &result); err != nil {
t.Fatal(err)
}
return result
}
func TestMCPProbeListsToolsOfAnUnsavedServer(t *testing.T) {
s, _ := newTestServerWithExtras(t, nil, "")
mcpServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
var req struct {
ID json.RawMessage `json:"id"`
Method string `json:"method"`
}
_ = json.NewDecoder(r.Body).Decode(&req)
result := map[string]any{"tools": []any{map[string]string{"name": "search"}, map[string]string{"name": "fetch"}}}
if req.Method == "server/discover" {
result = map[string]any{"supportedVersions": []string{"2026-07-28"}, "capabilities": map[string]any{"tools": map[string]any{}}}
}
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(map[string]any{"jsonrpc": "2.0", "id": req.ID, "result": result})
}))
defer mcpServer.Close()
before, err := os.ReadFile(s.configPath())
if err != nil {
t.Fatal(err)
}
result := probeDraft(t, s, `{"url":"`+mcpServer.URL+`/mcp","tools":{"allow":["half typed"]}}`)
live, _ := result["live"].(map[string]any)
if live == nil || live["tools"] != float64(2) || result["errorKind"] != nil {
t.Fatalf("result = %v", result)
}
if after, _ := os.ReadFile(s.configPath()); string(after) != string(before) {
t.Fatal("a probe must not save the server")
}
}
func TestMCPProbeClassifiesARefusedConnection(t *testing.T) {
s, _ := newTestServerWithExtras(t, nil, "")
closed := httptest.NewServer(http.NotFoundHandler())
closed.Close()
result := probeDraft(t, s, `{"url":"`+closed.URL+`/mcp"}`)
if result["errorKind"] != "connect" || !strings.Contains(result["error"].(string), "refused") {
t.Fatalf("result = %v", result)
}
}
// A live probe of a slow server must not hold the config lock, or every other API
// request waits for it.
func TestMCPCheckLiveDoesNotHoldTheConfigLock(t *testing.T) {
s, _ := newTestServerWithExtras(t, nil, "")
t.Setenv("HOME", t.TempDir())
t.Setenv("CLAUDE_CONFIG_DIR", "")
command := filepath.Join(t.TempDir(), "slow-mcp")
started, release := writeBlockingCommand(t, command, "")
writeMCPSource(t, s, "mcp:\n targets: [claude]\n servers:\n slow:\n command: "+command+"\n")
done := make(chan struct{})
go func() {
defer close(done)
s.handleMCPCheck(httptest.NewRecorder(), httptest.NewRequest(http.MethodGet, "/api/mcp/check?dns=0&live=1", nil))
}()
defer func() { release(); <-done }()
started()
if !s.mu.TryLock() {
t.Fatal("a live probe holds the config lock")
}
s.mu.Unlock()
}