Skip to content

Commit

Permalink
Fixed all compiler warnings
Browse files Browse the repository at this point in the history
Most of them were about capitalized error messages...
  • Loading branch information
snej committed May 11, 2023
1 parent b36efc8 commit 011516c
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 26 deletions.
4 changes: 2 additions & 2 deletions codec.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ func (d *decompressor) passthrough(input []byte, checksum *uint32) ([]byte, erro
_, _ = d.checksum.Write(input) // Update checksum (no error possible)
if checksum != nil {
if curChecksum := d.getChecksum(); curChecksum != *checksum {
return nil, fmt.Errorf("Invalid checksum %x; should be %x", curChecksum, *checksum)
return nil, fmt.Errorf("invalid checksum %x; should be %x", curChecksum, *checksum)
}
}
return input, nil
Expand Down Expand Up @@ -168,7 +168,7 @@ func (d *decompressor) decompress(input []byte, checksum uint32) ([]byte, error)
return nil, err
} else if n == 0 {
// Nothing more to read; since checksum didn't match (above), fail:
return nil, fmt.Errorf("Invalid checksum %x; should be %x", d.getChecksum(), checksum)
return nil, fmt.Errorf("invalid checksum %x; should be %x", d.getChecksum(), checksum)
}
_, _ = d.checksum.Write(d.buffer[0:n]) // Update checksum (no error possible)

