Add rebalance threshold to benchmarks

MicroFish91 · MicroFish91 · commit f78350b709bc · 2025-11-28T16:33:36.000-08:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -8,6 +8,13 @@
             "mode": "auto",
             "program": "${fileDirname}"
         },
+        {
+            "name": "Launch API",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}/cmd/api/main.go"
+        },
         {
             "name": "Launch Tests",
             "type": "go",
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ migration:
 	@migrate create -ext sql -dir migrations $(filter-out $@,$(MAKECMDGOALS))
 
 migrate-up:
-	@go run cmd/migrate/main.go up 
+	@go run cmd/migrate/main.go up
 
 migrate-down:
 	@go run cmd/migrate/main.go down 
diff --git a/api/constants/constants.go b/api/constants/constants.go
@@ -13,4 +13,6 @@ const (
 
 	TIMEOUT_MEDIUM = 5 * time.Second
 	TIMEOUT_LONG   = 10 * time.Second
+
+	BENCHMARK_REBALANCE_PCT_DEFAULT = 10
 )
diff --git a/api/services/benchmark/handler_createbenchmark.go b/api/services/benchmark/handler_createbenchmark.go
@@ -31,14 +31,15 @@ func (h *BenchmarkHandlerImpl) CreateBenchmark(c fiber.Ctx) error {
 	benchmark, err := h.benchmarkStore.CreateBenchmark(
 		c.Context(),
 		&types.Benchmark{
-			Name:             benchmarkPayload.Name,
-			Description:      benchmarkPayload.Description,
-			Asset_allocation: benchmarkPayload.Asset_allocation,
-			Std_dev_pct:      benchmarkPayload.Std_dev_pct,
-			Real_return_pct:  benchmarkPayload.Real_return_pct,
-			Drawdown_yrs:     benchmarkPayload.Drawdown_yrs,
-			Is_deprecated:    benchmarkPayload.Is_deprecated,
-			User_id:          userPayload.User_id,
+			Name:                    benchmarkPayload.Name,
+			Description:             benchmarkPayload.Description,
+			Asset_allocation:        benchmarkPayload.Asset_allocation,
+			Std_dev_pct:             benchmarkPayload.Std_dev_pct,
+			Real_return_pct:         benchmarkPayload.Real_return_pct,
+			Drawdown_yrs:            benchmarkPayload.Drawdown_yrs,
+			Rebalance_threshold_pct: benchmarkPayload.Rebalance_threshold_pct,
+			Is_deprecated:           benchmarkPayload.Is_deprecated,
+			User_id:                 userPayload.User_id,
 		},
 	)
 
diff --git a/api/services/benchmark/schema_createbenchmark.go b/api/services/benchmark/schema_createbenchmark.go
@@ -8,13 +8,14 @@ import (
 )
 
 type CreateBenchmarkPayload struct {
-	Name             string                     `json:"name"`
-	Description      string                     `json:"description"`
-	Asset_allocation []types.AssetAllocationPct `json:"asset_allocation"`
-	Std_dev_pct      float32                    `json:"std_dev_pct"`
-	Real_return_pct  float32                    `json:"real_return_pct"`
-	Drawdown_yrs     int                        `json:"drawdown_yrs"`
-	Is_deprecated    bool                       `json:"is_deprecated"`
+	Name                    string                     `json:"name"`
+	Description             string                     `json:"description"`
+	Asset_allocation        []types.AssetAllocationPct `json:"asset_allocation"`
+	Std_dev_pct             float32                    `json:"std_dev_pct"`
+	Real_return_pct         float32                    `json:"real_return_pct"`
+	Drawdown_yrs            int                        `json:"drawdown_yrs"`
+	Rebalance_threshold_pct int                        `json:"rebalance_threshold_pct"`
+	Is_deprecated           bool                       `json:"is_deprecated"`
 }
 
 func (p CreateBenchmarkPayload) Validate() error {
@@ -42,6 +43,7 @@ func (p CreateBenchmarkPayload) Validate() error {
 		validation.Field(&p.Std_dev_pct, validation.Min(float32(0)), validation.Max(float32(100))),
 		validation.Field(&p.Real_return_pct, validation.Min(float32(0)), validation.Max(float32(100))),
 		validation.Field(&p.Drawdown_yrs, validation.Min(0), validation.Max(50)),
+		validation.Field(&p.Rebalance_threshold_pct, validation.Min(1), validation.Max(100)),
 		validation.Field(&p.Is_deprecated),
 	)
 }
diff --git a/api/services/benchmark/schema_updatebenchmark.go b/api/services/benchmark/schema_updatebenchmark.go
@@ -18,13 +18,14 @@ func (p UpdateBenchmarkById) Validate() error {
 }
 
 type UpdateBenchmarkPayload struct {
-	Name             string                     `json:"name"`
-	Description      string                     `json:"description"`
-	Asset_allocation []types.AssetAllocationPct `json:"asset_allocation"`
-	Std_dev_pct      float32                    `json:"std_dev_pct"`
-	Real_return_pct  float32                    `json:"real_return_pct"`
-	Drawdown_yrs     int                        `json:"drawdown_yrs"`
-	Is_deprecated    bool                       `json:"is_deprecated"`
+	Name                    string                     `json:"name"`
+	Description             string                     `json:"description"`
+	Asset_allocation        []types.AssetAllocationPct `json:"asset_allocation"`
+	Std_dev_pct             float32                    `json:"std_dev_pct"`
+	Real_return_pct         float32                    `json:"real_return_pct"`
+	Drawdown_yrs            int                        `json:"drawdown_yrs"`
+	Rebalance_threshold_pct int                        `json:"rebalance_threshold_pct"`
+	Is_deprecated           bool                       `json:"is_deprecated"`
 }
 
 func (p UpdateBenchmarkPayload) Validate() error {
@@ -52,6 +53,7 @@ func (p UpdateBenchmarkPayload) Validate() error {
 		validation.Field(&p.Std_dev_pct, validation.Min(float32(0)), validation.Max(float32(100))),
 		validation.Field(&p.Real_return_pct, validation.Min(float32(0)), validation.Max(float32(100))),
 		validation.Field(&p.Drawdown_yrs, validation.Min(0), validation.Max(50)),
+		validation.Field(&p.Rebalance_threshold_pct, validation.Min(1), validation.Max(100)),
 		validation.Field(&p.Is_deprecated),
 	)
 }
diff --git a/api/services/benchmark/store_createbenchmark.go b/api/services/benchmark/store_createbenchmark.go
@@ -16,13 +16,18 @@ func (s *PostgresBenchmarkStore) CreateBenchmark(ctx context.Context, b *types.B
 		return types.Benchmark{}, errors.New("service error: benchmark struct cannot be nil, valid benchmark data is required")
 	}
 
+	var rebalance_threshold_pct int = b.Rebalance_threshold_pct
+	if b.Rebalance_threshold_pct == 0 {
+		rebalance_threshold_pct = constants.BENCHMARK_REBALANCE_PCT_DEFAULT
+	}
+
 	row := s.db.QueryRow(
 		c,
 		`INSERT INTO benchmarks
-		(name, description, asset_allocation, std_dev_pct, real_return_pct, drawdown_yrs, is_deprecated, user_id)
-		VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
+		(name, description, asset_allocation, std_dev_pct, real_return_pct, drawdown_yrs, is_deprecated, user_id, rebalance_threshold_pct)
+		VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9)
 		RETURNING *`,
-		b.Name, b.Description, b.Asset_allocation, b.Std_dev_pct, b.Real_return_pct, b.Drawdown_yrs, b.Is_deprecated, b.User_id,
+		b.Name, b.Description, b.Asset_allocation, b.Std_dev_pct, b.Real_return_pct, b.Drawdown_yrs, b.Is_deprecated, b.User_id, rebalance_threshold_pct,
 	)
 
 	benchmark, err := s.parseRowIntoBenchmark(row)
diff --git a/api/services/benchmark/store_getbenchmarkbyid.go b/api/services/benchmark/store_getbenchmarkbyid.go
@@ -49,6 +49,7 @@ func (s *PostgresBenchmarkStore) parseRowIntoBenchmark(row pgx.Row) (types.Bench
 		&b.User_id,
 		&b.Created_at,
 		&b.Updated_at,
+		&b.Rebalance_threshold_pct,
 	)
 
 	if err != nil {
diff --git a/api/services/benchmark/store_getbenchmarks.go b/api/services/benchmark/store_getbenchmarks.go
@@ -103,6 +103,7 @@ func (s *PostgresBenchmarkStore) parseRowsIntoBenchmarks(rows pgx.Rows) ([]types
 			&b.User_id,
 			&b.Created_at,
 			&b.Updated_at,
+			&b.Rebalance_threshold_pct,
 			&total_items,
 		)
 
diff --git a/api/services/benchmark/store_updatebenchmark.go b/api/services/benchmark/store_updatebenchmark.go
@@ -29,6 +29,7 @@ func (s *PostgresBenchmarkStore) UpdateBenchmark(ctx context.Context, b *types.B
 				real_return_pct = $5,
 				drawdown_yrs = $6,
 				is_deprecated = $7,
+				rebalance_threshold_pct = $10,
 				updated_at = now()
 			where
 				benchmark_id = $8
@@ -45,6 +46,7 @@ func (s *PostgresBenchmarkStore) UpdateBenchmark(ctx context.Context, b *types.B
 		b.Is_deprecated,
 		b.Benchmark_id,
 		b.User_id,
+		b.Rebalance_threshold_pct,
 	)
 
 	benchmark, err := s.parseRowIntoBenchmark(row)
diff --git a/api/types/benchmark.go b/api/types/benchmark.go
@@ -13,17 +13,18 @@ type AssetAllocationPct struct {
 }
 
 type Benchmark struct {
-	Benchmark_id     int                  `json:"benchmark_id"`
-	Name             string               `json:"name"`
-	Description      string               `json:"description"`
-	Asset_allocation []AssetAllocationPct `json:"asset_allocation"`
-	Std_dev_pct      float32              `json:"std_dev_pct"`
-	Real_return_pct  float32              `json:"real_return_pct"`
-	Drawdown_yrs     int                  `json:"drawdown_yrs"`
-	Is_deprecated    bool                 `json:"is_deprecated"`
-	User_id          int                  `json:"user_id"`
-	Created_at       time.Time            `json:"created_at"`
-	Updated_at       time.Time            `json:"updated_at"`
+	Benchmark_id            int                  `json:"benchmark_id"`
+	Name                    string               `json:"name"`
+	Description             string               `json:"description"`
+	Asset_allocation        []AssetAllocationPct `json:"asset_allocation"`
+	Std_dev_pct             float32              `json:"std_dev_pct"`
+	Real_return_pct         float32              `json:"real_return_pct"`
+	Drawdown_yrs            int                  `json:"drawdown_yrs"`
+	Rebalance_threshold_pct int                  `json:"rebalance_threshold_pct"`
+	Is_deprecated           bool                 `json:"is_deprecated"`
+	User_id                 int                  `json:"user_id"`
+	Created_at              time.Time            `json:"created_at"`
+	Updated_at              time.Time            `json:"updated_at"`
 }
 
 type BenchmarkHandler interface {
diff --git a/migrations/20251128183812_add-benchmark-rebalance-threshold.down.sql b/migrations/20251128183812_add-benchmark-rebalance-threshold.down.sql
@@ -0,0 +1 @@
+ALTER TABLE benchmarks DROP COLUMN rebalance_threshold_pct;
diff --git a/migrations/20251128183812_add-benchmark-rebalance-threshold.up.sql b/migrations/20251128183812_add-benchmark-rebalance-threshold.up.sql
@@ -0,0 +1 @@
+ALTER TABLE benchmarks ADD COLUMN rebalance_threshold_pct integer DEFAULT 10;
diff --git a/tests/integration/testcases/benchmark/createbenchmark.go b/tests/integration/testcases/benchmark/createbenchmark.go
@@ -40,6 +40,29 @@ func CreateBenchmarkTestCases(t *testing.T, userId int, email string) []shared.T
 			},
 			ExpectedStatusCode: fiber.StatusCreated,
 		},
+		{
+			Title: "201 Custom Rebalance Threshold",
+			Payload: benchmark.CreateBenchmarkPayload{
+				Name:        "Classic Bogleheads Portfolio",
+				Description: "The classic 60/40 split",
+				Asset_allocation: []types.AssetAllocationPct{
+					{
+						Category: "TSM",
+						Percent:  60,
+					},
+					{
+						Category: "ITB",
+						Percent:  40,
+					},
+				},
+				Std_dev_pct:             3.4,
+				Real_return_pct:         6.8,
+				Drawdown_yrs:            10,
+				Rebalance_threshold_pct: 5,
+				Is_deprecated:           true,
+			},
+			ExpectedStatusCode: fiber.StatusCreated,
+		},
 		{
 			Title: "201 Valid Duplicate",
 			Payload: benchmark.CreateBenchmarkPayload{
@@ -399,5 +422,41 @@ func CreateBenchmarkTestCases(t *testing.T, userId int, email string) []shared.T
 			},
 			ExpectedStatusCode: fiber.StatusBadRequest,
 		},
+		{
+			Title: "400 Bad Rebalance Threshold 1",
+			Payload: benchmark.CreateBenchmarkPayload{
+				Name:                    "Permanent Portfolio",
+				Description:             "Harry Browne's all-weather portfolio",
+				Std_dev_pct:             0.5,
+				Real_return_pct:         6.5,
+				Drawdown_yrs:            3,
+				Rebalance_threshold_pct: 101,
+			},
+			ExpectedStatusCode: fiber.StatusBadRequest,
+		},
+		{
+			Title: "400 Bad Rebalance Threshold 2",
+			Payload: map[string]any{
+				"Name":                    "Permanent Portfolio",
+				"Description":             "Harry Browne's all-weather portfolio",
+				"Std_dev_pct":             0.5,
+				"Real_return_pct":         6.5,
+				"Drawdown_yrs":            3,
+				"Rebalance_threshold_pct": 40.5,
+			},
+			ExpectedStatusCode: fiber.StatusBadRequest,
+		},
+		{
+			Title: "400 Bad Rebalance Threshold 3",
+			Payload: map[string]any{
+				"Name":                    "Permanent Portfolio",
+				"Description":             "Harry Browne's all-weather portfolio",
+				"Std_dev_pct":             0.5,
+				"Real_return_pct":         6.5,
+				"Drawdown_yrs":            3,
+				"Rebalance_threshold_pct": "40",
+			},
+			ExpectedStatusCode: fiber.StatusBadRequest,
+		},
 	}
 }
diff --git a/tests/integration/testcases/benchmark/getbenchmarks.go b/tests/integration/testcases/benchmark/getbenchmarks.go
@@ -22,11 +22,11 @@ func GetBenchmarksTestCases(t *testing.T, userId int, email string) []shared.Tes
 			Title:              "200",
 			ExpectedStatusCode: fiber.StatusOK,
 			ExpectedResponse: benchmark.GetBenchmarksExpectedResponse{
-				Benchmarks: 30,
+				Benchmarks: 31,
 				Pagination: types.PaginationMetadata{
 					Current_page: 1,
 					Page_size:    50,
-					Total_items:  30,
+					Total_items:  31,
 				},
 			},
 		},
