Live: use latest changes in Go SDK to deal with streaming frames (#34668)

2025-02-25 18:55:37 -06:00 · 2021-05-25 20:29:02 +03:00
parent 93c5c8345c
commit 063e1b5ff5
15 changed files with 84 additions and 101 deletions
--- a/pkg/services/live/runstream/manager.go
+++ b/pkg/services/live/runstream/manager.go
@@ -18,10 +18,10 @@ var (
 	logger = log.New("live.runstream")
 )

-//go:generate mockgen -destination=mock.go -package=runstream github.com/grafana/grafana/pkg/services/live/runstream StreamPacketSender,PresenceGetter,StreamRunner,PluginContextGetter
+//go:generate mockgen -destination=mock.go -package=runstream github.com/grafana/grafana/pkg/services/live/runstream ChannelSender,PresenceGetter,StreamRunner,PluginContextGetter

-type StreamPacketSender interface {
-	Send(channel string, packet *backend.StreamPacket) error
+type ChannelSender interface {
+	Send(channel string, data []byte) error
 }

 type PluginContextGetter interface {
@@ -33,23 +33,16 @@ type PresenceGetter interface {
 }

 type StreamRunner interface {
-	RunStream(ctx context.Context, request *backend.RunStreamRequest, sender backend.StreamPacketSender) error
+	RunStream(ctx context.Context, request *backend.RunStreamRequest, sender *backend.StreamSender) error
 }

-type streamSender struct {
-	channel      string
-	packetSender StreamPacketSender
+type packetSender struct {
+	channelSender ChannelSender
+	channel       string
 }

-func newStreamSender(channel string, packetSender StreamPacketSender) *streamSender {
-	return &streamSender{
-		channel:      channel,
-		packetSender: packetSender,
-	}
-}
-
-func (p *streamSender) Send(packet *backend.StreamPacket) error {
-	return p.packetSender.Send(p.channel, packet)
+func (p *packetSender) Send(packet *backend.StreamPacket) error {
+	return p.channelSender.Send(p.channel, packet.Data)
 }

 // Manager manages streams from Grafana to plugins (i.e. RunStream method).
@@ -60,7 +53,7 @@ type Manager struct {
 	datasourceStreams       map[string]map[string]struct{}
 	presenceGetter          PresenceGetter
 	pluginContextGetter     PluginContextGetter
-	packetSender            StreamPacketSender
+	channelSender           ChannelSender
 	registerCh              chan submitRequest
 	closedCh                chan struct{}
 	checkInterval           time.Duration
@@ -86,11 +79,11 @@ const (
 )

 // NewManager creates new Manager.
-func NewManager(packetSender StreamPacketSender, presenceGetter PresenceGetter, pluginContextGetter PluginContextGetter, opts ...ManagerOption) *Manager {
+func NewManager(channelSender ChannelSender, presenceGetter PresenceGetter, pluginContextGetter PluginContextGetter, opts ...ManagerOption) *Manager {
 	sm := &Manager{
 		streams:                 make(map[string]streamContext),
 		datasourceStreams:       map[string]map[string]struct{}{},
-		packetSender:            packetSender,
+		channelSender:           channelSender,
 		presenceGetter:          presenceGetter,
 		pluginContextGetter:     pluginContextGetter,
 		registerCh:              make(chan submitRequest),
@@ -308,7 +301,7 @@ func (s *Manager) runStream(ctx context.Context, cancelFn func(), sr streamReque
 				PluginContext: pluginCtx,
 				Path:          sr.Path,
 			},
-			newStreamSender(sr.Channel, s.packetSender),
+			backend.NewStreamSender(&packetSender{channelSender: s.channelSender, channel: sr.Channel}),
 		)
 		if err != nil {
 			if errors.Is(ctx.Err(), context.Canceled) {
--- a/pkg/services/live/runstream/manager_test.go
+++ b/pkg/services/live/runstream/manager_test.go
@@ -27,11 +27,11 @@ func TestStreamManager_Run(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockChannelSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

-	manager := NewManager(mockPacketSender, mockPresenceGetter, mockContextGetter)
+	manager := NewManager(mockChannelSender, mockPresenceGetter, mockContextGetter)

 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
@@ -48,7 +48,7 @@ func TestStreamManager_SubmitStream_Send(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -84,12 +84,10 @@ func TestStreamManager_SubmitStream_Send(t *testing.T) {
 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		require.Equal(t, "test", req.Path)
 		close(startedCh)
-		err := sender.Send(&backend.StreamPacket{
-			Data: []byte("test"),
-		})
+		err := sender.SendJSON([]byte("{}"))
 		require.NoError(t, err)
 		<-ctx.Done()
 		close(doneCh)
@@ -115,7 +113,7 @@ func TestStreamManager_SubmitStream_DifferentOrgID(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -142,12 +140,10 @@ func TestStreamManager_SubmitStream_DifferentOrgID(t *testing.T) {
 	mockStreamRunner1 := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner1.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		require.Equal(t, "test", req.Path)
 		close(startedCh1)
-		err := sender.Send(&backend.StreamPacket{
-			Data: []byte("test"),
-		})
+		err := sender.SendJSON([]byte("{}"))
 		require.NoError(t, err)
 		<-ctx.Done()
 		close(doneCh1)
@@ -157,12 +153,10 @@ func TestStreamManager_SubmitStream_DifferentOrgID(t *testing.T) {
 	mockStreamRunner2 := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner2.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		require.Equal(t, "test", req.Path)
 		close(startedCh2)
-		err := sender.Send(&backend.StreamPacket{
-			Data: []byte("test"),
-		})
+		err := sender.SendJSON([]byte("{}"))
 		require.NoError(t, err)
 		<-ctx.Done()
 		close(doneCh2)
@@ -190,7 +184,7 @@ func TestStreamManager_SubmitStream_CloseNoSubscribers(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -218,7 +212,7 @@ func TestStreamManager_SubmitStream_CloseNoSubscribers(t *testing.T) {
 	mockPresenceGetter.EXPECT().GetNumSubscribers("1/test").Return(0, nil).Times(3)

 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
-	mockStreamRunner.EXPECT().RunStream(gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	mockStreamRunner.EXPECT().RunStream(gomock.Any(), gomock.Any(), gomock.Any()).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		close(startedCh)
 		<-ctx.Done()
 		close(doneCh)
@@ -237,7 +231,7 @@ func TestStreamManager_SubmitStream_ErrorRestartsRunStream(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -271,7 +265,7 @@ func TestStreamManager_SubmitStream_ErrorRestartsRunStream(t *testing.T) {
 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		if currentErrors >= numErrors {
 			return nil
 		}
@@ -290,7 +284,7 @@ func TestStreamManager_SubmitStream_NilErrorStopsRunStream(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -309,7 +303,7 @@ func TestStreamManager_SubmitStream_NilErrorStopsRunStream(t *testing.T) {
 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		return nil
 	}).Times(1)

@@ -323,7 +317,7 @@ func TestStreamManager_HandleDatasourceUpdate(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -359,7 +353,7 @@ func TestStreamManager_HandleDatasourceUpdate(t *testing.T) {
 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		if isFirstCall {
 			// first RunStream will wait till context done.
 			isFirstCall = false
@@ -389,7 +383,7 @@ func TestStreamManager_HandleDatasourceDelete(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()

-	mockPacketSender := NewMockStreamPacketSender(mockCtrl)
+	mockPacketSender := NewMockChannelSender(mockCtrl)
 	mockPresenceGetter := NewMockPresenceGetter(mockCtrl)
 	mockContextGetter := NewMockPluginContextGetter(mockCtrl)

@@ -422,7 +416,7 @@ func TestStreamManager_HandleDatasourceDelete(t *testing.T) {
 	mockStreamRunner := NewMockStreamRunner(mockCtrl)
 	mockStreamRunner.EXPECT().RunStream(
 		gomock.Any(), gomock.Any(), gomock.Any(),
-	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender backend.StreamPacketSender) error {
+	).DoAndReturn(func(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
 		close(doneCh)
 		<-ctx.Done()
 		return ctx.Err()
--- a/pkg/services/live/runstream/mock.go
+++ b/pkg/services/live/runstream/mock.go
@@ -1,5 +1,5 @@
 // Code generated by MockGen. DO NOT EDIT.
-// Source: github.com/grafana/grafana/pkg/services/live/runstream (interfaces: StreamPacketSender,PresenceGetter,StreamRunner,PluginContextGetter)
+// Source: github.com/grafana/grafana/pkg/services/live/runstream (interfaces: ChannelSender,PresenceGetter,StreamRunner,PluginContextGetter)

 // Package runstream is a generated GoMock package.
 package runstream
@@ -13,31 +13,31 @@ import (
 	models "github.com/grafana/grafana/pkg/models"
 )

-// MockStreamPacketSender is a mock of StreamPacketSender interface.
-type MockStreamPacketSender struct {
+// MockChannelSender is a mock of ChannelSender interface.
+type MockChannelSender struct {
 	ctrl     *gomock.Controller
-	recorder *MockStreamPacketSenderMockRecorder
+	recorder *MockChannelSenderMockRecorder
 }

-// MockStreamPacketSenderMockRecorder is the mock recorder for MockStreamPacketSender.
-type MockStreamPacketSenderMockRecorder struct {
-	mock *MockStreamPacketSender
+// MockChannelSenderMockRecorder is the mock recorder for MockChannelSender.
+type MockChannelSenderMockRecorder struct {
+	mock *MockChannelSender
 }

-// NewMockStreamPacketSender creates a new mock instance.
-func NewMockStreamPacketSender(ctrl *gomock.Controller) *MockStreamPacketSender {
-	mock := &MockStreamPacketSender{ctrl: ctrl}
-	mock.recorder = &MockStreamPacketSenderMockRecorder{mock}
+// NewMockChannelSender creates a new mock instance.
+func NewMockChannelSender(ctrl *gomock.Controller) *MockChannelSender {
+	mock := &MockChannelSender{ctrl: ctrl}
+	mock.recorder = &MockChannelSenderMockRecorder{mock}
 	return mock
 }

 // EXPECT returns an object that allows the caller to indicate expected use.
-func (m *MockStreamPacketSender) EXPECT() *MockStreamPacketSenderMockRecorder {
+func (m *MockChannelSender) EXPECT() *MockChannelSenderMockRecorder {
 	return m.recorder
 }

 // Send mocks base method.
-func (m *MockStreamPacketSender) Send(arg0 string, arg1 *backend.StreamPacket) error {
+func (m *MockChannelSender) Send(arg0 string, arg1 []byte) error {
 	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "Send", arg0, arg1)
 	ret0, _ := ret[0].(error)
@@ -45,9 +45,9 @@ func (m *MockStreamPacketSender) Send(arg0 string, arg1 *backend.StreamPacket) e
 }

 // Send indicates an expected call of Send.
-func (mr *MockStreamPacketSenderMockRecorder) Send(arg0, arg1 interface{}) *gomock.Call {
+func (mr *MockChannelSenderMockRecorder) Send(arg0, arg1 interface{}) *gomock.Call {
 	mr.mock.ctrl.T.Helper()
-	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Send", reflect.TypeOf((*MockStreamPacketSender)(nil).Send), arg0, arg1)
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Send", reflect.TypeOf((*MockChannelSender)(nil).Send), arg0, arg1)
 }

 // MockPresenceGetter is a mock of PresenceGetter interface.
@@ -112,7 +112,7 @@ func (m *MockStreamRunner) EXPECT() *MockStreamRunnerMockRecorder {
 }

 // RunStream mocks base method.
-func (m *MockStreamRunner) RunStream(arg0 context.Context, arg1 *backend.RunStreamRequest, arg2 backend.StreamPacketSender) error {
+func (m *MockStreamRunner) RunStream(arg0 context.Context, arg1 *backend.RunStreamRequest, arg2 *backend.StreamSender) error {
 	m.ctrl.T.Helper()
 	ret := m.ctrl.Call(m, "RunStream", arg0, arg1, arg2)
 	ret0, _ := ret[0].(error)