Display toasts in case of project creation (#1020)

Displays a success toast for successful project creation, or error toasts for failing project or experiment tasks.

Author: sven1103

user-interface/src/main/java/life/qbic/datamanager/views/projects/overview/ProjectOverviewMain.java

@@ -13,6 +13,8 @@
 import java.io.Serial;
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.Locale;
+import java.util.Objects;
 import java.util.Set;
 import life.qbic.application.commons.ApplicationException;
 import life.qbic.application.commons.Result;
@@ -21,11 +23,12 @@
 import life.qbic.datamanager.views.general.Main;
 import life.qbic.datamanager.views.general.contact.Contact;
 import life.qbic.datamanager.views.notifications.CancelConfirmationDialogFactory;
-import life.qbic.datamanager.views.notifications.StyledNotification;
-import life.qbic.datamanager.views.notifications.SuccessMessage;
+import life.qbic.datamanager.views.notifications.MessageSourceNotificationFactory;
+import life.qbic.datamanager.views.notifications.Toast;
 import life.qbic.datamanager.views.projects.create.AddProjectDialog;
 import life.qbic.datamanager.views.projects.create.AddProjectDialog.ConfirmEvent;
 import life.qbic.datamanager.views.projects.overview.components.ProjectCollectionComponent;
+import life.qbic.datamanager.views.register.EmailConfirmationMain;
 import life.qbic.finances.api.FinanceService;
 import life.qbic.identity.api.UserInformationService;
 import life.qbic.logging.api.Logger;
@@ -62,6 +65,7 @@ public class ProjectOverviewMain extends Main {
   private final transient AddExperimentToProjectService addExperimentToProjectService;
   private final transient UserInformationService userInformationService;
   private final transient AuthenticationToUserIdTranslationService userIdTranslator;
+  private final transient MessageSourceNotificationFactory messageSourceNotificationFactory;
 
   public ProjectOverviewMain(@Autowired ProjectCollectionComponent projectCollectionComponent,
       ProjectCreationService projectCreationService, FinanceService financeService,
@@ -71,7 +75,8 @@ public ProjectOverviewMain(@Autowired ProjectCollectionComponent projectCollecti
       UserInformationService userInformationService,
       AuthenticationToUserIdTranslationService userIdTranslator,
       TerminologyService terminologyService,
-      CancelConfirmationDialogFactory cancelConfirmationDialogFactory) {
+      CancelConfirmationDialogFactory cancelConfirmationDialogFactory,
+      MessageSourceNotificationFactory messageSourceNotificationFactory) {
     this.projectCollectionComponent = requireNonNull(projectCollectionComponent,
         "project collection component can not be null");
     this.projectCreationService = requireNonNull(projectCreationService,
@@ -110,6 +115,21 @@ public ProjectOverviewMain(@Autowired ProjectCollectionComponent projectCollecti
         this.getClass().getSimpleName(), System.identityHashCode(this),
         projectCollectionComponent.getClass().getSimpleName(),
         System.identityHashCode(projectCollectionComponent)));
+    this.messageSourceNotificationFactory = messageSourceNotificationFactory;
+  }
+
+  private static Toast notificationFor(NotificationType type, ConfirmEvent confirmEvent,
+      MessageSourceNotificationFactory factory, Locale locale) {
+    return switch (type) {
+      case PROJECT_CREATED_SUCCESSFULLY -> factory.toast("project.created.success",
+          new Object[]{confirmEvent.getProjectDesign().getProjectTitle()}, locale);
+      case PROJECT_CREATION_FAILED ->
+          factory.toast("project.created.error", new Object[]{}, locale);
+      case EXPERIMENT_CREATED_SUCCESSFULLY -> factory.toast("experiment.created.success",
+          new Object[]{confirmEvent.getExperimentalInformation().getExperimentName()}, locale);
+      case EXPERIMENT_CREATION_FAILED ->
+          factory.toast("experiment.created.error", new Object[]{}, locale);
+    };
   }
 
   private void addTitleAndDescription() {
@@ -158,11 +178,7 @@ private void createProject(ConfirmEvent confirmEvent) {
             .map(Contact::toDomainContact).orElse(null),
         confirmEvent.getProjectCollaborators().getProjectManager().toDomainContact(),
         funding);
-    project
-        .onValue(result -> onProjectCreated(confirmEvent))
-        .onError(e -> {
-          throw e;
-        });
+    handleResultProject(project, confirmEvent);
     var experiment = addExperimentToProjectService.addExperimentToProject(
         project.getValue().getId(),
         confirmEvent.getExperimentalInformation().getExperimentName(),
@@ -171,22 +187,43 @@ private void createProject(ConfirmEvent confirmEvent) {
         confirmEvent.getExperimentalInformation().getAnalytes(),
         confirmEvent.getExperimentalInformation().getSpeciesIcon().getLabel(),
         confirmEvent.getExperimentalInformation().getSpecimenIcon().getLabel());
-    experiment.onError(e -> {
-      throw e;
-    });
+    handleResultExperiment(experiment, confirmEvent);
+    projectCollectionComponent.refresh();
+    projectCollectionComponent.resetSearch();
+  }
+
+  private void handleResultProject(Result<?, ?> result, ConfirmEvent event) {
+    if (result.isError()) {
+      processNotification(notificationFor(NotificationType.PROJECT_CREATION_FAILED, event,
+          messageSourceNotificationFactory, getLocale()));
+      return;
+    }
+    processNotification(notificationFor(NotificationType.PROJECT_CREATED_SUCCESSFULLY, event,
+        messageSourceNotificationFactory, getLocale()));
+    closeDialog(event);
   }
 
-  private void onProjectCreated(ConfirmEvent confirmEvent) {
-    displaySuccessfulProjectCreationNotification();
-    confirmEvent.getSource().close();
+  private void handleResultExperiment(Result<?, ?> result, ConfirmEvent event) {
+    if (result.isError()) {
+      processNotification(notificationFor(NotificationType.EXPERIMENT_CREATION_FAILED, event,
+          messageSourceNotificationFactory, getLocale()));
+      return;
+    }
+    closeDialog(event);
+  }
 
-    projectCollectionComponent.refresh();
-    projectCollectionComponent.resetSearch();
+  private void processNotification(Toast t) {
+    t.open();
+  }
+
+  private void closeDialog(ConfirmEvent event) {
+    event.getSource().close();
   }
 
-  private void displaySuccessfulProjectCreationNotification() {
-    var successMessage = new SuccessMessage("Project creation succeeded.", "");
-    var notification = new StyledNotification(successMessage);
-    notification.open();
+  enum NotificationType {
+    PROJECT_CREATED_SUCCESSFULLY,
+    PROJECT_CREATION_FAILED,
+    EXPERIMENT_CREATED_SUCCESSFULLY,
+    EXPERIMENT_CREATION_FAILED,
   }
 }

user-interface/src/main/resources/messages/toast-notifications.properties

@@ -25,6 +25,15 @@ personal-access-token.created.success.message.type=html
 personal-access-token.created.success.message.text=Personal Access Token <strong>{0}</strong> was created.
 personal-access-token.created.success.duration=PT8s
 personal-access-token.created.success.level=success
+project.created.success.message.type=html
+project.created.success.message.text=New project <strong>{0}</strong> created.
+project.created.success.level=success
+project.created.error.message.type=html
+project.created.error.message.text=Project creation failed, please contact the <a href="mailto:[email protected]">QBiC support</a>.
+project.created.error.level=error
+experiment.created.error.message.type=html
+experiment.created.error.message.text=Experiment creation failed, please contact the <a href="mailto:[email protected]">QBiC support</a>.
+experiment.created.error.level=error
 sample-batch.deleted.success.message.type=html
 sample-batch.deleted.success.message.text=Deleted sample batch <strong>{0}</strong>.
 sample-batch.deleted.success.level=success