Merge pull request #168 from docker/report-compose-syntax-errors

Report YAML syntax errors in Compose files

Author: rcjsuen

CHANGELOG.md

@@ -14,6 +14,8 @@ All notable changes to the Docker Language Server will be documented in this fil
     - show the parent service's value if it is being overridden and they are not object attributes ([#156](https://github.com/docker/docker-language-server/issues/156))
   - textDocument/formatting
     - add support to format YAML files that do not have clear syntactical errors ([#165](https://github.com/docker/docker-language-server/issues/165))
+  - textDocument/publishDiagnostics
+    - report YAML syntax errors ([#167](https://github.com/docker/docker-language-server/issues/167))
 
 ### Fixed
 

README.md

@@ -16,6 +16,7 @@ The Docker Language Server relies on some features that are dependent on [Buildx
   - code completion
   - code navigation
   - document outline support
+  - error reporting
   - formatting
   - highlight named references of services, networks, volumes, configs, and secrets
   - hover tooltips
@@ -27,6 +28,7 @@ The Docker Language Server relies on some features that are dependent on [Buildx
   - code completion
   - code navigation
   - document outline support
+  - error reporting
   - formatting
   - hover tooltips
   - inferring variable values

internal/compose/diagnosticsCollector.go

@@ -0,0 +1,50 @@
+package compose
+
+import (
+	"errors"
+	"math"
+
+	"github.com/docker/docker-language-server/internal/pkg/document"
+	"github.com/docker/docker-language-server/internal/pkg/lsp/textdocument"
+	"github.com/docker/docker-language-server/internal/tliron/glsp/protocol"
+	"github.com/docker/docker-language-server/internal/types"
+	"github.com/goccy/go-yaml"
+)
+
+type ComposeDiagnosticsCollector struct {
+}
+
+func NewComposeDiagnosticsCollector() textdocument.DiagnosticsCollector {
+	return &ComposeDiagnosticsCollector{}
+}
+
+func (c *ComposeDiagnosticsCollector) SupportsLanguageIdentifier(languageIdentifier protocol.LanguageIdentifier) bool {
+	return languageIdentifier == protocol.DockerComposeLanguage
+}
+
+func (c *ComposeDiagnosticsCollector) CollectDiagnostics(source, workspaceFolder string, doc document.Document, text string) []protocol.Diagnostic {
+	err := doc.(document.ComposeDocument).ParsingError()
+	if err != nil {
+		var syntaxError *yaml.SyntaxError
+		if errors.As(err, &syntaxError) {
+			return []protocol.Diagnostic{
+				{
+					Message:  syntaxError.Message,
+					Source:   types.CreateStringPointer(source),
+					Severity: types.CreateDiagnosticSeverityPointer(protocol.DiagnosticSeverityError),
+					Range: protocol.Range{
+						Start: protocol.Position{
+							Line:      protocol.UInteger(syntaxError.Token.Position.Line) - 1,
+							Character: protocol.UInteger(syntaxError.Token.Position.Column) - 1,
+						},
+						End: protocol.Position{
+							Line:      protocol.UInteger(syntaxError.Token.Position.Line) - 1,
+							Character: math.MaxUint32,
+						},
+					},
+				},
+			}
+		}
+	}
+	return nil
+}

internal/compose/diagnosticsCollector_test.go

@@ -0,0 +1,52 @@
+package compose
+
+import (
+	"fmt"
+	"math"
+	"os"
+	"path/filepath"
+	"strings"
+	"testing"
+
+	"github.com/docker/docker-language-server/internal/pkg/document"
+	"github.com/docker/docker-language-server/internal/tliron/glsp/protocol"
+	"github.com/docker/docker-language-server/internal/types"
+	"github.com/stretchr/testify/require"
+	"go.lsp.dev/uri"
+)
+
+func TestCollectDiagnostics(t *testing.T) {
+	testCases := []struct {
+		name        string
+		content     string
+		diagnostics []protocol.Diagnostic
+	}{
+		{
+			name: "tab is flagged as an error",
+			content: `
+service:
+	abc:`,
+			diagnostics: []protocol.Diagnostic{
+				{
+					Message:  "found character '\t' that cannot start any token",
+					Source:   types.CreateStringPointer("docker-language-server"),
+					Severity: types.CreateDiagnosticSeverityPointer(protocol.DiagnosticSeverityError),
+					Range: protocol.Range{
+						Start: protocol.Position{Line: 2, Character: 0},
+						End:   protocol.Position{Line: 2, Character: math.MaxUint32},
+					},
+				},
+			},
+		},
+	}
+
+	composeFileURI := uri.URI(fmt.Sprintf("file:///%v", strings.TrimPrefix(filepath.ToSlash(filepath.Join(os.TempDir(), "compose.yaml")), "/")))
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			collector := NewComposeDiagnosticsCollector()
+			doc := document.NewComposeDocument(composeFileURI, 1, []byte(tc.content))
+			diagnostics := collector.CollectDiagnostics("docker-language-server", "", doc, "")
+			require.Equal(t, tc.diagnostics, diagnostics)
+		})
+	}
+}

internal/pkg/document/dockerComposeDocument.go

@@ -12,12 +12,14 @@ import (
 type ComposeDocument interface {
 	Document
 	File() *ast.File
+	ParsingError() error
 }
 
 type composeDocument struct {
 	document
-	mutex sync.Mutex
-	file  *ast.File
+	mutex        sync.Mutex
+	file         *ast.File
+	parsingError error
 }
 
 func NewComposeDocument(u uri.URI, version int32, input []byte) ComposeDocument {
@@ -39,7 +41,7 @@ func (d *composeDocument) parse(_ bool) bool {
 	d.mutex.Lock()
 	defer d.mutex.Unlock()
 
-	d.file, _ = parser.ParseBytes(d.input, 0)
+	d.file, d.parsingError = parser.ParseBytes(d.input, 0)
 	return true
 }
 
@@ -50,3 +52,7 @@ func (d *composeDocument) copy() Document {
 func (d *composeDocument) File() *ast.File {
 	return d.file
 }
+
+func (d *composeDocument) ParsingError() error {
+	return d.parsingError
+}

internal/pkg/server/server.go

@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/docker/docker-language-server/internal/bake/hcl"
+	"github.com/docker/docker-language-server/internal/compose"
 	"github.com/docker/docker-language-server/internal/configuration"
 	"github.com/docker/docker-language-server/internal/pkg/buildkit"
 	"github.com/docker/docker-language-server/internal/pkg/cli/metadata"
@@ -90,6 +91,7 @@ func NewServer(docManager *document.Manager) *Server {
 		diagnosticsCollectors: []textdocument.DiagnosticsCollector{
 			buildkit.NewBuildKitDiagnosticsCollector(),
 			scoutService,
+			compose.NewComposeDiagnosticsCollector(),
 			hcl.NewBakeHCLDiagnosticsCollector(docManager, scoutService),
 		},
 	}