refactor(querytee): move response comparator files to dedicated package

This change relocates response comparator logic to its own package to
prevent cyclic imports and improve code organization.
No functional changes.

Author: jnewbigin

cmd/querytee/main.go

@@ -12,6 +12,8 @@ import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/collectors"
 
+	"github.com/grafana/loki/v3/tools/querytee/responsecomparator"
+
 	loki_tracing "github.com/grafana/loki/v3/pkg/tracing"
 	util_log "github.com/grafana/loki/v3/pkg/util/log"
 	"github.com/grafana/loki/v3/tools/querytee"
@@ -85,7 +87,7 @@ func exit(code int) {
 }
 
 func lokiReadRoutes(cfg Config) []querytee.Route {
-	samplesComparator := querytee.NewSamplesComparator(querytee.SampleComparisonOptions{
+	samplesComparator := responsecomparator.NewSamplesComparator(responsecomparator.SampleComparisonOptions{
 		Tolerance:         cfg.ProxyConfig.ValueComparisonTolerance,
 		UseRelativeError:  cfg.ProxyConfig.UseRelativeError,
 		SkipRecentSamples: cfg.ProxyConfig.SkipRecentSamples,

tools/querytee/proxy.go

@@ -19,6 +19,7 @@ import (
 	"github.com/gorilla/mux"
 	"github.com/grafana/dskit/flagext"
 	"github.com/grafana/dskit/middleware"
+	"github.com/grafana/loki/v3/tools/querytee/responsecomparator"
 	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
 
@@ -71,7 +72,7 @@ type Route struct {
 	Path               string
 	RouteName          string
 	Methods            []string
-	ResponseComparator ResponsesComparator
+	ResponseComparator responsecomparator.ResponsesComparator
 }
 
 type Proxy struct {
@@ -240,7 +241,7 @@ func (p *Proxy) Start() error {
 
 	// register read routes
 	for _, route := range p.readRoutes {
-		var comparator ResponsesComparator
+		var comparator responsecomparator.ResponsesComparator
 		if p.cfg.CompareResponses {
 			comparator = route.ResponseComparator
 		}

tools/querytee/proxy_endpoint.go

@@ -14,22 +14,14 @@ import (
 	"github.com/go-kit/log"
 	"github.com/go-kit/log/level"
 	"github.com/grafana/loki/v3/tools/querytee/goldfish"
+	"github.com/grafana/loki/v3/tools/querytee/responsecomparator"
 )
 
-type ResponsesComparator interface {
-	Compare(expected, actual []byte, queryEvaluationTime time.Time) (*ComparisonSummary, error)
-}
-
-type ComparisonSummary struct {
-	skipped        bool
-	missingMetrics int
-}
-
 type ProxyEndpoint struct {
 	backends   []*ProxyBackend
 	metrics    *ProxyMetrics
 	logger     log.Logger
-	comparator ResponsesComparator
+	comparator responsecomparator.ResponsesComparator
 
 	instrumentCompares bool
 
@@ -43,7 +35,7 @@ type ProxyEndpoint struct {
 	goldfishManager *goldfish.Manager
 }
 
-func NewProxyEndpoint(backends []*ProxyBackend, routeName string, metrics *ProxyMetrics, logger log.Logger, comparator ResponsesComparator, instrumentCompares bool) *ProxyEndpoint {
+func NewProxyEndpoint(backends []*ProxyBackend, routeName string, metrics *ProxyMetrics, logger log.Logger, comparator responsecomparator.ResponsesComparator, instrumentCompares bool) *ProxyEndpoint {
 	hasPreferredBackend := false
 	for _, backend := range backends {
 		if backend.preferred {
@@ -195,12 +187,12 @@ func (p *ProxyEndpoint) executeBackendRequests(r *http.Request, resCh chan *Back
 					"route-name", p.routeName,
 					"query", r.URL.RawQuery, "err", err)
 				result = comparisonFailed
-			} else if summary != nil && summary.skipped {
+			} else if summary != nil && summary.Skipped {
 				result = comparisonSkipped
 			}
 
 			if p.instrumentCompares && summary != nil {
-				p.metrics.missingMetrics.WithLabelValues(p.backends[i].name, p.routeName, result, issuer).Observe(float64(summary.missingMetrics))
+				p.metrics.missingMetrics.WithLabelValues(p.backends[i].name, p.routeName, result, issuer).Observe(float64(summary.MissingMetrics))
 			}
 			p.metrics.responsesComparedTotal.WithLabelValues(p.backends[i].name, p.routeName, result, issuer).Inc()
 		}
@@ -275,9 +267,9 @@ func (p *ProxyEndpoint) waitBackendResponseForDownstream(resCh chan *BackendResp
 	return responses[0]
 }
 
-func (p *ProxyEndpoint) compareResponses(expectedResponse, actualResponse *BackendResponse, queryEvalTime time.Time) (*ComparisonSummary, error) {
+func (p *ProxyEndpoint) compareResponses(expectedResponse, actualResponse *BackendResponse, queryEvalTime time.Time) (*responsecomparator.ComparisonSummary, error) {
 	if expectedResponse.err != nil {
-		return &ComparisonSummary{skipped: true}, nil
+		return &responsecomparator.ComparisonSummary{Skipped: true}, nil
 	}
 
 	if actualResponse.err != nil {
@@ -286,7 +278,7 @@ func (p *ProxyEndpoint) compareResponses(expectedResponse, actualResponse *Backe
 
 	// compare response body only if we get a 200
 	if expectedResponse.status != 200 {
-		return &ComparisonSummary{skipped: true}, nil
+		return &responsecomparator.ComparisonSummary{Skipped: true}, nil
 	}
 
 	if actualResponse.status != 200 {

tools/querytee/proxy_endpoint_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/go-kit/log"
 	"github.com/grafana/loki/v3/pkg/goldfish"
 	querytee_goldfish "github.com/grafana/loki/v3/tools/querytee/goldfish"
+	"github.com/grafana/loki/v3/tools/querytee/responsecomparator"
 	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
 	prom_testutil "github.com/prometheus/client_golang/prometheus/testutil"
@@ -425,8 +426,8 @@ func Test_BackendResponse_statusCode(t *testing.T) {
 
 type mockComparator struct{}
 
-func (c *mockComparator) Compare(_, _ []byte, _ time.Time) (*ComparisonSummary, error) {
-	return &ComparisonSummary{missingMetrics: 12}, nil
+func (c *mockComparator) Compare(_, _ []byte, _ time.Time) (*responsecomparator.ComparisonSummary, error) {
+	return &responsecomparator.ComparisonSummary{MissingMetrics: 12}, nil
 }
 
 func Test_endToEnd_traceIDFlow(t *testing.T) {

tools/querytee/proxy_test.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/go-kit/log"
 	"github.com/gorilla/mux"
+	"github.com/grafana/loki/v3/tools/querytee/responsecomparator"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -25,7 +26,9 @@ var testWriteRoutes = []Route{}
 
 type testComparator struct{}
 
-func (testComparator) Compare(_, _ []byte, _ time.Time) (*ComparisonSummary, error) { return nil, nil }
+func (testComparator) Compare(_, _ []byte, _ time.Time) (*responsecomparator.ComparisonSummary, error) {
+	return nil, nil
+}
 
 func Test_NewProxy(t *testing.T) {
 	cfg := ProxyConfig{}

tools/querytee/response_comparator.go renamed to tools/querytee/responsecomparator/response_comparator.go

@@ -1,4 +1,4 @@
-package querytee
+package responsecomparator
 
 import (
 	"encoding/json"
@@ -8,6 +8,7 @@ import (
 	"time"
 
 	"github.com/go-kit/log/level"
+
 	jsoniter "github.com/json-iterator/go"
 	"github.com/pkg/errors"
 	"github.com/prometheus/common/model"
@@ -16,6 +17,15 @@ import (
 	util_log "github.com/grafana/loki/v3/pkg/util/log"
 )
 
+type ResponsesComparator interface {
+	Compare(expected, actual []byte, queryEvaluationTime time.Time) (*ComparisonSummary, error)
+}
+
+type ComparisonSummary struct {
+	Skipped        bool
+	MissingMetrics int
+}
+
 // SamplesComparatorFunc helps with comparing different types of samples coming from /api/v1/query and /api/v1/query_range routes.
 type SamplesComparatorFunc func(expected, actual json.RawMessage, evaluationTime time.Time, opts SampleComparisonOptions) (*ComparisonSummary, error)
 
@@ -122,7 +132,7 @@ func compareMatrix(expectedRaw, actualRaw json.RawMessage, evaluationTime time.T
 
 	// If both matrices are empty after filtering, we can skip comparison
 	if len(expected) == 0 && len(actual) == 0 {
-		return &ComparisonSummary{skipped: true}, nil
+		return &ComparisonSummary{Skipped: true}, nil
 	}
 
 	if len(expected) != len(actual) {
@@ -233,7 +243,7 @@ func compareVector(expectedRaw, actualRaw json.RawMessage, evaluationTime time.T
 	}
 
 	if len(expected) == 0 && len(actual) == 0 {
-		return &ComparisonSummary{skipped: true}, nil
+		return &ComparisonSummary{Skipped: true}, nil
 	}
 
 	if len(expected) != len(actual) {
@@ -279,7 +289,7 @@ func compareVector(expectedRaw, actualRaw json.RawMessage, evaluationTime time.T
 		err = fmt.Errorf("expected metric(s) [%s] missing from actual response", b.String())
 	}
 
-	return &ComparisonSummary{missingMetrics: len(missingMetrics)}, err
+	return &ComparisonSummary{MissingMetrics: len(missingMetrics)}, err
 }
 
 func compareScalar(expectedRaw, actualRaw json.RawMessage, evaluationTime time.Time, opts SampleComparisonOptions) (*ComparisonSummary, error) {
@@ -295,7 +305,7 @@ func compareScalar(expectedRaw, actualRaw json.RawMessage, evaluationTime time.T
 	}
 
 	if opts.SkipSample(expected.Timestamp.Time(), evaluationTime) && opts.SkipSample(actual.Timestamp.Time(), evaluationTime) {
-		return &ComparisonSummary{skipped: true}, nil
+		return &ComparisonSummary{Skipped: true}, nil
 	}
 
 	return nil, compareSamplePair(model.SamplePair{
@@ -359,7 +369,7 @@ func compareStreams(expectedRaw, actualRaw json.RawMessage, evaluationTime time.
 
 	// If both streams are empty after filtering, we can skip comparison
 	if len(expected) == 0 && len(actual) == 0 {
-		return &ComparisonSummary{skipped: true}, nil
+		return &ComparisonSummary{Skipped: true}, nil
 	}
 
 	if len(expected) != len(actual) {

tools/querytee/response_comparator_test.go renamed to tools/querytee/responsecomparator/response_comparator_test.go

@@ -1,4 +1,4 @@
-package querytee
+package responsecomparator
 
 import (
 	"encoding/json"
@@ -693,7 +693,7 @@ func TestCompareStreams_SamplesOutsideComparableWindow(t *testing.T) {
 			if tc.err == nil {
 				require.NoError(t, err)
 				if summary != nil {
-					require.True(t, summary.skipped)
+					require.True(t, summary.Skipped)
 				}
 				return
 			}