Mcbff 12 research

descriptors/ModuleDescriptor-template.json

@@ -16,7 +16,9 @@
           ],
           "modulePermissions": [
             "tlr.pick-slips.collection.get",
-            "circulation.pick-slips.get"
+            "tlr.settings.get",
+            "circulation.pick-slips.get",
+            "user-tenants.collection.get"
           ]
         }
       ]
@@ -35,7 +37,9 @@
           ],
           "modulePermissions": [
             "tlr.search-slips.collection.get",
-            "circulation.search-slips.get"
+            "tlr.settings.get",
+            "circulation.search-slips.get",
+            "user-tenants.collection.get"
           ]
         }
       ]
@@ -200,6 +204,10 @@
       "id": "requests-mediated",
       "version": "2.0"
     },
+    {
+      "id": "user-tenants",
+      "version": "1.0"
+    },
     {
       "id": "users",
       "version": "16.0"

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

@@ -4,8 +4,9 @@
 import org.folio.circulationbff.domain.dto.AllowedServicePoints;
 import org.folio.circulationbff.domain.dto.BffRequest;
 import org.folio.circulationbff.domain.dto.CirculationSettingsResponse;
+import org.folio.circulationbff.domain.dto.PickSlipCollection;
 import org.folio.circulationbff.domain.dto.Request;
-import org.folio.circulationbff.domain.dto.StaffSlipCollection;
+import org.folio.circulationbff.domain.dto.SearchSlipCollection;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.cloud.openfeign.SpringQueryMap;
@@ -32,8 +33,8 @@ public interface CirculationClient {
   Request getRequestById(@PathVariable("requestId") String requestId);
 
   @GetMapping("/pick-slips/{servicePointId}")
-  StaffSlipCollection getPickSlips(@PathVariable ("servicePointId") String servicePointId);
+  PickSlipCollection getPickSlips(@PathVariable ("servicePointId") String servicePointId);
 
   @GetMapping("/search-slips/{servicePointId}")
-  StaffSlipCollection getSearchSlips(@PathVariable ("servicePointId") String servicePointId);
+  SearchSlipCollection getSearchSlips(@PathVariable ("servicePointId") String servicePointId);
 }

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

@@ -4,7 +4,8 @@
 import org.folio.circulationbff.domain.dto.AllowedServicePoints;
 import org.folio.circulationbff.domain.dto.BffRequest;
 import org.folio.circulationbff.domain.dto.EcsTlr;
-import org.folio.circulationbff.domain.dto.StaffSlipCollection;
+import org.folio.circulationbff.domain.dto.PickSlipCollection;
+import org.folio.circulationbff.domain.dto.SearchSlipCollection;
 import org.folio.circulationbff.domain.dto.TlrSettings;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
@@ -27,8 +28,8 @@ public interface EcsTlrClient {
   EcsTlr createRequest(@RequestBody BffRequest request);
 
   @GetMapping("/staff-slips/pick-slips/{servicePointId}")
-  StaffSlipCollection getPickSlips(@PathVariable("servicePointId") String servicePointId);
+  PickSlipCollection getPickSlips(@PathVariable("servicePointId") String servicePointId);
 
   @GetMapping("/staff-slips/search-slips/{servicePointId}")
-  StaffSlipCollection getSearchSlips(@PathVariable ("servicePointId") String servicePointId);
+  SearchSlipCollection getSearchSlips(@PathVariable ("servicePointId") String servicePointId);
 }

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

@@ -12,8 +12,9 @@
 import org.folio.circulationbff.domain.dto.BffSearchInstance;
 import org.folio.circulationbff.domain.dto.EmptyBffSearchInstance;
 import org.folio.circulationbff.domain.dto.MediatedRequest;
+import org.folio.circulationbff.domain.dto.PickSlipCollection;
 import org.folio.circulationbff.domain.dto.Request;
-import org.folio.circulationbff.domain.dto.StaffSlipCollection;
+import org.folio.circulationbff.domain.dto.SearchSlipCollection;
 import org.folio.circulationbff.domain.dto.UserCollection;
 import org.folio.circulationbff.rest.resource.CirculationBffApi;
 import org.folio.circulationbff.service.CirculationBffService;
@@ -38,15 +39,15 @@ public class CirculationBffController implements CirculationBffApi {
   private final UserService userService;
 
   @Override
-  public ResponseEntity<StaffSlipCollection> getPickSlips(String servicePointId) {
+  public ResponseEntity<PickSlipCollection> getPickSlips(String servicePointId) {
     log.info("getPickSlips:: servicePointId = {}", servicePointId);
 
     return ResponseEntity.status(HttpStatus.OK)
       .body(circulationBffService.fetchPickSlipsByServicePointId(servicePointId));
   }
 
   @Override
-  public ResponseEntity<StaffSlipCollection> getSearchSlips(String servicePointId) {
+  public ResponseEntity<SearchSlipCollection> getSearchSlips(String servicePointId) {
     log.info("getSearchSlips:: servicePointId = {}", servicePointId);
 
     return ResponseEntity.status(HttpStatus.OK).body(circulationBffService

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

@@ -3,12 +3,13 @@
 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.PickSlipCollection;
 import org.folio.circulationbff.domain.dto.Request;
-import org.folio.circulationbff.domain.dto.StaffSlipCollection;
+import org.folio.circulationbff.domain.dto.SearchSlipCollection;
 
 public interface CirculationBffService {
   AllowedServicePoints getAllowedServicePoints(AllowedServicePointParams allowedServicePointParams, String tenantId);
   Request createRequest(BffRequest request, String tenantId);
-  StaffSlipCollection fetchPickSlipsByServicePointId(String servicePointId);
-  StaffSlipCollection fetchSearchSlipsByServicePointId(String servicePointId);
+  PickSlipCollection fetchPickSlipsByServicePointId(String servicePointId);
+  SearchSlipCollection fetchSearchSlipsByServicePointId(String servicePointId);
 }

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

@@ -1,6 +1,5 @@
 package org.folio.circulationbff.service;
 
 public interface SettingsService {
-  boolean isEcsTlrFeatureEnabled();
   boolean isEcsTlrFeatureEnabled(String tenantId);
 }

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

@@ -6,8 +6,9 @@
 import org.folio.circulationbff.domain.dto.AllowedServicePoints;
 import org.folio.circulationbff.domain.dto.BffRequest;
 import org.folio.circulationbff.domain.dto.EcsTlr;
+import org.folio.circulationbff.domain.dto.PickSlipCollection;
 import org.folio.circulationbff.domain.dto.Request;
-import org.folio.circulationbff.domain.dto.StaffSlipCollection;
+import org.folio.circulationbff.domain.dto.SearchSlipCollection;
 import org.folio.circulationbff.service.CirculationBffService;
 import org.folio.circulationbff.service.SettingsService;
 import org.folio.circulationbff.service.UserTenantsService;
@@ -27,27 +28,35 @@ public class CirculationBffServiceImpl implements CirculationBffService {
   private final UserTenantsService userTenantsService;
 
   @Override
-  public StaffSlipCollection fetchPickSlipsByServicePointId(String servicePointId) {
+  public PickSlipCollection fetchPickSlipsByServicePointId(String servicePointId) {
     log.info("fetchPickSlipsByServicePointId:: servicePointId: {}", servicePointId);
-    boolean isEcsTlrFeatureEnabled = settingsService.isEcsTlrFeatureEnabled();
-    log.info("fetchPickSlipsByServicePointId:: isEcsTlrFeatureEnabled: {}",
-      isEcsTlrFeatureEnabled);
-
-    return isEcsTlrFeatureEnabled
-      ? ecsTlrClient.getPickSlips(servicePointId)
-      : circulationClient.getPickSlips(servicePointId);
+    PickSlipCollection pickSlips = null;
+    if(shouldFetchStaffSlipsFromModTlr()) {
+      log.info("fetchPickSlipsByServicePointId:: BEFORE TLR CLIENT client; pickSlips: {}", pickSlips);
+      pickSlips = ecsTlrClient.getPickSlips(servicePointId);
+      log.info("fetchPickSlipsByServicePointId:: AFTER TLR CLIENT client; pickSlips: {}", pickSlips);
+    } else {
+      log.info("fetchPickSlipsByServicePointId:: BEFORE CIRCULATION CLIENT client; pickSlips: {}", pickSlips);
+      pickSlips = circulationClient.getPickSlips(servicePointId);
+      log.info("fetchPickSlipsByServicePointId:: AFTER CIRCULATION CLIENT client; pickSlips: {}", pickSlips);
+    }
+    return pickSlips;
   }
 
   @Override
-  public StaffSlipCollection fetchSearchSlipsByServicePointId(String servicePointId) {
+  public SearchSlipCollection fetchSearchSlipsByServicePointId(String servicePointId) {
     log.info("fetchSearchSlipsByServicePointId:: servicePointId: {}", servicePointId);
-    boolean isEcsTlrFeatureEnabled = settingsService.isEcsTlrFeatureEnabled();
-    log.info("fetchSearchSlipsByServicePointId:: isEcsTlrFeatureEnabled: {}",
-      isEcsTlrFeatureEnabled);
-
-    return isEcsTlrFeatureEnabled
-      ? ecsTlrClient.getSearchSlips(servicePointId)
-      : circulationClient.getSearchSlips(servicePointId);
+    SearchSlipCollection searchSlips = null;
+    if(shouldFetchStaffSlipsFromModTlr()) {
+      log.info("fetchSearchSlipsByServicePointId:: BEFORE TLR CLIENT client; searchSlips: {}", searchSlips);
+      searchSlips = ecsTlrClient.getSearchSlips(servicePointId);
+      log.info("fetchSearchSlipsByServicePointId:: AFTER TLR CLIENT client; searchSlips: {}", searchSlips);
+    } else {
+      log.info("fetchSearchSlipsByServicePointId:: BEFORE CIRCULATION CLIENT client; searchSlips: {}", searchSlips);
+      searchSlips = circulationClient.getSearchSlips(servicePointId);
+      log.info("fetchSearchSlipsByServicePointId:: AFTER CIRCULATION CLIENT client; searchSlips: {}", searchSlips);
+    }
+    return searchSlips;
   }
 
   @Override
@@ -76,4 +85,14 @@ public Request createRequest(BffRequest request, String tenantId) {
       return circulationClient.createRequest(request);
     }
   }
+
+  private boolean shouldFetchStaffSlipsFromModTlr() {
+    boolean isCentralTenant = userTenantsService.isCentralTenant();
+    boolean ecsTlrFeatureIsEnabledInModTlr = false;
+    if (isCentralTenant) {
+      ecsTlrFeatureIsEnabledInModTlr = ecsTlrClient.getTlrSettings().getEcsTlrFeatureEnabled();
+    }
+    log.info("shouldFetchStaffSlipsFromModTlr:: {}", ecsTlrFeatureIsEnabledInModTlr);
+    return ecsTlrFeatureIsEnabledInModTlr;
+  }
 }

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

@@ -19,13 +19,6 @@ public class SettingsServiceImpl implements SettingsService {
   private final CirculationClient circulationClient;
   private final UserTenantsService userTenantsService;
 
-  @Override
-  public boolean isEcsTlrFeatureEnabled() {
-    return userTenantsService.isCentralTenant()
-      ? ecsTlrClient.getTlrSettings().getEcsTlrFeatureEnabled()
-      : isTlrEnabledInCirculationSettings();
-  }
-
   @Override
   public boolean isEcsTlrFeatureEnabled(String tenantId) {
     if (userTenantsService.isCentralTenant(tenantId)) {

src/main/resources/application.yml

@@ -33,6 +33,10 @@ folio:
     password: ${SYSTEM_USER_PASSWORD:mod-circulation-bff}
     lastname: System
     permissionsFilePath: permissions/mod-circulation-bff.csv
+  logging:
+    feign:
+      enabled: true
+      level: full
 management:
   endpoints:
     web:

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

@@ -12,7 +12,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../responses/externalUsersResponse.yaml'
+            $ref: '../../schemas/response/userCollection.json'
     '404':
       $ref: '../../responses/notFoundResponse.yaml'
     '422':

src/main/resources/swagger.api/paths/staffSlips/pickSlips.yaml

@@ -11,7 +11,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../responses/staffSlipsResponse.yaml'
+            $ref: '../../schemas/dto/staffSlips/pickSlipCollection.yaml'
     '404':
       $ref: '../../responses/notFoundResponse.yaml'
     '422':

src/main/resources/swagger.api/paths/staffSlips/searchSlips.yaml

@@ -11,7 +11,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../responses/staffSlipsResponse.yaml'
+            $ref: '../../schemas/dto/staffSlips/searchSlipCollection.yaml'
     '404':
       $ref: '../../responses/notFoundResponse.yaml'
     '422':

src/main/resources/swagger.api/schemas/dto/staffSlips/staffSlipCollection.yaml → src/main/resources/swagger.api/schemas/dto/staffSlips/pickSlipCollection.yaml

@@ -1,13 +1,13 @@
-description: Collection of staff slips
+description: Collection of pick slips
 type: object
 properties:
   totalRecords:
     type: integer
-    description: Total number of staff slips
-  staffSlips:
+    description: Total number of pick slips
+  pickSlips:
     type: array
     items:
       $ref: "staffSlip.yaml"
 required:
   - totalRecords
-  - staffSlips
+  - pickSlips

src/main/resources/swagger.api/schemas/dto/staffSlips/searchSlipCollection.yaml

@@ -0,0 +1,13 @@
+description: Collection of search slips
+type: object
+properties:
+  totalRecords:
+    type: integer
+    description: Total number of search slips
+  searchSlips:
+    type: array
+    items:
+      $ref: "staffSlip.yaml"
+required:
+  - totalRecords
+  - searchSlips