Show error message when preprocessing fails

Author: spoenemann

go.mod

@@ -4,6 +4,7 @@ go 1.12
 
 require (
 	github.com/gorilla/websocket v1.4.0 // indirect
+	github.com/pkg/errors v0.8.1
 	github.com/sourcegraph/go-lsp v0.0.0-20181119182933-0c7d621186c1
 	github.com/sourcegraph/jsonrpc2 v0.0.0-20190106185902-35a74f039c6a
 )

go.sum

@@ -1,5 +1,7 @@
 github.com/gorilla/websocket v1.4.0 h1:WDFjx/TMzVgy9VdMMQi2K2Emtwi2QcUQsztZ/zLaH/Q=
 github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/sourcegraph/go-lsp v0.0.0-20181119182933-0c7d621186c1 h1:O1d7nVzpGmP5pGAZBSlp9TSpjNwwI0xThxhPd9oVJuU=
 github.com/sourcegraph/go-lsp v0.0.0-20181119182933-0c7d621186c1/go.mod h1:tpps84QRlOVVLYk5QpKYX8Tr289D1v/UTWDLqeguiqM=
 github.com/sourcegraph/jsonrpc2 v0.0.0-20190106185902-35a74f039c6a h1:jTZwOlrDhmk4Ez2vhWh7kA0eKUahp1lCO2uyM4fi/Qk=

handler/builder.go

