fix(io,tunnel): nil deref in RecorderObjectFromContext, CloseRead checked Writer, SetReadDeadline no unwrap
- entrypoint.go: guard ictx.RecorderObjectFromContext with nil checks on ClientID and Redirect assignments - io.go: fix CloseRead checking Writer instead of Reader, add Reader fallback to CloseWrite, unwrap *readWriter/*readWriteCloser in SetReadDeadline to reach underlying net.Conn - docs: add package doc and exported symbol comments to internal/ctx and internal/io
This commit is contained in:
@@ -1,3 +1,6 @@
|
||||
// Package io provides composite IO types that combine separate readers and
|
||||
// writers into standard [io.ReadWriter] and [io.ReadWriteCloser] pairs, plus
|
||||
// helpers for half-close and read-deadline propagation.
|
||||
package io
|
||||
|
||||
import (
|
||||
@@ -7,13 +10,25 @@ import (
|
||||
)
|
||||
|
||||
var (
|
||||
// ErrUnsupported is returned when a half-close operation is not supported
|
||||
// by the underlying reader or writer.
|
||||
ErrUnsupported = errors.New("unsupported")
|
||||
)
|
||||
|
||||
// CloseRead is the interface that groups the basic CloseRead method.
|
||||
//
|
||||
// CloseRead closes the read side of a connection. After CloseRead, reads
|
||||
// return io.EOF while writes remain unaffected. It is typically implemented
|
||||
// by [net.TCPConn] and connection wrappers throughout the x module.
|
||||
type CloseRead interface {
|
||||
CloseRead() error
|
||||
}
|
||||
|
||||
// CloseWrite is the interface that groups the basic CloseWrite method.
|
||||
//
|
||||
// CloseWrite closes the write side of a connection. After CloseWrite, writes
|
||||
// return an error while reads continue to work. It is typically implemented
|
||||
// by [net.TCPConn] and connection wrappers throughout the x module.
|
||||
type CloseWrite interface {
|
||||
CloseWrite() error
|
||||
}
|
||||
@@ -23,6 +38,9 @@ type readWriter struct {
|
||||
io.Writer
|
||||
}
|
||||
|
||||
// NewReadWriter returns an [io.ReadWriter] that reads from r and writes to w.
|
||||
// The returned value supports [CloseRead] and [CloseWrite] by delegating to
|
||||
// the corresponding methods on r or w when available.
|
||||
func NewReadWriter(r io.Reader, w io.Writer) io.ReadWriter {
|
||||
return &readWriter{
|
||||
Reader: r,
|
||||
@@ -31,6 +49,9 @@ func NewReadWriter(r io.Reader, w io.Writer) io.ReadWriter {
|
||||
}
|
||||
|
||||
func (rw *readWriter) CloseRead() error {
|
||||
if sc, ok := rw.Reader.(CloseRead); ok {
|
||||
return sc.CloseRead()
|
||||
}
|
||||
if sc, ok := rw.Writer.(CloseRead); ok {
|
||||
return sc.CloseRead()
|
||||
}
|
||||
@@ -41,6 +62,9 @@ func (rw *readWriter) CloseWrite() error {
|
||||
if sc, ok := rw.Writer.(CloseWrite); ok {
|
||||
return sc.CloseWrite()
|
||||
}
|
||||
if sc, ok := rw.Reader.(CloseWrite); ok {
|
||||
return sc.CloseWrite()
|
||||
}
|
||||
return ErrUnsupported
|
||||
}
|
||||
|
||||
@@ -50,6 +74,10 @@ type readWriteCloser struct {
|
||||
io.Closer
|
||||
}
|
||||
|
||||
// NewReadWriteCloser returns an [io.ReadWriteCloser] that reads from r, writes
|
||||
// to w, and closes c. Close delegates to c. The returned value also supports
|
||||
// [CloseRead] and [CloseWrite] by delegating to the corresponding methods on
|
||||
// r or w when available.
|
||||
func NewReadWriteCloser(r io.Reader, w io.Writer, c io.Closer) io.ReadWriteCloser {
|
||||
return &readWriteCloser{
|
||||
Reader: r,
|
||||
@@ -59,6 +87,9 @@ func NewReadWriteCloser(r io.Reader, w io.Writer, c io.Closer) io.ReadWriteClose
|
||||
}
|
||||
|
||||
func (rwc *readWriteCloser) CloseRead() error {
|
||||
if sc, ok := rwc.Reader.(CloseRead); ok {
|
||||
return sc.CloseRead()
|
||||
}
|
||||
if sc, ok := rwc.Writer.(CloseRead); ok {
|
||||
return sc.CloseRead()
|
||||
}
|
||||
@@ -69,6 +100,9 @@ func (rwc *readWriteCloser) CloseWrite() error {
|
||||
if sc, ok := rwc.Writer.(CloseWrite); ok {
|
||||
return sc.CloseWrite()
|
||||
}
|
||||
if sc, ok := rwc.Reader.(CloseWrite); ok {
|
||||
return sc.CloseWrite()
|
||||
}
|
||||
return ErrUnsupported
|
||||
}
|
||||
|
||||
@@ -76,9 +110,30 @@ type setReadDeadline interface {
|
||||
SetReadDeadline(t time.Time) error
|
||||
}
|
||||
|
||||
// SetReadDeadline sets the read deadline on rw if the underlying connection
|
||||
// supports it. It checks rw itself first, then unwraps *readWriter and
|
||||
// *readWriteCloser to reach their embedded Reader or Writer. If no
|
||||
// settable deadline is found the call is a no-op and returns nil.
|
||||
func SetReadDeadline(rw io.ReadWriter, t time.Time) error {
|
||||
if v, _ := rw.(setReadDeadline); v != nil {
|
||||
return v.SetReadDeadline(t)
|
||||
}
|
||||
// Unwrap readWriter/readWriteCloser to reach the underlying connection.
|
||||
switch r := rw.(type) {
|
||||
case *readWriter:
|
||||
if v, _ := r.Reader.(setReadDeadline); v != nil {
|
||||
return v.SetReadDeadline(t)
|
||||
}
|
||||
if v, _ := r.Writer.(setReadDeadline); v != nil {
|
||||
return v.SetReadDeadline(t)
|
||||
}
|
||||
case *readWriteCloser:
|
||||
if v, _ := r.Reader.(setReadDeadline); v != nil {
|
||||
return v.SetReadDeadline(t)
|
||||
}
|
||||
if v, _ := r.Writer.(setReadDeadline); v != nil {
|
||||
return v.SetReadDeadline(t)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user