Compare commits

...
Author SHA1 Message Date
Thomas SharedInbox db3bf5937d feat(U6): show sync status indicator in email list app bar
Replaces the static sync icon with a live status widget:
- Spinner (CircularProgressIndicator) while a sync cycle is active
- Red sync_problem icon when the last sync recorded an error
- Regular sync icon when idle (tapping still triggers a manual sync)

AccountSyncManager now exposes watchSyncing(accountId) — a broadcast
stream that emits true/false as each sync loop starts and ends.
The isSyncingProvider in di.dart bridges this to Riverpod.
2026-05-14 04:19:48 +02:00
Bot of Thomas Güttler 2715c1613f feat(U4): background sync and local notifications for new mail (#28) 2026-05-14 04:06:35 +02:00
10 changed files with 282 additions and 22 deletions
+1 -1
View File
@@ -35,7 +35,7 @@ android {
applicationId = "de.sharedinbox.mua"
// You can update the following values to match your application needs.
// For more information, see: https://flutter.dev/to/review-gradle-config.
minSdk = flutter.minSdkVersion
minSdk = 23
targetSdk = flutter.targetSdkVersion
versionCode = flutter.versionCode
versionName = flutter.versionName
+3
View File
@@ -1,5 +1,8 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.WAKE_LOCK"/>
<application
android:label="sharedinbox"
android:name="${applicationName}"
@@ -0,0 +1,38 @@
import 'dart:io';
import 'package:flutter_local_notifications/flutter_local_notifications.dart';
const _kChannelId = 'new_mail';
const _kChannelName = 'New mail';
final _plugin = FlutterLocalNotificationsPlugin();
Future<void> initNotifications() async {
const android = AndroidInitializationSettings('@mipmap/ic_launcher');
await _plugin.initialize(
const InitializationSettings(android: android),
onDidReceiveNotificationResponse: (_) {},
);
await _plugin
.resolvePlatformSpecificImplementation<
AndroidFlutterLocalNotificationsPlugin>()
?.requestNotificationsPermission();
}
Future<void> showNewMailNotification(String accountEmail) async {
if (!Platform.isAndroid) return;
await _plugin.show(
accountEmail.hashCode & 0x7FFFFFFF,
'New mail',
accountEmail,
const NotificationDetails(
android: AndroidNotificationDetails(
_kChannelId,
_kChannelName,
channelDescription: 'Notifications for new incoming mail',
importance: Importance.high,
priority: Priority.high,
),
),
);
}
+59 -5
View File
@@ -12,6 +12,8 @@ import 'package:sharedinbox/core/utils/logger.dart';
import 'package:sharedinbox/data/imap/imap_client_factory.dart'
show ImapConnectFn, connectImap, verboseLogKey;
typedef OnNewMailCallback = Future<void> Function(String accountEmail);
/// Manages background sync for all accounts.
///
/// IMAP accounts get an IDLE-based sync loop (_AccountSync).
@@ -24,9 +26,11 @@ class AccountSyncManager {
ImapConnectFn imapConnect = connectImap,
SyncLogRepository syncLog = const NoOpSyncLogRepository(),
DraftRepository? drafts,
OnNewMailCallback? onNewMail,
}) : _imapConnect = imapConnect,
_syncLog = syncLog,
_drafts = drafts;
_drafts = drafts,
_onNewMail = onNewMail;
final AccountRepository _accounts;
final MailboxRepository _mailboxes;
@@ -34,11 +38,22 @@ class AccountSyncManager {
final ImapConnectFn _imapConnect;
final SyncLogRepository _syncLog;
final DraftRepository? _drafts;
final OnNewMailCallback? _onNewMail;
final Map<String, _SyncLoop> _active = {};
StreamSubscription<List<Account>>? _accountsSub;
StreamSubscription<String>? _onChangesSub;
final _syncPhaseCtrl = StreamController<(String, bool)>.broadcast();
/// Emits `true` when [accountId] starts syncing, `false` when it stops.
Stream<bool> watchSyncing(String accountId) =>
_syncPhaseCtrl.stream.where((e) => e.$1 == accountId).map((e) => e.$2);
void _emitSyncing(String accountId, {required bool syncing}) {
if (!_syncPhaseCtrl.isClosed) _syncPhaseCtrl.add((accountId, syncing));
}
void start() {
_onChangesSub = _emails.onChangesQueued.listen((accountId) {
_active[accountId]?.kick();
@@ -49,6 +64,7 @@ class AccountSyncManager {
for (final account in accounts) {
if (_active.containsKey(account.id)) continue;
final id = account.id;
final loop = switch (account.type) {
AccountType.imap => _AccountSync(
account,
@@ -58,6 +74,9 @@ class AccountSyncManager {
_imapConnect,
_syncLog,
_drafts,
_onNewMail,
onSyncStart: () => _emitSyncing(id, syncing: true),
onSyncEnd: () => _emitSyncing(id, syncing: false),
),
AccountType.jmap => _JmapAccountSync(
account,
@@ -65,6 +84,8 @@ class AccountSyncManager {
_emails,
_accounts,
_syncLog,
onSyncStart: () => _emitSyncing(id, syncing: true),
onSyncEnd: () => _emitSyncing(id, syncing: false),
),
};
_active[account.id] = loop;
@@ -86,6 +107,7 @@ class AccountSyncManager {
s.stop();
}
_active.clear();
unawaited(_syncPhaseCtrl.close());
}
/// Wakes the idle/wait phase of the given account's sync loop so a new
@@ -119,6 +141,9 @@ class AccountSyncManager {
_imapConnect,
_syncLog,
_drafts,
_onNewMail,
onSyncStart: () => _emitSyncing(accountId, syncing: true),
onSyncEnd: () => _emitSyncing(accountId, syncing: false),
),
AccountType.jmap => _JmapAccountSync(
account,
@@ -126,6 +151,8 @@ class AccountSyncManager {
_emails,
_accounts,
_syncLog,
onSyncStart: () => _emitSyncing(accountId, syncing: true),
onSyncEnd: () => _emitSyncing(accountId, syncing: false),
),
};
_active[accountId] = loop;
@@ -152,7 +179,11 @@ class _AccountSync implements _SyncLoop {
this._imapConnect,
this._syncLog,
this._drafts,
);
this._onNewMail, {
void Function()? onSyncStart,
void Function()? onSyncEnd,
}) : _onSyncStart = onSyncStart,
_onSyncEnd = onSyncEnd;
final Account account;
final AccountRepository _accounts;
@@ -161,6 +192,9 @@ class _AccountSync implements _SyncLoop {
final ImapConnectFn _imapConnect;
final SyncLogRepository _syncLog;
final DraftRepository? _drafts;
final OnNewMailCallback? _onNewMail;
final void Function()? _onSyncStart;
final void Function()? _onSyncEnd;
imap.ImapClient? _idleClient;
bool _running = false;
@@ -193,6 +227,7 @@ class _AccountSync implements _SyncLoop {
Future<void> _loop() async {
while (_running) {
final startedAt = DateTime.now();
_onSyncStart?.call();
try {
final (_SyncStats stats, String? capturedLog) = await _runSync(
account.verbose,
@@ -212,8 +247,10 @@ class _AccountSync implements _SyncLoop {
protocolLog: capturedLog,
);
_backoffSeconds = 5;
_onSyncEnd?.call();
await _idle();
} catch (e, st) {
_onSyncEnd?.call();
final isPermanent = _isPermanentError(e);
try {
await _syncLog.log(
@@ -335,6 +372,7 @@ class _AccountSync implements _SyncLoop {
await client.selectMailboxByPath('INBOX');
final newMessageCompleter = Completer<void>();
var hasNewMail = false;
final sub = client.eventBus
.on<imap.ImapEvent>()
@@ -342,7 +380,11 @@ class _AccountSync implements _SyncLoop {
(e) =>
e is imap.ImapMessagesExistEvent || e is imap.ImapExpungeEvent,
)
.listen((_) {
.listen((e) {
if (e is imap.ImapMessagesExistEvent &&
e.newMessagesExists > e.oldMessagesExists) {
hasNewMail = true;
}
if (!newMessageCompleter.isCompleted) newMessageCompleter.complete();
});
@@ -358,6 +400,10 @@ class _AccountSync implements _SyncLoop {
await client.idleDone();
await sub.cancel();
if (hasNewMail) {
unawaited(_onNewMail?.call(account.email));
}
} finally {
await client.logout();
_idleClient = null;
@@ -374,14 +420,19 @@ class _JmapAccountSync implements _SyncLoop {
this._mailboxes,
this._emails,
this._accounts,
this._syncLog,
);
this._syncLog, {
void Function()? onSyncStart,
void Function()? onSyncEnd,
}) : _onSyncStart = onSyncStart,
_onSyncEnd = onSyncEnd;
final Account account;
final MailboxRepository _mailboxes;
final EmailRepository _emails;
final AccountRepository _accounts;
final SyncLogRepository _syncLog;
final void Function()? _onSyncStart;
final void Function()? _onSyncEnd;
bool _running = false;
int _backoffSeconds = 5;
@@ -413,6 +464,7 @@ class _JmapAccountSync implements _SyncLoop {
Future<void> _loop() async {
while (_running) {
final startedAt = DateTime.now();
_onSyncStart?.call();
try {
final (_SyncStats stats, String? capturedLog) = await _runSync(
account.verbose,
@@ -432,8 +484,10 @@ class _JmapAccountSync implements _SyncLoop {
protocolLog: capturedLog,
);
_backoffSeconds = 5;
_onSyncEnd?.call();
await _wait();
} catch (e, st) {
_onSyncEnd?.call();
final isPermanent = _isPermanentError(e);
try {
await _syncLog.log(
+123
View File
@@ -0,0 +1,123 @@
import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:drift/drift.dart';
import 'package:drift/native.dart';
import 'package:enough_mail/enough_mail.dart' as imap;
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
import 'package:sharedinbox/core/models/account.dart' as model;
import 'package:sharedinbox/core/repositories/account_repository.dart';
import 'package:sharedinbox/core/services/notification_service.dart';
import 'package:sharedinbox/data/db/database.dart';
import 'package:sharedinbox/data/imap/imap_client_factory.dart';
import 'package:sharedinbox/data/repositories/account_repository_impl.dart';
import 'package:sharedinbox/data/storage/flutter_secure_storage_impl.dart';
import 'package:workmanager/workmanager.dart';
const _kTaskName = 'si_bg_sync';
const _kResourceType = 'background_check';
@pragma('vm:entry-point')
void callbackDispatcher() {
Workmanager().executeTask((_, __) async {
try {
await _doBackgroundSync();
} catch (_) {}
return true;
});
}
Future<void> registerBackgroundSync() async {
await Workmanager().initialize(callbackDispatcher);
await Workmanager().registerPeriodicTask(
_kTaskName,
_kTaskName,
frequency: const Duration(minutes: 15),
constraints: Constraints(networkType: NetworkType.connected),
existingWorkPolicy: ExistingWorkPolicy.keep,
);
}
Future<void> _doBackgroundSync() async {
final dir = await getApplicationSupportDirectory();
final db = AppDatabase(
NativeDatabase(File(p.join(dir.path, 'sharedinbox.db'))),
);
try {
final accountRepo = AccountRepositoryImpl(
db,
const FlutterSecureStorageImpl(),
);
final accounts = await accountRepo.observeAccounts().first;
await initNotifications();
for (final account in accounts) {
if (account.type != model.AccountType.imap) continue;
await _checkAccount(db, accountRepo, account);
}
} finally {
await db.close();
}
}
Future<void> _checkAccount(
AppDatabase db,
AccountRepository accountRepo,
model.Account account,
) async {
try {
final password = await accountRepo.getPassword(account.id);
final username =
account.username.isNotEmpty ? account.username : account.email;
final client = await connectImap(account, username, password);
try {
final status = await client.statusMailbox(
imap.Mailbox.virtual('INBOX', []),
[imap.StatusFlags.uidNext],
);
final currentUidNext = status.uidNext;
final stored = await (db.select(db.syncStates)
..where(
(t) =>
t.accountId.equals(account.id) &
t.resourceType.equals(_kResourceType),
))
.getSingleOrNull();
final lastUidNext = _parseUidNext(stored?.state);
await db.into(db.syncStates).insertOnConflictUpdate(
SyncStatesCompanion.insert(
accountId: account.id,
resourceType: _kResourceType,
state: jsonEncode({'uidNext': currentUidNext}),
syncedAt: DateTime.now(),
),
);
if (lastUidNext != null &&
currentUidNext != null &&
currentUidNext > lastUidNext) {
await showNewMailNotification(account.email);
}
} finally {
await client.logout();
}
} catch (_) {}
}
int? _parseUidNext(String? state) {
if (state == null) return null;
try {
final decoded = jsonDecode(state);
if (decoded is Map<String, Object?>) {
return decoded['uidNext'] as int?;
}
return null;
} catch (_) {
return null;
}
}
+7
View File
@@ -12,6 +12,7 @@ import 'package:sharedinbox/core/repositories/undo_repository.dart';
import 'package:sharedinbox/core/services/account_discovery_service.dart';
import 'package:sharedinbox/core/services/connection_test_service.dart';
import 'package:sharedinbox/core/services/managesieve_probe_service.dart';
import 'package:sharedinbox/core/services/notification_service.dart';
import 'package:sharedinbox/core/services/undo_service.dart';
import 'package:sharedinbox/core/storage/secure_storage.dart';
import 'package:sharedinbox/core/sync/account_sync_manager.dart';
@@ -114,6 +115,11 @@ final syncHealthProvider =
.watchSingleOrNull();
});
final isSyncingProvider =
StreamProvider.autoDispose.family<bool, String>((ref, accountId) {
return ref.watch(syncManagerProvider).watchSyncing(accountId);
});
final syncManagerProvider = Provider<AccountSyncManager>((ref) {
final manager = AccountSyncManager(
ref.watch(accountRepositoryProvider),
@@ -122,6 +128,7 @@ final syncManagerProvider = Provider<AccountSyncManager>((ref) {
syncLog: ref.watch(syncLogRepositoryProvider),
imapConnect: ref.watch(imapConnectProvider),
drafts: ref.watch(draftRepositoryProvider),
onNewMail: showNewMailNotification,
);
ref.onDispose(manager.dispose);
return manager;
+7
View File
@@ -1,8 +1,11 @@
import 'dart:async';
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:sharedinbox/core/services/notification_service.dart';
import 'package:sharedinbox/core/sync/background_sync.dart';
import 'package:sharedinbox/data/db/database.dart';
import 'package:sharedinbox/di.dart';
import 'package:sharedinbox/ui/router.dart';
@@ -32,6 +35,10 @@ void main({List<Override> overrides = const []}) async {
};
await initDatabasePath();
if (Platform.isAndroid) {
await initNotifications();
await registerBackgroundSync();
}
runApp(
ProviderScope(overrides: overrides, child: const SharedInboxApp()),
);
+39 -16
View File
@@ -180,22 +180,7 @@ class _EmailListScreenState extends ConsumerState<EmailListScreen> {
),
),
),
IconButton(
icon: const Icon(Icons.sync),
onPressed: () async {
try {
await emailRepo.syncEmails(
widget.accountId,
widget.mailboxPath,
);
} catch (e) {
if (!mounted) return;
ScaffoldMessenger.of(
context,
).showSnackBar(SnackBar(content: Text('Sync failed: $e')));
}
},
),
_buildSyncButton(emailRepo),
IconButton(
icon: const Icon(Icons.edit),
onPressed: () => context.push(
@@ -229,6 +214,44 @@ class _EmailListScreenState extends ConsumerState<EmailListScreen> {
);
}
Widget _buildSyncButton(EmailRepository emailRepo) {
final isSyncing =
ref.watch(isSyncingProvider(widget.accountId)).valueOrNull ?? false;
final hasError =
ref.watch(syncLastErrorProvider(widget.accountId)).valueOrNull != null;
return IconButton(
tooltip: isSyncing
? 'Syncing…'
: hasError
? 'Sync error'
: 'Sync',
icon: isSyncing
? const SizedBox(
width: 20,
height: 20,
child: CircularProgressIndicator(strokeWidth: 2),
)
: hasError
? const Icon(Icons.sync_problem, color: Colors.red)
: const Icon(Icons.sync),
onPressed: isSyncing
? null
: () async {
try {
await emailRepo.syncEmails(
widget.accountId,
widget.mailboxPath,
);
} catch (e) {
if (!mounted) return;
ScaffoldMessenger.of(context).showSnackBar(
SnackBar(content: Text('Sync failed: $e')),
);
}
},
);
}
Widget _selectionBottomBar() {
return BottomAppBar(
child: Row(
+4
View File
@@ -45,6 +45,10 @@ dependencies:
url_launcher: ^6.3.2
flutter_markdown: ^0.7.7+1
# Background sync and local notifications
flutter_local_notifications: ^18.0.1
workmanager: ^0.5.2
dev_dependencies:
flutter_test:
sdk: flutter
+1
View File
@@ -52,6 +52,7 @@ const _excluded = {
'lib/ui/widgets/try_connection_button.dart',
'lib/ui/widgets/undo_shell.dart',
'lib/core/sync/account_sync_manager.dart',
'lib/core/sync/background_sync.dart',
'lib/core/sync/reliability_runner.dart',
'lib/data/jmap/jmap_client.dart',
'lib/data/jmap/sieve_repository.dart',