feat: add pagination for users & verification_requests

Author: lakhansamani

server/constants/pagination.go

@@ -0,0 +1,4 @@
+package constants
+
+// DefaultLimit is the default limit for pagination
+var DefaultLimit = 10

server/db/models/verification_requests.go

@@ -1,5 +1,7 @@
 package models
 
+import "github.com/authorizerdev/authorizer/server/graph/model"
+
 // VerificationRequest model for db
 type VerificationRequest struct {
 	Key        string `json:"_key,omitempty" bson:"_key"` // for arangodb
@@ -11,3 +13,15 @@ type VerificationRequest struct {
 	UpdatedAt  int64  `gorm:"autoUpdateTime" json:"updated_at" bson:"updated_at"`
 	Email      string `gorm:"uniqueIndex:idx_email_identifier" json:"email" bson:"email"`
 }
+
+func (v *VerificationRequest) AsAPIVerificationRequest() *model.VerificationRequest {
+	return &model.VerificationRequest{
+		ID:         v.ID,
+		Token:      &v.Token,
+		Identifier: &v.Identifier,
+		Expires:    &v.ExpiresAt,
+		CreatedAt:  &v.CreatedAt,
+		UpdatedAt:  &v.UpdatedAt,
+		Email:      &v.Email,
+	}
+}

server/db/providers/arangodb/user.go

@@ -1,6 +1,7 @@
 package arangodb
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"strings"
@@ -11,6 +12,7 @@ import (
 	"github.com/authorizerdev/authorizer/server/constants"
 	"github.com/authorizerdev/authorizer/server/db/models"
 	"github.com/authorizerdev/authorizer/server/envstore"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 )
 
@@ -66,32 +68,40 @@ func (p *provider) DeleteUser(user models.User) error {
 }
 
 // ListUsers to get list of users from database
-func (p *provider) ListUsers() ([]models.User, error) {
-	var users []models.User
-	query := fmt.Sprintf("FOR d in %s RETURN d", models.Collections.User)
+func (p *provider) ListUsers(pagination model.Pagination) (*model.Users, error) {
+	var users []*model.User
+	ctx := driver.WithQueryFullCount(context.Background())
 
-	cursor, err := p.db.Query(nil, query, nil)
+	query := fmt.Sprintf("FOR d in %s SORT d.created_at DESC LIMIT %d, %d RETURN d", models.Collections.User, pagination.Offset, pagination.Limit)
+
+	cursor, err := p.db.Query(ctx, query, nil)
 	if err != nil {
-		return users, err
+		return nil, err
 	}
 	defer cursor.Close()
 
+	paginationClone := pagination
+	paginationClone.Total = cursor.Statistics().FullCount()
+
 	for {
 		var user models.User
 		meta, err := cursor.ReadDocument(nil, &user)
 
-		if driver.IsNoMoreDocuments(err) {
+		if arangoDriver.IsNoMoreDocuments(err) {
 			break
 		} else if err != nil {
-			return users, err
+			return nil, err
 		}
 
 		if meta.Key != "" {
-			users = append(users, user)
+			users = append(users, user.AsAPIUser())
 		}
 	}
 
-	return users, nil
+	return &model.Users{
+		Pagination: &paginationClone,
+		Users:      users,
+	}, nil
 }
 
 // GetUserByEmail to get user information from database using email address

server/db/providers/arangodb/verification_requests.go

@@ -1,12 +1,14 @@
 package arangodb
 
 import (
+	"context"
 	"fmt"
 	"log"
 	"time"
 
 	"github.com/arangodb/go-driver"
 	"github.com/authorizerdev/authorizer/server/db/models"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 )
 
@@ -93,34 +95,40 @@ func (p *provider) GetVerificationRequestByEmail(email string, identifier string
 }
 
 // ListVerificationRequests to get list of verification requests from database
-func (p *provider) ListVerificationRequests() ([]models.VerificationRequest, error) {
-	var verificationRequests []models.VerificationRequest
+func (p *provider) ListVerificationRequests(pagination model.Pagination) (*model.VerificationRequests, error) {
+	var verificationRequests []*model.VerificationRequest
+	ctx := driver.WithQueryFullCount(context.Background())
+	query := fmt.Sprintf("FOR d in %s SORT d.created_at DESC LIMIT %d, %d RETURN d", models.Collections.VerificationRequest, pagination.Offset, pagination.Limit)
 
-	query := fmt.Sprintf("FOR d in %s RETURN d", models.Collections.VerificationRequest)
-
-	cursor, err := p.db.Query(nil, query, nil)
+	cursor, err := p.db.Query(ctx, query, nil)
 	if err != nil {
-		return verificationRequests, err
+		return nil, err
 	}
 	defer cursor.Close()
 
+	paginationClone := pagination
+	paginationClone.Total = cursor.Statistics().FullCount()
+
 	for {
 		var verificationRequest models.VerificationRequest
 		meta, err := cursor.ReadDocument(nil, &verificationRequest)
 
 		if driver.IsNoMoreDocuments(err) {
 			break
 		} else if err != nil {
-			return verificationRequests, err
+			return nil, err
 		}
 
 		if meta.Key != "" {
-			verificationRequests = append(verificationRequests, verificationRequest)
+			verificationRequests = append(verificationRequests, verificationRequest.AsAPIVerificationRequest())
 		}
 
 	}
 
-	return verificationRequests, nil
+	return &model.VerificationRequests{
+		VerificationRequests: verificationRequests,
+		Pagination:           &paginationClone,
+	}, nil
 }
 
 // DeleteVerificationRequest to delete verification request from database

server/db/providers/mongodb/user.go

@@ -8,6 +8,7 @@ import (
 	"github.com/authorizerdev/authorizer/server/constants"
 	"github.com/authorizerdev/authorizer/server/db/models"
 	"github.com/authorizerdev/authorizer/server/envstore"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/mongo/options"
@@ -60,26 +61,45 @@ func (p *provider) DeleteUser(user models.User) error {
 }
 
 // ListUsers to get list of users from database
-func (p *provider) ListUsers() ([]models.User, error) {
-	var users []models.User
+func (p *provider) ListUsers(pagination model.Pagination) (*model.Users, error) {
+	var users []*model.User
+	opts := options.Find()
+	opts.SetLimit(pagination.Limit)
+	opts.SetSkip(pagination.Offset)
+	opts.SetSort(bson.M{"created_at": -1})
+
+	paginationClone := pagination
+	// TODO add pagination total
+
 	userCollection := p.db.Collection(models.Collections.User, options.Collection())
-	cursor, err := userCollection.Find(nil, bson.M{}, options.Find())
+	count, err := userCollection.CountDocuments(nil, bson.M{}, options.Count())
+	if err != nil {
+		log.Println("error getting total users:", err)
+		return nil, err
+	}
+
+	paginationClone.Total = count
+
+	cursor, err := userCollection.Find(nil, bson.M{}, opts)
 	if err != nil {
 		log.Println("error getting users:", err)
-		return users, err
+		return nil, err
 	}
 	defer cursor.Close(nil)
 
 	for cursor.Next(nil) {
 		var user models.User
 		err := cursor.Decode(&user)
 		if err != nil {
-			return users, err
+			return nil, err
 		}
-		users = append(users, user)
+		users = append(users, user.AsAPIUser())
 	}
 
-	return users, nil
+	return &model.Users{
+		Pagination: &paginationClone,
+		Users:      users,
+	}, nil
 }
 
 // GetUserByEmail to get user information from database using email address

server/db/providers/mongodb/verification_requests.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	"github.com/authorizerdev/authorizer/server/db/models"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/mongo/options"
@@ -56,26 +57,40 @@ func (p *provider) GetVerificationRequestByEmail(email string, identifier string
 }
 
 // ListVerificationRequests to get list of verification requests from database
-func (p *provider) ListVerificationRequests() ([]models.VerificationRequest, error) {
-	var verificationRequests []models.VerificationRequest
+func (p *provider) ListVerificationRequests(pagination model.Pagination) (*model.VerificationRequests, error) {
+	var verificationRequests []*model.VerificationRequest
+
+	opts := options.Find()
+	opts.SetLimit(pagination.Limit)
+	opts.SetSkip(pagination.Offset)
+	opts.SetSort(bson.M{"created_at": -1})
+
 	verificationRequestCollection := p.db.Collection(models.Collections.VerificationRequest, options.Collection())
-	cursor, err := verificationRequestCollection.Find(nil, bson.M{}, options.Find())
+
+	verificationRequestCollectionCount, err := verificationRequestCollection.CountDocuments(nil, bson.M{})
+	paginationClone := pagination
+	paginationClone.Total = verificationRequestCollectionCount
+
+	cursor, err := verificationRequestCollection.Find(nil, bson.M{}, opts)
 	if err != nil {
 		log.Println("error getting verification requests:", err)
-		return verificationRequests, err
+		return nil, err
 	}
 	defer cursor.Close(nil)
 
 	for cursor.Next(nil) {
 		var verificationRequest models.VerificationRequest
 		err := cursor.Decode(&verificationRequest)
 		if err != nil {
-			return verificationRequests, err
+			return nil, err
 		}
-		verificationRequests = append(verificationRequests, verificationRequest)
+		verificationRequests = append(verificationRequests, verificationRequest.AsAPIVerificationRequest())
 	}
 
-	return verificationRequests, nil
+	return &model.VerificationRequests{
+		VerificationRequests: verificationRequests,
+		Pagination:           &paginationClone,
+	}, nil
 }
 
 // DeleteVerificationRequest to delete verification request from database

server/db/providers/providers.go

@@ -1,6 +1,9 @@
 package providers
 
-import "github.com/authorizerdev/authorizer/server/db/models"
+import (
+	"github.com/authorizerdev/authorizer/server/db/models"
+	"github.com/authorizerdev/authorizer/server/graph/model"
+)
 
 type Provider interface {
 	// AddUser to save user information in database
@@ -10,7 +13,7 @@ type Provider interface {
 	// DeleteUser to delete user information from database
 	DeleteUser(user models.User) error
 	// ListUsers to get list of users from database
-	ListUsers() ([]models.User, error)
+	ListUsers(pagination model.Pagination) (*model.Users, error)
 	// GetUserByEmail to get user information from database using email address
 	GetUserByEmail(email string) (models.User, error)
 	// GetUserByID to get user information from database using user ID
@@ -23,7 +26,7 @@ type Provider interface {
 	// GetVerificationRequestByEmail to get verification request by email from database
 	GetVerificationRequestByEmail(email string, identifier string) (models.VerificationRequest, error)
 	// ListVerificationRequests to get list of verification requests from database
-	ListVerificationRequests() ([]models.VerificationRequest, error)
+	ListVerificationRequests(pagination model.Pagination) (*model.VerificationRequests, error)
 	// DeleteVerificationRequest to delete verification request from database
 	DeleteVerificationRequest(verificationRequest models.VerificationRequest) error
 

server/db/providers/sql/user.go

@@ -8,6 +8,7 @@ import (
 	"github.com/authorizerdev/authorizer/server/constants"
 	"github.com/authorizerdev/authorizer/server/db/models"
 	"github.com/authorizerdev/authorizer/server/envstore"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 	"gorm.io/gorm/clause"
 )
@@ -64,15 +65,32 @@ func (p *provider) DeleteUser(user models.User) error {
 }
 
 // ListUsers to get list of users from database
-func (p *provider) ListUsers() ([]models.User, error) {
+func (p *provider) ListUsers(pagination model.Pagination) (*model.Users, error) {
 	var users []models.User
-	result := p.db.Find(&users)
+	result := p.db.Limit(int(pagination.Limit)).Offset(int(pagination.Offset)).Order("created_at DESC").Find(&users)
 	if result.Error != nil {
 		log.Println("error getting users:", result.Error)
-		return users, result.Error
+		return nil, result.Error
 	}
 
-	return users, nil
+	responseUsers := []*model.User{}
+	for _, user := range users {
+		responseUsers = append(responseUsers, user.AsAPIUser())
+	}
+
+	var total int64
+	totalRes := p.db.Model(&models.User{}).Count(&total)
+	if totalRes.Error != nil {
+		return nil, totalRes.Error
+	}
+
+	paginationClone := pagination
+	paginationClone.Total = total
+
+	return &model.Users{
+		Pagination: &paginationClone,
+		Users:      responseUsers,
+	}, nil
 }
 
 // GetUserByEmail to get user information from database using email address

server/db/providers/sql/verification_requests.go

@@ -4,6 +4,7 @@ import (
 	"log"
 
 	"github.com/authorizerdev/authorizer/server/db/models"
+	"github.com/authorizerdev/authorizer/server/graph/model"
 	"github.com/google/uuid"
 	"gorm.io/gorm/clause"
 )
@@ -56,15 +57,33 @@ func (p *provider) GetVerificationRequestByEmail(email string, identifier string
 }
 
 // ListVerificationRequests to get list of verification requests from database
-func (p *provider) ListVerificationRequests() ([]models.VerificationRequest, error) {
+func (p *provider) ListVerificationRequests(pagination model.Pagination) (*model.VerificationRequests, error) {
 	var verificationRequests []models.VerificationRequest
 
-	result := p.db.Find(&verificationRequests)
+	result := p.db.Limit(int(pagination.Limit)).Offset(int(pagination.Offset)).Order("created_at DESC").Find(&verificationRequests)
 	if result.Error != nil {
 		log.Println("error getting verification requests:", result.Error)
-		return verificationRequests, result.Error
+		return nil, result.Error
 	}
-	return verificationRequests, nil
+
+	responseVerificationRequests := []*model.VerificationRequest{}
+	for _, v := range verificationRequests {
+		responseVerificationRequests = append(responseVerificationRequests, v.AsAPIVerificationRequest())
+	}
+
+	var total int64
+	totalRes := p.db.Model(&models.VerificationRequest{}).Count(&total)
+	if totalRes.Error != nil {
+		return nil, totalRes.Error
+	}
+
+	paginationClone := pagination
+	paginationClone.Total = total
+
+	return &model.VerificationRequests{
+		VerificationRequests: responseVerificationRequests,
+		Pagination:           &paginationClone,
+	}, nil
 }
 
 // DeleteVerificationRequest to delete verification request from database