From aae656cd15fc59856d36ba15762621d118a36b57 Mon Sep 17 00:00:00 2001
From: joshemb <josh@elixxir.io>
Date: Wed, 20 Jul 2022 11:23:46 -0700
Subject: [PATCH] Standardize unimported interfaces in groupChat
---
groupChat/interface.go | 8 ++++----
groupChat/manager.go | 6 +++---
groupChat/manager_test.go | 4 ++--
groupChat/messenger_test.go | 6 +++---
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/groupChat/interface.go b/groupChat/interface.go
index 967f98ebe..0355c9094 100644
--- a/groupChat/interface.go
+++ b/groupChat/interface.go
@@ -100,9 +100,9 @@ type ReceiveCallback func(msg MessageReceive)
// Sub-interfaces from other packages //////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////
-// messenger is a sub-interface mocking the xxdk.E2e object.
+// groupE2e is a sub-interface mocking the xxdk.E2e object.
// This contains methods specific for this package.
-type messenger interface {
+type groupE2e interface {
GetCmix() cmix.Client
GetE2E() e2e.Handler
GetReceptionIdentity() xxdk.ReceptionIdentity
@@ -122,9 +122,9 @@ type groupCmix interface {
GetMaxMessageLength() int
}
-// e2eHandler is a subset of the e2e.Handler interface containing only the methods
+// groupE2eHandler is a subset of the e2e.Handler interface containing only the methods
// needed by GroupChat
-type e2eHandler interface {
+type groupE2eHandler interface {
SendE2E(mt catalog.MessageType, recipient *id.ID, payload []byte,
params e2e.Params) ([]id.Round, crypto.MessageID, time.Time, error)
RegisterListener(senderID *id.ID, messageType catalog.MessageType,
diff --git a/groupChat/manager.go b/groupChat/manager.go
index 020b74e32..34ac47250 100644
--- a/groupChat/manager.go
+++ b/groupChat/manager.go
@@ -47,11 +47,11 @@ type manager struct {
// Callback that is called when a new group request is received
requestFunc RequestCallback
- messenger messenger
+ messenger groupE2e
}
// NewManager creates a new group chat manager
-func NewManager(messenger messenger,
+func NewManager(messenger groupE2e,
requestFunc RequestCallback, receiveFunc Processor) (GroupChat, error) {
// Initialize a member object
@@ -147,7 +147,7 @@ func (m *manager) getCMix() groupCmix {
return m.messenger.GetCmix()
}
-func (m *manager) getE2eHandler() e2eHandler {
+func (m *manager) getE2eHandler() groupE2eHandler {
return m.messenger.GetE2E()
}
diff --git a/groupChat/manager_test.go b/groupChat/manager_test.go
index 8372a4408..07009a543 100644
--- a/groupChat/manager_test.go
+++ b/groupChat/manager_test.go
@@ -31,8 +31,8 @@ var _ GroupChat = (*manager)(nil)
// Tests that groupCmix adheres to the cmix.Client interface.
var _ groupCmix = (cmix.Client)(nil)
-// Tests that e2eHandler adheres to the e2e.Handler interface.
-var _ e2eHandler = (e2eImport.Handler)(nil)
+// Tests that groupE2eHandler adheres to the e2e.Handler interface.
+var _ groupE2eHandler = (e2eImport.Handler)(nil)
type mockProcessor struct{ receiveChan chan MessageReceive }
diff --git a/groupChat/messenger_test.go b/groupChat/messenger_test.go
index 7cc66585b..918947452 100644
--- a/groupChat/messenger_test.go
+++ b/groupChat/messenger_test.go
@@ -15,7 +15,7 @@ import (
"testing"
)
-// mockMessenger implementation for messenger interface
+// mockMessenger implementation for groupE2e interface
type mockMessenger struct {
receptionId *id.ID
net cmix.Client
@@ -25,7 +25,7 @@ type mockMessenger struct {
storage storage.Session
}
-func newMockMessenger(t testing.TB, kv *versioned.KV) messenger {
+func newMockMessenger(t testing.TB, kv *versioned.KV) groupE2e {
receptionId := id.NewIdFromString("test", id.User, t)
mockCmix := newTestNetworkManager(0)
prng := rand.New(rand.NewSource(42))
@@ -44,7 +44,7 @@ func newMockMessenger(t testing.TB, kv *versioned.KV) messenger {
}
}
-func newMockMessengerWithStore(t testing.TB, sendErr int) messenger {
+func newMockMessengerWithStore(t testing.TB, sendErr int) groupE2e {
receptionId := id.NewIdFromString("test", id.User, t)
mockCmix := newTestNetworkManager(sendErr)
prng := rand.New(rand.NewSource(42))
--
GitLab