Loki: Ensure that streaming is behind feature toggle in backend (#106657)

* Loki: Ensure that streaming is behind feature toggle in backend

* Update getLiveStreamKey to include orgId and datasourceUIS
pull/106699/head
Ivana Huckova 1 month ago committed by GitHub
parent 61be88b9b3
commit fba0d8ddb0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 7
      pkg/tsdb/loki/streaming.go
  2. 61
      pkg/tsdb/loki/streaming_test.go
  3. 2
      public/app/plugins/datasource/loki/streaming.ts

@ -13,9 +13,16 @@ import (
"github.com/gorilla/websocket"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/data"
"github.com/grafana/grafana/pkg/services/featuremgmt"
)
func (s *Service) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
if !isFeatureEnabled(ctx, featuremgmt.FlagLokiExperimentalStreaming) {
return &backend.SubscribeStreamResponse{
Status: backend.SubscribeStreamStatusPermissionDenied,
}, fmt.Errorf("streaming is not supported")
}
dsInfo, err := s.getDSInfo(ctx, req.PluginContext)
if err != nil {
return &backend.SubscribeStreamResponse{

@ -0,0 +1,61 @@
package loki
import (
"context"
"testing"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana-plugin-sdk-go/backend/datasource"
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
"github.com/grafana/grafana-plugin-sdk-go/experimental/featuretoggles"
"github.com/grafana/grafana/pkg/infra/tracing"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/stretchr/testify/require"
)
func TestSubscribeStream(t *testing.T) {
// Create a service instance with required dependencies
service := &Service{
im: datasource.NewInstanceManager(newInstanceSettings(httpclient.NewProvider())),
tracer: tracing.InitializeTracerForTest(),
logger: backend.NewLoggerWith("logger", "loki test"),
}
// Create a test request
req := &backend.SubscribeStreamRequest{
PluginContext: backend.PluginContext{
DataSourceInstanceSettings: &backend.DataSourceInstanceSettings{
ID: 1,
UID: "test",
Type: "loki",
URL: "http://localhost:3100",
},
},
Path: "tail/test",
Data: []byte(`{"expr": "test"}`),
}
t.Run("when feature toggle is disabled", func(t *testing.T) {
// Create a context without the feature toggle enabled
ctx := context.Background()
resp, err := service.SubscribeStream(ctx, req)
require.Error(t, err)
require.Equal(t, "streaming is not supported", err.Error())
require.Equal(t, backend.SubscribeStreamStatusPermissionDenied, resp.Status)
})
t.Run("when feature toggle is enabled", func(t *testing.T) {
// Create a context with the feature toggle enabled
cfg := backend.NewGrafanaCfg(map[string]string{
featuretoggles.EnabledFeatures: featuremgmt.FlagLokiExperimentalStreaming,
})
ctx := backend.WithGrafanaConfig(context.Background(), cfg)
resp, err := service.SubscribeStream(ctx, req)
require.NoError(t, err)
require.Equal(t, backend.SubscribeStreamStatusOK, resp.Status)
})
}

@ -25,7 +25,7 @@ export async function getLiveStreamKey(query: LokiQuery): Promise<string> {
const msgUint8 = new TextEncoder().encode(str); // encode as (utf-8) Uint8Array
const hashBuffer = await crypto.subtle.digest('SHA-1', msgUint8); // hash the message
const hashArray = Array.from(new Uint8Array(hashBuffer.slice(0, 8))); // first 8 bytes
return hashArray.map((b) => b.toString(16).padStart(2, '0')).join('');
return `${query.datasource?.uid}/${hashArray.map((b) => b.toString(16).padStart(2, '0')).join('')}/${config.bootData.user.orgId}`;
}
// This will get both v1 and v2 result formats

Loading…
Cancel
Save