turbo-editors/turbo-core · fakelsp_test.go

⑂ v1.0.2

fakelsp_test.go · 219 lines · 5.8 KBGo    Blame HistoryRaw
   1package app
5	"encoding/json"
8
📦 Turbo Core   11	"rickub.com/turbo-editors/turbo-core/lsp"
   12
14// fakeLSP is a language server living in this process, at the far end of an
15// in-memory pipe.
17// The `lsp` package has one of these too, for testing the client. This one
18// exists to test what the *editor* says to a server, which is a different
19// question and belongs here.
20type fakeLSP struct {
21	stream net.Conn
22	reader *bufio.Reader
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   24	mu         sync.Mutex
25	seen       map[string]int
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save   26	order      []string // every method, in the order it arrived
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   27	answers    map[string]json.RawMessage
28	lastOpened json.RawMessage // the params of the last textDocument/didOpen
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save   29	lastFiles  json.RawMessage // the params of the last workspace/didChangeWatchedFiles
   30
32// frame is one JSON-RPC message, reduced to what this fake needs to look at.
33type frame struct {
34	JSONRPC string          `json:"jsonrpc"`
35	ID      json.RawMessage `json:"id,omitempty"`
36	Method  string          `json:"method,omitempty"`
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   37	Params  json.RawMessage `json:"params,omitempty"`
   38	Result  json.RawMessage `json:"result,omitempty"`
41// newFakeLanguage returns an initialised client wired to a fake server. The
42// client is not attached to the app yet — connectLanguage does that, so a test
43// can check what happens on either side of the moment it becomes ready.
44func newFakeLanguage(t *testing.T, _ *App) (*lsp.Client, *fakeLSP) {
45	t.Helper()
47	clientSide, serverSide := net.Pipe()
48	server := &fakeLSP{
49		stream:  serverSide,
50		reader:  bufio.NewReader(serverSide),
51		seen:    map[string]int{},
52		answers: map[string]json.RawMessage{},
55	client := lsp.NewClient(clientSide, t.TempDir(), "Turbo Test")
56	go client.Run() //nolint:errcheck // failures surface through the client
57	go server.serve()
59	t.Cleanup(func() {
60		clientSide.Close()
61		serverSide.Close()
64	if err := client.Initialize(t.Context()); err != nil {
65		t.Fatalf("Initialize() error = %v", err)
67	return client, server
70// connectLanguage makes the app talk to a client, as a successful start-up
71
72func connectLanguage(a *App, client *lsp.Client) {
73	a.language.attach(client)
76// serve answers every request with null and records every method it sees.
77func (s *fakeLSP) serve() {
79		body, err := lsp.ReadMessage(s.reader)
80		if err != nil {
81
84		var msg frame
85		if err := json.Unmarshal(body, &msg); err != nil {
86
88		s.record(msg.Method)
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   89		if msg.Method == "textDocument/didOpen" {
90			s.mu.Lock()
91			s.lastOpened = msg.Params
92			s.mu.Unlock()
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save   94		if msg.Method == "workspace/didChangeWatchedFiles" {
95			s.mu.Lock()
96			s.lastFiles = msg.Params
97			s.mu.Unlock()
   99
100		if len(msg.ID) == 0 || msg.Method == "" {
101			continue // a notification, or an answer to something we asked
103		reply, err := json.Marshal(frame{JSONRPC: "2.0", ID: msg.ID, Result: s.answerTo(msg.Method)})
104		if err != nil {
105
107		if err := lsp.WriteMessage(s.stream, reply); err != nil {
108
113// answerTo returns what this server has been told to answer a method with,
114// and null when it has been told nothing — which is what every request got
115// before results could be set, and what most tests still want.
116func (s *fakeLSP) answerTo(method string) json.RawMessage {
117	s.mu.Lock()
118	defer s.mu.Unlock()
119	if answer, set := s.answers[method]; set {
120		return answer
122	return json.RawMessage("null")
125// setAnswer tells the server what to reply to one method.
126func (s *fakeLSP) setAnswer(t *testing.T, method string, result any) {
127	t.Helper()
129	encoded, err := json.Marshal(result)
130	if err != nil {
131		t.Fatalf("cannot encode the answer for %s: %v", method, err)
133	s.mu.Lock()
134	defer s.mu.Unlock()
135	s.answers[method] = encoded
138// record counts one method.
139func (s *fakeLSP) record(method string) {
140	if method == "" {
141
143	s.mu.Lock()
144	defer s.mu.Unlock()
145	s.seen[method]++
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save   146	s.order = append(s.order, method)
149// methodsSeen returns every method the client has sent, in order.
150func (s *fakeLSP) methodsSeen() []string {
151	s.mu.Lock()
152	defer s.mu.Unlock()
153	return append([]string(nil), s.order...)
   154
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   156// lastOpenedURI returns the URI the client announced in its most recent
157// textDocument/didOpen — the spelling the server was actually given, which is
158// what a server that resolves symbolic links cares about.
159func (s *fakeLSP) lastOpenedURI() string {
160	waitForMethodQuietly(s, "textDocument/didOpen")
161	s.mu.Lock()
162	defer s.mu.Unlock()
163	var params struct {
164		TextDocument struct {
165			URI string `json:"uri"`
166		} `json:"textDocument"`
168	_ = json.Unmarshal(s.lastOpened, &params)
169	return params.TextDocument.URI
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save   172// lastFileEvents returns the changes the client reported in its most recent
173// workspace/didChangeWatchedFiles.
174func (s *fakeLSP) lastFileEvents() []lsp.FileEvent {
175	waitForMethodQuietly(s, "workspace/didChangeWatchedFiles")
176	s.mu.Lock()
177	defer s.mu.Unlock()
178	var params lsp.DidChangeWatchedFilesParams
179	_ = json.Unmarshal(s.lastFiles, &params)
180	return params.Changes
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS)   183// waitForMethodQuietly is waitForMethod for a caller that reports its own
184// failure: it gives up after two seconds and returns.
185func waitForMethodQuietly(server *fakeLSP, method string) {
186	deadline := time.After(2 * time.Second)
187	for server.methodCount(method) == 0 {
188
189		case <-deadline:
190
191		case <-time.After(time.Millisecond):
   196// methodCount returns how many times the client has sent a method.
197func (s *fakeLSP) methodCount(method string) int {
198	s.mu.Lock()
199	defer s.mu.Unlock()
200	return s.seen[method]
203// waitForMethod blocks until the server has seen a method, so a test never
204// races the notification it is about to assert on.
205func waitForMethod(t *testing.T, server *fakeLSP, method string) {
206	t.Helper()
208	deadline := time.After(2 * time.Second)
210		if server.methodCount(method) > 0 {
211
213
214		case <-deadline:
215			t.Fatalf("the server never saw %q", method)
216		case <-time.After(time.Millisecond):

🛟 Updated. 28d5985 k33g 18h ago	1	package app
	2
	3	import (
	4	"bufio"
	5	"encoding/json"
	6	"net"
	7	"sync"
	8	"testing"
	9	"time"
	10
📦 Turbo Core f3ade8d k33g 11h ago	11	"rickub.com/turbo-editors/turbo-core/lsp"
🛟 Updated. 28d5985 k33g 18h ago	12	)
	13
	14	// fakeLSP is a language server living in this process, at the far end of an
	15	// in-memory pipe.
	16	//
	17	// The `lsp` package has one of these too, for testing the client. This one
	18	// exists to test what the editor says to a server, which is a different
	19	// question and belongs here.
	20	type fakeLSP struct {
	21	stream net.Conn
	22	reader *bufio.Reader
	23
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	24	mu sync.Mutex
	25	seen map[string]int
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save 3561e52 k33g 9h ago	26	order []string // every method, in the order it arrived
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	27	answers map[string]json.RawMessage
	28	lastOpened json.RawMessage // the params of the last textDocument/didOpen
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save 3561e52 k33g 9h ago	29	lastFiles json.RawMessage // the params of the last workspace/didChangeWatchedFiles
🛟 Updated. 28d5985 k33g 18h ago	30	}
	31
	32	// frame is one JSON-RPC message, reduced to what this fake needs to look at.
	33	type frame struct {
	34	JSONRPC string `json:"jsonrpc"`
	35	ID json.RawMessage `json:"id,omitempty"`
	36	Method string `json:"method,omitempty"`
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	37	Params json.RawMessage `json:"params,omitempty"`
🛟 Updated. 28d5985 k33g 18h ago	38	Result json.RawMessage `json:"result,omitempty"`
	39	}
	40
	41	// newFakeLanguage returns an initialised client wired to a fake server. The
	42	// client is not attached to the app yet — connectLanguage does that, so a test
	43	// can check what happens on either side of the moment it becomes ready.
	44	func newFakeLanguage(t testing.T, _ App) (lsp.Client, fakeLSP) {
	45	t.Helper()
	46
	47	clientSide, serverSide := net.Pipe()
	48	server := &fakeLSP{
	49	stream: serverSide,
	50	reader: bufio.NewReader(serverSide),
	51	seen: map[string]int{},
	52	answers: map[string]json.RawMessage{},
	53	}
	54
	55	client := lsp.NewClient(clientSide, t.TempDir(), "Turbo Test")
	56	go client.Run() //nolint:errcheck // failures surface through the client
	57	go server.serve()
	58
	59	t.Cleanup(func() {
	60	clientSide.Close()
	61	serverSide.Close()
	62	})
	63
	64	if err := client.Initialize(t.Context()); err != nil {
	65	t.Fatalf("Initialize() error = %v", err)
	66	}
	67	return client, server
	68	}
	69
	70	// connectLanguage makes the app talk to a client, as a successful start-up
	71	// would.
	72	func connectLanguage(a App, client lsp.Client) {
	73	a.language.attach(client)
	74	}
	75
	76	// serve answers every request with null and records every method it sees.
	77	func (s *fakeLSP) serve() {
	78	for {
	79	body, err := lsp.ReadMessage(s.reader)
	80	if err != nil {
	81	return
	82	}
	83
	84	var msg frame
	85	if err := json.Unmarshal(body, &msg); err != nil {
	86	return
	87	}
	88	s.record(msg.Method)
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	89	if msg.Method == "textDocument/didOpen" {
	90	s.mu.Lock()
	91	s.lastOpened = msg.Params
	92	s.mu.Unlock()
	93	}
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save 3561e52 k33g 9h ago	94	if msg.Method == "workspace/didChangeWatchedFiles" {
	95	s.mu.Lock()
	96	s.lastFiles = msg.Params
	97	s.mu.Unlock()
	98	}
🛟 Updated. 28d5985 k33g 18h ago	99
	100	if len(msg.ID) == 0 \|\| msg.Method == "" {
	101	continue // a notification, or an answer to something we asked
	102	}
	103	reply, err := json.Marshal(frame{JSONRPC: "2.0", ID: msg.ID, Result: s.answerTo(msg.Method)})
	104	if err != nil {
	105	return
	106	}
	107	if err := lsp.WriteMessage(s.stream, reply); err != nil {
	108	return
	109	}
	110	}
	111	}
	112
	113	// answerTo returns what this server has been told to answer a method with,
	114	// and null when it has been told nothing — which is what every request got
	115	// before results could be set, and what most tests still want.
	116	func (s *fakeLSP) answerTo(method string) json.RawMessage {
	117	s.mu.Lock()
	118	defer s.mu.Unlock()
	119	if answer, set := s.answers[method]; set {
	120	return answer
	121	}
	122	return json.RawMessage("null")
	123	}
	124
	125	// setAnswer tells the server what to reply to one method.
	126	func (s fakeLSP) setAnswer(t testing.T, method string, result any) {
	127	t.Helper()
	128
	129	encoded, err := json.Marshal(result)
	130	if err != nil {
	131	t.Fatalf("cannot encode the answer for %s: %v", method, err)
	132	}
	133	s.mu.Lock()
	134	defer s.mu.Unlock()
	135	s.answers[method] = encoded
	136	}
	137
	138	// record counts one method.
	139	func (s *fakeLSP) record(method string) {
	140	if method == "" {
	141	return
	142	}
	143	s.mu.Lock()
	144	defer s.mu.Unlock()
	145	s.seen[method]++
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save 3561e52 k33g 9h ago	146	s.order = append(s.order, method)
	147	}
	148
	149	// methodsSeen returns every method the client has sent, in order.
	150	func (s *fakeLSP) methodsSeen() []string {
	151	s.mu.Lock()
	152	defer s.mu.Unlock()
	153	return append([]string(nil), s.order...)
🛟 Updated. 28d5985 k33g 18h ago	154	}
🛟 Updated. 28d5985 k33g 18h ago	155
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	156	// lastOpenedURI returns the URI the client announced in its most recent
	157	// textDocument/didOpen — the spelling the server was actually given, which is
	158	// what a server that resolves symbolic links cares about.
	159	func (s *fakeLSP) lastOpenedURI() string {
	160	waitForMethodQuietly(s, "textDocument/didOpen")
	161	s.mu.Lock()
	162	defer s.mu.Unlock()
	163	var params struct {
	164	TextDocument struct {
	165	URI string `json:"uri"`
	166	} `json:"textDocument"`
	167	}
	168	_ = json.Unmarshal(s.lastOpened, &params)
	169	return params.TextDocument.URI
	170	}
	171
📦 Turbo Core — a save that creates a file tells the server (workspace/didChangeWatchedFiles), so moon-lsp diagnoses a new .mbt from its first save 3561e52 k33g 9h ago	172	// lastFileEvents returns the changes the client reported in its most recent
	173	// workspace/didChangeWatchedFiles.
	174	func (s *fakeLSP) lastFileEvents() []lsp.FileEvent {
	175	waitForMethodQuietly(s, "workspace/didChangeWatchedFiles")
	176	s.mu.Lock()
	177	defer s.mu.Unlock()
	178	var params lsp.DidChangeWatchedFilesParams
	179	_ = json.Unmarshal(s.lastFiles, &params)
	180	return params.Changes
	181	}
	182
📦 Turbo Core — canonical paths: symbolic links resolved in URIs and document keys (moon-lsp on macOS) b91316e k33g 9h ago	183	// waitForMethodQuietly is waitForMethod for a caller that reports its own
	184	// failure: it gives up after two seconds and returns.
	185	func waitForMethodQuietly(server *fakeLSP, method string) {
	186	deadline := time.After(2 * time.Second)
	187	for server.methodCount(method) == 0 {
	188	select {
	189	case <-deadline:
	190	return
	191	case <-time.After(time.Millisecond):
	192	}
	193	}
	194	}
	195
🛟 Updated. 28d5985 k33g 18h ago	196	// methodCount returns how many times the client has sent a method.
	197	func (s *fakeLSP) methodCount(method string) int {
	198	s.mu.Lock()
	199	defer s.mu.Unlock()
	200	return s.seen[method]
	201	}
	202
	203	// waitForMethod blocks until the server has seen a method, so a test never
	204	// races the notification it is about to assert on.
	205	func waitForMethod(t testing.T, server fakeLSP, method string) {
	206	t.Helper()
	207
	208	deadline := time.After(2 * time.Second)
	209	for {
	210	if server.methodCount(method) > 0 {
	211	return
	212	}
	213	select {
	214	case <-deadline:
	215	t.Fatalf("the server never saw %q", method)
	216	case <-time.After(time.Millisecond):
	217	}
	218	}
	219	}