fix(curated): stop loading curated communities as soon as you get a single valid community

Part of status-im/status-app#21514

Curated community discovery only needs one valid description to populate the UI, but it reused the general `FetchCommunity` freshness rule, which continued paging unless the stored description clock became newer than the clock captured when the request started. Allow curated requests to stop as soon as any accepted description is available, and retain an ephemeral description filter so subsequent updates arrive live without including the topic in historic synchronization sweeps.

Author: jrainville

protocol/messenger_curated_communities.go

@@ -3,6 +3,7 @@ package protocol
 import (
 	"context"
 	"errors"
+	"fmt"
 	"reflect"
 	"time"
 
@@ -12,6 +13,7 @@ import (
 
 	gocommon "github.com/status-im/status-go/common"
 	"github.com/status-im/status-go/internal/crypto/types"
+	types2 "github.com/status-im/status-go/pkg/messaging/types"
 	"github.com/status-im/status-go/protocol/communities"
 	"github.com/status-im/status-go/services/wallet/common"
 )
@@ -142,6 +144,10 @@ func (m *Messenger) getCuratedCommunitiesFromContract() (*communities.CuratedCom
 }
 
 func (m *Messenger) fetchCuratedCommunities(curatedCommunities *communities.CuratedCommunities) (*communities.KnownCommunitiesResponse, error) {
+	if err := m.subscribeToCuratedCommunityDescriptions(curatedCommunities.ContractCommunities); err != nil {
+		return nil, err
+	}
+
 	response, err := m.communitiesManager.GetStoredDescriptionForCommunities(curatedCommunities.ContractCommunities)
 	if err != nil {
 		return nil, err
@@ -156,7 +162,10 @@ func (m *Messenger) fetchCuratedCommunities(curatedCommunities *communities.Cura
 		m.logger.Debug("fetching unknown curated communities")
 
 		for _, communityID := range response.UnknownCommunities {
-			_, _, err := m.storeNodeRequestsManager.FetchCommunity(m.ctx, communityID, nil)
+			options := []StoreNodeRequestOption{
+				WithRequireNewerCommunityDescription(false),
+			}
+			_, _, err := m.storeNodeRequestsManager.FetchCommunity(m.ctx, communityID, options)
 			if err != nil {
 				m.logger.Error("failed to fetch curated community",
 					zap.String("communityID", communityID),
@@ -169,6 +178,19 @@ func (m *Messenger) fetchCuratedCommunities(curatedCommunities *communities.Cura
 	return response, nil
 }
 
+func (m *Messenger) subscribeToCuratedCommunityDescriptions(communityIDs []string) error {
+	for _, communityID := range communityIDs {
+		filter, created, err := m.storeNodeRequestsManager.getFilter(storeNodeCommunityRequest, communityID, types2.DefaultShard())
+		if err != nil {
+			if created && filter != nil {
+				m.storeNodeRequestsManager.forgetFilter(filter)
+			}
+			return fmt.Errorf("failed to subscribe to curated community %s: %w", communityID, err)
+		}
+	}
+	return nil
+}
+
 func (m *Messenger) CuratedCommunities() (*communities.KnownCommunitiesResponse, error) {
 	curatedCommunities, err := m.communitiesManager.GetCuratedCommunities()
 	if err != nil {

protocol/messenger_curated_communities_test.go

@@ -6,6 +6,10 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/status-im/status-go/internal/connection"
+	"github.com/status-im/status-go/internal/crypto"
+	cryptotypes "github.com/status-im/status-go/internal/crypto/types"
+	"github.com/status-im/status-go/pkg/messaging"
+	types2 "github.com/status-im/status-go/pkg/messaging/types"
 )
 
 func TestShouldPauseCuratedCommunitiesUpdateLoop(t *testing.T) {
@@ -16,3 +20,34 @@ func TestShouldPauseCuratedCommunitiesUpdateLoop(t *testing.T) {
 	m.setConnectionState(connection.State{Expensive: true})
 	require.True(t, m.shouldPauseCuratedCommunitiesUpdateLoop())
 }
+
+func TestSubscribeToCuratedCommunityDescriptions(t *testing.T) {
+	messagingEnv, err := messaging.NewTestMessagingEnvironment()
+	require.NoError(t, err)
+	require.NoError(t, messagingEnv.Setup(t))
+
+	m, err := newTestMessenger(t, messagingEnv, testMessengerConfig{})
+	require.NoError(t, err)
+
+	newCommunityKey, err := crypto.GenerateKey()
+	require.NoError(t, err)
+	newCommunityID := cryptotypes.HexBytes(crypto.CompressPubkey(&newCommunityKey.PublicKey)).String()
+
+	existingCommunityKey, err := crypto.GenerateKey()
+	require.NoError(t, err)
+	existingCommunityID := cryptotypes.HexBytes(crypto.CompressPubkey(&existingCommunityKey.PublicKey)).String()
+	existingFilters, err := m.messaging.InitPublicChats(types2.ChatsToInitialize{{
+		ChatID:      existingCommunityID,
+		PubsubTopic: types2.DefaultShard().PubsubTopic(),
+	}})
+	require.NoError(t, err)
+	require.Len(t, existingFilters, 1)
+	require.False(t, existingFilters[0].IsEphemeral())
+
+	require.NoError(t, m.subscribeToCuratedCommunityDescriptions([]string{newCommunityID, existingCommunityID}))
+
+	newFilter := m.messaging.ChatFilterByChatID(newCommunityID)
+	require.NotNil(t, newFilter)
+	require.True(t, newFilter.IsEphemeral())
+	require.False(t, m.messaging.ChatFilterByChatID(existingCommunityID).IsEphemeral())
+}

protocol/messenger_store_node_request_manager.go

@@ -329,6 +329,10 @@ func (r *storeNodeRequest) finalize() {
 	}
 }
 
+func (r *storeNodeRequest) hasFoundCommunityDescription(clock uint64) bool {
+	return !r.config.RequireNewerCommunityDescription || clock > r.minimumDataClock
+}
+
 func (r *storeNodeRequest) shouldFetchNextPage(envelopesCount int) (bool, uint64) {
 	logger := r.manager.logger.With(
 		zap.Any("requestID", r.requestID),
@@ -393,7 +397,7 @@ func (r *storeNodeRequest) shouldFetchNextPage(envelopesCount int) (bool, uint64
 		// Would be perfect if we could track that the community was in these particular envelopes,
 		// but I don't think that's possible right now. We check if clock was updated instead.
 
-		if community.Clock() <= r.minimumDataClock {
+		if !r.hasFoundCommunityDescription(community.Clock()) {
 			logger.Debug("local community description is not newer than existing",
 				zap.Any("existingClock", community.Clock()),
 				zap.Any("minimumDataClock", r.minimumDataClock),

protocol/messenger_store_node_request_manager_config.go

@@ -1,20 +1,22 @@
 package protocol
 
 type StoreNodeRequestConfig struct {
-	WaitForResponse   bool
-	StopWhenDataFound bool
-	InitialPageSize   uint64
-	FurtherPageSize   uint64
+	WaitForResponse                  bool
+	StopWhenDataFound                bool
+	RequireNewerCommunityDescription bool
+	InitialPageSize                  uint64
+	FurtherPageSize                  uint64
 }
 
 type StoreNodeRequestOption func(*StoreNodeRequestConfig)
 
 func defaultStoreNodeRequestConfig() StoreNodeRequestConfig {
 	return StoreNodeRequestConfig{
-		WaitForResponse:   true,
-		StopWhenDataFound: true,
-		InitialPageSize:   initialStoreNodeRequestPageSize,
-		FurtherPageSize:   defaultStoreNodeRequestPageSize,
+		WaitForResponse:                  true,
+		StopWhenDataFound:                true,
+		RequireNewerCommunityDescription: true,
+		InitialPageSize:                  initialStoreNodeRequestPageSize,
+		FurtherPageSize:                  defaultStoreNodeRequestPageSize,
 	}
 }
 
@@ -40,6 +42,12 @@ func WithStopWhenDataFound(stopWhenDataFound bool) StoreNodeRequestOption {
 	}
 }
 
+func WithRequireNewerCommunityDescription(requireNewer bool) StoreNodeRequestOption {
+	return func(c *StoreNodeRequestConfig) {
+		c.RequireNewerCommunityDescription = requireNewer
+	}
+}
+
 func WithInitialPageSize(initialPageSize uint64) StoreNodeRequestOption {
 	return func(c *StoreNodeRequestConfig) {
 		c.InitialPageSize = initialPageSize

protocol/messenger_store_node_request_manager_test.go

@@ -0,0 +1,22 @@
+package protocol
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestStoreNodeRequestCommunityDescriptionFreshness(t *testing.T) {
+	request := &storeNodeRequest{
+		minimumDataClock: 10,
+		config:           defaultStoreNodeRequestConfig(),
+	}
+
+	require.False(t, request.hasFoundCommunityDescription(10))
+	require.True(t, request.hasFoundCommunityDescription(11))
+
+	request.config = buildStoreNodeRequestConfig([]StoreNodeRequestOption{
+		WithRequireNewerCommunityDescription(false),
+	})
+	require.True(t, request.hasFoundCommunityDescription(10))
+}