Merge pull request #5204 from onflow/fxamacker/atree-migration-cadenc…

…e-value-validation

Replace hash-based validation of migrated Cadence values to use `Equal()`

cmd/util/cmd/execution-state-extract/cmd.go

@@ -15,15 +15,17 @@ import (
 )
 
 var (
-	flagExecutionStateDir string
-	flagOutputDir         string
-	flagBlockHash         string
-	flagStateCommitment   string
-	flagDatadir           string
-	flagChain             string
-	flagNoMigration       bool
-	flagNoReport          bool
-	flagNWorker           int
+	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{
@@ -59,6 +61,13 @@ func init() {
 		"don't report the state")
 
 	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 (atree migration)")
+
+	Cmd.Flags().BoolVar(&flagLogVerboseValidationError, "log-verbose-validation-error", false,
+		"log entire Cadence values on validation error (atree migration)")
+
 }
 
 func run(*cobra.Command, []string) {
@@ -135,6 +144,14 @@ func run(*cobra.Command, []string) {
 		log.Warn().Msgf("--no-migration flag is deprecated")
 	}
 
+	if flagValidateMigration {
+		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(
 		flagExecutionStateDir,
 		stateCommitment,

cmd/util/cmd/execution-state-extract/execution_state_extract.go

@@ -85,19 +85,18 @@ func extractExecutionState(
 
 	rwf := reporters.NewReportFileWriterFactory(dir, log)
 
-	cadenceDataValidation := migrators.NewCadenceDataValidationMigrations(rwf, nWorker)
-
 	var migrations = []ledger.Migration{
 		migrators.CreateAccountBasedMigration(
 			log,
 			nWorker,
 			[]migrators.AccountBasedMigration{
-				cadenceDataValidation.PreMigration(),
 				migrators.NewAtreeRegisterMigrator(
 					rwf,
+					flagValidateMigration,
+					flagLogVerboseValidationError,
 				),
+
 				&migrators.DeduplicateContractNamesMigration{},
-				cadenceDataValidation.PostMigration(),
 
 				// This will fix storage used discrepancies caused by the
 				// DeduplicateContractNamesMigration.

cmd/util/ledger/migrations/atree_register_migration.go

@@ -35,22 +35,28 @@ type AtreeRegisterMigrator struct {
 	rwf     reporters.ReportWriterFactory
 
 	nWorkers int
+
+	validateMigratedValues    bool
+	logVerboseValidationError bool
 }
 
 var _ AccountBasedMigration = (*AtreeRegisterMigrator)(nil)
 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"),
+		sampler:                   sampler,
+		rwf:                       rwf,
+		rw:                        rwf.ReportWriter("atree-register-migrator"),
+		validateMigratedValues:    validateMigratedValues,
+		logVerboseValidationError: logVerboseValidationError,
 	}
 
 	return migrator
@@ -108,6 +114,13 @@ func (m *AtreeRegisterMigrator) MigrateAccount(
 		return nil, err
 	}
 
+	if m.validateMigratedValues {
+		err = validateCadenceValues(address, oldPayloads, newPayloads, m.log, m.logVerboseValidationError)
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	newLen := len(newPayloads)
 
 	if newLen > originalLen {

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)),
+					migrations.NewAtreeRegisterMigrator(reporters.NewReportFileWriterFactory(dir, log), true, false),
 					validation.PostMigration(),
 				},
 			),