feat(eventpayload): add GetEventSource() to EventPayload interface

this design (as opposed to adding a Source field to the Event struct)
requires fewer changes to existing APIs while still supporting the two
primary cases for event sources:
1. an event that always has the same source can just return a hard-coded
string
2. an event that can come from multiple components (or from plugins) can
have a source field that gets returned by this function

example/plugins/api-call-example/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/debugger/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/dynamic-capture-example/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/event-subscriber-example/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/helloworld/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/restful-example/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/static-capture-example/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

example/plugins/upnp/mod/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data

src/mod/plugins/zoraxy_plugin/events/events.go

@@ -12,6 +12,9 @@ type EventName string
 type EventPayload interface {
 	// GetName returns the event type
 	GetName() EventName
+
+	// Returns the "source" of the event, that is, the component or plugin that emitted the event
+	GetEventSource() string
 }
 
 // Event represents a system event
@@ -62,6 +65,10 @@ func (e *BlacklistedIPBlockedEvent) GetName() EventName {
 	return EventBlacklistedIPBlocked
 }
 
+func (e *BlacklistedIPBlockedEvent) GetEventSource() string {
+	return "proxy-access"
+}
+
 // BlacklistToggledEvent represents an event when the blacklist is disabled for an access rule
 type BlacklistToggledEvent struct {
 	RuleID  string `json:"rule_id"`
@@ -72,6 +79,10 @@ func (e *BlacklistToggledEvent) GetName() EventName {
 	return EventBlacklistToggled
 }
 
+func (e *BlacklistToggledEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // AccessRuleCreatedEvent represents an event when a new access ruleset is created
 type AccessRuleCreatedEvent struct {
 	ID               string `json:"id"`
@@ -85,6 +96,10 @@ func (e *AccessRuleCreatedEvent) GetName() EventName {
 	return EventAccessRuleCreated
 }
 
+func (e *AccessRuleCreatedEvent) GetEventSource() string {
+	return "accesslist-api"
+}
+
 // ParseEvent parses a JSON byte slice into an Event struct
 func ParseEvent(jsonData []byte, event *Event) error {
 	// First, determine the event type, and parse shared fields, from the JSON data