Language server now skips libraries detection while editing

A full build is made only at language server startup.
Other full builds are performed by the IDE and build_path should be
passed to the LS with a custom command "ino/didCompleteBuild".

Co-authored-by: [email protected]

Author: cmaglie

Diff for: ls/builder.go

@@ -92,7 +92,7 @@ func (r *SketchRebuilder) rebuilderLoop() {
 		r.cancel = cancel
 		r.mutex.Unlock()
 
-		if err := r.doRebuild(ctx, logger); err != nil {
+		if err := r.doRebuildArduinoPreprocessedSketch(ctx, logger); err != nil {
 			logger.Logf("Error: %s", err)
 		}
 
@@ -104,10 +104,9 @@ func (r *SketchRebuilder) rebuilderLoop() {
 	}
 }
 
-func (r *SketchRebuilder) doRebuild(ctx context.Context, logger jsonrpc.FunctionLogger) error {
+func (r *SketchRebuilder) doRebuildArduinoPreprocessedSketch(ctx context.Context, logger jsonrpc.FunctionLogger) error {
 	ls := r.ls
-
-	if success, err := ls.generateBuildEnvironment(ctx, logger); err != nil {
+	if success, err := ls.generateBuildEnvironment(ctx, false, logger); err != nil {
 		return err
 	} else if !success {
 		return fmt.Errorf("build failed")
@@ -123,10 +122,6 @@ func (r *SketchRebuilder) doRebuild(ctx context.Context, logger jsonrpc.Function
 	default:
 	}
 
-	if err := ls.buildPath.Join("compile_commands.json").CopyTo(ls.compileCommandsDir.Join("compile_commands.json")); err != nil {
-		logger.Logf("ERROR: updating compile_commands: %s", err)
-	}
-
 	if cppContent, err := ls.buildSketchCpp.ReadFile(); err == nil {
 		oldVersion := ls.sketchMapper.CppText.Version
 		ls.sketchMapper = sourcemapper.CreateInoMapper(cppContent)
@@ -166,11 +161,17 @@ func (r *SketchRebuilder) doRebuild(ctx context.Context, logger jsonrpc.Function
 	return nil
 }
 
-func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logger jsonrpc.FunctionLogger) (bool, error) {
+func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, fullBuild bool, logger jsonrpc.FunctionLogger) (bool, error) {
+	var buildPath *paths.Path
+	if fullBuild {
+		buildPath = ls.fullBuildPath
+	} else {
+		buildPath = ls.buildPath
+	}
+
 	// Extract all build information from language server status
 	ls.readLock(logger, false)
 	sketchRoot := ls.sketchRoot
-	buildPath := ls.buildPath
 	config := ls.config
 	type overridesFile struct {
 		Overrides map[string]string `json:"overrides"`
@@ -204,6 +205,7 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 			BuildPath:                     buildPath.String(),
 			CreateCompilationDatabaseOnly: true,
 			Verbose:                       true,
+			SkipLibrariesDiscovery:        !fullBuild,
 		}
 		compileReqJson, _ := json.MarshalIndent(compileReq, "", "  ")
 		logger.Logf("Running build with: %s", string(compileReqJson))
@@ -264,9 +266,12 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 			"--source-override", overridesJSON.String(),
 			"--build-path", buildPath.String(),
 			"--format", "json",
-			//"--clean",
-			sketchRoot.String(),
 		}
+		if !fullBuild {
+			args = append(args, "--skip-libraries-discovery")
+		}
+		args = append(args, sketchRoot.String())
+
 		cmd, err := executils.NewProcess(nil, args...)
 		if err != nil {
 			return false, errors.Errorf("running %s: %s", strings.Join(args, " "), err)
@@ -298,6 +303,11 @@ func (ls *INOLanguageServer) generateBuildEnvironment(ctx context.Context, logge
 		success = res.Success
 	}
 
+	if fullBuild {
+		ls.CopyFullBuildResults(logger, buildPath)
+		return ls.generateBuildEnvironment(ctx, false, logger)
+	}
+
 	// TODO: do canonicalization directly in `arduino-cli`
 	canonicalizeCompileCommandsJSON(buildPath.Join("compile_commands.json"))
 

Diff for: ls/ls.go

@@ -39,6 +39,7 @@ type INOLanguageServer struct {
 	buildPath                 *paths.Path
 	buildSketchRoot           *paths.Path
 	buildSketchCpp            *paths.Path
+	fullBuildPath             *paths.Path
 	sketchRoot                *paths.Path
 	sketchName                string
 	sketchMapper              *sourcemapper.SketchMapper
@@ -129,9 +130,16 @@ func NewINOLanguageServer(stdin io.Reader, stdout io.Writer, config *Config) *IN
 		ls.buildSketchRoot = ls.buildPath.Join("sketch")
 	}
 
+	if tmp, err := paths.MkTempDir("", "arduino-language-server"); err != nil {
+		log.Fatalf("Could not create temp folder: %s", err)
+	} else {
+		ls.fullBuildPath = tmp.Canonical()
+	}
+
 	logger.Logf("Initial board configuration: %s", ls.config.Fqbn)
 	logger.Logf("Language server build path: %s", ls.buildPath)
 	logger.Logf("Language server build sketch root: %s", ls.buildSketchRoot)
+	logger.Logf("Language server FULL build path: %s", ls.fullBuildPath)
 
 	ls.IDE = NewIDELSPServer(logger, stdin, stdout, ls)
 	ls.progressHandler = NewProgressProxy(ls.IDE.conn)
@@ -158,7 +166,7 @@ func (ls *INOLanguageServer) InitializeReqFromIDE(ctx context.Context, logger js
 		ls.sketchName = ls.sketchRoot.Base()
 		ls.buildSketchCpp = ls.buildSketchRoot.Join(ls.sketchName + ".ino.cpp")
 
-		if success, err := ls.generateBuildEnvironment(context.Background(), logger); err != nil {
+		if success, err := ls.generateBuildEnvironment(context.Background(), true, logger); err != nil {
 			logger.Logf("error starting clang: %s", err)
 			return
 		} else if !success {
@@ -1160,6 +1168,24 @@ func (ls *INOLanguageServer) TextDocumentDidCloseNotifFromIDE(logger jsonrpc.Fun
 	}
 }
 
+func (ls *INOLanguageServer) FullBuildCompletedFromIDE(logger jsonrpc.FunctionLogger, params *DidCompleteBuildParams) {
+	ls.writeLock(logger, true)
+	defer ls.writeUnlock(logger)
+
+	ls.CopyFullBuildResults(logger, params.BuildOutputUri.AsPath())
+	ls.triggerRebuild()
+}
+
+func (ls *INOLanguageServer) CopyFullBuildResults(logger jsonrpc.FunctionLogger, buildPath *paths.Path) {
+	fromCache := buildPath.Join("libraries.cache")
+	toCache := ls.buildPath.Join("libraries.cache")
+	if err := fromCache.CopyTo(toCache); err != nil {
+		logger.Logf("ERROR: updating libraries.cache: %s", err)
+	} else {
+		logger.Logf("Updated 'libraries.cache'. Copied: %v to %v", fromCache, toCache)
+	}
+}
+
 func (ls *INOLanguageServer) PublishDiagnosticsNotifFromClangd(logger jsonrpc.FunctionLogger, clangParams *lsp.PublishDiagnosticsParams) {
 	ls.readLock(logger, false)
 	defer ls.readUnlock(logger)
@@ -1343,6 +1369,10 @@ func (ls *INOLanguageServer) CleanUp() {
 		ls.buildPath.RemoveAll()
 		ls.buildPath = nil
 	}
+	if ls.fullBuildPath != nil {
+		ls.fullBuildPath.RemoveAll()
+		ls.fullBuildPath = nil
+	}
 }
 
 func (ls *INOLanguageServer) extractDataFolderFromArduinoCLI(logger jsonrpc.FunctionLogger) (*paths.Path, error) {

Diff for: ls/lsp_server_ide.go

@@ -20,6 +20,7 @@ func NewIDELSPServer(logger jsonrpc.FunctionLogger, in io.Reader, out io.Writer,
 		ls: ls,
 	}
 	server.conn = lsp.NewServer(in, out, server)
+	server.conn.RegisterCustomNotification("ino/didCompleteBuild", server.ArduinoBuildCompleted)
 	server.conn.SetLogger(&LSPLogger{
 		IncomingPrefix: "IDE --> LS",
 		OutgoingPrefix: "IDE <-- LS",
@@ -274,3 +275,17 @@ func (server *IDELSPServer) TextDocumentDidSave(logger jsonrpc.FunctionLogger, p
 func (server *IDELSPServer) TextDocumentDidClose(logger jsonrpc.FunctionLogger, params *lsp.DidCloseTextDocumentParams) {
 	server.ls.TextDocumentDidCloseNotifFromIDE(logger, params)
 }
+
+// DidCompleteBuildParams is a custom notification from the Arduino IDE, sent
+type DidCompleteBuildParams struct {
+	BuildOutputUri *lsp.DocumentURI `json:"buildOutputUri"`
+}
+
+func (server *IDELSPServer) ArduinoBuildCompleted(logger jsonrpc.FunctionLogger, raw json.RawMessage) {
+	var params DidCompleteBuildParams
+	if err := json.Unmarshal(raw, &params); err != nil {
+		logger.Logf("ERROR decoding DidCompleteBuildParams: %s", err)
+	} else {
+		server.ls.FullBuildCompletedFromIDE(logger, &params)
+	}
+}