TF-3611 E2E Trash & spam empty and recover

backend-docker/deletedMessageVault.properties

@@ -0,0 +1,8 @@
+# ============================================= Deleted Messages Vault Configuration ==================================
+
+enabled=true
+restoreLocation=Restored-Messages
+
+# Retention period for your deleted messages into the vault, after which they expire and can be potentially cleaned up
+# Optional, default 1y
+# retentionPeriod=1y

backend-docker/docker-compose.yaml

@@ -10,6 +10,8 @@ services:
       - ./mailetcontainer.xml:/root/conf/mailetcontainer.xml
       - ./imapserver.xml:/root/conf/imapserver.xml
       - ./jmap.properties:/root/conf/jmap.properties
+      - ./deletedMessageVault.properties:/root/conf/deletedMessageVault.properties
+      - ./listeners.xml:/root/conf/listeners.xml
       - ./linagora-ecosystem.properties:/root/conf/linagora-ecosystem.properties
       - ../provisioning/integration_test/provisioning.sh:/root/conf/integration_test/provisioning.sh
       - ../provisioning/integration_test/eml:/root/conf/integration_test/eml

backend-docker/listeners.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+
+<listeners>
+  <preDeletionHook>
+    <class>org.apache.james.vault.DeletedMessageVaultHook</class>
+  </preDeletionHook>
+</listeners>

integration_test/mixin/scenario_utils_mixin.dart

@@ -11,6 +11,7 @@ import 'package:jmap_dart_client/jmap/identities/identity.dart';
 import 'package:jmap_dart_client/jmap/jmap_request.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_address.dart';
 import 'package:jmap_dart_client/jmap/mail/email/set/set_email_method.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:model/model.dart';
 import 'package:path_provider/path_provider.dart';
 import 'package:tmail_ui_user/features/composer/domain/state/upload_attachment_state.dart';
@@ -33,6 +34,7 @@ mixin ScenarioUtilsMixin {
     List<ProvisioningEmail> provisioningEmails, {
     bool refreshEmailView = true,
     bool requestReadReceipt = true,
+    Role? sentLocation,
   }) async {
     ComposerBindings().dependencies();
 
@@ -58,7 +60,9 @@ mixin ScenarioUtilsMixin {
           emailContent: provisioningEmail.content,
           toRecipients: {EmailAddress(null, provisioningEmail.toEmail)},
           outboxMailboxId: mailboxDashBoardController.outboxMailbox?.mailboxId,
-          sentMailboxId: mailboxDashBoardController.mapDefaultMailboxIdByRole[PresentationMailbox.roleSent],
+          sentMailboxId: mailboxDashBoardController.mapDefaultMailboxIdByRole[
+            sentLocation ?? PresentationMailbox.roleSent
+          ],
           identity: identity,
           attachments: attachments,
           hasRequestReadReceipt: requestReadReceipt,

integration_test/robots/mailbox_menu_robot.dart

@@ -70,4 +70,16 @@ class MailboxMenuRobot extends CoreRobot {
       })
       .tap();
   }
+
+  Future<void> tapRecoverDeletedMessages() async {
+    await $(AppLocalizations().recoverDeletedMessages).tap();
+  }
+
+  Future<void> tapConfirmRecoverDeletedMessages() async {
+    if (await $.native.isPermissionDialogVisible(timeout: const Duration(seconds: 2))) {
+      await $.native.grantPermissionWhenInUse();
+    }
+    await $(AppLocalizations().restore).tap();
+    await $.pumpAndSettle();
+  }
 }

integration_test/robots/thread_robot.dart

@@ -5,6 +5,7 @@ import 'package:tmail_ui_user/features/base/widget/compose_floating_button.dart'
 import 'package:tmail_ui_user/features/thread/presentation/thread_view.dart';
 import 'package:tmail_ui_user/features/thread/presentation/widgets/email_tile_builder.dart';
 import 'package:tmail_ui_user/features/thread/presentation/widgets/scroll_to_top_button_widget.dart';
+import 'package:tmail_ui_user/main/localizations/app_localizations.dart';
 
 import '../base/core_robot.dart';
 
