feat(eventsystem): plumbing for plugin<->plugin comms

The only thing left is to add an API endpoint for broadcasting
EventCustom events (other event types should not be emittible by
plugins, the use-case isn't there since plugins can already talk to
Zoraxy via the API).
Input to the endput should be a json-encoded `CustomEvent`

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}

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

@@ -20,10 +20,8 @@ type EventPayload interface {
 // Event represents a system event
 type Event struct {
 	Name      EventName    `json:"name"`
-	// Unix timestamp
-	Timestamp int64        `json:"timestamp"`
-	// UUID for the event
-	UUID      string       `json:"uuid"`
+	Timestamp int64        `json:"timestamp"` // Unix timestamp
+	UUID      string       `json:"uuid"`      // UUID for the event
 	Data      EventPayload `json:"data"`
 }
 
@@ -34,6 +32,9 @@ const (
 	EventBlacklistToggled EventName = "blacklistToggled"
 	// EventAccessRuleCreated is emitted when a new access ruleset is created
 	EventAccessRuleCreated EventName = "accessRuleCreated"
+	// A custom event emitted by a plugin, with the intention of being broadcast
+	// to the designated recipient(s)
+	EventCustom EventName = "customEvent"
 
 	// Add more event types as needed
 )
@@ -42,6 +43,7 @@ var validEventNames = map[EventName]bool{
 	EventBlacklistedIPBlocked: true,
 	EventBlacklistToggled:     true,
 	EventAccessRuleCreated:    true,
+	EventCustom:               true,
 	// Add more event types as needed
 	// NOTE: Keep up-to-date with event names specified above
 }
@@ -100,6 +102,20 @@ func (e *AccessRuleCreatedEvent) GetEventSource() string {
 	return "accesslist-api"
 }
 
+type CustomEvent struct {
+	SourcePlugin string         `json:"source_plugin"`
+	Recipients   []string       `json:"recipients"`
+	Payload      map[string]any `json:"payload"`
+}
+
+func (e *CustomEvent) GetName() EventName {
+	return EventCustom
+}
+
+func (e *CustomEvent) GetEventSource() string {
+	return e.SourcePlugin
+}
+
 // 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
@@ -146,6 +162,15 @@ func ParseEvent(jsonData []byte, event *Event) error {
 			return err
 		}
 		event.Data = &payload.Data
+	case EventCustom:
+		type tempData struct {
+			Data CustomEvent `json:"data"`
+		}
+		var payload tempData
+		if err := json.Unmarshal(jsonData, &payload); err != nil {
+			return err
+		}
+		event.Data = &payload.Data
 	default:
 		return fmt.Errorf("unknown event: %s, %v", temp.Name, jsonData)
 	}