Add flag for verbose validation error logging

Added flag --log-verbose-validation-error to enable logging of entire Cadence values on validation error during atree migration.
onflow · Jan 9, 2024 · 706b5a5 · 706b5a5
1 parent 074e115
commit 706b5a5
Show file tree

Hide file tree

Showing 6 changed files with 260 additions and 62 deletions.
diff --git a/cmd/util/cmd/execution-state-extract/cmd.go b/cmd/util/cmd/execution-state-extract/cmd.go
@@ -15,16 +15,17 @@ import (
 )
 
 var (
-	flagExecutionStateDir string
-	flagOutputDir         string
-	flagBlockHash         string
-	flagStateCommitment   string
-	flagDatadir           string
-	flagChain             string
-	flagNWorker           int
-	flagNoMigration       bool
-	flagNoReport          bool
-	flagValidateMigration bool
+	flagExecutionStateDir         string
+	flagOutputDir                 string
+	flagBlockHash                 string
+	flagStateCommitment           string
+	flagDatadir                   string
+	flagChain                     string
+	flagNWorker                   int
+	flagNoMigration               bool
+	flagNoReport                  bool
+	flagValidateMigration         bool
+	flagLogVerboseValidationError bool
 )
 
 var Cmd = &cobra.Command{
@@ -62,7 +63,10 @@ func init() {
 	Cmd.Flags().IntVar(&flagNWorker, "n-migrate-worker", 10, "number of workers to migrate payload concurrently")
 
 	Cmd.Flags().BoolVar(&flagValidateMigration, "validate", false,
-		"validate migrated Cadence values")
+		"validate migrated Cadence values (atree migration)")
+
+	Cmd.Flags().BoolVar(&flagLogVerboseValidationError, "log-verbose-validation-error", false,
+		"log entire Cadence values on validation error (atree migration)")
 
 }
 
@@ -141,7 +145,11 @@ func run(*cobra.Command, []string) {
 	}
 
 	if flagValidateMigration {
-		log.Warn().Msgf("validation flag is enabled and will increase duration of migration")
+		log.Warn().Msgf("atree migration validation flag is enabled and will increase duration of migration")
+	}
+
+	if flagLogVerboseValidationError {
+		log.Warn().Msgf("atree migration has verbose validation error logging enabled which may increase size of log")
 	}
 
 	err := extractExecutionState(

diff --git a/cmd/util/cmd/execution-state-extract/execution_state_extract.go b/cmd/util/cmd/execution-state-extract/execution_state_extract.go
@@ -93,6 +93,7 @@ func extractExecutionState(
 				migrators.NewAtreeRegisterMigrator(
 					rwf,
 					flagValidateMigration,
+					flagLogVerboseValidationError,
 				),
 
 				&migrators.DeduplicateContractNamesMigration{},

diff --git a/cmd/util/ledger/migrations/atree_register_migration.go b/cmd/util/ledger/migrations/atree_register_migration.go
@@ -36,7 +36,8 @@ type AtreeRegisterMigrator struct {
 
 	nWorkers int
 
-	validateMigratedValues bool
+	validateMigratedValues    bool
+	logVerboseValidationError bool
 }
 
 var _ AccountBasedMigration = (*AtreeRegisterMigrator)(nil)
@@ -45,15 +46,17 @@ var _ io.Closer = (*AtreeRegisterMigrator)(nil)
 func NewAtreeRegisterMigrator(
 	rwf reporters.ReportWriterFactory,
 	validateMigratedValues bool,
+	logVerboseValidationError bool,
 ) *AtreeRegisterMigrator {
 
 	sampler := util2.NewTimedSampler(30 * time.Second)
 
 	migrator := &AtreeRegisterMigrator{
-		sampler:                sampler,
-		rwf:                    rwf,
-		rw:                     rwf.ReportWriter("atree-register-migrator"),
-		validateMigratedValues: validateMigratedValues,
+		sampler:                   sampler,
+		rwf:                       rwf,
+		rw:                        rwf.ReportWriter("atree-register-migrator"),
+		validateMigratedValues:    validateMigratedValues,
+		logVerboseValidationError: logVerboseValidationError,
 	}
 
 	return migrator
@@ -112,7 +115,7 @@ func (m *AtreeRegisterMigrator) MigrateAccount(
 	}
 
 	if m.validateMigratedValues {
-		err = validateCadenceValues(address, oldPayloads, newPayloads)
+		err = validateCadenceValues(address, oldPayloads, newPayloads, m.log, m.logVerboseValidationError)
 		if err != nil {
 			return nil, err
 		}

diff --git a/cmd/util/ledger/migrations/atree_register_migration_test.go b/cmd/util/ledger/migrations/atree_register_migration_test.go
@@ -36,7 +36,7 @@ func TestAtreeRegisterMigration(t *testing.T) {
 			migrations.CreateAccountBasedMigration(log, 2,
 				[]migrations.AccountBasedMigration{
 					validation.PreMigration(),
-					migrations.NewAtreeRegisterMigrator(reporters.NewReportFileWriterFactory(dir, log), true),
+					migrations.NewAtreeRegisterMigrator(reporters.NewReportFileWriterFactory(dir, log), true, false),
 					validation.PostMigration(),
 				},
 			),