To release 1.2.5 (#133)

* UXPROD 5001 Support DCB re-requests (#130) UXPROD 5001 Support DCB re-requests * UXPROD-5054 - Support DCB Requests on Unavailable Items (#123) UXPROD-5054 - Support DCB Requests on Unavailable Items * UXPROD 5001 Support DCB re-requests (#131) UXPROD 5001 Support DCB re-requests * Update NEWS.md * [maven-release-plugin] prepare release v1.2.5 * [maven-release-plugin] prepare for next development iteration --------- Co-authored-by: Antony Hruschev <[email protected]>
folio-org · Jan 17, 2025 · 4cd0727 · 4cd0727
1 parent 2e1b69f
commit 4cd0727
Show file tree

Hide file tree

Showing 46 changed files with 588 additions and 87 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+## v1.2.5 2025-01-17
+* MODDCB-142: [DCB Re-Requests] Update transaction API
+* MODDCB-154: Support DCB Requests on Unavailable Items
+
 ## v1.2.4 2024-12-12
 * MODDCB-152: Support for intermediate requests
 

diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -113,7 +113,7 @@
           ],
           "pathPattern": "/transactions/{dcbTransactionId}/status",
           "permissionsRequired": [
-            "dcb.transactions.get"
+            "dcb.transactions.status.get"
           ],
           "modulePermissions": []
         },
@@ -123,7 +123,7 @@
           ],
           "pathPattern": "/transactions/{dcbTransactionId}/status",
           "permissionsRequired": [
-            "dcb.transactions.put"
+            "dcb.transactions.status.put"
           ],
           "modulePermissions": [
             "circulation.check-out-by-barcode.post",
@@ -141,6 +141,30 @@
             "dcb.transactions.collection.get"
           ],
           "modulePermissions": []
+        },
+        {
+          "methods": [
+            "PUT"
+          ],
+          "pathPattern": "/transactions/{dcbTransactionId}",
+          "permissionsRequired": [
+            "dcb.transactions.item.put"
+          ],
+          "modulePermissions": [
+            "inventory-storage.items.item.get",
+            "inventory-storage.items.collection.get",
+            "inventory-storage.holdings.item.get",
+            "circulation.requests.item.post",
+            "circulation.requests.item.put",
+            "circulation-item.item.post",
+            "circulation-item.collection.get",
+            "circulation-item.item.get",
+            "inventory-storage.material-types.collection.get",
+            "inventory-storage.loan-types.collection.get",
+            "circulation-storage.requests.item.get",
+            "circulation-storage.cancellation-reasons.item.get",
+            "circulation-storage.cancellation-reasons.item.post"
+          ]
         }
       ]
     },
@@ -229,10 +253,11 @@
       "description": "All permissions for dcb module",
       "subPermissions": [
         "dcb.transactions.post",
-        "dcb.transactions.put",
-        "dcb.transactions.get",
+        "dcb.transactions.status.put",
+        "dcb.transactions.status.get",
         "dcb.transactions.collection.get",
-        "dcb.ecs-request.transactions.post"
+        "dcb.ecs-request.transactions.post",
+        "dcb.transactions.item.put"
       ]
     },
     {
@@ -241,14 +266,16 @@
       "description": "creates new transaction"
     },
     {
-      "permissionName": "dcb.transactions.get",
+      "permissionName": "dcb.transactions.status.get",
       "displayName": "get transaction details",
-      "description": "get transaction details"
+      "description": "get transaction details",
+      "replaces": ["dcb.transactions.get"]
     },
     {
-      "permissionName": "dcb.transactions.put",
-      "displayName": "update transaction details",
-      "description": "update transaction details"
+      "permissionName": "dcb.transactions.status.put",
+      "displayName": "update transaction status",
+      "description": "update transaction status",
+      "replaces": ["dcb.transactions.put"]
     },
     {
       "permissionName": "dcb.transactions.collection.get",
@@ -259,6 +286,11 @@
       "permissionName": "dcb.ecs-request.transactions.post",
       "displayName": "creates new ECS request transaction",
       "description": "creates new ECS request transaction"
+    },
+    {
+      "permissionName": "dcb.transactions.item.put",
+      "displayName": "update transaction details",
+      "description": "update transaction details"
     }
   ],
   "metadata": {
@@ -328,4 +360,4 @@
       { "name": "ENV", "value": "folio" }
     ]
   }
