Merge pull request #152 from docker/compose-prepare-rename-support

Support rename preparation requests for Compose

Author: rcjsuen

CHANGELOG.md

@@ -20,6 +20,8 @@ All notable changes to the Docker Language Server will be documented in this fil
     - support highlighting the short form `depends_on` syntax for services ([#70](https://github.com/docker/docker-language-server/issues/70))
     - support highlighting the long form `depends_on` syntax for services ([#71](https://github.com/docker/docker-language-server/issues/71))
     - support highlighting referenced networks, volumes, configs, and secrets ([#145](https://github.com/docker/docker-language-server/issues/145))
+  - textDocument/prepareRename
+    - support rename preparation requests ([#150](https://github.com/docker/docker-language-server/issues/150))
   - textDocument/rename
     - support renaming named references of services, networks, volumes, configs, and secrets ([#149](https://github.com/docker/docker-language-server/issues/149))
 

README.md

@@ -19,6 +19,7 @@ The Docker Language Server relies on some features that are dependent on [Buildx
   - highlight named references of services, networks, volumes, configs, and secrets
   - hover tooltips
   - open links to images
+  - rename preparation
   - rename named references
 - Bake files
   - code completion

e2e-tests/prepareRename_test.go

@@ -0,0 +1,70 @@
+package server_test
+
+import (
+	"bytes"
+	"context"
+	"os"
+	"testing"
+
+	"github.com/docker/docker-language-server/internal/tliron/glsp/protocol"
+	"github.com/sourcegraph/jsonrpc2"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPrepareRename(t *testing.T) {
+	s := startServer()
+
+	client := bytes.NewBuffer(make([]byte, 0, 1024))
+	server := bytes.NewBuffer(make([]byte, 0, 1024))
+	serverStream := &TestStream{incoming: server, outgoing: client, closed: false}
+	defer serverStream.Close()
+	go s.ServeStream(serverStream)
+
+	clientStream := jsonrpc2.NewBufferedStream(&TestStream{incoming: client, outgoing: server, closed: false}, jsonrpc2.VSCodeObjectCodec{})
+	defer clientStream.Close()
+	conn := jsonrpc2.NewConn(context.Background(), clientStream, &ConfigurationHandler{t: t})
+	initialize(t, conn, protocol.InitializeParams{})
+
+	homedir, err := os.UserHomeDir()
+	require.NoError(t, err)
+
+	testCases := []struct {
+		name     string
+		content  string
+		position protocol.Position
+		result   *protocol.Range
+	}{
+		{
+			name: "rename dependent service",
+			content: `
+services:
+  test:
+    depends_on:
+      - test2
+  test2:`,
+			position: protocol.Position{Line: 4, Character: 11},
+			result: &protocol.Range{
+				Start: protocol.Position{Line: 4, Character: 8},
+				End:   protocol.Position{Line: 4, Character: 13},
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			didOpen := createDidOpenTextDocumentParams(homedir, t.Name()+".yaml", tc.content, "dockercompose")
+			err := conn.Notify(context.Background(), protocol.MethodTextDocumentDidOpen, didOpen)
+			require.NoError(t, err)
+
+			var result *protocol.Range
+			err = conn.Call(context.Background(), protocol.MethodTextDocumentPrepareRename, protocol.PrepareRenameParams{
+				TextDocumentPositionParams: protocol.TextDocumentPositionParams{
+					TextDocument: protocol.TextDocumentIdentifier{URI: didOpen.TextDocument.URI},
+					Position:     tc.position,
+				},
+			}, &result)
+			require.NoError(t, err)
+			require.Equal(t, tc.result, result)
+		})
+	}
+}

e2e-tests/publishDiagnostics_test.go

@@ -85,7 +85,7 @@ func initialize(t *testing.T, conn *jsonrpc2.Conn, initializeParams protocol.Ini
 			InlayHintProvider:        protocol.InlayHintOptions{},
 			InlineCompletionProvider: protocol.InlineCompletionOptions{},
 			RenameProvider: protocol.RenameOptions{
-				PrepareProvider: types.CreateBoolPointer(false),
+				PrepareProvider: types.CreateBoolPointer(true),
 			},
 			SemanticTokensProvider: protocol.SemanticTokensOptions{
 				Legend: protocol.SemanticTokensLegend{