Add logger support to RPC Chain VM server

Signed-off-by: Sam Batschelet <sam.batschelet@avalabs.org>

Author: hexfusion

snow/engine/snowman/block/batched_vm.go

@@ -11,7 +11,9 @@ import (
 	"github.com/ava-labs/avalanchego/database"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/consensus/snowman"
+	"github.com/ava-labs/avalanchego/utils/logging"
 	"github.com/ava-labs/avalanchego/utils/wrappers"
+	"go.uber.org/zap"
 )
 
 var ErrRemoteVMNotImplemented = errors.New("vm does not implement RemoteVM interface")
@@ -33,6 +35,7 @@ type BatchedChainVM interface {
 
 func GetAncestors(
 	ctx context.Context,
+	log logging.Logger,
 	vm Getter, // fetch blocks
 	blkID ids.ID, // first requested block
 	maxBlocksNum int, // max number of blocks to be retrieved
@@ -77,6 +80,10 @@ func GetAncestors(
 		blk, err = vm.GetBlock(ctx, blk.Parent())
 		if err != nil {
 			// After state sync we may not have the full chain
+			log.Debug("failed to get block during ancestorial lookup",
+				zap.String("parent id", blk.Parent().String()),
+				zap.Error(err),
+			)
 			break
 		}
 		blkBytes := blk.Bytes()
@@ -85,7 +92,7 @@ func GetAncestors(
 		// is repr. by an int.
 		newLen := ancestorsBytesLen + len(blkBytes) + wrappers.IntLen
 		if newLen > maxBlocksSize {
-			// reached maximum response size
+			// Reached maximum response size
 			break
 		}
 		ancestorsBytes = append(ancestorsBytes, blkBytes)

snow/engine/snowman/block/batched_vm_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/ava-labs/avalanchego/database"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/snow/consensus/snowman"
+	"github.com/ava-labs/avalanchego/utils/logging"
 )
 
 var errTest = errors.New("non-nil error")
@@ -25,7 +26,7 @@ func TestGetAncestorsDatabaseNotFound(t *testing.T) {
 		require.Equal(t, someID, id)
 		return nil, database.ErrNotFound
 	}
-	containers, err := GetAncestors(context.Background(), vm, someID, 10, 10, 1*time.Second)
+	containers, err := GetAncestors(context.Background(), logging.NewLogger("test"), vm, someID, 10, 10, 1*time.Second)
 	require.NoError(t, err)
 	require.Empty(t, containers)
 }
@@ -39,7 +40,7 @@ func TestGetAncestorsPropagatesErrors(t *testing.T) {
 		require.Equal(t, someID, id)
 		return nil, errTest
 	}
-	containers, err := GetAncestors(context.Background(), vm, someID, 10, 10, 1*time.Second)
+	containers, err := GetAncestors(context.Background(), logging.NewLogger("test"), vm, someID, 10, 10, 1*time.Second)
 	require.Nil(t, containers)
 	require.ErrorIs(t, err, errTest)
 }

vms/rpcchainvm/vm_server.go

@@ -75,6 +75,7 @@ type VMServer struct {
 
 	processMetrics prometheus.Gatherer
 	dbManager      manager.Manager
+	log            logging.Logger
 
 	serverCloser grpcutils.ServerCloser
 	connCloser   wrappers.Closer
@@ -184,6 +185,16 @@ func (vm *VMServer) Initialize(ctx context.Context, req *vmpb.InitializeRequest)
 	}
 	vm.dbManager = dbManager
 
+	// TODO: Allow the logger to be configured by the client
+	vm.log = logging.NewLogger(
+		fmt.Sprintf("<%s Chain>", chainID),
+		logging.NewWrappedCore(
+			logging.Info,
+			originalStderr,
+			logging.Colors.ConsoleEncoder(),
+		),
+	)
+
 	clientConn, err := grpcutils.Dial(
 		req.ServerAddr,
 		grpcutils.WithChainUnaryInterceptor(grpcClientMetrics.UnaryClientInterceptor()),
@@ -233,15 +244,7 @@ func (vm *VMServer) Initialize(ctx context.Context, req *vmpb.InitializeRequest)
 		CChainID:    cChainID,
 		AVAXAssetID: avaxAssetID,
 
-		// TODO: Allow the logger to be configured by the client
-		Log: logging.NewLogger(
-			fmt.Sprintf("<%s Chain>", chainID),
-			logging.NewWrappedCore(
-				logging.Info,
-				originalStderr,
-				logging.Colors.ConsoleEncoder(),
-			),
-		),
+		Log:          vm.log,
 		Keystore:     keystoreClient,
 		SharedMemory: sharedMemoryClient,
 		BCLookup:     bcLookupClient,
@@ -657,6 +660,7 @@ func (vm *VMServer) GetAncestors(ctx context.Context, req *vmpb.GetAncestorsRequ
 		maxBlksNum,
 		maxBlksSize,
 		maxBlocksRetrivalTime,
+		vm.log,
 	)
 	return &vmpb.GetAncestorsResponse{
 		BlksBytes: blocks,