From 8e8a8079c56461179c2a83f7f6105553cf0e03f6 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Wed, 7 Feb 2024 08:21:43 -0600 Subject: [PATCH 1/5] =?UTF-8?q?=F0=9F=A7=AA=20Add=20integration=20test?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- int_test.go | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 int_test.go diff --git a/int_test.go b/int_test.go new file mode 100644 index 0000000..05218e6 --- /dev/null +++ b/int_test.go @@ -0,0 +1,47 @@ +package handler + +import ( + "net/http" + "net/http/httptest" + "testing" + + errors "codeberg.org/danjones000/responsable-errors" + "github.com/gin-gonic/gin" + "github.com/stretchr/testify/assert" +) + +func TestErrorMiddleware(t *testing.T) { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + _, r := gin.CreateTestContext(w) + r.Use(ErrorMiddleware()) + r.Use(HandlerWithErrorWrapper(func(c *gin.Context) error { + return errors.Errorf(400, "Oops") + })) + r.GET("/", func(c *gin.Context) { + c.JSON(200, gin.H{"Hello": "World"}) + }) + req, _ := http.NewRequest("GET", "/", nil) + r.ServeHTTP(w, req) + + assert.Equal(t, 400, w.Code) + assert.Equal(t, `{"error":"Oops"}`, w.Body.String()) +} + +func TestErrorNoResponseIfAlreadyWritten(t *testing.T) { + gin.SetMode(gin.TestMode) + w := httptest.NewRecorder() + _, r := gin.CreateTestContext(w) + r.Use(ErrorMiddleware()) + + r.GET("/", HandlerWithErrorWrapper(func(c *gin.Context) error { + c.JSON(200, gin.H{"Hello": "World"}) + return errors.Errorf(400, "Oops") + })) + req, _ := http.NewRequest("GET", "/", nil) + r.ServeHTTP(w, req) + + assert.Equal(t, 200, w.Code) + assert.Equal(t, `{"Hello":"World"}`, w.Body.String()) + +} From 644fbe5fa5e828564b615aacddbf3507a6504f70 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Wed, 7 Feb 2024 08:41:54 -0600 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=90=9B=20Abort=20after=20error?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes https://codeberg.org/danjones000/gin-error-handler/issues/1 --- handler.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/handler.go b/handler.go index f7da46f..151e139 100644 --- a/handler.go +++ b/handler.go @@ -25,6 +25,8 @@ func HandlerWithErrorWrapper(h HandlerWithError) gin.HandlerFunc { return func(c *gin.Context) { err := h(c) if err != nil { + // We shouldn't process more handlers if there was an error + c.Abort() c.Error(err) } } From 119d73aae194f50ea47110831dde76b97695a9c3 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Wed, 7 Feb 2024 08:49:09 -0600 Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=90=9B=20Only=20send=20response=20if?= =?UTF-8?q?=20not=20already=20sent?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- middleware.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/middleware.go b/middleware.go index ece360b..0eee5ed 100644 --- a/middleware.go +++ b/middleware.go @@ -55,7 +55,8 @@ func ErrorMiddleware(opts ...Option) gin.HandlerFunc { c.Set("rendered_error", re) - // @todo check a response hasn't already been sent - c.JSON(re.Status(), re) + if !c.Writer.Written() { + c.JSON(re.Status(), re) + } } } From 7edba56f11878d3426732ec7cb0c281bf3c50f7c Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Wed, 7 Feb 2024 09:15:04 -0600 Subject: [PATCH 4/5] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Upgrade=20responsable-?= =?UTF-8?q?errors?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- go.mod | 2 +- go.sum | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/go.mod b/go.mod index f76f4cf..fab6112 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module codeberg.org/danjones000/gin-error-handler go 1.21.5 require ( - codeberg.org/danjones000/responsable-errors v0.2.0 + codeberg.org/danjones000/responsable-errors v0.2.1 github.com/gin-gonic/gin v1.9.1 github.com/stretchr/testify v1.8.4 ) diff --git a/go.sum b/go.sum index c9768c3..112bc9f 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,5 @@ -codeberg.org/danjones000/responsable-errors v0.1.1 h1:WTWo0egPNsp+kEKRK8R+yc/bfdEDUbwEjMnqgA7IklA= -codeberg.org/danjones000/responsable-errors v0.1.1/go.mod h1:susEj39A/bflyej4tRirtuVKkmfUdhR2Skljwd/1ndI= -codeberg.org/danjones000/responsable-errors v0.2.0 h1:WUTBSaKQzkXHDYraHt3mxB4QHqVk78sKR/VeteXM1OY= -codeberg.org/danjones000/responsable-errors v0.2.0/go.mod h1:susEj39A/bflyej4tRirtuVKkmfUdhR2Skljwd/1ndI= +codeberg.org/danjones000/responsable-errors v0.2.1 h1:Ur6t+QZWaAfBgjQWBqSCgS3sTySdkKQD/FQefeRrm90= +codeberg.org/danjones000/responsable-errors v0.2.1/go.mod h1:susEj39A/bflyej4tRirtuVKkmfUdhR2Skljwd/1ndI= github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM= github.com/bytedance/sonic v1.9.1 h1:6iJ6NqdoxCDr6mbY8h18oSO+cShGSMRGCEo7F2h0x8s= github.com/bytedance/sonic v1.9.1/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U= From c42d835d97da98de3e6b97584ecb4783b31cf2e8 Mon Sep 17 00:00:00 2001 From: Dan Jones Date: Wed, 7 Feb 2024 09:18:44 -0600 Subject: [PATCH 5/5] =?UTF-8?q?=F0=9F=93=9D=20Update=20CHANGELOG?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ed50a14..bd994b1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [0.2.0] - 2024-02-07 + +### Fixed + +- [Using HandlerWithError as Middleware allows response to be sent](https://codeberg.org/danjones000/gin-error-handler/issues/1) +- Error response still sent if other response is already sent, resulting in duplicate body + ## [0.1.0] - 2024-01-22 🎉 Initial release