IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Rename AddEventListenerCtx to AddEventListener and PublishCtx to Publish (#43566)

Browse Source
This commit is contained in:
idafurjes 2022-01-04 09:36:01 +01:00 committed by GitHub
parent a0cf57b5b8
commit 65e60759fb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/api/org_invite.go
View File

@ -206,7 +206,7 @@ func (hs *HTTPServer) CompleteInvite(c *models.ReqContext) response.Response {
return response.Error(500, "failed to create user", err) return response.Error(500, "failed to create user", err)
} }
if err := bus.PublishCtx(c.Req.Context(), &events.SignUpCompleted{ if err := bus.Publish(c.Req.Context(), &events.SignUpCompleted{
Name: user.NameOrFallback(), Name: user.NameOrFallback(),
Email: user.Email, Email: user.Email,
}); err != nil { }); err != nil {

4
pkg/api/signup.go
View File

@ -55,7 +55,7 @@ func SignUp(c *models.ReqContext) response.Response {
return response.Error(500, "Failed to create signup", err) return response.Error(500, "Failed to create signup", err)
} }
if err := bus.PublishCtx(c.Req.Context(), &events.SignUpStarted{ if err := bus.Publish(c.Req.Context(), &events.SignUpStarted{
Email: form.Email, Email: form.Email,
Code: cmd.Code, Code: cmd.Code,
}); err != nil { }); err != nil {
@ -102,7 +102,7 @@ func (hs *HTTPServer) SignUpStep2(c *models.ReqContext) response.Response {
} }
// publish signup event // publish signup event
if err := bus.PublishCtx(c.Req.Context(), &events.SignUpCompleted{ if err := bus.Publish(c.Req.Context(), &events.SignUpCompleted{
Email: user.Email, Email: user.Email,
Name: user.NameOrFallback(), Name: user.NameOrFallback(),
}); err != nil { }); err != nil {

16
pkg/bus/bus.go
View File

@ -29,7 +29,7 @@ type TransactionManager interface {
type Bus interface { type Bus interface {
Dispatch(ctx context.Context, msg Msg) error Dispatch(ctx context.Context, msg Msg) error
PublishCtx(ctx context.Context, msg Msg) error Publish(ctx context.Context, msg Msg) error
// InTransaction starts a transaction and store it in the context. // InTransaction starts a transaction and store it in the context.
// The caller can then pass a function with multiple DispatchCtx calls that // The caller can then pass a function with multiple DispatchCtx calls that
@ -39,7 +39,7 @@ type Bus interface {
AddHandler(handler HandlerFunc) AddHandler(handler HandlerFunc)
AddEventListenerCtx(handler HandlerFunc) AddEventListener(handler HandlerFunc)
// SetTransactionManager allows the user to replace the internal // SetTransactionManager allows the user to replace the internal
// noop TransactionManager that is responsible for managing // noop TransactionManager that is responsible for managing
@ -127,7 +127,7 @@ func (b *InProcBus) Dispatch(ctx context.Context, msg Msg) error {
} }
// PublishCtx function publish a message to the bus listener. // PublishCtx function publish a message to the bus listener.
func (b *InProcBus) PublishCtx(ctx context.Context, msg Msg) error { func (b *InProcBus) Publish(ctx context.Context, msg Msg) error {
var msgName = reflect.TypeOf(msg).Elem().Name() var msgName = reflect.TypeOf(msg).Elem().Name()
var params = []reflect.Value{} var params = []reflect.Value{}
@ -183,7 +183,7 @@ func (b *InProcBus) GetHandlerCtx(name string) HandlerFunc {
return b.handlersWithCtx[name] return b.handlersWithCtx[name]
} }
func (b *InProcBus) AddEventListenerCtx(handler HandlerFunc) { func (b *InProcBus) AddEventListener(handler HandlerFunc) {
handlerType := reflect.TypeOf(handler) handlerType := reflect.TypeOf(handler)
eventName := handlerType.In(1).Elem().Name() eventName := handlerType.In(1).Elem().Name()
_, exists := b.listenersWithCtx[eventName] _, exists := b.listenersWithCtx[eventName]
@ -201,16 +201,16 @@ func AddHandler(implName string, handler HandlerFunc) {
// AddEventListenerCtx attaches a handler function to the event listener. // AddEventListenerCtx attaches a handler function to the event listener.
// Package level function. // Package level function.
func AddEventListenerCtx(handler HandlerFunc) { func AddEventListener(handler HandlerFunc) {
globalBus.AddEventListenerCtx(handler) globalBus.AddEventListener(handler)
} }
func Dispatch(ctx context.Context, msg Msg) error { func Dispatch(ctx context.Context, msg Msg) error {
return globalBus.Dispatch(ctx, msg) return globalBus.Dispatch(ctx, msg)
} }
func PublishCtx(ctx context.Context, msg Msg) error { func Publish(ctx context.Context, msg Msg) error {
return globalBus.PublishCtx(ctx, msg) return globalBus.Publish(ctx, msg)
} }
func GetHandlerCtx(name string) HandlerFunc { func GetHandlerCtx(name string) HandlerFunc {

20
pkg/bus/bus_test.go
View File

@ -127,12 +127,12 @@ func TestEventPublish(t *testing.T) {
var invoked bool var invoked bool
bus.AddEventListenerCtx(func(ctx context.Context, query *testQuery) error { bus.AddEventListener(func(ctx context.Context, query *testQuery) error {
invoked = true invoked = true
return nil return nil
}) })
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
require.True(t, invoked) require.True(t, invoked)
@ -141,7 +141,7 @@ func TestEventPublish(t *testing.T) {
func TestEventPublish_NoRegisteredListener(t *testing.T) { func TestEventPublish_NoRegisteredListener(t *testing.T) {
bus := New() bus := New()
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
} }
@ -150,12 +150,12 @@ func TestEventCtxPublishCtx(t *testing.T) {
var invoked bool var invoked bool
bus.AddEventListenerCtx(func(ctx context.Context, query *testQuery) error { bus.AddEventListener(func(ctx context.Context, query *testQuery) error {
invoked = true invoked = true
return nil return nil
}) })
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
require.True(t, invoked) require.True(t, invoked)
@ -164,7 +164,7 @@ func TestEventCtxPublishCtx(t *testing.T) {
func TestEventPublishCtx_NoRegisteredListener(t *testing.T) { func TestEventPublishCtx_NoRegisteredListener(t *testing.T) {
bus := New() bus := New()
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
} }
@ -173,12 +173,12 @@ func TestEventPublishCtx(t *testing.T) {
var invoked bool var invoked bool
bus.AddEventListenerCtx(func(ctx context.Context, query *testQuery) error { bus.AddEventListener(func(ctx context.Context, query *testQuery) error {
invoked = true invoked = true
return nil return nil
}) })
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
require.True(t, invoked) require.True(t, invoked)
@ -189,12 +189,12 @@ func TestEventCtxPublish(t *testing.T) {
var invoked bool var invoked bool
bus.AddEventListenerCtx(func(ctx context.Context, query *testQuery) error { bus.AddEventListener(func(ctx context.Context, query *testQuery) error {
invoked = true invoked = true
return nil return nil
}) })
err := bus.PublishCtx(context.Background(), &testQuery{}) err := bus.Publish(context.Background(), &testQuery{})
require.NoError(t, err, "unable to publish event") require.NoError(t, err, "unable to publish event")
require.True(t, invoked) require.True(t, invoked)

2
pkg/plugins/plugindashboards/service.go
View File

@ -19,7 +19,7 @@ func ProvideService(pluginStore plugins.Store, pluginDashboardManager plugins.Pl
pluginDashboardManager: pluginDashboardManager, pluginDashboardManager: pluginDashboardManager,
logger: log.New("plugindashboards"), logger: log.New("plugindashboards"),
} }
bus.AddEventListenerCtx(s.handlePluginStateChanged) bus.AddEventListener(s.handlePluginStateChanged)
s.updateAppDashboards() s.updateAppDashboards()
return s return s
} }

4
pkg/services/notifications/notifications.go
View File

@ -38,8 +38,8 @@ func ProvideService(bus bus.Bus, cfg *setting.Cfg) (*NotificationService, error)
ns.Bus.AddHandler(ns.sendEmailCommandHandlerSync) ns.Bus.AddHandler(ns.sendEmailCommandHandlerSync)
ns.Bus.AddHandler(ns.SendWebhookSync) ns.Bus.AddHandler(ns.SendWebhookSync)
ns.Bus.AddEventListenerCtx(ns.signUpStartedHandler) ns.Bus.AddEventListener(ns.signUpStartedHandler)
ns.Bus.AddEventListenerCtx(ns.signUpCompletedHandler) ns.Bus.AddEventListener(ns.signUpCompletedHandler)
mailTemplates = template.New("name") mailTemplates = template.New("name")
mailTemplates.Funcs(template.FuncMap{ mailTemplates.Funcs(template.FuncMap{

4
pkg/services/sqlstore/datasource_test.go
View File

@ -97,7 +97,7 @@ func TestDataAccess(t *testing.T) {
sqlStore := InitTestDB(t) sqlStore := InitTestDB(t)
var created *events.DataSourceCreated var created *events.DataSourceCreated
bus.AddEventListenerCtx(func(ctx context.Context, e *events.DataSourceCreated) error { bus.AddEventListener(func(ctx context.Context, e *events.DataSourceCreated) error {
created = e created = e
return nil return nil
}) })
@ -241,7 +241,7 @@ func TestDataAccess(t *testing.T) {
ds := initDatasource(sqlStore) ds := initDatasource(sqlStore)
var deleted *events.DataSourceDeleted var deleted *events.DataSourceDeleted
bus.AddEventListenerCtx(func(ctx context.Context, e *events.DataSourceDeleted) error { bus.AddEventListener(func(ctx context.Context, e *events.DataSourceDeleted) error {
deleted = e deleted = e
return nil return nil
}) })

2
pkg/services/sqlstore/transactions.go
View File

@ -68,7 +68,7 @@ func inTransactionWithRetryCtx(ctx context.Context, engine *xorm.Engine, callbac
if len(sess.events) > 0 { if len(sess.events) > 0 {
for _, e := range sess.events { for _, e := range sess.events {
if err = bus.PublishCtx(ctx, e); err != nil { if err = bus.Publish(ctx, e); err != nil {
tsclogger.Error("Failed to publish event after commit.", "error", err) tsclogger.Error("Failed to publish event after commit.", "error", err)
} }
} }