Feature: filter rollup by category (#286)

celenium-io · Oct 13, 2024 · 5f557d8 · 5f557d8
1 parent b0023af
commit 5f557d8
Show file tree

Hide file tree

Showing 16 changed files with 243 additions and 94 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -22,3 +22,7 @@ linters:
     - prealloc
     - protogetter
     - makezero
+linters-settings:
+  gosec:
+    excludes:
+      - G115
diff --git a/cmd/api/docs/swagger.json b/cmd/api/docs/swagger.json
diff --git a/cmd/api/handler/constant_test.go b/cmd/api/handler/constant_test.go
@@ -63,4 +63,5 @@ func (s *ConstantTestSuite) TestEnums() {
 	s.Require().Len(enums.EventType, 59)
 	s.Require().Len(enums.MessageType, 74)
 	s.Require().Len(enums.Status, 2)
+	s.Require().Len(enums.Categories, 3)
 }
diff --git a/cmd/api/handler/requests.go b/cmd/api/handler/requests.go
@@ -139,44 +139,6 @@ func (p *namespaceList) SetDefault() {
 	}
 }
 
-type rollupList struct {
-	Limit  int    `query:"limit"   validate:"omitempty,min=1,max=100"`
-	Offset int    `query:"offset"  validate:"omitempty,min=0"`
-	Sort   string `query:"sort"    validate:"omitempty,oneof=asc desc"`
-	SortBy string `query:"sort_by" validate:"omitempty,oneof=time blobs_count size fee"`
-}
-
-func (p *rollupList) SetDefault() {
-	if p.Limit == 0 {
-		p.Limit = 10
-	}
-	if p.Sort == "" {
-		p.Sort = desc
-	}
-	if p.SortBy == "" {
-		p.SortBy = "size"
-	}
-}
-
-type rollupDayList struct {
-	Limit  int    `query:"limit"   validate:"omitempty,min=1,max=100"`
-	Offset int    `query:"offset"  validate:"omitempty,min=0"`
-	Sort   string `query:"sort"    validate:"omitempty,oneof=asc desc"`
-	SortBy string `query:"sort_by" validate:"omitempty,oneof=avg_size blobs_count total_size total_fee throughput namespace_count pfb_count mb_price"`
-}
-
-func (p *rollupDayList) SetDefault() {
-	if p.Limit == 0 {
-		p.Limit = 10
-	}
-	if p.Sort == "" {
-		p.Sort = desc
-	}
-	if p.SortBy == "" {
-		p.SortBy = "throughput"
-	}
-}
-
 type getById struct {
 	Id uint64 `param:"id" validate:"required,min=1"`
 }
diff --git a/cmd/api/handler/responses/constants.go b/cmd/api/handler/responses/constants.go
@@ -69,12 +69,14 @@ type Enums struct {
 	Status      []string `json:"status"`
 	MessageType []string `json:"message_type"`
 	EventType   []string `json:"event_type"`
+	Categories  []string `json:"categories"`
 }
 
 func NewEnums() Enums {
 	return Enums{
 		Status:      types.StatusNames(),
 		MessageType: types.MsgTypeNames(),
 		EventType:   types.EventTypeNames(),
+		Categories:  types.RollupCategoryNames(),
 	}
 }
diff --git a/cmd/api/handler/rollup.go b/cmd/api/handler/rollup.go
@@ -9,6 +9,7 @@ import (
 
 	"github.com/celenium-io/celestia-indexer/cmd/api/handler/responses"
 	"github.com/celenium-io/celestia-indexer/internal/storage"
+	"github.com/celenium-io/celestia-indexer/internal/storage/types"
 	testsuite "github.com/celenium-io/celestia-indexer/internal/test_suite"
 	"github.com/labstack/echo/v4"
 )
@@ -31,29 +32,61 @@ func NewRollupHandler(
 	}
 }
 
+type rollupList struct {
+	Limit    int         `query:"limit"    validate:"omitempty,min=1,max=100"`
+	Offset   int         `query:"offset"   validate:"omitempty,min=0"`
+	Sort     string      `query:"sort"     validate:"omitempty,oneof=asc desc"`
+	SortBy   string      `query:"sort_by"  validate:"omitempty,oneof=time blobs_count size fee"`
+	Category StringArray `query:"category" validate:"omitempty,dive,category"`
+}
+
+func (p *rollupList) SetDefault() {
+	if p.Limit == 0 {
+		p.Limit = 10
+	}
+	if p.Sort == "" {
+		p.Sort = desc
+	}
+	if p.SortBy == "" {
+		p.SortBy = "size"
+	}
+}
+
 // Leaderboard godoc
 //