@@ -9,15 +9,19 @@ import (
 	"os/exec"
 	"path/filepath"
 	"strings"
+
+	"github.com/pkg/errors"
 )
 
 func generateCpp(inoCode []byte, name, fqbn string) (cppPath string, cppCode []byte, err error) {
 	rawTempDir, err := ioutil.TempDir("", "ino2cpp-")
 	if err != nil {
+		err = errors.Wrap(err, "Error while creating temporary directory.")
 		return
 	}
 	tempDir, err := filepath.EvalSymlinks(rawTempDir)
 	if err != nil {
+		err = errors.Wrap(err, "Error while resolving symbolic links of temporary directory.")
 		return
 	}
 
@@ -28,6 +32,7 @@ func generateCpp(inoCode []byte, name, fqbn string) (cppPath string, cppCode []b
 	inoPath := filepath.Join(tempDir, name)
 	err = ioutil.WriteFile(inoPath, inoCode, 0600)
 	if err != nil {
+		err = errors.Wrap(err, "Error while writing source file to temporary directory.")
 		return
 	}
 	if enableLogging {
@@ -47,14 +52,16 @@ func generateCpp(inoCode []byte, name, fqbn string) (cppPath string, cppCode []b
 	preprocessCmd := exec.Command(globalCliPath, "compile", "--fqbn", fqbn, "--preprocess", inoPath)
 	cppCode, err = preprocessCmd.Output()
 	if err != nil {
-		logCommandErr(globalCliPath, cppCode, err)
+		err = logCommandErr(globalCliPath, cppCode, err, errMsgFilter(tempDir))
 		return
 	}
 
 	// Write target file to temp dir
 	cppPath = filepath.Join(tempDir, name+".cpp")
 	err = ioutil.WriteFile(cppPath, cppCode, 0600)
-	if err == nil && enableLogging {
+	if err != nil {
+		err = errors.Wrap(err, "Error while writing target file to temporary directory.")
+	} else if enableLogging {
 		log.Println("Target file written to", cppPath)
 	}
 	return
@@ -65,37 +72,41 @@ func updateCpp(inoCode []byte, fqbn, cppPath string) (cppCode []byte, err error)
 	inoPath := strings.TrimSuffix(cppPath, ".cpp")
 	err = ioutil.WriteFile(inoPath, inoCode, 0600)
 	if err != nil {
+		err = errors.Wrap(err, "Error while writing source file to temporary directory.")
 		return
 	}
 
 	// Generate target file
 	preprocessCmd := exec.Command(globalCliPath, "compile", "--fqbn", fqbn, "--preprocess", inoPath)
 	cppCode, err = preprocessCmd.Output()
 	if err != nil {
-		logCommandErr(globalCliPath, cppCode, err)
+		err = logCommandErr(globalCliPath, cppCode, err, errMsgFilter(filepath.Dir(inoPath)))
 		return
 	}
 
 	// Write target file to temp dir
 	err = ioutil.WriteFile(cppPath, cppCode, 0600)
+	if err != nil {
+		err = errors.Wrap(err, "Error while writing target file to temporary directory.")
+	}
 	return
 }
 
 func generateCompileFlags(tempDir, inoPath, fqbn string) (string, error) {
 	propertiesCmd := exec.Command(globalCliPath, "compile", "--fqbn", fqbn, "--show-properties", inoPath)
 	output, err := propertiesCmd.Output()
 	if err != nil {
-		logCommandErr(globalCliPath, output, err)
+		err = logCommandErr(globalCliPath, output, err, errMsgFilter(tempDir))
 		return "", err
 	}
 	properties, err := readProperties(bytes.NewReader(output))
 	if err != nil {
-		return "", err
+		return "", errors.Wrap(err, "Error while reading build properties.")
 	}
 	flagsPath := filepath.Join(tempDir, "compile_flags.txt")
 	outFile, err := os.OpenFile(flagsPath, os.O_WRONLY|os.O_CREATE, 0600)
 	if err != nil {
-		return flagsPath, err
+		return flagsPath, errors.Wrap(err, "Error while creating output file for compile flags.")
 	}
 	defer outFile.Close()
 	writer := bufio.NewWriter(outFile)
@@ -125,15 +136,30 @@ func generateCompileFlags(tempDir, inoPath, fqbn string) (string, error) {
 	return flagsPath, nil
 }
 
-func logCommandErr(command string, stdout []byte, err error) {
+func logCommandErr(command string, stdout []byte, err error, filter func(string) string) error {
+	message := ""
 	log.Println("Command error:", command, err)
 	if len(stdout) > 0 {
-		log.Println("------------------------------BEGIN STDOUT\n", string(stdout), "\n------------------------------END STDOUT")
+		stdoutStr := string(stdout)
+		log.Println("------------------------------BEGIN STDOUT\n", stdoutStr, "\n------------------------------END STDOUT")
+		message += filter(stdoutStr)
 	}
 	if exitErr, ok := err.(*exec.ExitError); ok {
 		stderr := exitErr.Stderr
 		if len(stderr) > 0 {
-			log.Println("------------------------------BEGIN STDERR\n", string(stderr), "\n------------------------------END STDERR")
+			stderrStr := string(stderr)
+			log.Println("------------------------------BEGIN STDERR\n", stderrStr, "\n------------------------------END STDERR")
+			message += filter(stderrStr)
 		}
 	}
+	return errors.Wrap(err, message)
+}
+
+func errMsgFilter(tempDir string) func(string) string {
+	if !strings.HasSuffix(tempDir, string(filepath.Separator)) {
+		tempDir += string(filepath.Separator)
+	}
+	return func(s string) string {
+		return strings.ReplaceAll(s, tempDir, "")
+	}
 }

handler/handler.go

@@ -56,7 +56,7 @@ type FileData struct {
 
 // FromStdio handles a message received from the client (via stdio).
 func (handler *InoHandler) FromStdio(ctx context.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) {
-	params, uri, err := handler.transformClangdParams(req.Method, req.Params)
+	params, uri, err := handler.transformClangdParams(ctx, req.Method, req.Params)
 	if err != nil {
 		log.Println("From stdio: Method:", req.Method, "Error:", err)
 		return nil, err
@@ -80,7 +80,7 @@ func (handler *InoHandler) FromStdio(ctx context.Context, conn *jsonrpc2.Conn, r
 	return result, err
 }
 
-func (handler *InoHandler) transformClangdParams(method string, raw *json.RawMessage) (params interface{}, uri lsp.DocumentURI, err error) {
+func (handler *InoHandler) transformClangdParams(ctx context.Context, method string, raw *json.RawMessage) (params interface{}, uri lsp.DocumentURI, err error) {
 	params, err = readParams(method, raw)
 	if err != nil {
 		return
@@ -92,7 +92,7 @@ func (handler *InoHandler) transformClangdParams(method string, raw *json.RawMes
 	case "textDocument/didOpen":
 		p := params.(*lsp.DidOpenTextDocumentParams)
 		uri = p.TextDocument.URI
-		err = handler.ino2cppTextDocumentItem(&p.TextDocument)
+		err = handler.ino2cppTextDocumentItem(ctx, &p.TextDocument)
 	case "textDocument/didChange":
 		p := params.(*lsp.DidChangeTextDocumentParams)
 		uri = p.TextDocument.URI
@@ -156,12 +156,14 @@ func (handler *InoHandler) transformClangdParams(method string, raw *json.RawMes
 	return
 }
 
-func (handler *InoHandler) createFileData(sourceURI lsp.DocumentURI, sourceText string) (*FileData, []byte, error) {
+func (handler *InoHandler) createFileData(ctx context.Context, sourceURI lsp.DocumentURI, sourceText string) (*FileData, []byte, error) {
 	sourcePath := uriToPath(sourceURI)
 	// TODO get board from sketch config
 	fqbn := "arduino:avr:uno"
 	targetPath, targetBytes, err := generateCpp([]byte(sourceText), filepath.Base(sourcePath), fqbn)
 	if err != nil {
+		message := "Could not start editor support:\n" + err.Error()
+		go handler.showMessage(ctx, lsp.MTError, message)
 		return nil, nil, err
 	}
 
@@ -230,9 +232,9 @@ func (handler *InoHandler) ino2cppTextDocumentIdentifier(doc *lsp.TextDocumentId
 	return nil
 }
 
-func (handler *InoHandler) ino2cppTextDocumentItem(doc *lsp.TextDocumentItem) error {
+func (handler *InoHandler) ino2cppTextDocumentItem(ctx context.Context, doc *lsp.TextDocumentItem) error {
 	if strings.HasSuffix(string(doc.URI), ".ino") {
-		data, targetBytes, err := handler.createFileData(doc.URI, doc.Text)
+		data, targetBytes, err := handler.createFileData(ctx, doc.URI, doc.Text)
 		if err != nil {
 			return err
 		}
@@ -517,6 +519,14 @@ func (handler *InoHandler) cpp2inoPublishDiagnosticsParams(params *lsp.PublishDi
 	return nil
 }
 
+func (handler *InoHandler) showMessage(ctx context.Context, msgType lsp.MessageType, message string) {
+	params := lsp.ShowMessageParams{
+		Type:    msgType,
+		Message: strings.ReplaceAll(message, "\n", "<br>"),
+	}
+	handler.StdioConn.Notify(ctx, "window/showMessage", &params)
+}
+
 func uriToPath(uri lsp.DocumentURI) string {
 	url, err := url.Parse(string(uri))
 	if err != nil {