@@ -60,4 +61,34 @@ class ThreadRobot extends CoreRobot {
   Future<void> selectStarredFilter() async {
     await $(#filter_email_starred).tap();
   }
+
+  Future<void> tapEmptyTrashBanner() async {
+    await $(AppLocalizations().empty_trash_now).tap();
+  }
+
+  Future<void> confirmEmptyTrash() async {
+    await $(AppLocalizations().delete_all).tap();
+  }
+
+  Future<void> tapEmptySpamBanner() async {
+    await $(AppLocalizations().deleteAllSpamEmailsNow).waitUntilVisible();
+    await $(AppLocalizations().deleteAllSpamEmailsNow).tap();
+  }
+
+  Future<void> confirmEmptySpam() async {
+    await $(AppLocalizations().delete_all).tap();
+  }
+
+  Future<void> tapEmptyTrashAfterLongPress() async {
+    await $(AppLocalizations().emptyTrash).tap();
+  }
+
+  Future<void> tapConfirmEmptyTrashAfterLongPress() async {
+    await $(AppLocalizations().delete).tap();
+    await $.pumpAndSettle(duration: const Duration(seconds: 2));
+  }
+
+  Future<void> tapEmptySpamAfterLongPress() async {
+    await $(AppLocalizations().deleteAllSpamEmails).tap();
+  }
 }

integration_test/scenarios/mailbox/empty_and_recover_spam_scenario.dart

@@ -0,0 +1,61 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:model/mailbox/presentation_mailbox.dart';
+import 'package:tmail_ui_user/features/thread/presentation/widgets/banner_delete_all_spam_emails_widget.dart';
+import 'package:tmail_ui_user/main/localizations/app_localizations.dart';
+
+import '../../base/base_test_scenario.dart';
+import '../../models/provisioning_email.dart';
+import '../../robots/mailbox_menu_robot.dart';
+import '../../robots/thread_robot.dart';
+
+class EmptyAndRecoverSpamScenario extends BaseTestScenario {
+  const EmptyAndRecoverSpamScenario(super.$);
+
+  @override
+  Future<void> runTestLogic() async {
+    const toEmail = String.fromEnvironment('BASIC_AUTH_EMAIL');
+    const subject = 'spam and recover';
+
+    final threadRobot = ThreadRobot($);
+    final mailboxMenuRobot = MailboxMenuRobot($);
+    final appLocalizations = AppLocalizations();
+
+    await provisionEmail(
+      [ProvisioningEmail(
+        toEmail: toEmail,
+        subject: subject,
+        content: '',
+      )],
+      sentLocation: PresentationMailbox.roleJunk,
+    );
+
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.spamMailboxDisplayName,
+    );
+    await threadRobot.tapEmptySpamBanner();
+    await threadRobot.confirmEmptySpam();
+    await _expectSpamBannerInvisible();
+
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.longPressMailboxWithName(
+      appLocalizations.trashMailboxDisplayName,
+    );
+    await mailboxMenuRobot.tapRecoverDeletedMessages();
+    await mailboxMenuRobot.tapConfirmRecoverDeletedMessages();
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.recoveredMailboxDisplayName,
+    );
+    await _expectEmailWithSubjectVisible(subject);
+  }
+
+  Future<void> _expectSpamBannerInvisible() async {
+    await $(#spam_banner_not_visible).waitUntilExists();
+    expect($(BannerDeleteAllSpamEmailsWidget).visible, false);
+  }
+
+  Future<void> _expectEmailWithSubjectVisible(String subject) async {
+    await expectViewVisible($(subject));
+  }
+} 

integration_test/scenarios/mailbox/empty_and_recover_trash_scenario.dart

@@ -0,0 +1,61 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:model/mailbox/presentation_mailbox.dart';
+import 'package:tmail_ui_user/features/thread/presentation/widgets/banner_empty_trash_widget.dart';
+import 'package:tmail_ui_user/main/localizations/app_localizations.dart';
+
+import '../../base/base_test_scenario.dart';
+import '../../models/provisioning_email.dart';
+import '../../robots/mailbox_menu_robot.dart';
+import '../../robots/thread_robot.dart';
+
+class EmptyAndRecoverTrashScenario extends BaseTestScenario {
+  const EmptyAndRecoverTrashScenario(super.$);
+
+  @override
+  Future<void> runTestLogic() async {
+    const toEmail = String.fromEnvironment('BASIC_AUTH_EMAIL');
+    const subject = 'trash and recover';
+
+    final threadRobot = ThreadRobot($);
+    final mailboxMenuRobot = MailboxMenuRobot($);
+    final appLocalizations = AppLocalizations();
+
+    await provisionEmail(
+      [ProvisioningEmail(
+        toEmail: toEmail,
+        subject: subject,
+        content: '',
+      )],
+      sentLocation: PresentationMailbox.roleTrash,
+    );
+
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.trashMailboxDisplayName,
+      );
+    await threadRobot.tapEmptyTrashBanner();
+    await threadRobot.confirmEmptyTrash();
+    await _expectTrashBannerInvisible();
+
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.longPressMailboxWithName(
+      appLocalizations.trashMailboxDisplayName,
+    );
+    await mailboxMenuRobot.tapRecoverDeletedMessages();
+    await mailboxMenuRobot.tapConfirmRecoverDeletedMessages();
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.recoveredMailboxDisplayName,
+    );
+    await _expectEmailWithSubjectVisible(subject);
+  }
+
+  Future<void> _expectTrashBannerInvisible() async {
+    await $(#trash_banner_not_visible).waitUntilExists();
+    expect($(BannerEmptyTrashWidget).visible, false);
+  }
+
+  Future<void> _expectEmailWithSubjectVisible(String subject) async {
+    await expectViewVisible($(subject));
+  }
+}

