chore(pagination): Move cursor based pagination to pkg (#1614)

Signed-off-by: Javier Rodriguez <[email protected]>

Author: javirln

app/controlplane/internal/service/service.go

@@ -142,7 +142,8 @@ func handleUseCaseErr(err error, l *log.Helper) error {
 	switch {
 	case errors.Is(err, context.Canceled):
 		return errors.ClientClosed("client closed", err.Error())
-	case biz.IsErrValidation(err) || biz.IsErrInvalidUUID(err) || biz.IsErrInvalidTimeWindow(err) || pagination.IsOffsetPaginationError(err):
+	case biz.IsErrValidation(err) || biz.IsErrInvalidUUID(err) || biz.IsErrInvalidTimeWindow(err) ||
+		pagination.IsOffsetPaginationError(err) || pagination.IsCursorPaginationError(err):
 		return errors.BadRequest("invalid", err.Error())
 	case biz.IsNotFound(err):
 		return errors.NotFound("not found", err.Error())

app/controlplane/internal/service/workflowrun.go

@@ -21,8 +21,8 @@ import (
 
 	pb "github.com/chainloop-dev/chainloop/app/controlplane/api/controlplane/v1"
 	craftingpb "github.com/chainloop-dev/chainloop/app/controlplane/api/workflowcontract/v1"
-	"github.com/chainloop-dev/chainloop/app/controlplane/internal/pagination"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
+	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/pagination"
 	"github.com/chainloop-dev/chainloop/pkg/credentials"
 	errors "github.com/go-kratos/kratos/v2/errors"
 	"github.com/google/uuid"

app/controlplane/pkg/biz/mocks/WorkflowRunRepo.go

@@ -22,7 +22,7 @@ import (
 	"io"
 	"time"
 
-	"github.com/chainloop-dev/chainloop/app/controlplane/internal/pagination"
+	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/pagination"
 	"github.com/chainloop-dev/chainloop/pkg/attestation"
 	"github.com/chainloop-dev/chainloop/pkg/attestation/renderer/chainloop"
 	"github.com/secure-systems-lab/go-securesystemslib/dsse"

app/controlplane/pkg/biz/workflowrun.go

@@ -22,9 +22,9 @@ import (
 	"testing"
 
 	schemav1 "github.com/chainloop-dev/chainloop/app/controlplane/api/workflowcontract/v1"
-	"github.com/chainloop-dev/chainloop/app/controlplane/internal/pagination"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz/testhelpers"
+	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/pagination"
 	"github.com/chainloop-dev/chainloop/pkg/credentials"
 	creds "github.com/chainloop-dev/chainloop/pkg/credentials/mocks"
 	"github.com/google/uuid"

app/controlplane/pkg/biz/workflowrun_integration_test.go

@@ -21,13 +21,13 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/chainloop-dev/chainloop/app/controlplane/internal/pagination"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/biz"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data/ent"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data/ent/organization"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data/ent/projectversion"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data/ent/workflow"
 	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/data/ent/workflowrun"
+	"github.com/chainloop-dev/chainloop/app/controlplane/pkg/pagination"
 	"github.com/go-kratos/kratos/v2/log"
 	"github.com/google/uuid"
 	"github.com/secure-systems-lab/go-securesystemslib/dsse"

app/controlplane/pkg/data/workflowrun.go

@@ -25,28 +25,51 @@ import (
 	"github.com/google/uuid"
 )
 
+// DefaultCursorLimit is the default number of items per page for cursor-based pagination
+const DefaultCursorLimit = 10
+
+// Cursor is a struct that holds the timestamp and identifier of a record
+type Cursor struct {
+	Timestamp *time.Time
+	ID        *uuid.UUID
+}
+
+// CursorOptions is a struct that holds the cursor and limit for pagination
 type CursorOptions struct {
 	Cursor *Cursor
 	Limit  int
 }
 
-type Cursor struct {
-	Timestamp *time.Time
-	ID        *uuid.UUID
+// CursorPaginationError is the error type for cursor-based pagination
+type CursorPaginationError struct {
+	err error
+}
+
+// NewCursorPaginationError creates a new CursorPaginationError with the provided error
+func NewCursorPaginationError(err error) CursorPaginationError {
+	return CursorPaginationError{err}
 }
 
-const defaultLimit = 10
+// Error returns the error message
+func (e CursorPaginationError) Error() string {
+	return e.err.Error()
+}
+
+// IsCursorPaginationError checks if the error is an CursorPaginationError
+func IsCursorPaginationError(err error) bool {
+	return errors.As(err, &CursorPaginationError{})
+}
 
 func NewCursor(c string, l int) (*CursorOptions, error) {
 	var cursor *Cursor
-	var limit = defaultLimit
+	var limit = DefaultCursorLimit
 
 	if c != "" {
-		time, uuid, err := decodeCursor(c)
+		timestamp, id, err := decodeCursor(c)
 		if err != nil {
-			return nil, fmt.Errorf("decoding cursor: %w", err)
+			return nil, NewCursorPaginationError(fmt.Errorf("decoding cursor: %w", err))
 		}
-		cursor = &Cursor{Timestamp: time, ID: uuid}
+		cursor = &Cursor{Timestamp: timestamp, ID: id}
 	}
 
 	if l > 0 {
@@ -59,6 +82,7 @@ func NewCursor(c string, l int) (*CursorOptions, error) {
 	}, nil
 }
 
+// decodeCursor decodes a base64 encoded cursor into a timestamp and identifier
 func decodeCursor(encodedCursor string) (*time.Time, *uuid.UUID, error) {
 	byt, err := base64.StdEncoding.DecodeString(encodedCursor)
 	if err != nil {
@@ -76,12 +100,12 @@ func decodeCursor(encodedCursor string) (*time.Time, *uuid.UUID, error) {
 	}
 
 	rawID := arrStr[1]
-	uuid, err := uuid.Parse(rawID)
+	id, err := uuid.Parse(rawID)
 	if err != nil {
 		return nil, nil, err
 	}
 
-	return &timestamp, &uuid, nil
+	return &timestamp, &id, nil
 }
 
 // EncodeCursor generates a base64 encoded representation of a timestamp + identifier