add pagination for project list api (#839)

* add pagination for project list api

* update default page size to 1000

* remove hardcoded pagination from service

* update ListOrganizations to accept page size and num from request

core/project/filter.go

@@ -1,10 +1,13 @@
 package project
 
+import "github.com/raystack/frontier/pkg/pagination"
+
 type Filter struct {
 	OrgID           string
 	WithMemberCount bool
 	ProjectIDs      []string
 	State           State
 	// NonInherited filters out projects that are inherited from access given through an organization
 	NonInherited bool
+	Pagination   *pagination.Pagination
 }

internal/api/v1beta1/org.go

@@ -47,7 +47,7 @@ type OrganizationService interface {
 
 func (h Handler) ListOrganizations(ctx context.Context, request *frontierv1beta1.ListOrganizationsRequest) (*frontierv1beta1.ListOrganizationsResponse, error) {
 	var orgs []*frontierv1beta1.Organization
-	paginate := pagination.NewPagination(1, 50)
+	paginate := pagination.NewPagination(request.GetPageNum(), request.GetPageSize())
 
 	orgList, err := h.orgService.List(ctx, organization.Filter{
 		State:      organization.State(request.GetState()),

internal/api/v1beta1/org_test.go

@@ -43,6 +43,8 @@ var (
 	}
 )
 
+const DefaultPageSize = 1000
+
 func TestHandler_ListOrganization(t *testing.T) {
 	table := []struct {
 		title string
@@ -54,7 +56,7 @@ func TestHandler_ListOrganization(t *testing.T) {
 			title: "should return internal error if org service return some error",
 			setup: func(os *mocks.OrganizationService) {
 				os.EXPECT().List(mock.AnythingOfType("context.backgroundCtx"), organization.Filter{
-					Pagination: pagination.NewPagination(1, 50)},
+					Pagination: pagination.NewPagination(1, DefaultPageSize)},
 				).Return([]organization.Organization{}, errors.New("test error"))
 			},
 			want: nil,
@@ -68,7 +70,7 @@ func TestHandler_ListOrganization(t *testing.T) {
 					testOrgList = append(testOrgList, o)
 				}
 				os.EXPECT().List(mock.AnythingOfType("context.backgroundCtx"), organization.Filter{
-					Pagination: pagination.NewPagination(1, 50),
+					Pagination: pagination.NewPagination(1, DefaultPageSize),
 				}).Return(testOrgList, nil)
 			},
 			want: &frontierv1beta1.ListOrganizationsResponse{Organizations: []*frontierv1beta1.Organization{
@@ -855,7 +857,7 @@ func TestHandler_ListAllOrganizations(t *testing.T) {
 			setup: func(os *mocks.OrganizationService) {
 				os.EXPECT().List(mock.AnythingOfType("context.backgroundCtx"),
 					organization.Filter{
-						Pagination: pagination.NewPagination(1, 50),
+						Pagination: pagination.NewPagination(1, DefaultPageSize),
 					}).Return([]organization.Organization{}, errors.New("test error"))
 			},
 			req:     &frontierv1beta1.ListAllOrganizationsRequest{},
@@ -866,7 +868,7 @@ func TestHandler_ListAllOrganizations(t *testing.T) {
 			name: "should return empty list of orgs if org service return nil error",
 			setup: func(os *mocks.OrganizationService) {
 				os.EXPECT().List(mock.AnythingOfType("context.backgroundCtx"), organization.Filter{
-					Pagination: pagination.NewPagination(1, 50),
+					Pagination: pagination.NewPagination(1, DefaultPageSize),
 				}).Return([]organization.Organization{}, nil)
 			},
 			req:     &frontierv1beta1.ListAllOrganizationsRequest{},
@@ -881,7 +883,7 @@ func TestHandler_ListAllOrganizations(t *testing.T) {
 					testOrgList = append(testOrgList, o)
 				}
 				os.EXPECT().List(mock.AnythingOfType("context.backgroundCtx"), organization.Filter{
-					Pagination: pagination.NewPagination(1, 50),
+					Pagination: pagination.NewPagination(1, DefaultPageSize),
 				}).Return(testOrgList, nil)
 			},
 			req: &frontierv1beta1.ListAllOrganizationsRequest{},

internal/api/v1beta1/user.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/raystack/frontier/core/organization"
+	"github.com/raystack/frontier/pkg/pagination"
 
 	"github.com/raystack/frontier/core/project"
 	"github.com/raystack/frontier/core/relation"
@@ -562,10 +563,12 @@ func (h Handler) ListProjectsByCurrentUser(ctx context.Context, request *frontie
 	if err != nil {
 		return nil, err
 	}
+	paginate := pagination.NewPagination(request.GetPageNum(), request.GetPageSize())
 	projList, err := h.projectService.ListByUser(ctx, principal.ID, principal.Type, project.Filter{
 		OrgID:           request.GetOrgId(),
 		NonInherited:    request.GetNonInherited(),
 		WithMemberCount: request.GetWithMemberCount(),
+		Pagination:      paginate,
 	})
 	if err != nil {
 		return nil, err
@@ -608,6 +611,7 @@ func (h Handler) ListProjectsByCurrentUser(ctx context.Context, request *frontie
 	return &frontierv1beta1.ListProjectsByCurrentUserResponse{
 		Projects:    projects,
 		AccessPairs: accessPairsPb,
+		Count:       paginate.Count,
 	}, nil
 }
 

internal/store/postgres/project_repository.go

@@ -172,6 +172,30 @@ func (r ProjectRepository) List(ctx context.Context, flt project.Filter) ([]proj
 			"state": flt.State.String(),
 		})
 	}
+
+	if flt.Pagination != nil {
+		offset := flt.Pagination.Offset()
+		limit := flt.Pagination.PageSize
+
+		// always make this call after all the filters have been applied
+		totalCountStmt := stmt.Select(goqu.COUNT("*"))
+		totalCountQuery, _, err := totalCountStmt.ToSQL()
+
+		if err != nil {
+			return []project.Project{}, fmt.Errorf("%w: %w", queryErr, err)
+		}
+
+		var totalCount int32
+		if err = r.dbc.WithTimeout(ctx, TABLE_PROJECTS, "Count", func(ctx context.Context) error {
+			return r.dbc.GetContext(ctx, &totalCount, totalCountQuery)
+		}); err != nil {
+			return nil, fmt.Errorf("%w: %w", dbErr, err)
+		}
+
+		flt.Pagination.SetCount(totalCount)
+		stmt = stmt.Limit(uint(limit)).Offset(uint(offset)).Order(goqu.C("created_at").Desc())
+	}
+
 	query, params, err := stmt.ToSQL()
 	if err != nil {
 		return []project.Project{}, fmt.Errorf("%w: %w", queryErr, err)

pkg/pagination/pagination.go

@@ -1,7 +1,7 @@
 package pagination
 
 const (
-	DefaultPageSize = 50
+	DefaultPageSize = 1000
 	DefaultPageNum  = 1
 )
 

proto/apidocs.swagger.yaml

@@ -2587,6 +2587,18 @@ paths:
           in: query
           required: false
           type: string
+        - name: page_size
+          description: The maximum number of users to return per page. The default is 50.
+          in: query
+          required: false
+          type: integer
+          format: int32
+        - name: page_num
+          description: The page number to return. The default is 1.
+          in: query
+          required: false
+          type: integer
+          format: int32
       tags:
         - Organization
     post:
@@ -9989,6 +10001,18 @@ paths:
           in: query
           required: false
           type: boolean
+        - name: page_size
+          description: The maximum number of users to return per page. The default is 50.
+          in: query
+          required: false
+          type: integer
+          format: int32
+        - name: page_num
+          description: The page number to return. The default is 1.
+          in: query
+          required: false
+          type: integer
+          format: int32
       tags:
         - User
 definitions:
@@ -11730,6 +11754,9 @@ definitions:
         items:
           type: object
           $ref: '#/definitions/v1beta1ListProjectsByCurrentUserResponseAccessPair'
+      count:
+        type: integer
+        format: int32
   v1beta1ListProjectsByCurrentUserResponseAccessPair:
     type: object
     properties: