gr1ffon/quic-go
1
0
Fork 0
forked from quic-go/quic-go
Code Pull Requests Activity

Merge pull request #2648 from lucas-clemente/fix-qlog-nil-writecloser

Browse Source 
fix crash when the qlog callbacks returns a nil io.WriteCloser
This commit is contained in:
Marten Seemann
2020-07-07 19:03:39 +07:00
committed by GitHub
parent 7c1e5da245 6dcc88536d
commit 37b072492f
2 changed files with 535 additions and 522 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
qlog/qlog.go
View File

@@ -31,11 +31,17 @@ func NewTracer(getLogWriter func(connectionID []byte) io.WriteCloser) logging.Tr
} }
func (t *tracer) TracerForServer(odcid protocol.ConnectionID) logging.ConnectionTracer { func (t *tracer) TracerForServer(odcid protocol.ConnectionID) logging.ConnectionTracer {
return newTracer(t.getLogWriter(odcid.Bytes()), protocol.PerspectiveServer, odcid) if w := t.getLogWriter(odcid.Bytes()); w != nil {
return newConnectionTracer(w, protocol.PerspectiveServer, odcid)
}
return nil
} }
func (t *tracer) TracerForClient(odcid protocol.ConnectionID) logging.ConnectionTracer { func (t *tracer) TracerForClient(odcid protocol.ConnectionID) logging.ConnectionTracer {
return newTracer(t.getLogWriter(odcid.Bytes()), protocol.PerspectiveClient, odcid) if w := t.getLogWriter(odcid.Bytes()); w != nil {
return newConnectionTracer(w, protocol.PerspectiveClient, odcid)
}
return nil
} }
type connectionTracer struct { type connectionTracer struct {
@@ -57,7 +63,7 @@ type connectionTracer struct {
var _ logging.ConnectionTracer = &connectionTracer{} var _ logging.ConnectionTracer = &connectionTracer{}
// newTracer creates a new connectionTracer to record a qlog. // newTracer creates a new connectionTracer to record a qlog.
func newTracer(w io.WriteCloser, p protocol.Perspective, odcid protocol.ConnectionID) logging.ConnectionTracer { func newConnectionTracer(w io.WriteCloser, p protocol.Perspective, odcid protocol.ConnectionID) logging.ConnectionTracer {
t := &connectionTracer{ t := &connectionTracer{
w: w, w: w,
perspective: p, perspective: p,

21
qlog/qlog_test.go
View File

@@ -48,7 +48,16 @@ type entry struct {
Event map[string]interface{} Event map[string]interface{}
} }
var _ = Describe("Tracer", func() { var _ = Describe("Tracing", func() {
Context("tracer", func() {
It("returns nil when there's no io.WriteCloser", func() {
t := NewTracer(func([]byte) io.WriteCloser { return nil })
Expect(t.TracerForClient(logging.ConnectionID{1, 2, 3, 4})).To(BeNil())
Expect(t.TracerForServer(logging.ConnectionID{1, 2, 3, 4})).To(BeNil())
})
})
Context("connection tracer", func() {
var ( var (
tracer logging.ConnectionTracer tracer logging.ConnectionTracer
buf *bytes.Buffer buf *bytes.Buffer
@@ -56,11 +65,8 @@ var _ = Describe("Tracer", func() {
BeforeEach(func() { BeforeEach(func() {
buf = &bytes.Buffer{} buf = &bytes.Buffer{}
tracer = newTracer( t := NewTracer(func([]byte) io.WriteCloser { return nopWriteCloser(buf) })
nopWriteCloser(buf), tracer = t.TracerForServer(logging.ConnectionID{0xde, 0xad, 0xbe, 0xef})
protocol.PerspectiveServer,
protocol.ConnectionID{0xde, 0xad, 0xbe, 0xef},
)
}) })
It("exports a trace that has the right metadata", func() { It("exports a trace that has the right metadata", func() {
@@ -91,7 +97,7 @@ var _ = Describe("Tracer", func() {
}) })
It("stops writing when encountering an error", func() { It("stops writing when encountering an error", func() {
tracer = newTracer( tracer = newConnectionTracer(
&limitedWriter{WriteCloser: nopWriteCloser(buf), N: 250}, &limitedWriter{WriteCloser: nopWriteCloser(buf), N: 250},
protocol.PerspectiveServer, protocol.PerspectiveServer,
protocol.ConnectionID{0xde, 0xad, 0xbe, 0xef}, protocol.ConnectionID{0xde, 0xad, 0xbe, 0xef},
@@ -623,3 +629,4 @@ var _ = Describe("Tracer", func() {
}) })
}) })
}) })
})