2026-04-06 09:00:47 +00:00
|
|
|
// Phase C Step 9 — `events` host capability.
|
|
|
|
|
//
|
|
|
|
|
// Plugins that subscribe to events declare topic names in their manifest.
|
|
|
|
|
// At activation time the wazero-tagged build wires each subscription into
|
|
|
|
|
// the WS pub/sub hub via Hub.Subscribe; the default build records the
|
|
|
|
|
// subscription in-memory only.
|
2026-04-07 10:10:38 +02:00
|
|
|
|
2026-04-06 09:00:47 +00:00
|
|
|
package plugin
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"sync"
|
|
|
|
|
)
|
|
|
|
|
|
2026-04-06 22:48:59 +02:00
|
|
|
// Broadcaster is a function that sends a raw JSON payload to a WS channel.
|
|
|
|
|
// channelID=0 broadcasts to all connected clients. It is set by the WS
|
|
|
|
|
// wiring code (api/router.go) so the wazero-tagged build can emit events to
|
|
|
|
|
// clients without importing the ws package (avoids an import cycle).
|
|
|
|
|
type Broadcaster func(channelID int64, payload []byte)
|
|
|
|
|
|
2026-04-06 09:00:47 +00:00
|
|
|
// EventSink is the channel a subscribed plugin reads from. The wazero-tagged
|
|
|
|
|
// build forwards each event to the plugin's `on_event` exported function.
|
|
|
|
|
type EventSink struct {
|
2026-04-06 22:48:59 +02:00
|
|
|
mu sync.Mutex
|
|
|
|
|
subs map[string][]*Instance
|
|
|
|
|
broadcaster Broadcaster // set via SetBroadcaster; nil = no WS delivery
|
2026-04-06 09:00:47 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewEventSink returns a fresh sink. Used by the registry as the central
|
|
|
|
|
// fan-out for plugin event delivery.
|
|
|
|
|
func NewEventSink() *EventSink {
|
|
|
|
|
return &EventSink{subs: make(map[string][]*Instance)}
|
|
|
|
|
}
|
|
|
|
|
|
2026-04-06 22:48:59 +02:00
|
|
|
// SetBroadcaster wires a WS-layer delivery function into the sink so that
|
|
|
|
|
// the wazero-tagged build can push plugin-generated events to WS clients.
|
|
|
|
|
// Safe to call from any goroutine; subsequent Emit calls use the new value.
|
|
|
|
|
func (s *EventSink) SetBroadcaster(b Broadcaster) {
|
|
|
|
|
s.mu.Lock()
|
|
|
|
|
s.broadcaster = b
|
|
|
|
|
s.mu.Unlock()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Emit delivers payload to all WS clients subscribed to channelID (or every
|
|
|
|
|
// client when channelID==0). It is a no-op when no broadcaster has been set.
|
|
|
|
|
// Called by the wazero-tagged build's host-function implementation.
|
|
|
|
|
func (s *EventSink) Emit(channelID int64, payload []byte) {
|
|
|
|
|
if s == nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
s.mu.Lock()
|
|
|
|
|
b := s.broadcaster
|
|
|
|
|
s.mu.Unlock()
|
|
|
|
|
if b != nil {
|
|
|
|
|
b(channelID, payload)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-04-06 09:00:47 +00:00
|
|
|
// Subscribe binds inst to topic. Multiple plugins may subscribe to the same
|
|
|
|
|
// topic — events fan out to every subscriber.
|
2026-07-20 14:36:24 +02:00
|
|
|
//
|
|
|
|
|
// No production code calls Subscribe today (only this package's tests), so
|
|
|
|
|
// subs is always empty at runtime and Dispatch's loop never iterates. The
|
|
|
|
|
// first caller added here turns Dispatch's loop live on the hub's broadcast
|
|
|
|
|
// path — see the SECURITY GATE comment on Dispatch before adding one.
|
2026-04-06 09:00:47 +00:00
|
|
|
func (s *EventSink) Subscribe(topic string, inst *Instance) error {
|
|
|
|
|
if !inst.Manifest.HasCapability(CapEvents) {
|
|
|
|
|
return ErrCapabilityNotGranted
|
|
|
|
|
}
|
|
|
|
|
s.mu.Lock()
|
|
|
|
|
defer s.mu.Unlock()
|
|
|
|
|
s.subs[topic] = append(s.subs[topic], inst)
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// UnsubscribeAll removes every subscription owned by inst (called on disable).
|
|
|
|
|
func (s *EventSink) UnsubscribeAll(inst *Instance) {
|
|
|
|
|
s.mu.Lock()
|
|
|
|
|
defer s.mu.Unlock()
|
|
|
|
|
for topic, list := range s.subs {
|
|
|
|
|
kept := list[:0]
|
|
|
|
|
for _, e := range list {
|
|
|
|
|
if e != inst {
|
|
|
|
|
kept = append(kept, e)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if len(kept) == 0 {
|
|
|
|
|
delete(s.subs, topic)
|
|
|
|
|
} else {
|
|
|
|
|
s.subs[topic] = kept
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-07-20 14:10:02 +02:00
|
|
|
// Dispatch invokes every subscriber's on_event for topic.
|
|
|
|
|
//
|
|
|
|
|
// SECURITY GATE (audit 2026-04-07 finding #4 — "no rate limit on event
|
2026-07-20 14:36:24 +02:00
|
|
|
// delivery to plugins"). Read this before adding anything to the loop below.
|
|
|
|
|
//
|
|
|
|
|
// Dispatch already has a production caller: ws/hub.go calls it on every
|
|
|
|
|
// broadcast message when an operator has enabled plugins (api/router.go wires
|
|
|
|
|
// h.pluginSink whenever the registry is non-nil). That call site runs on the
|
|
|
|
|
// hub's broadcast goroutine while seqMu is held, so anything this function
|
|
|
|
|
// does is on the hub's hot path and must not block or re-enter the hub.
|
|
|
|
|
//
|
|
|
|
|
// Guest delivery is nonetheless NOT implemented in either build: the loop
|
|
|
|
|
// below touches no module, and no production code calls Subscribe (only this
|
|
|
|
|
// package's tests), so subs is empty and the loop never iterates. No guest
|
|
|
|
|
// code executes on the event path today — that, not an absent call site, is
|
|
|
|
|
// why a plugin cannot currently slow the hub by handling events slowly.
|
|
|
|
|
//
|
|
|
|
|
// Wiring guest delivery is what makes the finding real, so whoever does it
|
|
|
|
|
// must land, in the same change:
|
2026-07-20 14:10:02 +02:00
|
|
|
//
|
|
|
|
|
// - a per-plugin delivery rate limit (drop, never block the caller), and
|
|
|
|
|
// - the same per-call CPU-budget deadline invokeCommand applies
|
|
|
|
|
// (sandbox_wazero.go), and
|
|
|
|
|
// - delivery off the hub's broadcast goroutine so a slow guest cannot
|
2026-07-20 14:36:24 +02:00
|
|
|
// backpressure fan-out to WS clients or extend the seqMu hold.
|
2026-07-20 14:10:02 +02:00
|
|
|
//
|
|
|
|
|
// Until then this stays inert on purpose.
|
2026-04-06 09:00:47 +00:00
|
|
|
func (s *EventSink) Dispatch(ctx context.Context, topic string, payload []byte) {
|
|
|
|
|
s.mu.Lock()
|
|
|
|
|
subs := append([]*Instance(nil), s.subs[topic]...)
|
|
|
|
|
s.mu.Unlock()
|
|
|
|
|
for _, inst := range subs {
|
2026-04-06 22:48:59 +02:00
|
|
|
_ = inst // wazero-tagged build calls inst.module.invoke("on_event", payload)
|
2026-04-06 09:00:47 +00:00
|
|
|
_ = ctx
|
|
|
|
|
_ = payload
|
|
|
|
|
}
|
|
|
|
|
}
|