coder / coder/websocket

Must not wrap io.EOF

オープン 初心者向け
#561 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
Go
スター
5.5k
フォーク
372
PR マージ指標
30日以内にマージされた PR はありません

説明

From the Go docs:

```go
// EOF is the error returned by Read when no more input is available.
// (Read must return EOF itself, not an error wrapping EOF,
// because callers will test for EOF using ==.)
// Functions should return EOF only to signal a graceful end of input.
// If the EOF occurs unexpectedly in a structured data stream,
// the appropriate error is either [ErrUnexpectedEOF] or some other error
// giving more detail.
var EOF = errors.New("EOF")
```

however, `Conn.reader` (and probably others) wrap io.EOF:

```go
func (c *Conn) reader(ctx context.Context) (_ MessageType, _ io.Reader, err error) {
defer errd.Wrap(&err, "failed to get reader")

// Wrap wraps err with fmt.Errorf if err is non nil.
// Intended for use with defer and a named error return.
// Inspired by https://github.com/golang/go/issues/32676.
func Wrap(err *error, f string, v ...any) {
if *err != nil {
*err = fmt.Errorf(f+": %w", append(v, *err)...)
}
}
```

This leads to errors such as https://github.com/hashicorp/yamux/pull/167.

I'd propose special-casing `Wrap` to check for `io.EOF` and would be happy to open a PR.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

errd.Wrap と Conn.reader での使用箇所から始め、その後、issue で引用されている Go io.EOF のドキュメントを確認してください。EOF をラップしたケースを再現し、プロジェクトに既存のテストを確認します。EOF を引き続き直接比較でき、他のエラーがコンテキストを保持していれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
go
領域
networking
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
72/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。