logging: add a Close function to the Tracer (#4298)

* logging: add a Close function to the Tracer

* close the Tracer when the Transport is closed

internal/mocks/logging/mockgen.go

@@ -15,6 +15,7 @@ type Tracer interface {
  SentVersionNegotiationPacket(_ net.Addr, dest, src logging.ArbitraryLenConnectionID, _ []logging.VersionNumber)
  DroppedPacket(net.Addr, logging.PacketType, logging.ByteCount, logging.PacketDropReason)
  Debug(name, msg string)
+ Close()
 }
 
 //go:generate sh -c "go run go.uber.org/mock/mockgen -typed -build_flags=\"-tags=gomock\" -package internal -destination internal/connection_tracer.go github.com/quic-go/quic-go/internal/mocks/logging ConnectionTracer"

internal/mocks/logging/tracer.go

@@ -28,5 +28,8 @@ func NewMockTracer(ctrl *gomock.Controller) (*logging.Tracer, *MockTracer) {
  Debug: func(name, msg string) {
  t.Debug(name, msg)
  },
+ Close: func() {
+ t.Close()
+ },
  }, t
 }

logging/multiplex_test.go

@@ -70,6 +70,12 @@ var _ = Describe("Tracing", func() {
  tr2.EXPECT().Debug("foo", "bar")
  tracer.Debug("foo", "bar")
  })
+
+ It("traces the Close event", func() {
+ tr1.EXPECT().Close()
+ tr2.EXPECT().Close()
+ tracer.Close()
+ })
  })
  })
 

logging/tracer.go

@@ -8,6 +8,7 @@ type Tracer struct {
  SentVersionNegotiationPacket func(_ net.Addr, dest, src ArbitraryLenConnectionID, _ []VersionNumber)
  DroppedPacket func(net.Addr, PacketType, ByteCount, PacketDropReason)
  Debug func(name, msg string)
+ Close func()
 }
 
 // NewMultiplexedTracer creates a new tracer that multiplexes events to multiple tracers.
@@ -47,5 +48,12 @@ func NewMultiplexedTracer(tracers ...*Tracer) *Tracer {
  }
  }
  },
+ Close: func() {
+ for _, t := range tracers {
+ if t.Close != nil {
+ t.Close()
+ }
+ }
+ },
  }
 }

server_test.go

@@ -203,6 +203,7 @@ var _ = Describe("Server", func() {
  })
 
  AfterEach(func() {
+ tracer.EXPECT().Close()
  tr.Close()
  })
 
@@ -1429,7 +1430,10 @@ var _ = Describe("Server", func() {
  serv.connHandler = phm
  })
 
- AfterEach(func() { tr.Close() })
+ AfterEach(func() {
+ tracer.EXPECT().Close()
+ tr.Close()
+ })
 
  It("passes packets to existing connections", func() {
  connID := protocol.ParseConnectionID([]byte{1, 2, 3, 4, 5, 6, 7, 8})

transport.go

@@ -111,6 +111,7 @@ type Transport struct {
  MaxHandshakes int
 
  // A Tracer traces events that don't belong to a single QUIC connection.
+ // Tracer.Close is called when the transport is closed.
  Tracer *logging.Tracer
 
  handlerMap packetHandlerManager
@@ -366,6 +367,9 @@ func (t *Transport) close(e error) {
  if t.server != nil {
  t.server.close(e, false)
  }
+ if t.Tracer != nil && t.Tracer.Close != nil {
+ t.Tracer.Close()
+ }
  t.closed = true
 }
 

transport_test.go

@@ -141,6 +141,7 @@ var _ = Describe("Transport", func() {
  Eventually(dropped).Should(BeClosed())
 
  // shutdown
+ tracer.EXPECT().Close()
  close(packetChan)
  tr.Close()
  })
@@ -391,6 +392,7 @@ var _ = Describe("Transport", func() {
  Eventually(done).Should(BeClosed())
 
  // shutdown
+ tracer.EXPECT().Close()
  close(packetChan)
  tr.Close()
  })