Skip to content

refactor: add ErrMessageTooBig sentinel error for limited reads #535

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 5, 2025
Merged

refactor: add ErrMessageTooBig sentinel error for limited reads #535

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e96e02a
refactor: replace fmt.Errorf with MessageTooBigError
DanielleMaywood Aug 15, 2025
c44f12f
refactor: replace MessageTooBigError with ErrMessageTooBig
DanielleMaywood Aug 15, 2025
bc07607
add backwards compatibility and test
mafredri Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion read.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ import (
"github.com/coder/websocket/internal/util"
)

type MessageTooBigError struct {
Limit int64
}

func (e MessageTooBigError) Error() string {
return fmt.Sprintf("read limited at %v bytes", e.Limit)
}

// Reader reads from the connection until there is a WebSocket
// data message to be read. It will handle ping, pong and close frames as appropriate.
//
Expand Down Expand Up @@ -520,7 +528,7 @@ func (lr *limitReader) Read(p []byte) (int, error) {
}

if lr.n == 0 {
err := fmt.Errorf("read limited at %v bytes", lr.limit.Load())
err := MessageTooBigError{Limit: lr.limit.Load()}
lr.c.writeError(StatusMessageTooBig, err)
return 0, err
}
Expand Down