MCBFF-21 Request types - failsafe approach for ECS requesting

descriptors/ModuleDescriptor-template.json

@@ -2,6 +2,21 @@
   "id": "@artifactId@-@version@",
   "name": "Folio mod-circulation-bff module",
   "provides": [
+    {
+      "id": "circulation-bff-ecs-request-external",
+      "version": "1.0",
+      "handlers": [
+        {
+          "methods": ["POST"],
+          "pathPattern": "/circulation-bff/create-ecs-request-external",
+          "permissionsRequired": ["circulation-bff.ecs-request-external.post"],
+          "modulePermissions": [
+            "tlr.ecs-request-external.post",
+            "user-tenants.collection.get"
+          ]
+        }
+      ]
+    },
     {
       "id": "circulation-bff-pick-slips",
       "version": "1.0",
@@ -151,6 +166,11 @@
     }
   ],
   "permissionSets" : [
+    {
+      "permissionName": "circulation-bff.ecs-request-external.post",
+      "displayName": "circulation BFF - create ecs external request",
+      "description": "create ecs external request"
+    },
     {
       "permissionName": "circulation-bff.pick-slips.collection.get",
       "displayName": "circulation BFF - get pick slips by service point id",
@@ -188,6 +208,10 @@
     }
   ],
   "requires": [
+    {
+      "id": "ecs-request-external",
+      "version": "1.0"
+    },
     {
       "id": "pick-slips",
       "version": "0.4"
@@ -212,6 +236,10 @@
       "id": "users",
       "version": "16.0"
     },
+    {
+      "id": "user-tenants",
+      "version": "1.0"
+    },
     {
       "id": "login",
       "version": "7.3"

src/main/java/org/folio/circulationbff/client/feign/EcsTlrClient.java

@@ -3,6 +3,7 @@
 import org.folio.circulationbff.domain.dto.AllowedServicePointParams;
 import org.folio.circulationbff.domain.dto.AllowedServicePoints;
 import org.folio.circulationbff.domain.dto.BffRequest;
+import org.folio.circulationbff.domain.dto.EcsRequestExternal;
 import org.folio.circulationbff.domain.dto.EcsTlr;
 import org.folio.circulationbff.domain.dto.PickSlipCollection;
 import org.folio.circulationbff.domain.dto.SearchSlipCollection;
@@ -32,4 +33,7 @@ public interface EcsTlrClient {
 
   @GetMapping("/staff-slips/search-slips/{servicePointId}")
   SearchSlipCollection getSearchSlips(@PathVariable ("servicePointId") String servicePointId);
+
+  @PostMapping("/create-ecs-request-external")
+  EcsTlr createEcsExternalRequest(@RequestBody EcsRequestExternal request);
 }

src/main/java/org/folio/circulationbff/controller/CirculationBffController.java

@@ -10,6 +10,8 @@
 import org.folio.circulationbff.domain.dto.AllowedServicePoints;
 import org.folio.circulationbff.domain.dto.BffRequest;
 import org.folio.circulationbff.domain.dto.BffSearchInstance;
+import org.folio.circulationbff.domain.dto.EcsRequestExternal;
+import org.folio.circulationbff.domain.dto.EcsTlr;
 import org.folio.circulationbff.domain.dto.EmptyBffSearchInstance;
 import org.folio.circulationbff.domain.dto.MediatedRequest;
 import org.folio.circulationbff.domain.dto.PickSlipCollection;
@@ -18,6 +20,7 @@
 import org.folio.circulationbff.domain.dto.UserCollection;
 import org.folio.circulationbff.rest.resource.CirculationBffApi;
 import org.folio.circulationbff.service.CirculationBffService;
+import org.folio.circulationbff.service.EcsRequestExternalService;
 import org.folio.circulationbff.service.MediatedRequestsService;
 import org.folio.circulationbff.service.SearchService;
 import org.folio.circulationbff.service.UserService;
@@ -37,6 +40,13 @@ public class CirculationBffController implements CirculationBffApi {
   private final SearchService searchService;
   private final MediatedRequestsService mediatedRequestsService;
   private final UserService userService;
+  private final EcsRequestExternalService ecsRequestExternalService;
+
+  @Override
+  public ResponseEntity<EcsTlr> postEcsRequestExternal(EcsRequestExternal ecsRequestExternal) {
+    return ResponseEntity.status(HttpStatus.OK)
+      .body(ecsRequestExternalService.createEcsRequestExternal(ecsRequestExternal));
+  }
 
   @Override
   public ResponseEntity<PickSlipCollection> getPickSlips(String servicePointId) {

src/main/java/org/folio/circulationbff/service/EcsRequestExternalService.java

@@ -0,0 +1,8 @@
+package org.folio.circulationbff.service;
+
+import org.folio.circulationbff.domain.dto.EcsRequestExternal;
+import org.folio.circulationbff.domain.dto.EcsTlr;
+
+public interface EcsRequestExternalService {
+  EcsTlr createEcsRequestExternal(EcsRequestExternal ecsRequestExternal);
+}

src/main/java/org/folio/circulationbff/service/impl/EcsRequestExternalServiceImpl.java

@@ -0,0 +1,32 @@
+package org.folio.circulationbff.service.impl;
+
+import org.folio.circulationbff.client.feign.EcsTlrClient;
+import org.folio.circulationbff.domain.dto.EcsRequestExternal;
+import org.folio.circulationbff.domain.dto.EcsTlr;
+import org.folio.circulationbff.service.EcsRequestExternalService;
+import org.folio.circulationbff.service.UserTenantsService;
+import org.folio.spring.service.SystemUserScopedExecutionService;
+import org.springframework.stereotype.Service;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+
+@Service
+@RequiredArgsConstructor
+@Log4j2
+public class EcsRequestExternalServiceImpl implements EcsRequestExternalService {
+
+  private final SystemUserScopedExecutionService systemUserScopedExecutionService;
+  private final EcsTlrClient ecsTlrClient;
+  private final UserTenantsService userTenantsService;
+
+
+  @Override
+  public EcsTlr createEcsRequestExternal(EcsRequestExternal ecsRequestExternal) {
+    String centralTenantId = userTenantsService.getCentralTenant();
+    log.info("createEcsRequestExternal:: centralTenantId={}", centralTenantId);
+
+    return systemUserScopedExecutionService.executeSystemUserScoped(centralTenantId,
+      () -> ecsTlrClient.createEcsExternalRequest(ecsRequestExternal));
+  }
+}

src/main/resources/swagger.api/circulation-bff.yaml

@@ -17,6 +17,8 @@ paths:
     $ref: 'paths/staffSlips/pickSlips.yaml'
   /circulation-bff/search-slips/{servicePointId}:
     $ref: 'paths/staffSlips/searchSlips.yaml'
+  /circulation-bff/create-ecs-request-external:
+    $ref: 'paths/ecsRequestExternal/ecsRequestExternal.yaml'
 
 components:
   schemas:

src/main/resources/swagger.api/paths/ecsRequestExternal/ecsRequestExternal.yaml

@@ -0,0 +1,22 @@
+post:
+  description: Create ECS request external
+  operationId: postEcsRequestExternal
+  tags:
+    - ecsRequestExternal
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../schemas/dto/ecsRequestExternal/ecsRequestExternal.yaml'
+    required: true
+  responses:
+    '201':
+      description: Ecs external request has been created
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/dto/ecs-tlr/EcsTlr.yaml#/EcsTlr'
+    '400':
+      $ref: '../../responses/badRequestResponse.yaml'
+    '500':
+      $ref: '../../responses/internalServerErrorResponse.yaml'

src/main/resources/swagger.api/schemas/dto/ecsRequestExternal/ecsRequestExternal.yaml

@@ -0,0 +1,65 @@
+description: ECS Request External - title level requests in a multi-tenant environment with Сonsortia support enabled
+type: object
+properties:
+  id:
+    description: ID of the ECS TLR
+    $ref: '../common/uuid.yaml'
+  instanceId:
+    description: ID of the instance being requested
+    $ref: '../common/uuid.yaml'
+  requesterId:
+    description: ID of the requesting patron (user)
+    $ref: '../common/uuid.yaml'
+  requestLevel:
+    description: Level of the request - Item or Title
+    type: string
+    enum: [ "Item", "Title" ]
+  requestExpirationDate:
+    description: Date when the request expires
+    type: string
+    format: date-time
+  requestDate:
+    description: Date when the request was placed
+    type: string
+    format: date-time
+  patronComments:
+    description: Comments made by the patron
+    type: string
+  fulfillmentPreference:
+    description: How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)
+    type: string
+    enum: ["Hold Shelf", "Delivery"]
+  pickupServicePointId:
+    description: The ID of the Service Point where this request can be picked up
+    $ref: '../common/uuid.yaml'
+  itemId:
+    description: ID of the item being requested
+    $ref: '../common/uuid.yaml'
+  holdingsRecordId:
+    description: ID of the holdings record being requested
+    $ref: '../common/uuid.yaml'
+  primaryRequestId:
+    description: Primary request ID
+    $ref: '../common/uuid.yaml'
+  primaryRequestDcbTransactionId:
+    description: ID of DCB transaction created for primary request
+    $ref: '../common/uuid.yaml'
+  primaryRequestTenantId:
+    description: ID of the tenant primary request was created in
+    type: string
+  secondaryRequestId:
+    description: "Secondary request ID"
+    $ref: '../common/uuid.yaml'
+  secondaryRequestDcbTransactionId:
+    description: ID of DCB transaction created for secondary request
+    $ref: '../common/uuid.yaml'
+  secondaryRequestTenantId:
+    description: ID of the tenant secondary request was created in
+    type: string
+
+required:
+  - instanceId
+  - requesterId
+  - requestLevel
+  - fulfillmentPreference
+  - requestDate

src/test/java/org/folio/circulationbff/api/EcsExternalRequestApiTest.java

@@ -0,0 +1,82 @@
+package org.folio.circulationbff.api;
+
+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;
+import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson;
+import static com.github.tomakehurst.wiremock.client.WireMock.jsonResponse;
+import static com.github.tomakehurst.wiremock.client.WireMock.matching;
+import static com.github.tomakehurst.wiremock.client.WireMock.postRequestedFor;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlMatching;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
+import static com.github.tomakehurst.wiremock.client.WireMock.urlPathMatching;
+import static org.apache.http.HttpStatus.SC_CREATED;
+import static org.apache.http.HttpStatus.SC_OK;
+
+import java.time.LocalDate;
+import java.util.Date;
+import java.util.List;
+import java.util.UUID;
+
+import org.folio.circulationbff.domain.dto.EcsRequestExternal;
+import org.folio.circulationbff.domain.dto.EcsTlr;
+import org.folio.circulationbff.domain.dto.UserTenant;
+import org.folio.circulationbff.domain.dto.UserTenantCollection;
+import org.folio.spring.integration.XOkapiHeaders;
+import org.junit.jupiter.api.Test;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+
+import com.github.tomakehurst.wiremock.client.WireMock;
+
+import lombok.SneakyThrows;
+
+class EcsExternalRequestApiTest extends BaseIT {
+  private static final String TLR_CREATE_ECS_EXTERNAL_REQUEST_URL =
+    "/tlr/create-ecs-request-external";
+  private static final String CIRCULATION_BFF_CREATE_ECS_EXTERNAL_REQUEST_URL =
+    "/circulation-bff/create-ecs-request-external";
+  private static final String TEST_CENTRAL_TENANT_ID = "testCentralTenantId";
+
+  @Test
+  @SneakyThrows
+  void postEcsRequestExternalTest() {
+    EcsRequestExternal requestExternal = buildEcsRequestExternal();
+    mockEcsTlrExternalRequestCreating(requestExternal);
+    mockUserTenants();
+    mockPerform(requestExternal);
+
+    wireMockServer.verify(1, postRequestedFor(urlPathMatching(TLR_CREATE_ECS_EXTERNAL_REQUEST_URL))
+      .withHeader(XOkapiHeaders.TENANT, equalTo(TEST_CENTRAL_TENANT_ID)));
+  }
+
+  private static void mockUserTenants() {
+    UserTenant userTenant = new UserTenant();
+    userTenant.setCentralTenantId(TEST_CENTRAL_TENANT_ID);
+    UserTenantCollection userTenants = new UserTenantCollection(List.of(userTenant), 1);
+
+    wireMockServer.stubFor(WireMock.get(urlPathEqualTo(USER_TENANTS_URL))
+      .withQueryParam("limit", matching("\\d*"))
+      .withHeader(HEADER_TENANT, equalTo(TENANT_ID_CONSORTIUM))
+      .willReturn(jsonResponse(asJsonString(userTenants), SC_OK)));
+  }
+
+  private static EcsRequestExternal buildEcsRequestExternal() {
+    return new EcsRequestExternal(
+      UUID.randomUUID().toString(),
+      UUID.randomUUID().toString(),
+      EcsRequestExternal.RequestLevelEnum.ITEM,
+      new Date(LocalDate.of(2000, 1, 1).toEpochDay()),
+      EcsRequestExternal.FulfillmentPreferenceEnum.HOLD_SHELF
+    );
+  }
+
+  private void mockPerform(EcsRequestExternal requestExternal) throws Exception {
+    mockMvc.perform(buildRequest(MockMvcRequestBuilders.post(
+      CIRCULATION_BFF_CREATE_ECS_EXTERNAL_REQUEST_URL), requestExternal)
+      .header(XOkapiHeaders.TENANT, TENANT_ID_CONSORTIUM));
+  }
+
+  private static void mockEcsTlrExternalRequestCreating(EcsRequestExternal requestExternal) {
+    wireMockServer.stubFor(WireMock.post(urlMatching(TLR_CREATE_ECS_EXTERNAL_REQUEST_URL))
+      .withRequestBody(equalToJson(asJsonString(requestExternal)))
+      .willReturn(jsonResponse(asJsonString(new EcsTlr()), SC_CREATED)));
+  }
+}