fix: improve foreign key and not found messages in API v3 (#896)

Author: morremeyer

pkg/controllers/account_v3.go

@@ -55,6 +55,18 @@ type AccountCreateResponseV3 struct {
 	Data  []AccountResponseV3 `json:"data"`                                                          // List of created Accounts
 }
 
+func (a *AccountCreateResponseV3) appendError(err httperrors.Error, status int) int {
+	s := err.Error()
+	a.Data = append(a.Data, AccountResponseV3{Error: &s})
+
+	// The final status code is the highest HTTP status code number
+	if err.Status > status {
+		status = err.Status
+	}
+
+	return status
+}
+
 type AccountResponseV3 struct {
 	Data  *AccountV3 `json:"data"`                                                          // Data for the account
 	Error *string    `json:"error" example:"the specified resource ID is not a valid UUID"` // The error, if any occurred for this transaction
@@ -214,7 +226,7 @@ func (co Controller) OptionsAccountDetailV3(c *gin.Context) {
 // @Failure		404			{object}	AccountCreateResponseV3
 // @Failure		500			{object}	AccountCreateResponseV3
 // @Param			accounts	body		[]AccountCreateV3	true	"Accounts"
-// @Router			/v3/accounts [post].
+// @Router			/v3/accounts [post]
 func (co Controller) CreateAccountsV3(c *gin.Context) {
 	var accounts []AccountCreateV3
 
@@ -236,36 +248,25 @@ func (co Controller) CreateAccountsV3(c *gin.Context) {
 			AccountCreate: create.ToCreate(),
 		}
 
+		// Verify that budget exists. If not, append the error
+		// and move to the next account
+		_, err := getResourceByID[models.Budget](c, co, create.BudgetID)
+		if !err.Nil() {
+			status = r.appendError(err, status)
+			continue
+		}
+
 		dbErr := co.DB.Create(&a).Error
 		if dbErr != nil {
 			err := httperrors.GenericDBError[models.Account](a, c, dbErr)
-			s := err.Error()
-			c.JSON(err.Status, AccountCreateResponseV3{
-				Error: &s,
-			})
-			return
-		}
-
-		// Append the error
-		if !err.Nil() {
-			e := err.Error()
-			r.Data = append(r.Data, AccountResponseV3{Error: &e})
-
-			// The final status code is the highest HTTP status code number since this also
-			// represents the priority we
-			if err.Status > status {
-				status = err.Status
-			}
+			status = r.appendError(err, status)
 			continue
 		}
 
 		aObject, err := co.getAccountV3(c, a.ID)
 		if !err.Nil() {
-			e := err.Error()
-			c.JSON(err.Status, AccountCreateResponseV3{
-				Error: &e,
-			})
-			return
+			status = r.appendError(err, status)
+			continue
 		}
 		r.Data = append(r.Data, AccountResponseV3{Data: &aObject})
 	}

pkg/controllers/account_v3_test.go

@@ -239,29 +239,68 @@ func (suite *TestSuiteStandard) TestAccountsV3GetFilter() {
 }
 
 func (suite *TestSuiteStandard) TestAccountsV3CreateFails() {
+	// Test account for uniqueness
+	a := suite.createTestAccountV3(suite.T(), controllers.AccountCreateV3{
+		Name: "Unique Account Name for Budget",
+	})
+
 	tests := []struct {
-		name   string
-		body   any
-		status int // expected HTTP status
+		name     string
+		body     any
+		status   int                                                       // expected HTTP status
+		testFunc func(t *testing.T, a controllers.AccountCreateResponseV3) // tests to perform against the updated account resource
 	}{
-		{"Broken Body", `[{ "note": 2 }]`, http.StatusBadRequest},
-		{"No body", "", http.StatusBadRequest},
+		{"Broken Body", `[{ "note": 2 }]`, http.StatusBadRequest, func(t *testing.T, a controllers.AccountCreateResponseV3) {
+			assert.Equal(t, "json: cannot unmarshal number into Go struct field AccountCreateV3.note of type string", *a.Error)
+		}},
+		{
+			"No body", "", http.StatusBadRequest,
+			func(t *testing.T, a controllers.AccountCreateResponseV3) {
+				assert.Equal(t, "the request body must not be empty", *a.Error)
+			},
+		},
 		{
 			"No Budget",
 			`[{ "note": "Some text" }]`,
 			http.StatusBadRequest,
+			func(t *testing.T, a controllers.AccountCreateResponseV3) {
+				assert.Equal(t, "no Budget ID specified", *a.Data[0].Error)
+			},
 		},
 		{
 			"Non-existing Budget",
 			`[{ "budgetId": "ea85ad1a-3679-4ced-b83b-89566c12ece9" }]`,
+			http.StatusNotFound,
+			func(t *testing.T, a controllers.AccountCreateResponseV3) {
+				assert.Equal(t, "there is no Budget with this ID", *a.Data[0].Error)
+			},
+		},
+		{
+			"Duplicate name for budget",
+			[]controllers.AccountCreateV3{
+				{
+					Name:     a.Data.Name,
+					BudgetID: a.Data.BudgetID,
+				},
+			},
 			http.StatusBadRequest,
+			func(t *testing.T, a controllers.AccountCreateResponseV3) {
+				assert.Equal(t, "the account name must be unique for the budget", *a.Data[0].Error)
+			},
 		},
 	}
 
 	for _, tt := range tests {
 		suite.T().Run(tt.name, func(t *testing.T) {
-			recorder := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/accounts", tt.body)
-			assertHTTPStatus(t, &recorder, tt.status)
+			r := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/accounts", tt.body)
+			assertHTTPStatus(t, &r, tt.status)
+
+			var a controllers.AccountCreateResponseV3
+			decodeResponse(t, &r, &a)
+
+			if tt.testFunc != nil {
+				tt.testFunc(t, a)
+			}
 		})
 	}
 }

pkg/controllers/budget_v3.go

@@ -74,6 +74,18 @@ type BudgetCreateResponseV3 struct {
 	Data  []BudgetResponseV3 `json:"data"`                                                          // List of created Budgets
 }
 
+func (b *BudgetCreateResponseV3) appendError(err httperrors.Error, status int) int {
+	s := err.Error()
+	b.Data = append(b.Data, BudgetResponseV3{Error: &s})
+
+	// The final status code is the highest HTTP status code number
+	if err.Status > status {
+		status = err.Status
+	}
+
+	return status
+}
+
 type BudgetResponseV3 struct {
 	Data  *BudgetV3 `json:"data"`                                                          // Data for the budget
 	Error *string   `json:"error" example:"the specified resource ID is not a valid UUID"` // The error, if any occurred
@@ -176,34 +188,15 @@ func (co Controller) CreateBudgetsV3(c *gin.Context) {
 		dbErr := co.DB.Create(&b).Error
 		if dbErr != nil {
 			err := httperrors.GenericDBError[models.Budget](b, c, dbErr)
-			s := err.Error()
-			c.JSON(err.Status, BudgetCreateResponseV3{
-				Error: &s,
-			})
-			return
-		}
-
-		// Append the error
-		if !err.Nil() {
-			e := err.Error()
-			r.Data = append(r.Data, BudgetResponseV3{Error: &e})
-
-			// The final status code is the highest HTTP status code number since this also
-			// represents the priority we
-			if err.Status > status {
-				status = err.Status
-			}
+			status = r.appendError(err, status)
 			continue
 		}
 
 		// Append the budget
 		bObject, err := co.getBudgetV3(c, b.ID)
 		if !err.Nil() {
-			e := err.Error()
-			c.JSON(err.Status, BudgetCreateResponseV3{
-				Error: &e,
-			})
-			return
+			status = r.appendError(err, status)
+			continue
 		}
 		r.Data = append(r.Data, BudgetResponseV3{Data: &bObject})
 	}

pkg/controllers/budget_v3_test.go

@@ -180,17 +180,29 @@ func (suite *TestSuiteStandard) TestBudgetsV3GetFilter() {
 
 func (suite *TestSuiteStandard) TestBudgetsV3CreateFails() {
 	tests := []struct {
-		name string
-		body string
+		name     string
+		body     string
+		testFunc func(t *testing.T, b controllers.BudgetCreateResponseV3) // tests to perform against the updated budget resource
 	}{
-		{"Broken Body", `{ "note": 2 }`},
-		{"No body", ""},
+		{"Broken Body", `{ "note": 2 }`, func(t *testing.T, b controllers.BudgetCreateResponseV3) {
+			assert.Equal(t, "json: cannot unmarshal object into Go value of type []models.BudgetCreate", *b.Error)
+		}},
+		{"No body", "", func(t *testing.T, b controllers.BudgetCreateResponseV3) {
+			assert.Equal(t, "the request body must not be empty", *b.Error)
+		}},
 	}
 
 	for _, tt := range tests {
 		suite.T().Run(tt.name, func(t *testing.T) {
-			recorder := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/budgets", tt.body)
-			assertHTTPStatus(t, &recorder, http.StatusBadRequest)
+			r := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/budgets", tt.body)
+			assertHTTPStatus(t, &r, http.StatusBadRequest)
+
+			var b controllers.BudgetCreateResponseV3
+			suite.decodeResponse(&r, &b)
+
+			if tt.testFunc != nil {
+				tt.testFunc(t, b)
+			}
 		})
 	}
 }

pkg/controllers/category_v3.go

@@ -90,6 +90,18 @@ type CategoryCreateResponseV3 struct {
 	Error *string              `json:"error" example:"the specified resource ID is not a valid UUID"` // The error, if any occurred
 }
 
+func (c *CategoryCreateResponseV3) appendError(err httperrors.Error, status int) int {
+	s := err.Error()
+	c.Data = append(c.Data, CategoryResponseV3{Error: &s})
+
+	// The final status code is the highest HTTP status code number
+	if err.Status > status {
+		status = err.Status
+	}
+
+	return status
+}
+
 type CategoryResponseV3 struct {
 	Data  *CategoryV3 `json:"data"`                                                          // Data for the Category
 	Error *string     `json:"error" example:"the specified resource ID is not a valid UUID"` // The error, if any occurred
@@ -206,36 +218,25 @@ func (co Controller) CreateCategoriesV3(c *gin.Context) {
 			CategoryCreate: create.ToCreate(),
 		}
 
+		// Verify that the budget exists. If not, append the error
+		// and move to the next one.
+		_, err := getResourceByID[models.Budget](c, co, create.BudgetID)
+		if !err.Nil() {
+			status = r.appendError(err, status)
+			continue
+		}
+
 		dbErr := co.DB.Create(&category).Error
 		if dbErr != nil {
 			err := httperrors.GenericDBError[models.Category](category, c, dbErr)
-			s := err.Error()
-			c.JSON(err.Status, CategoryCreateResponseV3{
-				Error: &s,
-			})
-			return
-		}
-
-		// Append the error
-		if !err.Nil() {
-			e := err.Error()
-			r.Data = append(r.Data, CategoryResponseV3{Error: &e})
-
-			// The final status code is the highest HTTP status code number since this also
-			// represents the priority we
-			if err.Status > status {
-				status = err.Status
-			}
+			status = r.appendError(err, status)
 			continue
 		}
 
 		eObject, err := co.getCategoryV3(c, category.ID)
 		if !err.Nil() {
-			e := err.Error()
-			c.JSON(err.Status, CategoryCreateResponseV3{
-				Error: &e,
-			})
-			return
+			status = r.appendError(err, status)
+			continue
 		}
 		r.Data = append(r.Data, CategoryResponseV3{Data: &eObject})
 	}

pkg/controllers/category_v3_test.go

@@ -213,36 +213,65 @@ func (suite *TestSuiteStandard) TestCategoriesV3CreateFails() {
 	})
 
 	tests := []struct {
-		name   string
-		body   any
-		status int // expected HTTP status
+		name     string
+		body     any
+		status   int                                                        // expected HTTP status
+		testFunc func(t *testing.T, c controllers.CategoryCreateResponseV3) // tests to perform against the updated category resource
 	}{
-		{"Broken Body", `[{ "note": 2 }]`, http.StatusBadRequest},
-		{"No body", "", http.StatusBadRequest},
+		{
+			"Broken Body", `[{ "note": 2 }]`, http.StatusBadRequest,
+			func(t *testing.T, c controllers.CategoryCreateResponseV3) {
+				assert.Equal(t, "json: cannot unmarshal number into Go struct field CategoryCreateV3.note of type string", *c.Error)
+			},
+		},
+		{
+			"No body", "", http.StatusBadRequest,
+			func(t *testing.T, c controllers.CategoryCreateResponseV3) {
+				assert.Equal(t, "the request body must not be empty", *c.Error)
+			},
+		},
 		{
 			"No Budget",
 			`[{ "note": "Some text" }]`,
 			http.StatusBadRequest,
+			func(t *testing.T, c controllers.CategoryCreateResponseV3) {
+				assert.Equal(t, "no Budget ID specified", *c.Data[0].Error)
+			},
 		},
 		{
 			"Non-existing Budget",
 			`[{ "budgetId": "ea85ad1a-3679-4ced-b83b-89566c12ece9" }]`,
-			http.StatusBadRequest,
+			http.StatusNotFound,
+			func(t *testing.T, c controllers.CategoryCreateResponseV3) {
+				assert.Equal(t, "there is no Budget with this ID", *c.Data[0].Error)
+			},
 		},
 		{
 			"Duplicate name in Budget",
-			controllers.CategoryCreateV3{
-				BudgetID: c.Data.BudgetID,
-				Name:     c.Data.Name,
+			[]controllers.CategoryCreateV3{
+				{
+					BudgetID: c.Data.BudgetID,
+					Name:     c.Data.Name,
+				},
 			},
 			http.StatusBadRequest,
+			func(t *testing.T, c controllers.CategoryCreateResponseV3) {
+				assert.Equal(t, "the category name must be unique for the budget", *c.Data[0].Error)
+			},
 		},
 	}
 
 	for _, tt := range tests {
 		suite.T().Run(tt.name, func(t *testing.T) {
-			recorder := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/categories", tt.body)
-			assertHTTPStatus(t, &recorder, tt.status)
+			r := test.Request(suite.controller, t, http.MethodPost, "http://example.com/v3/categories", tt.body)
+			assertHTTPStatus(t, &r, tt.status)
+
+			var c controllers.CategoryCreateResponseV3
+			decodeResponse(t, &r, &c)
+
+			if tt.testFunc != nil {
+				tt.testFunc(t, c)
+			}
 		})
 	}
 }