-//	@Summary		List rollups info
-//	@Description	List rollups info
-//	@Tags			rollup
-//	@ID				list-rollup
-//	@Param			limit	query	integer	false	"Count of requested entities"	mininum(1)	maximum(100)
-//	@Param			offset	query	integer	false	"Offset"						mininum(1)
-//	@Param			sort	query	string	false	"Sort order. Default: desc"		Enums(asc, desc)
-//	@Param			sort_by	query	string	false	"Sort field. Default: size"		Enums(time, blobs_count, size, fee)
-//	@Produce		json
-//	@Success		200	{array}		responses.RollupWithStats
-//	@Failure		400	{object}	Error
-//	@Failure		500	{object}	Error
-//	@Router			/rollup [get]
+//		@Summary		List rollups info
+//		@Description	List rollups info
+//		@Tags			rollup
+//		@ID				list-rollup
+//		@Param			limit	 query	integer	false	"Count of requested entities"	mininum(1)	maximum(100)
+//		@Param			offset	 query	integer	false	"Offset"						mininum(1)
+//		@Param			sort	 query	string	false	"Sort order. Default: desc"		Enums(asc, desc)
+//		@Param			sort_by	 query	string	false	"Sort field. Default: size"		Enums(time, blobs_count, size, fee)
+//	    @Param          category query  string  false   "Comma-separated rollup category list"
+//		@Produce		json
+//		@Success		200	{array}		responses.RollupWithStats
+//		@Failure		400	{object}	Error
+//		@Failure		500	{object}	Error
+//		@Router			/rollup [get]
 func (handler RollupHandler) Leaderboard(c echo.Context) error {
 	req, err := bindAndValidate[rollupList](c)
 	if err != nil {
 		return badRequestError(c, err)
 	}
 	req.SetDefault()
 
-	rollups, err := handler.rollups.Leaderboard(c.Request().Context(), req.SortBy, pgSort(req.Sort), req.Limit, req.Offset)
+	categories := make([]types.RollupCategory, len(req.Category))
+	for i := range categories {
+		categories[i] = types.RollupCategory(req.Category[i])
+	}
+
+	rollups, err := handler.rollups.Leaderboard(c.Request().Context(), storage.LeaderboardFilters{
+		SortField: req.SortBy,
+		Sort:      pgSort(req.Sort),
+		Limit:     req.Limit,
+		Offset:    req.Offset,
+		Category:  categories,
+	})
 	if err != nil {
 		return handleError(c, err, handler.rollups)
 	}
@@ -64,6 +97,26 @@ func (handler RollupHandler) Leaderboard(c echo.Context) error {
 	return returnArray(c, response)
 }
 
+type rollupDayList struct {
+	Limit    int         `query:"limit"    validate:"omitempty,min=1,max=100"`
+	Offset   int         `query:"offset"   validate:"omitempty,min=0"`
+	Sort     string      `query:"sort"     validate:"omitempty,oneof=asc desc"`
+	SortBy   string      `query:"sort_by"  validate:"omitempty,oneof=avg_size blobs_count total_size total_fee throughput namespace_count pfb_count mb_price"`
+	Category StringArray `query:"category" validate:"omitempty,dive,category"`
+}
+
+func (p *rollupDayList) SetDefault() {
+	if p.Limit == 0 {
+		p.Limit = 10
+	}
+	if p.Sort == "" {
+		p.Sort = desc
+	}
+	if p.SortBy == "" {
+		p.SortBy = "throughput"
+	}
+}
+
 // LeaderboardDay godoc
 //
 //	@Summary		List rollups info with stats by previous 24 hours
@@ -74,6 +127,7 @@ func (handler RollupHandler) Leaderboard(c echo.Context) error {
 //	@Param			offset	query	integer	false	"Offset"						mininum(1)
 //	@Param			sort	query	string	false	"Sort order. Default: desc"		Enums(asc, desc)
 //	@Param			sort_by	query	string	false	"Sort field. Default: mb_price"	Enums(avg_size, blobs_count, total_size, total_fee, throughput, namespace_count, pfb_count, mb_price)
+//	@Param          category query  string  false   "Comma-separated rollup category list"
 //	@Produce		json
 //	@Success		200	{array}		responses.RollupWithDayStats
 //	@Failure		400	{object}	Error
@@ -86,7 +140,18 @@ func (handler RollupHandler) LeaderboardDay(c echo.Context) error {
 	}
 	req.SetDefault()
 
-	rollups, err := handler.rollups.LeaderboardDay(c.Request().Context(), req.SortBy, pgSort(req.Sort), req.Limit, req.Offset)
+	categories := make([]types.RollupCategory, len(req.Category))
+	for i := range categories {
+		categories[i] = types.RollupCategory(req.Category[i])
+	}
+
+	rollups, err := handler.rollups.LeaderboardDay(c.Request().Context(), storage.LeaderboardFilters{
+		SortField: req.SortBy,
+		Sort:      pgSort(req.Sort),
+		Limit:     req.Limit,
+		Offset:    req.Offset,
+		Category:  categories,
+	})
 	if err != nil {
 		return handleError(c, err, handler.rollups)
 	}

diff --git a/cmd/api/handler/rollup_test.go b/cmd/api/handler/rollup_test.go
@@ -15,6 +15,7 @@ import (
 	"github.com/celenium-io/celestia-indexer/cmd/api/handler/responses"
 	"github.com/celenium-io/celestia-indexer/internal/storage"
 	"github.com/celenium-io/celestia-indexer/internal/storage/mock"
+	"github.com/celenium-io/celestia-indexer/internal/storage/types"
 	sdk "github.com/dipdup-net/indexer-sdk/pkg/storage"
 	"github.com/labstack/echo/v4"
 	"github.com/stretchr/testify/suite"
@@ -31,6 +32,7 @@ var (
 		Twitter:     "https://x.com",
 		Logo:        "image.png",
 		Slug:        "test-rollup",
+		Category:    types.RollupCategoryNft,
 	}
 	testRollupWithStats = storage.RollupWithStats{
 		Rollup: testRollup,
@@ -87,14 +89,24 @@ func (s *RollupTestSuite) TestLeaderboard() {
 	} {
 		q := make(url.Values)
 		q.Add("sort_by", sort)
+		q.Add("category", "nft,gaming")
 
 		req := httptest.NewRequest(http.MethodGet, "/?"+q.Encode(), nil)
 		rec := httptest.NewRecorder()
 		c := s.echo.NewContext(req, rec)
 		c.SetPath("/rollup")
 
 		s.rollups.EXPECT().
-			Leaderboard(gomock.Any(), sort, sdk.SortOrderDesc, 10, 0).
+			Leaderboard(gomock.Any(), storage.LeaderboardFilters{
+				SortField: sort,
+				Sort:      sdk.SortOrderDesc,
+				Limit:     10,
+				Offset:    0,
+				Category: []types.RollupCategory{
+					types.RollupCategoryNft,
+					types.RollupCategoryGaming,
+				},
+			}).
 			Return([]storage.RollupWithStats{testRollupWithStats}, nil).
 			Times(1)
 
@@ -127,14 +139,24 @@ func (s *RollupTestSuite) TestLeaderboardDay() {
 	} {
 		q := make(url.Values)
 		q.Add("sort_by", sort)
+		q.Add("category", "nft,gaming")
 
 		req := httptest.NewRequest(http.MethodGet, "/?"+q.Encode(), nil)
 		rec := httptest.NewRecorder()
 		c := s.echo.NewContext(req, rec)
 		c.SetPath("/rollup/day")
 
 		s.rollups.EXPECT().
-			LeaderboardDay(gomock.Any(), sort, sdk.SortOrderDesc, 10, 0).
+			LeaderboardDay(gomock.Any(), storage.LeaderboardFilters{
+				SortField: sort,
+				Sort:      sdk.SortOrderDesc,
+				Limit:     10,
+				Offset:    0,
+				Category: []types.RollupCategory{
+					types.RollupCategoryNft,
+					types.RollupCategoryGaming,
+				},
+			}).
 			Return([]storage.RollupWithDayStats{
 				{
 					Rollup: testRollup,

diff --git a/cmd/api/handler/validators.go b/cmd/api/handler/validators.go
@@ -32,6 +32,9 @@ func NewCelestiaApiValidator() *CelestiaApiValidator {
 	if err := v.RegisterValidation("namespace", namespaceValidator()); err != nil {
 		panic(err)
 	}
+	if err := v.RegisterValidation("category", categoryValidator()); err != nil {
+		panic(err)
+	}
 	return &CelestiaApiValidator{validator: v}
 }
 
@@ -99,3 +102,10 @@ func namespaceValidator() validator.Func {
 		return isNamespace(fl.Field().String())
 	}
 }
+
+func categoryValidator() validator.Func {
+	return func(fl validator.FieldLevel) bool {
+		_, err := types.ParseRollupCategory(fl.Field().String())
+		return err == nil
+	}
+}
diff --git a/cmd/api/handler/ws_test.go b/cmd/api/handler/ws_test.go
@@ -52,13 +52,13 @@ func TestWebsocket(t *testing.T) {
 	dispatcher.Start(ctx)
 	observer := dispatcher.Observe(storage.ChannelHead, storage.ChannelBlock)
 
-	for i := 0; i < 10; i++ {
+	for i := uint64(0); i < 10; i++ {
 		hash := make([]byte, 32)
 		_, err := rand.Read(hash)
 		require.NoError(t, err)
 
-		blockMock.EXPECT().ByIdWithRelations(ctx, uint64(i)).Return(storage.Block{
-			Id:           uint64(i),
+		blockMock.EXPECT().ByIdWithRelations(ctx, i).Return(storage.Block{
+			Id:           i,
 			Height:       types.Level(i),
 			Time:         time.Now(),
 			Hash:         hash,