feat: enable Org search joined with billing Details (#877)

* feat: update protobuf files

* feat: setup service and repo for aggregated org search

* fix: update protobuf files

* chore: update protobuf files

* feat: add rql tags

* refactor: change package name from orgaggregate to orgbilling

* feat: prepare org data joined with their billing subscription data

* feat: fetch latest subscription entry for each org

* feat: fetch billing data for each org from db

* feat: add country of org in response

* feat: add avatar of org in response

* refactor: rename

* feat: add rql filters

* feat: add rql sort

* feat: add rql pagination

* feat: add rql search

* feat: handle empty string in filter

* refactor

* feat: update response schema to have page and group info

* feat: parse group by data

* feat: combine group_by aggregated count with raw data rows

* refactor: for readability

* refactor: for readability

* refactor: for readability and handle error

* feat: add support for in and not in operators

* feat: add support for like and not like in string type

* feat: add support for empty and non empty string check

* refactor: remove redundant if else check

* refactor: for readability

* feat: enable search on timestamp columns

* refactor: for readability

* refactor: for readability

* refactor

* enable transation

* change tx isolation level

* test: add unit test for query generation

* refactor

* refactor: rename package

* update proto

* fix: linting

Author: whoAbhishekSah

.gitignore

@@ -20,4 +20,5 @@ buf.yaml
 /resources_config
 resource_config
 /rules
-/dist
+/dist
+__debug_*

Makefile

@@ -4,7 +4,7 @@ TAG := $(shell git rev-list --tags --max-count=1)
 VERSION := $(shell git describe --tags ${TAG})
 .PHONY: build check fmt lint test test-race vet test-cover-html help install proto ui compose-up-dev
 .DEFAULT_GOAL := build
-PROTON_COMMIT := "86b10eaddc8786d4f27aa5b639a3506218118659"
+PROTON_COMMIT := "fd8e1af945b1cef163ad5fc5341c05025689f620"
 
 ui:
 	@echo " > generating ui build"

cmd/serve.go

@@ -12,6 +12,8 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/raystack/frontier/core/aggregates/orgbilling"
+
 	"github.com/raystack/frontier/core/kyc"
 	"github.com/raystack/frontier/core/prospect"
 
@@ -409,6 +411,9 @@ func buildAPIDependencies(
 	orgKycRepository := postgres.NewOrgKycRepository(dbc)
 	orgKycService := kyc.NewService(orgKycRepository)
 
+	orgBillingRepository := postgres.NewOrgBillingRepository(dbc)
+	orgBillingService := orgbilling.NewService(orgBillingRepository)
+
 	domainRepository := postgres.NewDomainRepository(logger, dbc)
 	domainService := domain.NewService(logger, domainRepository, userService, organizationService)
 
@@ -548,6 +553,7 @@ func buildAPIDependencies(
 		WebhookService:      webhookService,
 		EventService:        eventProcessor,
 		ProspectService:     prospectService,
+		OrgBillingService:   orgBillingService,
 	}
 	return dependencies, nil
 }

core/aggregates/orgbilling/service.go

@@ -0,0 +1,66 @@
+package orgbilling
+
+import (
+	"context"
+	"time"
+
+	"github.com/raystack/frontier/core/organization"
+	"github.com/raystack/salt/rql"
+)
+
+type Repository interface {
+	Search(ctx context.Context, query *rql.Query) (OrgBilling, error)
+}
+
+type Service struct {
+	repository Repository
+}
+
+func NewService(repository Repository) *Service {
+	return &Service{
+		repository: repository,
+	}
+}
+
+type OrgBilling struct {
+	Organizations []AggregatedOrganization `json:"organization"`
+	Group         Group                    `json:"group"`
+	Pagination    Page                     `json:"pagination"`
+}
+
+type Group struct {
+	Name string      `json:"name"`
+	Data []GroupData `json:"data"`
+}
+
+type GroupData struct {
+	Name  string `json:"name"`
+	Count int    `json:"count"`
+}
+
+type Page struct {
+	Limit  int `json:"limit"`
+	Offset int `json:"offset"`
+}
+
+type AggregatedOrganization struct {
+	ID                     string             `rql:"name=id,type=string"`
+	Name                   string             `rql:"name=name,type=string"`
+	Title                  string             `rql:"name=title,type=string"`
+	CreatedBy              string             `rql:"name=created_by,type=string"`
+	PlanName               string             `rql:"name=plan_name,type=string"`
+	PaymentMode            string             `rql:"name=payment_mode,type=string"`
+	Country                string             `rql:"name=country,type=string"`
+	Avatar                 string             `rql:"name=avatar,type=string"`
+	State                  organization.State `rql:"name=state,type=string"`
+	CreatedAt              time.Time          `rql:"name=created_at,type=datetime"`
+	UpdatedAt              time.Time          `rql:"name=updated_at,type=datetime"`
+	SubscriptionCycleEndAt time.Time          `rql:"name=subscription_cycle_end_at,type=datetime"`
+	SubscriptionState      string             `rql:"name=subscription_state,type=string"`
+	PlanInterval           string             `rql:"name=plan_interval,type=string"`
+	PlanID                 string             `rql:"name=plan_id,type=string"`
+}
+
+func (s Service) Search(ctx context.Context, query *rql.Query) (OrgBilling, error) {
+	return s.repository.Search(ctx, query)
+}

go.mod

@@ -36,7 +36,7 @@ require (
 	github.com/ory/dockertest/v3 v3.10.0
 	github.com/pkg/errors v0.9.1
 	github.com/pkg/profile v1.7.0
-	github.com/raystack/salt v0.3.1
+	github.com/raystack/salt v0.3.8
 	github.com/robfig/cron/v3 v3.0.1
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.9.0

go.sum

@@ -10,6 +10,7 @@ import (
 	"github.com/raystack/frontier/billing/product"
 	"github.com/raystack/frontier/billing/subscription"
 	"github.com/raystack/frontier/billing/usage"
+	"github.com/raystack/frontier/core/aggregates/orgbilling"
 	"github.com/raystack/frontier/core/audit"
 	"github.com/raystack/frontier/core/authenticate"
 	"github.com/raystack/frontier/core/authenticate/session"
@@ -70,6 +71,7 @@ type Deps struct {
 	InvoiceService      *invoice.Service
 	WebhookService      *webhook.Service
 	EventService        *event.Service
+	OrgBillingService   *orgbilling.Service
 
 	LogListener *event.ChanListener
 

internal/api/api.go

@@ -19,7 +19,6 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/raystack/frontier/core/organization"
-
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/types/known/timestamppb"

internal/api/v1beta1/org.go

@@ -0,0 +1,129 @@
+package v1beta1
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/raystack/frontier/core/aggregates/orgbilling"
+	frontierv1beta1 "github.com/raystack/frontier/proto/v1beta1"
+	"github.com/raystack/salt/rql"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+	"google.golang.org/protobuf/types/known/timestamppb"
+)
+
+type OrgBillingService interface {
+	Search(ctx context.Context, query *rql.Query) (orgbilling.OrgBilling, error)
+}
+
+func (h Handler) SearchOrganizations(ctx context.Context, request *frontierv1beta1.SearchOrganizationsRequest) (*frontierv1beta1.SearchOrganizationsResponse, error) {
+	var orgs []*frontierv1beta1.SearchOrganizationsResponse_OrganizationResult
+
+	rqlQuery, err := transformProtoToRQL(request.GetQuery())
+	if err != nil {
+		return nil, status.Errorf(codes.InvalidArgument, fmt.Sprintf("failed to read rql query: %v", err))
+	}
+
+	err = rql.ValidateQuery(rqlQuery, orgbilling.AggregatedOrganization{})
+	if err != nil {
+		return nil, status.Errorf(codes.InvalidArgument, fmt.Sprintf("failed to validate rql query: %v", err))
+	}
+
+	orgBillingData, err := h.orgBillingService.Search(ctx, rqlQuery)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, v := range orgBillingData.Organizations {
+		orgs = append(orgs, transformAggregatedOrgToPB(v))
+	}
+
+	groupResponse := make([]*frontierv1beta1.RQLQueryGroupData, 0)
+	for _, groupItem := range orgBillingData.Group.Data {
+		groupResponse = append(groupResponse, &frontierv1beta1.RQLQueryGroupData{
+			Name:  groupItem.Name,
+			Count: uint32(groupItem.Count),
+		})
+	}
+	return &frontierv1beta1.SearchOrganizationsResponse{
+		Organizations: orgs,
+		Pagination: &frontierv1beta1.RQLQueryPaginationResponse{
+			Offset: uint32(orgBillingData.Pagination.Offset),
+			Limit:  uint32(orgBillingData.Pagination.Limit),
+		},
+		Group: &frontierv1beta1.RQLQueryGroupResponse{
+			Name: orgBillingData.Group.Name,
+			Data: groupResponse,
+		},
+	}, nil
+}
+
+func transformProtoToRQL(q *frontierv1beta1.RQLRequest) (*rql.Query, error) {
+	filters := make([]rql.Filter, 0)
+	for _, filter := range q.GetFilters() {
+		datatype, err := rql.GetDataTypeOfField(filter.GetName(), orgbilling.AggregatedOrganization{})
+		if err != nil {
+			return nil, err
+		}
+		switch datatype {
+		case "string":
+			filters = append(filters, rql.Filter{
+				Name:     filter.GetName(),
+				Operator: filter.GetOperator(),
+				Value:    filter.GetStringValue(),
+			})
+		case "number":
+			filters = append(filters, rql.Filter{
+				Name:     filter.GetName(),
+				Operator: filter.GetOperator(),
+				Value:    filter.GetNumberValue(),
+			})
+		case "bool":
+			filters = append(filters, rql.Filter{
+				Name:     filter.GetName(),
+				Operator: filter.GetOperator(),
+				Value:    filter.GetBoolValue(),
+			})
+		case "datetime":
+			filters = append(filters, rql.Filter{
+				Name:     filter.GetName(),
+				Operator: filter.GetOperator(),
+				Value:    filter.GetStringValue(),
+			})
+		}
+	}
+
+	sortItems := make([]rql.Sort, 0)
+	for _, sortItem := range q.GetSort() {
+		sortItems = append(sortItems, rql.Sort{Name: sortItem.GetName(), Order: sortItem.GetOrder()})
+	}
+
+	return &rql.Query{
+		Search:  q.GetSearch(),
+		Offset:  int(q.GetOffset()),
+		Limit:   int(q.GetLimit()),
+		Filters: filters,
+		Sort:    sortItems,
+		GroupBy: q.GetGroupBy(),
+	}, nil
+}
+
+func transformAggregatedOrgToPB(v orgbilling.AggregatedOrganization) *frontierv1beta1.SearchOrganizationsResponse_OrganizationResult {
+	return &frontierv1beta1.SearchOrganizationsResponse_OrganizationResult{
+		Id:                     v.ID,
+		Name:                   v.Name,
+		Title:                  v.Title,
+		Avatar:                 v.Avatar,
+		CreatedAt:              timestamppb.New(v.CreatedAt),
+		UpdatedAt:              timestamppb.New(v.UpdatedAt),
+		CreatedBy:              v.CreatedBy,
+		State:                  string(v.State),
+		Country:                v.Country,
+		PaymentMode:            v.PaymentMode,
+		PlanName:               v.PlanName,
+		PlanId:                 v.PlanID,
+		SubscriptionState:      v.SubscriptionState,
+		PlanInterval:           v.PlanInterval,
+		SubscriptionCycleEndAt: timestamppb.New(v.SubscriptionCycleEndAt),
+	}
+}

internal/api/v1beta1/orgbilling.go

@@ -45,6 +45,7 @@ type Handler struct {
 	webhookService      WebhookService
 	eventService        EventService
 	prospectService     ProspectService
+	orgBillingService   OrgBillingService
 }
 
 func Register(s *grpc.Server, deps api.Deps, authConf authenticate.Config) {
@@ -83,6 +84,7 @@ func Register(s *grpc.Server, deps api.Deps, authConf authenticate.Config) {
 		webhookService:      deps.WebhookService,
 		eventService:        deps.EventService,
 		prospectService:     deps.ProspectService,
+		orgBillingService:   deps.OrgBillingService,
 	}
 	s.RegisterService(&frontierv1beta1.FrontierService_ServiceDesc, handler)
 	s.RegisterService(&frontierv1beta1.AdminService_ServiceDesc, handler)