@@ -39,7 +39,7 @@ func GetBenchmarksTestCases(t *testing.T, userId int, email string) []shared.Tes
 				Pagination: types.PaginationMetadata{
 					Current_page: 1,
 					Page_size:    20,
-					Total_items:  30,
+					Total_items:  31,
 				},
 			},
 		},
@@ -48,11 +48,11 @@ func GetBenchmarksTestCases(t *testing.T, userId int, email string) []shared.Tes
 			Route:              "/api/v1/benchmarks?current_page=2&page_size=20",
 			ExpectedStatusCode: fiber.StatusOK,
 			ExpectedResponse: benchmark.GetBenchmarksExpectedResponse{
-				Benchmarks: 10,
+				Benchmarks: 11,
 				Pagination: types.PaginationMetadata{
 					Current_page: 2,
 					Page_size:    20,
-					Total_items:  30,
+					Total_items:  31,
 				},
 			},
 		},
@@ -74,11 +74,11 @@ func GetBenchmarksTestCases(t *testing.T, userId int, email string) []shared.Tes
 			Route:              "/api/v1/benchmarks?name=classic",
 			ExpectedStatusCode: fiber.StatusOK,
 			ExpectedResponse: benchmark.GetBenchmarksExpectedResponse{
-				Benchmarks: 28,
+				Benchmarks: 29,
 				Pagination: types.PaginationMetadata{
 					Current_page: 1,
 					Page_size:    50,
-					Total_items:  28,
+					Total_items:  29,
 				},
 			},
 		},
