CIRC-2142: Merge ECS TLR feature branch into master

descriptors/ModuleDescriptor-template.json

@@ -167,6 +167,22 @@
         }
       ]
     },
+    {
+      "id": "instance-items",
+      "version": "0.1",
+      "handlers": [
+        {
+          "methods": ["GET"],
+          "pathPattern": "/circulation/items-by-instance",
+          "permissionsRequired": [
+            "circulation.items-by-instance.get"
+          ],
+          "modulePermissions": [
+            "search.instances.collection.get"
+          ]
+        }
+      ]
+    },
     {
       "id": "add-info",
       "version": "0.1",
@@ -649,7 +665,7 @@
     },
     {
       "id": "allowed-service-points",
-      "version": "1.0",
+      "version": "1.2",
       "handlers": [
         {
           "methods": [
@@ -677,7 +693,10 @@
             "inventory-storage.instances.item.get",
             "inventory-storage.instances.collection.get",
             "configuration.entries.item.get",
-            "configuration.entries.collection.get"
+            "configuration.entries.collection.get",
+            "mod-settings.entries.item.get",
+            "mod-settings.entries.collection.get",
+            "mod-settings.global.read.circulation"
           ]
         }
       ]
@@ -1604,6 +1623,11 @@
       "displayName": "circulation settings - Read configuration",
       "description": "To read the configuration from mod settings."
     },
+    {
+      "permissionName": "circulation.items-by-instance.get",
+      "displayName": "circulation - get items by instance",
+      "description": "get items by instance"
+    },
     {
       "permissionName": "circulation.settings.collection.get",
       "displayName": "circulation - get circulation settings",
@@ -1670,7 +1694,8 @@
         "circulation.requests.allowed-service-points.get",
         "circulation.inventory.items-in-transit-report.get",
         "circulation.pick-slips.get",
-        "circulation.search-slips.get"
+        "circulation.search-slips.get",
+        "circulation.items-by-instance.get"
       ]
     },
     {
@@ -1776,6 +1801,10 @@
         "configuration.entries.collection.get",
         "calendar.endpoint.calendars.surroundingOpenings.get",
         "calendar.endpoint.calendars.allOpenings.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation",
+        "calendar.endpoint.dates.get",
         "pubsub.publish.post",
         "circulation-storage.loans-history.collection.get"
       ],
@@ -1829,7 +1858,8 @@
         "checkout-lock-storage.checkout-locks.item.delete",
         "mod-settings.entries.collection.get",
         "mod-settings.entries.item.get",
-        "mod-settings.global.read.mod-circulation"
+        "mod-settings.global.read.mod-circulation",
+        "mod-settings.global.read.circulation"
       ],
       "visible": false
     },
@@ -1891,7 +1921,10 @@
         "actual-cost-fee-fine-cancel.post",
         "departments.item.get",
         "departments.collection.get",
-        "circulation-storage.loans-history.collection.get"
+        "circulation-storage.loans-history.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation"
       ],
       "visible": false
     },
@@ -1924,6 +1957,9 @@
         "calendar.endpoint.calendars.surroundingOpenings.get",
         "calendar.endpoint.calendars.allOpenings.get",
         "configuration.entries.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation",
         "scheduled-notice-storage.scheduled-notices.collection.delete",
         "scheduled-notice-storage.scheduled-notices.item.post",
         "patron-notice.post",
@@ -2109,6 +2145,9 @@
         "scheduled-notice-storage.scheduled-notices.collection.delete",
         "scheduled-notice-storage.scheduled-notices.item.post",
         "configuration.entries.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation",
         "manualblocks.collection.get",
         "pubsub.publish.post",
         "automated-patron-blocks.collection.get",
@@ -2190,6 +2229,9 @@
         "proxiesfor.collection.get",
         "patron-notice.post",
         "configuration.entries.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation",
         "scheduled-notice-storage.scheduled-notices.collection.delete",
         "scheduled-notice-storage.scheduled-notices.item.post",
         "pubsub.publish.post",
