mirror of
https://github.com/golang/go
synced 2024-10-01 18:38:34 -06:00
e02f5847d1
For testability, and to support the exchange of debug information across Forwarder and server, it is helpful to encapsulate all debug information on the instance object. This CL moves all state in the debug package into a new 'State' type, that is added as a field on the debug.Instance. While doing so, common functionality for object collections is factored out into the objset helper type. Also add two new debug object types: Client and Server. These aren't yet used, but will be in a later CL (and frankly it was easier to leave them in this CL than to more carefully rewrite history...). Updates golang/go#34111 Change-Id: Ib809cd14cb957b41a9bcbd94a991f804531a76ea Reviewed-on: https://go-review.googlesource.com/c/tools/+/220078 Run-TryBot: Robert Findley <rfindley@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Heschi Kreinick <heschi@google.com>
162 lines
3.8 KiB
Go
162 lines
3.8 KiB
Go
// Copyright 2020 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package lsprpc
|
|
|
|
import (
|
|
"context"
|
|
"regexp"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"golang.org/x/tools/internal/jsonrpc2/servertest"
|
|
"golang.org/x/tools/internal/lsp/cache"
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/telemetry/log"
|
|
)
|
|
|
|
type fakeClient struct {
|
|
protocol.Client
|
|
|
|
logs chan string
|
|
}
|
|
|
|
func (c fakeClient) LogMessage(ctx context.Context, params *protocol.LogMessageParams) error {
|
|
c.logs <- params.Message
|
|
return nil
|
|
}
|
|
|
|
type pingServer struct{ protocol.Server }
|
|
|
|
func (s pingServer) DidOpen(ctx context.Context, params *protocol.DidOpenTextDocumentParams) error {
|
|
log.Print(ctx, "ping")
|
|
return nil
|
|
}
|
|
|
|
func TestClientLogging(t *testing.T) {
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
defer cancel()
|
|
|
|
server := pingServer{}
|
|
client := fakeClient{logs: make(chan string, 10)}
|
|
|
|
ss := NewStreamServer(cache.New(nil, nil), false)
|
|
ss.serverForTest = server
|
|
ts := servertest.NewPipeServer(ctx, ss)
|
|
cc := ts.Connect(ctx)
|
|
cc.AddHandler(protocol.ClientHandler(client))
|
|
|
|
protocol.ServerDispatcher(cc).DidOpen(ctx, &protocol.DidOpenTextDocumentParams{})
|
|
|
|
select {
|
|
case got := <-client.logs:
|
|
want := "ping"
|
|
matched, err := regexp.MatchString(want, got)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !matched {
|
|
t.Errorf("got log %q, want a log containing %q", got, want)
|
|
}
|
|
case <-time.After(1 * time.Second):
|
|
t.Error("timeout waiting for client log")
|
|
}
|
|
}
|
|
|
|
// waitableServer instruments LSP request so that we can control their timing.
|
|
// The requests chosen are arbitrary: we simply needed one that blocks, and
|
|
// another that doesn't.
|
|
type waitableServer struct {
|
|
protocol.Server
|
|
|
|
started chan struct{}
|
|
}
|
|
|
|
func (s waitableServer) Hover(ctx context.Context, _ *protocol.HoverParams) (*protocol.Hover, error) {
|
|
s.started <- struct{}{}
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil, ctx.Err()
|
|
case <-time.After(200 * time.Millisecond):
|
|
}
|
|
return &protocol.Hover{}, nil
|
|
}
|
|
|
|
func (s waitableServer) Resolve(_ context.Context, item *protocol.CompletionItem) (*protocol.CompletionItem, error) {
|
|
return item, nil
|
|
}
|
|
|
|
func TestRequestCancellation(t *testing.T) {
|
|
server := waitableServer{
|
|
started: make(chan struct{}),
|
|
}
|
|
ss := NewStreamServer(cache.New(nil, nil), false)
|
|
ss.serverForTest = server
|
|
ctx := context.Background()
|
|
tsDirect := servertest.NewTCPServer(ctx, ss)
|
|
|
|
forwarder := NewForwarder("tcp", tsDirect.Addr, false)
|
|
tsForwarded := servertest.NewPipeServer(ctx, forwarder)
|
|
|
|
tests := []struct {
|
|
serverType string
|
|
ts servertest.Connector
|
|
}{
|
|
{"direct", tsDirect},
|
|
{"forwarder", tsForwarded},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.serverType, func(t *testing.T) {
|
|
cc := test.ts.Connect(ctx)
|
|
cc.AddHandler(protocol.Canceller{})
|
|
ctx := context.Background()
|
|
ctx1, cancel1 := context.WithCancel(ctx)
|
|
var (
|
|
err1, err2 error
|
|
wg sync.WaitGroup
|
|
)
|
|
wg.Add(2)
|
|
go func() {
|
|
defer wg.Done()
|
|
_, err1 = protocol.ServerDispatcher(cc).Hover(ctx1, &protocol.HoverParams{})
|
|
}()
|
|
go func() {
|
|
defer wg.Done()
|
|
_, err2 = protocol.ServerDispatcher(cc).Resolve(ctx, &protocol.CompletionItem{})
|
|
}()
|
|
// Wait for the Hover request to start.
|
|
<-server.started
|
|
cancel1()
|
|
wg.Wait()
|
|
if err1 == nil {
|
|
t.Errorf("cancelled Hover(): got nil err")
|
|
}
|
|
if err2 != nil {
|
|
t.Errorf("uncancelled Hover(): err: %v", err2)
|
|
}
|
|
if _, err := protocol.ServerDispatcher(cc).Resolve(ctx, &protocol.CompletionItem{}); err != nil {
|
|
t.Errorf("subsequent Hover(): %v", err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
const exampleProgram = `
|
|
-- go.mod --
|
|
module mod
|
|
|
|
go 1.12
|
|
-- main.go --
|
|
package main
|
|
|
|
import "fmt"
|
|
|
|
func main() {
|
|
fmt.Println("Hello World.")
|
|
}`
|
|
|
|
// TODO: add a test for telemetry.
|