Open platform to collect and prioritize feedback
fix: omit cancelled request error logs (#951)
Guilherme Oenninge54f269efabc
diff --git a/app/middlewares/panic.go b/app/middlewares/panic.goindex 94678cb8e..250bcf382 100644--- a/app/middlewares/panic.go+++ b/app/middlewares/panic.go@@ -2,9 +2,7 @@ package middlewaresimport ("io"- "time"- "github.com/getfider/fider/app/models/dto""github.com/getfider/fider/app/pkg/errors""github.com/getfider/fider/app/pkg/log""github.com/getfider/fider/app/pkg/web"@@ -15,13 +13,9 @@ func CatchPanic() web.MiddlewareFunc {return func(c *web.Context) error {defer func() {if r := recover(); r != nil {- _ = c.Failure(errors.Panicked(r))+ err := c.Failure(errors.Panicked(r))+ log.Error(c, err)c.Rollback()- log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} panicked in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "HttpMethod": c.Request.Method,- "URL": c.Request.URL.String(),- "ElapsedMs": time.Since(c.Request.StartTime).Nanoseconds() / int64(time.Millisecond),- })if f, ok := c.Response.(io.Closer); ok {f.Close()diff --git a/app/middlewares/setup.go b/app/middlewares/setup.goindex ad90a6474..d7fb39560 100644--- a/app/middlewares/setup.go+++ b/app/middlewares/setup.go@@ -1,6 +1,7 @@package middlewaresimport (+ "context""time""github.com/getfider/fider/app/pkg/dbx"@@ -18,62 +19,61 @@ func WorkerSetup() worker.MiddlewareFunc {return func(next worker.Job) worker.Job {return func(c *worker.Context) (err error) {start := time.Now()- log.Debugf(c, "Task '@{TaskName:magenta}' started on worker '@{WorkerID:magenta}'", dto.Props{+ log.Infof(c, "Task '@{TaskName:magenta}' started on worker '@{WorkerID:magenta}'", dto.Props{"TaskName": c.TaskName(),"WorkerID": c.WorkerID(),})- trx, err := dbx.BeginTx(c)- if err != nil {- err = c.Failure(err)- log.Debugf(c, "Task '@{TaskName:magenta}' finished in @{ElapsedMs:magenta}ms", dto.Props{+ logFinish := func(state string, err error) {+ if err != nil {+ log.Error(c, err)+ }++ log.Infof(c, "Task '@{TaskName:magenta}' finished in @{ElapsedMs:magenta}ms (@{State})", dto.Props{+ "State": state,"TaskName": c.TaskName(),"ElapsedMs": time.Since(start).Nanoseconds() / int64(time.Millisecond),})+ }++ trx, err := dbx.BeginTx(c)+ if err != nil {+ err = c.Failure(err)+ logFinish("begin_error", err)return err}+ c.Set(app.TransactionCtxKey, trx)+//In case it panics somewheredefer func() {if r := recover(); r != nil {- _ = c.Failure(errors.Panicked(r))+ err := c.Failure(errors.Panicked(r))trx.MustRollback()- log.Debugf(c, "Task '@{TaskName:magenta}' panicked in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "TaskName": c.TaskName(),- "ElapsedMs": time.Since(start).Nanoseconds() / int64(time.Millisecond),- })+ logFinish("panicked", err)}}()- c.Set(app.TransactionCtxKey, trx)-//Execute the chainif err = next(c); err != nil {trx.MustRollback()- log.Debugf(c, "Task '@{TaskName:magenta}' finished in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "TaskName": c.TaskName(),- "ElapsedMs": time.Since(start).Nanoseconds() / int64(time.Millisecond),- })+ logFinish("next_error", err)return err}//No errors, so try to commit itif err = trx.Commit(); err != nil {- log.Errorf(c, "Failed to commit request with: @{Error}", dto.Props{- "Error": err.Error(),- })- log.Debugf(c, "Task '@{TaskName:magenta}' finished in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "TaskName": c.TaskName(),- "ElapsedMs": time.Since(start).Nanoseconds() / int64(time.Millisecond),- })+ if errors.Cause(err) == context.Canceled {+ logFinish("canceled", nil)+ return err+ }++ logFinish("commit_error", err)return err}//Still no errors, everything is fine!- log.Debugf(c, "Task '@{TaskName:magenta}' finished in @{ElapsedMs:magenta}ms (committed)", dto.Props{- "TaskName": c.TaskName(),- "ElapsedMs": time.Since(start).Nanoseconds() / int64(time.Millisecond),- })+ logFinish("committed", err)return nil}}@@ -89,53 +89,58 @@ func WebSetup() web.MiddlewareFunc {"ClientIP": c.Request.ClientIP,})- trx, err := dbx.BeginTx(c)- if err != nil {- err = c.Failure(err)- log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms", dto.Props{+ logFinish := func(state string, err error) {+ if err != nil {+ log.Error(c, err)+ }++ log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (@{State})", dto.Props{+ "State": state,"HttpMethod": c.Request.Method,"StatusCode": c.ResponseStatusCode,"URL": c.Request.URL.String(),"ElapsedMs": time.Since(c.Request.StartTime).Nanoseconds() / int64(time.Millisecond),})+ }++ trx, err := dbx.BeginTx(c)+ if err != nil {+ err = c.Failure(err)+ logFinish("begin_error", err)return err}c.Set(app.TransactionCtxKey, trx)+ //In case it panics somewhere+ defer func() {+ if r := recover(); r != nil {+ err := c.Failure(errors.Panicked(r))+ trx.MustRollback()+ logFinish("panicked", err)+ }+ }()+//Execute the chainif err := next(c); err != nil {c.Rollback()- log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "HttpMethod": c.Request.Method,- "StatusCode": c.ResponseStatusCode,- "URL": c.Request.URL.String(),- "ElapsedMs": time.Since(c.Request.StartTime).Nanoseconds() / int64(time.Millisecond),- })+ logFinish("next_error", err)return err}//No errors, so try to commit itif err := c.Commit(); err != nil {- log.Errorf(c, "Failed to commit request with: @{Error}", dto.Props{- "Error": err.Error(),- })- log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (rolled back)", dto.Props{- "HttpMethod": c.Request.Method,- "StatusCode": c.ResponseStatusCode,- "URL": c.Request.URL.String(),- "ElapsedMs": time.Since(c.Request.StartTime).Nanoseconds() / int64(time.Millisecond),- })+ if errors.Cause(err) == context.Canceled {+ logFinish("canceled", nil)+ return err+ }++ logFinish("commit_error", err)return err}//Still no errors, everything is fine!- log.Infof(c, "@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (committed)", dto.Props{- "HttpMethod": c.Request.Method,- "StatusCode": c.ResponseStatusCode,- "URL": c.Request.URL.String(),- "ElapsedMs": time.Since(c.Request.StartTime).Nanoseconds() / int64(time.Millisecond),- })+ logFinish("committed", err)return nil}}diff --git a/app/middlewares/setup_test.go b/app/middlewares/setup_test.goindex 97304b67b..ad79955fe 100644--- a/app/middlewares/setup_test.go+++ b/app/middlewares/setup_test.go@@ -9,7 +9,9 @@ import ("github.com/getfider/fider/app""github.com/getfider/fider/app/middlewares"+ "github.com/getfider/fider/app/models/cmd". "github.com/getfider/fider/app/pkg/assert"+ "github.com/getfider/fider/app/pkg/bus""github.com/getfider/fider/app/pkg/dbx""github.com/getfider/fider/app/pkg/mock""github.com/getfider/fider/app/pkg/web"@@ -43,6 +45,83 @@ func TestWebSetup_Failure(t *testing.T) {Expect(status).Equals(http.StatusInternalServerError)}+func TestWebSetup_Panic(t *testing.T) {+ RegisterT(t)++ server := mock.NewServer()+ server.Use(middlewares.WebSetup())+ status, _ := server.Execute(func(c *web.Context) error {+ panic("Boom!")+ })++ Expect(status).Equals(http.StatusInternalServerError)+}++func TestWorkerSetup_Logging_Success(t *testing.T) {+ RegisterT(t)++ var infoLogs []*cmd.LogInfo+ bus.AddListener(func(ctx context.Context, q *cmd.LogInfo) error {+ infoLogs = append(infoLogs, q)+ return nil+ })++ var errorLogs []*cmd.LogError+ bus.AddListener(func(ctx context.Context, q *cmd.LogError) error {+ errorLogs = append(errorLogs, q)+ return nil+ })++ server := mock.NewServer()+ server.Use(middlewares.WebSetup())+ status, _ := server.Execute(func(c *web.Context) error {+ return c.Ok(nil)+ })++ Expect(status).Equals(http.StatusOK)++ Expect(infoLogs).HasLen(2)+ Expect(infoLogs[0].Message).Equals("@{HttpMethod:magenta} @{URL:magenta} started for @{ClientIP:magenta}")+ Expect(infoLogs[1].Message).Equals("@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (@{State})")+ Expect(infoLogs[1].Props["StatusCode"]).Equals(200)+ Expect(infoLogs[1].Props["State"]).Equals("committed")++ Expect(errorLogs).HasLen(0)+}++func TestWorkerSetup_Logging_Error(t *testing.T) {+ RegisterT(t)++ var infoLogs []*cmd.LogInfo+ bus.AddListener(func(ctx context.Context, q *cmd.LogInfo) error {+ infoLogs = append(infoLogs, q)+ return nil+ })++ var errorLogs []*cmd.LogError+ bus.AddListener(func(ctx context.Context, q *cmd.LogError) error {+ errorLogs = append(errorLogs, q)+ return nil+ })++ server := mock.NewServer()+ server.Use(middlewares.WebSetup())+ status, _ := server.Execute(func(c *web.Context) error {+ return c.Failure(errors.New("Something went wrong..."))+ })++ Expect(status).Equals(http.StatusInternalServerError)++ Expect(infoLogs).HasLen(2)+ Expect(infoLogs[0].Message).Equals("@{HttpMethod:magenta} @{URL:magenta} started for @{ClientIP:magenta}")+ Expect(infoLogs[1].Message).Equals("@{HttpMethod:magenta} @{URL:magenta} finished with @{StatusCode:magenta} in @{ElapsedMs:magenta}ms (@{State})")+ Expect(infoLogs[1].Props["StatusCode"]).Equals(500)+ Expect(infoLogs[1].Props["State"]).Equals("next_error")++ Expect(errorLogs).HasLen(1)+ Expect(errorLogs[0].Err.Error()).ContainsSubstring("Something went wrong...")+}+func TestWebSetup_NotQueueTask_OnFailure(t *testing.T) {RegisterT(t)diff --git a/app/pkg/dbx/dbx.go b/app/pkg/dbx/dbx.goindex 765f58fbe..db8ecd183 100644--- a/app/pkg/dbx/dbx.go+++ b/app/pkg/dbx/dbx.go@@ -290,10 +290,15 @@ func (trx *Trx) MustCommit() {// Rollback current transactionfunc (trx *Trx) Rollback() error {+ if trx.tx == nil {+ return nil+ }+err := trx.tx.Rollback()if err != nil && err != sql.ErrTxDone {return wrap(err, "failed to rollback transaction")}+return nil}diff --git a/app/pkg/web/context.go b/app/pkg/web/context.goindex 7c2d5c3b8..4ac71c6eb 100644--- a/app/pkg/web/context.go+++ b/app/pkg/web/context.go@@ -243,12 +243,6 @@ func (c *Context) Failure(err error) error {return c.NotFound()}- log.Errorf(c, err.Error(), dto.Props{- "Body": c.Request.Body,- "HttpMethod": c.Request.Method,- "URL": c.Request.URL.String(),- })-if renderErr := c.Render(http.StatusInternalServerError, "500.html", Props{Title: "Shoot! Well, this is unexpected…",Description: "An error has occurred and we're working to fix the problem!",