💚 End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
Refactor large backup session tracking and integrate standby screen logic
AmanRajSinghMouryab91ff524bd77
diff --git a/mobile/apps/photos/lib/services/sync/large_backup_session_tracker.dart b/mobile/apps/photos/lib/services/sync/large_backup_session_tracker.dartindex ef018f3069..329d261528 100644--- a/mobile/apps/photos/lib/services/sync/large_backup_session_tracker.dart+++ b/mobile/apps/photos/lib/services/sync/large_backup_session_tracker.dart@@ -1,32 +1,27 @@import "package:flutter/foundation.dart";-import "package:logging/logging.dart";import "package:photos/events/sync_status_update_event.dart";-import "package:photos/extensions/logger_extension.dart";-/// Tracks whether the current upload session is large enough to offer the-/// foreground standby screen.class LargeBackupSessionTracker extends ChangeNotifier {- static final _logger = Logger("LargeBackupSessionTracker");- static const int minimumFileCount = 2;+ static const int minimumFileCount = 1000;bool _isEligible = false;bool _isUploading = false;int _remainingCount = 0;- SyncStatus? _lastStatus;+ bool _isStandbyScreenActive = false;- // A backup can contain multiple upload batches. The session remains active- // while the sync service prepares the next batch, even though the current- // batch's remaining count is temporarily zero.bool get isActive => _isUploading && _isEligible;int get remainingCount => _remainingCount;- SyncStatus? get lastStatus => _lastStatus;+ bool get isStandbyScreenActive => _isStandbyScreenActive;++ void setStandbyScreenActive(bool value) {+ _isStandbyScreenActive = value;+ }void update(SyncStatusUpdate event) {final wasActive = isActive;final previousRemainingCount = _remainingCount;- _lastStatus = event.status;switch (event.status) {case SyncStatus.preparingForUpload:@@ -53,16 +48,6 @@ class LargeBackupSessionTracker extends ChangeNotifier {break;}- if (event.status != SyncStatus.inProgress || _remainingCount == 0) {- _logger.internalInfo(- "status=${event.status.name}, total=${event.total}, "- "completed=${event.completed}, uploading=$_isUploading, "- "eligible=$_isEligible, remaining=$_remainingCount, "- "active=$isActive, "- "threshold=$minimumFileCount",- );- }-if (wasActive != isActive || previousRemainingCount != _remainingCount) {notifyListeners();}diff --git a/mobile/apps/photos/lib/services/sync/sync_service.dart b/mobile/apps/photos/lib/services/sync/sync_service.dartindex a8bf7f3725..27ee36415b 100644--- a/mobile/apps/photos/lib/services/sync/sync_service.dart+++ b/mobile/apps/photos/lib/services/sync/sync_service.dart@@ -19,6 +19,7 @@ import 'package:photos/module/upload/service/file_uploader.dart';import 'package:photos/service_locator.dart';import 'package:photos/services/language_service.dart';import 'package:photos/services/notification_service.dart';+import 'package:photos/services/sync/large_backup_session_tracker.dart';import 'package:photos/services/sync/local_sync_service.dart';import 'package:photos/services/sync/offline_import_metadata_service.dart';import 'package:photos/services/sync/remote_sync_service.dart';@@ -26,6 +27,7 @@ import 'package:shared_preferences/shared_preferences.dart';class SyncService {final _logger = Logger("SyncService");+ final largeBackupSessionTracker = LargeBackupSessionTracker();final _localSyncService = LocalSyncService.instance;final _remoteSyncService = RemoteSyncService.instance;final _uploader = FileUploader.instance;@@ -98,6 +100,7 @@ class SyncService {});Bus.instance.on<SyncStatusUpdate>().listen((event) {+ largeBackupSessionTracker.update(event);_logger.info("Sync status received " + event.toString());_lastSyncStatusEvent = event;});@@ -153,6 +156,7 @@ class SyncService {Bus.instance.fire(SyncStatusUpdate(SyncStatus.error, error: e));} on UnauthorizedError {_logger.info("Logging user out");+ Bus.instance.fire(SyncStatusUpdate(SyncStatus.error));Bus.instance.fire(TriggerLogoutEvent());} on NoMediaLocationAccessError {_logger.severe("Not uploading due to no media location access");diff --git a/mobile/apps/photos/lib/ui/home/backup_standby_screen.dart b/mobile/apps/photos/lib/ui/home/backup_standby_screen.dartindex ab25c626fc..69497534ce 100644--- a/mobile/apps/photos/lib/ui/home/backup_standby_screen.dart+++ b/mobile/apps/photos/lib/ui/home/backup_standby_screen.dart@@ -1,9 +1,11 @@+import "dart:async";+import "package:ente_components/ente_components.dart";+import "package:ente_screen_brightness/ente_screen_brightness.dart";import "package:ente_strings/ente_strings.dart";import "package:flutter/material.dart";import "package:intl/intl.dart";import "package:logging/logging.dart";-import "package:photos/extensions/logger_extension.dart";import "package:photos/service_locator.dart";import "package:photos/services/sync/large_backup_session_tracker.dart";import "package:photos/services/wake_lock_service.dart";@@ -20,9 +22,13 @@ class BackupStandbyScreen extends StatefulWidget {class _BackupStandbyScreenState extends State<BackupStandbyScreen>with WidgetsBindingObserver {static final _logger = Logger("BackupStandbyScreen");+ static const _dimmingDelay = Duration(seconds: 3);+ static const _dimmedBrightness = 0.15;late int _remainingCount;+ Timer? _dimmingTimer;bool _isClosing = false;+ bool _isScreenDimmed = false;bool _isWakeLockEnabled = false;@override@@ -32,52 +38,41 @@ class _BackupStandbyScreenState extends State<BackupStandbyScreen>WidgetsBinding.instance.addObserver(this);widget.sessionTracker.addListener(_handleBackupSessionChanged);final isBackupActive = widget.sessionTracker.isActive;- _logger.internalInfo(- "Opened with remaining=$_remainingCount, "- "backupActive=$isBackupActive, "- "persistentAutoLock="- "${wakeLockService.shouldKeepAppAwakeAcrossSessions}",- );if (isBackupActive) {_setWakeLock(enable: true);+ _scheduleScreenDimming();} else {- _logger.internalInfo("Closing because backup finished before opening");- WidgetsBinding.instance.addPostFrameCallback(- (_) => _dismiss(reason: "backupInactiveBeforeOpening"),- );+ WidgetsBinding.instance.addPostFrameCallback((_) => _dismiss());}}@overridevoid didChangeAppLifecycleState(AppLifecycleState state) {final isBackupActive = widget.sessionTracker.isActive;- _logger.internalInfo(- "Lifecycle=${state.name}, backupActive=$isBackupActive, "- "closing=$_isClosing, wakeLockRequested=$_isWakeLockEnabled",- );switch (state) {case AppLifecycleState.resumed:if (!_isClosing && isBackupActive) {_setWakeLock(enable: true);+ _scheduleScreenDimming();} else if (!_isClosing) {- _dismiss(reason: "backupInactiveOnResume");+ _dismiss();}break;case AppLifecycleState.inactive:+ _restoreScreenBrightness(resetText: true);+ break;case AppLifecycleState.paused:case AppLifecycleState.hidden:- case AppLifecycleState.detached:_setWakeLock(enable: false);break;+ case AppLifecycleState.detached:+ break;}}@overridevoid dispose() {- _logger.internalInfo(- "Disposing with remaining=$_remainingCount, "- "wakeLockRequested=$_isWakeLockEnabled",- );+ _restoreScreenBrightness();_setWakeLock(enable: false);widget.sessionTracker.removeListener(_handleBackupSessionChanged);WidgetsBinding.instance.removeObserver(this);@@ -86,27 +81,37 @@ class _BackupStandbyScreenState extends State<BackupStandbyScreen>@overrideWidget build(BuildContext context) {+ const colors = ColorTokens.light;final formattedCount = NumberFormat().format(_remainingCount);final memoryLabel = _remainingCount == 1 ? "memory" : "memories";+ final statusText = _remainingCount > 0+ ? pendingTranslation("Preserving $formattedCount $memoryLabel")+ : pendingTranslation("Checking for more…");+ final statusColor = colors.specialWhite.withValues(+ alpha: _isScreenDimmed ? 0.35 : 1,+ );+ final instructionColor = colors.textLightest.withValues(+ alpha: _isScreenDimmed ? 0.50 : 1,+ );return GestureDetector(key: const ValueKey("large-backup-standby-screen"),behavior: HitTestBehavior.opaque,- onTap: () => _dismiss(reason: "userTap"),+ onTap: _dismiss,child: Scaffold(- backgroundColor: Colors.black,+ backgroundColor: colors.fillBase,body: Center(child: Column(mainAxisSize: MainAxisSize.min,children: [Text(- pendingTranslation("Preserving $formattedCount $memoryLabel"),- style: TextStyles.large.copyWith(color: Colors.white),+ statusText,+ style: TextStyles.large.copyWith(color: statusColor),),const SizedBox(height: 17),Text(- pendingTranslation("Tap to wake the screen"),- style: TextStyles.body.copyWith(color: const Color(0xFFD6D6D6)),+ pendingTranslation("Tap to return to Ente"),+ style: TextStyles.body.copyWith(color: instructionColor),),],),@@ -121,7 +126,7 @@ class _BackupStandbyScreenState extends State<BackupStandbyScreen>}if (!widget.sessionTracker.isActive) {- _dismiss(reason: "syncStatus:${widget.sessionTracker.lastStatus?.name}");+ _dismiss();return;}@@ -134,37 +139,65 @@ class _BackupStandbyScreenState extends State<BackupStandbyScreen>});}- void _dismiss({required String reason}) {- if (_isClosing) {- _logger.internalInfo("Ignored duplicate dismissal: $reason");- return;- }- if (!mounted) {- return;- }- final navigator = Navigator.of(context);- if (!navigator.canPop()) {- _logger.internalWarning("Could not pop standby screen");+ void _dismiss() {+ if (!mounted || _isClosing) {return;}- _logger.internalInfo(- "Dismissing: reason=$reason, remaining=$_remainingCount",- );+ _restoreScreenBrightness();_setWakeLock(enable: false);- navigator.pop();+ Navigator.of(context).pop();_isClosing = true;}+ void _scheduleScreenDimming() {+ _restoreScreenBrightness(resetText: true);+ _dimmingTimer = Timer(_dimmingDelay, () async {+ _dimmingTimer = null;+ if (!_canDimScreen) {+ return;+ }++ try {+ final didDim = await EnteScreenBrightness.setBrightness(+ _dimmedBrightness,+ );+ if (didDim && _canDimScreen) {+ setState(() => _isScreenDimmed = true);+ }+ } catch (error, stackTrace) {+ _logger.warning("Could not dim screen brightness", error, stackTrace);+ }+ });+ }++ bool get _canDimScreen =>+ mounted &&+ !_isClosing &&+ widget.sessionTracker.isActive &&+ WidgetsBinding.instance.lifecycleState == AppLifecycleState.resumed;++ void _restoreScreenBrightness({bool resetText = false}) {+ _dimmingTimer?.cancel();+ _dimmingTimer = null;+ if (resetText && _isScreenDimmed && mounted) {+ setState(() => _isScreenDimmed = false);+ }+ unawaited(+ EnteScreenBrightness.restore().onError(+ (error, stackTrace) => _logger.warning(+ "Could not restore screen brightness",+ error,+ stackTrace,+ ),+ ),+ );+ }+void _setWakeLock({required bool enable}) {if (_isWakeLockEnabled == enable) {return;}_isWakeLockEnabled = enable;- _logger.internalInfo(- "Wake lock request: enable=$enable, "- "persistentAutoLock="- "${wakeLockService.shouldKeepAppAwakeAcrossSessions}",- );wakeLockService.updateWakeLock(enable: enable,wakeLockFor: WakeLockFor.largeBackupStandbyScreen,diff --git a/mobile/apps/photos/lib/ui/home/status_bar_widget.dart b/mobile/apps/photos/lib/ui/home/status_bar_widget.dartindex 5989ea7f75..77cd1cbedf 100644--- a/mobile/apps/photos/lib/ui/home/status_bar_widget.dart+++ b/mobile/apps/photos/lib/ui/home/status_bar_widget.dart@@ -12,9 +12,9 @@ import "package:logging/logging.dart";import 'package:photos/core/event_bus.dart';import 'package:photos/ente_theme_data.dart';import 'package:photos/events/christmas_banner_event.dart';+import "package:photos/events/force_reload_home_gallery_event.dart";import 'package:photos/events/notification_event.dart';import 'package:photos/events/sync_status_update_event.dart';-import "package:photos/extensions/logger_extension.dart";import "package:photos/service_locator.dart";import "package:photos/services/sync/large_backup_session_tracker.dart";import 'package:photos/services/sync/sync_service.dart';@@ -52,30 +52,13 @@ class _StatusBarWidgetState extends State<StatusBarWidget> {(isLocalGalleryMode || flagService.hasSyncedAccountFlags()) &&!localSettings.hasSeenMLEnablingBanner;final LargeBackupSessionTracker _largeBackupSession =- LargeBackupSessionTracker();+ SyncService.instance.largeBackupSessionTracker;Error? _syncError;@overridevoid initState() {- _logger.internalInfo(- "Large backup standby enabled=$_isLargeBackupStandbyEnabled, "- "platform=${Platform.operatingSystem}, "- "threshold=${LargeBackupSessionTracker.minimumFileCount}",- );- if (_isLargeBackupStandbyEnabled) {- final lastSyncStatus = SyncService.instance.getLastSyncStatusEvent();- if (lastSyncStatus != null) {- _logger.internalInfo(- "Restoring large backup state from ${lastSyncStatus.status.name}",- );- _largeBackupSession.update(lastSyncStatus);- }- }_subscription = Bus.instance.on<SyncStatusUpdate>().listen((event) {_logger.info("Received event " + event.status.toString());- if (_isLargeBackupStandbyEnabled) {- _largeBackupSession.update(event);- }_isPausedDueToNetwork = event.status == SyncStatus.paused;if (event.status == SyncStatus.error) {setState(() {@@ -128,7 +111,6 @@ class _StatusBarWidgetState extends State<StatusBarWidget> {_subscription.cancel();_notificationSubscription.cancel();_christmasBannerSubscription.cancel();- _largeBackupSession.dispose();super.dispose();}@@ -173,13 +155,15 @@ class _StatusBarWidgetState extends State<StatusBarWidget> {);}- bool get _isLargeBackupStandbyEnabled => flagService.internalUser;+ bool get _isLargeBackupStandbyEnabled =>+ flagService.largeBackupStandby &&+ localSettings.isLargeBackupStandbyEnabled;bool get _shouldShowLargeBackupBanner =>_isLargeBackupStandbyEnabled &&Platform.isIOS &&!_showErrorBanner &&- _largeBackupSession.shouldOfferStandby;+ _largeBackupSession.isActive;Widget _largeBackupBanner(BuildContext context) {return _bannerPadding(@@ -192,21 +176,23 @@ class _StatusBarWidgetState extends State<StatusBarWidget> {),state: BannerComponentState.success,onTap: () async {- if (!_largeBackupSession.shouldOfferStandby) {- _logger.internalInfo(- "Ignored standby banner tap because backup is no longer active",- );+ if (_largeBackupSession.isStandbyScreenActive ||+ !_largeBackupSession.isActive) {return;}- _logger.internalInfo(- "Opening standby screen with "- "remaining=${_largeBackupSession.remainingCount}",- );- await routeToPage(- context,- BackupStandbyScreen(sessionTracker: _largeBackupSession),- forceCustomPageRoute: true,- );+ _largeBackupSession.setStandbyScreenActive(true);+ try {+ await routeToPage(+ context,+ BackupStandbyScreen(sessionTracker: _largeBackupSession),+ forceCustomPageRoute: true,+ );+ } finally {+ _largeBackupSession.setStandbyScreenActive(false);+ Bus.instance.fire(+ ForceReloadHomeGalleryEvent("largeBackupStandbyEnded"),+ );+ }},),);