Propagate to user if a project with the provided code already exists during project creation (#516)

* Propagate to user if project code is already in use

* Fail early and intelligent and remove unused fields

Author: Steffengreiner

project-management/src/main/java/life/qbic/projectmanagement/application/ProjectCreationService.java

@@ -1,15 +1,13 @@
 package life.qbic.projectmanagement.application;
 
 import static java.util.Objects.requireNonNull;
-import static life.qbic.logging.service.LoggerFactory.logger;
 
 import java.util.Objects;
 import java.util.Optional;
 import life.qbic.application.commons.ApplicationException;
 import life.qbic.application.commons.ApplicationException.ErrorCode;
 import life.qbic.application.commons.ApplicationException.ErrorParameters;
 import life.qbic.application.commons.Result;
-import life.qbic.logging.api.Logger;
 import life.qbic.projectmanagement.domain.model.project.Contact;
 import life.qbic.projectmanagement.domain.model.project.Funding;
 import life.qbic.projectmanagement.domain.model.project.OfferIdentifier;
@@ -18,9 +16,7 @@
 import life.qbic.projectmanagement.domain.model.project.ProjectIntent;
 import life.qbic.projectmanagement.domain.model.project.ProjectObjective;
 import life.qbic.projectmanagement.domain.model.project.ProjectTitle;
-import life.qbic.projectmanagement.domain.repository.ProjectRepository;
 import life.qbic.projectmanagement.domain.service.ProjectDomainService;
-import life.qbic.projectmanagement.domain.service.ProjectDomainService.ResponseCode;
 import org.springframework.stereotype.Service;
 
 /**
@@ -29,14 +25,9 @@
 @Service
 public class ProjectCreationService {
 
-  private static final Logger log = logger(ProjectCreationService.class);
-
-  private final ProjectRepository projectRepository;
   private final ProjectDomainService projectDomainService;
 
-  public ProjectCreationService(ProjectRepository projectRepository,
-      ProjectDomainService projectDomainService) {
-    this.projectRepository = requireNonNull(projectRepository);
+  public ProjectCreationService(ProjectDomainService projectDomainService) {
     this.projectDomainService = requireNonNull(projectDomainService);
   }
 
@@ -64,7 +55,6 @@ public Result<Project, ApplicationException> createProject(String sourceOffer,
     if (Objects.isNull(projectManager)) {
       return Result.fromError(new ApplicationException("project manager is null"));
     }
-
     try {
       Project project = createProject(code, title, objective, projectManager,
           principalInvestigator, responsiblePerson, funding);
@@ -84,24 +74,13 @@ private Project createProject(String code, String title, String objective,
     ProjectCode projectCode;
     try {
       projectCode = ProjectCode.parse(code);
-      if (!projectRepository.find(projectCode).isEmpty()) {
-        throw new ApplicationException("Project code: " + code + " is already in use.",
-            ErrorCode.DUPLICATE_PROJECT_CODE,
-            ErrorParameters.of(code));
-      }
     } catch (IllegalArgumentException exception) {
       throw new ApplicationException("Project code: " + code + " is invalid.", exception,
           ErrorCode.INVALID_PROJECT_CODE,
           ErrorParameters.of(code, ProjectCode.getPREFIX(), ProjectCode.getLENGTH()));
     }
-
-    var registrationResult = projectDomainService.registerProject(intent, projectCode, projectManager, principalInvestigator, responsiblePerson, funding);
-
-    if (registrationResult.isError() && registrationResult.getError().equals(ResponseCode.PROJECT_REGISTRATION_FAILED)) {
-      throw new ApplicationException("Project registration failed.", ErrorCode.GENERAL, ErrorParameters.of(code));
-    }
-
-    return registrationResult.getValue();
+    return projectDomainService.registerProject(intent, projectCode,
+        projectManager, principalInvestigator, responsiblePerson, funding);
   }
 
   private static ProjectIntent getProjectIntent(String title, String objective) {

project-management/src/main/java/life/qbic/projectmanagement/domain/service/ProjectDomainService.java

@@ -1,17 +1,18 @@
 package life.qbic.projectmanagement.domain.service;
 
-import static life.qbic.logging.service.LoggerFactory.logger;
-
+import life.qbic.application.commons.ApplicationException;
+import life.qbic.application.commons.ApplicationException.ErrorCode;
+import life.qbic.application.commons.ApplicationException.ErrorParameters;
 import life.qbic.application.commons.Result;
 import life.qbic.domain.concepts.DomainEventDispatcher;
-import life.qbic.logging.api.Logger;
 import life.qbic.projectmanagement.domain.model.project.Contact;
 import life.qbic.projectmanagement.domain.model.project.Funding;
 import life.qbic.projectmanagement.domain.model.project.Project;
 import life.qbic.projectmanagement.domain.model.project.ProjectCode;
 import life.qbic.projectmanagement.domain.model.project.ProjectIntent;
 import life.qbic.projectmanagement.domain.model.project.event.ProjectRegisteredEvent;
 import life.qbic.projectmanagement.domain.repository.ProjectRepository;
+import life.qbic.projectmanagement.domain.repository.ProjectRepository.ProjectExistsException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
@@ -26,7 +27,6 @@
 @Service
 public class ProjectDomainService {
 
-  private static final Logger log = logger(ProjectDomainService.class);
   private final ProjectRepository projectRepository;
 
   @Autowired
@@ -47,30 +47,26 @@ public ProjectDomainService(ProjectRepository projectRepository) {
    * @return a {@link Result} of the registration
    * @since 1.0.0
    */
-  public Result<Project, ResponseCode> registerProject(
+  public Project registerProject(
       ProjectIntent projectIntent, ProjectCode projectCode,
       Contact projectManager, Contact principalInvestigator,
       Contact responsiblePerson, Funding funding) {
     var project = Project.create(projectIntent, projectCode,
         projectManager, principalInvestigator,
         responsiblePerson);
     project.setFunding(funding);
-
     try {
       projectRepository.add(project);
-    } catch (Exception e) {
-      log.error("Project with code " + project.getProjectCode() + " registration failed.", e);
-      return Result.fromError(ResponseCode.PROJECT_REGISTRATION_FAILED);
+    } catch (ProjectExistsException projectExistsException) {
+      throw new ApplicationException("Project code is " + projectCode + " already in use.",
+          projectExistsException,
+          ErrorCode.DUPLICATE_PROJECT_CODE, ErrorParameters.of(projectCode.value()));
+    } catch (RuntimeException exception) {
+      throw new ApplicationException("Registration of project with code "
+          + projectCode + " failed.", exception);
     }
-
     // In case of a successful registration, we dispatch the registration event
     DomainEventDispatcher.instance().dispatch(ProjectRegisteredEvent.create(project.getId()));
-
-    return Result.fromValue(project);
+    return project;
   }
-
-  public enum ResponseCode {
-    PROJECT_REGISTRATION_FAILED
-  }
-
 }

project-management/src/test/groovy/life/qbic/projectmanagement/application/ProjectCreationServiceSpec.groovy

@@ -21,7 +21,7 @@ class ProjectCreationServiceSpec extends Specification {
   ProjectRepository projectRepositoryStub = Stub()
   AddExperimentToProjectService addExperimentToProjectServiceStub = Stub()
     ProjectDomainService projectDomainServiceStub = new ProjectDomainService(projectRepositoryStub)
-  ProjectCreationService projectCreationServiceWithStubs = new ProjectCreationService(projectRepositoryStub, projectDomainServiceStub)
+  ProjectCreationService projectCreationServiceWithStubs = new ProjectCreationService(projectDomainServiceStub)
 
   def "invalid project title leads to INVALID_PROJECT_TITLE code"() {
     given: