LSP-conformant originalRootURI

buildserver/build_server.go

@@ -178,6 +178,19 @@ func (h *BuildHandler) Handle(ctx context.Context, conn *jsonrpc2.Conn, req *jso
 			return nil, err
 		}
 
+		// Fall back to reading the `originalRootURI` from
+		// `InitializeParams.intitializationOptions` if absent from the
+		// `InitializeParams`. This makes go-langserver more LSP-compliant so that
+		// clients don't need to go outside of the LSP specification to communicate
+		// with it.
+		if params.OriginalRootURI == "" {
+			if initializationOptions, ok := params.InitializationOptions.(map[string]interface{}); ok {
+				if originalRootURI, ok := initializationOptions["originalRootURI"].(string); ok {
+					params.OriginalRootURI = lsp.DocumentURI(originalRootURI)
+				}
+			}
+		}
+
 		if Debug {
 			var b []byte
 			if req.Params != nil {

buildserver/proxy_test.go

@@ -22,24 +22,33 @@ import (
 	"github.com/sourcegraph/jsonrpc2"
 )
 
+type OriginalRootURIParent int
+
+const (
+	parentInitializeParams OriginalRootURIParent = iota
+	parentInitializationOptions
+)
+
 func TestProxy(t *testing.T) {
 	if testing.Short() {
 		t.Skip()
 	}
 
 	tests := map[string]struct {
-		rootURI           lsp.DocumentURI
-		mode              string
-		fs                map[string]string
-		wantHover         map[string]string
-		wantDefinition    map[string]string
-		wantXDefinition   map[string]string
-		wantReferences    map[string][]string
-		wantSymbols       map[string][]string
-		wantXDependencies string
-		wantXReferences   map[*lsext.WorkspaceReferencesParams][]string
-		wantXPackages     []string
-		depFS             map[string]map[string]string // dep clone URL -> map VFS
+		rootURI lsp.DocumentURI
+		mode    string
+		// defaults to "intializeParams"
+		originalRootURIParent OriginalRootURIParent
+		fs                    map[string]string
+		wantHover             map[string]string
+		wantDefinition        map[string]string
+		wantXDefinition       map[string]string
+		wantReferences        map[string][]string
+		wantSymbols           map[string][]string
+		wantXDependencies     string
+		wantXReferences       map[*lsext.WorkspaceReferencesParams][]string
+		wantXPackages         []string
+		depFS                 map[string]map[string]string // dep clone URL -> map VFS
 	}{
 		"go basic": {
 			rootURI: "git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
@@ -569,6 +578,17 @@ func yza() {}
 				"is:exported": []string{"git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef#abc.go:class:XYZ:2:5", "git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef#bcd.go:class:YZA:2:5", "git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef#abc.go:method:XYZ.ABC:4:13", "git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef#bcd.go:method:YZA.BCD:4:13"},
 			},
 		},
+		"originalRootURI in initalizationOptions instead of initializeParams": {
+			rootURI:               "git://test/pkg?deadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
+			originalRootURIParent: parentInitializationOptions,
+			mode:                  "go",
+			fs: map[string]string{
+				"a.go": "package p; func A() { A() }",
+			},
+			wantHover: map[string]string{
+				"a.go:1:17": "func A()",
+			},
+		},
 	}
 	for label, test := range tests {
 		t.Run(label, func(t *testing.T) {
@@ -610,10 +630,26 @@ func yza() {}
 			defer done()
 
 			// Prepare the connection.
-			if err := c.Call(ctx, "initialize", lspext.InitializeParams{
-				InitializeParams: lsp.InitializeParams{RootURI: "file:///"},
-				OriginalRootURI:  test.rootURI,
-			}, nil); err != nil {
+			var initializeParams lspext.InitializeParams
+			switch test.originalRootURIParent {
+			case parentInitializeParams:
+				initializeParams = lspext.InitializeParams{
+					InitializeParams: lsp.InitializeParams{RootURI: "file:///"},
+					OriginalRootURI:  test.rootURI,
+				}
+			case parentInitializationOptions:
+				initializeParams = lspext.InitializeParams{
+					InitializeParams: lsp.InitializeParams{
+						RootURI: "file:///",
+						InitializationOptions: map[string]string{
+							"originalRootURI": string(test.rootURI),
+						},
+					},
+				}
+			default:
+				t.Fatalf("invalid originalRootURIParent: %d", test.originalRootURIParent)
+			}
+			if err := c.Call(ctx, "initialize", initializeParams, nil); err != nil {
 				t.Fatal("initialize:", err)
 			}
 

langserver/hover.go

@@ -500,7 +500,7 @@ func packageForFile(pkgs map[string]*ast.Package, filename string) (string, *ast
 			}
 		}
 	}
-	return "", nil, fmt.Errorf("failed to find %q in packages %q", filename, pkgs)
+	return "", nil, fmt.Errorf("failed to find %q in packages %+v", filename, pkgs)
 }
 
 // inRange tells if x is in the range of a-b inclusive.