@@ -2233,7 +2275,10 @@
         "addresstypes.collection.get",
         "usergroups.collection.get",
         "usergroups.item.get",
-        "pubsub.publish.post"
+        "pubsub.publish.post",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation"
       ],
       "visible": false
     },
@@ -2269,6 +2314,9 @@
         "calendar.endpoint.calendars.surroundingOpenings.get",
         "calendar.endpoint.calendars.allOpenings.get",
         "configuration.entries.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation",
         "scheduled-notice-storage.scheduled-notices.collection.delete",
         "scheduled-notice-storage.scheduled-notices.item.post",
         "manualblocks.collection.get",
@@ -2326,7 +2374,10 @@
         "addresstypes.collection.get",
         "pubsub.publish.post",
         "patron-notice.post",
-        "circulation-storage.loans-history.collection.get"
+        "circulation-storage.loans-history.collection.get",
+        "mod-settings.entries.item.get",
+        "mod-settings.entries.collection.get",
+        "mod-settings.global.read.circulation"
       ],
       "visible": false
     },

ramls/circulation.raml

@@ -337,6 +337,14 @@ resourceTypes:
               description: "Instance ID"
               pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
               required: false
+            useStubItem:
+              description: "When true, allows to apply circulation rules based on patron group only"
+              type: boolean
+              required: false
+            ecsRequestRouting:
+              description: "When true, returns only service points with ecsRequestRouting"
+              type: boolean
+              required: false
         responses:
           200:
             description: "List of allowed service points was retrieved successfully"

src/main/java/org/folio/circulation/CirculationVerticle.java

@@ -21,6 +21,7 @@
 import org.folio.circulation.resources.FeeFineNotRealTimeScheduledNoticeProcessingResource;
 import org.folio.circulation.resources.FeeFineScheduledNoticeProcessingResource;
 import org.folio.circulation.resources.HealthResource;
+import org.folio.circulation.resources.ItemsByInstanceResource;
 import org.folio.circulation.resources.ItemsInTransitResource;
 import org.folio.circulation.resources.LoanAnonymizationResource;
 import org.folio.circulation.resources.LoanCirculationRulesEngineResource;
