Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show toast on measurement interaction #981

Merged
merged 4 commits into from
Jan 17, 2025
Merged

Show toast on measurement interaction #981

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
baf48e7
Update measurement toast
sven1103 Jan 15, 2025
439e846
Apply suggestions from code review
sven1103 Jan 16, 2025
28996dd
Correct number of measurements
sven1103 Jan 16, 2025
82b00a1
Revert change for registration
sven1103 Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion user-interface/src/main/java/life/qbic/datamanager/views/notifications/Toast.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public final class Toast extends Notification {
addClassName(switch (level) {
case SUCCESS -> "success-toast";
case INFO -> "info-toast";
case WARNING, ERROR -> "";
case WARNING, ERROR -> "error-toast";
});

setPosition(DEFAULT_POSITION);
Expand Down
108 changes: 73 additions & 35 deletions .../main/java/life/qbic/datamanager/views/projects/project/measurements/MeasurementMain.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import com.vaadin.flow.spring.annotation.UIScope;
import jakarta.annotation.security.PermitAll;
import java.io.Serial;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
Expand All @@ -39,15 +40,16 @@
import life.qbic.datamanager.views.general.download.MeasurementTemplateDownload;
import life.qbic.datamanager.views.notifications.CancelConfirmationDialogFactory;
import life.qbic.datamanager.views.notifications.ErrorMessage;
import life.qbic.datamanager.views.notifications.MessageSourceNotificationFactory;
import life.qbic.datamanager.views.notifications.StyledNotification;
import life.qbic.datamanager.views.notifications.Toast;
import life.qbic.datamanager.views.projects.project.experiments.ExperimentMainLayout;
import life.qbic.datamanager.views.projects.project.measurements.MeasurementMetadataUploadDialog.ConfirmEvent;
import life.qbic.datamanager.views.projects.project.measurements.MeasurementMetadataUploadDialog.MODE;
import life.qbic.datamanager.views.projects.project.measurements.MeasurementMetadataUploadDialog.MeasurementMetadataUpload;
import life.qbic.datamanager.views.projects.project.measurements.MeasurementTemplateListComponent.DownloadMeasurementTemplateEvent;
import life.qbic.logging.api.Logger;
import life.qbic.logging.service.LoggerFactory;
import life.qbic.projectmanagement.application.ProjectInformationService;
import life.qbic.projectmanagement.application.measurement.MeasurementMetadata;
import life.qbic.projectmanagement.application.measurement.MeasurementService;
import life.qbic.projectmanagement.application.measurement.MeasurementService.MeasurementDeletionException;
import life.qbic.projectmanagement.application.measurement.validation.MeasurementValidationService;
Expand All @@ -60,7 +62,6 @@
import life.qbic.projectmanagement.domain.model.project.Project;
import life.qbic.projectmanagement.domain.model.project.ProjectId;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.StringUtils;


/**
Expand Down Expand Up @@ -101,6 +102,7 @@ public class MeasurementMain extends Main implements BeforeEnterObserver {
private final DownloadProvider proteomicsDownloadProvider;
private final transient ProjectInformationService projectInformationService;
private final transient CancelConfirmationDialogFactory cancelConfirmationDialogFactory;
private final transient MessageSourceNotificationFactory messageFactory;
private transient Context context;

public MeasurementMain(
Expand All @@ -111,11 +113,13 @@ public MeasurementMain(
@Autowired MeasurementPresenter measurementPresenter,
@Autowired MeasurementValidationService measurementValidationService,
ProjectInformationService projectInformationService,
CancelConfirmationDialogFactory cancelConfirmationDialogFactory) {
CancelConfirmationDialogFactory cancelConfirmationDialogFactory,
MessageSourceNotificationFactory messageFactory) {
Objects.requireNonNull(measurementTemplateListComponent);
Objects.requireNonNull(measurementDetailsComponent);
Objects.requireNonNull(measurementService);
Objects.requireNonNull(measurementValidationService);
this.messageFactory = Objects.requireNonNull(messageFactory);
this.measurementDetailsComponent = measurementDetailsComponent;
this.measurementTemplateListComponent = measurementTemplateListComponent;
this.measurementService = measurementService;
Expand Down Expand Up @@ -283,50 +287,76 @@ private Dialog setupDialog(MeasurementMetadataUploadDialog dialog) {
dialog.addCancelListener(cancelEvent -> cancelEvent.getSource().close());
dialog.addConfirmListener(confirmEvent ->
{
triggerMeasurementRegistration(confirmEvent.uploads(),
confirmEvent.getSource());
setMeasurementInformation();
triggerMeasurementRegistration(confirmEvent);
});
return dialog;
}

private void triggerMeasurementRegistration(
List<MeasurementMetadataUpload<MeasurementMetadata>> measurementMetadataUploads,
MeasurementMetadataUploadDialog measurementMetadataUploadDialog) {
String process =
measurementMetadataUploadDialog.getMode() == MODE.EDIT ? "update" : "registration";
for (var upload : measurementMetadataUploads) {
ConfirmEvent event) {
var uploads = new ArrayList<>(event.uploads());
var dialog = event.getSource();
var mode = dialog.getMode();
UI ui = event.getSource().getUI().orElseThrow();
for (var upload : uploads) {
var measurementData = upload.measurementMetadata();
measurementMetadataUploadDialog.taskInProgress(
"%s of %s measurements ...".formatted(StringUtils.capitalize(process),
measurementData.size()),
"This might take a minute");

// UI ui = UI.getCurrent();
sven1103 marked this conversation as resolved.
Show resolved Hide resolved
//Necessary so the dialog window switches to show the upload progress
UI.getCurrent().push();
ui.push();
CompletableFuture<List<Result<MeasurementId, MeasurementService.ErrorCode>>> completableFuture;
if (measurementMetadataUploadDialog.getMode().equals(MODE.EDIT)) {
completableFuture = measurementService.updateAll(upload.measurementMetadata(),
Toast pendingToast;

// we can close the dialog, everything that comes now is executed concurrently and there is
// no need the user is blocked
event.getSource().close();

if (mode.equals(MODE.EDIT)) {
completableFuture = measurementService.updateAll(measurementData,
context.projectId().orElseThrow());
pendingToast = messageFactory.pendingTaskToast("task.in-progress", new Object[]{
"Update of #%d measurements".formatted(measurementData.size())},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be confusing in the pooling context, since it will show the number of rows which are updated but not the number of unique measurements.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you suggest instead?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One way could be to filter the number of measurementIds via the distinct method to ensure only unique measurements are counted and then provide that number within the toast message.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so straight forward, love it. will do

getLocale());
} else {
completableFuture = measurementService.registerAll(upload.measurementMetadata(),
context.projectId().orElseThrow());
pendingToast = messageFactory.pendingTaskToast("task.in-progress", new Object[]{
"Registration of #%d measurements".formatted(upload.measurementMetadata().size())},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be confusing in the pooling context, since it will show the number of rows which are registered but not the number of unique measurements.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you suggest instead?

getLocale());
}
ui.access( pendingToast::open);
try {
completableFuture.exceptionally(e -> {
log.error(e.getMessage(), e);
ui.access(() -> {
pendingToast.close();
messageFactory.toast("task.failed", new Object[]{"Registration failed"}, getLocale())
.open();
});
throw new HandledException(e);
})
.thenAccept(results -> {
var errorResult = results.stream().filter(Result::isError).findAny();
if (errorResult.isPresent()) {
String detailedMessage = convertErrorCodeToMessage(errorResult.get().getError());
ui.access(() -> {
pendingToast.close();
messageFactory.toast("task.failed", new Object[]{detailedMessage}, getLocale());
});
} else {
ui.access(() -> {
pendingToast.close();
messageFactory.toast("task.finished", new Object[]{"Measurement update"},
getLocale()).open();
setMeasurementInformation();
});
}
}).exceptionally(e -> {
throw new HandledException(e);
});
} catch (HandledException e) {
log.error(e.getMessage(), e);
}
completableFuture.thenAccept(results -> {
var errorResult = results.stream().filter(Result::isError).findAny();
if (errorResult.isPresent()) {
String detailedMessage = convertErrorCodeToMessage(errorResult.get().getError());
measurementMetadataUploadDialog.getUI().ifPresent(ui -> ui.access(
() -> measurementMetadataUploadDialog.taskFailed(
"Measurement %s could not be completed".formatted(process),
detailedMessage)));
} else {
measurementMetadataUploadDialog.getUI().ifPresent(ui -> ui.access(
() -> measurementMetadataUploadDialog.taskSucceeded(
"Measurement %s is complete".formatted(process),
"Measurement %s for %s measurements was successful".formatted(process,
measurementData.size()))));
}
}).join(); // we wait for the update to finish
}
}

Expand Down Expand Up @@ -565,4 +595,12 @@ private void setSelectedMeasurementsInfo(int selectedMeasurements) {
}
measurementsSelectedInfoBox.setText(text);
}

static class HandledException extends RuntimeException {

HandledException(Throwable cause) {
super(cause);
}

}
}
1 change: 0 additions & 1 deletion ...qbic/datamanager/views/projects/project/measurements/MeasurementMetadataUploadDialog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,6 @@ protected void onConfirmClicked(ClickEvent<Button> clickEvent) {
return;
}
uploadItemsDisplay.setVisible(false);
uploadProgressDisplay.setVisible(true);
fireEvent(new ConfirmEvent(this, clickEvent.isFromClient(), measurementMetadataUploads));
}

Expand Down
Loading