feat(server): add nats subscription manager (#3522)

kubeshop · Jan 15, 2024 · 29ae31c · 29ae31c
1 parent 7373145
commit 29ae31c
Show file tree

Hide file tree

Showing 30 changed files with 704 additions and 357 deletions.
diff --git a/agent/workers/poller_test.go b/agent/workers/poller_test.go
@@ -7,7 +7,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/davecgh/go-spew/spew"
 	"github.com/kubeshop/tracetest/agent/client"
 	"github.com/kubeshop/tracetest/agent/client/mocks"
 	"github.com/kubeshop/tracetest/agent/collector"
@@ -72,8 +71,6 @@ func TestPollerWorker(t *testing.T) {
 		}
 	}
 
-	spew.Dump(pollingResponse)
-
 	assert.Len(t, spans, 2)
 	assert.Equal(t, "", spans[0].ParentId)
 	assert.Equal(t, spans[0].Id, spans[1].ParentId)

diff --git a/server/app/app.go b/server/app/app.go
@@ -120,12 +120,13 @@ func provision(provisioner *provisioning.Provisioner, file string) {
 	fmt.Println("[Provisioning]: success")
 }
 
-func (app *App) subscribeToConfigChanges(sm *subscription.Manager) {
+func (app *App) subscribeToConfigChanges(sm subscription.Manager) {
 	sm.Subscribe(config.ResourceID, subscription.NewSubscriberFunction(
 		func(m subscription.Message) error {
-			configFromDB, ok := m.Content.(config.Config)
-			if !ok {
-				return fmt.Errorf("cannot read update to configFromDB. unexpected type %T", m.Content)
+			configFromDB := config.Config{}
+			err := m.DecodeContent(&configFromDB)
+			if err != nil {
+				return fmt.Errorf("cannot read update to configFromDB: %w", err)
 			}
 
 			return app.initAnalytics(configFromDB)
@@ -174,7 +175,12 @@ func (app *App) Start(opts ...appOption) error {
 		log.Fatal(err)
 	}
 
-	subscriptionManager := subscription.NewManager()
+	natsConn, err := nats.Connect(app.cfg.NATSEndpoint())
+	if err != nil {
+		log.Printf("could not connect to NATS: %s. Defaulting to InMemory Queues", err)
+	}
+
+	subscriptionManager := subscription.NewManager(subscription.WithNats(natsConn))
 	app.subscribeToConfigChanges(subscriptionManager)
 
 	configRepo := config.NewRepository(db, config.WithPublisher(subscriptionManager))
@@ -241,11 +247,6 @@ func (app *App) Start(opts ...appOption) error {
 		registerOtlpServer(app, tracesRepo, runRepo, eventEmitter, dataStoreRepo, tracer)
 	}
 
-	natsConn, err := nats.Connect(app.cfg.NATSEndpoint())
-	if err != nil {
-		log.Printf("could not connect to NATS: %s. Defaulting to InMemory Queues", err)
-	}
-
 	executorDriverFactory := pipeline.NewDriverFactory[executor.Job](natsConn)
 	testPipeline := buildTestPipeline(
 		executorDriverFactory,
@@ -527,7 +528,7 @@ type httpServerConfig interface {
 	ExperimentalFeatures() []string
 }
 
-func registerWSHandler(router *mux.Router, mappers mappings.Mappings, subscriptionManager *subscription.Manager) {
+func registerWSHandler(router *mux.Router, mappers mappings.Mappings, subscriptionManager subscription.Manager) {
 	wsRouter := websocket.NewRouter()
 	wsRouter.Add("subscribe", websocket.NewSubscribeCommandExecutor(subscriptionManager, mappers))
 	wsRouter.Add("unsubscribe", websocket.NewUnsubscribeCommandExecutor(subscriptionManager))

diff --git a/server/app/test_pipeline.go b/server/app/test_pipeline.go
@@ -30,7 +30,7 @@ func buildTestPipeline(
 	testRepo test.Repository,
 	runRepo test.RunRepository,
 	tracer trace.Tracer,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	triggerRegistry *trigger.Registry,
 	tracedbFactory tracedb.FactoryFunc,
 	appConfig *config.AppConfig,

diff --git a/server/app/test_suite_pipeline.go b/server/app/test_suite_pipeline.go
@@ -12,7 +12,7 @@ func buildTestSuitePipeline(
 	tranRepo *testsuite.Repository,
 	runRepo *testsuite.RunRepository,
 	testRunner *executor.TestPipeline,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	meter metric.Meter,
 ) *executor.TestSuitesPipeline {
 	tranRunner := executor.NewTestSuiteRunner(testRunner, runRepo, subscriptionManager)

diff --git a/server/executor/assertion_runner.go b/server/executor/assertion_runner.go
@@ -20,15 +20,15 @@ type defaultAssertionRunner struct {
 	updater             RunUpdater
 	assertionExecutor   AssertionExecutor
 	outputsProcessor    OutputsProcessorFn
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	eventEmitter        EventEmitter
 }
 
 func NewAssertionRunner(
 	updater RunUpdater,
 	assertionExecutor AssertionExecutor,
 	op OutputsProcessorFn,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	eventEmitter EventEmitter,
 ) *defaultAssertionRunner {
 	return &defaultAssertionRunner{

diff --git a/server/executor/eventemitter_test.go b/server/executor/eventemitter_test.go
@@ -3,6 +3,7 @@ package executor_test
 import (
 	"context"
 	"errors"
+	"fmt"
 	"testing"
 
 	"github.com/kubeshop/tracetest/server/executor"
@@ -135,13 +136,17 @@ func (s *testRunEventSubscriber) ID() string {
 	return "some-id"
 }
 
-func (s *testRunEventSubscriber) Notify(message subscription.Message) error {
-	event := message.Content.(model.TestRunEvent)
+func (s *testRunEventSubscriber) Notify(m subscription.Message) error {
+	event := model.TestRunEvent{}
+	err := m.DecodeContent(&event)
+	if err != nil {
+		panic(fmt.Errorf("cannot read testRunEvent: %w", err))
+	}
 	s.events = append(s.events, event)
 	return nil
 }
 
-func getSubscriptionManagerMock(t *testing.T, event model.TestRunEvent) (*subscription.Manager, *testRunEventSubscriber) {
+func getSubscriptionManagerMock(t *testing.T, event model.TestRunEvent) (subscription.Manager, *testRunEventSubscriber) {
 	t.Helper()
 
 	subscriptionManager := subscription.NewManager()

diff --git a/server/executor/linter_runner.go b/server/executor/linter_runner.go
@@ -20,15 +20,15 @@ type AnalyzerGetter interface {
 
 type defaultLinterRunner struct {
 	updater             RunUpdater
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	eventEmitter        EventEmitter
 	analyzerGetter      AnalyzerGetter
 	outputQueue         pipeline.Enqueuer[Job]
 }
 
 func NewLinterRunner(
 	updater RunUpdater,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	eventEmitter EventEmitter,
 	analyzerGetter AnalyzerGetter,
 ) *defaultLinterRunner {

diff --git a/server/executor/queue.go b/server/executor/queue.go
@@ -366,9 +366,10 @@ func (q Queue) listenForUserRequests(ctx context.Context, cancelCtx context.Canc
 
 	sfn := subscription.NewSubscriberFunction(func(m subscription.Message) error {
 		cancelCtx(nil)
-		request, ok := m.Content.(UserRequest)
-		if !ok {
-			return nil
+		request := UserRequest{}
+		err := m.DecodeContent(&request)
+		if err != nil {
+			return fmt.Errorf("cannot decode UserRequest message: %w", err)
 		}
 
 		run, err := q.runs.GetRun(ctx, request.TestID, request.RunID)
@@ -384,9 +385,10 @@ func (q Queue) listenForUserRequests(ctx context.Context, cancelCtx context.Canc
 	})
 
 	spfn := subscription.NewSubscriberFunction(func(m subscription.Message) error {
-		request, ok := m.Content.(UserRequest)
-		if !ok {
-			return nil
+		request := UserRequest{}
+		err := m.DecodeContent(&request)
+		if err != nil {
+			return fmt.Errorf("cannot decode UserRequest message: %w", err)
 		}
 
 		run, err := q.runs.GetRun(ctx, request.TestID, request.RunID)
@@ -416,7 +418,8 @@ func (q Queue) resolveTestSuite(ctx context.Context, job Job) testsuite.TestSuit
 		return testsuite.TestSuite{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve TestSuite: %s", err.Error())
+		return testsuite.TestSuite{}
 	}
 
 	return tran
@@ -431,7 +434,8 @@ func (q Queue) resolveTestSuiteRun(ctx context.Context, job Job) testsuite.TestS
 		return testsuite.TestSuiteRun{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve TestSuiteRun: %s", err.Error())
+		return testsuite.TestSuiteRun{}
 	}
 
 	return tranRun
@@ -447,7 +451,8 @@ func (q Queue) resolveTest(ctx context.Context, job Job) test.Test {
 		return test.Test{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve Test: %s", err.Error())
+		return test.Test{}
 	}
 
 	return t
@@ -463,7 +468,8 @@ func (q Queue) resolveTestRun(ctx context.Context, job Job) test.Run {
 		return test.Run{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve test run: %s", err.Error())
+		return test.Run{}
 	}
 
 	return run
@@ -479,7 +485,8 @@ func (q Queue) resolvePollingProfile(ctx context.Context, job Job) pollingprofil
 		return pollingprofile.PollingProfile{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve PollingProfile: %s", err.Error())
+		return pollingprofile.PollingProfile{}
 	}
 
 	return profile
@@ -495,7 +502,8 @@ func (q Queue) resolveDataStore(ctx context.Context, job Job) datastore.DataStor
 		return datastore.DataStore{}
 	}
 	if err != nil {
-		panic(err)
+		log.Printf("cannot resolve DataStore: %s", err.Error())
+		return datastore.DataStore{}
 	}
 
 	return ds

diff --git a/server/executor/run_updater.go b/server/executor/run_updater.go
@@ -50,10 +50,10 @@ func (u dbUpdater) Update(ctx context.Context, run test.Run) error {
 }
 
 type subscriptionUpdater struct {
-	manager *subscription.Manager
+	manager subscription.Manager
 }
 
-func NewSubscriptionUpdater(manager *subscription.Manager) RunUpdater {
+func NewSubscriptionUpdater(manager subscription.Manager) RunUpdater {
 	return subscriptionUpdater{manager}
 }
 

diff --git a/server/executor/test_suite_run_updater.go b/server/executor/test_suite_run_updater.go
@@ -50,10 +50,10 @@ func (u dbTransactionUpdater) Update(ctx context.Context, run testsuite.TestSuit
 }
 
 type subscriptionTransactionUpdater struct {
-	manager *subscription.Manager
+	manager subscription.Manager
 }
 
-func NewSubscriptionTransactionUpdater(manager *subscription.Manager) TestSuiteRunUpdater {
+func NewSubscriptionTransactionUpdater(manager subscription.Manager) TestSuiteRunUpdater {
 	return subscriptionTransactionUpdater{manager}
 }
 

diff --git a/server/executor/test_suite_runner.go b/server/executor/test_suite_runner.go
@@ -26,7 +26,7 @@ type testRunner interface {
 func NewTestSuiteRunner(
 	testRunner testRunner,
 	transactionRuns testSuiteRunRepository,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 ) *persistentTransactionRunner {
 	updater := (CompositeTransactionUpdater{}).
 		Add(NewDBTranasctionUpdater(transactionRuns)).
@@ -44,7 +44,7 @@ type persistentTransactionRunner struct {
 	testRunner          testRunner
 	transactionRuns     testSuiteRunRepository
 	updater             TestSuiteRunUpdater
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 }
 
 func (r *persistentTransactionRunner) SetOutputQueue(_ pipeline.Enqueuer[Job]) {
@@ -104,7 +104,11 @@ func (r persistentTransactionRunner) runTransactionStep(ctx context.Context, tr
 	// listen for updates and propagate them as if they were transaction updates
 	r.subscriptionManager.Subscribe(testRun.ResourceID(), subscription.NewSubscriberFunction(
 		func(m subscription.Message) error {
-			testRun := m.Content.(test.Run)
+			testRun := test.Run{}
+			err := m.DecodeContent(&testRun)
+			if err != nil {
+				return fmt.Errorf("cannot decode Run message: %w", err)
+			}
 			if testRun.LastError != nil {
 				tr.State = testsuite.TestSuiteStateFailed
 				tr.LastError = testRun.LastError

diff --git a/server/executor/test_suite_runner_test.go b/server/executor/test_suite_runner_test.go
@@ -26,7 +26,7 @@ import (
 
 type fakeTestRunner struct {
 	db                  test.RunRepository
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	returnErr           bool
 	uid                 int
 }
@@ -181,7 +181,11 @@ func runTestSuiteRunnerTest(t *testing.T, withErrors bool, assert func(t *testin
 
 	done := make(chan testsuite.TestSuiteRun, 1)
 	sf := subscription.NewSubscriberFunction(func(m subscription.Message) error {
-		tr := m.Content.(testsuite.TestSuiteRun)
+		tr := testsuite.TestSuiteRun{}
+		err := m.DecodeContent(&tr)
+		if err != nil {
+			panic(fmt.Errorf("cannot decode TestSuiteRun message: %w", err))
+		}
 		if tr.State.IsFinal() {
 			done <- tr
 		}

diff --git a/server/executor/trace_poller.go b/server/executor/trace_poller.go
@@ -65,7 +65,7 @@ type TraceFetcher interface {
 func NewTracePoller(
 	pe pollerExecutor,
 	updater RunUpdater,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	eventEmitter EventEmitter,
 ) *tracePoller {
 	return &tracePoller{
@@ -79,7 +79,7 @@ func NewTracePoller(
 type tracePoller struct {
 	updater             RunUpdater
 	pollerExecutor      pollerExecutor
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	eventEmitter        EventEmitter
 	inputQueue          pipeline.Enqueuer[Job]
 	outputQueue         pipeline.Enqueuer[Job]

diff --git a/server/executor/tracepollerworker/common.go b/server/executor/tracepollerworker/common.go
@@ -24,7 +24,7 @@ type workerState struct {
 	newTraceDBFn        tracedb.FactoryFunc
 	dsRepo              resourcemanager.Current[datastore.DataStore]
 	updater             executor.RunUpdater
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	tracer              trace.Tracer
 	inputQueue          pipeline.Enqueuer[executor.Job]
 }

diff --git a/server/executor/tracepollerworker/evaluator_worker.go b/server/executor/tracepollerworker/evaluator_worker.go
@@ -36,7 +36,7 @@ func NewEvaluatorWorker(
 	newTraceDBFn tracedb.FactoryFunc,
 	dsRepo resourcemanager.Current[datastore.DataStore],
 	updater executor.RunUpdater,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	stopStrategy PollingStopStrategy,
 	tracer trace.Tracer,
 ) *tracePollerEvaluatorWorker {

diff --git a/server/executor/tracepollerworker/fetcher_worker.go b/server/executor/tracepollerworker/fetcher_worker.go
@@ -24,7 +24,7 @@ func NewFetcherWorker(
 	newTraceDBFn tracedb.FactoryFunc,
 	dsRepo resourcemanager.Current[datastore.DataStore],
 	updater executor.RunUpdater,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	tracer trace.Tracer,
 	enabled bool,
 ) *traceFetcherWorker {

diff --git a/server/executor/tracepollerworker/starter_worker.go b/server/executor/tracepollerworker/starter_worker.go
@@ -26,7 +26,7 @@ func NewStarterWorker(
 	newTraceDBFn tracedb.FactoryFunc,
 	dsRepo resourcemanager.Current[datastore.DataStore],
 	updater executor.RunUpdater,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	tracer trace.Tracer,
 ) *tracePollerStarterWorker {
 	state := &workerState{

diff --git a/server/executor/trigger_result_processor_worker.go b/server/executor/trigger_result_processor_worker.go
@@ -21,7 +21,7 @@ type RunResult struct {
 
 func NewTriggerResultProcessorWorker(
 	tracer trace.Tracer,
-	subscriptionManager *subscription.Manager,
+	subscriptionManager subscription.Manager,
 	eventEmitter EventEmitter,
 	updater RunUpdater,
 ) *triggerResultProcessorWorker {
@@ -35,7 +35,7 @@ func NewTriggerResultProcessorWorker(
 
 type triggerResultProcessorWorker struct {
 	tracer              trace.Tracer
-	subscriptionManager *subscription.Manager
+	subscriptionManager subscription.Manager
 	eventEmitter        EventEmitter
 	outputQueue         pipeline.Enqueuer[Job]
 	updater             RunUpdater