refactor logProgress

Author: zhangchiqing

ledger/complete/wal/checkpointer.go

@@ -24,6 +24,7 @@ import (
 	"github.com/onflow/flow-go/ledger/complete/mtrie/trie"
 	"github.com/onflow/flow-go/model/bootstrap"
 	"github.com/onflow/flow-go/module/metrics"
+	"github.com/onflow/flow-go/module/util"
 	utilsio "github.com/onflow/flow-go/utils/io"
 )
 
@@ -516,15 +517,9 @@ func StoreCheckpointV5(dir string, fileName string, logger *zerolog.Logger, trie
 }
 
 func logProgress(msg string, estimatedSubtrieNodeCount int, logger *zerolog.Logger) func(nodeCounter uint64) {
-	lookup := make(map[int]int)
-	for i := 1; i < 10; i++ { // [1...9]
-		lookup[estimatedSubtrieNodeCount/10*i] = i * 10
-	}
-	return func(nodeCounter uint64) {
-		percentage, ok := lookup[int(nodeCounter)]
-		if ok {
-			logger.Info().Msgf("%s completion percentage: %v percent", msg, percentage)
-		}
+	lg := util.LogProgress(msg, estimatedSubtrieNodeCount, logger)
+	return func(index uint64) {
+		lg(int(index))
 	}
 }
 

module/util/log.go

@@ -4,8 +4,12 @@ import (
 	"github.com/rs/zerolog"
 )
 
+// LogProgress takes a total and return function such that when called with a 0-based index
+// it prints the progress from 0% to 100% to indicate the index from 0 to (total - 1) has been
+// processed.
+// useful to report the progress of processing the index from 0 to (total - 1)
 func LogProgress(msg string, total int, logger *zerolog.Logger) func(currentIndex int) {
-	logThreshold := float64(10)
+	logThreshold := float64(0)
 	return func(currentIndex int) {
 		percentage := float64(100)
 		if total > 0 {
@@ -14,7 +18,7 @@ func LogProgress(msg string, total int, logger *zerolog.Logger) func(currentInde
 
 		// report every 10 percent
 		if percentage >= logThreshold {
-			logger.Info().Msgf("%s completion percentage: %v percent", msg, int(percentage))
+			logger.Info().Msgf("%s progress: %v percent", msg, logThreshold)
 			logThreshold += 10
 		}
 	}

module/util/log_test.go

@@ -8,27 +8,52 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestLogProgress(t *testing.T) {
+func TestLogProgress40(t *testing.T) {
 	buf := bytes.NewBufferString("")
 	lg := zerolog.New(buf)
-	logger := LogProgress("test", 40, &lg)
-	for i := 0; i < 50; i++ {
+	total := 40
+	logger := LogProgress("test", total, &lg)
+	for i := 0; i < total; i++ {
 		logger(i)
 	}
 
 	expectedLogs :=
-		`{"level":"info","message":"test completion percentage: 10 percent"}
-{"level":"info","message":"test completion percentage: 20 percent"}
-{"level":"info","message":"test completion percentage: 30 percent"}
-{"level":"info","message":"test completion percentage: 40 percent"}
-{"level":"info","message":"test completion percentage: 50 percent"}
-{"level":"info","message":"test completion percentage: 60 percent"}
-{"level":"info","message":"test completion percentage: 70 percent"}
-{"level":"info","message":"test completion percentage: 80 percent"}
-{"level":"info","message":"test completion percentage: 90 percent"}
-{"level":"info","message":"test completion percentage: 100 percent"}
-{"level":"info","message":"test completion percentage: 110 percent"}
-{"level":"info","message":"test completion percentage: 120 percent"}
+		`{"level":"info","message":"test progress: 0 percent"}
+{"level":"info","message":"test progress: 10 percent"}
+{"level":"info","message":"test progress: 20 percent"}
+{"level":"info","message":"test progress: 30 percent"}
+{"level":"info","message":"test progress: 40 percent"}
+{"level":"info","message":"test progress: 50 percent"}
+{"level":"info","message":"test progress: 60 percent"}
+{"level":"info","message":"test progress: 70 percent"}
+{"level":"info","message":"test progress: 80 percent"}
+{"level":"info","message":"test progress: 90 percent"}
+{"level":"info","message":"test progress: 100 percent"}
 `
 	require.Equal(t, expectedLogs, buf.String())
 }
+
+func TestLogProgress1000(t *testing.T) {
+	for total := 11; total < 1000; total++ {
+		buf := bytes.NewBufferString("")
+		lg := zerolog.New(buf)
+		logger := LogProgress("test", total, &lg)
+		for i := 0; i < total; i++ {
+			logger(i)
+		}
+
+		expectedLogs := `{"level":"info","message":"test progress: 0 percent"}
+{"level":"info","message":"test progress: 10 percent"}
+{"level":"info","message":"test progress: 20 percent"}
+{"level":"info","message":"test progress: 30 percent"}
+{"level":"info","message":"test progress: 40 percent"}
+{"level":"info","message":"test progress: 50 percent"}
+{"level":"info","message":"test progress: 60 percent"}
+{"level":"info","message":"test progress: 70 percent"}
+{"level":"info","message":"test progress: 80 percent"}
+{"level":"info","message":"test progress: 90 percent"}
+{"level":"info","message":"test progress: 100 percent"}
+`
+		require.Equal(t, expectedLogs, buf.String(), total)
+	}
+}