Provide ExperimentId To batch registration email (#954)

Steffengreiner · web-flow · commit e70a3891db92 · 2024-12-17T15:23:19.000+01:00
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/application/AppContextProvider.java b/project-management/src/main/java/life/qbic/projectmanagement/application/AppContextProvider.java
@@ -22,8 +22,9 @@ public interface AppContextProvider {
    * Returns a resolvable URL to the target project's sample page resource in the application.
    *
    * @param projectId the project id
+   * @param experimentId the experiment id
    * @return a fully resolvable URL
    * @since 1.0.0
    */
-  String urlToSamplePage(String projectId);
+  String urlToSamplePage(String projectId, String experimentId);
 }
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/application/batch/BatchRegistrationService.java b/project-management/src/main/java/life/qbic/projectmanagement/application/batch/BatchRegistrationService.java
@@ -15,6 +15,7 @@
 import life.qbic.projectmanagement.application.sample.SampleRegistrationService;
 import life.qbic.projectmanagement.domain.model.batch.Batch;
 import life.qbic.projectmanagement.domain.model.batch.BatchId;
+import life.qbic.projectmanagement.domain.model.experiment.ExperimentId;
 import life.qbic.projectmanagement.domain.model.project.ProjectId;
 import life.qbic.projectmanagement.domain.model.sample.Sample;
 import life.qbic.projectmanagement.domain.model.sample.SampleId;
@@ -70,21 +71,23 @@ public BatchRegistrationService(BatchRepository batchRepository,
    *                  are usually followed by a complete batch that represents the measurements of
    *                  the complete experiment.
    * @param projectId id of the project this batch is added to
+   * @param experimentId id of the experiment this batch is added to
    * @return a result object with the response. If the registration failed, a response code will be
    * provided.
    * @since 1.0.0
    */
   @PreAuthorize("hasPermission(#projectId, 'life.qbic.projectmanagement.domain.model.project.Project', 'WRITE')")
   public Result<BatchId, ResponseCode> registerBatch(String label, boolean isPilot,
-      ProjectId projectId) {
+      ProjectId projectId, ExperimentId experimentId) {
     var project = projectInformationService.find(projectId);
     if (project.isEmpty()) {
       log.error(
           "Batch registration aborted. Reason: project with id:" + projectId + " was not found");
       return Result.fromError(ResponseCode.BATCH_CREATION_FAILED);
     }
     String projectTitle = project.get().getProjectIntent().projectTitle().title();
-    var result = batchDomainService.register(label, isPilot, projectTitle, projectId);
+    var result = batchDomainService.register(label, isPilot, projectTitle, projectId,
+        experimentId);
     if (result.isError()) {
       return Result.fromError(ResponseCode.BATCH_REGISTRATION_FAILED);
     }
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/application/policy/directive/InformUsersAboutBatchRegistration.java b/project-management/src/main/java/life/qbic/projectmanagement/application/policy/directive/InformUsersAboutBatchRegistration.java
@@ -60,7 +60,8 @@ public Class<? extends DomainEvent> subscribedToEventType() {
   @PreAuthorize("hasPermission(#projectId, 'life.qbic.projectmanagement.domain.model.project.Project', 'WRITE')")
   public void handleEvent(BatchRegistered event) {
     List<RecipientDTO> recipients = getRecipients(event.projectId());
-    String sampleUri = appContextProvider.urlToSamplePage(event.projectId().value());
+    String sampleUri = appContextProvider.urlToSamplePage(event.projectId().value(),
+        event.experimentId().value());
     notifyAllRecipients(recipients, event.projectTitle(), event.name(), sampleUri);
   }
 
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleRegistrationServiceV2.java b/project-management/src/main/java/life/qbic/projectmanagement/application/sample/SampleRegistrationServiceV2.java
@@ -58,9 +58,10 @@ public SampleRegistrationServiceV2(BatchRegistrationService batchRegistrationSer
   @PreAuthorize("hasPermission(#projectId, 'life.qbic.projectmanagement.domain.model.project.Project', 'WRITE')")
   @Async
   public CompletableFuture<Void> registerSamples(Collection<SampleMetadata> sampleMetadata,
-      ProjectId projectId, String batchLabel, boolean batchIsPilot)
+      ProjectId projectId, String batchLabel, boolean batchIsPilot, ExperimentId experimentId)
       throws RegistrationException {
-    var result = batchRegistrationService.registerBatch(batchLabel, batchIsPilot, projectId);
+    var result = batchRegistrationService.registerBatch(batchLabel, batchIsPilot, projectId,
+        experimentId);
     if (result.isError()) {
       throw new RegistrationException("Batch registration failed");
     }
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/domain/model/sample/event/BatchRegistered.java b/project-management/src/main/java/life/qbic/projectmanagement/domain/model/sample/event/BatchRegistered.java
@@ -5,6 +5,7 @@
 import java.util.Objects;
 import life.qbic.domain.concepts.DomainEvent;
 import life.qbic.projectmanagement.domain.model.batch.BatchId;
+import life.qbic.projectmanagement.domain.model.experiment.ExperimentId;
 import life.qbic.projectmanagement.domain.model.project.ProjectId;
 
 /**
@@ -17,23 +18,27 @@
 public class BatchRegistered extends DomainEvent {
 
   @Serial
-  private static final long serialVersionUID = 580378782496926484L;
+  private static final long serialVersionUID = 1439070961084871049L;
 
   private final BatchId batchId;
   private final String projectTitle;
   private final String batchName;
   private final ProjectId projectId;
+  private final ExperimentId experimentId;
 
-  private BatchRegistered(BatchId batchId, String batchName, String projectTitle, ProjectId projectId) {
+  private BatchRegistered(BatchId batchId, String batchName, String projectTitle,
+      ProjectId projectId,
+      ExperimentId experimentId) {
     this.batchId = Objects.requireNonNull(batchId);
     this.projectTitle = Objects.requireNonNull(projectTitle);
     this.batchName = Objects.requireNonNull(batchName);
     this.projectId = Objects.requireNonNull(projectId);
+    this.experimentId = Objects.requireNonNull(experimentId);
   }
 
   public static BatchRegistered create(String batchName, BatchId id, String projectTitle,
-      ProjectId projectId) {
-    return new BatchRegistered(id, batchName, projectTitle, projectId);
+      ProjectId projectId, ExperimentId experimentId) {
+    return new BatchRegistered(id, batchName, projectTitle, projectId, experimentId);
   }
 
   @JsonGetter("batchId")
@@ -50,4 +55,8 @@ public BatchId batchId() {
   @JsonGetter("projectId")
   public ProjectId projectId() { return projectId; }
 
+  @JsonGetter("experimentId")
+  public ExperimentId experimentId() {
+    return experimentId;
+  }
 }
diff --git a/project-management/src/main/java/life/qbic/projectmanagement/domain/service/BatchDomainService.java b/project-management/src/main/java/life/qbic/projectmanagement/domain/service/BatchDomainService.java
@@ -5,6 +5,7 @@
 import life.qbic.domain.concepts.DomainEventDispatcher;
 import life.qbic.projectmanagement.domain.model.batch.Batch;
 import life.qbic.projectmanagement.domain.model.batch.BatchId;
+import life.qbic.projectmanagement.domain.model.experiment.ExperimentId;
 import life.qbic.projectmanagement.domain.model.project.ProjectId;
 import life.qbic.projectmanagement.domain.model.project.event.ProjectChanged;
 import life.qbic.projectmanagement.domain.model.sample.event.BatchDeleted;
@@ -42,25 +43,28 @@ public BatchDomainService(BatchRepository batchRepository) {
    *                    measurements of the complete experiment.
    * @param projectName the title of the project the batch is added to
    * @param projectId   id of the project this batch is added to
+   * @param experimentId id of the experiment this batch is added to
    * @return a result object with the response. If the registration failed, a response code will be
    * provided.
    * @since 1.0.0
    */
   public Result<BatchId, ResponseCode> register(String label, boolean isPilot, String projectName,
-      ProjectId projectId) {
+      ProjectId projectId, ExperimentId experimentId) {
     Batch batch = Batch.create(label, isPilot);
     var result = batchRepository.add(batch);
     if (result.isError()) {
       return Result.fromError(ResponseCode.BATCH_REGISTRATION_FAILED);
     } else {
-      dispatchRegistration(label, batch.batchId(), projectName, projectId);
+      dispatchRegistration(label, batch.batchId(), projectName, projectId,
+          experimentId);
     }
     return Result.fromValue(result.getValue().batchId());
   }
 
   private void dispatchRegistration(String name, BatchId id, String projectName,
-      ProjectId projectId) {
-    BatchRegistered batchRegistered = BatchRegistered.create(name, id, projectName, projectId);
+      ProjectId projectId, ExperimentId experimentId) {
+    BatchRegistered batchRegistered = BatchRegistered.create(name, id, projectName, projectId,
+        experimentId);
     DomainEventDispatcher.instance().dispatch(batchRegistered);
   }
 
diff --git a/project-management/src/test/groovy/life/qbic/projectmanagement/domain/service/BatchDomainServiceSpec.groovy b/project-management/src/test/groovy/life/qbic/projectmanagement/domain/service/BatchDomainServiceSpec.groovy
@@ -6,6 +6,7 @@ import life.qbic.domain.concepts.DomainEventDispatcher
 import life.qbic.domain.concepts.DomainEventSubscriber
 import life.qbic.projectmanagement.domain.model.batch.Batch
 import life.qbic.projectmanagement.domain.model.batch.BatchId
+import life.qbic.projectmanagement.domain.model.experiment.ExperimentId
 import life.qbic.projectmanagement.domain.model.project.*
 import life.qbic.projectmanagement.domain.model.sample.event.BatchDeleted
 import life.qbic.projectmanagement.domain.model.sample.event.BatchRegistered
@@ -49,7 +50,7 @@ class BatchDomainServiceSpec extends Specification {
         DomainEventDispatcher.instance().subscribe(batchRegistered)
 
         when:
-        domainService.register("test", false, project.projectIntent.projectTitle().title(), project.getId())
+        domainService.register("test", false, project.projectIntent.projectTitle().title(), project.getId(), ExperimentId.create())
 
         then:
         batchRegistered.eventReceived
diff --git a/user-interface/src/main/java/life/qbic/datamanager/DataManagerContextProvider.java b/user-interface/src/main/java/life/qbic/datamanager/DataManagerContextProvider.java
@@ -51,10 +51,11 @@ public String urlToProject(String projectId) {
   }
 
   @Override
-  public String urlToSamplePage(String projectId) {
+  public String urlToSamplePage(String projectId, String experimentId) {
     try {
       return new URL(baseUrlApplication,
-          Paths.get(baseUrlApplication.getPath(), samplesEndpoint.formatted(projectId))
+          Paths.get(baseUrlApplication.getPath(),
+                  samplesEndpoint.formatted(projectId, experimentId))
               .toString()).toExternalForm();
     } catch (MalformedURLException e) {
       throw new ApplicationException("Data Manager context creation failed.", e);
diff --git a/user-interface/src/main/java/life/qbic/datamanager/views/projects/project/samples/SampleInformationMain.java b/user-interface/src/main/java/life/qbic/datamanager/views/projects/project/samples/SampleInformationMain.java
@@ -232,7 +232,7 @@ private void onRegisterBatchClicked() {
       UI ui = event.getSource().getUI().orElseThrow();
       CompletableFuture<Void> registrationTask = sampleRegistrationServiceV2.registerSamples(
               event.validatedSampleMetadata(),
-              projectId, event.batchName(), false)
+              projectId, event.batchName(), false, experimentId)
           .orTimeout(5, TimeUnit.MINUTES);
       try {
         registrationTask
diff --git a/user-interface/src/main/resources/application.properties b/user-interface/src/main/resources/application.properties
@@ -93,7 +93,7 @@ routing.password-reset.reset-parameter=${PASSWORD_RESET_PARAMETER:user-id}
 # route to project resource
 routing.projects.endpoint=/projects
 routing.projects.info.endpoint=/projects/%s/info
-routing.projects.samples.enpoint=/projects/%s/samples
+routing.projects.samples.enpoint=/projects/%s/experiments/%s/samples
 routing.registration.oidc.orcid.endpoint=/register/oidc
 routing.registration.error.pending-email-verification=/register/pending-email-confirmation
 ################## oauth provider ###########################

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,9 @@ public interface AppContextProvider {`
`22`	`22`	`* Returns a resolvable URL to the target project's sample page resource in the application.`
`23`	`23`	`*`
`24`	`24`	`* @param projectId the project id`
	`25`	`+ * @param experimentId the experiment id`
`25`	`26`	`* @return a fully resolvable URL`
`26`	`27`	`* @since 1.0.0`
`27`	`28`	`*/`
`28`		`- String urlToSamplePage(String projectId);`
	`29`	`+ String urlToSamplePage(String projectId, String experimentId);`
`29`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,8 @@ public Class<? extends DomainEvent> subscribedToEventType() {`
`60`	`60`	`@PreAuthorize("hasPermission(#projectId, 'life.qbic.projectmanagement.domain.model.project.Project', 'WRITE')")`
`61`	`61`	`public void handleEvent(BatchRegistered event) {`
`62`	`62`	`List<RecipientDTO> recipients = getRecipients(event.projectId());`
`63`		`- String sampleUri = appContextProvider.urlToSamplePage(event.projectId().value());`
	`63`	`+ String sampleUri = appContextProvider.urlToSamplePage(event.projectId().value(),`
	`64`	`+ event.experimentId().value());`
`64`	`65`	`notifyAllRecipients(recipients, event.projectTitle(), event.name(), sampleUri);`
`65`	`66`	`}`
`66`	`67`