Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
refactor: simplify json serializer
Kyle Mendellb47a8b90dec5
diff --git a/backend/api/json_serializer.go b/backend/api/json_serializer.goindex 721a537d9..a8b50a6f8 100644--- a/backend/api/json_serializer.go+++ b/backend/api/json_serializer.go@@ -4,12 +4,8 @@ import (jsonv1 "encoding/json""encoding/json/jsontext""encoding/json/v2"- "errors"- "fmt"- "net/http""github.com/labstack/echo/v5"- "go.getarcane.app/kit/normalization")type jsonV2Serializer struct{}@@ -26,33 +22,9 @@ func (jsonV2Serializer) Serialize(c *echo.Context, value any, indent string) err}func (jsonV2Serializer) Deserialize(c *echo.Context, value any) error {- err := json.UnmarshalRead(c.Request().Body, value, jsonV2APIOptions)- if err == nil {- if normalizeErr := normalization.Normalize(value); normalizeErr != nil {- return echo.NewHTTPError(http.StatusUnprocessableEntity, normalizeErr.Error()).Wrap(normalizeErr)- }- return nil+ if err := json.UnmarshalRead(c.Request().Body, value, jsonV2APIOptions); err != nil {+ return echo.ErrBadRequest.Wrap(err)}- if semanticErr, ok := errors.AsType[*json.SemanticError](err); ok {- return echo.NewHTTPError(- http.StatusBadRequest,- fmt.Sprintf(- "Unmarshal type error: expected=%v, got=%v, field=%v, offset=%v",- semanticErr.GoType,- semanticErr.JSONKind,- semanticErr.JSONPointer,- semanticErr.ByteOffset,- ),- ).Wrap(err)- }-- if syntacticErr, ok := errors.AsType[*jsontext.SyntacticError](err); ok {- return echo.NewHTTPError(- http.StatusBadRequest,- fmt.Sprintf("Syntax error: offset=%v, error=%v", syntacticErr.ByteOffset, syntacticErr.Error()),- ).Wrap(err)- }-- return err+ return nil}diff --git a/backend/api/json_serializer_test.go b/backend/api/json_serializer_test.goindex c0747b5e7..d7ad3ca66 100644--- a/backend/api/json_serializer_test.go+++ b/backend/api/json_serializer_test.go@@ -2,9 +2,9 @@ package apiimport ("bytes"- "errors""net/http""net/http/httptest"+ "strings""testing""time"@@ -87,14 +87,28 @@ func TestJSONV2SerializerUsesStrictV2Decoding(t *testing.T) {var body requestBodyerr := (jsonV2Serializer{}).Deserialize(context, &body)- var httpErr *echo.HTTPError- if !errors.As(err, &httpErr) {- require.ErrorAs(t, err, &httpErr,- "deserialize error = %T %v, want *echo.HTTPError", err, err)- }-- require.Equal(t, http.StatusBadRequest, httpErr.StatusCode(),- "HTTP status = %d, want %d", httpErr.StatusCode(), http.StatusBadRequest)+ require.Equal(t, http.StatusBadRequest, echo.StatusCode(err),+ "HTTP status = %d, want %d", echo.StatusCode(err), http.StatusBadRequest)})}}++func TestEchoSerializerPreservesUnnormalizedStrings(t *testing.T) {+ router := echo.New()+ request := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"name":" e\u0301 ","password":" secret "}`))+ ctx := router.NewContext(request, httptest.NewRecorder())+ var result normalizationTestBody+ require.NoError(t, (jsonV2Serializer{}).Deserialize(ctx, &result))+ require.Equal(t, " e\u0301 ", result.Name)+ require.Equal(t, " secret ", result.Password)+}++func TestEchoSerializerAllowsWhitespaceOnlyName(t *testing.T) {+ router := echo.New()+ request := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"name":" "}`))+ ctx := router.NewContext(request, httptest.NewRecorder())+ var result normalizationTestBody+ err := (jsonV2Serializer{}).Deserialize(ctx, &result)+ require.NoError(t, err)+ require.Equal(t, " ", result.Name)+}diff --git a/backend/api/normalization_test.go b/backend/api/normalization_test.goindex 5d322b405..d7ba463ee 100644--- a/backend/api/normalization_test.go+++ b/backend/api/normalization_test.go@@ -266,24 +266,3 @@ func TestNormalizationRejectsInvalidTagsAtRegistration(t *testing.T) {})})}--func TestEchoSerializerNormalization(t *testing.T) {- router := echo.New()- request := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"name":" e\u0301 ","password":" secret "}`))- ctx := router.NewContext(request, httptest.NewRecorder())- var result normalizationTestBody- require.NoError(t, (jsonV2Serializer{}).Deserialize(ctx, &result))- require.Equal(t, "é", result.Name)- require.Equal(t, " secret ", result.Password)-}--func TestEchoSerializerRejectsNormalizedEmptyName(t *testing.T) {- router := echo.New()- request := httptest.NewRequest(http.MethodPost, "/", strings.NewReader(`{"name":" "}`))- ctx := router.NewContext(request, httptest.NewRecorder())- var result normalizationTestBody- err := (jsonV2Serializer{}).Deserialize(ctx, &result)- var httpError *echo.HTTPError- require.ErrorAs(t, err, &httpError)- require.Equal(t, http.StatusUnprocessableEntity, httpError.Code)-}