-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Implement Unwrap() for responseWriterDelegator #1480
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
// Copyright 2024 The Prometheus Authors | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package promhttp | ||
|
||
import ( | ||
"net/http" | ||
"testing" | ||
"time" | ||
) | ||
|
||
type responseWriter struct { | ||
flushErrorCalled bool | ||
setWriteDeadlineCalled time.Time | ||
setReadDeadlineCalled time.Time | ||
} | ||
|
||
func (rw *responseWriter) Header() http.Header { | ||
return nil | ||
} | ||
|
||
func (rw *responseWriter) Write(p []byte) (int, error) { | ||
return 0, nil | ||
} | ||
|
||
func (rw *responseWriter) WriteHeader(statusCode int) { | ||
} | ||
|
||
func (rw *responseWriter) FlushError() error { | ||
rw.flushErrorCalled = true | ||
|
||
return nil | ||
} | ||
|
||
func (rw *responseWriter) SetWriteDeadline(deadline time.Time) error { | ||
rw.setWriteDeadlineCalled = deadline | ||
|
||
return nil | ||
} | ||
|
||
func (rw *responseWriter) SetReadDeadline(deadline time.Time) error { | ||
rw.setReadDeadlineCalled = deadline | ||
|
||
return nil | ||
} | ||
|
||
func TestResponseWriterDelegatorUnwrap(t *testing.T) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This test is a bit shallow it only tests single variable return 🙈 We could test if the HTTP lib will call Unwrap to get to those Flush methods properly. This would test our method from two sides:
What do you think? 🤔 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure, I've implemented a custom ResponseWriter and now it checks whether the methods were propagated correctly by http.ResponseController I've omitted a test for Flush method, because the library seems to try FlushError instead: https://cs.opensource.google/go/go/+/refs/tags/go1.21.4:src/net/http/responsecontroller.go;l=51, to actually return an error |
||
w := &responseWriter{} | ||
rwd := &responseWriterDelegator{ResponseWriter: w} | ||
|
||
if rwd.Unwrap() != w { | ||
t.Error("unwrapped responsewriter must equal to the original responsewriter") | ||
} | ||
|
||
controller := http.NewResponseController(rwd) | ||
if err := controller.Flush(); err != nil || !w.flushErrorCalled { | ||
t.Error("FlushError must be propagated to the original responsewriter") | ||
} | ||
|
||
timeNow := time.Now() | ||
if err := controller.SetWriteDeadline(timeNow); err != nil || w.setWriteDeadlineCalled != timeNow { | ||
t.Error("SetWriteDeadline must be propagated to the original responsewriter") | ||
} | ||
|
||
if err := controller.SetReadDeadline(timeNow); err != nil || w.setReadDeadlineCalled != timeNow { | ||
t.Error("SetReadDeadline must be propagated to the original responsewriter") | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mind adding quick comment on this public method similar to your PR description?