feat(web, mobile): Options to show archived assets in map (#4293)

* Add include archive setting to map on web

* open api

* better naming for web isArchived variable

* add withArchived setting to mobile

* (e2e): tests for mapMarker endpoint and isArchived

* isArchived to mobile

* chore: cleanup test

* chore: optimize e2e

---------

Co-authored-by: shalong-tanwen <139912620+shalong-tanwen@users.noreply.github.com>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

mobile/assets/i18n/en-US.json

@@ -312,6 +312,7 @@
   "map_settings_dialog_title": "Map Settings",
   "map_settings_dark_mode": "Dark mode",
   "map_settings_only_show_favorites": "Show Favorite Only",
+  "map_settings_include_show_archived": "Include Archived",
   "map_settings_only_relative_range": "Date range",
   "map_settings_dialog_cancel": "Cancel",
   "map_settings_dialog_save": "Save",

mobile/lib/modules/map/models/map_state.model.dart

@@ -1,29 +1,33 @@
 class MapState {
   final bool isDarkTheme;
   final bool showFavoriteOnly;
+  final bool includeArchived;
   final int relativeTime;
 
   MapState({
     this.isDarkTheme = false,
     this.showFavoriteOnly = false,
+    this.includeArchived = false,
     this.relativeTime = 0,
   });
 
   MapState copyWith({
     bool? isDarkTheme,
     bool? showFavoriteOnly,
+    bool? includeArchived,
     int? relativeTime,
   }) {
     return MapState(
       isDarkTheme: isDarkTheme ?? this.isDarkTheme,
       showFavoriteOnly: showFavoriteOnly ?? this.showFavoriteOnly,
+      includeArchived: includeArchived ?? this.includeArchived,
       relativeTime: relativeTime ?? this.relativeTime,
     );
   }
 
   @override
   String toString() {
-    return 'MapSettingsState(isDarkTheme: $isDarkTheme, showFavoriteOnly: $showFavoriteOnly, relativeTime: $relativeTime)';
+    return 'MapSettingsState(isDarkTheme: $isDarkTheme, showFavoriteOnly: $showFavoriteOnly, relativeTime: $relativeTime, includeArchived: $includeArchived)';
   }
 
   @override
@@ -33,13 +37,15 @@ class MapState {
     return other is MapState &&
         other.isDarkTheme == isDarkTheme &&
         other.showFavoriteOnly == showFavoriteOnly &&
-        other.relativeTime == relativeTime;
+        other.relativeTime == relativeTime &&
+        other.includeArchived == includeArchived;
   }
 
   @override
   int get hashCode {
     return isDarkTheme.hashCode ^
         showFavoriteOnly.hashCode ^
-        relativeTime.hashCode;
+        relativeTime.hashCode ^
+        includeArchived.hashCode;
   }
 }

mobile/lib/modules/map/providers/map_marker.provider.dart

@@ -10,6 +10,7 @@ final mapMarkersProvider =
   final mapState = ref.read(mapStateNotifier);
   DateTime? fileCreatedAfter;
   bool? isFavorite;
+  bool? isIncludeArchived;
 
   if (mapState.relativeTime != 0) {
     fileCreatedAfter =
@@ -20,8 +21,13 @@ final mapMarkersProvider =
     isFavorite = true;
   }
 
+  if (!mapState.includeArchived) {
+    isIncludeArchived = false;
+  }
+
   final markers = await service.getMapMarkers(
     isFavorite: isFavorite,
+    withArchived: isIncludeArchived,
     fileCreatedAfter: fileCreatedAfter,
   );
 

mobile/lib/modules/map/providers/map_state.provider.dart

@@ -11,6 +11,8 @@ class MapStateNotifier extends StateNotifier<MapState> {
                 .getSetting<bool>(AppSettingsEnum.mapThemeMode),
             showFavoriteOnly: appSettingsProvider
                 .getSetting<bool>(AppSettingsEnum.mapShowFavoriteOnly),
+            includeArchived: appSettingsProvider
+                .getSetting<bool>(AppSettingsEnum.mapIncludeArchived),
             relativeTime: appSettingsProvider
                 .getSetting<int>(AppSettingsEnum.mapRelativeDate),
           ),
@@ -31,11 +33,19 @@ class MapStateNotifier extends StateNotifier<MapState> {
   void switchFavoriteOnly(bool isFavoriteOnly) {
     appSettingsProvider.setSetting(
       AppSettingsEnum.mapShowFavoriteOnly,
-      appSettingsProvider,
+      isFavoriteOnly,
     );
     state = state.copyWith(showFavoriteOnly: isFavoriteOnly);
   }
 
+  void switchIncludeArchived(bool isIncludeArchived) {
+    appSettingsProvider.setSetting(
+      AppSettingsEnum.mapIncludeArchived,
+      isIncludeArchived,
+    );
+    state = state.copyWith(includeArchived: isIncludeArchived);
+  }
+
   void setRelativeTime(int relativeTime) {
     appSettingsProvider.setSetting(
       AppSettingsEnum.mapRelativeDate,

mobile/lib/modules/map/services/map.service.dart

@@ -23,12 +23,14 @@ class MapSerivce {
 
   Future<List<MapMarkerResponseDto>> getMapMarkers({
     bool? isFavorite,
+    bool? withArchived,
     DateTime? fileCreatedAfter,
     DateTime? fileCreatedBefore,
   }) async {
     try {
       final markers = await _apiService.assetApi.getMapMarkers(
         isFavorite: isFavorite,
+        isArchived: withArchived,
         fileCreatedAfter: fileCreatedAfter,
         fileCreatedBefore: fileCreatedBefore,
       );

mobile/lib/modules/map/ui/map_settings_dialog.dart

@@ -13,6 +13,7 @@ class MapSettingsDialog extends HookConsumerWidget {
     final mapSettings = ref.read(mapStateNotifier);
     final isDarkMode = useState(mapSettings.isDarkTheme);
     final showFavoriteOnly = useState(mapSettings.showFavoriteOnly);
+    final showIncludeArchived = useState(mapSettings.includeArchived);
     final showRelativeDate = useState(mapSettings.relativeTime);
     final ThemeData theme = Theme.of(context);
 
@@ -48,6 +49,22 @@ class MapSettingsDialog extends HookConsumerWidget {
       );
     }
 
+    Widget buildIncludeArchivedSetting() {
+      return SwitchListTile.adaptive(
+        value: showIncludeArchived.value,
+        onChanged: (value) {
+          showIncludeArchived.value = value;
+        },
+        activeColor: theme.primaryColor,
+        dense: true,
+        title: Text(
+          "map_settings_include_show_archived".tr(),
+          style:
+              theme.textTheme.labelLarge?.copyWith(fontWeight: FontWeight.bold),
+        ),
+      );
+    }
+
     Widget buildDateRangeSetting() {
       final now = DateTime.now();
       return DropdownMenu(
@@ -127,6 +144,8 @@ class MapSettingsDialog extends HookConsumerWidget {
             mapSettingsNotifier.switchTheme(isDarkMode.value);
             mapSettingsNotifier.switchFavoriteOnly(showFavoriteOnly.value);
             mapSettingsNotifier.setRelativeTime(showRelativeDate.value);
+            mapSettingsNotifier
+                .switchIncludeArchived(showIncludeArchived.value);
             Navigator.of(context).pop();
           },
           style: TextButton.styleFrom(
@@ -166,6 +185,7 @@ class MapSettingsDialog extends HookConsumerWidget {
             children: [
               buildMapThemeSetting(),
               buildFavoriteOnlySetting(),
+              buildIncludeArchivedSetting(),
               const SizedBox(
                 height: 10,
               ),

mobile/lib/modules/map/views/map_page.dart

@@ -155,7 +155,8 @@ class MapPageState extends ConsumerState<MapPage> {
     ref.listen(mapStateNotifier, (previous, next) {
       bool shouldRefetch =
           previous?.showFavoriteOnly != next.showFavoriteOnly ||
-              previous?.relativeTime != next.relativeTime;
+              previous?.relativeTime != next.relativeTime ||
+              previous?.includeArchived != next.includeArchived;
       if (shouldRefetch) {
         refetchMarkers.value = shouldRefetch;
         ref.invalidate(mapMarkersProvider);

mobile/lib/modules/settings/services/app_settings.service.dart

@@ -48,6 +48,7 @@ enum AppSettingsEnum<T> {
   preferRemoteImage<bool>(StoreKey.preferRemoteImage, null, false),
   mapThemeMode<bool>(StoreKey.mapThemeMode, null, false),
   mapShowFavoriteOnly<bool>(StoreKey.mapShowFavoriteOnly, null, false),
+  mapIncludeArchived<bool>(StoreKey.mapIncludeArchived, null, false),
   mapRelativeDate<int>(StoreKey.mapRelativeDate, null, 0),
   allowSelfSignedSSLCert<bool>(StoreKey.selfSignedCert, null, false),
   ;

mobile/lib/shared/models/store.dart

@@ -179,6 +179,7 @@ enum StoreKey<T> {
   mapShowFavoriteOnly<bool>(118, type: bool),
   mapRelativeDate<int>(119, type: int),
   selfSignedCert<bool>(120, type: bool),
+  mapIncludeArchived<bool>(121, type: bool),
   ;
 
   const StoreKey(

mobile/openapi/doc/AssetApi.md

@@ -902,7 +902,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **getMapMarkers**
-> List<MapMarkerResponseDto> getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore)
+> List<MapMarkerResponseDto> getMapMarkers(isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore)
 
 
 
@@ -925,12 +925,13 @@ import 'package:openapi/api.dart';
 //defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
 
 final api_instance = AssetApi();
+final isArchived = true; // bool | 
 final isFavorite = true; // bool | 
 final fileCreatedAfter = 2013-10-20T19:20:30+01:00; // DateTime | 
 final fileCreatedBefore = 2013-10-20T19:20:30+01:00; // DateTime | 
 
 try {
-    final result = api_instance.getMapMarkers(isFavorite, fileCreatedAfter, fileCreatedBefore);
+    final result = api_instance.getMapMarkers(isArchived, isFavorite, fileCreatedAfter, fileCreatedBefore);
     print(result);
 } catch (e) {
     print('Exception when calling AssetApi->getMapMarkers: $e\n');
@@ -941,6 +942,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **isArchived** | **bool**|  | [optional] 
  **isFavorite** | **bool**|  | [optional] 
  **fileCreatedAfter** | **DateTime**|  | [optional] 
  **fileCreatedBefore** | **DateTime**|  | [optional] 

mobile/openapi/lib/api/asset_api.dart

@@ -909,12 +909,14 @@ class AssetApi {
   /// Performs an HTTP 'GET /asset/map-marker' operation and returns the [Response].
   /// Parameters:
   ///
+  /// * [bool] isArchived:
+  ///
   /// * [bool] isFavorite:
   ///
   /// * [DateTime] fileCreatedAfter:
   ///
   /// * [DateTime] fileCreatedBefore:
-  Future<Response> getMapMarkersWithHttpInfo({ bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, }) async {
+  Future<Response> getMapMarkersWithHttpInfo({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, }) async {
     // ignore: prefer_const_declarations
     final path = r'/asset/map-marker';
 
@@ -925,6 +927,9 @@ class AssetApi {
     final headerParams = <String, String>{};
     final formParams = <String, String>{};
 
+    if (isArchived != null) {
+      queryParams.addAll(_queryParams('', 'isArchived', isArchived));
+    }
     if (isFavorite != null) {
       queryParams.addAll(_queryParams('', 'isFavorite', isFavorite));
     }
@@ -951,13 +956,15 @@ class AssetApi {
 
   /// Parameters:
   ///
+  /// * [bool] isArchived:
+  ///
   /// * [bool] isFavorite:
   ///
   /// * [DateTime] fileCreatedAfter:
   ///
   /// * [DateTime] fileCreatedBefore:
-  Future<List<MapMarkerResponseDto>?> getMapMarkers({ bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, }) async {
-    final response = await getMapMarkersWithHttpInfo( isFavorite: isFavorite, fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, );
+  Future<List<MapMarkerResponseDto>?> getMapMarkers({ bool? isArchived, bool? isFavorite, DateTime? fileCreatedAfter, DateTime? fileCreatedBefore, }) async {
+    final response = await getMapMarkersWithHttpInfo( isArchived: isArchived, isFavorite: isFavorite, fileCreatedAfter: fileCreatedAfter, fileCreatedBefore: fileCreatedBefore, );
     if (response.statusCode >= HttpStatus.badRequest) {
       throw ApiException(response.statusCode, await _decodeBodyBytes(response));
     }

mobile/openapi/test/asset_api_test.dart

@@ -102,7 +102,7 @@ void main() {
       // TODO
     });
 
-    //Future<List<MapMarkerResponseDto>> getMapMarkers({ bool isFavorite, DateTime fileCreatedAfter, DateTime fileCreatedBefore }) async
+    //Future<List<MapMarkerResponseDto>> getMapMarkers({ bool isArchived, bool isFavorite, DateTime fileCreatedAfter, DateTime fileCreatedBefore }) async
     test('test getMapMarkers', () async {
       // TODO
     });