TF-4400 Enable collapse threads on Force Query path

dab246 · dab246 · commit 23d550eee263 · 2026-04-24T10:20:48.000+07:00
Signed-off-by: dab246 &lt;tdvu@linagora.com&gt;
diff --git a/lib/features/base/mixin/mail_api_mixin.dart b/lib/features/base/mixin/mail_api_mixin.dart
@@ -38,6 +38,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/exceptions/mailbox_excepti
 import 'package:tmail_ui_user/features/mailbox/domain/state/move_folder_content_state.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/list_email_extension.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/list_email_id_extension.dart';
+import 'package:tmail_ui_user/features/thread/data/extensions/query_email_method_extension.dart';
 import 'package:tmail_ui_user/features/thread/domain/model/email_response.dart';
 import 'package:tmail_ui_user/main/error/capability_validator.dart';
 
@@ -109,6 +110,7 @@ mixin MailAPIMixin on HandleSetErrorMixin, SessionMixin {
     int? position,
     Set<Comparator>? sort,
     Filter? filter,
+    bool? collapseThreads,
     Properties? properties,
   }) async {
     final processingInvocation = ProcessingInvocation();
@@ -118,15 +120,12 @@ mixin MailAPIMixin on HandleSetErrorMixin, SessionMixin {
       processingInvocation,
     );
 
-    final queryEmailMethod = QueryEmailMethod(accountId);
-
-    if (limit != null) queryEmailMethod.addLimit(limit);
-
-    if (position != null && position > 0) queryEmailMethod.addPosition(position);
-
-    if (sort != null) queryEmailMethod.addSorts(sort);
-
-    if (filter != null) queryEmailMethod.addFilters(filter);
+    final queryEmailMethod = QueryEmailMethod(accountId)
+      ..addLimitIfNotNull(limit)
+      ..addPositionIfAvailable(position)
+      ..addSortsIfNotNull(sort)
+      ..addFiltersIfNotNull(filter)
+      ..addCollapseThreadsIfAvailable(collapseThreads);
 
     final queryEmailInvocation =
         jmapRequestBuilder.invocation(queryEmailMethod);
diff --git a/lib/features/thread/data/datasource/thread_datasource.dart b/lib/features/thread/data/datasource/thread_datasource.dart
@@ -28,6 +28,7 @@ abstract class ThreadDataSource {
       int? position,
       Set<Comparator>? sort,
       Filter? filter,
+      bool? collapseThreads,
       Properties? properties
     }
   );
diff --git a/lib/features/thread/data/datasource_impl/local_thread_datasource_impl.dart b/lib/features/thread/data/datasource_impl/local_thread_datasource_impl.dart
@@ -44,6 +44,7 @@ class LocalThreadDataSourceImpl extends ThreadDataSource {
       int? position,
       Set<Comparator>? sort,
       Filter? filter,
+      bool? collapseThreads,
       Properties? properties
     }
   ) {
diff --git a/lib/features/thread/data/datasource_impl/thread_datasource_impl.dart b/lib/features/thread/data/datasource_impl/thread_datasource_impl.dart
@@ -45,6 +45,7 @@ class ThreadDataSourceImpl extends ThreadDataSource {
       int? position,
       Set<Comparator>? sort,
       Filter? filter,
+      bool? collapseThreads,
       Properties? properties,
     }
   ) {
@@ -56,6 +57,7 @@ class ThreadDataSourceImpl extends ThreadDataSource {
         position: position,
         sort: sort,
         filter: filter,
+        collapseThreads: collapseThreads,
         properties: properties);
     }).catchError(_exceptionThrower.throwException);
   }
diff --git a/lib/features/thread/data/extensions/query_email_method_extension.dart b/lib/features/thread/data/extensions/query_email_method_extension.dart
@@ -3,11 +3,17 @@ import 'package:jmap_dart_client/jmap/core/sort/comparator.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
 import 'package:jmap_dart_client/jmap/mail/email/query/query_email_method.dart';
 