integration_test/scenarios/mailbox/long_press_empty_and_recover_spam_scenario.dart

@@ -0,0 +1,92 @@
+import 'package:flutter_test/flutter_test.dart';
+import 'package:model/mailbox/presentation_mailbox.dart';
+import 'package:tmail_ui_user/features/mailbox/presentation/widgets/trailing_mailbox_item_widget.dart';
+import 'package:tmail_ui_user/features/thread/presentation/widgets/banner_delete_all_spam_emails_widget.dart';
+import 'package:tmail_ui_user/main/localizations/app_localizations.dart';
+
+import '../../base/base_test_scenario.dart';
+import '../../models/provisioning_email.dart';
+import '../../robots/mailbox_menu_robot.dart';
+import '../../robots/thread_robot.dart';
+
+class LongPressEmptyAndRecoverSpamScenario extends BaseTestScenario {
+  const LongPressEmptyAndRecoverSpamScenario(super.$);
+
+  @override
+  Future<void> runTestLogic() async {
+    const toEmail = String.fromEnvironment('BASIC_AUTH_EMAIL');
+    const subject = 'long press spam';
+
+    final threadRobot = ThreadRobot($);
+    final mailboxMenuRobot = MailboxMenuRobot($);
+    final appLocalizations = AppLocalizations();
+
+    await provisionEmail(
+      [ProvisioningEmail(
+        toEmail: toEmail,
+        subject: subject,
+        content: '',
+      )],
+      sentLocation: PresentationMailbox.roleJunk,
+    );
+
+    await threadRobot.openMailbox();
+    await _expectMailboxWithNameHaveCountVisible(
+      appLocalizations.spamMailboxDisplayName,
+    );
+    await mailboxMenuRobot.longPressMailboxWithName(
+      appLocalizations.spamMailboxDisplayName,
+    );
+    await threadRobot.tapEmptySpamAfterLongPress();
+    await threadRobot.confirmEmptySpam();
+    _expectMailboxWithNameHaveCountInvisible(
+      appLocalizations.spamMailboxDisplayName,
+    );
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.spamMailboxDisplayName,
+    );
+    await _expectSpamBannerInvisible();
+
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.longPressMailboxWithName(
+      appLocalizations.trashMailboxDisplayName,
+    );
+    await mailboxMenuRobot.tapRecoverDeletedMessages();
+    await mailboxMenuRobot.tapConfirmRecoverDeletedMessages();
+    await threadRobot.openMailbox();
+    await mailboxMenuRobot.openFolderByName(
+      appLocalizations.recoveredMailboxDisplayName,
+    );
+    await _expectEmailWithSubjectVisible(subject);
+  }
+
+  Future<void> _expectSpamBannerInvisible() async {
+    await $(#spam_banner_not_visible).waitUntilExists();
+    expect($(BannerDeleteAllSpamEmailsWidget).visible, false);
+  }
+
+  Future<void> _expectEmailWithSubjectVisible(String subject) async {
+    await expectViewVisible($(subject));
+  }
+
+  Future<void> _expectMailboxWithNameHaveCountVisible(String name) async {
+    await expectViewVisible(
+      $(TrailingMailboxItemWidget)
+        .which<TrailingMailboxItemWidget>((widget) {
+          return widget.mailboxNode.item.name?.name.toLowerCase() == name.toLowerCase();
+        })
+    );
+  }
+
+  void _expectMailboxWithNameHaveCountInvisible(String name) {
+    expect(
+      $(TrailingMailboxItemWidget)
+        .which<TrailingMailboxItemWidget>((widget) {
+          return widget.mailboxNode.item.name?.name.toLowerCase() == name.toLowerCase();
+        })
+        .visible,
+      false,
+    );
+  }
+}