gopls/internal/protocol: patch RenameParams to extend PositionParams

The LSP states that RenameParams extends TextDocumentPositionParams.
However, the source json definition flattens the text document and
position fields directly to Renameparams, rather than preserving
the inheritance.

This change manually patches the parsed model ensuring the generated
code correctly embeds PositionParams matching the LSP.

Change-Id: I265ceab5fc5c7ce08cfca2ceb81cc9a52f0be503
Reviewed-on: https://go-review.googlesource.com/c/tools/+/730040
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Hongxiang Jiang <hxjiang@golang.org>
Reviewed-by: Alan Donovan <adonovan@google.com>

Author: h9jiang

gopls/internal/cmd/rename.go

@@ -61,9 +61,8 @@ func (r *rename) Run(ctx context.Context, args ...string) error {
 		return err
 	}
 	p := protocol.RenameParams{
-		TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI},
-		Position:     loc.Range.Start,
-		NewName:      args[1],
+		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(loc),
+		NewName:                    args[1],
 	}
 	edit, err := cli.server.Rename(ctx, &p)
 	if err != nil {

gopls/internal/protocol/generate/main.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"slices"
 	"strings"
 )
 
@@ -72,6 +73,28 @@ func processinline() {
 
 	model := parse(filepath.Join(*repodir, "protocol/metaModel.json"))
 
+	// Although the LSP specification defines RenameParams as extending
+	// TextDocumentPositionParams, the metaModel.json definition flattens
+	// these properties (likely due to specific comments in the TS definition).
+	// See microsoft/vscode-languageserver-node#1698.
+	//
+	// TODO(hxjiang): delete the patch logic after releasing lsp 3.18.
+	for _, s := range model.Structures {
+		if s.Name == "RenameParams" {
+			s.Properties = slices.DeleteFunc(s.Properties, func(t NameType) bool {
+				return t.Name == "position" || t.Name == "textDocument"
+			})
+			if !slices.ContainsFunc(s.Extends, func(t *Type) bool {
+				return t.Kind == "reference" && t.Name == "TextDocumentPositionParams"
+			}) {
+				s.Extends = append(s.Extends, &Type{
+					Kind: "reference",
+					Name: "TextDocumentPositionParams",
+				})
+			}
+		}
+	}
+
 	findTypeNames(model)
 	generateOutput(model)
 

gopls/internal/protocol/generate/output.go

@@ -122,10 +122,8 @@ func genCase(model *Model, method string, param, result *Type, dir string) {
 		// If the parameter extends the TextDocumentPositionParam, verify the
 		// position is within the provided range.
 		if extends(nm, "TextDocumentPositionParams") {
-			out.WriteString(`		if params.Range != (Range{}) {
-			if !params.Range.Contains(params.Position) {
-				return nil, true, fmt.Errorf("position %%v is outside the provided range %%v.", params.Position, params.Range)
-			}
+			out.WriteString(`		if !params.Range.Empty() && !params.Range.Contains(params.Position) {
+			return nil, true, fmt.Errorf("position %%v is outside the provided range %%v.", params.Position, params.Range)
 		}
 `)
 

gopls/internal/protocol/tsprotocol.go

@@ -1396,20 +1396,18 @@ func (e *Editor) Rename(ctx context.Context, loc protocol.Location, newName stri
 	if e.Server == nil {
 		return nil
 	}
-	path := e.sandbox.Workdir.URIToPath(loc.URI)
 
 	// Verify that PrepareRename succeeds.
-	prepareParams := &protocol.PrepareRenameParams{}
-	prepareParams.TextDocument = e.TextDocumentIdentifier(path)
-	prepareParams.Position = loc.Range.Start
+	prepareParams := &protocol.PrepareRenameParams{
+		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(loc),
+	}
 	if _, err := e.Server.PrepareRename(ctx, prepareParams); err != nil {
 		return fmt.Errorf("preparing rename: %v", err)
 	}
 
 	params := &protocol.RenameParams{
-		TextDocument: e.TextDocumentIdentifier(path),
-		Position:     loc.Range.Start,
-		NewName:      newName,
+		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(loc),
+		NewName:                    newName,
 	}
 	wsedit, err := e.Server.Rename(ctx, params)
 	if err != nil {

gopls/internal/protocol/tsserver.go

@@ -2043,9 +2043,8 @@ func rename(env *integration.Env, loc protocol.Location, newName string) (map[st
 	// @rename markers.
 
 	wsedit, err := env.Editor.Server.Rename(env.Ctx, &protocol.RenameParams{
-		TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI},
-		Position:     loc.Range.Start,
-		NewName:      newName,
+		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(loc),
+		NewName:                    newName,
 	})
 	if err != nil {
 		return nil, err