fix!: prevent duplicate accounts names (#753)

Duplicate account names are confusing, which is why we don't want them.

BREAKING CHANGE: With this change, account names must be unique for every budget.
Existing duplicate account names are updated automatically with a number
to make them unique.

Author: morremeyer

.goreleaser.yaml

@@ -9,7 +9,7 @@ builds:
       - amd64
       - arm64
     ldflags:
-      - -X github.com/envelope-zero/backend/v2/pkg/router.version={{.Version}}
+      - -X github.com/envelope-zero/backend/v3/pkg/router.version={{.Version}}
 
 snapshot:
   name_template: "{{ incpatch .Version }}-next"

Makefile

@@ -25,7 +25,7 @@ coverage: test
 VERSION ?= $(shell git rev-parse HEAD)
 .PHONY: build
 build:
-	go build -ldflags "-X github.com/envelope-zero/backend/v2/pkg/router.version=${VERSION}"
+	go build -ldflags "-X github.com/envelope-zero/backend/v3/pkg/router.version=${VERSION}"
 
 
 .PHONY: docs

docs/upgrading.md

@@ -1,8 +1,18 @@
 # Upgrading
 
+:warning: You cannot skip major versions on upgrades. You have to upgrade to at least one release of each major version.
+
 If upgrades between versions require manual actions, those are described here.
 
-## to any version > v1.0.0
+# to v3.0.0
+
+v3.0.0 does not require manual steps. With v3.0.0, account names must be unique per budget.
+
+# to v2.0.0
+
+v2.0.0 does not require manual steps. With v2.0.0, spent amounts are now negative values instead of positive values.
+
+## < v1.0.0 to v1.0.0
 
 If you are running a version below `v0.35.0`, you _must_ upgrade to `v1.0.0` before you upgrade any further.
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/envelope-zero/backend/v2
+module github.com/envelope-zero/backend/v3
 
 go 1.19
 

main.go

@@ -10,10 +10,10 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/envelope-zero/backend/v2/pkg/controllers"
-	"github.com/envelope-zero/backend/v2/pkg/database"
-	"github.com/envelope-zero/backend/v2/pkg/models"
-	"github.com/envelope-zero/backend/v2/pkg/router"
+	"github.com/envelope-zero/backend/v3/pkg/controllers"
+	"github.com/envelope-zero/backend/v3/pkg/database"
+	"github.com/envelope-zero/backend/v3/pkg/models"
+	"github.com/envelope-zero/backend/v3/pkg/router"
 	"github.com/gin-gonic/gin"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"

pkg/controllers/account.go

@@ -3,9 +3,9 @@ package controllers
 import (
 	"net/http"
 
-	"github.com/envelope-zero/backend/v2/pkg/httperrors"
-	"github.com/envelope-zero/backend/v2/pkg/httputil"
-	"github.com/envelope-zero/backend/v2/pkg/models"
+	"github.com/envelope-zero/backend/v3/pkg/httperrors"
+	"github.com/envelope-zero/backend/v3/pkg/httputil"
+	"github.com/envelope-zero/backend/v3/pkg/models"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
 )

pkg/controllers/account_test.go

@@ -6,9 +6,9 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/envelope-zero/backend/v2/pkg/controllers"
-	"github.com/envelope-zero/backend/v2/pkg/models"
-	"github.com/envelope-zero/backend/v2/test"
+	"github.com/envelope-zero/backend/v3/pkg/controllers"
+	"github.com/envelope-zero/backend/v3/pkg/models"
+	"github.com/envelope-zero/backend/v3/test"
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 )
@@ -48,13 +48,13 @@ func (suite *TestSuiteStandard) TestOptionsAccount() {
 	recorder = test.Request(suite.controller, suite.T(), http.MethodOptions, "http://example.com/v1/accounts/NotParseableAsUUID", "")
 	assert.Equal(suite.T(), http.StatusBadRequest, recorder.Code, "Request ID %s", recorder.Header().Get("x-request-id"))
 
-	path = suite.createTestAccount(models.AccountCreate{}).Data.Links.Self
+	path = suite.createTestAccount(models.AccountCreate{Name: "TestOptionsAccount"}).Data.Links.Self
 	recorder = test.Request(suite.controller, suite.T(), http.MethodOptions, path, "")
 	assert.Equal(suite.T(), http.StatusNoContent, recorder.Code, "Request ID %s", recorder.Header().Get("x-request-id"))
 }
 
 func (suite *TestSuiteStandard) TestGetAccounts() {
-	_ = suite.createTestAccount(models.AccountCreate{})
+	_ = suite.createTestAccount(models.AccountCreate{Name: "TestGetAccounts"})
 
 	var response controllers.AccountListResponse
 	recorder := test.Request(suite.controller, suite.T(), http.MethodGet, "http://example.com/v1/accounts", "")
@@ -200,7 +200,7 @@ func (suite *TestSuiteStandard) TestAccountInvalidIDs() {
 }
 
 func (suite *TestSuiteStandard) TestCreateAccount() {
-	_ = suite.createTestAccount(models.AccountCreate{Name: "Test account for creation"})
+	_ = suite.createTestAccount(models.AccountCreate{Name: "TestCreateAccount"})
 }
 
 func (suite *TestSuiteStandard) TestCreateAccountNoBudget() {
@@ -235,7 +235,7 @@ func (suite *TestSuiteStandard) TestCreateAccountNoBody() {
 }
 
 func (suite *TestSuiteStandard) TestGetAccount() {
-	a := suite.createTestAccount(models.AccountCreate{})
+	a := suite.createTestAccount(models.AccountCreate{Name: "TestGetAccount"})
 
 	r := test.Request(suite.controller, suite.T(), http.MethodGet, a.Data.Links.Self, "")
 	assert.Equal(suite.T(), http.StatusOK, r.Code)
@@ -266,7 +266,7 @@ func (suite *TestSuiteStandard) TestUpdateAccount() {
 
 func (suite *TestSuiteStandard) TestUpdateAccountBrokenJSON() {
 	a := suite.createTestAccount(models.AccountCreate{
-		Name: "New Account",
+		Name: "TestUpdateAccountBrokenJSON",
 		Note: "More tests something something",
 	})
 
@@ -276,7 +276,7 @@ func (suite *TestSuiteStandard) TestUpdateAccountBrokenJSON() {
 
 func (suite *TestSuiteStandard) TestUpdateAccountInvalidType() {
 	a := suite.createTestAccount(models.AccountCreate{
-		Name: "New Account",
+		Name: "TestUpdateAccountInvalidType",
 		Note: "More tests something something",
 	})
 
@@ -288,7 +288,7 @@ func (suite *TestSuiteStandard) TestUpdateAccountInvalidType() {
 
 func (suite *TestSuiteStandard) TestUpdateAccountInvalidBudgetID() {
 	a := suite.createTestAccount(models.AccountCreate{
-		Name: "New Account",
+		Name: "TestUpdateAccountInvalidBudgetID",
 		Note: "More tests something something",
 	})
 
@@ -327,7 +327,7 @@ func (suite *TestSuiteStandard) TestDeleteNonExistingAccount() {
 }
 
 func (suite *TestSuiteStandard) TestDeleteAccountWithBody() {
-	a := suite.createTestAccount(models.AccountCreate{Name: "Delete me now!"})
+	a := suite.createTestAccount(models.AccountCreate{Name: "TestDeleteAccountWithBody"})
 
 	r := test.Request(suite.controller, suite.T(), http.MethodDelete, a.Data.Links.Self, models.AccountCreate{Name: "Some other account"})
 	assertHTTPStatus(suite.T(), &r, http.StatusNoContent)

pkg/controllers/allocation.go

@@ -6,10 +6,10 @@ import (
 	"github.com/google/uuid"
 	"github.com/shopspring/decimal"
 
-	"github.com/envelope-zero/backend/v2/internal/types"
-	"github.com/envelope-zero/backend/v2/pkg/httperrors"
-	"github.com/envelope-zero/backend/v2/pkg/httputil"
-	"github.com/envelope-zero/backend/v2/pkg/models"
+	"github.com/envelope-zero/backend/v3/internal/types"
+	"github.com/envelope-zero/backend/v3/pkg/httperrors"
+	"github.com/envelope-zero/backend/v3/pkg/httputil"
+	"github.com/envelope-zero/backend/v3/pkg/models"
 	"github.com/gin-gonic/gin"
 )
 

pkg/controllers/allocation_test.go

@@ -7,10 +7,10 @@ import (
 	"testing"
 	"time"
 
-	"github.com/envelope-zero/backend/v2/internal/types"
-	"github.com/envelope-zero/backend/v2/pkg/controllers"
-	"github.com/envelope-zero/backend/v2/pkg/models"
-	"github.com/envelope-zero/backend/v2/test"
+	"github.com/envelope-zero/backend/v3/internal/types"
+	"github.com/envelope-zero/backend/v3/pkg/controllers"
+	"github.com/envelope-zero/backend/v3/pkg/models"
+	"github.com/envelope-zero/backend/v3/test"
 	"github.com/google/uuid"
 	"github.com/shopspring/decimal"
 	"github.com/stretchr/testify/assert"

pkg/controllers/budget.go

@@ -3,10 +3,10 @@ package controllers
 import (
 	"net/http"
 
-	"github.com/envelope-zero/backend/v2/internal/types"
-	"github.com/envelope-zero/backend/v2/pkg/httperrors"
-	"github.com/envelope-zero/backend/v2/pkg/httputil"
-	"github.com/envelope-zero/backend/v2/pkg/models"
+	"github.com/envelope-zero/backend/v3/internal/types"
+	"github.com/envelope-zero/backend/v3/pkg/httperrors"
+	"github.com/envelope-zero/backend/v3/pkg/httputil"
+	"github.com/envelope-zero/backend/v3/pkg/models"
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
 	"github.com/shopspring/decimal"
@@ -194,11 +194,6 @@ func (co Controller) CreateBudget(c *gin.Context) {
 		return
 	}
 
-	// TODO: Delete
-	// budgetObject, ok := co.getBudgetResource(c, budget.ID)
-	// if !ok {
-	// 	return
-	// }
 	c.JSON(http.StatusCreated, BudgetResponse{Data: budget})
 }
 
@@ -431,12 +426,6 @@ func (co Controller) UpdateBudget(c *gin.Context) {
 		return
 	}
 
-	// TODO: delete
-	// budgetObject, ok := co.getBudgetObject(c, budget.ID)
-	// if !ok {
-	// 	httperrors.Handler(c, err)
-	// 	return
-	// }
 	c.JSON(http.StatusOK, BudgetResponse{Data: budget})
 }