filter webhook (#1243)

* add webhook filter to protobuf and ensure IsAllowed checked
* generated protobuf

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

Author: barrust

livekit/livekit_models.pb.go

@@ -176,7 +176,7 @@ message ParticipantInfo {
   DisconnectReason disconnect_reason = 16;
   repeated KindDetail kind_details = 18;
 
-  // NEXT_ID: 19 
+  // NEXT_ID: 19
 }
 
 enum TrackType {
@@ -310,7 +310,7 @@ message EncryptedPacket {
   Encryption.Type encryption_type = 1;
   bytes iv = 2;
   uint32 key_index = 3;
-  bytes encrypted_value = 4; // This is an encrypted EncryptedPacketPayload message representation 
+  bytes encrypted_value = 4; // This is an encrypted EncryptedPacketPayload message representation
 }
 
 message EncryptedPacketPayload {
@@ -757,13 +757,18 @@ message DataStream {
   }
 }
 
+message FilterParams {
+  repeated string include_events = 1;
+  repeated string exclude_events = 2;
+}
+
 message WebhookConfig {
   string url = 1;
   string signing_key = 2;
+  FilterParams filter_params = 3;
 }
 
 message SubscribedAudioCodec {
   string codec = 1;
   bool enabled = 2;
 }
-

protobufs/livekit_models.proto

@@ -30,6 +30,8 @@ func (f *filter) SetFilter(params FilterParams) {
 	f.params = params
 }
 
+// IncludeEvents and ExcludeEvents are mutually exclusive; only one will be checked
+// if neither are set, the event will be allowed
 func (f *filter) IsAllowed(event string) bool {
 	// includes get higher precendence than excludes
 	if len(f.params.IncludeEvents) != 0 {
@@ -40,6 +42,5 @@ func (f *filter) IsAllowed(event string) bool {
 		return !slices.Contains(f.params.ExcludeEvents, event)
 	}
 
-	// default allow
 	return true
 }

webhook/filter.go

@@ -31,11 +31,13 @@ type WebHookConfig struct {
 	APIKey              string                    `yaml:"api_key,omitempty"`
 	URLNotifier         URLNotifierConfig         `yaml:"url_notifier,omitempty"`
 	ResourceURLNotifier ResourceURLNotifierConfig `yaml:"resource_url_notifier,omitempty"`
+	FilterParams        FilterParams              `yaml:"filter_params,omitempty"`
 }
 
 var DefaultWebHookConfig = WebHookConfig{
 	URLNotifier:         DefaultURLNotifierConfig,
 	ResourceURLNotifier: DefaultResourceURLNotifierConfig,
+	FilterParams:        FilterParams{},
 }
 
 type NotifyParams struct {
@@ -83,11 +85,12 @@ func NewDefaultNotifier(config WebHookConfig, kp auth.KeyProvider) (QueuedNotifi
 	}
 	for _, url := range config.URLs {
 		u := NewResourceURLNotifier(ResourceURLNotifierParams{
-			URL:       url,
-			Logger:    logger.GetLogger().WithComponent("webhook"),
-			APIKey:    config.APIKey,
-			APISecret: apiSecret,
-			Config:    config.ResourceURLNotifier,
+			URL:          url,
+			Logger:       logger.GetLogger().WithComponent("webhook"),
+			APIKey:       config.APIKey,
+			APISecret:    apiSecret,
+			Config:       config.ResourceURLNotifier,
+			FilterParams: config.FilterParams,
 		})
 		n.notifiers = append(n.notifiers, u)
 	}

webhook/notifier.go

@@ -156,6 +156,10 @@ func (r *ResourceURLNotifier) SetFilter(params FilterParams) {
 	r.filter.SetFilter(params)
 }
 
+func (r *ResourceURLNotifier) IsAllowed(event string) bool {
+	return r.filter.IsAllowed(event)
+}
+
 func (r *ResourceURLNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo)) {
 	r.mu.Lock()
 	defer r.mu.Unlock()

webhook/resource_url_notifier.go

@@ -33,11 +33,6 @@ import (
 	"github.com/livekit/protocol/logger"
 )
 
-const (
-	numWorkers       = 10
-	defaultQueueSize = 100
-)
-
 type URLNotifierConfig struct {
 	NumWorkers int `yaml:"num_workers,omitempty"`
 	QueueSize  int `yaml:"queue_size,omitempty"`
@@ -123,6 +118,10 @@ func (n *URLNotifier) SetFilter(params FilterParams) {
 	n.filter.SetFilter(params)
 }
 
+func (n *URLNotifier) IsAllowed(event string) bool {
+	return n.filter.IsAllowed(event)
+}
+
 func (n *URLNotifier) RegisterProcessedHook(hook func(ctx context.Context, whi *livekit.WebhookInfo)) {
 	n.mu.Lock()
 	defer n.mu.Unlock()