Expand Down
2 changes: 1 addition & 1 deletion codec_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func init() {
randomData = make([]byte, 65536)
var b byte
var step byte = 1
for i, _ := range randomData {
for i := range randomData {
if rando.Intn(10) == 0 {
b = byte(rando.Intn(256))
step = byte(rando.Intn(4))
Expand Down
6 changes: 3 additions & 3 deletions context.go
Original file line number Diff line number Diff line change
Expand Up @@ -222,9 +222,9 @@ func (bwss *blipWebsocketServer) handshake(w http.ResponseWriter, r *http.Reques
protocolHeader := r.Header.Get("Sec-WebSocket-Protocol")
protocol, found := includesProtocol(protocolHeader, bwss.blipCtx.SupportedSubProtocols)
if !found {
stringSeperatedProtocols := strings.Join(bwss.blipCtx.SupportedSubProtocols, ",")
bwss.blipCtx.log("Error: Client doesn't support any of WS protocols: %s only %s", stringSeperatedProtocols, protocolHeader)
return nil, fmt.Errorf("I only speak %s protocols", stringSeperatedProtocols)
stringSeparatedProtocols := strings.Join(bwss.blipCtx.SupportedSubProtocols, ",")
bwss.blipCtx.log("Error: Client doesn't support any of WS protocols: %s only %s", stringSeparatedProtocols, protocolHeader)
return nil, fmt.Errorf("I only speak %s protocols", stringSeparatedProtocols)
}

ws, err := websocket.Accept(w, r, &websocket.AcceptOptions{
Expand Down
10 changes: 3 additions & 7 deletions message.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"strconv"
"sync"
)
Expand Down Expand Up @@ -153,8 +152,8 @@ func (message *Message) Complete() bool {
}

// Writes the encoded form of a Message to a stream.
func (message *Message) WriteTo(writer io.Writer) error {
if err := message.Properties.WriteTo(writer); err != nil {
func (message *Message) WriteEncodedTo(writer io.Writer) error {
if err := message.Properties.WriteEncodedTo(writer); err != nil {
return err
}
var err error
Expand Down Expand Up @@ -236,7 +235,7 @@ func (m *Message) Body() ([]byte, error) {
m.bodyMutex.Lock()
defer m.bodyMutex.Unlock()
if m.body == nil && !m.Outgoing {
body, err := ioutil.ReadAll(m.bodyReader)
body, err := io.ReadAll(m.bodyReader)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -569,9 +568,6 @@ func (m *msgReceiver) cancelIncoming() {
func (message *Message) assertMutable() {
precondition(message.Outgoing && !message.inProgress, "Message %s is not modifiable", message)
}
func (message *Message) assertIncoming() {
precondition(!message.Outgoing, "Message %s is not incoming", message)
}
func (message *Message) assertOutgoing() {
precondition(message.Outgoing, "Message %s is not outgoing", message)
}
Expand Down
4 changes: 2 additions & 2 deletions properties.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ func ReadProperties(body []byte) (properties Properties, bytesRead int, err erro
}

// Writes Properties to a stream.
func (properties Properties) WriteTo(writer io.Writer) error {
func (properties Properties) WriteEncodedTo(writer io.Writer) error {
// First convert the property strings into byte arrays, and add up their sizes:
var strings propertyList = make(propertyList, 2*len(properties))
i := 0
Expand Down Expand Up @@ -111,7 +111,7 @@ func (properties Properties) WriteTo(writer io.Writer) error {
// Writes Properties to a byte array.
func (properties Properties) Encode() []byte {
var out bytes.Buffer
_ = properties.WriteTo(&out)
_ = properties.WriteEncodedTo(&out)
return out.Bytes()
}

Expand Down
4 changes: 2 additions & 2 deletions properties_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func init() {
func TestReadWriteProperties(t *testing.T) {
p := Properties{"Content-Type": "application/octet-stream", "Foo": "Bar"}
var writer bytes.Buffer
err := p.WriteTo(&writer)
err := p.WriteEncodedTo(&writer)
assert.Equal(t, nil, err)
writer.Write([]byte("FOOBAR"))
serialized := writer.Bytes()
Expand All @@ -47,7 +47,7 @@ func TestReadWriteProperties(t *testing.T) {
func TestReadWriteEmptyProperties(t *testing.T) {
var p Properties
var writer bytes.Buffer
err := p.WriteTo(&writer)
err := p.WriteEncodedTo(&writer)
assert.Equal(t, nil, err)
serialized := writer.Bytes()
assert.Equal(t, "\x00", string(serialized))
Expand Down
14 changes: 7 additions & 7 deletions receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ func (r *receiver) parseLoop() {
r.context.log("PANIC in BLIP parseLoop: %v\n%s", p, debug.Stack())
err, _ := p.(error)
if err == nil {
err = fmt.Errorf("Panic: %v", p)
err = fmt.Errorf("panic: %v", p)
}
r.fatalError(err)
}
Expand Down Expand Up @@ -157,7 +157,7 @@ func (r *receiver) closePendingResponses() {
func (r *receiver) handleIncomingFrame(frame []byte) error {
// Parse BLIP header:
if len(frame) < 2 {
return fmt.Errorf("Illegally short frame")
return fmt.Errorf("illegally short frame")
}
r.frameBuffer.Reset()
r.frameBuffer.Write(frame)
Expand Down Expand Up @@ -189,14 +189,14 @@ func (r *receiver) handleIncomingFrame(frame []byte) error {
bufferedFrame := r.frameBuffer.Bytes()
frameSize := len(bufferedFrame)
if len(frame) < checksumLength {
return fmt.Errorf("Illegally short frame")
return fmt.Errorf("illegally short frame")
}
checksumSlice := bufferedFrame[len(bufferedFrame)-checksumLength : len(bufferedFrame)]
checksumSlice := bufferedFrame[len(bufferedFrame)-checksumLength:]
checksum := binary.BigEndian.Uint32(checksumSlice)
r.frameBuffer.Truncate(r.frameBuffer.Len() - checksumLength)

if r.context.LogFrames {
r.context.logFrame("Received frame: %s (flags=%8b, length=%d)",
r.context.logFrame("received frame: %s (flags=%8b, length=%d)",
frameString(requestNumber, flags), flags, r.frameBuffer.Len())
}

Expand Down Expand Up @@ -280,7 +280,7 @@ func (r *receiver) getPendingRequest(requestNumber MessageNumber, flags frameFla
r.pendingRequests[requestNumber] = msgStream
}
} else {
return nil, fmt.Errorf("Bad incoming request number %d", requestNumber)
return nil, fmt.Errorf("bad incoming request number %d", requestNumber)
}
return msgStream, nil
}
Expand All @@ -301,7 +301,7 @@ func (r *receiver) getPendingResponse(requestNumber MessageNumber, flags frameFl
r.context.log("Warning: Unexpected response frame to my msg #%d", requestNumber) // benign
} else {
// processing a response frame with a message number higher than any requests I've sent
err = fmt.Errorf("Bogus message number %d in response. Expected to be less than max pending response number (%d)", requestNumber, r.maxPendingResponseNumber)
err = fmt.Errorf("bogus message number %d in response. Expected to be less than max pending response number (%d)", requestNumber, r.maxPendingResponseNumber)
}
return
}
Expand Down
4 changes: 2 additions & 2 deletions util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,14 @@ func WaitWithTimeout(wg *sync.WaitGroup, timeout time.Duration) error {
case <-wgFinished:
return nil
case <-time.After(timeout):
return fmt.Errorf("Timed out waiting after %v", timeout)
return fmt.Errorf("timed out waiting after %v", timeout)
}
}

// Returns the serialized form (properties + body) of a Message.
func serializeMessage(t *testing.T, m *Message) []byte {
var writer bytes.Buffer
err := m.WriteTo(&writer)
err := m.WriteEncodedTo(&writer)
assert.NoError(t, err)
return writer.Bytes()
}
Expand Down

0 comments on commit 011516c

Please sign in to comment.