Add logging to corruptabledb closure (#3938)

Signed-off-by: Joshua Kim <20001595+joshua-kim@users.noreply.github.com>

Author: joshua-kim

database/corruptabledb/db.go

@@ -8,7 +8,10 @@ import (
 	"fmt"
 	"sync"
 
+	"go.uber.org/zap"
+
 	"github.com/ava-labs/avalanchego/database"
+	"github.com/ava-labs/avalanchego/utils/logging"
 )
 
 var (
@@ -21,6 +24,7 @@ var (
 type Database struct {
 	database.Database
 
+	log logging.Logger
 	// initialError stores the error other than "not found" or "closed" while
 	// performing a db operation. If not nil, Has, Get, Put, Delete and batch
 	// writes will fail with initialError.
@@ -29,8 +33,11 @@ type Database struct {
 }
 
 // New returns a new prefixed database
-func New(db database.Database) *Database {
-	return &Database{Database: db}
+func New(db database.Database, log logging.Logger) *Database {
+	return &Database{
+		Database: db,
+		log:      log,
+	}
 }
 
 // Has returns if the key is set in the database
@@ -136,6 +143,11 @@ func (db *Database) handleError(err error) error {
 		// Set the initial error to the first unexpected error. Don't call
 		// corrupted() here since it would deadlock.
 		if db.initialError == nil {
+			db.log.Error(
+				"closing database to avoid possible corruption",
+				zap.Error(err),
+			)
+
 			db.initialError = fmt.Errorf("closed to avoid possible corruption, init error: %w", err)
 		}
 	}

database/corruptabledb/db_test.go

@@ -15,13 +15,14 @@ import (
 	"github.com/ava-labs/avalanchego/database/databasemock"
 	"github.com/ava-labs/avalanchego/database/dbtest"
 	"github.com/ava-labs/avalanchego/database/memdb"
+	"github.com/ava-labs/avalanchego/utils/logging"
 )
 
 var errTest = errors.New("non-nil error")
 
 func newDB() *Database {
 	baseDB := memdb.New()
-	return New(baseDB)
+	return New(baseDB, logging.NoLog{})
 }
 
 func TestInterface(t *testing.T) {

database/factory/factory.go

@@ -70,7 +70,7 @@ func New(
 	}
 
 	// Wrap with corruptable DB
-	db = corruptabledb.New(db)
+	db = corruptabledb.New(db, logger)
 
 	if readOnly && name != memdb.Name {
 		db = versiondb.New(db)

database/rpcdb/db_test.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ava-labs/avalanchego/database/corruptabledb"
 	"github.com/ava-labs/avalanchego/database/dbtest"
 	"github.com/ava-labs/avalanchego/database/memdb"
+	"github.com/ava-labs/avalanchego/utils/logging"
 	"github.com/ava-labs/avalanchego/vms/rpcchainvm/grpcutils"
 
 	rpcdbpb "github.com/ava-labs/avalanchego/proto/pb/rpcdb"
@@ -120,7 +121,7 @@ func TestHealthCheck(t *testing.T) {
 			require := require.New(t)
 
 			baseDB := setupDB(t)
-			db := corruptabledb.New(baseDB.server)
+			db := corruptabledb.New(baseDB.server, logging.NoLog{})
 			defer db.Close()
 			require.NoError(scenario.testFn(db))
 

vms/rpcchainvm/vm_server.go

@@ -181,9 +181,6 @@ func (vm *VMServer) Initialize(ctx context.Context, req *vmpb.InitializeRequest)
 		return nil, err
 	}
 	vm.connCloser.Add(dbClientConn)
-	vm.db = corruptabledb.New(
-		rpcdb.NewClient(rpcdbpb.NewDatabaseClient(dbClientConn)),
-	)
 
 	// TODO: Allow the logger to be configured by the client
 	vm.log = logging.NewLogger(
@@ -195,6 +192,11 @@ func (vm *VMServer) Initialize(ctx context.Context, req *vmpb.InitializeRequest)
 		),
 	)
 
+	vm.db = corruptabledb.New(
+		rpcdb.NewClient(rpcdbpb.NewDatabaseClient(dbClientConn)),
+		vm.log,
+	)
+
 	clientConn, err := grpcutils.Dial(
 		req.ServerAddr,
 		grpcutils.WithChainUnaryInterceptor(grpcClientMetrics.UnaryClientInterceptor()),