@@ -94,6 +95,7 @@ public void start(Promise<Void> startFuture) {
     new RequestCollectionResource(client).register(router);
     new RequestQueueResource(client).register(router);
     new RequestByInstanceIdResource(client).register(router);
+    new ItemsByInstanceResource(client).register(router);
 
     new RequestHoldShelfClearanceResource(
       "/circulation/requests-reports/hold-shelf-clearance/:servicePointId", client)

src/main/java/org/folio/circulation/domain/AllowedServicePointsRequest.java

@@ -17,8 +17,12 @@ public class AllowedServicePointsRequest {
 
   private Request.Operation operation;
   private String requesterId;
+  private String patronGroupId;
   private String instanceId;
   private String itemId;
+  private String requestId;
+  private boolean useStubItem;
+  private boolean ecsRequestRouting;
 
   public boolean isForTitleLevelRequest() {
     return instanceId != null;
@@ -27,7 +31,6 @@ public boolean isForTitleLevelRequest() {
   public boolean isForItemLevelRequest() {
     return itemId != null;
   }
-  private String requestId;
 
   public AllowedServicePointsRequest updateWithRequestInformation(Request request) {
     log.debug("updateWithRequestInformation:: parameters request: {}", request);

src/main/java/org/folio/circulation/domain/CreateRequestService.java

@@ -227,6 +227,11 @@ private CompletableFuture<Result<RequestAndRelatedRecords>> checkPolicy(
     boolean tlrFeatureEnabled = request.getTlrSettingsConfiguration().isTitleLevelRequestsFeatureEnabled();
 
     if (tlrFeatureEnabled && request.isTitleLevel() && request.isHold()) {
+      if (request.getEcsRequestPhase() == EcsRequestPhase.PRIMARY) {
+        log.warn("checkPolicy:: ECS TLR primary Hold detected, skipping policy check");
+        return ofAsync(() -> records);
+      }
+
       log.info("checkPolicy:: checking policy for title-level hold");
       return completedFuture(checkPolicyForTitleLevelHold(records));
     }

src/main/java/org/folio/circulation/domain/EcsRequestPhase.java

@@ -0,0 +1,37 @@
+package org.folio.circulation.domain;
+
+import static org.apache.commons.lang3.StringUtils.equalsIgnoreCase;
+
+import java.util.Arrays;
+
+public enum EcsRequestPhase {
+  NONE(""),
+  PRIMARY("Primary"),
+  SECONDARY("Secondary");
+
+  public final String value;
+
+  public static EcsRequestPhase from(String value) {
+    return Arrays.stream(values())
+      .filter(status -> status.nameMatches(value))
+      .findFirst()
+      .orElse(NONE);
+  }
+
+  EcsRequestPhase(String value) {
+    this.value = value;
+  }
+
+  public String getValue() {
+    return value;
+  }
+
+  public boolean nameMatches(String value) {
+    return equalsIgnoreCase(getValue(), value);
+  }
+
+  @Override
+  public String toString() {
+    return value;
+  }
+}

src/main/java/org/folio/circulation/domain/Item.java

@@ -447,6 +447,17 @@ public String getDcbItemTitle() {
     return getProperty(itemRepresentation, "instanceTitle");
   }
 
+  public String getTenantId() {
+    return getProperty(itemRepresentation, "tenantId");
+  }
+
+  public Item changeTenantId(String tenantId) {
+    if (itemRepresentation != null) {
+      write(itemRepresentation, "tenantId", tenantId);
+    }
+    return this;
+  }
+
   public boolean isAtLocation(String locationCode) {
     return locationCode != null && getLocation() != null && (
       locationCode.equals(getLocation().getCode()) ||

src/main/java/org/folio/circulation/domain/MoveRequestService.java

@@ -10,6 +10,7 @@
 import org.apache.logging.log4j.Logger;
 import org.folio.circulation.domain.validation.RequestLoanValidator;
 import org.folio.circulation.infrastructure.storage.ConfigurationRepository;
+import org.folio.circulation.infrastructure.storage.SettingsRepository;
 import org.folio.circulation.infrastructure.storage.requests.RequestPolicyRepository;
 import org.folio.circulation.infrastructure.storage.requests.RequestQueueRepository;
 import org.folio.circulation.infrastructure.storage.requests.RequestRepository;
@@ -27,13 +28,14 @@ public class MoveRequestService {
   private final ConfigurationRepository configurationRepository;
   private final EventPublisher eventPublisher;
   private final RequestQueueRepository requestQueueRepository;
+  private final SettingsRepository settingsRepository;
   private static final Logger log = LogManager.getLogger(MethodHandles.lookup().lookupClass());
 
   public MoveRequestService(RequestRepository requestRepository, RequestPolicyRepository requestPolicyRepository,
     UpdateUponRequest updateUponRequest, MoveRequestProcessAdapter moveRequestHelper,
     RequestLoanValidator requestLoanValidator, RequestNoticeSender requestNoticeSender,
     ConfigurationRepository configurationRepository, EventPublisher eventPublisher,
-    RequestQueueRepository requestQueueRepository) {
+    RequestQueueRepository requestQueueRepository, SettingsRepository settingsRepository) {
 
     this.requestRepository = requestRepository;
     this.requestPolicyRepository = requestPolicyRepository;
@@ -44,11 +46,12 @@ public MoveRequestService(RequestRepository requestRepository, RequestPolicyRepo
     this.configurationRepository = configurationRepository;
     this.eventPublisher = eventPublisher;
     this.requestQueueRepository = requestQueueRepository;
+    this.settingsRepository = settingsRepository;
   }
 
   public CompletableFuture<Result<RequestAndRelatedRecords>> moveRequest(
       RequestAndRelatedRecords requestAndRelatedRecords, Request originalRequest) {
-    return configurationRepository.lookupTlrSettings()
+    return settingsRepository.lookupTlrSettings()
       .thenApply(r -> r.map(requestAndRelatedRecords::withTlrSettings))
       .thenApply(r -> r.next(RequestServiceUtility::refuseTlrProcessingWhenFeatureIsDisabled))
       .thenApply(r -> r.next(records -> RequestServiceUtility.refuseMovingToOrFromHoldTlr(records,

src/main/java/org/folio/circulation/domain/Request.java

@@ -18,6 +18,7 @@
 import static org.folio.circulation.domain.representations.RequestProperties.CANCELLATION_REASON_NAME;
 import static org.folio.circulation.domain.representations.RequestProperties.CANCELLATION_REASON_PUBLIC_DESCRIPTION;
 import static org.folio.circulation.domain.representations.RequestProperties.ITEM_LOCATION_CODE;
+import static org.folio.circulation.domain.representations.RequestProperties.ECS_REQUEST_PHASE;
 import static org.folio.circulation.domain.representations.RequestProperties.HOLDINGS_RECORD_ID;
 import static org.folio.circulation.domain.representations.RequestProperties.HOLD_SHELF_EXPIRATION_DATE;
 import static org.folio.circulation.domain.representations.RequestProperties.INSTANCE_ID;
@@ -269,6 +270,10 @@ public RequestType getRequestType() {
     return RequestType.from(getProperty(requestRepresentation, REQUEST_TYPE));
   }
 
+  public EcsRequestPhase getEcsRequestPhase() {
+    return EcsRequestPhase.from(getProperty(requestRepresentation, ECS_REQUEST_PHASE));
+  }
+
   boolean allowedForItem() {
     return RequestTypeItemStatusWhiteList.canCreateRequestForItem(getItem().getStatus(), getRequestType());
   }

src/main/java/org/folio/circulation/domain/SearchInstance.java

@@ -0,0 +1,50 @@
+package org.folio.circulation.domain;
+
+import static org.folio.circulation.support.json.JsonObjectArrayPropertyFetcher.mapToList;
+import static org.folio.circulation.support.json.JsonPropertyWriter.write;
+
+import java.lang.invoke.MethodHandles;
+import java.util.Collection;
+import java.util.List;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.folio.circulation.domain.representations.ItemSummaryRepresentation;
+import org.folio.circulation.storage.mappers.ItemMapper;
+
+import io.vertx.core.json.JsonArray;
+import io.vertx.core.json.JsonObject;
+import lombok.NonNull;
+import lombok.ToString;
+import lombok.Value;
+
+@Value
+@ToString(onlyExplicitlyIncluded = true)
+public class SearchInstance {
+
+  private static final Logger log = LogManager.getLogger(MethodHandles.lookup().lookupClass());
+  JsonObject representation;
+  String id;
+  @NonNull Collection<Item> items;
+
+  public static SearchInstance from(JsonObject representation) {
+    return new SearchInstance(representation, representation.getString("id"), mapItems(representation));
+  }
+
+  private static List<Item> mapItems(JsonObject representation) {
+    return mapToList(representation, "items", new ItemMapper()::toDomain);
+  }
+
+  public SearchInstance changeItems(Collection<Item> items) {
+    JsonArray itemsArray = new JsonArray();
+    for (Item item : items) {
+      itemsArray.add(new ItemSummaryRepresentation().createItemSummary(item));
+    }
+    write(representation, "items", itemsArray);
+    return new SearchInstance(representation, id, items);
+  }
+
+  public JsonObject toJson() {
+    return representation;
+  }
+}

src/main/java/org/folio/circulation/domain/representations/ItemSummaryRepresentation.java

@@ -46,6 +46,7 @@ public JsonObject createItemSummary(Item item) {
     write(itemSummary, "copyNumber", item.getCopyNumber());
     write(itemSummary, CALL_NUMBER_COMPONENTS,
       createCallNumberComponents(item.getCallNumberComponents()));
+    write(itemSummary, "tenantId", item.getTenantId());
 
     JsonObject status = new JsonObject()
       .put("name", item.getStatus().getValue());