Enable go plugins to send events #2692
Conversation
Signed-off-by: Sam Foo <[email protected]> Co-authored-by: Liam Rathke <[email protected]>
GuessWhoSamFoo
force-pushed
the
send-event
branch
from
08bca0c
to
f2b531c
Compare
| @@ -379,14 +380,18 @@ func (c *grpcServer) ForceFrontendUpdate(ctx context.Context, _ *proto.Empty) (* | |||
| return &proto.Empty{}, nil | |||
| } | |||
|
|
|||
| // SendAlert sends an alert | |||
| // SendAlert sends an alert. This method is deprecated and will be removed in a future release | |||
There was a problem hiding this comment.
Just to be clear, we'd just need to deprecate it from the server side, right? As in, we could modify SendAlert() in client.go to call client.SendEvent(), so that plugins sending alerts won't need to be rewritten. I feel like SendAlert() is a good utility to have client-side, since it's widely usable. Were it removed, any plugins would need to re-implement the same code, and it would look almost identical to what we have already anyways.
There was a problem hiding this comment.
The idea is to remove it entirely because it is redundant (and we can do so relatively safely as it is pre 1.0). Otherwise one could argue one should have similar methods for each event type.
The tradeoff is abstracting away knowledge of the required action.Payload keys which is something that could be addressed by creating payload helpers for various events.
There was a problem hiding this comment.
Makes sense, some sort of action/event helpers would be super useful for plugins
What this PR does / why we need it:
Javascript plugins have a
SendEventmethod that is currently not possible with go plugins.see https://github.com/vmware-tanzu/octant/blob/447171cf3ac3c520c3ad3bbe839f8affc6b61cc3/pkg/plugin/javascript/dashboard_send_event.go
This PR allows plugin authors to do the same via:
request.DashboardClient.SendEvent(request.Context(),request.ClientState.ClientID(), event.EventTypeMyEvent, action.Payload{})cc @liamrathke