refactor(api): introduce a generic query option

Author: heiytor

api/services/device.go

@@ -44,7 +44,7 @@ func (s *service) ListDevices(ctx context.Context, req *requests.DeviceList) ([]
 	}
 
 	if req.TenantID != "" {
-		ns, err := s.store.NamespaceGet(ctx, req.TenantID, s.store.Options().CountAcceptedDevices())
+		ns, err := s.store.NamespaceGet(ctx, req.TenantID)
 		if err != nil {
 			return nil, 0, NewErrNamespaceNotFound(req.TenantID, err)
 		}
@@ -184,7 +184,7 @@ func (s *service) OfflineDevice(ctx context.Context, uid models.UID) error {
 
 // UpdateDeviceStatus updates the device status.
 func (s *service) UpdateDeviceStatus(ctx context.Context, tenant string, uid models.UID, status models.DeviceStatus) error {
-	namespace, err := s.store.NamespaceGet(ctx, tenant, s.store.Options().CountAcceptedDevices())
+	namespace, err := s.store.NamespaceGet(ctx, tenant)
 	if err != nil {
 		return NewErrNamespaceNotFound(tenant, err)
 	}

api/services/member.go

@@ -105,7 +105,7 @@ func (s *service) AddNamespaceMember(ctx context.Context, req *requests.Namespac
 		}
 	}
 
-	return s.store.NamespaceGet(ctx, req.TenantID, s.store.Options().CountAcceptedDevices(), s.store.Options().EnrichMembersData())
+	return s.store.NamespaceGet(ctx, req.TenantID)
 }
 
 // addMember returns a transaction callback that adds a member and sends an invite if the instance is cloud.
@@ -228,7 +228,7 @@ func (s *service) RemoveNamespaceMember(ctx context.Context, req *requests.Names
 			Error("failed to uncache the token")
 	}
 
-	return s.store.NamespaceGet(ctx, req.TenantID, s.store.Options().CountAcceptedDevices(), s.store.Options().EnrichMembersData())
+	return s.store.NamespaceGet(ctx, req.TenantID)
 }
 
 func (s *service) LeaveNamespace(ctx context.Context, req *requests.LeaveNamespace) (*models.UserAuthResponse, error) {

api/services/namespace.go

@@ -98,7 +98,7 @@ func (s *service) CreateNamespace(ctx context.Context, req *requests.NamespaceCr
 }
 
 func (s *service) ListNamespaces(ctx context.Context, req *requests.NamespaceList) ([]models.Namespace, int, error) {
-	namespaces, count, err := s.store.NamespaceList(ctx, req.Paginator, req.Filters, s.store.Options().CountAcceptedDevices(), s.store.Options().EnrichMembersData())
+	namespaces, count, err := s.store.NamespaceList(ctx, s.store.Options().Filter(req.Filters), s.store.Options().Paginate(req.Paginator))
 	if err != nil {
 		return nil, 0, NewErrNamespaceList(err)
 	}
@@ -112,7 +112,7 @@ func (s *service) ListNamespaces(ctx context.Context, req *requests.NamespaceLis
 //
 // GetNamespace returns a models.Namespace and an error. When error is not nil, the models.Namespace is nil.
 func (s *service) GetNamespace(ctx context.Context, tenantID string) (*models.Namespace, error) {
-	namespace, err := s.store.NamespaceGet(ctx, tenantID, s.store.Options().CountAcceptedDevices(), s.store.Options().EnrichMembersData())
+	namespace, err := s.store.NamespaceGet(ctx, tenantID)
 	if err != nil || namespace == nil {
 		return nil, NewErrNamespaceNotFound(tenantID, err)
 	}
@@ -127,7 +127,7 @@ func (s *service) GetNamespace(ctx context.Context, tenantID string) (*models.Na
 // When cloud and billing is enabled, it will try to delete the namespace's billing information from the billing
 // service if it exists.
 func (s *service) DeleteNamespace(ctx context.Context, tenantID string) error {
-	ns, err := s.store.NamespaceGet(ctx, tenantID, s.store.Options().CountAcceptedDevices())
+	ns, err := s.store.NamespaceGet(ctx, tenantID)
 	if err != nil {
 		return NewErrNamespaceNotFound(tenantID, err)
 	}
@@ -161,7 +161,7 @@ func (s *service) EditNamespace(ctx context.Context, req *requests.NamespaceEdit
 		}
 	}
 
-	return s.store.NamespaceGet(ctx, req.Tenant, s.store.Options().CountAcceptedDevices(), s.store.Options().EnrichMembersData())
+	return s.store.NamespaceGet(ctx, req.Tenant)
 }
 
 // EditSessionRecordStatus defines if the sessions will be recorded.

api/store/namespace.go

@@ -3,7 +3,6 @@ package store
 import (
 	"context"
 
-	"github.com/shellhub-io/shellhub/pkg/api/query"
 	"github.com/shellhub-io/shellhub/pkg/models"
 )
 
@@ -15,24 +14,24 @@ type NamespaceStore interface {
 	//
 	// It returns the list of namespaces, the total count of matching documents (ignoring pagination), and
 	// an error if any.
-	NamespaceList(ctx context.Context, paginator query.Paginator, filters query.Filters, opts ...NamespaceQueryOption) ([]models.Namespace, int, error)
+	NamespaceList(ctx context.Context, opts ...QueryOption) ([]models.Namespace, int, error)
 
 	// NamespaceGet retrieves a namespace identified by the given tenantID. A list of options can be
 	// passed to inject additional data into the namespace.
 	//
 	// It returns the namespace or an error if any.
-	NamespaceGet(ctx context.Context, tenantID string, opts ...NamespaceQueryOption) (*models.Namespace, error)
+	NamespaceGet(ctx context.Context, tenantID string, opts ...QueryOption) (*models.Namespace, error)
 
 	// NamespaceGetByName retrieves a namespace by its name, similar to [Store.NamespaceGet], but matches by name instead
 	// of tenantID.
-	NamespaceGetByName(ctx context.Context, name string, opts ...NamespaceQueryOption) (*models.Namespace, error)
+	NamespaceGetByName(ctx context.Context, name string, opts ...QueryOption) (*models.Namespace, error)
 
 	// NamespaceGetPreferred retrieves the user's preferred namespace. If the user has no preferred namespace it returns
 	// the first namespace where the user is a member (typically the first one the user was added to). A list of options
 	// can be passed via `opts` to inject additional data into the namespace.
 	//
 	// It returns the namespace or an error if any.
-	NamespaceGetPreferred(ctx context.Context, userID string, opts ...NamespaceQueryOption) (*models.Namespace, error)
+	NamespaceGetPreferred(ctx context.Context, userID string, opts ...QueryOption) (*models.Namespace, error)
 
 	NamespaceCreate(ctx context.Context, namespace *models.Namespace) (*models.Namespace, error)
 

api/store/pg/namespace.go

@@ -4,28 +4,27 @@ import (
 	"context"
 
 	"github.com/shellhub-io/shellhub/api/store"
-	"github.com/shellhub-io/shellhub/pkg/api/query"
 	"github.com/shellhub-io/shellhub/pkg/models"
 )
 
 func (pg *pg) NamespaceCreate(ctx context.Context, namespace *models.Namespace) (*models.Namespace, error) {
 	return nil, nil
 }
 
-func (pg *pg) NamespaceList(ctx context.Context, paginator query.Paginator, filters query.Filters, opts ...store.NamespaceQueryOption) ([]models.Namespace, int, error) {
+func (pg *pg) NamespaceList(ctx context.Context, opts ...store.QueryOption) ([]models.Namespace, int, error) {
 	return nil, 0, nil
 }
 
-func (pg *pg) NamespaceGet(ctx context.Context, tenantID string, opts ...store.NamespaceQueryOption) (*models.Namespace, error) {
+func (pg *pg) NamespaceGet(ctx context.Context, tenantID string, opts ...store.QueryOption) (*models.Namespace, error) {
 	return nil, nil
 }
 
-func (pg *pg) NamespaceGetByName(ctx context.Context, name string, opts ...store.NamespaceQueryOption) (*models.Namespace, error) {
+func (pg *pg) NamespaceGetByName(ctx context.Context, name string, opts ...store.QueryOption) (*models.Namespace, error) {
 	// TODO: unify get methods
 	return nil, nil
 }
 
-func (pg *pg) NamespaceGetPreferred(ctx context.Context, userID string, opts ...store.NamespaceQueryOption) (*models.Namespace, error) {
+func (pg *pg) NamespaceGetPreferred(ctx context.Context, userID string, opts ...store.QueryOption) (*models.Namespace, error) {
 	// TODO: unify get methods
 	return nil, nil
 }

api/store/pg/pg.go

@@ -14,8 +14,11 @@ import (
 	"github.com/uptrace/bun/dialect/pgdialect"
 )
 
+type queryOptions struct{}
+
 type pg struct {
-	driver *bun.DB
+	driver  *bun.DB
+	options *queryOptions
 }
 
 func URI(host, port, user, password, db string) string {
@@ -35,7 +38,7 @@ func New(ctx context.Context, uri string, opts ...options.Option) (store.Store,
 		return nil, err
 	}
 
-	pg := &pg{driver: bun.NewDB(stdlib.OpenDBFromPool(pool), pgdialect.New())}
+	pg := &pg{driver: bun.NewDB(stdlib.OpenDBFromPool(pool), pgdialect.New()), options: &queryOptions{}}
 	if err := pg.driver.Ping(); err != nil {
 		return nil, err
 	}