From cc9a5ee744d8b271b71a9f87b6e42d74c23d154e Mon Sep 17 00:00:00 2001
From: Marten Seemann <martenseemann@gmail.com>
Date: Wed, 5 Jun 2024 18:50:01 +0800
Subject: [PATCH] qlog: rename DefaultTracer to DefaultConnectionTracer (#4556)

---
 example/client/main.go                 | 2 +-
 example/main.go                        | 2 +-
 integrationtests/self/qlog_dir_test.go | 4 ++--
 qlog/qlog_dir.go                       | 8 +++++++-
 qlog/qlog_dir_test.go                  | 4 ++--
 5 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/example/client/main.go b/example/client/main.go
index c759855ad..409a3444f 100644
--- a/example/client/main.go
+++ b/example/client/main.go
@@ -47,7 +47,7 @@ func main() {
 			KeyLogWriter:       keyLog,
 		},
 		QUICConfig: &quic.Config{
-			Tracer: qlog.DefaultTracer,
+			Tracer: qlog.DefaultConnectionTracer,
 		},
 	}
 	defer roundTripper.Close()
diff --git a/example/main.go b/example/main.go
index d242ba4e6..bf87f8107 100644
--- a/example/main.go
+++ b/example/main.go
@@ -169,7 +169,7 @@ func main() {
 					Handler: handler,
 					Addr:    bCap,
 					QUICConfig: &quic.Config{
-						Tracer: qlog.DefaultTracer,
+						Tracer: qlog.DefaultConnectionTracer,
 					},
 				}
 				err = server.ListenAndServeTLS(certFile, keyFile)
diff --git a/integrationtests/self/qlog_dir_test.go b/integrationtests/self/qlog_dir_test.go
index 1af5a619a..b81366e53 100644
--- a/integrationtests/self/qlog_dir_test.go
+++ b/integrationtests/self/qlog_dir_test.go
@@ -36,7 +36,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
 			"localhost:0",
 			getTLSConfig(),
 			&quic.Config{
-				Tracer: qlog.DefaultTracer,
+				Tracer: qlog.DefaultConnectionTracer,
 			},
 		)
 		Expect(err).ToNot(HaveOccurred())
@@ -56,7 +56,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
 			server.Addr().String(),
 			getTLSClientConfig(),
 			&quic.Config{
-				Tracer: qlog.DefaultTracer,
+				Tracer: qlog.DefaultConnectionTracer,
 			},
 		)
 		Expect(err).ToNot(HaveOccurred())
diff --git a/qlog/qlog_dir.go b/qlog/qlog_dir.go
index e7acef4f0..5ea5e3ae2 100644
--- a/qlog/qlog_dir.go
+++ b/qlog/qlog_dir.go
@@ -13,9 +13,15 @@ import (
 )
 
 // DefaultTracer creates a qlog file in the qlog directory specified by the QLOGDIR environment variable.
+// Deprecated: use DefaultConnectionTracer instead.
+func DefaultTracer(ctx context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
+	return DefaultConnectionTracer(ctx, p, connID)
+}
+
+// DefaultConnectionTracer creates a qlog file in the qlog directory specified by the QLOGDIR environment variable.
 // File names are <odcid>_<perspective>.qlog.
 // Returns nil if QLOGDIR is not set.
-func DefaultTracer(_ context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
+func DefaultConnectionTracer(_ context.Context, p logging.Perspective, connID logging.ConnectionID) *logging.ConnectionTracer {
 	var label string
 	switch p {
 	case logging.PerspectiveClient:
diff --git a/qlog/qlog_dir_test.go b/qlog/qlog_dir_test.go
index f0582b485..837465a51 100644
--- a/qlog/qlog_dir_test.go
+++ b/qlog/qlog_dir_test.go
@@ -36,7 +36,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
 		qlogDir := path.Join(tempTestDirPath, "qlogs")
 		err := os.Setenv("QLOGDIR", qlogDir)
 		Expect(err).ToNot(HaveOccurred())
-		tracer := DefaultTracer(ctx, perspective, connID)
+		tracer := DefaultConnectionTracer(ctx, perspective, connID)
 		Expect(tracer).ToNot(BeNil())
 		tracer.Close()
 		_, err = os.Stat(qlogDir)
@@ -50,7 +50,7 @@ var _ = Describe("qlog dir tests", Serial, func() {
 	It("environment variable is not set", func() {
 		err := os.Setenv("QLOGDIR", "")
 		Expect(err).ToNot(HaveOccurred())
-		tracer := DefaultTracer(ctx, perspective, connID)
+		tracer := DefaultConnectionTracer(ctx, perspective, connID)
 		Expect(tracer).To(BeNil())
 	})
 })