refactor: separate validation, response and business logic

.github/workflows/backend-integration-test.yml

@@ -35,7 +35,7 @@ jobs:
         working-directory: backend
         run:
           go install github.com/swaggo/swag/cmd/swag@latest && swag init --ot json -o ./pkg/api/docs -d ./pkg/api/ -g ./handlers/public.go
-          go test -failfast ./pkg/api/... -config "${{ secrets.CI_CONFIG_PATH }}"
+          go test -failfast ./pkg/api/... -config "${{ secrets.CI_CONFIG_PATH }}" --tags=integration
 
 
 

.github/workflows/backend-test.yml

@@ -22,7 +22,7 @@ jobs:
         working-directory: ./backend
         run: |
           export TERM=xterm
-          go test `go list ./... | grep -v "pkg/consapi\|pkg/api\|internal/th\|internal/contracts\|pkg/commons/types\|pkg/commons/contracts\|cmd"` -coverprofile coverage.out -covermode atomic -race
+          go test `go list ./... | grep -v "pkg/consapi\|internal/th\|internal/contracts\|pkg/commons/types\|pkg/commons/contracts\|cmd"` -coverprofile coverage.out -covermode atomic -race
 
       - name: coverage
         working-directory: ./backend

backend/go.mod

@@ -32,6 +32,7 @@ require (
 	github.com/gobitfly/eth.store v0.0.0-20241115163631-57eeb551a84e
 	github.com/golang-jwt/jwt v3.2.2+incompatible
 	github.com/golang-jwt/jwt/v4 v4.5.1
+	github.com/golang/protobuf v1.5.4
 	github.com/gomodule/redigo v1.9.2
 	github.com/google/go-cmp v0.6.0
 	github.com/google/uuid v1.6.0
@@ -175,7 +176,6 @@ require (
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/glog v1.2.2 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/golang/snappy v0.0.5-0.20220116011046-fa5810519dcb // indirect
 	github.com/google/btree v1.1.2 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect

backend/pkg/api/api_test.go

@@ -1,3 +1,6 @@
+//go:build integration
+// +build integration
+
 package api_test
 
 import (

backend/pkg/api/handlers/auth.go

@@ -226,7 +226,7 @@ func (h *HandlerService) InternalPostUsers(w http.ResponseWriter, r *http.Reques
 		Email    string `json:"email"`
 		Password string `json:"password"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -321,7 +321,7 @@ func (h *HandlerService) InternalPostUserPasswordReset(w http.ResponseWriter, r
 	req := struct {
 		Email string `json:"email"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -360,7 +360,7 @@ func (h *HandlerService) InternalPostUserPasswordResetHash(w http.ResponseWriter
 	req := struct {
 		Password string `json:"password"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -428,7 +428,7 @@ func (h *HandlerService) InternalPostLogin(w http.ResponseWriter, r *http.Reques
 		Email    string `json:"email"`
 		Password string `json:"password"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -563,7 +563,7 @@ func (h *HandlerService) InternalPostMobileEquivalentExchange(w http.ResponseWri
 		RefreshToken string `json:"refresh_token"`
 		DeviceID     string `json:"client_id"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -629,7 +629,7 @@ func (h *HandlerService) InternalPostUsersMeNotificationSettingsPairedDevicesTok
 	req := struct {
 		Token string `json:"token"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -658,7 +658,7 @@ const USER_SUBSCRIPTION_LIMIT = 8
 func (h *HandlerService) InternalHandleMobilePurchase(w http.ResponseWriter, r *http.Request) {
 	var v validationError
 	req := types.MobileSubscription{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -794,7 +794,7 @@ func (h *HandlerService) InternalPostUserEmail(w http.ResponseWriter, r *http.Re
 		Email    string `json:"new_email"`
 		Password string `json:"password"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -869,7 +869,7 @@ func (h *HandlerService) InternalPutUserPassword(w http.ResponseWriter, r *http.
 		OldPassword string `json:"old_password"`
 		NewPassword string `json:"new_password"`
 	}{}
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}

backend/pkg/api/handlers/handler_service.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 
 	"github.com/gobitfly/beaconchain/pkg/commons/log"
+	"github.com/gorilla/mux"
 	"github.com/invopop/jsonschema"
 
 	"github.com/alexedwards/scs/v2"
@@ -59,6 +60,41 @@ func (h *HandlerService) getDataAccessor(ctx context.Context) dataaccess.DataAcc
 // all networks available in the system, filled on startup in NewHandlerService
 var allNetworks []types.NetworkInfo
 
+type Checker[T any] interface {
+	Check(params map[string]string, payload io.ReadCloser) (T, error)
+}
+
+type BusinessLogicFunc[Input any, Response any] func(ctx context.Context, input Input) (Response, error)
+
+func Handle[Input Checker[Input], Response any](defaultCode int, logicFunc BusinessLogicFunc[Input, Response]) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		// prepare input
+		vars := mux.Vars(r)
+		q := r.URL.Query()
+		for k, v := range q {
+			if _, ok := vars[k]; ok || len(v) == 0 {
+				continue
+			}
+			vars[k] = v[0]
+		}
+		// input validation
+		var i Input
+		input, err := i.Check(vars, r.Body)
+		if err != nil {
+			handleErr(w, r, err)
+			return
+		}
+		// business logic
+		response, err := logicFunc(r.Context(), input)
+		if err != nil {
+			handleErr(w, r, err)
+			return
+		}
+
+		writeResponse(w, r, defaultCode, response)
+	}
+}
+
 // --------------------------------------
 // errors
 

backend/pkg/api/handlers/input_validation.go

@@ -1,8 +1,8 @@
 package handlers
 
 import (
-	"bytes"
 	"cmp"
+	"encoding/base64"
 	"encoding/json"
 	"fmt"
 	"io"
@@ -95,6 +95,13 @@ func (v *validationError) hasErrors() bool {
 	return v != nil && len(*v) > 0
 }
 
+func (v *validationError) AsError() error {
+	if v.hasErrors() {
+		return newBadRequestErr("%s", v.Error())
+	}
+	return nil
+}
+
 // --------------------------------------
 
 func (v *validationError) checkRegex(regex *regexp.Regexp, param, paramName string) string {
@@ -142,14 +149,8 @@ func (v *validationError) checkUserEmailToken(token string) string {
 
 // check request structure (body contains valid json and all required parameters are present)
 // return error only if internal error occurs, otherwise add error to validationError and/or return nil
-func (v *validationError) checkBody(data interface{}, r *http.Request) error {
-	// check if content type is application/json
-	if contentType := r.Header.Get("Content-Type"); !reJsonContentType.MatchString(contentType) {
-		v.add("request body", "'Content-Type' header must be 'application/json'")
-	}
-
-	bodyBytes, err := io.ReadAll(r.Body)
-	r.Body = io.NopCloser(bytes.NewReader(bodyBytes)) // unconsume body for error logging
+func (v *validationError) checkBody(data interface{}, requestBody io.ReadCloser) error { // <- should be checkBody after refactoring
+	bodyBytes, err := io.ReadAll(requestBody)
 	if err != nil {
 		return newInternalServerErr("error reading request body")
 	}
@@ -560,3 +561,28 @@ func (v *validationError) checkTimestamps(r *http.Request, chartLimits ChartTime
 		return afterTs, beforeTs
 	}
 }
+
+func (v *validationError) checkDashboardId(id string) interface{} {
+	if reInteger.MatchString(id) {
+		// given id is a normal id
+		id := v.checkUint(id, "dashboard_id")
+		return types.VDBIdPrimary(id)
+	}
+	if reValidatorDashboardPublicId.MatchString(id) {
+		// given id is a public id
+		return types.VDBIdPublic(id)
+	}
+	// given id must be an encoded set of validators
+	decodedId, err := base64.RawURLEncoding.DecodeString(id)
+	if err != nil {
+		v.add("dashboard_id", fmt.Sprintf("given value '%s' is not a valid dashboard id", id))
+		return nil
+	}
+	var validatorListError validationError
+	indexes, publicKeys := validatorListError.checkValidatorList(string(decodedId), forbidEmpty)
+	if validatorListError.hasErrors() {
+		v.add("dashboard_id", fmt.Sprintf("given value '%s' is not a valid dashboard id", id))
+		return nil
+	}
+	return validatorSet{Indexes: indexes, PublicKeys: publicKeys}
+}

backend/pkg/api/handlers/internal.go

@@ -106,7 +106,7 @@ func (h *HandlerService) InternalPostAdConfigurations(w http.ResponseWriter, r *
 	}
 
 	var req types.AdConfigurationData
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -183,7 +183,7 @@ func (h *HandlerService) InternalPutAdConfiguration(w http.ResponseWriter, r *ht
 
 	key := v.checkKeyNotEmpty(mux.Vars(r)["key"])
 	var req types.AdConfigurationUpdateData
-	if err := v.checkBody(&req, r); err != nil {
+	if err := v.checkBody(&req, r.Body); err != nil {
 		handleErr(w, r, err)
 		return
 	}
@@ -348,10 +348,6 @@ func (h *HandlerService) InternalPutValidatorDashboardName(w http.ResponseWriter
 	h.PublicPutValidatorDashboardName(w, r)
 }
 
-func (h *HandlerService) InternalPostValidatorDashboardGroups(w http.ResponseWriter, r *http.Request) {
-	h.PublicPostValidatorDashboardGroups(w, r)
-}
-
 func (h *HandlerService) InternalPutValidatorDashboardGroups(w http.ResponseWriter, r *http.Request) {
 	h.PublicPutValidatorDashboardGroups(w, r)
 }
@@ -431,11 +427,6 @@ func (h *HandlerService) InternalGetValidatorDashboardSlotViz(w http.ResponseWri
 func (h *HandlerService) InternalGetValidatorDashboardSummary(w http.ResponseWriter, r *http.Request) {
 	h.PublicGetValidatorDashboardSummary(w, r)
 }
-
-func (h *HandlerService) InternalGetValidatorDashboardGroupSummary(w http.ResponseWriter, r *http.Request) {
-	h.PublicGetValidatorDashboardGroupSummary(w, r)
-}
-
 func (h *HandlerService) InternalGetValidatorDashboardSummaryChart(w http.ResponseWriter, r *http.Request) {
 	h.PublicGetValidatorDashboardSummaryChart(w, r)
 }