[go] net/http: add MaxBytesError
Gerrit Bot (Gerrit)
Gerrit Bot has uploaded this change for review.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: fea999aefc925a71446214907bcf54641889f3c0
GitHub-Pull-Request: golang/go#49359
---
M src/net/http/request.go
M src/net/http/serve_test.go
2 files changed, 34 insertions(+), 3 deletions(-)
diff --git a/src/net/http/request.go b/src/net/http/request.go
index 76c2317..9ef3275 100644
--- a/src/net/http/request.go
+++ b/src/net/http/request.go
@@ -1119,7 +1119,7 @@
// MaxBytesReader is similar to io.LimitReader but is intended for
// limiting the size of incoming request bodies. In contrast to
// io.LimitReader, MaxBytesReader's result is a ReadCloser, returns a
-// non-EOF error for a Read beyond the limit, and closes the
+// MaxBytesError for a Read beyond the limit, and closes the
// underlying reader when its Close method is called.
//
// MaxBytesReader prevents clients from accidentally or maliciously
@@ -1128,12 +1128,23 @@
if n < 0 { // Treat negative limits as equivalent to 0.
n = 0
}
- return &maxBytesReader{w: w, r: r, n: n}
+ return &maxBytesReader{w: w, r: r, i: n, n: n}
+}
+
+// MaxBytesError is returned by MaxBytesReader when its read limit is exceeded.
+type MaxBytesError struct {
+ Limit int64
+}
+
+func (e MaxBytesError) Error() string {
+ // Due to Hyrum's law, this text cannot be changed.
+ return "http: request body too large"
}
type maxBytesReader struct {
w ResponseWriter
r io.ReadCloser // underlying reader
+ i int64 // max bytes initially, for MaxBytesError
n int64 // max bytes remaining
err error // sticky error
}
@@ -1175,7 +1186,7 @@
if res, ok := l.w.(requestTooLarger); ok {
res.requestTooLarge()
}
- l.err = errors.New("http: request body too large")
+ l.err = MaxBytesError{l.i}
return n, l.err
}
diff --git a/src/net/http/serve_test.go b/src/net/http/serve_test.go
index a98d6c3..3dab1b2 100644
--- a/src/net/http/serve_test.go
+++ b/src/net/http/serve_test.go
@@ -2978,6 +2978,13 @@
if n != limit {
t.Errorf("io.Copy = %d, want %d", n, limit)
}
+ mb, ok := err.(MaxBytesError)
+ if !ok {
+ t.Errorf("expected MaxBytesError, got %T", err)
+ }
+ if mb.Limit != limit {
+ t.Errorf("MaxBytesError.Limit = %d, want %d", mb.Limit, limit)
+ }
}))
defer cst.close()
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Carl Johnson (Gerrit)
Attention is currently required from: Damien Neil.
1 comment:
File src/net/http/request.go:
Patch Set #1, Line 1139:
func (e MaxBytesError) Error() string {Minor implementation question: Should this be a pointer?
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Damien Neil (Gerrit)
Attention is currently required from: Carl Johnson.
1 comment:
File src/net/http/request.go:
Patch Set #1, Line 1139:
func (e MaxBytesError) Error() string {Minor implementation question: Should this be a pointer?
Yes, for general consistency.
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Gerrit Bot (Gerrit)
Attention is currently required from: Carl Johnson.
Gerrit Bot uploaded patch set #2 to this change.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: 218d9ca608f44fa745a6f4209aa24fe7437b6437
GitHub-Pull-Request: golang/go#49359
---
M src/net/http/request.go
M src/net/http/serve_test.go
2 files changed, 34 insertions(+), 3 deletions(-)
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Carl Johnson (Gerrit)
Attention is currently required from: Damien Neil.
1 comment:
File src/net/http/request.go:
Patch Set #1, Line 1139:
func (e MaxBytesError) Error() string {
Yes, for general consistency.
Done
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Damien Neil (Gerrit)
Patch set 2:Run-TryBot +1Trust +1
Damien Neil (Gerrit)
1 comment:
File src/net/http/serve_test.go:
Patch Set #2, Line 2981:
mb, ok := err.(MaxBytesError)needs to be (*MaxBytesError) now
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Gerrit Bot (Gerrit)
Gerrit Bot uploaded patch set #3 to this change.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: fa2db73445e941bcf89e6f75bc0508d82d036738
GitHub-Pull-Request: golang/go#49359
---
M src/net/http/request.go
M src/net/http/serve_test.go
2 files changed, 34 insertions(+), 3 deletions(-)
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Carl Johnson (Gerrit)
Attention is currently required from: Damien Neil.
1 comment:
File src/net/http/serve_test.go:
Patch Set #2, Line 2981:
mb, ok := err.(MaxBytesError)needs to be (*MaxBytesError) now
Done
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Damien Neil (Gerrit)
Patch set 3:Run-TryBot +1Trust +1
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Damien Neil (Gerrit)
Patch set 3:Code-Review +2
Ian Lance Taylor (Gerrit)
Patch set 3:Trust +1
Gerrit Bot (Gerrit)
Gerrit Bot uploaded patch set #4 to this change.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: cd6ff5d35ac2f42ca24a1de01d7f303532b05287
GitHub-Pull-Request: golang/go#49359
---
A api/next/30715.txt
M src/net/http/request.go
M src/net/http/serve_test.go
3 files changed, 37 insertions(+), 3 deletions(-)
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Gerrit Bot (Gerrit)
Gerrit Bot uploaded patch set #5 to this change.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: 6ae68402a5a7c57f7f18e945d48c69ba2b134078
GitHub-Pull-Request: golang/go#49359
---
A api/next/30715.txt
M src/net/http/request.go
M src/net/http/serve_test.go
3 files changed, 40 insertions(+), 4 deletions(-)
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Carl Johnson (Gerrit)
1 comment:
Patchset:
TryBots are happy. Can this get a review and merged before the quiet week and code freeze?
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.
Ian Lance Taylor (Gerrit)
Patch set 5:Run-TryBot +1Auto-Submit +1Code-Review +1
Damien Neil (Gerrit)
Patch set 5:Code-Review +2
Gopher Robot (Gerrit)
Gopher Robot submitted this change.
net/http: add MaxBytesError
Fixes #30715
Change-Id: Ia3712d248b6dc86abef71ccea6e705a571933d53
GitHub-Last-Rev: 6ae68402a5a7c57f7f18e945d48c69ba2b134078
GitHub-Pull-Request: golang/go#49359
Reviewed-on: https://go-review.googlesource.com/c/go/+/361397
Reviewed-by: Ian Lance Taylor <ia...@google.com>
Run-TryBot: Ian Lance Taylor <ia...@google.com>
Auto-Submit: Ian Lance Taylor <ia...@google.com>
Reviewed-by: Damien Neil <dn...@google.com>
TryBot-Result: Gopher Robot <go...@golang.org>
---
A api/next/30715.txt
M src/net/http/request.go
M src/net/http/serve_test.go
3 files changed, 46 insertions(+), 4 deletions(-)
diff --git a/api/next/30715.txt b/api/next/30715.txt
new file mode 100644
index 0000000..077a8d1
--- /dev/null
+++ b/api/next/30715.txt
@@ -0,0 +1,3 @@
+pkg net/http, type MaxBytesError struct #30715
+pkg net/http, type MaxBytesError struct, Limit int64 #30715
+pkg net/http, method (*MaxBytesError) Error() string #30715
diff --git a/src/net/http/request.go b/src/net/http/request.go
index 3122119..d091f3c 100644
--- a/src/net/http/request.go
+++ b/src/net/http/request.go
@@ -1126,21 +1126,34 @@
// MaxBytesReader is similar to io.LimitReader but is intended for
// limiting the size of incoming request bodies. In contrast to
// io.LimitReader, MaxBytesReader's result is a ReadCloser, returns a
-// non-EOF error for a Read beyond the limit, and closes the
+// MaxBytesError for a Read beyond the limit, and closes the
// underlying reader when its Close method is called.
//
// MaxBytesReader prevents clients from accidentally or maliciously
-// sending a large request and wasting server resources.
+// sending a large request and wasting server resources. If possible,
+// it tells the ResponseWriter to close the connection after the limit
+// has been reached.
func MaxBytesReader(w ResponseWriter, r io.ReadCloser, n int64) io.ReadCloser {
if n < 0 { // Treat negative limits as equivalent to 0.
n = 0
}
- return &maxBytesReader{w: w, r: r, n: n}
+ return &maxBytesReader{w: w, r: r, i: n, n: n}
+}
+
+// MaxBytesError is returned by MaxBytesReader when its read limit is exceeded.
+type MaxBytesError struct {
+ Limit int64
+}
+
+func (e *MaxBytesError) Error() string {
+ // Due to Hyrum's law, this text cannot be changed.
+ return "http: request body too large"
}
type maxBytesReader struct {
w ResponseWriter
r io.ReadCloser // underlying reader
+ i int64 // max bytes initially, for MaxBytesError
n int64 // max bytes remaining
err error // sticky error
}
@@ -1182,7 +1195,7 @@
if res, ok := l.w.(requestTooLarger); ok {
res.requestTooLarge()
}
- l.err = errors.New("http: request body too large")
+ l.err = &MaxBytesError{l.i}
return n, l.err
}
diff --git a/src/net/http/serve_test.go b/src/net/http/serve_test.go
index 1c85a66..404cca0 100644
--- a/src/net/http/serve_test.go
+++ b/src/net/http/serve_test.go
@@ -3035,6 +3035,13 @@
if n != limit {
t.Errorf("io.Copy = %d, want %d", n, limit)
}
+ mbErr, ok := err.(*MaxBytesError)
+ if !ok {
+ t.Errorf("expected MaxBytesError, got %T", err)
+ }
+ if mbErr.Limit != limit {
+ t.Errorf("MaxBytesError.Limit = %d, want %d", mbErr.Limit, limit)
+ }
}))
defer cst.close()
To view, visit change 361397. To unsubscribe, or for help writing mail filters, visit settings.