-}
+}
diff --git a/pom.xml b/pom.xml
@@ -10,7 +10,7 @@
   <groupId>org.folio</groupId>
   <artifactId>mod-dcb</artifactId>
   <name>mod-dcb</name>
-  <version>1.2.5-SNAPSHOT</version>
+  <version>1.2.6-SNAPSHOT</version>
   <description>Manage DCB related transactions in folio</description>
   <packaging>jar</packaging>
 

diff --git a/src/main/java/org/folio/dcb/client/feign/CirculationItemClient.java b/src/main/java/org/folio/dcb/client/feign/CirculationItemClient.java
@@ -19,4 +19,4 @@ public interface CirculationItemClient {
   CirculationItem retrieveCirculationItemById(@PathVariable("circulationItemId") String circulationItemId);
 
   @GetMapping
-  CirculationItemCollection fetchItemByIdAndBarcode(@RequestParam("query") String query);}
+  CirculationItemCollection fetchItemByCqlQuery(@RequestParam("query") String query);}
diff --git a/src/main/java/org/folio/dcb/controller/TransactionApiController.java b/src/main/java/org/folio/dcb/controller/TransactionApiController.java
@@ -3,6 +3,7 @@
 import lombok.AllArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 import org.folio.dcb.domain.dto.DcbTransaction;
+import org.folio.dcb.domain.dto.DcbUpdateTransaction;
 import org.folio.dcb.domain.dto.TransactionStatus;
 import org.folio.dcb.domain.dto.TransactionStatusResponseCollection;
 import org.folio.dcb.rest.resource.TransactionsApi;
@@ -74,4 +75,11 @@ public ResponseEntity<TransactionStatusResponseCollection> getTransactionStatusL
       .body(transactionsService.getTransactionStatusList(fromDate, toDate, pageNumber, pageSize));
   }
 
+  @Override
+  public ResponseEntity<Void> updateTransactionDetails(String dcbTransactionId, DcbUpdateTransaction dcbUpdateTransaction) {
+    transactionsService.updateTransactionDetails(dcbTransactionId, dcbUpdateTransaction);
+    return ResponseEntity.status(HttpStatus.NO_CONTENT)
+      .build();
+  }
+
 }
diff --git a/src/main/java/org/folio/dcb/domain/mapper/TransactionMapper.java b/src/main/java/org/folio/dcb/domain/mapper/TransactionMapper.java
@@ -3,6 +3,7 @@
 import org.folio.dcb.domain.dto.DcbItem;
 import org.folio.dcb.domain.dto.DcbPatron;
 import org.folio.dcb.domain.dto.DcbPickup;
+import org.folio.dcb.domain.dto.DcbUpdateItem;
 import org.folio.dcb.domain.dto.TransactionStatusResponseList;
 import org.folio.dcb.domain.entity.TransactionAuditEntity;
 import org.folio.dcb.domain.entity.TransactionEntity;
@@ -91,4 +92,14 @@ public DcbPickup mapTransactionEntityToDcbPickup(TransactionEntity transactionEn
       .build();
   }
 
+  public DcbItem convertTransactionUpdateItemToDcbItem(DcbUpdateItem dcbUpdateItem, TransactionEntity entity) {
+    return DcbItem
+      .builder()
+      .lendingLibraryCode(dcbUpdateItem.getLendingLibraryCode())
+      .barcode(dcbUpdateItem.getBarcode())
+      .materialType(dcbUpdateItem.getMaterialType())
+      .title(entity.getItemTitle())
+      .build();
+  }
+
 }
