add sketch logs for API and CLI at start up time (#474)

Co-authored-by: mirkoCrobu <mirkocrobu@NB-0531.localdomain>
Co-authored-by: Alessio Perugini <alessio@perugini.xyz>

Author: 3 people

cmd/arduino-app-cli/app.go

@@ -258,7 +258,7 @@ func startHandler(ctx context.Context, app app.ArduinoApp) error {
 	for message := range stream {
 		switch message.GetType() {
 		case orchestrator.ProgressType:
-			fmt.Fprintf(out, "Progress: %.0f%%\n", float64(message.GetProgress().Progress)*100)
+			fmt.Fprintf(out, "Progress: %.0f%%\n", message.GetProgress().Progress)
 		case orchestrator.InfoType:
 			fmt.Fprintln(out, "[INFO]", message.GetData())
 		case orchestrator.ErrorType:
@@ -283,7 +283,7 @@ func stopHandler(ctx context.Context, app app.ArduinoApp) error {
 	for message := range orchestrator.StopApp(ctx, app) {
 		switch message.GetType() {
 		case orchestrator.ProgressType:
-			fmt.Fprintf(out, "Progress: %.0f%%\n", float64(message.GetProgress().Progress)*100)
+			fmt.Fprintf(out, "Progress: %.0f%%\n", message.GetProgress().Progress)
 		case orchestrator.InfoType:
 			fmt.Fprintln(out, "[INFO]", message.GetData())
 		case orchestrator.ErrorType:

internal/orchestrator/orchestrator.go

@@ -28,6 +28,7 @@ import (
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/app"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/bricksindex"
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator/modelsindex"
+	"github.com/bcmi-labs/orchestrator/pkg/helpers"
 	"github.com/bcmi-labs/orchestrator/pkg/micro"
 	"github.com/bcmi-labs/orchestrator/pkg/x/fatomic"
 )
@@ -122,6 +123,10 @@ func StartApp(ctx context.Context, docker *dockerClient.Client, provisioner *Pro
 		})
 
 		if app.MainSketchPath != nil {
+			if !yield(StreamMessage{data: "compiling and updating sketch..."}) {
+				cancel()
+				return
+			}
 			if err := compileUploadSketch(ctx, &app, callbackWriter); err != nil {
 				yield(StreamMessage{error: err})
 				return
@@ -879,8 +884,31 @@ func compileUploadSketch(ctx context.Context, arduinoApp *app.ArduinoApp, w io.W
 
 	if err := srv.Init(
 		initReq,
-		// TODO: implement progress callback function
-		commands.InitStreamResponseToCallbackFunction(ctx, func(r *rpc.InitResponse) error { return nil }),
+		commands.InitStreamResponseToCallbackFunction(ctx, func(r *rpc.InitResponse) error {
+			var response string
+			switch msg := r.GetMessage().(type) {
+			case *rpc.InitResponse_InitProgress:
+				if progress := msg.InitProgress.GetTaskProgress(); progress != nil {
+					response = helpers.ArduinoCLITaskProgressToString(progress)
+				}
+				if progress := msg.InitProgress.GetDownloadProgress(); progress != nil {
+					response = helpers.ArduinoCLIDownloadProgressToString(progress)
+				}
+			case *rpc.InitResponse_Error:
+				response = "Error: " + msg.Error.String()
+			case *rpc.InitResponse_Profile:
+				response = fmt.Sprintf(
+					"Sketch profile configured: FQBN=%q, Port=%q",
+					msg.Profile.GetFqbn(),
+					msg.Profile.GetPort(),
+				)
+			}
+			if _, err := w.Write([]byte(response + "\n")); err != nil {
+				return err
+			}
+
+			return nil
+		}),
 	); err != nil {
 		return err
 	}

internal/update/arduino/arduino.go

@@ -3,7 +3,6 @@ package arduino
 import (
 	"context"
 	"errors"
-	"fmt"
 	"log/slog"
 	"sync"
 	"time"
@@ -15,6 +14,7 @@ import (
 
 	"github.com/bcmi-labs/orchestrator/internal/orchestrator"
 	"github.com/bcmi-labs/orchestrator/internal/update"
+	"github.com/bcmi-labs/orchestrator/pkg/helpers"
 )
 
 type ArduinoPlatformUpdater struct {
@@ -111,12 +111,12 @@ func (a *ArduinoPlatformUpdater) UpgradePackages(ctx context.Context, names []st
 	eventsCh := make(chan update.Event, 100)
 
 	downloadProgressCB := func(curr *rpc.DownloadProgress) {
-		data := arduinoCLIDownloadProgressToString(curr)
+		data := helpers.ArduinoCLIDownloadProgressToString(curr)
 		slog.Debug("Download progress", slog.String("download_progress", data))
 		eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: data}
 	}
 	taskProgressCB := func(msg *rpc.TaskProgress) {
-		data := arduinoCLITaskProgressToString(msg)
+		data := helpers.ArduinoCLITaskProgressToString(msg)
 		slog.Debug("Task progress", slog.String("task_progress", data))
 		eventsCh <- update.Event{Type: update.UpgradeLineEvent, Data: data}
 	}
@@ -262,28 +262,3 @@ func (a *ArduinoPlatformUpdater) UpgradePackages(ctx context.Context, names []st
 
 	return eventsCh, nil
 }
-
-func arduinoCLIDownloadProgressToString(progress *rpc.DownloadProgress) string {
-	switch {
-	case progress.GetStart() != nil:
-		return fmt.Sprintf("Download started: %s", progress.GetStart().GetUrl())
-	case progress.GetUpdate() != nil:
-		return fmt.Sprintf("Download progress: %s", progress.GetUpdate())
-	case progress.GetEnd() != nil:
-		return fmt.Sprintf("Download completed: %s", progress.GetEnd())
-	}
-	return progress.String()
-}
-
-func arduinoCLITaskProgressToString(progress *rpc.TaskProgress) string {
-	data := fmt.Sprintf("Task %s:", progress.GetName())
-	if progress.GetMessage() != "" {
-		data += fmt.Sprintf(" (%s)", progress.GetMessage())
-	}
-	if progress.GetCompleted() {
-		data += " completed"
-	} else {
-		data += fmt.Sprintf(" %.2f%%", progress.GetPercent())
-	}
-	return data
-}

pkg/helpers/helpers.go

@@ -0,0 +1,32 @@
+package helpers
+
+import (
+	"fmt"
+
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+func ArduinoCLIDownloadProgressToString(progress *rpc.DownloadProgress) string {
+	switch {
+	case progress.GetStart() != nil:
+		return fmt.Sprintf("Download started: %s", progress.GetStart().GetUrl())
+	case progress.GetUpdate() != nil:
+		return fmt.Sprintf("Download progress: %s", progress.GetUpdate())
+	case progress.GetEnd() != nil:
+		return fmt.Sprintf("Download completed: %s", progress.GetEnd())
+	}
+	return progress.String()
+}
+
+func ArduinoCLITaskProgressToString(progress *rpc.TaskProgress) string {
+	data := fmt.Sprintf("Task %s:", progress.GetName())
+	if progress.GetMessage() != "" {
+		data += fmt.Sprintf(" (%s)", progress.GetMessage())
+	}
+	if progress.GetCompleted() {
+		data += " completed"
+	} else {
+		data += fmt.Sprintf(" %.2f%%", progress.GetPercent())
+	}
+	return data
+}