Fix progressbar

Port of arduino/arduino-builder#289

Author: facchinm

legacy/builder/builder.go

@@ -143,7 +143,7 @@ func (s *PreprocessSketch) Run(ctx *types.Context) error {
 	} else {
 		commands = append(commands, &ContainerAddPrototypes{})
 	}
-	return runCommands(ctx, commands, true)
+	return runCommands(ctx, commands, false)
 }
 
 type Preprocess struct{}
@@ -201,12 +201,12 @@ func (s *ParseHardwareAndDumpBuildProperties) Run(ctx *types.Context) error {
 func runCommands(ctx *types.Context, commands []types.Command, progressEnabled bool) error {
 
 	ctx.Progress.PrintEnabled = progressEnabled
-	ctx.Progress.Progress = 0
 
 	for _, command := range commands {
 		PrintRingNameIfDebug(ctx, command)
-		ctx.Progress.Steps = 100.0 / float64(len(commands))
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		stepSize := float64(100-(6*len(ctx.ImportedLibraries))) / float64(len(commands))
+		ctx.Progress.Steps = stepSize
+		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx, progressEnabled, stepSize)
 		err := command.Run(ctx)
 		if err != nil {
 			return i18n.WrapError(err)

legacy/builder/builder_utils/utils.go

@@ -46,16 +46,20 @@ import (
 	"github.com/arduino/go-properties-orderedmap"
 )
 
-func PrintProgressIfProgressEnabledAndMachineLogger(ctx *types.Context) {
+func PrintProgressIfProgressEnabledAndMachineLogger(ctx *types.Context, progressEnabled bool, stepSize float64) {
 
-	if !ctx.Progress.PrintEnabled {
+	var mut sync.Mutex
+	if !progressEnabled {
 		return
 	}
 
 	log := ctx.GetLogger()
 	if log.Name() == "machine" {
+		mut.Lock()
 		log.Println(constants.LOG_LEVEL_INFO, constants.MSG_PROGRESS, strconv.FormatFloat(ctx.Progress.Progress, 'f', 2, 32))
-		ctx.Progress.Progress += ctx.Progress.Steps
+		ctx.Progress.Progress += stepSize
+		log.Flush()
+		mut.Unlock()
 	}
 }
 
@@ -174,11 +178,11 @@ func compileFilesWithRecipe(ctx *types.Context, sourcePath *paths.Path, sources
 	var errors []error
 	var errorsMux sync.Mutex
 
-	ctx.Progress.Steps = ctx.Progress.Steps / float64(len(sources))
+	stepSize := ctx.Progress.Steps / float64(len(sources))
 
 	queue := make(chan *paths.Path)
 	job := func(source *paths.Path) {
-		PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		go PrintProgressIfProgressEnabledAndMachineLogger(ctx, true, stepSize)
 		objectFile, err := compileFileWithRecipe(ctx, sourcePath, source, buildPath, buildProperties, includes, recipe)
 		if err != nil {
 			errorsMux.Lock()

legacy/builder/container_find_includes.go

@@ -148,8 +148,11 @@ func (s *ContainerFindIncludes) Run(ctx *types.Context) error {
 		queueSourceFilesFromFolder(ctx, sourceFilePaths, sketch, srcSubfolderPath, true /* recurse */)
 	}
 
+	stepSize := ctx.Progress.Steps / 20.0
+	stepLimit := ctx.Progress.Progress + ctx.Progress.Steps
+
 	for !sourceFilePaths.Empty() {
-		err := findIncludesUntilDone(ctx, cache, sourceFilePaths.Pop())
+		err := findIncludesUntilDone(ctx, cache, sourceFilePaths.Pop(), stepSize, stepLimit)
 		if err != nil {
 			cachePath.Remove()
 			return i18n.WrapError(err)
@@ -290,7 +293,7 @@ func writeCache(cache *includeCache, path *paths.Path) error {
 	return nil
 }
 
-func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile types.SourceFile) error {
+func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile types.SourceFile, stepSize, stepLimit float64) error {
 	sourcePath := sourceFile.SourcePath(ctx)
 	targetFilePath := paths.NullPath()
 	depPath := sourceFile.DepfilePath(ctx)
@@ -318,6 +321,8 @@ func findIncludesUntilDone(ctx *types.Context, cache *includeCache, sourceFile t
 		var include string
 		cache.ExpectFile(sourcePath)
 
+		go builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx, ctx.Progress.Progress < stepLimit, stepSize)
+
 		includes := ctx.IncludeFolders
 		if library, ok := sourceFile.Origin.(*libraries.Library); ok && library.UtilityDir != nil {
 			includes = append(includes, library.UtilityDir)

legacy/builder/container_setup.go

@@ -52,10 +52,11 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 		&LibrariesLoader{},
 	}
 
-	ctx.Progress.Steps = ctx.Progress.Steps / float64(len(commands))
+	stepSize := ctx.Progress.Steps / float64(len(commands))
+	ctx.Progress.Steps = stepSize
 
 	for _, command := range commands {
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx, ctx.Progress.PrintEnabled, stepSize)
 		PrintRingNameIfDebug(ctx, command)
 		err := command.Run(ctx)
 		if err != nil {
@@ -84,10 +85,11 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 		&AddMissingBuildPropertiesFromParentPlatformTxtFiles{},
 	}
 
-	ctx.Progress.Steps = ctx.Progress.Steps / float64(len(commands))
+	stepSize = ctx.Progress.Steps / float64(len(commands))
+	ctx.Progress.Steps = stepSize
 
 	for _, command := range commands {
-		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx)
+		builder_utils.PrintProgressIfProgressEnabledAndMachineLogger(ctx, ctx.Progress.PrintEnabled, stepSize)
 		PrintRingNameIfDebug(ctx, command)
 		err := command.Run(ctx)
 		if err != nil {