SQS-379 | unit tests for processOrderBookActiveOrders

domain/mocks/orderbook_grpc_client_mock.go

@@ -12,33 +12,33 @@ var _ orderbookgrpcclientdomain.OrderBookClient = (*OrderbookGRPCClientMock)(nil
 
 // OrderbookGRPCClientMock is a mock struct that implements orderbookplugindomain.OrderbookGRPCClient.
 type OrderbookGRPCClientMock struct {
-	MockGetOrdersByTickCb          func(ctx context.Context, contractAddress string, tick int64) ([]orderbookplugindomain.Order, error)
-	MockGetActiveOrdersCb          func(ctx context.Context, contractAddress string, ownerAddress string) (orderbookdomain.Orders, uint64, error)
-	MockGetTickUnrealizedCancelsCb func(ctx context.Context, contractAddress string, tickIDs []int64) ([]orderbookgrpcclientdomain.UnrealizedTickCancels, error)
-	FetchTickUnrealizedCancelsCb   func(ctx context.Context, chunkSize int, contractAddress string, tickIDs []int64) ([]orderbookgrpcclientdomain.UnrealizedTickCancels, error)
-	MockQueryTicksCb               func(ctx context.Context, contractAddress string, ticks []int64) ([]orderbookdomain.Tick, error)
-	FetchTicksCb                   func(ctx context.Context, chunkSize int, contractAddress string, tickIDs []int64) ([]orderbookdomain.Tick, error)
+	GetOrdersByTickCb            func(ctx context.Context, contractAddress string, tick int64) ([]orderbookplugindomain.Order, error)
+	GetActiveOrdersCb            func(ctx context.Context, contractAddress string, ownerAddress string) (orderbookdomain.Orders, uint64, error)
+	GetTickUnrealizedCancelsCb   func(ctx context.Context, contractAddress string, tickIDs []int64) ([]orderbookgrpcclientdomain.UnrealizedTickCancels, error)
+	FetchTickUnrealizedCancelsCb func(ctx context.Context, chunkSize int, contractAddress string, tickIDs []int64) ([]orderbookgrpcclientdomain.UnrealizedTickCancels, error)
+	MockQueryTicksCb             func(ctx context.Context, contractAddress string, ticks []int64) ([]orderbookdomain.Tick, error)
+	FetchTicksCb                 func(ctx context.Context, chunkSize int, contractAddress string, tickIDs []int64) ([]orderbookdomain.Tick, error)
 }
 
 func (o *OrderbookGRPCClientMock) GetOrdersByTick(ctx context.Context, contractAddress string, tick int64) ([]orderbookplugindomain.Order, error) {
-	if o.MockGetOrdersByTickCb != nil {
-		return o.MockGetOrdersByTickCb(ctx, contractAddress, tick)
+	if o.GetOrdersByTickCb != nil {
+		return o.GetOrdersByTickCb(ctx, contractAddress, tick)
 	}
 
 	return nil, nil
 }
 
 func (o *OrderbookGRPCClientMock) GetActiveOrders(ctx context.Context, contractAddress string, ownerAddress string) (orderbookdomain.Orders, uint64, error) {
-	if o.MockGetActiveOrdersCb != nil {
-		return o.MockGetActiveOrdersCb(ctx, contractAddress, ownerAddress)
+	if o.GetActiveOrdersCb != nil {
+		return o.GetActiveOrdersCb(ctx, contractAddress, ownerAddress)
 	}
 
 	return nil, 0, nil
 }
 
 func (o *OrderbookGRPCClientMock) GetTickUnrealizedCancels(ctx context.Context, contractAddress string, tickIDs []int64) ([]orderbookgrpcclientdomain.UnrealizedTickCancels, error) {
-	if o.MockGetTickUnrealizedCancelsCb != nil {
-		return o.MockGetTickUnrealizedCancelsCb(ctx, contractAddress, tickIDs)
+	if o.GetTickUnrealizedCancelsCb != nil {
+		return o.GetTickUnrealizedCancelsCb(ctx, contractAddress, tickIDs)
 	}
 
 	return nil, nil

orderbook/types/errors.go

@@ -195,3 +195,26 @@ type FailedGetAllCanonicalOrderbookPoolIDsError struct {
 func (e FailedGetAllCanonicalOrderbookPoolIDsError) Error() string {
 	return fmt.Sprintf("failed to get all canonical orderbook pool IDs: %v", e.Err)
 }
+
+// FailedToGetActiveOrdersError is returned when the retrieval of active orders fails.
+type FailedToGetActiveOrdersError struct {
+	ContractAddress string
+	OwnerAddress    string
+	Err             error
+}
+
+// Error implements the error interface.
+func (e FailedToGetActiveOrdersError) Error() string {
+	return fmt.Sprintf("failed to get active orders for contract: %s and owner: %s: %v", e.ContractAddress, e.OwnerAddress, e.Err)
+}
+
+// FailedToGetMetadataError is returned when getting token metadata fails.
+type FailedToGetMetadataError struct {
+	TokenDenom string
+	Err        error
+}
+
+// Error implements the error interface.
+func (e FailedToGetMetadataError) Error() string {
+	return fmt.Sprintf("failed to get metadata for token denom: %s: %v", e.TokenDenom, e.Err)
+}

orderbook/usecase/export_test.go

@@ -1,10 +1,12 @@
 package orderbookusecase
 
 import (
+	"context"
+	"github.com/osmosis-labs/sqs/domain"
 	orderbookdomain "github.com/osmosis-labs/sqs/domain/orderbook"
 )
 
-// OrderBookEntry is an alias of orderBookEntry for testing purposes
+// CreateFormattedLimitOrder is an alias of createFormattedLimitOrder for testing purposes
 func (o *OrderbookUseCaseImpl) CreateFormattedLimitOrder(
 	poolID uint64,
 	order orderbookdomain.Order,
@@ -14,3 +16,8 @@ func (o *OrderbookUseCaseImpl) CreateFormattedLimitOrder(
 ) (orderbookdomain.LimitOrder, error) {
 	return o.createFormattedLimitOrder(poolID, order, quoteAsset, baseAsset, orderbookAddress)
 }
+
+// ProcessOrderBookActiveOrders is an alias of processOrderBookActiveOrders for testing purposes
+func (o *OrderbookUseCaseImpl) ProcessOrderBookActiveOrders(ctx context.Context, orderBook domain.CanonicalOrderBooksResult, ownerAddress string) ([]orderbookdomain.LimitOrder, bool, error) {
+	return o.processOrderBookActiveOrders(ctx, orderBook, ownerAddress)
+}

orderbook/usecase/orderbook_usecase.go

@@ -202,7 +202,11 @@ func (o *OrderbookUseCaseImpl) processOrderBookActiveOrders(ctx context.Context,
 
 	orders, count, err := o.orderBookClient.GetActiveOrders(ctx, orderBook.ContractAddress, ownerAddress)
 	if err != nil {
-		return nil, false, err
+		return nil, false, types.FailedToGetActiveOrdersError{
+			ContractAddress: orderBook.ContractAddress,
+			OwnerAddress:    ownerAddress,
+			Err:             err,
+		}
 	}
 
 	// There are orders to process for given orderbook
@@ -212,12 +216,18 @@ func (o *OrderbookUseCaseImpl) processOrderBookActiveOrders(ctx context.Context,
 
 	quoteToken, err := o.tokensUsecease.GetMetadataByChainDenom(orderBook.Quote)
 	if err != nil {
-		return nil, false, err
+		return nil, false, types.FailedToGetMetadataError{
+			TokenDenom: orderBook.Quote,
+			Err:        err,
+		}
 	}
 
 	baseToken, err := o.tokensUsecease.GetMetadataByChainDenom(orderBook.Base)
 	if err != nil {
-		return nil, false, err
+		return nil, false, types.FailedToGetMetadataError{
+			TokenDenom: orderBook.Base,
+			Err:        err,
+		}
 	}
 
 	// Create a slice to store the results