feat(logging): show image index and total to indicate build progress

Signed-off-by: Aleksei Igrychev <aleksei.igrychev@palark.com>

Author: alexey-igrychev

pkg/build/build_phase.go

@@ -265,12 +265,12 @@ func (phase *BuildPhase) AfterImages(ctx context.Context) error {
 				}
 			}
 		} else {
-			img := image.NewMultiplatformImage(name, images)
+			img := image.NewMultiplatformImage(name, images, taskId, len(images))
 			phase.Conveyor.imagesTree.SetMultiplatformImage(img)
 
 			// TODO: Separate LocalStagesStorage and RepoStagesStorage interfaces, local should not include metadata publishing methods at all
 			if _, isLocal := phase.Conveyor.StorageManager.GetStagesStorage().(*storage.LocalStagesStorage); !isLocal {
-				if err := logboek.Context(ctx).LogProcess(logging.ImageLogProcessName(name, img.IsFinal, "")).
+				if err := logboek.Context(ctx).LogProcess(img.LogDetailedName()).
 					Options(func(options types.LogProcessOptionsInterface) {
 						options.Style(logging.ImageMetadataStyle())
 					}).

pkg/build/image/image.go

@@ -115,6 +115,9 @@ type Image struct {
 
 	baseStageImage   *stage.StageImage
 	stageAsBaseImage stage.Interface
+
+	logImageIndex  int
+	logTotalImages int
 }
 
 func (i *Image) LogName() string {
@@ -130,7 +133,7 @@ func (i *Image) LogDetailedName() string {
 	if i.ShouldLogPlatform() {
 		targetPlatformForLog = i.TargetPlatform
 	}
-	return logging.ImageLogProcessName(i.Name, i.IsFinal, targetPlatformForLog)
+	return logging.ImageLogProcessName(i.Name, i.IsFinal, targetPlatformForLog, logging.WithProgress(i.logImageIndex+1, i.logTotalImages))
 }
 
 func (i *Image) LogProcessStyle() color.Style {

pkg/build/image/image_tree.go

@@ -126,6 +126,11 @@ func (tree *ImagesTree) Calculate(ctx context.Context) error {
 	tree.imagesSets = builder.GetImagesSets()
 	tree.images = builder.GetImages()
 
+	for ind, img := range tree.images {
+		img.logImageIndex = ind
+		img.logTotalImages = len(tree.images)
+	}
+
 	return nil
 }
 

pkg/build/image/multiplatform_image.go

@@ -4,6 +4,7 @@ import (
 	"github.com/werf/common-go/pkg/util"
 	"github.com/werf/werf/v2/pkg/image"
 	common_image "github.com/werf/werf/v2/pkg/image"
+	"github.com/werf/werf/v2/pkg/logging"
 )
 
 type MultiplatformImage struct {
@@ -15,17 +16,22 @@ type MultiplatformImage struct {
 	stageID          common_image.StageID
 	stageDesc        *common_image.StageDesc
 	finalStageDesc   *common_image.StageDesc
+
+	logImageIndex int
+	logImageTotal int
 }
 
-func NewMultiplatformImage(name string, images []*Image) *MultiplatformImage {
+func NewMultiplatformImage(name string, images []*Image, logImageIndex, logImageTotal int) *MultiplatformImage {
 	if len(images) == 0 {
 		panic("expected at least one image")
 	}
 
 	img := &MultiplatformImage{
-		Name:    name,
-		IsFinal: images[0].IsFinal,
-		Images:  images,
+		Name:          name,
+		IsFinal:       images[0].IsFinal,
+		Images:        images,
+		logImageIndex: logImageIndex,
+		logImageTotal: logImageTotal,
 	}
 
 	metaStageDeps := util.MapFuncToSlice(images, func(img *Image) string {
@@ -72,3 +78,7 @@ func (img *MultiplatformImage) GetStageDesc() *image.StageDesc {
 func (img *MultiplatformImage) SetStageDesc(stageDesc *common_image.StageDesc) {
 	img.stageDesc = stageDesc
 }
+
+func (img *MultiplatformImage) LogDetailedName() string {
+	return logging.ImageLogProcessName(img.Name, img.IsFinal, "", logging.WithProgress(img.logImageIndex+1, img.logImageTotal))
+}

pkg/cleaning/cleanup.go

@@ -396,7 +396,9 @@ func (m *cleanupManager) gitHistoryBasedCleanup(ctx context.Context) error {
 		var reachedStageIDs []string
 		var hitStageIDCommitList map[string][]string
 		// TODO(multiarch): iterate target platforms
-		if err := logboek.Context(ctx).LogProcess(logging.ImageLogProcessName(imageName, false, "")).DoError(func() error {
+
+		header := logging.ImageLogProcessName(imageName, false, "", logging.WithProgress(taskId+1, len(imagePairs)))
+		if err := logboek.Context(ctx).LogProcess(header).DoError(func() error {
 			if logboek.Context(ctx).Streams().Width() > 120 {
 				m.printStageIDCommitListTable(ctx, imageName)
 				m.printStageIDCustomTagListTable(ctx)

pkg/logging/image.go

@@ -7,8 +7,8 @@ import (
 )
 
 var (
-	finalImageNameFormat        = "🛳️  image %s"
-	intermediateImageNameFormat = "🏗️️  image %s"
+	finalImagePrettyPrefix        = "🛳️  "
+	intermediateImagePrettyPrefix = "🏗️️  "
 )
 
 func ImageLogName(name string) string {
@@ -18,26 +18,51 @@ func ImageLogName(name string) string {
 	return name
 }
 
-func ImageLogProcessName(name string, isFinal bool, targetPlatform string) string {
-	appendPlatformFunc := func(name string) string {
-		if targetPlatform == "" {
-			return name
-		}
-		return fmt.Sprintf("%s [%s]", name, targetPlatform)
+func WithProgress(index, total int) Option {
+	return func(o *Options) {
+		o.withProgress = true
+		o.index = index
+		o.total = total
+	}
+}
+
+type Options struct {
+	withProgress bool
+	index        int
+	total        int
+}
+
+type Option func(*Options)
+
+func ImageLogProcessName(name string, isFinal bool, targetPlatform string, opts ...Option) string {
+	options := &Options{}
+	for _, opt := range opts {
+		opt(options)
 	}
 
-	logName := ImageLogName(name)
+	var res string
+	res += "image" + " " + ImageLogName(name)
+
+	if targetPlatform != "" {
+		res += " [" + targetPlatform + "]"
+	}
+
+	if options.withProgress {
+		res = fmt.Sprintf("(%d/%d)", options.index, options.total) + " " + res
+	}
 
 	if isFinal {
-		return appendPlatformFunc(fmt.Sprintf(finalImageNameFormat, logName))
+		res = finalImagePrettyPrefix + res
 	} else {
-		return appendPlatformFunc(fmt.Sprintf(intermediateImageNameFormat, logName))
+		res = intermediateImagePrettyPrefix + res
 	}
+
+	return res
 }
 
 func DisablePrettyLog() {
-	finalImageNameFormat = "image %s"
-	intermediateImageNameFormat = "image %s"
+	finalImagePrettyPrefix = ""
+	intermediateImagePrettyPrefix = ""
 }
 
 func ImageDefaultStyle(isFinal bool) color.Style {