Skip to content

Commit 28a8b90

Browse files
wpfleger96Hayt
andauthored
fix(mobile): keep retired sections manager out of successor cache (#7873)
Follow-up to #7806. - **A retired sections manager never writes the shared prefs cache.** `_persist()` now returns once the manager is disposed. That covers every path a torn-down manager could take after an account or relay switch, including a late OK restoring its submitted layout and the `dispose()` flush's read-before-write merging a head. Before this change, both could overwrite the successor's cache on the same pubkey key. - **Coverage:** - a retired late OK and a retired flush pre-read both leave the successor's cache untouched - an edit made while an OK is held still publishes after the OK is released (`_lastPublishedStore` is built from the submitted store) - a same-second losing head adopted after a local edit still converges UI, cache and relay once our OK wins. The adopted layout's pending debounce is deliberately left armed, because its republish is what re-converges this race. **Residual:** an edit made just before our own echo arrives can be replaced by that echo. This is existing behaviour on main and on desktop. --------- Signed-off-by: Will Pfleger <[email protected]> Co-authored-by: Hayt <211b96e6a2b7f45fd4047988976c7bbbeeda0c15f3ae7b32eec20834b5a55118@buzz.block.builderlab.xyz>
1 parent 8f6b66f commit 28a8b90

2 files changed

Lines changed: 126 additions & 0 deletions

File tree

‎mobile/lib/features/channels/channel_sections/channel_sections_manager.dart‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,8 @@ class ChannelSectionsManager {
416416
_lastRemoteEventId = event.id;
417417
_store = incoming;
418418
_persist();
419+
// A pending debounce stays armed: its republish re-converges an OK
420+
// that later wins the cursor after this head replaced the store.
419421
}
420422
} catch (_) {
421423
// Decryption failure or parse error — keep existing state.
@@ -511,7 +513,9 @@ class ChannelSectionsManager {
511513
}
512514
}
513515

516+
/// A retired manager never writes the prefs key its successor now owns.
514517
void _persist() {
518+
if (_disposed) return;
515519
_storage.write(pubkey, _store);
516520
}
517521

‎mobile/test/features/channels/channel_reader_recovery_test.dart‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,128 @@ void wholeBlobLanes(SharedPreferences Function() prefs) {
430430
expect(names(), ['mine']);
431431
expect(prefs().getString(prefs().getKeys().single), contains('"mine"'));
432432
});
433+
434+
fakeAsyncTest('a same-second loser adopted after an edit re-converges', (
435+
clock,
436+
) {
437+
relay.holdOk = Completer<void>();
438+
start(clock).createSection('mine');
439+
clock.elapse(const Duration(seconds: 5));
440+
final own = relay.published.single;
441+
m.renameSection(m.store.sections.single.id, 'new-local');
442+
final loser = relay.event(
443+
'channel-sections',
444+
blob('loser'),
445+
own.createdAt,
446+
id: ''.padLeft(64, 'f'),
447+
);
448+
relay
449+
..stored.add(loser)
450+
..emit(loser);
451+
clock.elapse(const Duration(milliseconds: 20));
452+
expect(names(), ['loser']);
453+
relay.holdOk!.complete();
454+
relay.holdOk = null;
455+
clock.flushMicrotasks();
456+
clock.elapse(const Duration(seconds: 6));
457+
final heads = relay.stored.toList()
458+
..sort(
459+
(a, b) => a.createdAt != b.createdAt
460+
? b.createdAt.compareTo(a.createdAt)
461+
: a.id.compareTo(b.id),
462+
);
463+
final retained = relay.decrypt(heads.first) as Map<String, dynamic>;
464+
relay.emit(heads.first);
465+
m.refreshFromRelay();
466+
clock.elapse(const Duration(milliseconds: 20));
467+
expect(names(), [
468+
for (final s in retained['sections'] as List) s['name'],
469+
]);
470+
expect(prefs().getString(prefs().getKeys().single), jsonEncode(retained));
471+
});
472+
473+
fakeAsyncTest(
474+
'a retired flush pre-read cannot rewrite the successor cache',
475+
(clock) {
476+
start(clock).createSection('mine');
477+
final held = relay.holdHistory = Completer<void>();
478+
m.dispose();
479+
clock.flushMicrotasks();
480+
m = ChannelSectionsManager(
481+
pubkey: relay.pubkey,
482+
prefs: prefs(),
483+
crypto: ChannelSectionsCrypto(relay.keys.nsec, relay.pubkey),
484+
relaySession: relay.session,
485+
signedEventRelay: relay.signer,
486+
remoteEnabled: false,
487+
onChanged: () {},
488+
)..initialize();
489+
m.renameSection(m.store.sections.single.id, 'successor-local');
490+
clock.flushMicrotasks();
491+
final before = prefs().getString(prefs().getKeys().single);
492+
held.complete();
493+
relay.holdHistory = null;
494+
clock.flushMicrotasks();
495+
expect(names(), ['successor-local']);
496+
expect(prefs().getString(prefs().getKeys().single), before);
497+
},
498+
);
499+
500+
fakeAsyncTest('a local edit during the OK wait still publishes', (clock) {
501+
relay.holdOk = Completer<void>();
502+
start(clock).createSection('mine');
503+
clock.elapse(const Duration(seconds: 5));
504+
expect(relay.published, hasLength(1));
505+
m.renameSection(m.store.sections.single.id, 'new-local');
506+
relay.holdOk!.complete();
507+
relay.holdOk = null;
508+
clock.flushMicrotasks();
509+
expect(names(), ['new-local']);
510+
clock.elapse(const Duration(seconds: 5));
511+
expect(relay.published, hasLength(2));
512+
expect(
513+
jsonEncode(relay.decrypt(relay.published.last)),
514+
contains('"new-local"'),
515+
);
516+
});
517+
518+
fakeAsyncTest('a retired late OK cannot rewrite the successor cache', (
519+
clock,
520+
) {
521+
relay.holdOk = Completer<void>();
522+
start(clock).createSection('mine');
523+
clock.elapse(const Duration(seconds: 5));
524+
final own = relay.published.single;
525+
final loser = relay.event(
526+
'channel-sections',
527+
blob('loser'),
528+
own.createdAt,
529+
id: ''.padLeft(64, 'f'),
530+
);
531+
relay
532+
..stored.add(loser)
533+
..emit(loser);
534+
clock.elapse(const Duration(milliseconds: 20));
535+
expect(names(), ['loser']);
536+
m.dispose(flushPending: false);
537+
m = ChannelSectionsManager(
538+
pubkey: relay.pubkey,
539+
prefs: prefs(),
540+
crypto: ChannelSectionsCrypto(relay.keys.nsec, relay.pubkey),
541+
relaySession: relay.session,
542+
signedEventRelay: relay.signer,
543+
remoteEnabled: false,
544+
onChanged: () {},
545+
)..initialize();
546+
m.renameSection('loser', 'successor-local');
547+
clock.flushMicrotasks();
548+
final before = prefs().getString(prefs().getKeys().single);
549+
expect(before, contains('"successor-local"'));
550+
relay.holdOk!.complete();
551+
clock.flushMicrotasks();
552+
expect(names(), ['successor-local']);
553+
expect(prefs().getString(prefs().getKeys().single), before);
554+
});
433555
});
434556

435557
group('sort', () {

0 commit comments

Comments
 (0)