Merge pull request #7 from SebUndefined/lastfeatures

WIP: benchmarks & README tweaks

Author: SebUndefined

Makefile

@@ -19,4 +19,10 @@ test-race: ## run tests with race detector
 	go test -race -count=1 ./...
 
 test-race-cover: ## run tests with race detector and coverage
-	go test -race -count=1 -coverprofile=coverage.out ./...
+	go test -race -count=1 -coverprofile=coverage.out ./...
+
+test-bench: ## run benchmark tests
+	go test -bench -v ./...
+
+test-bench-mem: ## with mem and allocation
+	go test -bench=. -benchmem -benchtime=2s ./...

README.md

@@ -92,6 +92,20 @@ kind of in-process system (adding config, per subscriber strategy...)
 - Clean abstractions with good defaults
 - Plays well with tests, mocks, and small services
 
+## 📈 Benchmark
+
+```shell
+go test -bench=. -benchmem -benchtime=2s ./...
+goos: darwin
+goarch: arm64
+pkg: github.com/sebundefined/thebus
+cpu: Apple M4 Pro
+BenchmarkBus_Publish_NoSubscriber-14                   	62964634	        38.04 ns/op	6729.34 MB/s	       0 B/op	       0 allocs/op
+BenchmarkBus_Publish_CopyOnPublish_NoSubscriber-14     	62382220	        38.36 ns/op	6673.82 MB/s	       0 B/op	       0 allocs/op
+BenchmarkBus_Publish_OneSubscriber-14                  	60785077	        40.02 ns/op	6397.49 MB/s	       0 B/op	       0 allocs/op
+BenchmarkBus_Publish_CopyOnPublish_OneSubscriber-14    	60166773	        39.96 ns/op	6406.85 MB/s	       0 B/op	       0 allocs/op
+```
+
 ## 🧪 Testing
 
 Run the full suite:

bench_test.go

@@ -1 +1,110 @@
-package thebus
+package thebus_test
+
+import (
+	"context"
+	"testing"
+
+	"github.com/sebundefined/thebus"
+)
+
+func BenchmarkBus_Publish_NoSubscriber(b *testing.B) {
+	bus, _ := thebus.New()
+	b.Cleanup(func() {
+		_ = bus.Close()
+	})
+
+	payload := make([]byte, 256)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(payload)))
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := bus.Publish("benchmark/no-subscriber", payload)
+		if err != nil {
+			b.Fatalf("publish fail: %s", err)
+		}
+	}
+}
+
+func BenchmarkBus_Publish_CopyOnPublish_NoSubscriber(b *testing.B) {
+	bus, _ := thebus.New(thebus.WithCopyOnPublish(true))
+	b.Cleanup(func() {
+		_ = bus.Close()
+	})
+
+	payload := make([]byte, 256)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(payload)))
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := bus.Publish("benchmark/no-subscriber", payload)
+		if err != nil {
+			b.Fatalf("publish fail: %s", err)
+		}
+	}
+}
+
+func BenchmarkBus_Publish_OneSubscriber(b *testing.B) {
+	bus, _ := thebus.New()
+	b.Cleanup(func() {
+		_ = bus.Close()
+	})
+	ctx, cancelFunc := context.WithCancel(context.Background())
+	b.Cleanup(cancelFunc)
+
+	subscriber, err := bus.Subscribe(ctx, "benchmark/one-subscriber",
+		thebus.WithBufferSize(1<<16),
+		thebus.WithDropIfFull(true))
+	if err != nil {
+		b.Fatalf("subscribe fail: %s", err)
+	}
+	go func() {
+		for range subscriber.Read() {
+
+		}
+	}()
+	payload := make([]byte, 256)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(payload)))
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := bus.Publish("benchmark/no-subscriber", payload)
+		if err != nil {
+			b.Fatalf("publish fail: %s", err)
+		}
+	}
+}
+
+func BenchmarkBus_Publish_CopyOnPublish_OneSubscriber(b *testing.B) {
+	bus, _ := thebus.New(thebus.WithCopyOnPublish(true))
+	b.Cleanup(func() {
+		_ = bus.Close()
+	})
+	ctx, cancelFunc := context.WithCancel(context.Background())
+	b.Cleanup(cancelFunc)
+
+	subscriber, err := bus.Subscribe(ctx, "benchmark/one-subscriber",
+		thebus.WithBufferSize(1<<16),
+		thebus.WithDropIfFull(true))
+	if err != nil {
+		b.Fatalf("subscribe fail: %s", err)
+	}
+	go func() {
+		for range subscriber.Read() {
+
+		}
+	}()
+	payload := make([]byte, 256)
+	b.ReportAllocs()
+	b.SetBytes(int64(len(payload)))
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		_, err := bus.Publish("benchmark/no-subscriber", payload)
+		if err != nil {
+			b.Fatalf("publish fail: %s", err)
+		}
+	}
+}