diff --git a/src/main/java/org/folio/dcb/listener/kafka/CirculationEventListener.java b/src/main/java/org/folio/dcb/listener/kafka/CirculationEventListener.java
@@ -78,14 +78,14 @@ public void handleRequestEvent(String data, MessageHeaders messageHeaders) {
           systemUserScopedExecutionService.executeAsyncSystemUserScoped(tenantId, () ->
             transactionRepository.findTransactionByRequestIdAndStatusNotInClosed(UUID.fromString(requestId))
               .ifPresent(transactionEntity -> {
-                if (eventData.getType() == EventData.EventType.CANCEL) {
+                if (eventData.getType() == EventData.EventType.CANCEL && !eventData.isDcbReRequestCancellation()) {
                   baseLibraryService.cancelTransactionEntity(transactionEntity);
                 } else if (eventData.getType() == EventData.EventType.IN_TRANSIT && transactionEntity.getRole() == LENDER) {
                   baseLibraryService.updateTransactionEntity(transactionEntity, TransactionStatus.StatusEnum.OPEN);
                 } else if (eventData.getType() == EventData.EventType.AWAITING_PICKUP && (transactionEntity.getRole() == BORROWING_PICKUP || transactionEntity.getRole() == PICKUP)) {
                   baseLibraryService.updateTransactionEntity(transactionEntity, TransactionStatus.StatusEnum.AWAITING_PICKUP);
                 } else {
-                  log.info("handleRequestEvent:: status for event {} can not be updated", eventData.getType());
+                  log.info("handleRequestEvent:: status for event {} can not be updated", eventData);
                 }
               })
           );

diff --git a/src/main/java/org/folio/dcb/listener/kafka/EventData.java b/src/main/java/org/folio/dcb/listener/kafka/EventData.java
@@ -8,6 +8,7 @@ public class EventData {
   private String itemId;
   private String requestId;
   private boolean isDcb;
+  private boolean isDcbReRequestCancellation;
 
   public enum EventType {
     CHECK_IN, CHECK_OUT, IN_TRANSIT, AWAITING_PICKUP, CANCEL

diff --git a/src/main/java/org/folio/dcb/repository/TransactionRepository.java b/src/main/java/org/folio/dcb/repository/TransactionRepository.java
@@ -12,7 +12,7 @@
 
 @Repository
 public interface TransactionRepository extends JpaRepository<TransactionEntity, String> {
-  @Query(value = "SELECT * FROM transactions where item_id = :itemId AND status not in ('CLOSED', 'CANCELLED', 'ERROR')", nativeQuery = true)
+  @Query(value = "SELECT * FROM transactions where item_id = :itemId AND status not in ('CLOSED', 'CANCELLED', 'ERROR', 'CREATED', 'OPEN')", nativeQuery = true)
   Optional<TransactionEntity> findTransactionByItemIdAndStatusNotInClosed(@Param("itemId") UUID itemId);
 
   @Query(value = "SELECT * FROM transactions where item_id = :itemId AND status not in ('CLOSED', 'CANCELLED', 'ERROR')", nativeQuery = true)

diff --git a/src/main/java/org/folio/dcb/service/CirculationService.java b/src/main/java/org/folio/dcb/service/CirculationService.java
@@ -17,5 +17,17 @@ public interface CirculationService {
    */
   void checkOutByBarcode(TransactionEntity dcbTransaction);
 
-  void cancelRequest(TransactionEntity dcbTransaction);
+  /**
+   * Cancels a transaction request based on the provided transaction details.
+   * <p>
+   * If {@code isItemUnavailableCancellation} is {@code true}, the notification for this
+   * cancellation will be suppressed by setting the {@code suppressNotification} flag
+   * to {@code true}.
+   * </p>
+   *
+   * @param dcbTransaction the transaction entity representing the request to be canceled
+   * @param isItemUnavailableCancellation a flag indicating whether the cancellation is due to item unavailability
+   *                                       (true if the item is unavailable, false otherwise)
+   */
+  void cancelRequest(TransactionEntity dcbTransaction, boolean isItemUnavailableCancellation);
 }
diff --git a/src/main/java/org/folio/dcb/service/RequestService.java b/src/main/java/org/folio/dcb/service/RequestService.java
@@ -6,11 +6,11 @@
 
 public interface RequestService {
   /**
-   * Create page item request
+   * Create request based on status of the item
    * @param user - userEntity
    * @param dcbItem - dcbItemEntity
    */
-  CirculationRequest createPageItemRequest(User user, DcbItem dcbItem, String pickupServicePointId);
+  CirculationRequest createRequestBasedOnItemStatus(User user, DcbItem dcbItem, String pickupServicePointId);
   CirculationRequest createHoldItemRequest(User user, DcbItem dcbItem, String pickupServicePointId);
   void updateCirculationRequest(CirculationRequest circulationRequest);
 }
diff --git a/src/main/java/org/folio/dcb/service/TransactionsService.java b/src/main/java/org/folio/dcb/service/TransactionsService.java
@@ -1,6 +1,7 @@
 package org.folio.dcb.service;
 
 import org.folio.dcb.domain.dto.DcbTransaction;
+import org.folio.dcb.domain.dto.DcbUpdateTransaction;
 import org.folio.dcb.domain.dto.TransactionStatus;
 import org.folio.dcb.domain.dto.TransactionStatusResponse;
 import org.folio.dcb.domain.dto.TransactionStatusResponseCollection;
@@ -17,5 +18,6 @@ public interface TransactionsService {
   TransactionStatusResponse updateTransactionStatus(String dcbTransactionId, TransactionStatus transactionStatus);
   TransactionStatusResponse getTransactionStatusById(String dcbTransactionId);
   TransactionStatusResponseCollection getTransactionStatusList(OffsetDateTime fromDate, OffsetDateTime toDate, Integer pageNumber, Integer pageSize);
+  void updateTransactionDetails(String dcbTransactionId, DcbUpdateTransaction dcbUpdateTransaction);
 
   }
diff --git a/src/main/java/org/folio/dcb/service/impl/BaseLibraryService.java b/src/main/java/org/folio/dcb/service/impl/BaseLibraryService.java
@@ -5,7 +5,10 @@
 import org.apache.commons.lang3.ObjectUtils;
 import org.folio.dcb.domain.dto.CirculationItem;
 import org.folio.dcb.domain.dto.CirculationRequest;
+import org.folio.dcb.domain.dto.DcbItem;
+import org.folio.dcb.domain.dto.DcbPatron;
 import org.folio.dcb.domain.dto.DcbTransaction;
+import org.folio.dcb.domain.dto.DcbUpdateItem;
 import org.folio.dcb.domain.dto.TransactionStatus;
 import org.folio.dcb.domain.dto.TransactionStatusResponse;
 import org.folio.dcb.domain.entity.TransactionEntity;
@@ -54,6 +57,7 @@ public TransactionStatusResponse createBorrowingLibraryTransaction(String dcbTra
     }
     checkItemExistsInInventoryAndThrow(itemVirtual.getBarcode());
     CirculationItem item = circulationItemService.checkIfItemExistsAndCreate(itemVirtual, pickupServicePointId);
+    dcbTransaction.getItem().setId(item.getId());
     checkOpenTransactionExistsAndThrow(item.getId());
     CirculationRequest holdRequest = requestService.createHoldItemRequest(user, itemVirtual, pickupServicePointId);
     saveDcbTransaction(dcbTransactionId, dcbTransaction, holdRequest.getId());
@@ -106,8 +110,10 @@ public void updateTransactionStatus(TransactionEntity dcbTransaction, Transactio
 
   public void cancelTransactionRequest(TransactionEntity transactionEntity){
     try {
-      circulationService.cancelRequest(transactionEntity);
+      circulationService.cancelRequest(transactionEntity, false);
     } catch (CirculationRequestException e) {
+      log.error("cancelTransactionRequest:: error during updating circulation request " +
+        "to cancel status", e);
       updateTransactionEntity(transactionEntity, TransactionStatus.StatusEnum.ERROR);
     }
   }
@@ -133,4 +139,28 @@ public void updateTransactionEntity(TransactionEntity transactionEntity, Transac
     transactionEntity.setStatus(transactionStatusEnum);
     transactionRepository.save(transactionEntity);
   }
+
+  public void updateTransactionDetails(TransactionEntity transactionEntity, DcbUpdateItem dcbUpdateItem) {
+    DcbPatron dcbPatron = transactionMapper.mapTransactionEntityToDcbPatron(transactionEntity);
+    DcbItem dcbItem = transactionMapper.convertTransactionUpdateItemToDcbItem(dcbUpdateItem, transactionEntity);
+    checkItemExistsInInventoryAndThrow(dcbItem.getBarcode());
+    CirculationItem item = circulationItemService.checkIfItemExistsAndCreate(dcbItem, transactionEntity.getServicePointId());
+    dcbItem.setId(item.getId());
+    checkOpenTransactionExistsAndThrow(item.getId());
+    circulationService.cancelRequest(transactionEntity, true);
+    CirculationRequest holdRequest = requestService.createHoldItemRequest(userService.fetchUser(dcbPatron), dcbItem,
+      transactionEntity.getServicePointId());
+    updateItemDetailsAndSaveEntity(transactionEntity, item, dcbItem.getMaterialType(), holdRequest.getId());
+  }
+
+  private void updateItemDetailsAndSaveEntity(TransactionEntity transactionEntity, CirculationItem item,
+                                              String materialType, String requestId) {
+    transactionEntity.setItemId(item.getId());
+    transactionEntity.setRequestId(UUID.fromString(requestId));
+    transactionEntity.setItemBarcode(item.getBarcode());
+    transactionEntity.setLendingLibraryCode(item.getLendingLibraryCode());
+    transactionEntity.setMaterialType(materialType);
+    transactionEntity.setStatus(CREATED);
+    transactionRepository.save(transactionEntity);
+  }
 }
diff --git a/src/main/java/org/folio/dcb/service/impl/CirculationItemServiceImpl.java b/src/main/java/org/folio/dcb/service/impl/CirculationItemServiceImpl.java
@@ -9,9 +9,11 @@
 import org.folio.dcb.domain.dto.ItemStatus;
 import org.folio.dcb.service.CirculationItemService;
 import org.folio.dcb.service.ItemService;
+import org.folio.util.StringUtil;
 import org.springframework.stereotype.Service;
 
 import java.util.Objects;
+import java.util.UUID;
 
 import static org.folio.dcb.domain.dto.ItemStatus.NameEnum.IN_TRANSIT;
 import static org.folio.dcb.utils.DCBConstants.HOLDING_ID;
@@ -29,18 +31,18 @@ public class CirculationItemServiceImpl implements CirculationItemService {
 
   @Override
   public CirculationItem checkIfItemExistsAndCreate(DcbItem dcbItem, String pickupServicePointId) {
-    var dcbItemId = dcbItem.getId();
-    log.debug("checkIfItemExistsAndCreate:: generate Circulation item by DcbItem with id={} if nit doesn't exist.", dcbItemId);
-    var circulationItem = fetchCirculationItemByIdAndBarcode(dcbItemId, dcbItem.getBarcode());
+    var dcbItemBarcode = dcbItem.getBarcode();
+    log.debug("checkIfItemExistsAndCreate:: generate Circulation item with barcode {} if it doesn't exist.", dcbItemBarcode);
+    var circulationItem = fetchCirculationItemByBarcode(dcbItem.getBarcode());
     if(Objects.isNull(circulationItem)) {
-      log.warn("Circulation item not found by id={}. Creating it.", dcbItemId);
+      log.warn("checkIfItemExistsAndCreate:: Circulation item not found by barcode={}. Creating it.", dcbItemBarcode);
       circulationItem = createCirculationItem(dcbItem, pickupServicePointId);
     }
     return circulationItem;
   }
 
-  private CirculationItem fetchCirculationItemByIdAndBarcode(String id, String barcode) {
-    return circulationItemClient.fetchItemByIdAndBarcode("id==" + id + " and barcode==" + barcode)
+  private CirculationItem fetchCirculationItemByBarcode(String barcode) {
+    return circulationItemClient.fetchItemByCqlQuery("barcode==" + StringUtil.cqlEncode(barcode))
       .getItems()
       .stream()
       .findFirst()
@@ -56,10 +58,10 @@ private CirculationItem createCirculationItem(DcbItem item, String pickupService
     //SetupDefaultMaterialTypeIfNotGiven
     String materialType = StringUtils.isBlank(item.getMaterialType()) ? MATERIAL_TYPE_NAME_BOOK : item.getMaterialType();
     var materialTypeId = itemService.fetchItemMaterialTypeIdByMaterialTypeName(materialType);
-
+    var itemId = UUID.randomUUID().toString();
     CirculationItem circulationItem =
       CirculationItem.builder()
-        .id(item.getId())
+        .id(itemId)
         .barcode(item.getBarcode())
         .status(ItemStatus.builder()
           .name(IN_TRANSIT)
@@ -72,6 +74,6 @@ private CirculationItem createCirculationItem(DcbItem item, String pickupService
         .lendingLibraryCode(item.getLendingLibraryCode())
         .build();
 
-    return circulationItemClient.createCirculationItem(item.getId(), circulationItem);
+    return circulationItemClient.createCirculationItem(itemId, circulationItem);
   }
 }
diff --git a/src/main/java/org/folio/dcb/service/impl/CirculationServiceImpl.java b/src/main/java/org/folio/dcb/service/impl/CirculationServiceImpl.java
@@ -41,11 +41,14 @@ public void checkOutByBarcode(TransactionEntity dcbTransaction) {
   }
 
   @Override
-  public void cancelRequest(TransactionEntity dcbTransaction) {
+  public void cancelRequest(TransactionEntity dcbTransaction, boolean isItemUnavailableCancellation) {
     log.debug("cancelRequest:: cancelling request using request id {} ", dcbTransaction.getRequestId());
     CirculationRequest request = circulationStorageService.getCancellationRequestIfOpenOrNull(dcbTransaction.getRequestId().toString());
     if (request != null){
       try {
+        if (isItemUnavailableCancellation) {
+          request.setIsDcbReRequestCancellation(true);
+        }
         circulationClient.updateRequest(request.getId(), request);
       } catch (FeignException e) {
         log.warn("cancelRequest:: error cancelling request using request id {} ", dcbTransaction.getRequestId(), e);

diff --git a/src/main/java/org/folio/dcb/service/impl/LendingLibraryServiceImpl.java b/src/main/java/org/folio/dcb/service/impl/LendingLibraryServiceImpl.java
@@ -47,7 +47,7 @@ public TransactionStatusResponse createCirculation(String dcbTransactionId, DcbT
     baseLibraryService.checkUserTypeAndThrowIfMismatch(user.getType());
     ServicePointRequest pickupServicePoint = servicePointService.createServicePointIfNotExists(dcbTransaction.getPickup());
     dcbTransaction.getPickup().setServicePointId(pickupServicePoint.getId());
-    CirculationRequest pageRequest = requestService.createPageItemRequest(user, item, pickupServicePoint.getId());
+    CirculationRequest pageRequest = requestService.createRequestBasedOnItemStatus(user, item, pickupServicePoint.getId());
     baseLibraryService.saveDcbTransaction(dcbTransactionId, dcbTransaction, pageRequest.getId());
 
     return TransactionStatusResponse.builder()