test(mailserver): add test that validates throttle behaviour

Author: jrainville

protocol/messenger_mailserver.go

@@ -283,7 +283,61 @@ func (m *Messenger) requestAllHistoricMessages(withRetries bool, aggregateRespon
 		return nil, nil
 	}
 
-	now := time.Now()
+	canSync, err := m.canSyncWithStoreNodes()
+	if err != nil {
+		return nil, err
+	}
+	if !canSync {
+		return nil, nil
+	}
+
+	return m.withHistoricSyncInFlight(time.Now(), func() (*MessengerResponse, error) {
+		var allResponses *MessengerResponse
+		if aggregateResponses {
+			allResponses = &MessengerResponse{}
+		}
+
+		filters := m.messaging.ChatFilters()
+		err = m.updateFiltersPriority(filters)
+		if err != nil {
+			return nil, fmt.Errorf("failed to update filters priority: %w", err)
+		}
+		defer func() {
+			err := m.resetFiltersPriority(filters)
+			if err != nil {
+				m.logger.Error("failed to reset filters priority", zap.Error(err))
+			}
+		}()
+
+		peerInfo := m.messaging.GetActiveStorenode()
+
+		if withRetries {
+			response, err := m.performStorenodeTask(func() (*MessengerResponse, error) {
+				return m.syncFilters(peerInfo, filters)
+			}, history.WithPeerID(peerInfo.ID))
+			if err != nil {
+				return nil, err
+			}
+			if aggregateResponses && response != nil {
+				allResponses.AddChats(response.Chats())
+				allResponses.AddMessages(response.Messages())
+			}
+			return allResponses, nil
+		}
+
+		response, err := m.syncFilters(peerInfo, filters)
+		if err != nil {
+			return nil, err
+		}
+		if aggregateResponses && response != nil {
+			allResponses.AddChats(response.Chats())
+			allResponses.AddMessages(response.Messages())
+		}
+		return allResponses, nil
+	})
+}
+
+func (m *Messenger) withHistoricSyncInFlight(now time.Time, fn func() (*MessengerResponse, error)) (*MessengerResponse, error) {
 	m.historicSyncMu.Lock()
 	if m.historicSyncInFlight {
 		m.historicSyncMu.Unlock()
@@ -312,48 +366,7 @@ func (m *Messenger) requestAllHistoricMessages(withRetries bool, aggregateRespon
 		m.historicSyncMu.Unlock()
 	}()
 
-	var allResponses *MessengerResponse
-	if aggregateResponses {
-		allResponses = &MessengerResponse{}
-	}
-
-	filters := m.messaging.ChatFilters()
-	err = m.updateFiltersPriority(filters)
-	if err != nil {
-		return nil, fmt.Errorf("failed to update filters priority: %w", err)
-	}
-	defer func() {
-		err := m.resetFiltersPriority(filters)
-		if err != nil {
-			m.logger.Error("failed to reset filters priority", zap.Error(err))
-		}
-	}()
-
-	peerInfo := m.messaging.GetActiveStorenode()
-
-	if withRetries {
-		response, err := m.performStorenodeTask(func() (*MessengerResponse, error) {
-			return m.syncFilters(peerInfo, filters)
-		}, history.WithPeerID(peerInfo.ID))
-		if err != nil {
-			return nil, err
-		}
-		if aggregateResponses && response != nil {
-			allResponses.AddChats(response.Chats())
-			allResponses.AddMessages(response.Messages())
-		}
-		return allResponses, nil
-	}
-
-	response, err := m.syncFilters(peerInfo, filters)
-	if err != nil {
-		return nil, err
-	}
-	if aggregateResponses && response != nil {
-		allResponses.AddChats(response.Chats())
-		allResponses.AddMessages(response.Messages())
-	}
-	return allResponses, nil
+	return fn()
 }
 
 const missingMessageCheckPeriod = 30 * time.Second

protocol/messenger_mailserver_throttle_test.go

@@ -0,0 +1,82 @@
+package protocol
+
+import (
+	"errors"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+	"go.uber.org/zap"
+)
+
+func TestWithHistoricSyncInFlightResetsFlagOnError(t *testing.T) {
+	m := &Messenger{logger: zap.NewNop()}
+
+	_, err := m.withHistoricSyncInFlight(time.Now(), func() (*MessengerResponse, error) {
+		return nil, errors.New("boom")
+	})
+	require.Error(t, err)
+
+	m.historicSyncMu.Lock()
+	require.False(t, m.historicSyncInFlight)
+	m.historicSyncMu.Unlock()
+}
+
+func TestWithHistoricSyncInFlightSkipsWhenAlreadyInFlight(t *testing.T) {
+	m := &Messenger{logger: zap.NewNop(), historicSyncInFlight: true}
+
+	called := false
+	resp, err := m.withHistoricSyncInFlight(time.Now(), func() (*MessengerResponse, error) {
+		called = true
+		return &MessengerResponse{}, nil
+	})
+	require.NoError(t, err)
+	require.Nil(t, resp)
+	require.False(t, called)
+
+	m.historicSyncMu.Lock()
+	require.True(t, m.historicSyncInFlight)
+	m.historicSyncMu.Unlock()
+}
+
+func TestWithHistoricSyncInFlightSkipsWhenThrottled(t *testing.T) {
+	now := time.Now()
+	m := &Messenger{
+		logger:                    zap.NewNop(),
+		lastHistoricSyncRequestAt: now.Add(-(historicSyncMinInterval / 2)),
+	}
+
+	called := false
+	resp, err := m.withHistoricSyncInFlight(now, func() (*MessengerResponse, error) {
+		called = true
+		return &MessengerResponse{}, nil
+	})
+	require.NoError(t, err)
+	require.Nil(t, resp)
+	require.False(t, called)
+
+	m.historicSyncMu.Lock()
+	require.False(t, m.historicSyncInFlight)
+	require.Equal(t, now.Add(-(historicSyncMinInterval / 2)), m.lastHistoricSyncRequestAt)
+	m.historicSyncMu.Unlock()
+}
+
+func TestWithHistoricSyncInFlightRunsAndUpdatesTimestamp(t *testing.T) {
+	now := time.Now()
+	old := now.Add(-2 * historicSyncMinInterval)
+	m := &Messenger{logger: zap.NewNop(), lastHistoricSyncRequestAt: old}
+
+	called := false
+	resp, err := m.withHistoricSyncInFlight(now, func() (*MessengerResponse, error) {
+		called = true
+		return &MessengerResponse{}, nil
+	})
+	require.NoError(t, err)
+	require.NotNil(t, resp)
+	require.True(t, called)
+
+	m.historicSyncMu.Lock()
+	require.False(t, m.historicSyncInFlight)
+	require.Equal(t, now, m.lastHistoricSyncRequestAt)
+	m.historicSyncMu.Unlock()
+}