refactor: use constanta for sortby field in backend

mnindrazaka · mnindrazaka · commit 62529d10466a · 2024-12-28T01:25:08.000+07:00
diff --git a/apps/api/data/mysql/base/transformers.go b/apps/api/data/mysql/base/transformers.go
@@ -0,0 +1,23 @@
+package base_mysql
+
+import "apps/api/domain/base"
+
+func ToSortByColumn(sortBy base.SortBy) string {
+	switch sortBy {
+	case base.CreatedAt:
+		return "created_at"
+	default:
+		return "created_at"
+	}
+}
+
+func ToOrderColumn(order base.Order) string {
+	switch order {
+	case base.Ascending:
+		return "asc"
+	case base.Descending:
+		return "desc"
+	default:
+		return "asc"
+	}
+}
diff --git a/apps/api/data/mysql/expenses/repository.go b/apps/api/data/mysql/expenses/repository.go
@@ -1,6 +1,8 @@
 package expenses_mysql
 
 import (
+	base_mysql "apps/api/data/mysql/base"
+	"apps/api/domain/base"
 	"apps/api/domain/expenses"
 	"apps/api/utils"
 	"context"
@@ -22,13 +24,9 @@ func (repo Repository) BeginTransaction(ctx context.Context, callback func(ctxWi
 	return utils.BeginDbTransaction(ctx, repo.db, callback)
 }
 
-func (repo Repository) GetExpenseList(ctx context.Context, sortBy string, order string, skip int, limit int) ([]expenses.Expense, error) {
+func (repo Repository) GetExpenseList(ctx context.Context, sortBy base.SortBy, order base.Order, skip int, limit int) ([]expenses.Expense, error) {
 	var expenses []expenses.Expense
-	result := repo.db.Table("expenses").Where("deleted_at is NULL").Preload("ExpenseItems").Preload("Wallet").Preload("Budget")
-
-	if sortBy != "" && order != "" {
-		result = result.Order(fmt.Sprintf("%s %s", sortBy, order))
-	}
+	result := repo.db.Table("expenses").Where("deleted_at is NULL").Preload("ExpenseItems").Preload("Wallet").Preload("Budget").Order(fmt.Sprintf("%s %s", base_mysql.ToSortByColumn(sortBy), base_mysql.ToOrderColumn(order)))
 
 	if skip > 0 {
 		result = result.Offset(skip)
diff --git a/apps/api/data/mysql/materials/repository.go b/apps/api/data/mysql/materials/repository.go
@@ -1,6 +1,8 @@
 package materials_mysql
 
 import (
+	base_mysql "apps/api/data/mysql/base"
+	"apps/api/domain/base"
 	"apps/api/domain/materials"
 	"apps/api/utils"
 	"context"
@@ -22,14 +24,10 @@ func (repo Repository) BeginTransaction(ctx context.Context, callback func(ctxWi
 	return utils.BeginDbTransaction(ctx, repo.db, callback)
 }
 
-func (repo Repository) GetMaterialList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]materials.Material, error) {
+func (repo Repository) GetMaterialList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]materials.Material, error) {
 	db := utils.GetDbFromCtx(ctx, repo.db)
 	var categories []materials.Material
-	result := db.Table("materials").Where("deleted_at", nil)
-
-	if sortBy != "" && order != "" {
-		result = result.Order(fmt.Sprintf("%s %s", sortBy, order))
-	}
+	result := db.Table("materials").Where("deleted_at", nil).Order(fmt.Sprintf("%s %s", base_mysql.ToSortByColumn(sortBy), base_mysql.ToOrderColumn(order)))
 
 	if query != "" {
 		result = result.Where("name LIKE ?", "%"+query+"%")
diff --git a/apps/api/data/mysql/products/repository.go b/apps/api/data/mysql/products/repository.go
@@ -1,6 +1,8 @@
 package products_mysql
 
 import (
+	base_mysql "apps/api/data/mysql/base"
+	"apps/api/domain/base"
 	"apps/api/domain/products"
 	"apps/api/utils"
 	"context"
@@ -22,15 +24,11 @@ func (repo Repository) BeginTransaction(ctx context.Context, callback func(ctxWi
 	return utils.BeginDbTransaction(ctx, repo.db, callback)
 }
 
-func (repo Repository) GetProductList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]products.Product, error) {
+func (repo Repository) GetProductList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]products.Product, error) {
 	db := utils.GetDbFromCtx(ctx, repo.db)
 
 	var products []products.Product
-	result := db.Table("products").Preload("Category").Preload("Materials").Preload("Materials.Material").Where("deleted_at", nil)
-
-	if sortBy != "" && order != "" {
-		result = result.Order(fmt.Sprintf("%s %s", sortBy, order))
-	}
+	result := db.Table("products").Preload("Category").Preload("Materials").Preload("Materials.Material").Where("deleted_at", nil).Order(fmt.Sprintf("%s %s", base_mysql.ToSortByColumn(sortBy), base_mysql.ToOrderColumn(order)))
 
 	if query != "" {
 		result = result.Where("name LIKE ?", "%"+query+"%")
diff --git a/apps/api/data/mysql/transactions/repository.go b/apps/api/data/mysql/transactions/repository.go
@@ -1,6 +1,8 @@
 package transactions_mysql
 
 import (
+	base_mysql "apps/api/data/mysql/base"
+	"apps/api/domain/base"
 	"apps/api/domain/transactions"
 	"apps/api/utils"
 	"context"
@@ -22,15 +24,11 @@ func (repo Repository) BeginTransaction(ctx context.Context, callback func(ctxWi
 	return utils.BeginDbTransaction(ctx, repo.db, callback)
 }
 
-func (repo Repository) GetTransactionList(ctx context.Context, query string, sortBy string, order string, skip int, limit int, paymentStatus transactions.PaymentStatus) ([]transactions.Transaction, error) {
+func (repo Repository) GetTransactionList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int, paymentStatus transactions.PaymentStatus) ([]transactions.Transaction, error) {
 	db := utils.GetDbFromCtx(ctx, repo.db)
 
 	var transactionResults []transactions.Transaction
-	result := db.Table("transactions").Where("deleted_at is NULL").Preload("TransactionItems").Preload("Wallet")
-
-	if sortBy != "" && order != "" {
-		result = result.Order(fmt.Sprintf("%s %s", sortBy, order))
-	}
+	result := db.Table("transactions").Where("deleted_at is NULL").Preload("TransactionItems").Preload("Wallet").Order(fmt.Sprintf("%s %s", base_mysql.ToSortByColumn(sortBy), base_mysql.ToOrderColumn(order)))
 
 	if query != "" {
 		result = result.Where("name LIKE ?", "%"+query+"%")
diff --git a/apps/api/data/mysql/wallets/repository.go b/apps/api/data/mysql/wallets/repository.go
@@ -1,6 +1,8 @@
 package wallets_mysql
 
 import (
+	base_mysql "apps/api/data/mysql/base"
+	"apps/api/domain/base"
 	"apps/api/domain/wallets"
 	"apps/api/utils"
 	"context"
@@ -55,15 +57,11 @@ func (repo Repository) DeleteWalletById(ctx context.Context, id int64) error {
 	return result.Error
 }
 
-func (repo Repository) GetWalletTransferList(ctx context.Context, walletId int64, sortBy string, order string, skip int, limit int) ([]wallets.WalletTransfer, error) {
+func (repo Repository) GetWalletTransferList(ctx context.Context, walletId int64, sortBy base.SortBy, order base.Order, skip int, limit int) ([]wallets.WalletTransfer, error) {
 	db := utils.GetDbFromCtx(ctx, repo.db)
 	var walletTransfers []wallets.WalletTransfer
 
-	result := db.Table("wallet_transfers").Preload("FromWallet").Preload("ToWallet").Where("deleted_at is NULL AND from_wallet_id = ?", walletId)
-
-	if sortBy != "" && order != "" {
-		result = result.Order(fmt.Sprintf("%s %s", sortBy, order))
-	}
+	result := db.Table("wallet_transfers").Preload("FromWallet").Preload("ToWallet").Where("deleted_at is NULL AND from_wallet_id = ?", walletId).Order(fmt.Sprintf("%s %s", base_mysql.ToSortByColumn(sortBy), base_mysql.ToOrderColumn(order)))
 
 	if skip > 0 {
 		result = result.Offset(skip)
diff --git a/apps/api/domain/base/entity.go b/apps/api/domain/base/entity.go
@@ -0,0 +1,14 @@
+package base
+
+type SortBy int
+
+const (
+	CreatedAt SortBy = iota
+)
+
+type Order int
+
+const (
+	Ascending Order = iota
+	Descending
+)
diff --git a/apps/api/domain/expenses/repository.go b/apps/api/domain/expenses/repository.go
@@ -1,12 +1,13 @@
 package expenses
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
 type Repository interface {
 	BeginTransaction(ctx context.Context, callback func(ctxWithTx context.Context) error) error
-	GetExpenseList(ctx context.Context, sortBy string, order string, skip int, limit int) ([]Expense, error)
+	GetExpenseList(ctx context.Context, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Expense, error)
 	GetExpenseById(ctx context.Context, id int64) (Expense, error)
 	CreateExpense(ctx context.Context, expense *Expense) error
 	UpdateExpenseById(ctx context.Context, expense *Expense, id int64) error
diff --git a/apps/api/domain/expenses/usecase.go b/apps/api/domain/expenses/usecase.go
@@ -1,6 +1,7 @@
 package expenses
 
 import (
+	"apps/api/domain/base"
 	"apps/api/domain/budgets"
 	"apps/api/domain/wallets"
 	"context"
@@ -22,7 +23,7 @@ func NewUsecase(repository Repository, budgetRepository budgets.Repository, wall
 	}
 }
 
-func (usecase Usecase) GetExpenseList(ctx context.Context, sortBy string, order string, skip int, limit int) ([]Expense, error) {
+func (usecase Usecase) GetExpenseList(ctx context.Context, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Expense, error) {
 	return usecase.repository.GetExpenseList(ctx, sortBy, order, skip, limit)
 }
 
diff --git a/apps/api/domain/materials/repository.go b/apps/api/domain/materials/repository.go
@@ -1,12 +1,13 @@
 package materials
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
 type Repository interface {
 	BeginTransaction(ctx context.Context, callback func(ctxWithTx context.Context) error) error
-	GetMaterialList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]Material, error)
+	GetMaterialList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Material, error)
 	GetMaterialListTotal(ctx context.Context, query string) (int64, error)
 	GetMaterialById(ctx context.Context, id int64) (Material, error)
 	CreateMaterial(ctx context.Context, materialRequest MaterialRequest) error
diff --git a/apps/api/domain/materials/usecase.go b/apps/api/domain/materials/usecase.go
@@ -1,6 +1,7 @@
 package materials
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
@@ -12,7 +13,7 @@ func NewUsecase(repository Repository) Usecase {
 	return Usecase{repository: repository}
 }
 
-func (usecase Usecase) GetMaterialList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]Material, int64, error) {
+func (usecase Usecase) GetMaterialList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Material, int64, error) {
 	materials, err := usecase.repository.GetMaterialList(ctx, query, sortBy, order, skip, limit)
 	if err != nil {
 		return []Material{}, 0, err
diff --git a/apps/api/domain/products/repository.go b/apps/api/domain/products/repository.go
@@ -1,12 +1,13 @@
 package products
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
 type Repository interface {
 	BeginTransaction(ctx context.Context, callback func(ctxWithTx context.Context) error) error
-	GetProductList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]Product, error)
+	GetProductList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Product, error)
 	GetProductListTotal(ctx context.Context, query string) (int64, error)
 	GetProductById(ctx context.Context, id int64) (Product, error)
 	CreateProduct(ctx context.Context, product *Product) error
diff --git a/apps/api/domain/products/usecase.go b/apps/api/domain/products/usecase.go
@@ -1,6 +1,7 @@
 package products
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
@@ -12,7 +13,7 @@ func NewUsecase(repository Repository) Usecase {
 	return Usecase{repository: repository}
 }
 
-func (usecase Usecase) GetProductList(ctx context.Context, query string, sortBy string, order string, skip int, limit int) ([]Product, int64, error) {
+func (usecase Usecase) GetProductList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Product, int64, error) {
 	products, err := usecase.repository.GetProductList(ctx, query, sortBy, order, skip, limit)
 	if err != nil {
 		return []Product{}, 0, err
diff --git a/apps/api/domain/transactions/repository.go b/apps/api/domain/transactions/repository.go
@@ -1,13 +1,14 @@
 package transactions
 
 import (
+	"apps/api/domain/base"
 	"context"
 	"time"
 )
 
 type Repository interface {
 	BeginTransaction(ctx context.Context, callback func(ctxWithTx context.Context) error) error
-	GetTransactionList(ctx context.Context, query string, sortBy string, order string, skip int, limit int, paymentStatus PaymentStatus) ([]Transaction, error)
+	GetTransactionList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int, paymentStatus PaymentStatus) ([]Transaction, error)
 	GetTransactionListTotal(ctx context.Context, query string, paymentStatus PaymentStatus) (int64, error)
 	GetTransactionById(ctx context.Context, id int64) (Transaction, error)
 	CreateTransaction(ctx context.Context, transaction *Transaction) error
diff --git a/apps/api/domain/transactions/usecase.go b/apps/api/domain/transactions/usecase.go
@@ -1,6 +1,7 @@
 package transactions
 
 import (
+	"apps/api/domain/base"
 	"apps/api/domain/budgets"
 	"apps/api/domain/products"
 	"apps/api/domain/wallets"
@@ -25,7 +26,7 @@ func NewUsecase(repository Repository, productRepository products.Repository, wa
 	}
 }
 
-func (usecase Usecase) GetTransactionList(ctx context.Context, query string, sortBy string, order string, skip int, limit int, paymentStatus PaymentStatus) ([]Transaction, int64, error) {
+func (usecase Usecase) GetTransactionList(ctx context.Context, query string, sortBy base.SortBy, order base.Order, skip int, limit int, paymentStatus PaymentStatus) ([]Transaction, int64, error) {
 	transactions, err := usecase.repository.GetTransactionList(ctx, query, sortBy, order, skip, limit, paymentStatus)
 	if err != nil {
 		return []Transaction{}, 0, err
diff --git a/apps/api/domain/wallets/repository.go b/apps/api/domain/wallets/repository.go
@@ -1,6 +1,7 @@
 package wallets
 
 import (
+	"apps/api/domain/base"
 	"context"
 )
 
@@ -11,6 +12,6 @@ type Repository interface {
 	CreateWallet(ctx context.Context, walletRequest WalletRequest) error
 	UpdateWalletById(ctx context.Context, walletRequest WalletRequest, id int64) error
 	DeleteWalletById(ctx context.Context, id int64) error
-	GetWalletTransferList(ctx context.Context, walletId int64, sortBy string, order string, skip int, limit int) ([]WalletTransfer, error)
+	GetWalletTransferList(ctx context.Context, walletId int64, sortBy base.SortBy, order base.Order, skip int, limit int) ([]WalletTransfer, error)
 	CreateWalletTransfer(ctx context.Context, walletTransferRequest WalletTransferRequest, fromWalletId int64) error
 }
diff --git a/apps/api/domain/wallets/usecase.go b/apps/api/domain/wallets/usecase.go
@@ -1,6 +1,7 @@
 package wallets
 
 import (
+	"apps/api/domain/base"
 	"context"
 	"errors"
 )
@@ -33,7 +34,7 @@ func (usecase Usecase) DeleteWalletById(ctx context.Context, id int64) error {
 	return usecase.repository.DeleteWalletById(ctx, id)
 }
 
-func (usecase Usecase) GetWalletTransferList(ctx context.Context, walletId int64, sortBy string, order string, skip int, limit int) ([]WalletTransfer, error) {
+func (usecase Usecase) GetWalletTransferList(ctx context.Context, walletId int64, sortBy base.SortBy, order base.Order, skip int, limit int) ([]WalletTransfer, error) {
 	return usecase.repository.GetWalletTransferList(ctx, walletId, sortBy, order, skip, limit)
 }
 
diff --git a/apps/api/presentation/http/base/transformer.go b/apps/api/presentation/http/base/transformer.go
@@ -1,6 +1,7 @@
 package base
 
 import (
+	"apps/api/domain/base"
 	"encoding/json"
 	apiContract "libs/api-contract"
 	"net/http"
@@ -24,12 +25,26 @@ func WriteError(w http.ResponseWriter, err apiContract.Error) {
 	json.NewEncoder(w).Encode(err)
 }
 
-func GetSortBy(r *http.Request) string {
-	return r.URL.Query().Get("sortBy")
+func GetSortBy(r *http.Request) base.SortBy {
+	sortByQuery := r.URL.Query().Get("sortBy")
+	switch sortByQuery {
+	case "created_at":
+		return base.CreatedAt
+	default:
+		return base.CreatedAt
+	}
 }
 
-func GetOrder(r *http.Request) string {
-	return r.URL.Query().Get("order")
+func GetOrder(r *http.Request) base.Order {
+	orderQuery := r.URL.Query().Get("order")
+	switch orderQuery {
+	case "asc":
+		return base.Ascending
+	case "desc":
+		return base.Descending
+	default:
+		return base.Ascending
+	}
 }
 
 func GetQuery(r *http.Request) string {
diff --git a/libs/api-contract/src/api.yaml b/libs/api-contract/src/api.yaml
@@ -1666,6 +1666,8 @@ components:
       in: query
       schema:
         type: string
+        enum:
+          - created_at
     Order:
       name: order
       in: query

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package expenses`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "apps/api/domain/base"`
`4`	`5`	`"apps/api/domain/budgets"`
`5`	`6`	`"apps/api/domain/wallets"`
`6`	`7`	`"context"`
`@@ -22,7 +23,7 @@ func NewUsecase(repository Repository, budgetRepository budgets.Repository, wall`
`22`	`23`	`}`
`23`	`24`	`}`
`24`	`25`
`25`		`-func (usecase Usecase) GetExpenseList(ctx context.Context, sortBy string, order string, skip int, limit int) ([]Expense, error) {`
	`26`	`+func (usecase Usecase) GetExpenseList(ctx context.Context, sortBy base.SortBy, order base.Order, skip int, limit int) ([]Expense, error) {`
`26`	`27`	`return usecase.repository.GetExpenseList(ctx, sortBy, order, skip, limit)`
`27`	`28`	`}`
`28`	`29`