legacy: builder task progress is now transferred via TaskProgress callback

Author: cmaglie

commands/compile/compile.go

@@ -132,6 +132,7 @@ func Compile(ctx context.Context, req *rpc.CompileRequest, outStream, errStream
 	builderCtx.PackageManager = pm
 	builderCtx.FQBN = fqbn
 	builderCtx.SketchLocation = sk.FullPath
+	builderCtx.ProgressCB = progressCB
 
 	// FIXME: This will be redundant when arduino-builder will be part of the cli
 	builderCtx.HardwareDirs = configuration.HardwareDirectories(configuration.Settings)

legacy/builder/builder.go

@@ -23,7 +23,6 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/i18n"
-	"github.com/arduino/arduino-cli/legacy/builder/builder_utils"
 	"github.com/arduino/arduino-cli/legacy/builder/phases"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/arduino/arduino-cli/legacy/builder/utils"
@@ -195,7 +194,7 @@ func runCommands(ctx *types.Context, commands []types.Command) error {
 			return errors.WithStack(err)
 		}
 		ctx.Progress.CompleteStep()
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		ctx.PushProgress()
 	}
 	return nil
 }

legacy/builder/builder_utils/utils.go

@@ -20,7 +20,6 @@ import (
 	"os/exec"
 	"path/filepath"
 	"runtime"
-	"strconv"
 	"strings"
 	"sync"
 
@@ -35,18 +34,6 @@ import (
 
 var tr = i18n.Tr
 
-func PrintProgressIfProgressEnabledAndMachineLogger(ctx *types.Context) {
-
-	if !ctx.Progress.PrintEnabled {
-		return
-	}
-
-	log := ctx.GetLogger()
-	if log.Name() == "machine" {
-		log.Println(constants.LOG_LEVEL_INFO, tr("Progress {0}"), strconv.FormatFloat(float64(ctx.Progress.Progress), 'f', 2, 32))
-	}
-}
-
 func CompileFilesRecursive(ctx *types.Context, sourcePath *paths.Path, buildPath *paths.Path, buildProperties *properties.Map, includes []string) (paths.PathList, error) {
 	objectFiles, err := CompileFiles(ctx, sourcePath, false, buildPath, buildProperties, includes)
 	if err != nil {
@@ -215,7 +202,7 @@ func compileFilesWithRecipe(ctx *types.Context, sourcePath *paths.Path, sources
 		queue <- source
 
 		ctx.Progress.CompleteStep()
-		PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		ctx.PushProgress()
 	}
 	close(queue)
 	wg.Wait()

legacy/builder/container_setup.go

@@ -19,7 +19,6 @@ import (
 	"fmt"
 
 	sk "github.com/arduino/arduino-cli/arduino/sketch"
-	"github.com/arduino/arduino-cli/legacy/builder/builder_utils"
 	"github.com/arduino/arduino-cli/legacy/builder/types"
 	"github.com/pkg/errors"
 )
@@ -50,7 +49,7 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 			return errors.WithStack(err)
 		}
 		ctx.Progress.CompleteStep()
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		ctx.PushProgress()
 	}
 
 	if ctx.SketchLocation != nil {
@@ -78,7 +77,7 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 		ctx.Sketch = sketch
 	}
 	ctx.Progress.CompleteStep()
-	builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+	ctx.PushProgress()
 
 	commands = []types.Command{
 		&SetupBuildProperties{},
@@ -94,7 +93,7 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 			return errors.WithStack(err)
 		}
 		ctx.Progress.CompleteStep()
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		ctx.PushProgress()
 	}
 
 	return nil

legacy/builder/phases/libraries_builder.go

@@ -123,7 +123,7 @@ func compileLibraries(ctx *types.Context, libraries libraries.List, buildPath *p
 		objectFiles.AddAll(libraryObjectFiles)
 
 		ctx.Progress.CompleteStep()
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		ctx.PushProgress()
 	}
 
 	return objectFiles, nil

legacy/builder/types/context.go

@@ -26,17 +26,17 @@ import (
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesmanager"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesresolver"
 	"github.com/arduino/arduino-cli/arduino/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/legacy/builder/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 	properties "github.com/arduino/go-properties-orderedmap"
 )
 
 type ProgressStruct struct {
-	PrintEnabled bool
-	Progress     float32
-	StepAmount   float32
-	Parent       *ProgressStruct
+	Progress   float32
+	StepAmount float32
+	Parent     *ProgressStruct
 }
 
 func (p *ProgressStruct) AddSubSteps(steps int) {
@@ -144,6 +144,8 @@ type Context struct {
 
 	// Dry run, only create progress map
 	Progress ProgressStruct
+	// Send progress events to this callback
+	ProgressCB commands.TaskProgressCB
 
 	// Contents of a custom build properties file (line by line)
 	CustomBuildProperties []string
@@ -254,3 +256,9 @@ func (ctx *Context) GetLogger() i18n.Logger {
 func (ctx *Context) SetLogger(l i18n.Logger) {
 	ctx.logger = l
 }
+
+func (ctx *Context) PushProgress() {
+	if ctx.ProgressCB != nil {
+		ctx.ProgressCB(&rpc.TaskProgress{Percent: ctx.Progress.Progress})
+	}
+}