Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

Recover gallery date headers after background startup

ashil-pilotbb9ecafd7f6b
diff --git a/mobile/apps/photos/changes/fix-gallery-date-labels.md b/mobile/apps/photos/changes/fix-gallery-date-labels.md
new file mode 100644
index 0000000000..17b0695d37
--- /dev/null
+++ b/mobile/apps/photos/changes/fix-gallery-date-labels.md
@@ -0,0 +1 @@
+- Fixed missing gallery date labels after background activity.
diff --git a/mobile/apps/photos/lib/ui/viewer/gallery/gallery.dart b/mobile/apps/photos/lib/ui/viewer/gallery/gallery.dart
index 2c8682784e..1709ccc32c 100644
--- a/mobile/apps/photos/lib/ui/viewer/gallery/gallery.dart
+++ b/mobile/apps/photos/lib/ui/viewer/gallery/gallery.dart
@@ -146,7 +146,7 @@ class Gallery extends StatefulWidget {
}
}
-class GalleryState extends State<Gallery> {
+class GalleryState extends State<Gallery> with WidgetsBindingObserver {
static const int kInitialLoadLimit = 100;
static final RegExp _automationIdentifierUnsafeChars = RegExp(
r'[^A-Za-z0-9_.-]',
@@ -154,6 +154,9 @@ class GalleryState extends State<Gallery> {
late final Debouncer _debouncer;
late final Debouncer _priorityDebouncer;
double? groupHeaderExtent;
+ bool _groupHeaderMeasurementScheduled = false;
+ bool _groupHeaderMeasurementInProgress = false;
+ bool _groupHeaderMeasurementRequested = false;
late Logger _logger;
bool _hasLoadedFiles = false;
@@ -191,6 +194,7 @@ class GalleryState extends State<Gallery> {
@override
void initState() {
super.initState();
+ WidgetsBinding.instance.addObserver(this);
_automationScrollIdentifier = _buildAutomationScrollIdentifier(
widget.tagPrefix,
);
@@ -311,16 +315,7 @@ class GalleryState extends State<Gallery> {
}
});
- if (_groupType.showGroupHeader()) {
- final generation = _layoutChangeGeneration;
- _measureGroupHeaderExtent().then((extent) {
- if (!mounted || generation != _layoutChangeGeneration) return;
- setState(() {
- groupHeaderExtent = extent;
- _updateGalleryGroups(callSetState: false);
- });
- });
- } else {
+ if (!_groupType.showGroupHeader()) {
groupHeaderExtent = GalleryGroups.spacing;
WidgetsBinding.instance.addPostFrameCallback((_) {
if (mounted) {
@@ -419,7 +414,7 @@ class GalleryState extends State<Gallery> {
return;
}
_needsLayoutRefresh = false;
- groupHeaderExtent = measuredHeaderExtent;
+ groupHeaderExtent = measuredHeaderExtent ?? groupHeaderExtent;
_updateGalleryGroups();
_restoreLayoutScrollAnchor(scrollAnchor, generation);
}
@@ -475,9 +470,10 @@ class GalleryState extends State<Gallery> {
await localSettings.setGalleryLayoutType(GalleryLayoutType.grid);
}
if (!mounted) return;
- ++_layoutChangeGeneration;
- groupHeaderExtent = await _measureGroupHeaderExtent();
- if (!mounted) return;
+ final generation = ++_layoutChangeGeneration;
+ final measuredHeaderExtent = await _measureGroupHeaderExtent();
+ if (!mounted || generation != _layoutChangeGeneration) return;
+ groupHeaderExtent = measuredHeaderExtent ?? groupHeaderExtent;
_updateGalleryGroups();
await WidgetsBinding.instance.endOfFrame;
if (!mounted) return;
@@ -606,8 +602,67 @@ class GalleryState extends State<Gallery> {
? 2
: localSettings.getPhotoGridSize();
- Future<double> _measureGroupHeaderExtent() async {
+ static bool _hasUsableSize(Size size) =>
+ size.width.isFinite &&
+ size.height.isFinite &&
+ size.width > 0 &&
+ size.height > 0;
+
+ void _scheduleGroupHeaderMeasurement() {
+ if (!mounted ||
+ groupHeaderExtent != null ||
+ !_hasUsableSize(MediaQuery.sizeOf(context))) {
+ return;
+ }
+ _groupHeaderMeasurementRequested = true;
+ if (_groupHeaderMeasurementScheduled || _groupHeaderMeasurementInProgress) {
+ return;
+ }
+ _groupHeaderMeasurementScheduled = true;
+ WidgetsBinding.instance.addPostFrameCallback((_) async {
+ _groupHeaderMeasurementScheduled = false;
+ if (!mounted || groupHeaderExtent != null) return;
+ _groupHeaderMeasurementRequested = false;
+ if (!_hasUsableSize(MediaQuery.sizeOf(context))) return;
+ _groupHeaderMeasurementInProgress = true;
+ final generation = _layoutChangeGeneration;
+ try {
+ final extent = await _measureGroupHeaderExtent();
+ if (!mounted ||
+ generation != _layoutChangeGeneration ||
+ groupHeaderExtent != null ||
+ extent == null) {
+ return;
+ }
+ setState(() {
+ groupHeaderExtent = extent;
+ _updateGalleryGroups(callSetState: false);
+ });
+ } finally {
+ _groupHeaderMeasurementInProgress = false;
+ if (mounted && _groupHeaderMeasurementRequested) {
+ _scheduleGroupHeaderMeasurement();
+ }
+ }
+ });
+ WidgetsBinding.instance.ensureVisualUpdate();
+ }
+
+ @override
+ void didChangeAppLifecycleState(AppLifecycleState state) {
+ if (state == AppLifecycleState.resumed) {
+ _scheduleGroupHeaderMeasurement();
+ }
+ }
+
+ Future<double?> _measureGroupHeaderExtent() async {
if (!_groupType.showGroupHeader()) return GalleryGroups.spacing;
+ final overlayBox = Overlay.of(context).context.findRenderObject();
+ if (overlayBox is! RenderBox ||
+ !overlayBox.hasSize ||
+ !_hasUsableSize(overlayBox.size)) {
+ return null;
+ }
final size = await getIntrinsicSizeOfWidget(
GroupHeaderWidget(
title: "Dummy title",
@@ -618,7 +673,7 @@ class GalleryState extends State<Gallery> {
),
context,
);
- return size.height;
+ return size.height.isFinite && size.height > 0 ? size.height : null;
}
void _selectedFilesListener() {
@@ -867,6 +922,7 @@ class GalleryState extends State<Gallery> {
@override
void dispose() {
+ WidgetsBinding.instance.removeObserver(this);
_boundariesProvider?.selectionSheetMinHeightNotifier.removeListener(
_selectedFilesListener,
);
@@ -993,16 +1049,22 @@ class GalleryState extends State<Gallery> {
});
}
- final widthAvailable = MediaQuery.sizeOf(context).width;
+ final viewSize = MediaQuery.sizeOf(context);
+ final widthAvailable = viewSize.width;
final shouldEnableSwipeSelection = widget.limitSelectionToOne == false;
if (groupHeaderExtent == null) {
+ _scheduleGroupHeaderMeasurement();
final photoGridSize = _photoGridSize;
final tileHeight =
(widthAvailable - (photoGridSize - 1) * GalleryGroups.spacing) /
photoGridSize;
final placeholder =
- widget.initialFiles != null && widget.initialFiles!.isNotEmpty
+ _hasUsableSize(viewSize) &&
+ tileHeight.isFinite &&
+ tileHeight > 0 &&
+ widget.initialFiles != null &&
+ widget.initialFiles!.isNotEmpty
? Column(
mainAxisAlignment: MainAxisAlignment.start,
children: [
diff --git a/mobile/apps/photos/test/ui/viewer/gallery/gallery_layout_changed_event_test.dart b/mobile/apps/photos/test/ui/viewer/gallery/gallery_layout_changed_event_test.dart
index 94b8ba524e..59dab9d0b1 100644
--- a/mobile/apps/photos/test/ui/viewer/gallery/gallery_layout_changed_event_test.dart
+++ b/mobile/apps/photos/test/ui/viewer/gallery/gallery_layout_changed_event_test.dart
@@ -16,6 +16,7 @@ import "package:photos/models/file/dummy_file.dart";
import "package:photos/models/file/file.dart";
import "package:photos/models/file/file_type.dart";
import "package:photos/models/file_load_result.dart";
+import "package:photos/models/gallery/fixed_extent_grid_row.dart";
import "package:photos/models/metadata/file_magic.dart";
import "package:photos/models/selected_files.dart";
import "package:photos/service_locator.dart";
@@ -61,6 +62,134 @@ void main() {
await localSettings.setGalleryLayoutType(GalleryLayoutType.grid);
});
+ testWidgets(
+ "zero-size startup recovers date headers without remounting or reloading",
+ (tester) async {
+ tester.view.devicePixelRatio = 1;
+ tester.view.physicalSize = Size.zero;
+ addTearDown(tester.view.resetDevicePixelRatio);
+ addTearDown(tester.view.resetPhysicalSize);
+ await localSettings.setPhotoGridSize(4);
+ final galleryKey = GlobalKey<GalleryState>();
+ final files = List<EnteFile>.generate(
+ 8,
+ (index) => _justifiedTestFile(index)
+ ..creationTime = DateTime(
+ 2026,
+ 8,
+ 19 - index ~/ 4,
+ ).microsecondsSinceEpoch,
+ );
+ final load = Completer<FileLoadResult>();
+ var loads = 0;
+ await tester.pumpWidget(
+ _viewSizedGalleryHost(
+ Gallery(
+ key: galleryKey,
+ tagPrefix: "zero_size_header",
+ groupType: GroupType.day,
+ initialFiles: [files.first],
+ loadingWidget: const SizedBox.shrink(),
+ asyncLoader: (start, end, {limit, asc}) {
+ loads++;
+ return load.future;
+ },
+ ),
+ ),
+ );
+ final originalState = galleryKey.currentState!;
+ load.complete(FileLoadResult(files, false));
+ await tester.pumpAndSettle();
+ expect(originalState.groupHeaderExtent, isNull);
+ expect(originalState.galleryGroups, isNull);
+ expect(loads, 1);
+ expect(tester.takeException(), isNull);
+
+ tester.view.physicalSize = const Size(400, 600);
+ await tester.pump();
+ await tester.pumpAndSettle();
+
+ expect(galleryKey.currentState, same(originalState));
+ final groups = originalState.galleryGroups!;
+ expect(groups.allFiles, orderedEquals(files));
+ expect(groups.groupIDs, hasLength(2));
+ expect(groups.groupHeaderExtent, greaterThan(0));
+ expect(loads, 1);
+ final header = find.byWidgetPredicate(
+ (widget) =>
+ widget is GroupHeaderWidget &&
+ !widget.isPinnedHeader &&
+ widget.filesInGroup.contains(files.first),
+ );
+ expect(header, findsOneWidget);
+ final headerRect = tester.getRect(header);
+ final firstRowRect = tester.getRect(
+ find.byType(FixedExtentGridRow).first,
+ );
+ expect(headerRect.height, closeTo(groups.groupHeaderExtent, 0.001));
+ expect(firstRowRect.top, greaterThanOrEqualTo(headerRect.bottom - 0.001));
+ expect(tester.takeException(), isNull);
+
+ await tester.pumpWidget(const SizedBox.shrink());
+ await tester.pump(const Duration(milliseconds: 100));
+ },
+ );
+
+ testWidgets(
+ "a layout change with a zero-size overlay retains a valid header cache",
+ (tester) async {
+ tester.view.devicePixelRatio = 1;
+ tester.view.physicalSize = const Size(400, 600);
+ addTearDown(tester.view.resetDevicePixelRatio);
+ addTearDown(tester.view.resetPhysicalSize);
+ await localSettings.setPhotoGridSize(4);
+ final galleryKey = GlobalKey<GalleryState>();
+ final files = List<EnteFile>.generate(4, _justifiedTestFile);
+ var loads = 0;
+ await tester.pumpWidget(
+ _viewSizedGalleryHost(
+ Gallery(
+ key: galleryKey,
+ tagPrefix: "retain_header_cache",
+ groupType: GroupType.day,
+ asyncLoader: (start, end, {limit, asc}) async {
+ loads++;
+ return FileLoadResult(files, false);
+ },
+ ),
+ keepGallerySize: true,
+ ),
+ );
+ await tester.pumpAndSettle();
+ final originalState = galleryKey.currentState!;
+ final headerExtent = originalState.groupHeaderExtent!;
+ expect(headerExtent, greaterThan(0));
+
+ tester.view.physicalSize = Size.zero;
+ await tester.pump();
+ final overlay =
+ Overlay.of(galleryKey.currentContext!).context.findRenderObject()!
+ as RenderBox;
+ expect(overlay.size, Size.zero);
+ Bus.instance.fire(GalleryLayoutChangedEvent());
+ await tester.pumpAndSettle();
+ expect(originalState.groupHeaderExtent, headerExtent);
+ expect(originalState.galleryGroups!.groupHeaderExtent, headerExtent);
+ expect(tester.takeException(), isNull);
+
+ tester.view.physicalSize = const Size(400, 600);
+ await tester.pumpAndSettle();
+ expect(galleryKey.currentState, same(originalState));
+ expect(originalState.groupHeaderExtent, headerExtent);
+ expect(originalState.galleryGroups!.allFiles, orderedEquals(files));
+ expect(loads, 1);
+ expect(tester.takeException(), isNull);
+
+ await tester.pumpWidget(const SizedBox.shrink());
+ await tester.pump(const Duration(milliseconds: 100));
+ },
+ );
+
testWidgets(
"zero-width startup keeps loading and lays out all files on recovery",
(tester) async {
@@ -102,6 +231,7 @@ void main() {
expect(find.byType(GalleryGridZoom), findsNothing);
width.value = 400;
+ await tester.pump();
await tester.pumpAndSettle();
final groups = galleryKey.currentState!.galleryGroups!;
expect(groups.widthAvailable, 400);
@@ -1035,6 +1165,32 @@ Widget _galleryHost(Gallery gallery) {
return GalleryBoundariesProvider(child: GalleryFilesState(child: gallery));
}
+Widget _viewSizedGalleryHost(Gallery gallery, {bool keepGallerySize = false}) {
+ return MaterialApp(
+ theme: lightThemeData,
+ localizationsDelegates: StringsLocalizations.localizationsDelegates,
+ supportedLocales: StringsLocalizations.supportedLocales,
+ home: Builder(
+ builder: (context) {
+ final child = _galleryHost(gallery);
+ if (!keepGallerySize) return child;
+ // Keep gallery layout usable while the measurement overlay becomes zero.
+ return OverflowBox(
+ alignment: Alignment.topLeft,
+ minWidth: 400,
+ maxWidth: 400,
+ minHeight: 600,
+ maxHeight: 600,
+ child: MediaQuery(
+ data: MediaQuery.of(context).copyWith(size: const Size(400, 600)),
+ child: child,
+ ),
+ );
+ },
+ ),
+ );
+}
+
Widget _resizableGalleryHost(ValueNotifier<double> width, Gallery gallery) {
return MaterialApp(
theme: lightThemeData,