Move SystemEvents interface into events/system package

Signed-off-by: Andrew Richardson <andrew.richardson@kaleido.io>
hyperledger · Aug 4, 2022 · 2eedf09 · 2eedf09
1 parent c17cea8
commit 2eedf09
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 64 deletions.
diff --git a/Makefile b/Makefile
@@ -53,7 +53,6 @@ $(eval $(call makemock, pkg/tokens,                Plugin,             tokenmock
 $(eval $(call makemock, pkg/tokens,                Callbacks,          tokenmocks))
 $(eval $(call makemock, internal/txcommon,         Helper,             txcommonmocks))
 $(eval $(call makemock, internal/identity,         Manager,            identitymanagermocks))
-$(eval $(call makemock, internal/sysmessaging,     SystemEvents,       sysmessagingmocks))
 $(eval $(call makemock, internal/sysmessaging,     MessageSender,      sysmessagingmocks))
 $(eval $(call makemock, internal/syncasync,        Bridge,             syncasyncmocks))
 $(eval $(call makemock, internal/data,             Manager,            datamocks))
@@ -65,6 +64,7 @@ $(eval $(call makemock, internal/shareddownload,   Callbacks,          shareddow
 $(eval $(call makemock, internal/definitions,      Handler,            definitionsmocks))
 $(eval $(call makemock, internal/definitions,      Sender,             definitionsmocks))
 $(eval $(call makemock, internal/events,           EventManager,       eventmocks))
+$(eval $(call makemock, internal/events/system,    EventInterface,     systemeventmocks))
 $(eval $(call makemock, internal/namespace,        Manager,            namespacemocks))
 $(eval $(call makemock, internal/networkmap,       Manager,            networkmapmocks))
 $(eval $(call makemock, internal/assets,           Manager,            assetmocks))

diff --git a/internal/events/event_manager.go b/internal/events/event_manager.go
@@ -41,7 +41,6 @@ import (
 	"github.com/hyperledger/firefly/internal/multiparty"
 	"github.com/hyperledger/firefly/internal/privatemessaging"
 	"github.com/hyperledger/firefly/internal/shareddownload"
-	"github.com/hyperledger/firefly/internal/sysmessaging"
 	"github.com/hyperledger/firefly/internal/txcommon"
 	"github.com/hyperledger/firefly/pkg/blockchain"
 	"github.com/hyperledger/firefly/pkg/core"
@@ -84,7 +83,7 @@ type EventManager interface {
 	GetPlugins() []*core.NamespaceStatusPlugin
 
 	// Internal events
-	sysmessaging.SystemEvents
+	system.EventInterface
 }
 
 type eventManager struct {

diff --git a/internal/events/system/events.go b/internal/events/system/events.go
@@ -42,6 +42,10 @@ type Events struct {
 	readAhead    uint16
 }
 
+type EventInterface interface {
+	AddSystemEventListener(ns string, el EventListener) error
+}
+
 type EventListener func(event *core.EventDelivery) error
 
 func (se *Events) Name() string { return SystemEventsTransport }

diff --git a/internal/syncasync/sync_async_bridge.go b/internal/syncasync/sync_async_bridge.go
@@ -28,16 +28,16 @@ import (
 	"github.com/hyperledger/firefly-common/pkg/log"
 	"github.com/hyperledger/firefly/internal/coremsgs"
 	"github.com/hyperledger/firefly/internal/data"
-	"github.com/hyperledger/firefly/internal/sysmessaging"
+	"github.com/hyperledger/firefly/internal/events/system"
 	"github.com/hyperledger/firefly/pkg/core"
 	"github.com/hyperledger/firefly/pkg/database"
 )
 
 // Bridge translates synchronous (HTTP API) calls, into asynchronously sending a
 // message and blocking until a correlating response is received, or we hit a timeout.
 type Bridge interface {
-	// Init is required as there's a bi-directional relationship between sysmessaging and syncasync bridge
-	Init(sysevents sysmessaging.SystemEvents)
+	// Init is required as there's a bi-directional relationship between event manager and syncasync bridge
+	Init(sysevents system.EventInterface)
 
 	// The following "WaitFor*" methods all wait for a particular type of event callback, and block until it is received.
 	// To use them, invoke the appropriate method, and pass a "send" callback that is expected to trigger the relevant event.
@@ -92,7 +92,7 @@ type syncAsyncBridge struct {
 	namespace   string
 	database    database.Plugin
 	data        data.Manager
-	sysevents   sysmessaging.SystemEvents
+	sysevents   system.EventInterface
 	inflightMux sync.Mutex
 	inflight    inflightRequestMap
 }
@@ -108,7 +108,7 @@ func NewSyncAsyncBridge(ctx context.Context, ns string, di database.Plugin, dm d
 	return sa
 }
 
-func (sa *syncAsyncBridge) Init(sysevents sysmessaging.SystemEvents) {
+func (sa *syncAsyncBridge) Init(sysevents system.EventInterface) {
 	sa.sysevents = sysevents
 }
 

diff --git a/internal/syncasync/sync_async_bridge_test.go b/internal/syncasync/sync_async_bridge_test.go
@@ -25,7 +25,7 @@ import (
 	"github.com/hyperledger/firefly-common/pkg/fftypes"
 	"github.com/hyperledger/firefly/mocks/databasemocks"
 	"github.com/hyperledger/firefly/mocks/datamocks"
-	"github.com/hyperledger/firefly/mocks/sysmessagingmocks"
+	"github.com/hyperledger/firefly/mocks/systemeventmocks"
 	"github.com/hyperledger/firefly/pkg/core"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -35,7 +35,7 @@ func newTestSyncAsyncBridge(t *testing.T) (*syncAsyncBridge, func()) {
 	ctx, cancel := context.WithCancel(context.Background())
 	mdi := &databasemocks.Plugin{}
 	mdm := &datamocks.Manager{}
-	mse := &sysmessagingmocks.SystemEvents{}
+	mse := &systemeventmocks.EventInterface{}
 	sa := NewSyncAsyncBridge(ctx, "ns1", mdi, mdm)
 	sa.Init(mse)
 	return sa.(*syncAsyncBridge), cancel
@@ -50,7 +50,7 @@ func TestRequestReplyOk(t *testing.T) {
 	replyID := fftypes.NewUUID()
 	dataID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -104,7 +104,7 @@ func TestAwaitConfirmationOk(t *testing.T) {
 	requestID := fftypes.NewUUID()
 	dataID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -152,7 +152,7 @@ func TestAwaitConfirmationRejected(t *testing.T) {
 	requestID := fftypes.NewUUID()
 	dataID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -195,7 +195,7 @@ func TestRequestReplyTimeout(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	_, err := sa.WaitForReply(sa.ctx, fftypes.NewUUID(), func(ctx context.Context) error {
@@ -209,7 +209,7 @@ func TestRequestSetupSystemListenerFail(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	defer cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(fmt.Errorf("pop"))
 
 	_, err := sa.WaitForReply(sa.ctx, fftypes.NewUUID(), func(ctx context.Context) error {
@@ -224,7 +224,7 @@ func TestEventCallbackNotInflight(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	defer cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	err := sa.eventCallback(&core.EventDelivery{
@@ -762,7 +762,7 @@ func TestAwaitTokenPoolConfirmation(t *testing.T) {
 
 	requestID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -802,7 +802,7 @@ func TestAwaitTokenPoolConfirmationSendFail(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	defer cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	_, err := sa.WaitForTokenPool(sa.ctx, fftypes.NewUUID(), func(ctx context.Context) error {
@@ -837,7 +837,7 @@ func TestAwaitTokenPoolConfirmationRejected(t *testing.T) {
 		},
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -870,7 +870,7 @@ func TestAwaitTokenTransferConfirmation(t *testing.T) {
 
 	requestID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -912,7 +912,7 @@ func TestAwaitTokenApprovalConfirmation(t *testing.T) {
 
 	requestID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -952,7 +952,7 @@ func TestAwaitTokenApprovalConfirmationSendFail(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	defer cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	_, err := sa.WaitForTokenApproval(sa.ctx, fftypes.NewUUID(), func(ctx context.Context) error {
@@ -966,7 +966,7 @@ func TestAwaitTokenTransferConfirmationSendFail(t *testing.T) {
 	sa, cancel := newTestSyncAsyncBridge(t)
 	defer cancel()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	_, err := sa.WaitForTokenTransfer(sa.ctx, fftypes.NewUUID(), func(ctx context.Context) error {
@@ -989,7 +989,7 @@ func TestAwaitFailedTokenPool(t *testing.T) {
 		Error: "pop",
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1028,7 +1028,7 @@ func TestAwaitFailedTokenTransfer(t *testing.T) {
 		Error: "pop",
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1067,7 +1067,7 @@ func TestAwaitFailedTokenApproval(t *testing.T) {
 		Error: "pop",
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1380,7 +1380,7 @@ func TestAwaitIdentityConfirmed(t *testing.T) {
 		},
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1412,7 +1412,7 @@ func TestAwaitIdentityFail(t *testing.T) {
 
 	requestID := fftypes.NewUUID()
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	_, err := sa.WaitForIdentity(sa.ctx, requestID, func(ctx context.Context) error {
@@ -1432,7 +1432,7 @@ func TestAwaitInvokeOpSucceeded(t *testing.T) {
 		Status: core.OpStatusSucceeded,
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1471,7 +1471,7 @@ func TestAwaitInvokeOpSucceededLookupFail(t *testing.T) {
 		},
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1502,7 +1502,7 @@ func TestAwaitInvokeOpFailed(t *testing.T) {
 		Error:  "pop",
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)
@@ -1540,7 +1540,7 @@ func TestAwaitInvokeOpFailedLookupFail(t *testing.T) {
 		},
 	}
 
-	mse := sa.sysevents.(*sysmessagingmocks.SystemEvents)
+	mse := sa.sysevents.(*systemeventmocks.EventInterface)
 	mse.On("AddSystemEventListener", "ns1", mock.Anything).Return(nil)
 
 	mdi := sa.database.(*databasemocks.Plugin)

diff --git a/internal/sysmessaging/sysevents.go b/internal/sysmessaging/sysevents.go
diff --git a/mocks/syncasyncmocks/bridge.go b/mocks/syncasyncmocks/bridge.go
diff --git a/mocks/sysmessagingmocks/system_events.go → mocks/systemeventmocks/event_interface.go b/mocks/sysmessagingmocks/system_events.go → mocks/systemeventmocks/event_interface.go