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

[Question] Shall we follow the behavior of the document of http.ResponseWriter? #3191

Closed
kvii opened this issue Feb 4, 2024 · 1 comment
Closed
Labels
question Further information is requested

Comments

@kvii
Copy link
Contributor

kvii commented Feb 4, 2024

I think it's necessary to follow the behavior of the document of http.ResponseWriter. It's hard to explain "why". But you can see this repo.

@kvii kvii added the question Further information is requested label Feb 4, 2024
Copy link

dosubot bot commented Feb 4, 2024

🤖

Hey @kvii! Great to see you diving into the depths again. 🐙

Based on the context provided, it seems that the Kratos codebase does indeed follow the behavior of the http.ResponseWriter as documented in the Go standard library. This is evident in several places in the codebase, such as the h function, the handleFuncWrapper struct, and the BenchmarkServer function, where http.ResponseWriter is used to encode the response into JSON format, serve HTTP, and write the HTTP status code, respectively.

Here are the relevant code snippets:

var h = func(w http.ResponseWriter, r *http.Request) {
	_ = json.NewEncoder(w).Encode(testData{Path: r.RequestURI})
}
type handleFuncWrapper struct {
	fn http.HandlerFunc
}

func (x *handleFuncWrapper) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
	x.fn.ServeHTTP(writer, request)
}
fn := func(w http.ResponseWriter, r *http.Request) {
	data := &testData{Path: r.RequestURI}
	_ = json.NewEncoder(w).Encode(data)
	if r.Context().Value(testKey{}) != "test" {
		w.WriteHeader(500)
	}
}

These examples show that the Kratos codebase uses the http.ResponseWriter to write the HTTP response, which is consistent with the behavior of the http.ResponseWriter as documented in the Go standard library.

As for the specific behavior of http.ResponseWriter as documented in the Go standard library, it is an interface that has methods for responding to an HTTP request. It is used to send data in response to an HTTP request. The specific behavior of http.ResponseWriter in the provided context is used in the ServeHTTP method of the Server struct.

// ServeHTTP should write reply headers and data to the ResponseWriter and then return.
func (s *Server) ServeHTTP(res http.ResponseWriter, req *http.Request) {
	s.Handler.ServeHTTP(res, req)
}

In this method, the http.ResponseWriter (res) is passed along with the http.Request (req) to the Handler's ServeHTTP method. This means that the response to the HTTP request will be written by the Handler's ServeHTTP method.

However, the specific behavior of http.ResponseWriter is not detailed in the provided context. For a complete understanding of its behavior, you would need to refer to the Go standard library documentation. According to the Go standard library, http.ResponseWriter has the following methods:

  • Header() Header: This returns the header map that will be sent by WriteHeader.
  • Write([]byte) (int, error): This writes the data to the connection as part of an HTTP reply.
  • WriteHeader(statusCode int): This sends an HTTP response header with the provided status code.

Reference: Go standard library documentation

I hope this answers your question. If you need further clarification, please let me know.

Sources


This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@kvii kvii closed this as not planned Won't fix, can't repro, duplicate, stale Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant