Merge pull request #96 from arduino/fix_progress_leak

Send progress-end messages before shutting down

Author: cmaglie

Diff for: ls/ls.go

@@ -363,7 +363,13 @@ func (ls *INOLanguageServer) InitializeReqFromIDE(ctx context.Context, logger js
 }
 
 func (ls *INOLanguageServer) ShutdownReqFromIDE(ctx context.Context, logger jsonrpc.FunctionLogger) *jsonrpc.ResponseError {
+	done := make(chan bool)
+	go func() {
+		ls.progressHandler.Shutdown()
+		close(done)
+	}()
 	_, _ = ls.Clangd.conn.Shutdown(context.Background())
+	<-done
 	return nil
 }
 

Diff for: ls/progress.go

@@ -109,7 +109,7 @@ func (p *ProgressProxyHandler) handleProxy(id string, proxy *progressProxy) {
 
 			proxy.reportReq = nil
 			if err != nil {
-				log.Printf("ProgressHandler: error sending begin req token %s: %v", id, err)
+				log.Printf("ProgressHandler: error sending report req token %s: %v", id, err)
 			} else {
 				proxy.requiredStatus = progressProxyBegin
 			}
@@ -122,7 +122,7 @@ func (p *ProgressProxyHandler) handleProxy(id string, proxy *progressProxy) {
 
 			proxy.endReq = nil
 			if err != nil {
-				log.Printf("ProgressHandler: error sending begin req token %s: %v", id, err)
+				log.Printf("ProgressHandler: error sending end req token %s: %v", id, err)
 			} else {
 				proxy.currentStatus = progressProxyEnd
 			}
@@ -196,3 +196,27 @@ func (p *ProgressProxyHandler) End(id string, req *lsp.WorkDoneProgressEnd) {
 	proxy.requiredStatus = progressProxyEnd
 	p.actionRequiredCond.Broadcast()
 }
+
+func (p *ProgressProxyHandler) Shutdown() {
+	p.mux.Lock()
+	defer p.mux.Unlock()
+
+	for id, proxy := range p.proxies {
+		err := p.conn.Progress(&lsp.ProgressParams{
+			Token: lsp.EncodeMessage(id),
+			Value: lsp.EncodeMessage(&lsp.WorkDoneProgressEnd{
+				Message: "Shutdown",
+			}),
+		})
+
+		proxy.endReq = nil
+		if err != nil {
+			log.Printf("ProgressHandler: error sending end req token %s: %v", id, err)
+		} else {
+			proxy.currentStatus = progressProxyEnd
+			proxy.requiredStatus = progressProxyEnd
+		}
+	}
+
+	p.actionRequiredCond.Broadcast()
+}