as: Add default pagination limit

TheThingsNetwork · Dec 3, 2024 · dec23f1 · dec23f1
1 parent eda0a45
commit dec23f1
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/pkg/applicationserver/applicationserver.go b/pkg/applicationserver/applicationserver.go
@@ -47,6 +47,7 @@ import (
 	"go.thethings.network/lorawan-stack/v3/pkg/messageprocessors/cayennelpp"
 	"go.thethings.network/lorawan-stack/v3/pkg/messageprocessors/devicerepository"
 	"go.thethings.network/lorawan-stack/v3/pkg/messageprocessors/javascript"
+	"go.thethings.network/lorawan-stack/v3/pkg/redis"
 	"go.thethings.network/lorawan-stack/v3/pkg/rpcmiddleware/hooks"
 	"go.thethings.network/lorawan-stack/v3/pkg/rpcmiddleware/rpclog"
 	"go.thethings.network/lorawan-stack/v3/pkg/rpcmiddleware/rpctracer"
@@ -155,6 +156,10 @@ func New(c *component.Component, conf *Config) (as *ApplicationServer, err error
 		return nil, err
 	}
 
+	redis.SetPaginationDefaults(redis.PaginationDefaults{
+		DefaultLimit: conf.Pagination.DefaultLimit,
+	})
+
 	as = &ApplicationServer{
 		Component:        c,
 		ctx:              ctx,

diff --git a/pkg/applicationserver/config.go b/pkg/applicationserver/config.go
@@ -105,6 +105,11 @@ type DownlinksConfig struct {
 	ConfirmationConfig ConfirmationConfig `name:"confirmation" description:"Configuration for confirmed downlink"`
 }
 
+// PaginationConfig represents the configuration for pagination.
+type PaginationConfig struct {
+	DefaultLimit int64 `name:"default-limit" description:"Default limit for pagination"`
+}
+
 // Config represents the ApplicationServer configuration.
 type Config struct {
 	LinkMode                 string                         `name:"link-mode" description:"Deprecated - mode to link applications to their Network Server (all, explicit)"`
@@ -123,6 +128,7 @@ type Config struct {
 	DeviceKEKLabel           string                         `name:"device-kek-label" description:"Label of KEK used to encrypt device keys at rest"`
 	DeviceLastSeen           LastSeenConfig                 `name:"device-last-seen" description:"End Device last seen batch update configuration"`
 	Downlinks                DownlinksConfig                `name:"downlinks" description:"Downlink configuration"`
+	Pagination               PaginationConfig               `name:"pagination" description:"Pagination configuration"`
 }
 
 func (c Config) toProto() *ttnpb.AsConfiguration {

diff --git a/pkg/redis/pagination.go b/pkg/redis/pagination.go
@@ -18,6 +18,16 @@ import (
 	"context"
 )
 
+// PaginationDefaults sets default values for paginations options within the Redis store.
+type PaginationDefaults struct {
+	DefaultLimit int64
+}
+
+var paginationDefaults = PaginationDefaults{}
+
+// SetPaginationDefaults should only be called at the initialization of the server.
+func SetPaginationDefaults(d PaginationDefaults) { paginationDefaults = d }
+
 type paginationOptionsKeyType struct{}
 
 var paginationOptionsKey paginationOptionsKeyType
@@ -33,6 +43,9 @@ func NewContextWithPagination(ctx context.Context, limit, page int64, total *int
 	if page == 0 {
 		page = 1
 	}
+	if limit == 0 {
+		limit = paginationDefaults.DefaultLimit
+	}
 	return context.WithValue(ctx, paginationOptionsKey, paginationOptions{
 		limit:  limit,
 		offset: (page - 1) * limit,

diff --git a/pkg/redis/pagination_test.go b/pkg/redis/pagination_test.go
@@ -84,4 +84,16 @@ func TestPagination(t *testing.T) {
 		redis.SetPaginationTotal(ctx, total)
 		a.So(totalCount, should.Equal, total)
 	})
+
+	t.Run("SetPaginationDefaults", func(t *testing.T) {
+		t.Parallel()
+		redis.SetPaginationDefaults(redis.PaginationDefaults{DefaultLimit: 20})
+
+		ctx := test.Context()
+		ctx = redis.NewContextWithPagination(ctx, 0, 0, nil)
+
+		limit, _ := redis.PaginationLimitAndOffsetFromContext(ctx)
+
+		a.So(limit, should.Equal, uint64(20))
+	})
 }