remove Progress from Context

arduino/builder/builder.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 
 	"github.com/arduino/arduino-cli/arduino/builder/logger"
+	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/go-paths-helper"
@@ -59,6 +60,9 @@ type Builder struct {
 	// Set to true to skip build and produce only Compilation Database
 	onlyUpdateCompilationDatabase bool
 
+	// Progress of all various steps
+	Progress *progress.Struct
+
 	*BuildOptionsManager
 }
 
@@ -78,6 +82,7 @@ func NewBuilder(
 	sourceOverrides map[string]string,
 	onlyUpdateCompilationDatabase bool,
 	logger *logger.BuilderLogger,
+	progressStats *progress.Struct,
 ) (*Builder, error) {
 	buildProperties := properties.NewMap()
 	if boardBuildProperties != nil {
@@ -126,6 +131,10 @@ func NewBuilder(
 		return nil, ErrSketchCannotBeLocatedInBuildPath
 	}
 
+	if progressStats == nil {
+		progressStats = progress.New(nil)
+	}
+
 	return &Builder{
 		sketch:                        sk,
 		buildProperties:               buildProperties,
@@ -140,6 +149,7 @@ func NewBuilder(
 		clean:                         clean,
 		sourceOverrides:               sourceOverrides,
 		onlyUpdateCompilationDatabase: onlyUpdateCompilationDatabase,
+		Progress:                      progressStats,
 		BuildOptionsManager: NewBuildOptionsManager(
 			hardwareDirs, builtInToolsDirs, otherLibrariesDirs,
 			builtInLibrariesDirs, buildPath,

arduino/builder/core.go

@@ -24,12 +24,10 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
-	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/buildcache"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
-	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/pkg/errors"
 )
@@ -38,7 +36,6 @@ import (
 func (b *Builder) BuildCore(
 	actualPlatform *cores.PlatformRelease,
 	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, *paths.Path, error) {
 	if err := b.coreBuildPath.MkdirAll(); err != nil {
 		return nil, nil, errors.WithStack(err)
@@ -56,11 +53,7 @@ func (b *Builder) BuildCore(
 		}
 	}
 
-	archiveFile, objectFiles, err := b.compileCore(
-		actualPlatform,
-		compilationDatabase,
-		progress, progressCB,
-	)
+	archiveFile, objectFiles, err := b.compileCore(actualPlatform, compilationDatabase)
 	if err != nil {
 		return nil, nil, errors.WithStack(err)
 	}
@@ -71,7 +64,6 @@ func (b *Builder) BuildCore(
 func (b *Builder) compileCore(
 	actualPlatform *cores.PlatformRelease,
 	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (*paths.Path, paths.PathList, error) {
 	coreFolder := b.buildProperties.GetPath("build.core.path")
 	variantFolder := b.buildProperties.GetPath("build.variant.path")
@@ -92,7 +84,7 @@ func (b *Builder) compileCore(
 			compilationDatabase,
 			b.jobs,
 			b.logger,
-			progress, progressCB,
+			b.Progress,
 		)
 		if err != nil {
 			return nil, nil, errors.WithStack(err)
@@ -143,7 +135,7 @@ func (b *Builder) compileCore(
 		compilationDatabase,
 		b.jobs,
 		b.logger,
-		progress, progressCB,
+		b.Progress,
 	)
 	if err != nil {
 		return nil, nil, errors.WithStack(err)

arduino/builder/libraries.go

@@ -21,12 +21,10 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
-	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
-	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
@@ -44,7 +42,6 @@ func (b *Builder) BuildLibraries(
 	includesFolders paths.PathList,
 	importedLibraries libraries.List,
 	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	includes := f.Map(includesFolders.AsStrings(), cpp.WrapWithHyphenI)
 	libs := importedLibraries
@@ -53,11 +50,7 @@ func (b *Builder) BuildLibraries(
 		return nil, errors.WithStack(err)
 	}
 
-	librariesObjectFiles, err := b.compileLibraries(
-		libs, includes,
-		compilationDatabase,
-		progress, progressCB,
-	)
+	librariesObjectFiles, err := b.compileLibraries(libs, includes, compilationDatabase)
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}
@@ -124,34 +117,23 @@ func (b *Builder) findExpectedPrecompiledLibFolder(
 	return nil
 }
 
-func (b *Builder) compileLibraries(
-	libraries libraries.List, includes []string,
-	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
-) (paths.PathList, error) {
-	progress.AddSubSteps(len(libraries))
-	defer progress.RemoveSubSteps()
+func (b *Builder) compileLibraries(libraries libraries.List, includes []string, compilationDatabase *compilation.Database) (paths.PathList, error) {
+	b.Progress.AddSubSteps(len(libraries))
+	defer b.Progress.RemoveSubSteps()
 
 	objectFiles := paths.NewPathList()
 	for _, library := range libraries {
 		libraryObjectFiles, err := b.compileLibrary(
 			library, includes,
 			compilationDatabase,
-			progress, progressCB,
 		)
 		if err != nil {
 			return nil, errors.WithStack(err)
 		}
 		objectFiles.AddAll(libraryObjectFiles)
 
-		progress.CompleteStep()
-		// PushProgress
-		if progressCB != nil {
-			progressCB(&rpc.TaskProgress{
-				Percent:   progress.Progress,
-				Completed: progress.Progress >= 100.0,
-			})
-		}
+		b.Progress.CompleteStep()
+		b.Progress.PushProgress()
 	}
 
 	return objectFiles, nil
@@ -160,7 +142,6 @@ func (b *Builder) compileLibraries(
 func (b *Builder) compileLibrary(
 	library *libraries.Library, includes []string,
 	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	if b.logger.Verbose() {
 		b.logger.Info(tr(`Compiling library "%[1]s"`, library.Name))
@@ -227,7 +208,7 @@ func (b *Builder) compileLibrary(
 			compilationDatabase,
 			b.jobs,
 			b.logger,
-			progress, progressCB,
+			b.Progress,
 		)
 		if err != nil {
 			return nil, errors.WithStack(err)
@@ -258,7 +239,7 @@ func (b *Builder) compileLibrary(
 			compilationDatabase,
 			b.jobs,
 			b.logger,
-			progress, progressCB,
+			b.Progress,
 		)
 		if err != nil {
 			return nil, errors.WithStack(err)
@@ -273,7 +254,7 @@ func (b *Builder) compileLibrary(
 				compilationDatabase,
 				b.jobs,
 				b.logger,
-				progress, progressCB,
+				b.Progress,
 			)
 			if err != nil {
 				return nil, errors.WithStack(err)

arduino/builder/progress/progress.go

@@ -15,11 +15,19 @@
 
 package progress
 
+import rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+
 // Struct fixdoc
 type Struct struct {
 	Progress   float32
 	StepAmount float32
 	Parent     *Struct
+	callback   rpc.TaskProgressCB
+}
+
+// New fixdoc
+func New(callback rpc.TaskProgressCB) *Struct {
+	return &Struct{callback: callback}
 }
 
 // AddSubSteps fixdoc
@@ -46,3 +54,13 @@ func (p *Struct) RemoveSubSteps() {
 func (p *Struct) CompleteStep() {
 	p.Progress += p.StepAmount
 }
+
+// PushProgress fixdoc
+func (p *Struct) PushProgress() {
+	if p.callback != nil {
+		p.callback(&rpc.TaskProgress{
+			Percent:   p.Progress,
+			Completed: p.Progress >= 100.0,
+		})
+	}
+}

arduino/builder/sketch.go

@@ -25,12 +25,10 @@ import (
 
 	"github.com/arduino/arduino-cli/arduino/builder/compilation"
 	"github.com/arduino/arduino-cli/arduino/builder/cpp"
-	"github.com/arduino/arduino-cli/arduino/builder/progress"
 	"github.com/arduino/arduino-cli/arduino/builder/utils"
 	"github.com/arduino/arduino-cli/arduino/sketch"
 	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
-	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/marcinbor85/gohex"
 
@@ -185,7 +183,6 @@ func writeIfDifferent(source []byte, destPath *paths.Path) error {
 func (b *Builder) BuildSketch(
 	includesFolders paths.PathList,
 	compilationDatabase *compilation.Database,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	includes := f.Map(includesFolders.AsStrings(), cpp.WrapWithHyphenI)
 
@@ -199,7 +196,7 @@ func (b *Builder) BuildSketch(
 		compilationDatabase,
 		b.jobs,
 		b.builderLogger,
-		progress, progressCB,
+		b.Progress,
 	)
 	if err != nil {
 		return nil, errors.WithStack(err)
@@ -214,7 +211,7 @@ func (b *Builder) BuildSketch(
 			compilationDatabase,
 			b.jobs,
 			b.builderLogger,
-			progress, progressCB,
+			b.Progress,
 		)
 		if err != nil {
 			return nil, errors.WithStack(err)

arduino/builder/sketch_test.go

@@ -54,7 +54,7 @@ func TestMergeSketchSources(t *testing.T) {
 
 	b, err := NewBuilder(
 		sk, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil)
+		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
 	require.NoError(t, err)
 
 	offset, source, err := b.sketchMergeSources(nil)
@@ -73,7 +73,7 @@ func TestMergeSketchSourcesArduinoIncluded(t *testing.T) {
 
 	// ensure not to include Arduino.h when it's already there
 	b, err := NewBuilder(sk, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil)
+		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
 	require.NoError(t, err)
 
 	_, source, err := b.sketchMergeSources(nil)
@@ -95,7 +95,7 @@ func TestCopyAdditionalFiles(t *testing.T) {
 	require.NoError(t, err)
 
 	b1, err := NewBuilder(sk1, nil, paths.New("testdata"), false, nil, 0, nil,
-		nil, nil, nil, nil, fqbn, false, nil, false, nil)
+		nil, nil, nil, nil, fqbn, false, nil, false, nil, nil)
 	require.NoError(t, err)
 
 	// copy the sketch over, create a fake main file we don't care about it

arduino/builder/utils/utils.go

@@ -33,7 +33,6 @@ import (
 	"github.com/arduino/arduino-cli/executils"
 	"github.com/arduino/arduino-cli/i18n"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
-	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-paths-helper"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/pkg/errors"
@@ -358,7 +357,7 @@ func CompileFiles(
 	compilationDatabase *compilation.Database,
 	jobs int,
 	builderLogger *logger.BuilderLogger,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct,
 ) (paths.PathList, error) {
 	return compileFiles(
 		onlyUpdateCompilationDatabase,
@@ -368,7 +367,7 @@ func CompileFiles(
 		false,
 		buildPath, buildProperties, includes,
 		builderLogger,
-		progress, progressCB,
+		progress,
 	)
 }
 
@@ -381,7 +380,7 @@ func CompileFilesRecursive(
 	compilationDatabase *compilation.Database,
 	jobs int,
 	builderLogger *logger.BuilderLogger,
-	progress *progress.Struct, progressCB rpc.TaskProgressCB,
+	progress *progress.Struct,
 ) (paths.PathList, error) {
 	return compileFiles(
 		onlyUpdateCompilationDatabase,
@@ -391,7 +390,7 @@ func CompileFilesRecursive(
 		true,
 		buildPath, buildProperties, includes,
 		builderLogger,
-		progress, progressCB,
+		progress,
 	)
 }
 
@@ -406,7 +405,6 @@ func compileFiles(
 	includes []string,
 	builderLogger *logger.BuilderLogger,
 	progress *progress.Struct,
-	progressCB rpc.TaskProgressCB,
 ) (paths.PathList, error) {
 	validExtensions := []string{}
 	for ext := range globals.SourceFilesValidExtensions {
@@ -483,13 +481,7 @@ func compileFiles(
 		queue <- source
 
 		progress.CompleteStep()
-		// PushProgress
-		if progressCB != nil {
-			progressCB(&rpc.TaskProgress{
-				Percent:   progress.Progress,
-				Completed: progress.Progress >= 100.0,
-			})
-		}
+		progress.PushProgress()
 	}
 	close(queue)
 	wg.Wait()