Refactoring the PermInteractor (#345)

Author: Noah Lee

internal/interactor/interface.go

@@ -16,12 +16,7 @@ type (
 		UserStore
 		ChatUserStore
 		RepoStore
-
-		ListPermsOfRepo(ctx context.Context, r *ent.Repo, q string, page, perPage int) ([]*ent.Perm, error)
-		FindPermOfRepo(ctx context.Context, r *ent.Repo, u *ent.User) (*ent.Perm, error)
-		CreatePerm(ctx context.Context, p *ent.Perm) (*ent.Perm, error)
-		UpdatePerm(ctx context.Context, p *ent.Perm) (*ent.Perm, error)
-		DeletePermsOfUserLessThanSyncedAt(ctx context.Context, u *ent.User, t time.Time) (int, error)
+		PermStore
 
 		CountDeployments(ctx context.Context) (int, error)
 		SearchDeployments(ctx context.Context, u *ent.User, s []deployment.Status, owned bool, from time.Time, to time.Time, page, perPage int) ([]*ent.Deployment, error)
@@ -67,6 +62,22 @@ type (
 		CheckNotificationRecordOfEvent(ctx context.Context, e *ent.Event) bool
 	}
 
+	// PermStore defines operations for working with perms.
+	PermStore interface {
+		ListPermsOfRepo(ctx context.Context, r *ent.Repo, opt *ListPermsOfRepoOptions) ([]*ent.Perm, error)
+		FindPermOfRepo(ctx context.Context, r *ent.Repo, u *ent.User) (*ent.Perm, error)
+		CreatePerm(ctx context.Context, p *ent.Perm) (*ent.Perm, error)
+		UpdatePerm(ctx context.Context, p *ent.Perm) (*ent.Perm, error)
+		DeletePermsOfUserLessThanSyncedAt(ctx context.Context, u *ent.User, t time.Time) (int, error)
+	}
+
+	ListPermsOfRepoOptions struct {
+		ListOptions
+
+		// Query search the 'login' contains the query.
+		Query string
+	}
+
 	SCM interface {
 		UserSCM
 		RepoSCM

internal/interactor/mock/pkg.go

@@ -5,26 +5,27 @@ import (
 	"fmt"
 	"time"
 
+	i "github.com/gitploy-io/gitploy/internal/interactor"
 	"github.com/gitploy-io/gitploy/model/ent"
 	"github.com/gitploy-io/gitploy/model/ent/perm"
 	"github.com/gitploy-io/gitploy/model/ent/repo"
 	"github.com/gitploy-io/gitploy/model/ent/user"
 	"github.com/gitploy-io/gitploy/pkg/e"
 )
 
-func (s *Store) ListPermsOfRepo(ctx context.Context, r *ent.Repo, q string, page, perPage int) ([]*ent.Perm, error) {
+func (s *Store) ListPermsOfRepo(ctx context.Context, r *ent.Repo, opt *i.ListPermsOfRepoOptions) ([]*ent.Perm, error) {
 	perms, err := s.c.Perm.
 		Query().
 		Where(
 			perm.And(
 				perm.HasRepoWith(repo.IDEQ(r.ID)),
-				perm.HasUserWith(user.LoginContains(q)),
+				perm.HasUserWith(user.LoginContains(opt.Query)),
 			),
 		).
 		WithRepo().
 		WithUser().
-		Limit(perPage).
-		Offset(offset(page, perPage)).
+		Limit(opt.PerPage).
+		Offset(offset(opt.Page, opt.PerPage)).
 		All(ctx)
 	if err != nil {
 		return nil, e.NewError(e.ErrorCodeInternalError, err)

internal/pkg/store/perm.go

@@ -14,7 +14,7 @@ type (
 	Interactor interface {
 		FindUserByID(ctx context.Context, id int64) (*ent.User, error)
 
-		ListPermsOfRepo(ctx context.Context, r *ent.Repo, q string, page, perPage int) ([]*ent.Perm, error)
+		ListPermsOfRepo(ctx context.Context, r *ent.Repo, opt *i.ListPermsOfRepoOptions) ([]*ent.Perm, error)
 		FindPermOfRepo(ctx context.Context, r *ent.Repo, u *ent.User) (*ent.Perm, error)
 
 		ListReposOfUser(ctx context.Context, u *ent.User, opt *i.ListReposOfUserOptions) ([]*ent.Repo, error)

internal/server/api/v1/repos/interface.go

@@ -7,6 +7,7 @@ import (
 	"github.com/gin-gonic/gin"
 	"go.uber.org/zap"
 
+	i "github.com/gitploy-io/gitploy/internal/interactor"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
 	"github.com/gitploy-io/gitploy/model/ent"
 	"github.com/gitploy-io/gitploy/pkg/e"
@@ -42,7 +43,10 @@ func (s *PermAPI) List(c *gin.Context) {
 		perPage = 100
 	}
 
-	perms, err := s.i.ListPermsOfRepo(ctx, re, q, page, perPage)
+	perms, err := s.i.ListPermsOfRepo(ctx, re, &i.ListPermsOfRepoOptions{
+		ListOptions: i.ListOptions{Page: page, PerPage: perPage},
+		Query:       q,
+	})
 	if err != nil {
 		s.log.Check(gb.GetZapLogLevel(err), "Failed to list permissions.").Write(zap.Error(err))
 		gb.ResponseWithError(c, err)