Skip to content

Commit 4f00463

Browse files
committed
Bound coalesced profile queries to relay page limits
Signed-off-by: Tom Brow <[email protected]>
1 parent 58f0768 commit 4f00463

2 files changed

Lines changed: 228 additions & 21 deletions

File tree

‎mobile/lib/shared/profile/user_cache_provider.dart‎

Lines changed: 45 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ import 'profile_event_parser.dart';
1212
/// In-memory cache of user profiles, fetched in batches from the relay.
1313
///
1414
/// Lookups requested via [get] or [preload] are coalesced into a single
15-
/// kind:0 batch query (NIP-01 `authors` filter) every 50ms.
15+
/// kind:0 batch query (NIP-01 `authors` filter) every 50ms. Larger requests
16+
/// drain sequentially in pages bounded by the relay response limit.
1617
class UserCacheNotifier extends Notifier<Map<String, UserProfile>> {
18+
// The relay clamps each history response to DEFAULT_MAX_PAGE_LIMIT (1000).
19+
static const _maximumProfilesPerQuery = 1000;
20+
1721
final Set<String> _pending = {};
1822
final _pushExport = PushPresentationExportRecovery();
1923
final Map<String, ({int createdAt, String eventId})> _profileEventOrders = {};
@@ -83,11 +87,15 @@ class UserCacheNotifier extends Notifier<Map<String, UserProfile>> {
8387
final generation = _generation;
8488
try {
8589
final session = ref.read(relaySessionProvider.notifier);
86-
final events = await session.fetchHistory(
87-
NostrFilters.profilesBatch(normalized),
88-
);
89-
if (!_isCurrent(generation)) return false;
90-
return await _verifyAndMerge(events, generation);
90+
for (final batch in _profileQueryBatches(normalized)) {
91+
if (!_isCurrent(generation)) return false;
92+
final events = await session.fetchHistory(
93+
NostrFilters.profilesBatch(batch),
94+
);
95+
if (!_isCurrent(generation)) return false;
96+
if (!await _verifyAndMerge(events, generation)) return false;
97+
}
98+
return true;
9199
} catch (_) {
92100
return false;
93101
}
@@ -125,22 +133,27 @@ class UserCacheNotifier extends Notifier<Map<String, UserProfile>> {
125133
try {
126134
final communityID = ref.read(activeCommunityProvider).value?.id;
127135
final session = ref.read(relaySessionProvider.notifier);
128-
final events = await session.fetchHistory(
129-
NostrFilters.profilesBatch(pubkeys),
130-
);
131-
132-
if (!_isCurrent(generation)) return;
133-
if (!await _verifyAndMerge(events, generation)) return;
134-
// Profile consumers can proceed as soon as their data is ready. Keep the
135-
// fetch slot occupied until export drains so later requests coalesce.
136-
succeeded = true;
137-
completer?.complete(true);
138-
if (communityID != null) {
139-
// Keep later profile requests in _pending until this exact batch has
140-
// reached the cache or its bounded recovery has failed.
141-
await _pushExport.export(
142-
() => cacheBuzzPushProfileEvents(communityID, events),
136+
var remaining = pubkeys.length;
137+
for (final batch in _profileQueryBatches(pubkeys)) {
138+
if (!_isCurrent(generation)) return;
139+
final events = await session.fetchHistory(
140+
NostrFilters.profilesBatch(batch),
143141
);
142+
if (!_isCurrent(generation)) return;
143+
if (!await _verifyAndMerge(events, generation)) return;
144+
remaining -= batch.length;
145+
if (remaining == 0) {
146+
// All requested pages are ready. Native export does not gate readers.
147+
succeeded = true;
148+
completer?.complete(true);
149+
}
150+
if (communityID != null) {
151+
// Drain each page before fetching another, retaining at most one raw
152+
// response while later requests coalesce as pubkeys in _pending.
153+
await _pushExport.export(
154+
() => cacheBuzzPushProfileEvents(communityID, events),
155+
);
156+
}
144157
}
145158
} catch (_) {
146159
// Silently fail — non-gating callers will just show pubkeys.
@@ -153,6 +166,17 @@ class UserCacheNotifier extends Notifier<Map<String, UserProfile>> {
153166
}
154167
}
155168

169+
Iterable<List<String>> _profileQueryBatches(List<String> pubkeys) sync* {
170+
for (
171+
var start = 0;
172+
start < pubkeys.length;
173+
start += _maximumProfilesPerQuery
174+
) {
175+
final end = start + _maximumProfilesPerQuery;
176+
yield pubkeys.sublist(start, end < pubkeys.length ? end : pubkeys.length);
177+
}
178+
}
179+
156180
void _scheduleBatch() {
157181
if (_flushInFlight) return;
158182
_batchTimer ??= Timer(const Duration(milliseconds: 50), _flushPending);
Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
import 'dart:async';
2+
import 'dart:convert';
3+
4+
import 'package:buzz/shared/community/community.dart';
5+
import 'package:buzz/shared/community/community_provider.dart';
6+
import 'package:buzz/shared/profile/user_cache_provider.dart';
7+
import 'package:buzz/shared/relay/relay.dart';
8+
import 'package:flutter/foundation.dart';
9+
import 'package:flutter/services.dart';
10+
import 'package:flutter_test/flutter_test.dart';
11+
import 'package:hooks_riverpod/hooks_riverpod.dart';
12+
import 'package:nostr/nostr.dart' as nostr;
13+
14+
void main() {
15+
TestWidgetsFlutterBinding.ensureInitialized();
16+
const bridge = MethodChannel('buzz/push');
17+
final messenger =
18+
TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger;
19+
20+
test(
21+
'pending profiles drain in bounded queries after delayed export',
22+
() async {
23+
debugDefaultTargetPlatformOverride = TargetPlatform.iOS;
24+
final entered = Completer<void>();
25+
final release = Completer<void>();
26+
messenger.setMockMethodCallHandler(bridge, (_) async {
27+
if (!entered.isCompleted) {
28+
entered.complete();
29+
await release.future;
30+
}
31+
return null;
32+
});
33+
addTearDown(() {
34+
messenger.setMockMethodCallHandler(bridge, null);
35+
debugDefaultTargetPlatformOverride = null;
36+
});
37+
final signed = NostrEvent.fromJson(
38+
nostr.Event.from(
39+
kind: 0,
40+
createdAt: 1,
41+
content: '{"name":"First"}',
42+
tags: [],
43+
secretKey: '1'.padLeft(64, '0'),
44+
).toMap(),
45+
);
46+
final session = _ClampingSession(first: signed);
47+
final container = ProviderContainer(
48+
overrides: [
49+
relaySessionProvider.overrideWith(() => session),
50+
activeCommunityProvider.overrideWith(
51+
(ref) async => Community(
52+
id: 'original',
53+
name: 'Synthetic',
54+
relayUrl: 'https://example.invalid',
55+
addedAt: DateTime(2026),
56+
),
57+
),
58+
],
59+
);
60+
addTearDown(container.dispose);
61+
await container.read(activeCommunityProvider.future);
62+
final cache = container.read(userCacheProvider.notifier);
63+
expect(await cache.preload([signed.pubkey]), isTrue);
64+
await entered.future.timeout(const Duration(seconds: 5));
65+
final keys = List.generate(1001, (i) => 'profile-$i');
66+
var completed = false;
67+
final pending = cache.preload(keys).then((result) {
68+
completed = true;
69+
return result;
70+
});
71+
final duplicate = cache.preload(keys);
72+
try {
73+
await Future<void>.delayed(const Duration(milliseconds: 60));
74+
expect(session.filters, hasLength(1));
75+
expect(completed, isFalse);
76+
} finally {
77+
release.complete();
78+
}
79+
expect(await pending, isTrue);
80+
expect(await duplicate, isTrue);
81+
expect(container.read(userCacheProvider).keys, containsAll(keys));
82+
expect(session.filters.map((f) => f.authors!.length), [1, 1000, 1]);
83+
expect(session.filters.map((f) => f.limit), [1, 1000, 1]);
84+
expect(session.maxRunning, 1);
85+
},
86+
);
87+
88+
for (final preload in [true, false]) {
89+
for (final outcome in ['success', 'failure', 'community change']) {
90+
test(
91+
'${preload ? "preload" : "refresh"} waits for final bounded query: $outcome',
92+
() async {
93+
final started = Completer<void>();
94+
final release = Completer<void>();
95+
final session = _ClampingSession(
96+
beforeFetch: (index) async {
97+
if (index != 1) return;
98+
started.complete();
99+
await release.future;
100+
if (outcome == 'failure') throw StateError('relay unavailable');
101+
},
102+
);
103+
final container = ProviderContainer(
104+
overrides: [relaySessionProvider.overrideWith(() => session)],
105+
);
106+
addTearDown(container.dispose);
107+
final cache = container.read(userCacheProvider.notifier);
108+
final keys = List.generate(1001, (i) => 'profile-$i');
109+
bool? result;
110+
final done = (preload ? cache.preload(keys) : cache.refresh(keys))
111+
.then((value) => result = value);
112+
await started.future.timeout(const Duration(seconds: 5));
113+
expect(result, isNull);
114+
expect(container.read(userCacheProvider), hasLength(1000));
115+
if (outcome == 'community change') {
116+
container
117+
.read(relayConfigProvider.notifier)
118+
.update(baseUrl: 'https://next.invalid');
119+
container.read(userCacheProvider);
120+
}
121+
release.complete();
122+
await done;
123+
expect(result, outcome == 'success');
124+
expect(session.filters.map((f) => f.authors!.length), [1000, 1]);
125+
expect(session.maxRunning, 1);
126+
expect(
127+
container.read(userCacheProvider),
128+
hasLength(
129+
outcome == 'community change'
130+
? 0
131+
: outcome == 'failure'
132+
? 1000
133+
: 1001,
134+
),
135+
);
136+
},
137+
);
138+
}
139+
}
140+
}
141+
142+
class _ClampingSession extends RelaySessionNotifier {
143+
_ClampingSession({this.first, this.beforeFetch});
144+
final NostrEvent? first;
145+
final Future<void> Function(int)? beforeFetch;
146+
final filters = <NostrFilter>[];
147+
int running = 0;
148+
int maxRunning = 0;
149+
150+
@override
151+
SessionState build() => const SessionState(status: SessionStatus.connected);
152+
153+
@override
154+
Future<List<NostrEvent>> fetchHistory(
155+
NostrFilter filter, {
156+
Duration timeout = const Duration(seconds: 8),
157+
}) async {
158+
final index = filters.length;
159+
filters.add(filter);
160+
running++;
161+
if (running > maxRunning) maxRunning = running;
162+
try {
163+
await beforeFetch?.call(index);
164+
return [
165+
for (final key in filter.authors!.take(1000))
166+
if (key == first?.pubkey)
167+
first!
168+
else
169+
NostrEvent(
170+
id: key,
171+
pubkey: key,
172+
createdAt: 1,
173+
kind: 0,
174+
tags: [],
175+
content: jsonEncode({'name': key}),
176+
sig: 'synthetic',
177+
),
178+
];
179+
} finally {
180+
running--;
181+
}
182+
}
183+
}

0 commit comments

Comments
 (0)