Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions bridge-history-api/cmd/api/app/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ func action(ctx *cli.Context) error {
api.InitController(db, redisClient)

router := gin.Default()
// Let *gin.Context carry request cancellation, so DB and Redis calls stop when the client goes away.
router.ContextWithFallback = true
registry := prometheus.DefaultRegisterer
route.Route(router, cfg, registry)

Expand Down
4 changes: 4 additions & 0 deletions bridge-history-api/internal/controller/api/controller.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package api

import (
"errors"
"sync"

"github.com/go-redis/redis/v8"
Expand All @@ -21,6 +22,9 @@ var (
L2WithdrawalsByAddressCtl *L2WithdrawalsByAddressController

initControllerOnce sync.Once

// errInternal hides internal error details from clients. The logic layer logs the full error.
errInternal = errors.New("internal error")
)

// InitController inits Controller with database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ func NewL2UnclaimedWithdrawalsByAddressController(db *gorm.DB, redisClient *redi
// GetL2UnclaimedWithdrawalsByAddress defines the http get method behavior
func (c *L2UnclaimedWithdrawalsByAddressController) GetL2UnclaimedWithdrawalsByAddress(ctx *gin.Context) {
var req types.QueryByAddressRequest
if err := ctx.ShouldBind(&req); err != nil {
if err := ctx.ShouldBindQuery(&req); err != nil {
types.RenderFailure(ctx, types.ErrParameterInvalidNo, err)
return
}

pagedTxs, total, err := c.historyLogic.GetL2UnclaimedWithdrawalsByAddress(ctx, req.Address, req.Page, req.PageSize)
if err != nil {
types.RenderFailure(ctx, types.ErrGetL2ClaimableWithdrawalsError, err)
types.RenderFailure(ctx, types.ErrGetL2ClaimableWithdrawalsError, errInternal)
return
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ func NewL2WithdrawalsByAddressController(db *gorm.DB, redisClient *redis.Client)
// GetL2WithdrawalsByAddress defines the http get method behavior
func (c *L2WithdrawalsByAddressController) GetL2WithdrawalsByAddress(ctx *gin.Context) {
var req types.QueryByAddressRequest
if err := ctx.ShouldBind(&req); err != nil {
if err := ctx.ShouldBindQuery(&req); err != nil {
types.RenderFailure(ctx, types.ErrParameterInvalidNo, err)
return
}

pagedTxs, total, err := c.historyLogic.GetL2WithdrawalsByAddress(ctx, req.Address, req.Page, req.PageSize)
if err != nil {
types.RenderFailure(ctx, types.ErrGetL2WithdrawalsError, err)
types.RenderFailure(ctx, types.ErrGetL2WithdrawalsError, errInternal)
return
}

Expand Down
4 changes: 2 additions & 2 deletions bridge-history-api/internal/controller/api/txs_by_address.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ func NewTxsByAddressController(db *gorm.DB, redisClient *redis.Client) *TxsByAdd
// GetTxsByAddress defines the http get method behavior
func (c *TxsByAddressController) GetTxsByAddress(ctx *gin.Context) {
var req types.QueryByAddressRequest
if err := ctx.ShouldBind(&req); err != nil {
if err := ctx.ShouldBindQuery(&req); err != nil {
types.RenderFailure(ctx, types.ErrParameterInvalidNo, err)
return
}

pagedTxs, total, err := c.historyLogic.GetTxsByAddress(ctx, req.Address, req.Page, req.PageSize)
if err != nil {
types.RenderFailure(ctx, types.ErrGetTxsError, err)
types.RenderFailure(ctx, types.ErrGetTxsError, errInternal)
return
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func (c *TxsByHashesController) PostQueryTxsByHashes(ctx *gin.Context) {

results, err := c.historyLogic.GetTxsByHashes(ctx, req.Txs)
if err != nil {
types.RenderFailure(ctx, types.ErrGetTxsByHashError, err)
types.RenderFailure(ctx, types.ErrGetTxsByHashError, errInternal)
return
}

Expand Down
14 changes: 12 additions & 2 deletions bridge-history-api/internal/logic/history_logic.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const (
cacheKeyPrefixTxsByAddr = cacheKeyPrefixBridgeHistory + "txsByAddr:"
cacheKeyPrefixQueryTxsByHashes = cacheKeyPrefixBridgeHistory + "queryTxsByHashes:"
cacheKeyExpiredTime = 1 * time.Minute
sharedQueryTimeout = 10 * time.Second
)

// HistoryLogic services.
Expand Down Expand Up @@ -76,6 +77,9 @@ func (h *HistoryLogic) GetL2UnclaimedWithdrawalsByAddress(ctx context.Context, a
log.Info("cache miss", "cache key", cacheKey)

result, err, _ := h.singleFlight.Do(cacheKey, func() (interface{}, error) {
// Callers share this query, so one disconnecting caller must not cancel it for the others.
ctx, cancel := context.WithTimeout(context.WithoutCancel(ctx), sharedQueryTimeout)
defer cancel()
var txHistoryInfos []*types.TxHistoryInfo
crossMessages, getErr := h.crossMessageOrm.GetL2UnclaimedWithdrawalsByAddress(ctx, address)
if getErr != nil {
Expand Down Expand Up @@ -119,6 +123,9 @@ func (h *HistoryLogic) GetL2WithdrawalsByAddress(ctx context.Context, address st
log.Info("cache miss", "cache key", cacheKey)

result, err, _ := h.singleFlight.Do(cacheKey, func() (interface{}, error) {
// Callers share this query, so one disconnecting caller must not cancel it for the others.
ctx, cancel := context.WithTimeout(context.WithoutCancel(ctx), sharedQueryTimeout)
defer cancel()
var txHistoryInfos []*types.TxHistoryInfo
crossMessages, getErr := h.crossMessageOrm.GetL2WithdrawalsByAddress(ctx, address)
if getErr != nil {
Expand Down Expand Up @@ -162,6 +169,9 @@ func (h *HistoryLogic) GetTxsByAddress(ctx context.Context, address string, page
log.Info("cache miss", "cache key", cacheKey)

result, err, _ := h.singleFlight.Do(cacheKey, func() (interface{}, error) {
// Callers share this query, so one disconnecting caller must not cancel it for the others.
ctx, cancel := context.WithTimeout(context.WithoutCancel(ctx), sharedQueryTimeout)
defer cancel()
var txHistoryInfos []*types.TxHistoryInfo
crossMessages, getErr := h.crossMessageOrm.GetTxsByAddress(ctx, address)
if getErr != nil {
Expand Down Expand Up @@ -262,7 +272,7 @@ func (h *HistoryLogic) GetTxsByHashes(ctx context.Context, txHashes []string) ([

crossMessages, err := h.crossMessageOrm.GetMessagesByTxHashes(ctx, txHashes)
if err != nil {
log.Error("failed to get cross messages by tx hashes", "hashes", txHashes)
log.Error("failed to get cross messages by tx hashes", "hashes", txHashes, "error", err)
return nil, err
}
for _, message := range crossMessages {
Expand All @@ -271,7 +281,7 @@ func (h *HistoryLogic) GetTxsByHashes(ctx context.Context, txHashes []string) ([

batchDepositMessages, err := h.bridgeBatchDepositOrm.GetMessagesByTxHashes(ctx, txHashes)
if err != nil {
log.Error("failed to get batch deposit messages by tx hashes", "hashes", txHashes)
log.Error("failed to get batch deposit messages by tx hashes", "hashes", txHashes, "error", err)
return nil, err
}
for _, message := range batchDepositMessages {
Expand Down
4 changes: 4 additions & 0 deletions bridge-history-api/internal/orm/bridge_batch_deposit.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,13 @@ func (c *BridgeBatchDepositEvent) GetMessagesByTxHashes(ctx context.Context, txH
db := c.db.WithContext(ctx)
db = db.Model(&BridgeBatchDepositEvent{})
db = db.Where("l1_tx_hash in (?) or l2_tx_hash in (?)", txHashes, txHashes)
db = db.Limit(maxMessagesByTxHashes + 1)
if err := db.Find(&messages).Error; err != nil {
return nil, fmt.Errorf("failed to GetMessagesByTxHashes by tx hashes, tx hashes: %v, error: %w", txHashes, err)
}
if len(messages) > maxMessagesByTxHashes {
return nil, fmt.Errorf("too many batch deposit messages for tx hashes, limit: %d", maxMessagesByTxHashes)
}
return messages, nil
}

Expand Down
8 changes: 8 additions & 0 deletions bridge-history-api/internal/orm/cross_message.go
Original file line number Diff line number Diff line change
Expand Up @@ -136,15 +136,23 @@ func (c *CrossMessage) GetL2WithdrawalsByBlockRange(ctx context.Context, startBl
return messages, nil
}

// maxMessagesByTxHashes bounds the rows one tx hashes query loads. Exceeding it is an error,
// so a truncated result is never returned or cached.
const maxMessagesByTxHashes = 500

// GetMessagesByTxHashes retrieves all cross messages from the database that match the provided transaction hashes.
func (c *CrossMessage) GetMessagesByTxHashes(ctx context.Context, txHashes []string) ([]*CrossMessage, error) {
var messages []*CrossMessage
db := c.db.WithContext(ctx)
db = db.Model(&CrossMessage{})
db = db.Where("l1_tx_hash in (?) or l2_tx_hash in (?)", txHashes, txHashes)
db = db.Limit(maxMessagesByTxHashes + 1)
if err := db.Find(&messages).Error; err != nil {
return nil, fmt.Errorf("failed to get L2 messages by tx hashes, tx hashes: %v, error: %w", txHashes, err)
}
if len(messages) > maxMessagesByTxHashes {
return nil, fmt.Errorf("too many messages for tx hashes, limit: %d", maxMessagesByTxHashes)
}
return messages, nil
}

Expand Down
2 changes: 1 addition & 1 deletion common/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"runtime/debug"
)

var tag = "v4.8.4"
var tag = "v4.8.5"

var commit = func() string {
if info, ok := debug.ReadBuildInfo(); ok {
Expand Down
Loading