[MODORDERS-1321]. Add 'Suppress from discovery' toggle for instance interaction (#1140)

BKadirkhodjaev · web-flow · commit 05fb292335a3 · 2025-07-02T15:10:52.000+05:00
* [MODORDERS-1321]. Add 'Suppress from discovery' toggle for instance interaction

* [MODORDERS-1321]. Update acq-models
diff --git a/descriptors/ModuleDescriptor-template.json b/descriptors/ModuleDescriptor-template.json
@@ -139,7 +139,7 @@
     },
     {
       "id": "order-lines",
-      "version": "4.0",
+      "version": "4.1",
       "handlers": [
         {
           "methods": [
diff --git a/ramls/acq-models b/ramls/acq-models
@@ -1 +1 @@
-Subproject commit a5d3b56b0f3fdcfcd447e5d522d718f612f65943
+Subproject commit 6202a2c386b7bddd7b1537287cee84bc3bae26e8
diff --git a/src/main/java/org/folio/rest/impl/TitlesApi.java b/src/main/java/org/folio/rest/impl/TitlesApi.java
@@ -27,6 +27,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 
 public class TitlesApi extends BaseApi implements OrdersTitles {
+
   @Autowired
   private TitlesService titlesService;
   @Autowired
diff --git a/src/main/java/org/folio/service/inventory/InventoryInstanceManager.java b/src/main/java/org/folio/service/inventory/InventoryInstanceManager.java
@@ -32,7 +32,6 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.CompletionException;
-import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import static java.util.Collections.singletonList;
@@ -54,6 +53,7 @@
 import static org.folio.service.inventory.InventoryUtils.INVENTORY_LOOKUP_ENDPOINTS;
 
 public class InventoryInstanceManager {
+
   private static final Logger logger = LogManager.getLogger(InventoryInstanceManager.class);
 
   public static final String ID = "id";
@@ -100,10 +100,11 @@ public Future<SharingInstance> createShadowInstanceIfNeeded(String instanceId, R
       .compose(consortiumConfiguration -> createShadowInstanceIfNeeded(instanceId, consortiumConfiguration.orElse(null), requestContext));
   }
 
-  public Future<String> getOrCreateInstanceRecord(Title title, boolean isInstanceMatchingDisabled, RequestContext requestContext) {
+  public Future<String> getOrCreateInstanceRecord(Title title, boolean isInstanceMatchingDisabled,
+                                                  boolean suppressDiscovery, RequestContext requestContext) {
     logger.debug("InventoryInstanceManager.getOrCreateInstanceRecord title.id={}", title.getId());
     if (CollectionUtils.isEmpty(title.getProductIds()) || isInstanceMatchingDisabled) {
-      return createInstanceRecord(title, requestContext);
+      return createInstanceRecord(title, suppressDiscovery, requestContext);
     }
 
     return searchInstancesByProducts(title.getProductIds(), requestContext)
@@ -112,7 +113,7 @@ public Future<String> getOrCreateInstanceRecord(Title title, boolean isInstanceM
           String instanceId = getFirstObjectFromResponse(instances, INSTANCES).getString(ID);
           return Future.succeededFuture(instanceId);
         }
-        return createInstanceRecord(title, requestContext);
+        return createInstanceRecord(title, suppressDiscovery, requestContext);
       });
   }
 
@@ -124,7 +125,7 @@ public Future<PoLine> openOrderHandleInstance(PoLine poLine, boolean isInstanceM
       .map(poLine::withInstanceId);
   }
 
-  public Future<String> createInstanceRecord(Title title, RequestContext requestContext) {
+  public Future<String> createInstanceRecord(Title title, boolean suppressDiscovery, RequestContext requestContext) {
     logger.debug("InventoryInstanceManager.createInstanceRecord title.id={}", title.getId());
     JsonObject lookupObj = new JsonObject();
     Future<Void> instanceTypeFuture = InventoryUtils.getEntryId(configurationEntriesCache, inventoryCache, INSTANCE_TYPES, MISSING_INSTANCE_TYPE, requestContext)
@@ -138,7 +139,7 @@ public Future<String> createInstanceRecord(Title title, RequestContext requestCo
     Future<Void> contributorNameTypeIdFuture = verifyContributorNameTypesExist(title.getContributors(), requestContext);
 
     return GenericCompositeFuture.join(List.of(instanceTypeFuture, statusFuture, contributorNameTypeIdFuture))
-      .map(cf -> buildInstanceRecordJsonObject(title, lookupObj))
+      .map(cf -> buildInstanceRecordJsonObject(title, suppressDiscovery, lookupObj))
       .compose(instanceJson -> createInstance(instanceJson, requestContext));
   }
 
@@ -152,13 +153,13 @@ Future<JsonObject> searchInstancesByProducts(List<ProductId> productIds, Request
     return restClient.getAsJsonObject(requestEntry, requestContext);
   }
 
-  JsonObject buildInstanceRecordJsonObject(Title title, JsonObject lookupObj) {
+  JsonObject buildInstanceRecordJsonObject(Title title, boolean suppressDiscovery, JsonObject lookupObj) {
     JsonObject instance = new JsonObject();
 
     // MODORDERS-145 The Source and source code are required by schema
     instance.put(INSTANCE_SOURCE, SOURCE_FOLIO);
     instance.put(INSTANCE_TITLE, title.getTitle());
-    instance.put(INSTANCE_DISCOVERY_SUPPRESS, false);
+    instance.put(INSTANCE_DISCOVERY_SUPPRESS, suppressDiscovery);
 
     if (title.getEdition() != null) {
       instance.put(INSTANCE_EDITIONS, new JsonArray(singletonList(title.getEdition())));
@@ -180,7 +181,7 @@ JsonObject buildInstanceRecordJsonObject(Title title, JsonObject lookupObj) {
         invContributor.put(CONTRIBUTOR_NAME_TYPE_ID, polContributor.getContributorNameTypeId());
         invContributor.put(CONTRIBUTOR_NAME, polContributor.getContributor());
         return invContributor;
-      }).collect(toList());
+      }).toList();
       instance.put(INSTANCE_CONTRIBUTORS, contributors);
     }
 
@@ -194,7 +195,7 @@ JsonObject buildInstanceRecordJsonObject(Title title, JsonObject lookupObj) {
             identifier.put(INSTANCE_IDENTIFIER_TYPE_VALUE, pId.getProductId());
             return identifier;
           })
-          .collect(toList());
+          .toList();
       instance.put(INSTANCE_IDENTIFIERS, new JsonArray(identifiers));
     }
     return instance;
@@ -326,7 +327,7 @@ private JsonObject buildInstanceRecordJsonObject(PoLine poLine, JsonObject looku
         invContributor.put(CONTRIBUTOR_NAME_TYPE_ID, polContributor.getContributorNameTypeId());
         invContributor.put(CONTRIBUTOR_NAME, polContributor.getContributor());
         return invContributor;
-      }).collect(toList());
+      }).toList();
       instance.put(INSTANCE_CONTRIBUTORS, contributors);
     }
 
