fix: return HTTP 201 with budget object instead of 204 on import

morremeyer · morremeyer · commit 00a03e231708 · 2022-12-27T14:05:48.000+01:00
diff --git a/api/docs.go b/api/docs.go
@@ -1863,8 +1863,11 @@ const docTemplate = `{
                     }
                 ],
                 "responses": {
-                    "204": {
-                        "description": "No Content"
+                    "201": {
+                        "description": "Created",
+                        "schema": {
+                            "$ref": "#/definitions/controllers.BudgetResponse"
+                        }
                     },
                     "400": {
                         "description": "Bad Request",
diff --git a/api/swagger.json b/api/swagger.json
@@ -1851,8 +1851,11 @@
                     }
                 ],
                 "responses": {
-                    "204": {
-                        "description": "No Content"
+                    "201": {
+                        "description": "Created",
+                        "schema": {
+                            "$ref": "#/definitions/controllers.BudgetResponse"
+                        }
                     },
                     "400": {
                         "description": "Bad Request",
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -2102,8 +2102,10 @@ paths:
       produces:
       - application/json
       responses:
-        "204":
-          description: No Content
+        "201":
+          description: Created
+          schema:
+            $ref: '#/definitions/controllers.BudgetResponse'
         "400":
           description: Bad Request
           schema:
diff --git a/pkg/controllers/import.go b/pkg/controllers/import.go
@@ -80,7 +80,7 @@ func (co Controller) Import(c *gin.Context) {
 //	@Tags			Import
 //	@Accept			multipart/form-data
 //	@Produce		json
-//	@Success		204
+//	@Success		201			{object}	BudgetResponse
 //	@Failure		400			{object}	httperrors.HTTPError
 //	@Failure		500			{object}	httperrors.HTTPError
 //	@Param			file		formData	file	true	"File to import"
@@ -140,11 +140,15 @@ func (co Controller) ImportYnab4(c *gin.Context) {
 		return
 	}
 
-	err = importer.Create(co.DB, query.BudgetName, resources)
+	budget, err = importer.Create(co.DB, query.BudgetName, resources)
 	if err != nil {
 		httperrors.Handler(c, err)
 		return
 	}
 
-	c.JSON(http.StatusNoContent, nil)
+	b, ok := co.getBudgetObject(c, budget.ID)
+	if !ok {
+		return
+	}
+	c.JSON(http.StatusCreated, BudgetResponse{Data: b})
 }
diff --git a/pkg/controllers/import_test.go b/pkg/controllers/import_test.go
@@ -87,5 +87,5 @@ func (suite *TestSuiteStandard) TestImport() {
 	// Import one
 	body, headers := suite.loadTestFile("Budget.yfull")
 	recorder := test.Request(suite.controller, suite.T(), http.MethodPost, "http://example.com/v1/import?budgetName=Test Budget", body, headers)
-	suite.Assert().Equal(http.StatusNoContent, recorder.Code, "Request ID %s, response %s", recorder.Header().Get("x-request-id"), recorder.Body.String())
+	suite.Assert().Equal(http.StatusCreated, recorder.Code, "Request ID %s, response %s", recorder.Header().Get("x-request-id"), recorder.Body.String())
 }
diff --git a/pkg/importer/creator.go b/pkg/importer/creator.go
@@ -4,11 +4,12 @@ import (
 	"errors"
 
 	"github.com/envelope-zero/backend/pkg/importer/types"
+	"github.com/envelope-zero/backend/pkg/models"
 	"github.com/google/uuid"
 	"gorm.io/gorm"
 )
 
-func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) error {
+func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) (models.Budget, error) {
 	// Start a transaction so we can roll back all created resources if an error occurs
 	tx := db.Begin()
 
@@ -18,7 +19,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 	err := tx.Create(&budget).Error
 	if err != nil {
 		tx.Rollback()
-		return err
+		return models.Budget{}, err
 	}
 
 	// Create accounts
@@ -30,7 +31,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		err := tx.Create(&account).Error
 		if err != nil {
 			tx.Rollback()
-			return err
+			return models.Budget{}, err
 		}
 
 		// Update the account in the resources struct so that it also contains the ID
@@ -44,7 +45,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		err := tx.Create(&category.Model).Error
 		if err != nil {
 			tx.Rollback()
-			return err
+			return models.Budget{}, err
 		}
 		resources.Categories[cName] = category
 
@@ -55,7 +56,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 			err := tx.Create(&envelope.Model).Error
 			if err != nil {
 				tx.Rollback()
-				return err
+				return models.Budget{}, err
 			}
 			resources.Categories[category.Model.Name].Envelopes[eName] = envelope
 		}
@@ -64,7 +65,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 	// Create transactions
 	for _, r := range resources.Transactions {
 		if r.Model.Amount.IsNegative() {
-			return errors.New("a transaction to be imported has a negative amount, this is invalid")
+			return models.Budget{}, errors.New("a transaction to be imported has a negative amount, this is invalid")
 		}
 
 		transaction := r.Model
@@ -80,7 +81,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		err := tx.Create(&transaction).Error
 		if err != nil {
 			tx.Rollback()
-			return err
+			return models.Budget{}, err
 		}
 	}
 
@@ -92,7 +93,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		err := tx.Create(&allocation).Error
 		if err != nil {
 			tx.Rollback()
-			return err
+			return models.Budget{}, err
 		}
 	}
 
@@ -104,11 +105,11 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err
 		err := tx.Create(&mConfig).Error
 		if err != nil {
 			tx.Rollback()
-			return err
+			return models.Budget{}, err
 		}
 	}
 
 	// No errors happened, commit the transaction
 	tx.Commit()
-	return nil
+	return budget, nil
 }

Original file line number	Diff line number	Diff line change
`@@ -87,5 +87,5 @@ func (suite *TestSuiteStandard) TestImport() {`
`87`	`87`	`// Import one`
`88`	`88`	`body, headers := suite.loadTestFile("Budget.yfull")`
`89`	`89`	`recorder := test.Request(suite.controller, suite.T(), http.MethodPost, "http://example.com/v1/import?budgetName=Test Budget", body, headers)`
`90`		`- suite.Assert().Equal(http.StatusNoContent, recorder.Code, "Request ID %s, response %s", recorder.Header().Get("x-request-id"), recorder.Body.String())`
	`90`	`+ suite.Assert().Equal(http.StatusCreated, recorder.Code, "Request ID %s, response %s", recorder.Header().Get("x-request-id"), recorder.Body.String())`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,12 @@ import (`
`4`	`4`	`"errors"`
`5`	`5`
`6`	`6`	`"github.com/envelope-zero/backend/pkg/importer/types"`
	`7`	`+ "github.com/envelope-zero/backend/pkg/models"`
`7`	`8`	`"github.com/google/uuid"`
`8`	`9`	`"gorm.io/gorm"`
`9`	`10`	`)`
`10`	`11`
`11`		`-func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) error {`
	`12`	`+func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) (models.Budget, error) {`
`12`	`13`	`// Start a transaction so we can roll back all created resources if an error occurs`
`13`	`14`	`tx := db.Begin()`
`14`	`15`
`@@ -18,7 +19,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`18`	`19`	`err := tx.Create(&budget).Error`
`19`	`20`	`if err != nil {`
`20`	`21`	`tx.Rollback()`
`21`		`- return err`
	`22`	`+ return models.Budget{}, err`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`// Create accounts`
`@@ -30,7 +31,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`30`	`31`	`err := tx.Create(&account).Error`
`31`	`32`	`if err != nil {`
`32`	`33`	`tx.Rollback()`
`33`		`- return err`
	`34`	`+ return models.Budget{}, err`
`34`	`35`	`}`
`35`	`36`
`36`	`37`	`// Update the account in the resources struct so that it also contains the ID`
`@@ -44,7 +45,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`44`	`45`	`err := tx.Create(&category.Model).Error`
`45`	`46`	`if err != nil {`
`46`	`47`	`tx.Rollback()`
`47`		`- return err`
	`48`	`+ return models.Budget{}, err`
`48`	`49`	`}`
`49`	`50`	`resources.Categories[cName] = category`
`50`	`51`
`@@ -55,7 +56,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`55`	`56`	`err := tx.Create(&envelope.Model).Error`
`56`	`57`	`if err != nil {`
`57`	`58`	`tx.Rollback()`
`58`		`- return err`
	`59`	`+ return models.Budget{}, err`
`59`	`60`	`}`
`60`	`61`	`resources.Categories[category.Model.Name].Envelopes[eName] = envelope`
`61`	`62`	`}`
`@@ -64,7 +65,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`64`	`65`	`// Create transactions`
`65`	`66`	`for _, r := range resources.Transactions {`
`66`	`67`	`if r.Model.Amount.IsNegative() {`
`67`		`- return errors.New("a transaction to be imported has a negative amount, this is invalid")`
	`68`	`+ return models.Budget{}, errors.New("a transaction to be imported has a negative amount, this is invalid")`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`transaction := r.Model`
`@@ -80,7 +81,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`80`	`81`	`err := tx.Create(&transaction).Error`
`81`	`82`	`if err != nil {`
`82`	`83`	`tx.Rollback()`
`83`		`- return err`
	`84`	`+ return models.Budget{}, err`
`84`	`85`	`}`
`85`	`86`	`}`
`86`	`87`
`@@ -92,7 +93,7 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`92`	`93`	`err := tx.Create(&allocation).Error`
`93`	`94`	`if err != nil {`
`94`	`95`	`tx.Rollback()`
`95`		`- return err`
	`96`	`+ return models.Budget{}, err`
`96`	`97`	`}`
`97`	`98`	`}`
`98`	`99`
`@@ -104,11 +105,11 @@ func Create(db *gorm.DB, budgetName string, resources types.ParsedResources) err`
`104`	`105`	`err := tx.Create(&mConfig).Error`
`105`	`106`	`if err != nil {`
`106`	`107`	`tx.Rollback()`
`107`		`- return err`
	`108`	`+ return models.Budget{}, err`
`108`	`109`	`}`
`109`	`110`	`}`
`110`	`111`
`111`	`112`	`// No errors happened, commit the transaction`
`112`	`113`	`tx.Commit()`
`113`		`- return nil`
	`114`	`+ return budget, nil`
`114`	`115`	`}`