refactor(api): pointer receivers for validation

remoterami · remoterami · commit a83aa3a996bf · 2025-03-10T10:52:40.000+01:00
diff --git a/backend/pkg/api/handlers/handler_service.go b/backend/pkg/api/handlers/handler_service.go
@@ -63,12 +63,13 @@ func (h *HandlerService) getDataAccessor(ctx context.Context) dataaccess.DataAcc
 var allNetworks []types.NetworkInfo
 
 type InputValidator[T any] interface {
-	Validate(params map[string]string, payload io.ReadCloser) (T, error)
+	Validate(params map[string]string, payload io.ReadCloser) error
+	*T
 }
 
 type BusinessLogicFunc[Input any, Response any] func(ctx context.Context, input Input) (Response, error)
 
-func Handle[Input InputValidator[Input], Response any](defaultCode int, logicFunc BusinessLogicFunc[Input, Response], isMockingAllowed bool) func(w http.ResponseWriter, r *http.Request) {
+func Handle[Input InputValidator[Value], Value, Response any](defaultCode int, logicFunc BusinessLogicFunc[Input, Response], isMockingAllowed bool) func(w http.ResponseWriter, r *http.Request) {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// prepare input
 		vars := mux.Vars(r)
@@ -83,8 +84,8 @@ func Handle[Input InputValidator[Input], Response any](defaultCode int, logicFun
 			vars[k] = v[0]
 		}
 		// input validation
-		var i Input
-		input, err := i.Validate(vars, r.Body)
+		var input Input = new(Value)
+		err := input.Validate(vars, r.Body)
 		if err != nil {
 			handleErr(w, r, err)
 			return
diff --git a/backend/pkg/api/handlers/handler_service_test.go b/backend/pkg/api/handlers/handler_service_test.go
@@ -33,7 +33,7 @@ type inputMock struct {
 	successMessage string
 }
 
-func (i inputMock) Validate(params map[string]string, payload io.ReadCloser) (inputMock, error) {
+func (i *inputMock) Validate(params map[string]string, payload io.ReadCloser) error {
 	var v validationError
 
 	i.shouldFail = v.checkBool(params["should_fail"], "should_fail")
@@ -44,14 +44,14 @@ func (i inputMock) Validate(params map[string]string, payload io.ReadCloser) (in
 		}
 		var req request
 		if err := v.checkBody(&req, payload); err != nil {
-			return i, err
+			return err
 		}
 		i.successMessage = req.SuccessMessage
 	}
-	return i, v.AsError()
+	return v.AsError()
 }
 
-func logicMock(ctx context.Context, input inputMock) (string, error) {
+func logicMock(ctx context.Context, input *inputMock) (string, error) {
 	if !input.shouldFail {
 		return input.successMessage, nil
 	}
diff --git a/backend/pkg/api/handlers/validator_dashboard.go b/backend/pkg/api/handlers/validator_dashboard.go
@@ -21,23 +21,23 @@ import (
 //	@Failure		400				{object}	types.ApiErrorResponse
 //	@Failure		409				{object}	types.ApiErrorResponse	"Conflict. The request could not be performed by the server because the authenticated user has already reached their group limit."
 //	@Router			/validator-dashboards/{dashboard_id}/groups [post]
-func (i inputPostValidatorDashboardGroups) Validate(params map[string]string, body io.ReadCloser) (inputPostValidatorDashboardGroups, error) {
+func (i *inputPostValidatorDashboardGroups) Validate(params map[string]string, body io.ReadCloser) error {
 	var v validationError
 	var req types.PostValidatorDashboardGroupsRequest
 	if err := v.checkBody(&req, body); err != nil {
-		return i, err
+		return err
 	}
 	i.dashboardId = v.checkPrimaryDashboardId(params["dashboard_id"])
 	i.name = v.checkNameNotEmpty(req.Name)
-	return i, v.AsError()
+	return v.AsError()
 }
 
 type inputPostValidatorDashboardGroups struct {
 	dashboardId types.VDBIdPrimary
 	name        string
 }
 
-func (h *HandlerService) PostValidatorDashboardGroups(ctx context.Context, input inputPostValidatorDashboardGroups) (types.ApiDataResponse[types.VDBPostCreateGroupData], error) {
+func (h *HandlerService) PostValidatorDashboardGroups(ctx context.Context, input *inputPostValidatorDashboardGroups) (types.ApiDataResponse[types.VDBPostCreateGroupData], error) {
 	var r types.ApiDataResponse[types.VDBPostCreateGroupData]
 	dataAccessor := h.getDataAccessor(ctx)
 	userId, err := GetUserIdByContext(ctx)
@@ -76,13 +76,13 @@ func (h *HandlerService) PostValidatorDashboardGroups(ctx context.Context, input
 //	@Success		200				{object}	types.GetValidatorDashboardGroupSummaryResponse
 //	@Failure		400				{object}	types.ApiErrorResponse
 //	@Router			/validator-dashboards/{dashboard_id}/groups/{group_id}/summary [get]
-func (i inputGetValidatorDashboardGroupSummary) Validate(params map[string]string, _ io.ReadCloser) (inputGetValidatorDashboardGroupSummary, error) {
+func (i *inputGetValidatorDashboardGroupSummary) Validate(params map[string]string, _ io.ReadCloser) error {
 	var v validationError
 	i.dashboardIdParam = v.checkDashboardId(params["dashboard_id"])
 	i.groupId = v.checkGroupId(params["group_id"], forbidEmpty)
 	i.period = checkEnum[enums.TimePeriod](&v, params["period"], "period")
 	i.protocolModes = v.checkProtocolModes(params["modes"])
-	return i, v.AsError()
+	return v.AsError()
 }
 
 type inputGetValidatorDashboardGroupSummary struct {
@@ -92,7 +92,7 @@ type inputGetValidatorDashboardGroupSummary struct {
 	period           enums.TimePeriod
 }
 
-func (h *HandlerService) GetValidatorDashboardGroupSummary(ctx context.Context, input inputGetValidatorDashboardGroupSummary) (types.GetValidatorDashboardGroupSummaryResponse, error) {
+func (h *HandlerService) GetValidatorDashboardGroupSummary(ctx context.Context, input *inputGetValidatorDashboardGroupSummary) (types.GetValidatorDashboardGroupSummaryResponse, error) {
 	var r types.GetValidatorDashboardGroupSummaryResponse
 	dashboardId, err := h.getDashboardId(ctx, input.dashboardIdParam)
 	if err != nil {
diff --git a/backend/pkg/api/handlers/validator_dashboard_test.go b/backend/pkg/api/handlers/validator_dashboard_test.go
@@ -44,15 +44,15 @@ func TestInputPostValidatorDashboardGroupsValidate(t *testing.T) {
 	t.Run("success", func(t *testing.T) {
 		params["dashboard_id"] = "1"
 		body := stringAsBody(`{"name":"test"}`)
-		i, err := i.Validate(params, body)
+		err := i.Validate(params, body)
 		assert.Nil(t, err)
 		assert.Equal(t, types.VDBIdPrimary(1), i.dashboardId)
 		assert.Equal(t, "test", i.name)
 	})
 	t.Run("empty name", func(t *testing.T) {
 		params["dashboard_id"] = "1"
 		body := stringAsBody(`{"name":""}`)
-		_, err := i.Validate(params, body)
+		err := i.Validate(params, body)
 		assert.NotNil(t, err)
 	})
 }
@@ -63,15 +63,15 @@ func TestPostValidatorDashboardGroups(t *testing.T) {
 			dashboardId: 0,
 			name:        "test",
 		}
-		_, err := h.PostValidatorDashboardGroups(ctx, input)
+		_, err := h.PostValidatorDashboardGroups(ctx, &input)
 		assert.Nil(t, err)
 	})
 	t.Run("group count reached", func(t *testing.T) {
 		input := inputPostValidatorDashboardGroups{
 			dashboardId: 1,
 			name:        "test",
 		}
-		_, err := h.PostValidatorDashboardGroups(ctx, input)
+		_, err := h.PostValidatorDashboardGroups(ctx, &input)
 		assert.NotNil(t, err)
 		assert.True(t, errors.Is(err, errConflict))
 	})
@@ -87,7 +87,7 @@ func TestInputGetValidatorDashboardGroupSummaryValidate(t *testing.T) {
 			"group_id":     "1",
 			"period":       "all_time",
 		}
-		i, err := i.Validate(params, nil)
+		err := i.Validate(params, nil)
 		assert.Nil(t, err)
 		assert.Equal(t, types.VDBIdPrimary(1), i.dashboardIdParam)
 		assert.Equal(t, int64(1), i.groupId)
@@ -98,7 +98,7 @@ func TestInputGetValidatorDashboardGroupSummaryValidate(t *testing.T) {
 			"group_id":     "1",
 			"period":       "all_time",
 		}
-		_, err := i.Validate(params, nil)
+		err := i.Validate(params, nil)
 		assert.NotNil(t, err)
 	})
 	t.Run("empty group_id", func(t *testing.T) {
@@ -107,7 +107,7 @@ func TestInputGetValidatorDashboardGroupSummaryValidate(t *testing.T) {
 			"group_id":     "",
 			"period":       "all_time",
 		}
-		_, err := i.Validate(params, nil)
+		err := i.Validate(params, nil)
 		assert.NotNil(t, err)
 	})
 	t.Run("empty period", func(t *testing.T) {
@@ -116,7 +116,7 @@ func TestInputGetValidatorDashboardGroupSummaryValidate(t *testing.T) {
 			"group_id":     "1",
 			"period":       "",
 		}
-		_, err := i.Validate(params, nil)
+		err := i.Validate(params, nil)
 		assert.NotNil(t, err)
 	})
 }

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ type inputMock struct {`
`33`	`33`	`successMessage string`
`34`	`34`	`}`
`35`	`35`
`36`		`-func (i inputMock) Validate(params map[string]string, payload io.ReadCloser) (inputMock, error) {`
	`36`	`+func (i *inputMock) Validate(params map[string]string, payload io.ReadCloser) error {`
`37`	`37`	`var v validationError`
`38`	`38`
`39`	`39`	`i.shouldFail = v.checkBool(params["should_fail"], "should_fail")`
`@@ -44,14 +44,14 @@ func (i inputMock) Validate(params map[string]string, payload io.ReadCloser) (in`
`44`	`44`	`}`
`45`	`45`	`var req request`
`46`	`46`	`if err := v.checkBody(&req, payload); err != nil {`
`47`		`- return i, err`
	`47`	`+ return err`
`48`	`48`	`}`
`49`	`49`	`i.successMessage = req.SuccessMessage`
`50`	`50`	`}`
`51`		`- return i, v.AsError()`
	`51`	`+ return v.AsError()`
`52`	`52`	`}`
`53`	`53`
`54`		`-func logicMock(ctx context.Context, input inputMock) (string, error) {`
	`54`	`+func logicMock(ctx context.Context, input *inputMock) (string, error) {`
`55`	`55`	`if !input.shouldFail {`
`56`	`56`	`return input.successMessage, nil`
`57`	`57`	`}`