refactor: add setField return for GetURLFields

Author: morremeyer

pkg/controllers/account.go

@@ -165,7 +165,7 @@ func (co Controller) GetAccounts(c *gin.Context) {
 	}
 
 	// Get the set parameters in the query string
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)

pkg/controllers/allocation.go

@@ -160,7 +160,7 @@ func (co Controller) GetAllocations(c *gin.Context) {
 	}
 
 	// Get the parameters set in the query string
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)

pkg/controllers/budget.go

@@ -237,7 +237,7 @@ func (co Controller) GetBudgets(c *gin.Context) {
 	_ = c.Bind(&filter)
 
 	// Get the fields that we're filtering for
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	var budgets []models.Budget
 

pkg/controllers/category.go

@@ -159,7 +159,7 @@ func (co Controller) GetCategories(c *gin.Context) {
 	_ = c.Bind(&filter)
 
 	// Get the fields that we are filtering for
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)

pkg/controllers/envelope.go

@@ -161,7 +161,7 @@ func (co Controller) GetEnvelopes(c *gin.Context) {
 	// The filters contain only strings, so this will always succeed
 	_ = c.Bind(&filter)
 
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)

pkg/controllers/month_config.go

@@ -169,7 +169,7 @@ func (co Controller) GetMonthConfigs(c *gin.Context) {
 	}
 
 	// Get the set parameters in the query string
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Filter struct
 	parsed, ok := filter.Parse(c)

pkg/controllers/transaction.go

@@ -224,7 +224,7 @@ func (co Controller) GetTransactions(c *gin.Context) {
 	}
 
 	// Get the fields set in the filter
-	queryFields := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)

pkg/httputil/query.go

@@ -15,8 +15,20 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-func GetURLFields(url *url.URL, filter any) []any {
+// GetURLFields checks which query parameters are set and which query
+// parameters are set and can be used directly in a gorm query
+//
+// queryFields contains all field names that can be used directly
+// in a gorm Where statament as argument to specify the fields filtered on.
+// As gorm uses interface{} as type for the Where statement, we cannot use
+// a []string type here.
+//
+// setFields returns a []string with all field names set in the query parameters.
+// This can be useful to filter for zero values without defining them as pointer
+// fields in gorm.
+func GetURLFields(url *url.URL, filter any) ([]any, []string) {
 	var queryFields []any
+	var setFields []string
 
 	// Add all parameters set in the query string to the queryFields
 	// This is used to determine which fields are queried in the database
@@ -31,11 +43,17 @@ func GetURLFields(url *url.URL, filter any) []any {
 		// GetURLFields (e.g. AccountID on a TransactionQueryFilter)
 		filterField := val.Type().Field(i).Tag.Get("filterField")
 
-		if url.Query().Has(param) && filterField != "false" {
-			queryFields = append(queryFields, field)
+		if url.Query().Has(param) {
+			// All fields are added to SetFields
+			setFields = append(setFields, field)
+
+			// If the field is a filterField (true by default), add it to the queryFields
+			if filterField != "false" {
+				queryFields = append(queryFields, field)
+			}
 		}
 	}
-	return queryFields
+	return queryFields, setFields
 }
 
 // GetBodyFields returns a slice of strings with the field names

pkg/httputil/query_test.go

@@ -15,11 +15,12 @@ import (
 )
 
 func TestGetURLFields(t *testing.T) {
-	url, _ := url.Parse("http://example.com/api/v1/accounts?budget=87645467-ad8a-4e16-ae7f-9d879b45f569&onBudget=false")
+	url, _ := url.Parse("http://example.com/api/v1/accounts?budget=87645467-ad8a-4e16-ae7f-9d879b45f569&onBudget=false&name=")
 
-	queryFields := httputil.GetURLFields(url, controllers.AccountQueryFilter{})
+	queryFields, setFields := httputil.GetURLFields(url, controllers.AccountQueryFilter{})
 
 	assert.Equal(t, []interface{}{"BudgetID", "OnBudget"}, queryFields)
+	assert.Equal(t, []string{"Name", "BudgetID", "OnBudget"}, setFields)
 }
 
 func TestGetBodyFields(t *testing.T) {