@@ -341,7 +342,7 @@ private JsonObject buildInstanceRecordJsonObject(PoLine poLine, JsonObject looku
             identifier.put(INSTANCE_IDENTIFIER_TYPE_VALUE, pId.getProductId());
             return identifier;
           })
-          .collect(toList());
+          .toList();
       instance.put(INSTANCE_IDENTIFIERS, new JsonArray(identifiers));
     }
     return instance;
@@ -386,7 +387,7 @@ private Future<List<JsonObject>> getContributorNameTypeByIds(List<String> ids, R
     return restClient.getAsJsonObject(requestEntry, requestContext)
       .map(entries -> entries.getJsonArray(CONTRIBUTOR_NAME_TYPES).stream()
         .map(JsonObject::mapFrom)
-        .collect(Collectors.toList())
+        .toList()
       )
       .recover(e -> {
         logger.error("The issue happened getting contributor name types", e);
@@ -446,7 +447,7 @@ private Future<SharingInstance> createShadowInstanceIfNeeded(String instanceId,
     }
     var targetTenant = TenantTool.tenantId(requestContext.getHeaders());
     logger.info("createShadowInstanceIfNeeded:: Getting instance: {} from tenant: {}", instanceId, targetTenant);
-    return getInstanceById(instanceId, true, requestContext)
+    return getInstanceById(instanceId, requestContext)
       .compose(instance -> {
         if (Objects.nonNull(instance) && !instance.isEmpty()) {
           logger.info("createShadowInstanceIfNeeded:: Shadow instance {} already exists in tenant: {}, skipping...", instanceId, targetTenant);
@@ -457,9 +458,8 @@ private Future<SharingInstance> createShadowInstanceIfNeeded(String instanceId,
       });
   }
 
-  private Future<JsonObject> getInstanceById(String instanceId, boolean skipNotFoundException, RequestContext requestContext) {
+  private Future<JsonObject> getInstanceById(String instanceId, RequestContext requestContext) {
     RequestEntry requestEntry = new RequestEntry(INVENTORY_LOOKUP_ENDPOINTS.get(INSTANCE_RECORDS_BY_ID_ENDPOINT)).withId(instanceId);
-    return restClient.getAsJsonObject(requestEntry, skipNotFoundException, requestContext);
+    return restClient.getAsJsonObject(requestEntry, true, requestContext);
   }
-
 }
diff --git a/src/main/java/org/folio/service/orders/flows/update/open/OpenCompositeOrderPieceService.java b/src/main/java/org/folio/service/orders/flows/update/open/OpenCompositeOrderPieceService.java
@@ -36,6 +36,7 @@
 import org.folio.service.titles.TitlesService;
 
 public class OpenCompositeOrderPieceService {
+
   private static final Logger logger = LogManager.getLogger(OpenCompositeOrderPieceService.class);
 
   private final InventoryItemManager inventoryItemManager;
@@ -134,7 +135,7 @@ private Future<Piece> openOrderUpdateInventory(Piece piece, CompositePurchaseOrd
         protectionService.isOperationRestricted(title.getAcqUnitIds(), ProtectedOperationType.CREATE, requestContext)
       )
       .compose(v ->
-        openOrderUpdateInventory(order, order.getPoLines().get(0), piece, isInstanceMatchingDisabled, requestContext)
+        openOrderUpdateInventory(order, order.getPoLines().getFirst(), piece, isInstanceMatchingDisabled, requestContext)
       )
       .map(v -> piece);
   }
@@ -174,8 +175,9 @@ public Future<Void> openOrderUpdateInventory(CompositePurchaseOrder compPO, PoLi
       return inventoryItemManager.updateItemWithPieceFields(piece, requestContext);
     }
     var locationContext = createContextWithNewTenantId(requestContext, piece.getReceivingTenantId());
+    var suppressDiscovery = Optional.ofNullable(poLine.getSuppressInstanceFromDiscovery()).orElse(false);
     return titlesService.getTitleById(piece.getTitleId(), requestContext)
-      .compose(title -> titlesService.updateTitleWithInstance(title, isInstanceMatchingDisabled, locationContext, requestContext).map(title::withInstanceId))
+      .compose(title -> titlesService.updateTitleWithInstance(title, isInstanceMatchingDisabled, suppressDiscovery, locationContext, requestContext).map(title::withInstanceId))
       .compose(title -> getOrCreateHolding(poLine, piece, title, locationContext))
       .compose(holdingId -> updateItemsIfNeeded(compPO, poLine, holdingId, locationContext))
       .map(itemId -> Optional.ofNullable(itemId).map(piece::withItemId))
diff --git a/src/main/java/org/folio/service/titles/TitleInstanceService.java b/src/main/java/org/folio/service/titles/TitleInstanceService.java
@@ -15,27 +15,28 @@ public TitleInstanceService(InventoryInstanceManager inventoryInstanceManager) {
   }
 
   public Future<String> getOrCreateInstance(Title title, RequestContext requestContext) {
-    return getOrCreateInstance(title, false, requestContext);
+    return getOrCreateInstance(title, false, false, requestContext);
   }
 
-  public Future<String> getOrCreateInstance(Title title, boolean isInstanceMatchingDisabled, RequestContext requestContext) {
+  public Future<String> getOrCreateInstance(Title title, boolean isInstanceMatchingDisabled,
+                                            boolean suppressDiscovery, RequestContext requestContext) {
     return createShadowInstance(title.getInstanceId(), requestContext)
-      .compose(shadowInstId -> createInventoryInstance(shadowInstId, title, isInstanceMatchingDisabled, requestContext));
+      .compose(shadowInstId -> createInventoryInstance(shadowInstId, title, isInstanceMatchingDisabled, suppressDiscovery, requestContext));
   }
 
   private Future<String> createShadowInstance(String instanceId, RequestContext requestContext) {
     return inventoryInstanceManager.createShadowInstanceIfNeeded(instanceId, requestContext)
       .map(sharingInstance -> sharingInstance != null ? instanceId : null);
   }
 
-  private Future<String> createInventoryInstance(String shadowInstId, Title title, boolean isInstanceMatchingDisabled, RequestContext requestContext) {
+  private Future<String> createInventoryInstance(String shadowInstId, Title title, boolean isInstanceMatchingDisabled,
+                                                 boolean suppressDiscovery, RequestContext requestContext) {
     if (shadowInstId != null) {
       return Future.succeededFuture(shadowInstId);
     }
     if (title.getInstanceId() != null) {
       return Future.succeededFuture(title.getInstanceId());
     }
-    return inventoryInstanceManager.getOrCreateInstanceRecord(title, isInstanceMatchingDisabled, requestContext);
+    return inventoryInstanceManager.getOrCreateInstanceRecord(title, isInstanceMatchingDisabled, suppressDiscovery, requestContext);
   }
-
 }
diff --git a/src/main/java/org/folio/service/titles/TitlesService.java b/src/main/java/org/folio/service/titles/TitlesService.java
@@ -57,6 +57,7 @@
 
 @Log4j2
 public class TitlesService {
+
   private static final String ENDPOINT = resourcesPath(TITLES);
   private static final String BY_ID_ENDPOINT = ENDPOINT + "/{id}";
 
@@ -159,18 +160,18 @@ public Future<Map<String, List<Title>>> fetchNonPackageTitles(CompositePurchaseO
   }
 
   private List<String> getNonPackageLineIds(List<PoLine> poLines) {
-    return poLines.stream().filter(line -> !line.getIsPackage()).map(PoLine::getId).collect(toList());
+    return poLines.stream().filter(line -> !line.getIsPackage()).map(PoLine::getId).toList();
   }
 
   public Future<String> updateTitleWithInstance(String titleId, RequestContext locationContext,
                                                 RequestContext requestContext) {
     return getTitleById(titleId, requestContext)
-      .compose(title -> updateTitleWithInstance(title, false, locationContext, requestContext));
+      .compose(title -> updateTitleWithInstance(title, false, false, locationContext, requestContext));
   }
 
-  public Future<String> updateTitleWithInstance(Title title, boolean isInstanceMatchingDisabled,
+  public Future<String> updateTitleWithInstance(Title title, boolean isInstanceMatchingDisabled, boolean suppressDiscovery,
                                                 RequestContext locationContext, RequestContext requestContext) {
-    return titleInstanceService.getOrCreateInstance(title, isInstanceMatchingDisabled, locationContext)
+    return titleInstanceService.getOrCreateInstance(title, isInstanceMatchingDisabled, suppressDiscovery, locationContext)
       .map(title::withInstanceId)
       .compose(entity -> saveTitle(entity, requestContext)
         .map(v -> entity.getInstanceId()));
diff --git a/src/test/java/org/folio/ApiTestSuite.java b/src/test/java/org/folio/ApiTestSuite.java
@@ -572,7 +572,6 @@ class WrapperPiecesAPITestNested extends WrapperPiecesAPITest {
   class TitlesServiceTestNested extends TitlesServiceTest {
   }
 
-
   @Nested
   class CacheableExchangeRateServiceTestNested extends CacheableExchangeRateServiceTest {
   }
diff --git a/src/test/java/org/folio/service/inventory/InventoryManagerTest.java b/src/test/java/org/folio/service/inventory/InventoryManagerTest.java
diff --git a/src/test/java/org/folio/service/orders/flows/update/open/OpenCompositeOrderPieceServiceTest.java b/src/test/java/org/folio/service/orders/flows/update/open/OpenCompositeOrderPieceServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@`
`139`	`139`	`},`
`140`	`140`	`{`
`141`	`141`	`"id": "order-lines",`
`142`		`- "version": "4.0",`
	`142`	`+ "version": "4.1",`
`143`	`143`	`"handlers": [`
`144`	`144`	`{`
`145`	`145`	`"methods": [`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`import org.folio.service.titles.TitlesService;`
`37`	`37`
`38`	`38`	`public class OpenCompositeOrderPieceService {`
	`39`	`+`
`39`	`40`	`private static final Logger logger = LogManager.getLogger(OpenCompositeOrderPieceService.class);`
`40`	`41`
`41`	`42`	`private final InventoryItemManager inventoryItemManager;`
`@@ -134,7 +135,7 @@ private Future<Piece> openOrderUpdateInventory(Piece piece, CompositePurchaseOrd`
`134`	`135`	`protectionService.isOperationRestricted(title.getAcqUnitIds(), ProtectedOperationType.CREATE, requestContext)`
`135`	`136`	`)`
`136`	`137`	`.compose(v ->`
`137`		`- openOrderUpdateInventory(order, order.getPoLines().get(0), piece, isInstanceMatchingDisabled, requestContext)`
	`138`	`+ openOrderUpdateInventory(order, order.getPoLines().getFirst(), piece, isInstanceMatchingDisabled, requestContext)`
`138`	`139`	`)`
`139`	`140`	`.map(v -> piece);`
`140`	`141`	`}`
`@@ -174,8 +175,9 @@ public Future<Void> openOrderUpdateInventory(CompositePurchaseOrder compPO, PoLi`
`174`	`175`	`return inventoryItemManager.updateItemWithPieceFields(piece, requestContext);`
`175`	`176`	`}`
`176`	`177`	`var locationContext = createContextWithNewTenantId(requestContext, piece.getReceivingTenantId());`
	`178`	`+ var suppressDiscovery = Optional.ofNullable(poLine.getSuppressInstanceFromDiscovery()).orElse(false);`
`177`	`179`	`return titlesService.getTitleById(piece.getTitleId(), requestContext)`
`178`		`- .compose(title -> titlesService.updateTitleWithInstance(title, isInstanceMatchingDisabled, locationContext, requestContext).map(title::withInstanceId))`
	`180`	`+ .compose(title -> titlesService.updateTitleWithInstance(title, isInstanceMatchingDisabled, suppressDiscovery, locationContext, requestContext).map(title::withInstanceId))`
`179`	`181`	`.compose(title -> getOrCreateHolding(poLine, piece, title, locationContext))`
`180`	`182`	`.compose(holdingId -> updateItemsIfNeeded(compPO, poLine, holdingId, locationContext))`
`181`	`183`	`.map(itemId -> Optional.ofNullable(itemId).map(piece::withItemId))`
Original file line number	Diff line number	Diff line change
`@@ -15,27 +15,28 @@ public TitleInstanceService(InventoryInstanceManager inventoryInstanceManager) {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public Future<String> getOrCreateInstance(Title title, RequestContext requestContext) {`
`18`		`- return getOrCreateInstance(title, false, requestContext);`
	`18`	`+ return getOrCreateInstance(title, false, false, requestContext);`
`19`	`19`	`}`
`20`	`20`
`21`		`- public Future<String> getOrCreateInstance(Title title, boolean isInstanceMatchingDisabled, RequestContext requestContext) {`
	`21`	`+ public Future<String> getOrCreateInstance(Title title, boolean isInstanceMatchingDisabled,`
	`22`	`+ boolean suppressDiscovery, RequestContext requestContext) {`
`22`	`23`	`return createShadowInstance(title.getInstanceId(), requestContext)`
`23`		`- .compose(shadowInstId -> createInventoryInstance(shadowInstId, title, isInstanceMatchingDisabled, requestContext));`
	`24`	`+ .compose(shadowInstId -> createInventoryInstance(shadowInstId, title, isInstanceMatchingDisabled, suppressDiscovery, requestContext));`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`private Future<String> createShadowInstance(String instanceId, RequestContext requestContext) {`
`27`	`28`	`return inventoryInstanceManager.createShadowInstanceIfNeeded(instanceId, requestContext)`
`28`	`29`	`.map(sharingInstance -> sharingInstance != null ? instanceId : null);`
`29`	`30`	`}`
`30`	`31`
`31`		`- private Future<String> createInventoryInstance(String shadowInstId, Title title, boolean isInstanceMatchingDisabled, RequestContext requestContext) {`
	`32`	`+ private Future<String> createInventoryInstance(String shadowInstId, Title title, boolean isInstanceMatchingDisabled,`
	`33`	`+ boolean suppressDiscovery, RequestContext requestContext) {`
`32`	`34`	`if (shadowInstId != null) {`
`33`	`35`	`return Future.succeededFuture(shadowInstId);`
`34`	`36`	`}`
`35`	`37`	`if (title.getInstanceId() != null) {`
`36`	`38`	`return Future.succeededFuture(title.getInstanceId());`
`37`	`39`	`}`
`38`		`- return inventoryInstanceManager.getOrCreateInstanceRecord(title, isInstanceMatchingDisabled, requestContext);`
	`40`	`+ return inventoryInstanceManager.getOrCreateInstanceRecord(title, isInstanceMatchingDisabled, suppressDiscovery, requestContext);`
`39`	`41`	`}`
`40`		`-`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -572,7 +572,6 @@ class WrapperPiecesAPITestNested extends WrapperPiecesAPITest {`
`572`	`572`	`class TitlesServiceTestNested extends TitlesServiceTest {`
`573`	`573`	`}`
`574`	`574`
`575`		`-`
`576`	`575`	`@Nested`
`577`	`576`	`class CacheableExchangeRateServiceTestNested extends CacheableExchangeRateServiceTest {`
`578`	`577`	`}`