+/// Naming convention:
+/// - `IfNotNull`  — applies the method only when the value is non-null.
+/// - `IfAvailable` — applies the method when the value meets an additional
+///   semantic condition beyond null (e.g. position > 0, collapseThreads == true).
 extension QueryEmailMethodExtension on QueryEmailMethod {
   void addLimitIfNotNull(UnsignedInt? limit) {
     if (limit != null) addLimit(limit);
   }
 
+  /// Only sets position when it is positive; position 0 is the default start
+  /// and does not need to be sent explicitly.
   void addPositionIfAvailable(int? position) {
     if (position != null && position > 0) addPosition(position);
   }
@@ -20,6 +26,8 @@ extension QueryEmailMethodExtension on QueryEmailMethod {
     if (filter != null) addFilters(filter);
   }
 
+  /// Only enables collapse-threads when the flag is explicitly `true`;
+  /// null or false means the feature is not requested.
   void addCollapseThreadsIfAvailable(bool? collapseThreads) {
     if (collapseThreads == true) {
       addCollapseThreads(true);
diff --git a/lib/features/thread/data/network/thread_api.dart b/lib/features/thread/data/network/thread_api.dart
@@ -48,6 +48,7 @@ class ThreadAPI with HandleSetErrorMixin, SessionMixin, MailAPIMixin {
       int? position,
       Set<Comparator>? sort,
       Filter? filter,
+      bool? collapseThreads,
       Properties? properties
     }
   ) async {
@@ -59,6 +60,7 @@ class ThreadAPI with HandleSetErrorMixin, SessionMixin, MailAPIMixin {
       position: position,
       sort: sort,
       filter: filter,
+      collapseThreads: collapseThreads,
       properties: properties,
     );
   }
diff --git a/lib/features/thread/data/repository/thread_repository_impl.dart b/lib/features/thread/data/repository/thread_repository_impl.dart
@@ -165,6 +165,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
     int? position,
     Set<Comparator>? sort,
     EmailFilter? emailFilter,
+    bool? collapseThreads,
     Properties? propertiesCreated,
   }) async* {
     jmap.State? cachedState;
@@ -196,6 +197,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
       position: position,
       sort: sort,
       filter: emailFilter?.filter,
+      collapseThreads: collapseThreads,
       properties: propertiesCreated,
     );
 
