Fixed documentSymbol update deadlock

Author: cmaglie

Diff for: handler/handler.go

@@ -542,43 +542,47 @@ func (handler *InoHandler) initializeWorkbench(ctx context.Context, params *lsp.
 }
 
 func (handler *InoHandler) refreshCppDocumentSymbols() error {
-	prefix := "LS  --- "
+	prefix := "RFSH--- "
 	defer log.Printf(prefix + "(done)")
-	log.Printf(prefix + "(queued)")
-	handler.dataMux.Lock()
-	defer handler.dataMux.Unlock()
-	log.Printf(prefix + "(running)")
 
 	// Query source code symbols
 	cppURI := lsp.NewDocumentURIFromPath(handler.buildSketchCpp)
 	log.Printf(prefix+"sent to clangd: documentSymbol(%s)", cppURI)
 	result, err := lsp.SendRequest(context.Background(), handler.ClangdConn, "textDocument/documentSymbol", &lsp.DocumentSymbolParams{
 		TextDocument: lsp.TextDocumentIdentifier{URI: cppURI},
 	})
+
+	log.Printf(prefix + "(queued answer)")
+	handler.dataMux.Lock()
+	defer handler.dataMux.Unlock()
+
 	if err != nil {
 		log.Printf(prefix+"error: %s", err)
 		return errors.WithMessage(err, "quering source code symbols")
 	}
 	result = handler.transformClangdResult("textDocument/documentSymbol", cppURI, lsp.NilURI, result)
-	if symbols, ok := result.([]lsp.DocumentSymbol); !ok {
+
+	symbols, ok := result.([]lsp.DocumentSymbol)
+	if !ok {
 		log.Printf(prefix + "error: invalid response from clangd")
 		return errors.New("invalid response from clangd")
-	} else {
-		// Filter non-functions symbols
-		i := 0
-		for _, symbol := range symbols {
-			if symbol.Kind != lsp.SKFunction {
-				continue
-			}
-			symbols[i] = symbol
-			i++
-		}
-		symbols = symbols[:i]
-		for _, symbol := range symbols {
-			log.Printf(prefix+"   symbol: %s %s", symbol.Kind, symbol.Name)
+	}
+
+	// Filter non-functions symbols
+	i := 0
+	for _, symbol := range symbols {
+		if symbol.Kind != lsp.SKFunction {
+			continue
 		}
-		handler.buildSketchSymbols = symbols
+		symbols[i] = symbol
+		i++
+	}
+	symbols = symbols[:i]
+
+	for _, symbol := range symbols {
+		log.Printf(prefix+"   symbol: %s %s %s", symbol.Kind, symbol.Name, symbol.Range)
 	}
+	handler.buildSketchSymbols = symbols
 	return nil
 }
 

Diff for: lsp/protocol_test.go

@@ -127,4 +127,26 @@ func TestVariousMessages(t *testing.T) {
 	var init InitializeResult
 	err = json.Unmarshal([]byte(msg), &init)
 	require.NoError(t, err)
+
+	msg = `[{"kind":12,"name":"setup","range":{"end":{"character":12,"line":5},"start":{"character":0,"line":5}},"selectionRange":
+	{"end":{"character":10,"line":5},"start":{"character":5,"line":5}}},{"kind":12,"name":"newfunc","range":{"end":{"character":14,"line":7},
+	"start":{"character":0,"line":7}},"selectionRange":{"end":{"character":12,"line":7},"start":{"character":5,"line":7}}},{"kind":12,"name":
+	"altro","range":{"end":{"character":12,"line":9},"start":{"character":0,"line":9}},"selectionRange":{"end":{"character":10,"line":9},"start":
+	{"character":5,"line":9}}},{"kind":12,"name":"ancora","range":{"end":{"character":18,"line":11},"start":{"character":0,"line":11}},
+	"selectionRange":{"end":{"character":11,"line":11},"start":{"character":5,"line":11}}},{"kind":12,"name":"loop","range":{"end":{
+	"character":11,"line":13},"start":{"character":0,"line":13}},"selectionRange":{"end":{"character":9,"line":13},"start":{"character":5,
+	"line":13}}},{"kind":12,"name":"secondFunction","range":{"end":{"character":21,"line":15},"start":{"character":0,"line":15}},
+	"selectionRange":{"end":{"character":19,"line":15},"start":{"character":5,"line":15}}},{"kind":12,"name":"setup","range":{"end":{
+	"character":1,"line":34},"start":{"character":0,"line":17}},"selectionRange":{"end":{"character":10,"line":17},"start":{"character":5,
+	"line":17}}},{"kind":12,"name":"newfunc","range":{"end":{"character":1,"line":40},"start":{"character":0,"line":36}},"selectionRange":
+	{"end":{"character":12,"line":36},"start":{"character":5,"line":36}}},{"kind":12,"name":"altro","range":{"end":{"character":38,"line":42},
+	"start":{"character":0,"line":42}},"selectionRange":{"end":{"character":10,"line":42},"start":{"character":5,"line":42}}},{"kind":12,
+	"name":"ancora","range":{"end":{"character":21,"line":47},"start":{"character":0,"line":47}},"selectionRange":{"end":{"character":11,
+	"line":47},"start":{"character":5,"line":47}}},{"kind":12,"name":"loop","range":{"end":{"character":24,"line":49},"start":{"character":0,
+	"line":49}},"selectionRange":{"end":{"character":9,"line":49},"start":{"character":5,"line":49}}},{"kind":12,"name":"secondFunction",
+	"range":{"end":{"character":38,"line":53},"start":{"character":0,"line":53}},"selectionRange":{"end":{"character":19,"line":53},"start":
+	{"character":5,"line":53}}}]`
+	var symbol DocumentSymbolArrayOrSymbolInformationArray
+	err = json.Unmarshal([]byte(msg), &symbol)
+	require.NoError(t, err)
 }