|
| 1 | +// SPDX-License-Identifier: MIT |
| 2 | +// SPDX-FileCopyrightText: © 2015 LabStack LLC and Echo contributors |
| 3 | + |
| 4 | +package sonic |
| 5 | + |
| 6 | +import ( |
| 7 | + "bytes" |
| 8 | + "io" |
| 9 | + "net/http" |
| 10 | + "net/http/httptest" |
| 11 | + "reflect" |
| 12 | + "testing" |
| 13 | + |
| 14 | + "github.com/labstack/echo/v5" |
| 15 | +) |
| 16 | + |
| 17 | +type payload struct { |
| 18 | + ID int `json:"id"` |
| 19 | + Name string `json:"name"` |
| 20 | + Email string `json:"email"` |
| 21 | + Active bool `json:"active"` |
| 22 | + Tags []string `json:"tags"` |
| 23 | + Scores []float64 `json:"scores"` |
| 24 | + Meta map[string]string `json:"meta"` |
| 25 | +} |
| 26 | + |
| 27 | +func sample() payload { |
| 28 | + return payload{ |
| 29 | + ID: 42, |
| 30 | + Name: "Jon Snow", |
| 31 | + Email: "jon@winterfell.north", |
| 32 | + Active: true, |
| 33 | + Tags: []string{"king", "stark", "watch"}, |
| 34 | + Scores: []float64{1.5, 2.25, 3.125}, |
| 35 | + Meta: map[string]string{"house": "stark", "region": "north"}, |
| 36 | + } |
| 37 | +} |
| 38 | + |
| 39 | +// nopResponseWriter discards everything; used to isolate serializer cost. |
| 40 | +type nopResponseWriter struct{ h http.Header } |
| 41 | + |
| 42 | +func (w *nopResponseWriter) Header() http.Header { |
| 43 | + if w.h == nil { |
| 44 | + w.h = make(http.Header) |
| 45 | + } |
| 46 | + return w.h |
| 47 | +} |
| 48 | +func (w *nopResponseWriter) Write(b []byte) (int, error) { return len(b), nil } |
| 49 | +func (w *nopResponseWriter) WriteHeader(int) {} |
| 50 | + |
| 51 | +// TestSerializerRoundTrip verifies sonic encodes/decodes equivalently to the |
| 52 | +// standard library serializer (semantic equality, ignoring trailing newline). |
| 53 | +func TestSerializerRoundTrip(t *testing.T) { |
| 54 | + e := echo.New() |
| 55 | + in := sample() |
| 56 | + |
| 57 | + // Encode with sonic. |
| 58 | + rec := httptest.NewRecorder() |
| 59 | + c := e.NewContext(httptest.NewRequest(http.MethodGet, "/", nil), rec) |
| 60 | + if err := New().Serialize(c, in, ""); err != nil { |
| 61 | + t.Fatalf("sonic Serialize: %v", err) |
| 62 | + } |
| 63 | + |
| 64 | + // Decode it back with sonic. |
| 65 | + var out payload |
| 66 | + dc := e.NewContext(httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(rec.Body.Bytes())), httptest.NewRecorder()) |
| 67 | + if err := New().Deserialize(dc, &out); err != nil { |
| 68 | + t.Fatalf("sonic Deserialize: %v", err) |
| 69 | + } |
| 70 | + if !reflect.DeepEqual(in, out) { |
| 71 | + t.Fatalf("round trip mismatch:\n in=%#v\nout=%#v", in, out) |
| 72 | + } |
| 73 | + |
| 74 | + // Cross-check: the standard serializer must decode sonic's output to the same value. |
| 75 | + var std payload |
| 76 | + sc := e.NewContext(httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(rec.Body.Bytes())), httptest.NewRecorder()) |
| 77 | + if err := (echo.DefaultJSONSerializer{}).Deserialize(sc, &std); err != nil { |
| 78 | + t.Fatalf("default Deserialize of sonic output: %v", err) |
| 79 | + } |
| 80 | + if !reflect.DeepEqual(in, std) { |
| 81 | + t.Fatalf("sonic output not std-compatible:\n in=%#v\nstd=%#v", in, std) |
| 82 | + } |
| 83 | +} |
| 84 | + |
| 85 | +func benchSerialize(b *testing.B, s echo.JSONSerializer) { |
| 86 | + e := echo.New() |
| 87 | + in := sample() |
| 88 | + c := e.NewContext(httptest.NewRequest(http.MethodGet, "/", nil), &nopResponseWriter{}) |
| 89 | + b.ReportAllocs() |
| 90 | + b.ResetTimer() |
| 91 | + for i := 0; i < b.N; i++ { |
| 92 | + if err := s.Serialize(c, in, ""); err != nil { |
| 93 | + b.Fatal(err) |
| 94 | + } |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +func benchDeserialize(b *testing.B, s echo.JSONSerializer) { |
| 99 | + e := echo.New() |
| 100 | + data, _ := func() ([]byte, error) { |
| 101 | + rec := httptest.NewRecorder() |
| 102 | + c := e.NewContext(httptest.NewRequest(http.MethodGet, "/", nil), rec) |
| 103 | + err := New().Serialize(c, sample(), "") |
| 104 | + return rec.Body.Bytes(), err |
| 105 | + }() |
| 106 | + req := httptest.NewRequest(http.MethodPost, "/", nil) |
| 107 | + c := e.NewContext(req, &nopResponseWriter{}) |
| 108 | + b.ReportAllocs() |
| 109 | + b.ResetTimer() |
| 110 | + for i := 0; i < b.N; i++ { |
| 111 | + req.Body = io.NopCloser(bytes.NewReader(data)) |
| 112 | + var out payload |
| 113 | + if err := s.Deserialize(c, &out); err != nil { |
| 114 | + b.Fatal(err) |
| 115 | + } |
| 116 | + } |
| 117 | +} |
| 118 | + |
| 119 | +func BenchmarkSerialize_Default(b *testing.B) { benchSerialize(b, echo.DefaultJSONSerializer{}) } |
| 120 | +func BenchmarkSerialize_Sonic(b *testing.B) { benchSerialize(b, New()) } |
| 121 | +func BenchmarkDeserialize_Default(b *testing.B) { benchDeserialize(b, echo.DefaultJSONSerializer{}) } |
| 122 | +func BenchmarkDeserialize_Sonic(b *testing.B) { benchDeserialize(b, New()) } |
0 commit comments