Enable request IDs for service API (#1040)

* Provide request ID

* Check valid response construction

* better method

* update to null

---------

Co-authored-by: KochTobi <[email protected]>

Author: sven1103

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

@@ -1,5 +1,9 @@
 package life.qbic.projectmanagement.application.api;
 
+import static java.util.Objects.nonNull;
+
+import java.util.Optional;
+import java.util.UUID;
 import reactor.core.publisher.Mono;
 
 /**
@@ -62,6 +66,24 @@ sealed interface UpdateResponseBody permits ProjectDesign {
 
   }
 
+  /**
+   * Cacheable requests provide a unique identifier so cache implementations can unambiguously
+   * manage the requests.
+   *
+   * @since 1.9.0
+   */
+  sealed interface CacheableRequest permits ProjectUpdateRequest {
+
+    /**
+     * Returns an ID that is unique to the request.
+     *
+     * @return the id
+     * @since 1.9.0
+     */
+    String requestId();
+
+  }
+
   /**
    * Container for passing information in an {@link UpdateRequestBody} or
    * {@link UpdateResponseBody}.
@@ -82,8 +104,17 @@ record ProjectDesign(String title, String objective) implements UpdateRequestBod
    * @param requestBody the information to be updated.
    * @since 1.9.0
    */
-  record ProjectUpdateRequest(String projectId, UpdateRequestBody requestBody) {
+  record ProjectUpdateRequest(String projectId, UpdateRequestBody requestBody, String id) implements
+      CacheableRequest {
 
+    public ProjectUpdateRequest(String projectId, UpdateRequestBody requestBody) {
+      this(projectId, requestBody, UUID.randomUUID().toString());
+    }
+
+    @Override
+    public String requestId() {
+      return id;
+    }
   }
 
   /**
@@ -93,8 +124,43 @@ record ProjectUpdateRequest(String projectId, UpdateRequestBody requestBody) {
    * @param responseBody the information that was updated.
    * @since 1.9.0
    */
-  record ProjectUpdateResponse(String projectId, UpdateResponseBody responseBody) {
+  record ProjectUpdateResponse(String projectId, UpdateResponseBody responseBody, String requestId) {
+
+    public ProjectUpdateResponse {
+      if (projectId == null) {
+        throw new IllegalArgumentException("Project ID cannot be null");
+      }
+      if (projectId.isBlank()) {
+        throw new IllegalArgumentException("Project ID cannot be blank");
+      }
+      if (requestId != null && requestId.isBlank()) {
+        requestId = null;
+      }
+    }
 
+    /**
+     * Retrieves the request id associated with this response. May be {@link Optional#empty()} but
+     * never null.
+     *
+     * @return an Optional with the requestId; {@link Optional#empty()} otherwise.
+     */
+    public Optional<String> retrieveRequestId() {
+      return Optional.ofNullable(requestId);
+    }
+
+    /**
+     * Returns the requestId, can be null.
+     *
+     * @return Returns the requestId, if no requestId is set, returns null.
+     */
+    @Override
+    public String requestId() {
+      return requestId;
+    }
+
+    boolean hasRequestId() {
+      return nonNull(requestId);
+    }
   }
 
   /**

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

@@ -40,7 +40,7 @@ public Mono<ProjectUpdateResponse> update(@NonNull ProjectUpdateRequest request)
       case ProjectDesign design:
         return
             withSecurityContext(SecurityContextHolder.getContext(),
-                () -> updateProjectDesign(projectId, design)).subscribeOn(scheduler);
+                () -> updateProjectDesign(projectId, design, request.requestId())).subscribeOn(scheduler);
       default:
         return Mono.error(new UnknownRequestException("Invalid request body"));
     }
@@ -59,13 +59,13 @@ private Mono<ProjectUpdateResponse> withSecurityContext(SecurityContext sctx,
     }).contextWrite(rcontext);
   }
 
-  private Mono<ProjectUpdateResponse> updateProjectDesign(String projectId, ProjectDesign design) {
+  private Mono<ProjectUpdateResponse> updateProjectDesign(String projectId, ProjectDesign design, String requestId) {
     return Mono.create(sink -> {
       try {
         var id = ProjectId.parse(projectId);
         projectService.updateTitle(id, design.title());
         projectService.updateObjective(id, design.objective());
-        sink.success(new ProjectUpdateResponse(projectId, design));
+        sink.success(new ProjectUpdateResponse(projectId, design, requestId));
       } catch (IllegalArgumentException e) {
         sink.error(new RequestFailedException("Invalid project id: " + projectId));
       } catch (org.springframework.security.access.AccessDeniedException e) {