feat: treat account name and note filter parameters like "contains"

Author: morremeyer

pkg/controllers/account.go

@@ -9,6 +9,7 @@ import (
 	"github.com/envelope-zero/backend/pkg/models"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
+	"golang.org/x/exp/slices"
 )
 
 type AccountListResponse struct {
@@ -30,8 +31,8 @@ type AccountLinks struct {
 }
 
 type AccountQueryFilter struct {
-	Name     string `form:"name"`
-	Note     string `form:"note"`
+	Name     string `form:"name" filterField:"false"` // Fuzzy filter for the account name
+	Note     string `form:"note" filterField:"false"` // Fuzzy filter for the note
 	BudgetID string `form:"budget"`
 	OnBudget bool   `form:"onBudget"`
 	External bool   `form:"external"`
@@ -44,8 +45,6 @@ func (a AccountQueryFilter) ToCreate(c *gin.Context) (models.AccountCreate, bool
 	}
 
 	return models.AccountCreate{
-		Name:     a.Name,
-		Note:     a.Note,
 		BudgetID: budgetID,
 		OnBudget: a.OnBudget,
 		External: a.External,
@@ -165,18 +164,32 @@ func (co Controller) GetAccounts(c *gin.Context) {
 	}
 
 	// Get the set parameters in the query string
-	queryFields, _ := httputil.GetURLFields(c.Request.URL, filter)
+	queryFields, setFields := httputil.GetURLFields(c.Request.URL, filter)
 
 	// Convert the QueryFilter to a Create struct
 	create, ok := filter.ToCreate(c)
 	if !ok {
 		return
 	}
 
-	var accounts []models.Account
-	if !queryWithRetry(c, co.DB.Where(&models.Account{
+	query := co.DB.Where(&models.Account{
 		AccountCreate: create,
-	}, queryFields...).Find(&accounts)) {
+	}, queryFields...)
+
+	if filter.Name != "" {
+		query = query.Where("name LIKE ?", fmt.Sprintf("%%%s%%", filter.Name))
+	} else if slices.Contains(setFields, "Name") {
+		query = query.Where("name = ''")
+	}
+
+	if filter.Note != "" {
+		query = query.Where("note LIKE ?", fmt.Sprintf("%%%s%%", filter.Note))
+	} else if slices.Contains(setFields, "Note") {
+		query = query.Where("note = ''")
+	}
+
+	var accounts []models.Account
+	if !queryWithRetry(c, query.Find(&accounts)) {
 		return
 	}
 

pkg/controllers/account_test.go

@@ -100,19 +100,36 @@ func (suite *TestSuiteStandard) TestGetAccountsFilter() {
 		External: true,
 	})
 
+	_ = suite.createTestAccount(models.AccountCreate{
+		Name:     "",
+		Note:     "specific note",
+		BudgetID: b1.Data.ID,
+	})
+
+	_ = suite.createTestAccount(models.AccountCreate{
+		Name:     "Name only",
+		Note:     "",
+		BudgetID: b1.Data.ID,
+	})
+
 	tests := []struct {
 		name  string
 		query string
 		len   int
 	}{
 		{"Name single", "name=Exact Account Match", 1},
 		{"Name multiple", "name=External Account Filter", 2},
+		{"Fuzzy name", "name=Account", 3},
 		{"Note", "note=A different note", 1},
-		{"Budget", fmt.Sprintf("budget=%s", b1.Data.ID), 2},
+		{"Fuzzy Note", "note=note", 4},
+		{"Empty name with note", "name=&note=specific", 1},
+		{"Empty note with name", "note=&name=Name", 1},
+		{"Empty note and name", "note=&name=&onBudget=false", 0},
+		{"Budget", fmt.Sprintf("budget=%s", b1.Data.ID), 4},
 		{"On budget", "onBudget=true", 1},
-		{"Off budget", "onBudget=false", 2},
+		{"Off budget", "onBudget=false", 4},
 		{"External", "external=true", 2},
-		{"Internal", "external=false", 1},
+		{"Internal", "external=false", 3},
 	}
 
 	for _, tt := range tests {
@@ -126,7 +143,7 @@ func (suite *TestSuiteStandard) TestGetAccountsFilter() {
 			for _, d := range re.Data {
 				accountNames = append(accountNames, d.Name)
 			}
-			assert.Equal(t, tt.len, len(re.Data), "Existing accounts: %#v", strings.Join(accountNames, ", "))
+			assert.Equal(t, tt.len, len(re.Data), "Existing accounts: %#v, Request-ID: %s", strings.Join(accountNames, ", "), r.Header().Get("x-request-id"))
 		})
 	}