use the new error types to log the reason why a connection is closed

logging/close_reason.go

@@ -1,78 +0,0 @@
-package logging
-
-// A CloseReason is the reason why a QUIC connection is closed.
-// It falls in one of 4 categories:
-// 1. The application closed the connection (with an application-specific error code).
-// 2. The transport closed the connection with a transport-error code.
-// 3. The connection timed out, either during the handshake, or due to an idle timeout.
-// 4. A stateless reset was received.
-type CloseReason struct {
-	remote           bool
-	applicationError *ApplicationError
-	transportError   *TransportError
-
-	timeout             *TimeoutReason
-	statelessResetToken *StatelessResetToken
-	versions            []VersionNumber
-}
-
-// NewApplicationCloseReason creates a new CloseReason for an application error.
-func NewApplicationCloseReason(errorCode ApplicationError, remote bool) CloseReason {
-	return CloseReason{remote: remote, applicationError: &errorCode}
-}
-
-// NewTransportCloseReason creates a new CloseReason for a transport error.
-func NewTransportCloseReason(errorCode TransportError, remote bool) CloseReason {
-	return CloseReason{remote: remote, transportError: &errorCode}
-}
-
-// NewTimeoutCloseReason creates a new CloseReason for a connection timeout.
-func NewTimeoutCloseReason(r TimeoutReason) CloseReason {
-	return CloseReason{timeout: &r}
-}
-
-// NewStatelessResetCloseReason creates a new CloseReason for a stateless reset.
-func NewStatelessResetCloseReason(token StatelessResetToken) CloseReason {
-	return CloseReason{statelessResetToken: &token}
-}
-
-// NewVersionNegotiationError creates a new CloseReason for a version negotiation error.
-func NewVersionNegotiationError(versions []VersionNumber) CloseReason {
-	return CloseReason{versions: versions}
-}
-
-// ApplicationError gets the application error.
-func (r *CloseReason) ApplicationError() (errorCode ApplicationError, remote bool, ok bool) {
-	if r.applicationError == nil {
-		return
-	}
-	return *r.applicationError, r.remote, true
-}
-
-// TransportError gets the transport error.
-func (r *CloseReason) TransportError() (errorCode TransportError, remote bool, ok bool) {
-	if r.transportError == nil {
-		return
-	}
-	return *r.transportError, r.remote, true
-}
-
-// Timeout gets the timeout error.
-func (r *CloseReason) Timeout() (reason TimeoutReason, ok bool) {
-	if r.timeout == nil {
-		return
-	}
-	return *r.timeout, true
-}
-
-// StatelessReset gets the stateless reset token.
-func (r *CloseReason) StatelessReset() (token StatelessResetToken, ok bool) {
-	if r.statelessResetToken == nil {
-		return
-	}
-	return *r.statelessResetToken, true
-}
-
-func (r *CloseReason) VersionNegotiation() (versions []VersionNumber, ok bool) {
-	return r.versions, len(r.versions) > 0
-}

logging/close_reason_test.go

