]> Cypherpunks repositories - gostls13.git/commitdiff
net/http, doc/go1.13.html: revert TimeoutHandler.Flush
authorEmmanuel T Odeke <emmanuel@orijtech.com>
Thu, 26 Sep 2019 20:17:49 +0000 (13:17 -0700)
committerEmmanuel Odeke <emm.odeke@gmail.com>
Thu, 26 Sep 2019 21:12:34 +0000 (21:12 +0000)
Also added a test to ensure that any interactions
between TimeoutHandler and Flusher result in the
correct status code and body, but also that we don't
get superfluous logs from stray writes as was seen
in the bug report.

Fixes #34439.

Change-Id: I4af62db256742326f9353f98a2fcb5f71d2a5fd9
Reviewed-on: https://go-review.googlesource.com/c/go/+/197659
Run-TryBot: Emmanuel Odeke <emm.odeke@gmail.com>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>

doc/go1.13.html
src/net/http/serve_test.go
src/net/http/server.go

index 3baf16c0af3c5be24ac14b8c79ca683dc7d6547b..a17337f6662c25ae3f51b0bb61da573641b63030 100644 (file)
@@ -821,7 +821,7 @@ godoc
     <p><!-- CL 154383 -->
       <a href="/pkg/net/http/#TimeoutHandler"><code>TimeoutHandler</code></a>'s
       <a href="/pkg/net/http/#ResponseWriter"><code>ResponseWriter</code></a> now implements the
-      <a href="/pkg/net/http/#Pusher"><code>Pusher</code></a> and <a href="/pkg/net/http/#Flusher"><code>Flusher</code></a> interfaces.
+      <a href="/pkg/net/http/#Pusher"><code>Pusher</code></a> interface.
     </p>
 
     <p><!-- CL 157339 -->
index 1d1449aa659ef417db74d94a17b1d9c5f13a61b9..e86cc9bdd21037c246b3c102a079aa66c9eda5b2 100644 (file)
@@ -6161,6 +6161,54 @@ func TestUnsupportedTransferEncodingsReturn501(t *testing.T) {
        }
 }
 
+// Issue 34439: ensure that TimeoutHandler doesn't implement Flusher
+// and that any interaction with Flusher won't affect TimeoutHandler's behavior.
+func TestTimeoutHandlerAndFlusher(t *testing.T) {
+       timeout := 50 * time.Millisecond
+
+       handler := HandlerFunc(func(w ResponseWriter, r *Request) {
+               w.WriteHeader(StatusTeapot)
+               w.Write([]byte("line1\n"))
+               fl, ok := w.(Flusher)
+               if ok {
+                       fl.Flush()
+               }
+               time.Sleep(timeout * 2)
+               w.Write([]byte("line2\n"))
+       })
+
+       cst := httptest.NewUnstartedServer(TimeoutHandler(handler, timeout, "TIMED OUT\n"))
+       // Provide a logger that will report an error on any superfluous log.
+       cst.Config.ErrorLog = log.New(&errorOnWrite{t: t}, "", 0)
+       cst.Start()
+       defer cst.Close()
+
+       res, err := cst.Client().Get(cst.URL)
+       if err != nil {
+               t.Fatal(err)
+       }
+       defer res.Body.Close()
+
+       if g, w := res.StatusCode, StatusServiceUnavailable; g != w {
+               t.Errorf("Status code mismatch\ngot:  %d\nwant: %d", g, w)
+       }
+
+       slurp, _ := ioutil.ReadAll(res.Body)
+       if g, w := string(slurp), "TIMED OUT\n"; g != w {
+               t.Fatalf("Body mismatch\ngot:  %q\nwant: %q", g, w)
+       }
+}
+
+// errorOnWrite will invoke t.Error on any attempted write.
+type errorOnWrite struct {
+       t *testing.T
+}
+
+func (ew *errorOnWrite) Write(b []byte) (int, error) {
+       ew.t.Errorf("Unexpected write: %s\n", b)
+       return len(b), nil
+}
+
 // fetchWireResponse is a helper for dialing to host,
 // sending http1ReqBody as the payload and retrieving
 // the response as it was sent on the wire.
index feff20045a0216c47f32996d7bd5f200d12e13f7..9fd86ed7cd28d262cb49e333f3830f579fd2eea5 100644 (file)
@@ -3272,7 +3272,6 @@ type timeoutWriter struct {
 }
 
 var _ Pusher = (*timeoutWriter)(nil)
-var _ Flusher = (*timeoutWriter)(nil)
 
 // Push implements the Pusher interface.
 func (tw *timeoutWriter) Push(target string, opts *PushOptions) error {
@@ -3282,14 +3281,6 @@ func (tw *timeoutWriter) Push(target string, opts *PushOptions) error {
        return ErrNotSupported
 }
 
-// Flush implements the Flusher interface.
-func (tw *timeoutWriter) Flush() {
-       f, ok := tw.w.(Flusher)
-       if ok {
-               f.Flush()
-       }
-}
-
 func (tw *timeoutWriter) Header() Header { return tw.h }
 
 func (tw *timeoutWriter) Write(p []byte) (int, error) {