eda

README

KPS Go Library - Event Driven Architecture

Overview

Standard Event

Unio

Event Bus

Rules Engine

Rule Definition

Documentation

Overview

********************************************************************************** The MIT License (MIT)

Copyright (c) 2022 Sean Beard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **********************************************************************************

********************************************************************************** The MIT License (MIT)

Copyright (c) 2022 Sean Beard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **********************************************************************************

********************************************************************************** The MIT License (MIT)

Copyright (c) 2022 Sean Beard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **********************************************************************************

Index

• type BusType
  • func BusTypeFromString(busTypeString string) BusType
  • func (busType BusType) String() string
• type Event
  • func GetDefaultEvent() *Event
  • func NewEventFromHTTPRequest(req *http.Request) (*Event, error)
  • func (event Event) EventSource() *string
  • func (event Event) EventTime() *time.Time
  • func (event Event) GetEventAsHTTPRequest() (*http.Request, error)
  • func (event Event) JSON() []byte
  • func (event Event) MarshalJSON() ([]byte, error)
  • func (event Event) MarshalYAML() ([]byte, error)
  • func (event Event) Schema() *string
  • func (event *Event) UnmarshalJSON(data []byte) error
  • func (event *Event) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (event Event) YAML() []byte
• type EventBusConfiguration
• type EventConfiguration
• type EventbridgeEvent

Types

type BusType

type BusType int

BusType represents an enumeration for the different support bus types

const (
	// UNIO represents the Unio event bus
	UNIO BusType = iota
	// EVENTBRIDGE represents the AWS EventBridge event bus
	EVENTBRIDGE
	// EVENTGRID representrs the Azure event bus
	EVENTGRID
	// SERVICE represents simply sending an event to a service endpoint
	SERVICE
	// NOBUS rerpesents a Noop for a non-existant bus
	NOBUS
)

func BusTypeFromString

func BusTypeFromString(busTypeString string) BusType

BusTypeFromString converts a string to the appropriate BusType value

func (BusType) String

func (busType BusType) String() string

String takes the the current BusType enum and returns the string representation

type Event

type Event struct {
	Data            interface{} `json:"data,omitempty" yaml:"data.omitempty"`
	Time            time.Time   `json:"time" yaml:"time"`
	ID              string      `json:"id" yaml:"id"`
	DetailType      string      `json:"detailtype" yaml:"detailtype"`
	SpecVersion     string      `json:"specversion" yaml:"specversion"`
	Type            string      `json:"type,omitempty" yaml:"type"`
	Subject         string      `json:"subject,omitempty" yaml:"subject"`
	Source          string      `json:"source,omitempty" yaml:"source"`
	DataContentType string      `json:"datacontenttype,omitempty" yaml:"datacontenttype.omitempty"`
}

Event represents an event passed through an event bus to process. This roughly

func GetDefaultEvent

func GetDefaultEvent() *Event

GetDefaultEvent creates a new event and populates the with generic default (empty) values

func NewEventFromHTTPRequest

func NewEventFromHTTPRequest(req *http.Request) (*Event, error)

NewEventFromHTTPRequest populates a new event from an HTTP Request. If an error occurs an error is returned

func (Event) EventSource

func (event Event) EventSource() *string

EventSource implements the AWSEvent interface and returns a pointer to the Source string

func (Event) EventTime

func (event Event) EventTime() *time.Time

EventTime implements the AWSEvent interface and returns the event time

func (Event) GetEventAsHTTPRequest

func (event Event) GetEventAsHTTPRequest() (*http.Request, error)

GetEventAsHTTPRequest converts the current event to an HTTP Request, where custom http headers represent the event metadata and the request body is the event data

func (Event) JSON

func (event Event) JSON() []byte

JSON returns a json string in a byte slice

func (Event) MarshalJSON

func (event Event) MarshalJSON() ([]byte, error)

MarshalJSON is a method allowing serialization of the ReferenceEvent

func (Event) MarshalYAML

func (event Event) MarshalYAML() ([]byte, error)

MarshalYAML is a method allowing serialization of the Event

func (Event) Schema

func (event Event) Schema() *string

Schema implements the AWSEvent interface and returns the JSON schema for the Event, allowing the calling object to parse the incoming event object

func (*Event) UnmarshalJSON

func (event *Event) UnmarshalJSON(data []byte) error

UnmarshalJSON is a method implemented allowing de-serialization of the ReferenceEvent

func (*Event) UnmarshalYAML

func (event *Event) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML is a method implemented allowing de-serialization of the Event

func (Event) YAML

func (event Event) YAML() []byte

YAML returns a yaml string in a byte slice

type EventBusConfiguration

type EventBusConfiguration struct {
	DataPlane    map[string]string `json:"databuses" env:"EDA_DATA_PLANE" envMapValueSeparator:"|"`
	ComputePlane map[string]string `json:"eventbuses,omitempty" env:"EDA_COMPUTE_PLANE" envMapValueSeparator:"|"`
	Create       bool              `json:"createbuses" env:"EDA_CREATE_BUSES"`
}

EventBusConfiguration holds all of the relevant event bus configuration data allowing a service to send and receive eventsr via the defined buses

type EventConfiguration

type EventConfiguration struct {
	EventParam string
	Condition  string
	Action     string
}

type EventbridgeEvent

type EventbridgeEvent struct {
	Detail     Event    `json:"detail"`
	Resources  []string `json:"resources"`
	Time       string   `json:"time"`
	Account    string   `json:"account"`
	DetailType string   `json:"detail-type"`
	ID         string   `json:"id"`
	Region     string   `json:"region"`
	Source     string   `json:"source"`
	Version    string   `json:"version"`
}

EventbridgeEvent represents an AWS event that is is recieved from EventBridge