-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Increased code robustness and consistency within the framework#2797
Open
suwakei wants to merge 1 commit intolabstack:masterfrom
Open
Increased code robustness and consistency within the framework#2797suwakei wants to merge 1 commit intolabstack:masterfrom
suwakei wants to merge 1 commit intolabstack:masterfrom
Conversation
Contributor
Proposal
1. Error handling when reading request body:
Currently, errors in io.ReadAll(c.Request().Body) are ignored. If the read fails, subsequent handlers may receive an incomplete body, causing unexpected behavior. I believe that the robustness of the middleware can be improved by interrupting processing when an error occurs and returning an error.
import (
"bufio"
"bytes"
+++ "fmt"
"errors"
"io"
"net"
// omission of sentence
// Request
reqBody := []byte{}
if c.Request().Body != nil { // Read
--- reqBody, _ = io.ReadAll(c.Request().Body)
+++ var errRead error
+++ reqBody, errRead = io.ReadAll(c.Request().Body)
+++ if errRead != nil {
+++ return errRead
+++ }
}
c.Request().Body = io.NopCloser(bytes.NewBuffer(reqBody)) // Reset
"bufio"
"bytes"
+++ "fmt"
"errors"
"io"
"net"
// omission of sentence
// Request
reqBody := []byte{}
if c.Request().Body != nil { // Read
--- reqBody, _ = io.ReadAll(c.Request().Body)
+++ var errRead error
+++ reqBody, errRead = io.ReadAll(c.Request().Body)
+++ if errRead != nil {
+++ return errRead
+++ }
}
c.Request().Body = io.NopCloser(bytes.NewBuffer(reqBody)) // Reset
2. Improvement of Flush panic messages:
Improve the messages when a panic occurs in the Flush method to be more detailed and consistent with the rest of the Echo framework (e.g., response.go). We believe this will make it clearer which ResponseWriters do not support the Flusher interface and make debugging easier.
import (
"bufio"
"bytes"
+++ "fmt"
"errors"
"io"
"net"
// omission of sentence
func (w *bodyDumpResponseWriter) Flush() {
err := http.NewResponseController(w.ResponseWriter).Flush()
if err != nil && errors.Is(err, http.ErrNotSupported) {
panic(errors.New("response writer flushing is not supported"))
panic(fmt.Errorf("echo: response writer %T does not support flushing (http.Flusher interface)", w.ResponseWriter))
}
}
"bufio"
"bytes"
+++ "fmt"
"errors"
"io"
"net"
// omission of sentence
func (w *bodyDumpResponseWriter) Flush() {
err := http.NewResponseController(w.ResponseWriter).Flush()
if err != nil && errors.Is(err, http.ErrNotSupported) {
panic(errors.New("response writer flushing is not supported"))
panic(fmt.Errorf("echo: response writer %T does not support flushing (http.Flusher interface)", w.ResponseWriter))
}
}
3. Modification of tests to accommodate the above changes
Contributor
Author
|
Hi maintainers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.