2023-07-12 09:46:56 +00:00
|
|
|
package protocol
|
|
|
|
|
|
|
|
import (
|
2023-08-10 13:57:52 +00:00
|
|
|
"context"
|
2023-12-15 19:50:12 +00:00
|
|
|
"crypto/rand"
|
2023-11-25 23:24:20 +00:00
|
|
|
"database/sql"
|
2023-07-12 09:46:56 +00:00
|
|
|
"errors"
|
2023-12-15 19:50:12 +00:00
|
|
|
"math/big"
|
2023-11-25 23:24:20 +00:00
|
|
|
"os"
|
2023-10-24 10:15:32 +00:00
|
|
|
"sync"
|
2023-10-20 14:23:02 +00:00
|
|
|
"time"
|
2023-07-12 09:46:56 +00:00
|
|
|
|
2023-12-15 19:50:12 +00:00
|
|
|
"golang.org/x/exp/maps"
|
|
|
|
|
2023-11-25 23:24:20 +00:00
|
|
|
"go.uber.org/zap"
|
|
|
|
|
2023-08-10 13:57:52 +00:00
|
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
|
2023-11-25 23:24:20 +00:00
|
|
|
"github.com/status-im/status-go/appdatabase"
|
|
|
|
gethbridge "github.com/status-im/status-go/eth-node/bridge/geth"
|
|
|
|
"github.com/status-im/status-go/eth-node/types"
|
2023-07-12 09:46:56 +00:00
|
|
|
"github.com/status-im/status-go/protocol/common"
|
2023-12-15 19:50:12 +00:00
|
|
|
"github.com/status-im/status-go/protocol/communities"
|
2023-07-12 09:46:56 +00:00
|
|
|
"github.com/status-im/status-go/protocol/protobuf"
|
2023-12-15 19:50:12 +00:00
|
|
|
"github.com/status-im/status-go/protocol/requests"
|
2023-07-12 09:46:56 +00:00
|
|
|
"github.com/status-im/status-go/protocol/tt"
|
2023-11-25 23:24:20 +00:00
|
|
|
"github.com/status-im/status-go/t/helpers"
|
|
|
|
waku2 "github.com/status-im/status-go/wakuv2"
|
2023-07-12 09:46:56 +00:00
|
|
|
)
|
|
|
|
|
2023-11-25 23:24:20 +00:00
|
|
|
const testENRBootstrap = "enrtree://AL65EKLJAUXKKPG43HVTML5EFFWEZ7L4LOKTLZCLJASG4DSESQZEC@prod.status.nodes.status.im"
|
|
|
|
|
2023-12-15 19:50:12 +00:00
|
|
|
var letterRunes = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ")
|
|
|
|
var hexRunes = []rune("0123456789abcdef")
|
|
|
|
|
2023-07-12 09:46:56 +00:00
|
|
|
// WaitOnMessengerResponse Wait until the condition is true or the timeout is reached.
|
|
|
|
func WaitOnMessengerResponse(m *Messenger, condition func(*MessengerResponse) bool, errorMessage string) (*MessengerResponse, error) {
|
|
|
|
response := &MessengerResponse{}
|
|
|
|
err := tt.RetryWithBackOff(func() error {
|
|
|
|
var err error
|
|
|
|
r, err := m.RetrieveAll()
|
2023-08-10 15:12:23 +00:00
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
2023-07-12 09:46:56 +00:00
|
|
|
if err := response.Merge(r); err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
if err == nil && !condition(response) {
|
|
|
|
err = errors.New(errorMessage)
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
})
|
2023-08-04 10:41:24 +00:00
|
|
|
return response, err
|
2023-07-12 09:46:56 +00:00
|
|
|
}
|
|
|
|
|
2023-10-20 14:23:02 +00:00
|
|
|
type MessengerSignalsHandlerMock struct {
|
|
|
|
MessengerSignalsHandler
|
|
|
|
|
2023-12-15 19:50:12 +00:00
|
|
|
responseChan chan *MessengerResponse
|
|
|
|
communityFoundChan chan *communities.Community
|
2023-10-20 14:23:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (m *MessengerSignalsHandlerMock) MessengerResponse(response *MessengerResponse) {
|
|
|
|
// Non-blocking send
|
|
|
|
select {
|
|
|
|
case m.responseChan <- response:
|
|
|
|
default:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func (m *MessengerSignalsHandlerMock) MessageDelivered(chatID string, messageID string) {}
|
|
|
|
|
2023-12-15 19:50:12 +00:00
|
|
|
func (m *MessengerSignalsHandlerMock) CommunityInfoFound(community *communities.Community) {
|
|
|
|
select {
|
|
|
|
case m.communityFoundChan <- community:
|
|
|
|
default:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-10-20 14:23:02 +00:00
|
|
|
func WaitOnSignaledMessengerResponse(m *Messenger, condition func(*MessengerResponse) bool, errorMessage string) (*MessengerResponse, error) {
|
|
|
|
interval := 500 * time.Millisecond
|
|
|
|
timeoutChan := time.After(10 * time.Second)
|
|
|
|
|
|
|
|
if m.config.messengerSignalsHandler != nil {
|
|
|
|
return nil, errors.New("messengerSignalsHandler already provided/mocked")
|
|
|
|
}
|
|
|
|
|
|
|
|
responseChan := make(chan *MessengerResponse, 1)
|
|
|
|
m.config.messengerSignalsHandler = &MessengerSignalsHandlerMock{
|
|
|
|
responseChan: responseChan,
|
|
|
|
}
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
m.config.messengerSignalsHandler = nil
|
|
|
|
}()
|
|
|
|
|
|
|
|
for {
|
|
|
|
_, err := m.RetrieveAll()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
select {
|
|
|
|
case r := <-responseChan:
|
|
|
|
if condition(r) {
|
|
|
|
return r, nil
|
|
|
|
}
|
|
|
|
return nil, errors.New(errorMessage)
|
|
|
|
|
|
|
|
case <-timeoutChan:
|
2024-01-18 18:54:54 +00:00
|
|
|
return nil, errors.New("timed out: " + errorMessage)
|
2023-10-20 14:23:02 +00:00
|
|
|
|
|
|
|
default: // No immediate response, rest & loop back to retrieve again
|
|
|
|
time.Sleep(interval)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-12-15 19:50:12 +00:00
|
|
|
func WaitOnSignaledCommunityFound(m *Messenger, action func(), condition func(community *communities.Community) bool, timeout time.Duration, errorMessage string) error {
|
|
|
|
timeoutChan := time.After(timeout)
|
|
|
|
|
|
|
|
if m.config.messengerSignalsHandler != nil {
|
|
|
|
return errors.New("messengerSignalsHandler already provided/mocked")
|
|
|
|
}
|
|
|
|
|
|
|
|
communityFoundChan := make(chan *communities.Community, 1)
|
|
|
|
m.config.messengerSignalsHandler = &MessengerSignalsHandlerMock{
|
|
|
|
communityFoundChan: communityFoundChan,
|
|
|
|
}
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
m.config.messengerSignalsHandler = nil
|
|
|
|
}()
|
|
|
|
|
|
|
|
// Call the action after setting up the mock
|
|
|
|
action()
|
|
|
|
|
|
|
|
// Wait for condition after
|
|
|
|
for {
|
|
|
|
select {
|
|
|
|
case c := <-communityFoundChan:
|
|
|
|
if condition(c) {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
case <-timeoutChan:
|
2024-01-18 18:54:54 +00:00
|
|
|
return errors.New("timed out: " + errorMessage)
|
2023-12-15 19:50:12 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-07-12 09:46:56 +00:00
|
|
|
func FindFirstByContentType(messages []*common.Message, contentType protobuf.ChatMessage_ContentType) *common.Message {
|
|
|
|
for _, message := range messages {
|
|
|
|
if message.ContentType == contentType {
|
|
|
|
return message
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2023-08-10 13:57:52 +00:00
|
|
|
|
|
|
|
func PairDevices(s *suite.Suite, device1, device2 *Messenger) {
|
|
|
|
// Send pairing data
|
|
|
|
response, err := device1.SendPairInstallation(context.Background(), nil)
|
|
|
|
s.Require().NoError(err)
|
|
|
|
s.Require().NotNil(response)
|
|
|
|
s.Len(response.Chats(), 1)
|
|
|
|
s.False(response.Chats()[0].Active)
|
|
|
|
|
|
|
|
i, ok := device1.allInstallations.Load(device1.installationID)
|
|
|
|
s.Require().True(ok)
|
|
|
|
|
|
|
|
// Wait for the message to reach its destination
|
|
|
|
response, err = WaitOnMessengerResponse(
|
|
|
|
device2,
|
|
|
|
func(r *MessengerResponse) bool {
|
|
|
|
for _, installation := range r.Installations {
|
|
|
|
if installation.ID == device1.installationID {
|
|
|
|
return installation.InstallationMetadata != nil &&
|
|
|
|
i.InstallationMetadata.Name == installation.InstallationMetadata.Name &&
|
|
|
|
i.InstallationMetadata.DeviceType == installation.InstallationMetadata.DeviceType
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
|
|
|
|
},
|
|
|
|
"installation not received",
|
|
|
|
)
|
|
|
|
s.Require().NoError(err)
|
|
|
|
s.Require().NotNil(response)
|
|
|
|
|
|
|
|
// Ensure installation is enabled
|
|
|
|
err = device2.EnableInstallation(device1.installationID)
|
|
|
|
s.Require().NoError(err)
|
|
|
|
}
|
2023-10-24 10:15:32 +00:00
|
|
|
|
2023-11-13 20:07:35 +00:00
|
|
|
func SetSettingsAndWaitForChange(s *suite.Suite, messenger *Messenger, timeout time.Duration,
|
|
|
|
actionCallback func(), eventCallback func(*SelfContactChangeEvent) bool) {
|
|
|
|
|
|
|
|
allEventsReceived := false
|
|
|
|
channel := messenger.SubscribeToSelfContactChanges()
|
2023-10-24 10:15:32 +00:00
|
|
|
wg := sync.WaitGroup{}
|
2023-11-13 20:07:35 +00:00
|
|
|
wg.Add(1)
|
2023-10-24 10:15:32 +00:00
|
|
|
|
2023-11-13 20:07:35 +00:00
|
|
|
go func() {
|
|
|
|
defer wg.Done()
|
|
|
|
for !allEventsReceived {
|
|
|
|
select {
|
|
|
|
case event := <-channel:
|
|
|
|
allEventsReceived = eventCallback(event)
|
|
|
|
case <-time.After(timeout):
|
|
|
|
return
|
2023-10-24 10:15:32 +00:00
|
|
|
}
|
2023-11-13 20:07:35 +00:00
|
|
|
}
|
|
|
|
}()
|
2023-10-24 10:15:32 +00:00
|
|
|
|
|
|
|
actionCallback()
|
|
|
|
|
|
|
|
wg.Wait()
|
|
|
|
|
2023-11-13 20:07:35 +00:00
|
|
|
s.Require().True(allEventsReceived)
|
2023-10-24 10:15:32 +00:00
|
|
|
}
|
|
|
|
|
2023-11-13 20:07:35 +00:00
|
|
|
func SetIdentityImagesAndWaitForChange(s *suite.Suite, messenger *Messenger, timeout time.Duration, actionCallback func()) {
|
|
|
|
channel := messenger.SubscribeToSelfContactChanges()
|
2023-10-24 10:15:32 +00:00
|
|
|
ok := false
|
|
|
|
wg := sync.WaitGroup{}
|
|
|
|
wg.Add(1)
|
|
|
|
|
|
|
|
go func() {
|
|
|
|
defer wg.Done()
|
|
|
|
select {
|
2023-11-13 20:07:35 +00:00
|
|
|
case event := <-channel:
|
|
|
|
if event.ImagesChanged {
|
|
|
|
ok = true
|
|
|
|
}
|
2023-10-24 10:15:32 +00:00
|
|
|
case <-time.After(timeout):
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}()
|
|
|
|
|
|
|
|
actionCallback()
|
|
|
|
|
|
|
|
wg.Wait()
|
2023-11-13 20:07:35 +00:00
|
|
|
|
2023-10-24 10:15:32 +00:00
|
|
|
s.Require().True(ok)
|
|
|
|
}
|
2023-11-25 23:24:20 +00:00
|
|
|
|
|
|
|
func WaitForAvailableStoreNode(s *suite.Suite, m *Messenger, timeout time.Duration) {
|
2023-12-15 19:50:12 +00:00
|
|
|
available := m.waitForAvailableStoreNode(timeout)
|
|
|
|
s.Require().True(available)
|
2023-11-25 23:24:20 +00:00
|
|
|
}
|
|
|
|
|
2024-01-16 10:38:41 +00:00
|
|
|
func NewWakuV2(s *suite.Suite, logger *zap.Logger, useLocalWaku bool, enableStore bool, useShardAsDefaultTopic bool, clusterID uint16) *waku2.Waku {
|
2023-11-25 23:24:20 +00:00
|
|
|
wakuConfig := &waku2.Config{
|
2024-01-16 10:38:41 +00:00
|
|
|
UseShardAsDefaultTopic: useShardAsDefaultTopic,
|
|
|
|
ClusterID: clusterID,
|
2023-11-25 23:24:20 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
var onPeerStats func(connStatus types.ConnStatus)
|
|
|
|
var connStatusChan chan struct{}
|
|
|
|
var db *sql.DB
|
|
|
|
|
|
|
|
if !useLocalWaku {
|
|
|
|
enrTreeAddress := testENRBootstrap
|
|
|
|
envEnrTreeAddress := os.Getenv("ENRTREE_ADDRESS")
|
|
|
|
if envEnrTreeAddress != "" {
|
|
|
|
enrTreeAddress = envEnrTreeAddress
|
|
|
|
}
|
|
|
|
|
|
|
|
wakuConfig.EnableDiscV5 = true
|
|
|
|
wakuConfig.DiscV5BootstrapNodes = []string{enrTreeAddress}
|
|
|
|
wakuConfig.DiscoveryLimit = 20
|
|
|
|
wakuConfig.WakuNodes = []string{enrTreeAddress}
|
|
|
|
|
|
|
|
connStatusChan = make(chan struct{})
|
|
|
|
terminator := sync.Once{}
|
|
|
|
onPeerStats = func(connStatus types.ConnStatus) {
|
|
|
|
if connStatus.IsOnline {
|
|
|
|
terminator.Do(func() {
|
|
|
|
connStatusChan <- struct{}{}
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if enableStore {
|
|
|
|
var err error
|
|
|
|
db, err = helpers.SetupTestMemorySQLDB(appdatabase.DbInitializer{})
|
|
|
|
s.Require().NoError(err)
|
|
|
|
|
|
|
|
wakuConfig.EnableStore = true
|
|
|
|
wakuConfig.StoreCapacity = 200
|
|
|
|
wakuConfig.StoreSeconds = 200
|
|
|
|
}
|
|
|
|
|
|
|
|
wakuNode, err := waku2.New("", "", wakuConfig, logger, db, nil, nil, onPeerStats)
|
|
|
|
s.Require().NoError(err)
|
|
|
|
s.Require().NoError(wakuNode.Start())
|
|
|
|
|
|
|
|
if !useLocalWaku {
|
|
|
|
select {
|
|
|
|
case <-time.After(30 * time.Second):
|
|
|
|
s.Require().Fail("timeout elapsed")
|
|
|
|
case <-connStatusChan:
|
|
|
|
// proceed, peers found
|
|
|
|
close(connStatusChan)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return wakuNode
|
|
|
|
}
|
|
|
|
|
2024-01-22 14:22:47 +00:00
|
|
|
func CreateWakuV2Network(s *suite.Suite, parentLogger *zap.Logger, useShardAsDefaultTopic bool, nodeNames []string) []types.Waku {
|
2023-11-25 23:24:20 +00:00
|
|
|
nodes := make([]*waku2.Waku, len(nodeNames))
|
|
|
|
for i, name := range nodeNames {
|
|
|
|
logger := parentLogger.With(zap.String("name", name+"-waku"))
|
2024-01-22 14:22:47 +00:00
|
|
|
wakuNode := NewWakuV2(s, logger, true, false, useShardAsDefaultTopic, 0)
|
2023-11-25 23:24:20 +00:00
|
|
|
nodes[i] = wakuNode
|
|
|
|
}
|
|
|
|
|
|
|
|
// Setup local network graph
|
|
|
|
for i := 0; i < len(nodes); i++ {
|
|
|
|
for j := 0; j < len(nodes); j++ {
|
|
|
|
if i == j {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
addrs := nodes[j].ListenAddresses()
|
|
|
|
s.Require().Greater(len(addrs), 0)
|
|
|
|
_, err := nodes[i].AddRelayPeer(addrs[0])
|
|
|
|
s.Require().NoError(err)
|
|
|
|
err = nodes[i].DialPeer(addrs[0])
|
|
|
|
s.Require().NoError(err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
wrappers := make([]types.Waku, len(nodes))
|
|
|
|
for i, n := range nodes {
|
|
|
|
wrappers[i] = gethbridge.NewGethWakuV2Wrapper(n)
|
|
|
|
}
|
|
|
|
return wrappers
|
|
|
|
}
|
2023-11-27 17:01:13 +00:00
|
|
|
|
|
|
|
func TearDownMessenger(s *suite.Suite, m *Messenger) {
|
2023-12-27 13:53:19 +00:00
|
|
|
if m == nil {
|
|
|
|
return
|
|
|
|
}
|
2023-11-27 17:01:13 +00:00
|
|
|
s.Require().NoError(m.Shutdown())
|
|
|
|
if m.database != nil {
|
|
|
|
s.Require().NoError(m.database.Close())
|
|
|
|
}
|
|
|
|
if m.multiAccounts != nil {
|
|
|
|
s.Require().NoError(m.multiAccounts.Close())
|
|
|
|
}
|
|
|
|
}
|
2023-12-15 19:50:12 +00:00
|
|
|
|
|
|
|
func randomInt(length int) int {
|
|
|
|
max := big.NewInt(int64(length))
|
|
|
|
value, err := rand.Int(rand.Reader, max)
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
return int(value.Int64())
|
|
|
|
}
|
|
|
|
|
|
|
|
func randomString(length int, runes []rune) string {
|
|
|
|
out := make([]rune, length)
|
|
|
|
for i := range out {
|
|
|
|
out[i] = runes[randomInt(len(runes))] // nolint: gosec
|
|
|
|
}
|
|
|
|
return string(out)
|
|
|
|
}
|
|
|
|
|
|
|
|
func RandomLettersString(length int) string {
|
|
|
|
return randomString(length, letterRunes)
|
|
|
|
}
|
|
|
|
|
|
|
|
func RandomColor() string {
|
|
|
|
return "#" + randomString(6, hexRunes)
|
|
|
|
}
|
|
|
|
|
|
|
|
func RandomCommunityTags(count int) []string {
|
|
|
|
all := maps.Keys(requests.TagsEmojies)
|
|
|
|
tags := make([]string, 0, count)
|
|
|
|
indexes := map[int]struct{}{}
|
|
|
|
|
|
|
|
for len(indexes) != count {
|
|
|
|
index := randomInt(len(all))
|
|
|
|
indexes[index] = struct{}{}
|
|
|
|
}
|
|
|
|
|
|
|
|
for index := range indexes {
|
|
|
|
tags = append(tags, all[index])
|
|
|
|
}
|
|
|
|
|
|
|
|
return tags
|
|
|
|
}
|
|
|
|
|
|
|
|
func RandomBytes(length int) []byte {
|
|
|
|
out := make([]byte, length)
|
|
|
|
_, err := rand.Read(out)
|
|
|
|
if err != nil {
|
|
|
|
panic(err)
|
|
|
|
}
|
|
|
|
return out
|
|
|
|
}
|