@@ -87,17 +87,17 @@ func GetBenchmarksTestCases(t *testing.T, userId int, email string) []shared.Tes
 			Route:              "/api/v1/benchmarks?is_deprecated=true",
 			ExpectedStatusCode: fiber.StatusOK,
 			ExpectedResponse: benchmark.GetBenchmarksExpectedResponse{
-				Benchmarks: 3,
+				Benchmarks: 4,
 				Pagination: types.PaginationMetadata{
 					Current_page: 1,
 					Page_size:    50,
-					Total_items:  3,
+					Total_items:  4,
 				},
 			},
 		},
 		{
 			Title:              "200 Combination",
-			Route:              "/api/v1/benchmarks?ids=1,11,15,29&is_deprecated=true",
+			Route:              "/api/v1/benchmarks?ids=1,12,16,30&is_deprecated=true",
 			ExpectedStatusCode: fiber.StatusOK,
 			ExpectedResponse: benchmark.GetBenchmarksExpectedResponse{
 				Benchmarks: 1,
diff --git a/tests/servicereqs/benchmark/createbenchmark.go b/tests/servicereqs/benchmark/createbenchmark.go
@@ -4,6 +4,7 @@ import (
 	"net/http"
 	"testing"
 
+	"github.com/MicroFish91/portfolio-instruments-api/api/constants"
 	"github.com/MicroFish91/portfolio-instruments-api/api/services/benchmark"
 	"github.com/MicroFish91/portfolio-instruments-api/api/types"
 	"github.com/MicroFish91/portfolio-instruments-api/tests/utils"
@@ -18,21 +19,27 @@ func TestCreateBenchmark(t *testing.T, payload any, token string, expectedUserId
 	case 201:
 		p := payload.(benchmark.CreateBenchmarkPayload)
 
+		// Account for the fact that rebalance_threshold_pct is optional and has a default value
+		if p.Rebalance_threshold_pct == 0 {
+			p.Rebalance_threshold_pct = constants.BENCHMARK_REBALANCE_PCT_DEFAULT
+		}
+
 		assert.Equal(t, expectedStatusCode, res.StatusCode)
 		assert.EqualExportedValues(
 			t,
 			types.Benchmark{
-				Benchmark_id:     createBenchmarkResponse.Data.Benchmark.Benchmark_id,
-				Name:             p.Name,
-				Description:      p.Description,
-				Asset_allocation: p.Asset_allocation,
-				Std_dev_pct:      p.Std_dev_pct,
-				Real_return_pct:  p.Real_return_pct,
-				Drawdown_yrs:     p.Drawdown_yrs,
-				Is_deprecated:    p.Is_deprecated,
-				User_id:          expectedUserId,
-				Created_at:       createBenchmarkResponse.Data.Benchmark.Created_at,
-				Updated_at:       createBenchmarkResponse.Data.Benchmark.Updated_at,
+				Benchmark_id:            createBenchmarkResponse.Data.Benchmark.Benchmark_id,
+				Name:                    p.Name,
+				Description:             p.Description,
+				Asset_allocation:        p.Asset_allocation,
+				Std_dev_pct:             p.Std_dev_pct,
+				Real_return_pct:         p.Real_return_pct,
+				Drawdown_yrs:            p.Drawdown_yrs,
+				Rebalance_threshold_pct: p.Rebalance_threshold_pct,
+				Is_deprecated:           p.Is_deprecated,
+				User_id:                 expectedUserId,
+				Created_at:              createBenchmarkResponse.Data.Benchmark.Created_at,
+				Updated_at:              createBenchmarkResponse.Data.Benchmark.Updated_at,
 			},
 			createBenchmarkResponse.Data.Benchmark,
 		)
diff --git a/tests/servicereqs/benchmark/getbenchmark.go b/tests/servicereqs/benchmark/getbenchmark.go

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,6 @@ const (`
`13`	`13`
`14`	`14`	`TIMEOUT_MEDIUM = 5 * time.Second`
`15`	`15`	`TIMEOUT_LONG = 10 * time.Second`
	`16`	`+`
	`17`	`+ BENCHMARK_REBALANCE_PCT_DEFAULT = 10`
`16`	`18`	`)`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ func (s *PostgresBenchmarkStore) parseRowIntoBenchmark(row pgx.Row) (types.Bench`
`49`	`49`	`&b.User_id,`
`50`	`50`	`&b.Created_at,`
`51`	`51`	`&b.Updated_at,`
	`52`	`+ &b.Rebalance_threshold_pct,`
`52`	`53`	`)`
`53`	`54`
`54`	`55`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@ func (s *PostgresBenchmarkStore) parseRowsIntoBenchmarks(rows pgx.Rows) ([]types`
`103`	`103`	`&b.User_id,`
`104`	`104`	`&b.Created_at,`
`105`	`105`	`&b.Updated_at,`
	`106`	`+ &b.Rebalance_threshold_pct,`
`106`	`107`	`&total_items,`
`107`	`108`	`)`
`108`	`109`