@@ -1,89 +0,0 @@
-package logging
-
-import (
-	. "github.com/onsi/ginkgo"
-	. "github.com/onsi/gomega"
-)
-
-var _ = Describe("Close Reason", func() {
-	checkNotApplicationError := func(r CloseReason) {
-		_, _, ok := r.ApplicationError()
-		Expect(ok).To(BeFalse())
-	}
-
-	checkNotTransportError := func(r CloseReason) {
-		_, _, ok := r.TransportError()
-		Expect(ok).To(BeFalse())
-	}
-
-	checkNotStatelessReset := func(r CloseReason) {
-		_, ok := r.StatelessReset()
-		ExpectWithOffset(1, ok).To(BeFalse())
-	}
-
-	checkNotTimeout := func(r CloseReason) {
-		_, ok := r.Timeout()
-		ExpectWithOffset(1, ok).To(BeFalse())
-	}
-
-	checkNotVN := func(r CloseReason) {
-		_, ok := r.VersionNegotiation()
-		ExpectWithOffset(1, ok).To(BeFalse())
-	}
-
-	It("application errors", func() {
-		r := NewApplicationCloseReason(1337, true)
-		errorCode, remote, ok := r.ApplicationError()
-		Expect(ok).To(BeTrue())
-		Expect(remote).To(BeTrue())
-		Expect(errorCode).To(Equal(ApplicationError(1337)))
-		checkNotTransportError(r)
-		checkNotStatelessReset(r)
-		checkNotTimeout(r)
-		checkNotVN(r)
-	})
-
-	It("transport errors", func() {
-		r := NewTransportCloseReason(1337, true)
-		errorCode, remote, ok := r.TransportError()
-		Expect(ok).To(BeTrue())
-		Expect(remote).To(BeTrue())
-		Expect(errorCode).To(Equal(TransportError(1337)))
-		checkNotApplicationError(r)
-		checkNotStatelessReset(r)
-		checkNotTimeout(r)
-		checkNotVN(r)
-	})
-
-	It("transport errors", func() {
-		r := NewTimeoutCloseReason(TimeoutReasonIdle)
-		timeout, ok := r.Timeout()
-		Expect(ok).To(BeTrue())
-		Expect(timeout).To(Equal(TimeoutReasonIdle))
-		checkNotApplicationError(r)
-		checkNotTransportError(r)
-		checkNotVN(r)
-	})
-
-	It("stateless resets", func() {
-		r := NewStatelessResetCloseReason(StatelessResetToken{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16})
-		token, ok := r.StatelessReset()
-		Expect(ok).To(BeTrue())
-		Expect(token).To(Equal(StatelessResetToken{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16}))
-		checkNotApplicationError(r)
-		checkNotTransportError(r)
-		checkNotTimeout(r)
-		checkNotVN(r)
-	})
-
-	It("version negotiation errors", func() {
-		r := NewVersionNegotiationError([]VersionNumber{1, 2, 3})
-		vn, ok := r.VersionNegotiation()
-		Expect(ok).To(BeTrue())
-		Expect(vn).To(Equal([]VersionNumber{1, 2, 3}))
-		checkNotApplicationError(r)
-		checkNotTransportError(r)
-		checkNotTimeout(r)
-		checkNotStatelessReset(r)
-	})
-})

logging/interface.go

@@ -106,7 +106,7 @@ type Tracer interface {
 type ConnectionTracer interface {
 	StartedConnection(local, remote net.Addr, srcConnID, destConnID ConnectionID)
 	NegotiatedVersion(chosen VersionNumber, clientVersions, serverVersions []VersionNumber)
-	ClosedConnection(CloseReason)
+	ClosedConnection(error)
 	SentTransportParameters(*TransportParameters)
 	ReceivedTransportParameters(*TransportParameters)
 	RestoredTransportParameters(parameters *TransportParameters) // for 0-RTT

logging/mock_connection_tracer_test.go

@@ -75,7 +75,7 @@ func (mr *MockConnectionTracerMockRecorder) Close() *gomock.Call {
 }
 
 // ClosedConnection mocks base method.
-func (m *MockConnectionTracer) ClosedConnection(arg0 CloseReason) {
+func (m *MockConnectionTracer) ClosedConnection(arg0 error) {
 	m.ctrl.T.Helper()
 	m.ctrl.Call(m, "ClosedConnection", arg0)
 }

logging/multiplex.go

@@ -74,9 +74,9 @@ func (m *connTracerMultiplexer) NegotiatedVersion(chosen VersionNumber, clientVe
 	}
 }
 
-func (m *connTracerMultiplexer) ClosedConnection(reason CloseReason) {
+func (m *connTracerMultiplexer) ClosedConnection(e error) {
 	for _, t := range m.tracers {
-		t.ClosedConnection(reason)
+		t.ClosedConnection(e)
 	}
 }
 

logging/multiplex_test.go

@@ -2,6 +2,7 @@ package logging
 
 import (
 	"context"
+	"errors"
 	"net"
 	"time"
 
@@ -111,10 +112,10 @@ var _ = Describe("Tracing", func() {
 		})
 
 		It("traces the ClosedConnection event", func() {
-			reason := NewTimeoutCloseReason(TimeoutReasonIdle)
-			tr1.EXPECT().ClosedConnection(reason)
-			tr2.EXPECT().ClosedConnection(reason)
-			tracer.ClosedConnection(reason)
+			e := errors.New("test err")
+			tr1.EXPECT().ClosedConnection(e)
+			tr2.EXPECT().ClosedConnection(e)
+			tracer.ClosedConnection(e)
 		})
 
 		It("traces the SentTransportParameters event", func() {