Skip to content

fix: fix a panic in ServeHTTP where stream was nil #16818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/limits/frontend/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func (f *Frontend) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return
}

streams := make([]*logproto.StreamMetadata, len(req.StreamHashes))
streams := make([]*logproto.StreamMetadata, 0, len(req.StreamHashes))
for _, streamHash := range req.StreamHashes {
streams = append(streams, &logproto.StreamMetadata{
StreamHash: streamHash,
Expand Down
109 changes: 109 additions & 0 deletions pkg/limits/frontend/http_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
package frontend

import (
"bytes"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"testing"
"time"

"github.com/grafana/dskit/limiter"
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require"

"github.com/grafana/loki/v3/pkg/logproto"
)

func TestFrontend_ServeHTTP(t *testing.T) {
tests := []struct {
name string
limits Limits
expectedGetStreamUsageRequest *GetStreamUsageRequest
getStreamUsageResponses []GetStreamUsageResponse
request exceedsLimitsRequest
expected exceedsLimitsResponse
}{{
name: "within limits",
limits: &mockLimits{
maxGlobalStreams: 1,
ingestionRate: 100,
},
expectedGetStreamUsageRequest: &GetStreamUsageRequest{
Tenant: "test",
StreamHashes: []uint64{0x1},
},
getStreamUsageResponses: []GetStreamUsageResponse{{
Response: &logproto.GetStreamUsageResponse{
Tenant: "test",
ActiveStreams: 1,
Rate: 10,
},
}},
request: exceedsLimitsRequest{
TenantID: "test",
StreamHashes: []uint64{0x1},
},
// expected should be default value (no rejected streams).
}, {
name: "exceeds limits",
limits: &mockLimits{
maxGlobalStreams: 1,
ingestionRate: 100,
},
expectedGetStreamUsageRequest: &GetStreamUsageRequest{
Tenant: "test",
StreamHashes: []uint64{0x1},
},
getStreamUsageResponses: []GetStreamUsageResponse{{
Response: &logproto.GetStreamUsageResponse{
Tenant: "test",
ActiveStreams: 2,
Rate: 200,
},
}},
request: exceedsLimitsRequest{
TenantID: "test",
StreamHashes: []uint64{0x1},
},
expected: exceedsLimitsResponse{
RejectedStreams: []*logproto.RejectedStream{{
StreamHash: 0x1,
Reason: "exceeds_rate_limit",
}},
},
}}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
f := Frontend{
limits: test.limits,
rateLimiter: limiter.NewRateLimiter(newRateLimitsAdapter(test.limits), time.Second),
streamUsage: &mockStreamUsageGatherer{
t: t,
expectedRequest: test.expectedGetStreamUsageRequest,
responses: test.getStreamUsageResponses,
},
metrics: newMetrics(prometheus.NewRegistry()),
}
ts := httptest.NewServer(&f)
defer ts.Close()

b, err := json.Marshal(test.request)
require.NoError(t, err)

resp, err := http.Post(ts.URL, "application/json", bytes.NewReader(b))
require.NoError(t, err)
require.Equal(t, http.StatusOK, resp.StatusCode)

defer resp.Body.Close()
b, err = io.ReadAll(resp.Body)
require.NoError(t, err)

var actual exceedsLimitsResponse
require.NoError(t, json.Unmarshal(b, &actual))
require.Equal(t, test.expected, actual)
})
}
}
16 changes: 16 additions & 0 deletions pkg/limits/frontend/mock_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ import (
"github.com/grafana/loki/v3/pkg/logproto"
)

// mockStreamUsageGatherer mocks a StreamUsageGatherer. It avoids having to
// set up a mock ring to test the frontend.
type mockStreamUsageGatherer struct {
t *testing.T

expectedRequest *GetStreamUsageRequest
responses []GetStreamUsageResponse
}

func (g *mockStreamUsageGatherer) GetStreamUsage(_ context.Context, r GetStreamUsageRequest) ([]GetStreamUsageResponse, error) {
if expected := g.expectedRequest; expected != nil {
require.Equal(g.t, *expected, r)
}
return g.responses, nil
}

// mockIngestLimitsClient mocks logproto.IngestLimitsClient.
type mockIngestLimitsClient struct {
logproto.IngestLimitsClient
Expand Down