@@ -205,6 +207,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
 
     logTrace(
       'ThreadRepositoryImpl::forceQueryAllEmailsForWeb(): '
+      'collapseThreads = $collapseThreads, '
       'ServerEmailCount = $serverCount, '
       'ServerNotFoundEmailIds = ${notFoundEmailIds.length}, '
       'StateResponse = ${stateResponse?.value}',
@@ -240,6 +243,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
       MailboxId? mailboxId,
       Properties? propertiesCreated,
       Filter? filter,
+      bool? collapseThreads,
     }
   ) async {
       final networkEmailResponse = await mapDataSource[DataSourceType.network]!.getAllEmail(
@@ -250,6 +254,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
         sort: sort,
         filter: filter ?? EmailFilterCondition(inMailbox: mailboxId),
         properties: propertiesCreated,
+        collapseThreads: collapseThreads,
       );
       await _updateEmailCache(
         accountId,
@@ -360,6 +365,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
       EmailFilter? emailFilter,
       Properties? propertiesCreated,
       Properties? propertiesUpdated,
+      bool? collapseThreads,
     }
   ) async* {
     log('ThreadRepositoryImpl::refreshChanges(): $currentState');
@@ -395,9 +401,11 @@ class ThreadRepositoryImpl extends ThreadRepository {
         filter: emailFilter?.filter,
         mailboxId: emailFilter?.mailboxId,
         propertiesCreated: propertiesCreated,
+        collapseThreads: collapseThreads,
       );
       logTrace(
         'ThreadRepositoryImpl::refreshChanges():'
+        'collapseThreads = $collapseThreads, '
         'CountEmailCached = ${newEmailResponse.emailList?.length}, '
         'EmailStateCache = ${newEmailResponse.state?.value}, '
         'InMailboxId = ${emailFilter?.mailboxId?.asString}, '
@@ -410,6 +418,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
     } else {
       logTrace(
         'ThreadRepositoryImpl::refreshChanges():'
+        'collapseThreads = $collapseThreads, '
         'CountEmailCached = ${newEmailResponse.emailList?.length}, '
         'EmailStateCache = ${newEmailResponse.state?.value}, '
         'InMailboxId = ${emailFilter?.mailboxId?.asString}, '
@@ -432,7 +441,9 @@ class ThreadRepositoryImpl extends ThreadRepository {
       );
     }
     logTrace(
-      'ThreadRepositoryImpl::loadMoreEmails(): emailList = ${response.emailList?.length},'
+      'ThreadRepositoryImpl::loadMoreEmails(): '
+      'collapseThreads = ${emailRequest.collapseThreads},'
+      'emailList = ${response.emailList?.length},'
       'notFoundEmailIds = ${response.notFoundEmailIds?.length}, '
       'existNotFoundEmails = ${response.existNotFoundEmails}, '
       'state = ${response.state?.value}',
@@ -449,6 +460,7 @@ class ThreadRepositoryImpl extends ThreadRepository {
           position: emailRequest.position,
           sort: emailRequest.sort,
           filter: emailRequest.filter,
+          collapseThreads: emailRequest.collapseThreads,
           properties: emailRequest.properties)
         .then((response) {
           final listEmails = response.emailList;
diff --git a/lib/features/thread/domain/model/get_email_request.dart b/lib/features/thread/domain/model/get_email_request.dart
@@ -19,6 +19,7 @@ class GetEmailRequest with EquatableMixin {
   final Properties? properties;
   final EmailId? lastEmailId;
   final bool useCache;
+  final bool? collapseThreads;
 
   GetEmailRequest(
     this.session,
@@ -32,6 +33,7 @@ class GetEmailRequest with EquatableMixin {
       this.properties,
       this.lastEmailId,
       this.useCache = true,
+      this.collapseThreads,
     }
   );
 
@@ -47,5 +49,6 @@ class GetEmailRequest with EquatableMixin {
     lastEmailId,
     filterOption,
     useCache,
+    collapseThreads,
   ];
 }
diff --git a/lib/features/thread/domain/repository/thread_repository.dart b/lib/features/thread/domain/repository/thread_repository.dart
@@ -50,6 +50,7 @@ abstract class ThreadRepository {
     int? position,
     Set<Comparator>? sort,
     EmailFilter? emailFilter,
+    bool? collapseThreads,
     Properties? propertiesCreated,
   });
 
@@ -63,6 +64,7 @@ abstract class ThreadRepository {
       EmailFilter? emailFilter,
       Properties? propertiesCreated,
       Properties? propertiesUpdated,
+      bool? collapseThreads,
     }
   );
 
diff --git a/lib/features/thread/domain/usecases/get_emails_in_mailbox_interactor.dart b/lib/features/thread/domain/usecases/get_emails_in_mailbox_interactor.dart
@@ -27,6 +27,7 @@ class GetEmailsInMailboxInteractor {
       EmailFilter? emailFilter,
       Properties? propertiesCreated,
       Properties? propertiesUpdated,
+      bool? collapseThreads,
       bool getLatestChanges = true,
       bool useCache = true,
       bool forceEmailQuery = false,
@@ -44,6 +45,7 @@ class GetEmailsInMailboxInteractor {
           limit: limit,
           sort: sort,
           emailFilter: emailFilter,
+          collapseThreads: collapseThreads,
           propertiesCreated: propertiesCreated,
         );
       } else if (useCache) {
diff --git a/lib/features/thread/domain/usecases/refresh_changes_emails_in_mailbox_interactor.dart b/lib/features/thread/domain/usecases/refresh_changes_emails_in_mailbox_interactor.dart
@@ -28,6 +28,7 @@ class RefreshChangesEmailsInMailboxInteractor {
       Properties? propertiesCreated,
       Properties? propertiesUpdated,
       EmailFilter? emailFilter,
+      bool? collapseThreads,
     }
   ) async* {
     yield Right<Failure, Success>(RefreshChangesAllEmailLoading());
@@ -42,6 +43,7 @@ class RefreshChangesEmailsInMailboxInteractor {
           limit: limit,
           propertiesCreated: propertiesCreated,
           propertiesUpdated: propertiesUpdated,
+          collapseThreads: collapseThreads,
           emailFilter: emailFilter)
         .map((emailResponse) => _toGetEmailState(
           emailResponse: emailResponse,
diff --git a/lib/features/thread/presentation/thread_controller.dart b/lib/features/thread/presentation/thread_controller.dart
@@ -446,6 +446,11 @@ class ThreadController extends BaseController with EmailActionController {
         if (previous?.threadConfig == next.threadConfig) return;
         if (searchController.isSearchEmailRunning) {
           _searchEmail(limit: limitEmailFetched);
+        } else if (forceEmailQuery) {
+          getAllEmailAction(
+            forceEmailQuery: forceEmailQuery,
+            limit: limitEmailFetched,
+          );
         }
       },
       fireImmediately: false,
@@ -570,7 +575,7 @@ class ThreadController extends BaseController with EmailActionController {
     logWarning('ThreadController::_handleErrorGetAllOrRefreshChangesEmail():Error: $error');
     if (error is CannotCalculateChangesMethodResponseException) {
       await cachingManager.clearAllEmailAndStateCache();
-      getAllEmailAction();
+      getAllEmailAction(forceEmailQuery: forceEmailQuery);
     } else if (error is MethodLevelErrors) {
       if (currentOverlayContext != null && error.message != null) {
         appToast.showToastErrorMessage(
@@ -698,13 +703,14 @@ class ThreadController extends BaseController with EmailActionController {
   void getAllEmailAction({
     bool getLatestChanges = true,
     bool forceEmailQuery = false,
+    UnsignedInt? limit,
   }) {
     log('ThreadController::_getAllEmailAction:getLatestChanges = $getLatestChanges');
     if (_session != null &&_accountId != null) {
       consumeState(_getEmailsInMailboxInteractor.execute(
         _session!,
         _accountId!,
-        limit: ThreadConstants.defaultLimit,
+        limit: limit ?? ThreadConstants.defaultLimit,
         sort: EmailSortOrderType.mostRecent.getSortOrder().toNullable(),
         emailFilter: getEmailFilterForLoadMailbox(),
         propertiesCreated: EmailUtils.getPropertiesForEmailGetMethod(_session!, _accountId!),
@@ -715,6 +721,7 @@ class ThreadController extends BaseController with EmailActionController {
         getLatestChanges: getLatestChanges,
         useCache: selectedMailbox?.isCacheable ?? false,
         forceEmailQuery: forceEmailQuery,
+        collapseThreads: _isCollapseThreadsEnabled,
       ));
     } else {
       consumeState(Stream.value(Left(GetAllEmailFailure(NotFoundSessionException()))));
@@ -739,7 +746,7 @@ class ThreadController extends BaseController with EmailActionController {
     if (searchController.isSearchEmailRunning) {
       _searchEmail(limit: limitEmailFetched);
     } else {
-      getAllEmailAction();
+      getAllEmailAction(forceEmailQuery: forceEmailQuery);
     }
   }
 
@@ -852,6 +859,7 @@ class ThreadController extends BaseController with EmailActionController {
         _accountId!,
       ),
       emailFilter: getEmailFilterForLoadMailbox(),
+      collapseThreads: _isCollapseThreadsEnabled,
     ).last;
 
     refreshState.fold(
@@ -903,6 +911,7 @@ class ThreadController extends BaseController with EmailActionController {
             _accountId!,
           ),
           useCache: false,
+          collapseThreads: forceEmailQuery && _isCollapseThreadsEnabled,
         )
         .last;
 
@@ -948,6 +957,7 @@ class ThreadController extends BaseController with EmailActionController {
           properties: EmailUtils.getPropertiesForEmailGetMethod(_session!, _accountId!),
           lastEmailId: oldestEmail?.id,
           useCache: useCache,
+          collapseThreads: forceEmailQuery && _isCollapseThreadsEnabled,
         )
       ));
     } else {
diff --git a/test/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller_test.dart b/test/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller_test.dart
diff --git a/test/features/search/verify_before_time_in_search_email_filter_test.dart b/test/features/search/verify_before_time_in_search_email_filter_test.dart
diff --git a/test/features/thread/presentation/controller/thread_controller_test.dart b/test/features/thread/presentation/controller/thread_controller_test.dart

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ abstract class ThreadDataSource {`
`28`	`28`	`int? position,`
`29`	`29`	`Set<Comparator>? sort,`
`30`	`30`	`Filter? filter,`
	`31`	`+ bool? collapseThreads,`
`31`	`32`	`Properties? properties`
`32`	`33`	`}`
`33`	`34`	`);`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ class LocalThreadDataSourceImpl extends ThreadDataSource {`
`44`	`44`	`int? position,`
`45`	`45`	`Set<Comparator>? sort,`
`46`	`46`	`Filter? filter,`
	`47`	`+ bool? collapseThreads,`
`47`	`48`	`Properties? properties`
`48`	`49`	`}`
`49`	`50`	`) {`