GoEventBus

README

EventBus lib in Golang!

> Simple event source system

This project lets you publish and subscribe events easily.

To download:

go get github.com/Raezil/GoEventBus

Quick Start

Let's make a pub/sub application:

1. Create a project

mkdir demo
cd demo
go mod init demo

1. Add main.go

Example 1.

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"

	gbus "github.com/Raezil/GoEventBus"

	"github.com/gorilla/mux"
	_ "github.com/lib/pq"
)

// HouseWasSold represents an event for when a house has been sold
type HouseWasSold struct{}

// NewDispatcher initializes the dispatcher with event handlers
func NewDispatcher() *gbus.Dispatcher {
	return &gbus.Dispatcher{
		HouseWasSold{}: func(m map[string]interface{}) (gbus.Result, error) {
			price, ok := m["price"].(int) // Match the correct key "price"
			if !ok {
				return gbus.Result{}, fmt.Errorf("price not provided or invalid")
			}
			result := fmt.Sprintf("House was sold for %d", price)
			log.Println(result)
			return gbus.Result{
				Message: result,
			}, nil
		},
	}
}

func main() {
	// Initialize dispatcher and event store
	dispatcher := NewDispatcher()
	eventstore := gbus.NewEventStore(dispatcher)

	router := mux.NewRouter()
	router.HandleFunc("/house-sold", func(w http.ResponseWriter, r *http.Request) {
		// Publish the event with the correct key "price"
		eventstore.Publish(gbus.NewEvent(
			HouseWasSold{},
			map[string]interface{}{
				"price": 100,
			},
		))

		// Broadcast the event after publishing, wait for completion
		if err := eventstore.Broadcast(); err != nil {
			log.Printf("Error broadcasting event: %v", err)
			http.Error(w, "Failed to process event", http.StatusInternalServerError)
			return
		}

		// Send response back to client
		w.Header().Set("Content-Type", "application/json")
		response := map[string]string{"status": "House sold event published"}
		json.NewEncoder(w).Encode(response)
	})

	serverAddress := ":8080"
	log.Printf("Server is listening on %s", serverAddress)
	if err := http.ListenAndServe(serverAddress, router); err != nil {
		log.Fatalf("Failed to start server: %v", err)
	}
}

Example 2.

package main

import (
	"fmt"
	"log"

	gbus "github.com/Raezil/GoEventBus"

	_ "github.com/lib/pq"
)

// HouseWasSold represents an event for when a house has been sold
type HouseWasSold struct{}

// NewDispatcher initializes the dispatcher with event handlers
func NewDispatcher() *gbus.Dispatcher {
	return &gbus.Dispatcher{
		HouseWasSold{}: func(m map[string]interface{}) (gbus.Result, error) {
			price, ok := m["price"].(int)
			if !ok {
				return gbus.Result{}, fmt.Errorf("price not provided or invalid")
			}
			result := fmt.Sprintf("House was sold for %d", price)
			log.Println(result)
			return gbus.Result{
				Message: result,
			}, nil
		},
	}
}

func main() {
	// Initialize dispatcher and event store
	dispatcher := NewDispatcher()
	eventstore := gbus.NewEventStore(dispatcher)
	eventstore.Publish(gbus.NewEvent(
		HouseWasSold{},
		map[string]interface{}{
			"price": 100,
		},
	))

	eventstore.Publish(gbus.NewEvent(
		HouseWasSold{},
		map[string]interface{}{
			"price": 100,
		},
	))
	// Broadcast the event
	eventstore.Broadcast()

}

Example 3

package main

import (
	. "github.com/Raezil/GoEventBus"
	"fmt"
	"log"
)

type HouseWasSoldEvent struct{}

// NewDispatcher initializes the dispatcher with event handlers
func NewDispatcher() *Dispatcher {
	return &Dispatcher{
		HouseWasSoldEvent{}: func(m map[string]interface{}) (Result, error) {
			price, ok := m["price"].(int)
			if !ok {
				return Result{}, fmt.Errorf("price not provided or invalid")
			}
			result := fmt.Sprintf("House was sold for %d", price)
			log.Println(result)
			return Result{
				Message: result,
			}, nil
		},
	}
}

func main() {
	// Initialize dispatcher and event store
	dispatcher := NewDispatcher()
	eventstore := NewEventStoreWithRabbitMq(dispatcher)
	eventstore.PublishToRabbitMQ(NewEvent(
		HouseWasSoldEvent{},
		map[string]interface{}{
			"price": 100,
		},
	))
	// Broadcast the event
	eventstore.BroadcastWithRabbitMq()

}

1. Get the dependency

go get github.com/Shibbaz/GOEventBus@v0.1.6.2

1. Run the project

go run ./

Documentation

Index

• type Dispatcher
• type Event
  • func NewEvent(projection any, args map[string]any) *Event
• type EventStore
  • func NewEventStore(dispatcher *Dispatcher) *EventStore
  • func NewEventStoreWithRabbitMq(dispatcher *Dispatcher) *EventStore
  • func (eventstore *EventStore) Broadcast() error
  • func (eventstore *EventStore) BroadcastWithRabbitMq()
  • func (es *EventStore) CloseRabbitMQ()
  • func (eventstore *EventStore) Commit() error
  • func (eventstore *EventStore) Publish(event *Event)
  • func (eventstore *EventStore) PublishToRabbitMQ(event *Event) error
• type Result

Types

type Dispatcher

type Dispatcher map[any]func(map[string]interface{}) (Result, error)

Dispatcher maps event projections to their respective handler functions

type Event

type Event struct {
	Id         string
	Projection any
	Args       map[string]interface{}
}

func NewEvent

func NewEvent(projection any, args map[string]any) *Event

type EventStore

type EventStore struct {
	Mutex      sync.Mutex
	Dispatcher *Dispatcher
	Events     *sync.Pool
	RabbitMQ   *amqp.Connection
	Channel    *amqp.Channel
}

EventStore handles publishing and dispatching events

func NewEventStore

func NewEventStore(dispatcher *Dispatcher) *EventStore

NewEventStore initializes an EventStore with a dispatcher and an event pool

func NewEventStoreWithRabbitMq

func NewEventStoreWithRabbitMq(dispatcher *Dispatcher) *EventStore

NewEventStore initializes an EventStore with a dispatcher and an event pool

func (*EventStore) Broadcast

func (eventstore *EventStore) Broadcast() error

Broadcast locks the store and processes each event in the pool

func (*EventStore) BroadcastWithRabbitMq

func (eventstore *EventStore) BroadcastWithRabbitMq()

Broadcast sends all stored events to RabbitMQ

func (*EventStore) CloseRabbitMQ

func (es *EventStore) CloseRabbitMQ()

CloseRabbitMQ cleans up RabbitMQ resources

func (*EventStore) Commit

func (eventstore *EventStore) Commit() error

Commit retrieves and processes an event from the pool

func (*EventStore) Publish

func (eventstore *EventStore) Publish(event *Event)

Publish adds an event to the event pool

func (*EventStore) PublishToRabbitMQ

func (eventstore *EventStore) PublishToRabbitMQ(event *Event) error

PublishToRabbitMQ sends an event to RabbitMQ

type Result

type Result struct {
	Message string
}