Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(examples): add one example to log request body when the status code is non 200 #4108

Merged
merged 4 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion examples/internal/gateway/handlers.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package gateway

import (
"bytes"
"fmt"
"io"
"net/http"
"path"
"strings"
Expand All @@ -27,7 +29,7 @@ func openAPIServer(dir string) http.HandlerFunc {
}
}

// allowCORS allows Cross Origin Resoruce Sharing from any origin.
// allowCORS allows Cross Origin Resource Sharing from any origin.
// Don't do this without consideration in production systems.
func allowCORS(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Expand Down Expand Up @@ -64,3 +66,39 @@ func healthzServer(conn *grpc.ClientConn) http.HandlerFunc {
fmt.Fprintln(w, "ok")
}
}

type logResponseWriter struct {
http.ResponseWriter
statusCode int
}

func (rsp *logResponseWriter) WriteHeader(code int) {
rsp.statusCode = code
rsp.ResponseWriter.WriteHeader(code)
}

func newLogResponseWriter(w http.ResponseWriter) *logResponseWriter {
return &logResponseWriter{w, http.StatusOK}
}

// logRequestBody logs the request body when the response status code is not 200.
// This addresses the issue of being unable to retrieve the request body in the customErrorHandler middleware.
func logRequestBody(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
lw := newLogResponseWriter(w)
body, err := io.ReadAll(r.Body)
if err != nil {
http.Error(w, fmt.Sprintf("grpc server read request body err %+v", err), http.StatusBadRequest)
return
}
clonedR := r.Clone(r.Context())
r.Body = io.NopCloser(bytes.NewReader(body))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this necessary? I don't think the request body should be used after the handler returns.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this necessary? I don't think the request body should be used after the handler returns.

Yes, you are right. This line is removed in the new commit. Sorry for the typo.

clonedR.Body = io.NopCloser(bytes.NewReader(body))

h.ServeHTTP(lw, clonedR)

if lw.statusCode != http.StatusOK {
grpclog.Errorf("http error %+v request body %+v", lw.statusCode, string(body))
}
})
}
2 changes: 1 addition & 1 deletion examples/internal/gateway/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func Run(ctx context.Context, opts Options) error {

s := &http.Server{
Addr: opts.Addr,
Handler: allowCORS(mux),
Handler: logRequestBody(allowCORS(mux)),
}
go func() {
<-ctx.Done()
Expand Down
Loading