debug yamlls DocumentSymbol race condition

mrjosh · Jul 25, 2024 · 9a7308d · 9a7308d
1 parent e2c89b8
commit 9a7308d
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 124 deletions.
diff --git a/internal/adapter/yamlls/documentSync.go b/internal/adapter/yamlls/documentSync.go
diff --git a/internal/adapter/yamlls/symbol.go b/internal/adapter/yamlls/symbol.go
@@ -6,10 +6,38 @@ import (
 	lsp "go.lsp.dev/protocol"
 )
 
+func getDocumentSymbolsError(text string) []interface{} {
+	return []interface{}{
+		lsp.DocumentSymbol{
+			Name: text,
+			Range: lsp.Range{
+				End: lsp.Position{
+					Line: 999999,
+				},
+			},
+		},
+	}
+}
+
 func (yamllsConnector Connector) CallDocumentSymbol(ctx context.Context, params *lsp.DocumentSymbolParams) (result []interface{}, err error) {
 	if yamllsConnector.server == nil {
-		return []interface{}{}, nil
+		if !yamllsConnector.configured {
+			logger.Error("DocumentSymbol was called before yamlls was configured")
+			return getDocumentSymbolsError("Yamlls was not configured yet, editing the document should trigger a refesh"), nil
+		}
+		return getDocumentSymbolsError("Yamlls is disabled"), nil
+	}
+
+	yamllsResult, err := yamllsConnector.server.DocumentSymbol(ctx, params)
+	if err != nil {
+		logger.Error("Failed getting document symbol from yamlls", err)
+		return getDocumentSymbolsError("Could not get DocumentSymbol from yamlls"), nil
+	}
+
+	if len(yamllsResult) == 0 {
+		return getDocumentSymbolsError("Yamlls did not find any DocumentSymbols yet"), nil
 	}
 
-	return yamllsConnector.server.DocumentSymbol(ctx, params)
+	logger.Debug("DocumentSymbol yamlls result ", yamllsResult)
+	return yamllsResult, err
 }
diff --git a/internal/adapter/yamlls/yamlls.go b/internal/adapter/yamlls/yamlls.go
@@ -18,10 +18,11 @@ import (
 var logger = log.GetLogger()
 
 type Connector struct {
-	config    util.YamllsConfiguration
-	server    protocol.Server
-	documents *lsplocal.DocumentStore
-	client    protocol.Client
+	config     util.YamllsConfiguration
+	server     protocol.Server
+	documents  *lsplocal.DocumentStore
+	client     protocol.Client
+	configured bool
 }
 
 func NewConnector(ctx context.Context, yamllsConfiguration util.YamllsConfiguration, client protocol.Client, documents *lsplocal.DocumentStore) *Connector {
@@ -68,7 +69,12 @@ func NewConnector(ctx context.Context, yamllsConfiguration util.YamllsConfigurat
 		io.Copy(os.Stderr, strderr)
 	}()
 
-	yamllsConnector := Connector{documents: documents, config: yamllsConfiguration, client: client}
+	yamllsConnector := Connector{
+		config:     yamllsConfiguration,
+		documents:  documents,
+		client:     client,
+		configured: true,
+	}
 
 	zapLogger, _ := zap.NewProduction()
 	_, _, server := protocol.NewClient(ctx, yamllsConnector, jsonrpc2.NewStream(readWriteCloser), zapLogger)