MODFQMMGR-456: Check whether entity type is cross-tenant when retriev…

…ing definition (#434)
folio-org · Sep 27, 2024 · 5280cfa · 5280cfa
1 parent ada68e6
commit 5280cfa
Show file tree

Hide file tree

Showing 12 changed files with 227 additions and 54 deletions.
diff --git a/src/main/java/org/folio/fqm/service/CrossTenantQueryService.java b/src/main/java/org/folio/fqm/service/CrossTenantQueryService.java
@@ -22,12 +22,15 @@ public class CrossTenantQueryService {
   private final SimpleHttpClient ecsClient;
   private final FolioExecutionContext executionContext;
   private final PermissionsService permissionsService;
+  private final UserTenantService userTenantService;
 
   private static final String COMPOSITE_INSTANCES_ID = "6b08439b-4f8e-4468-8046-ea620f5cfb74";
   private static final String SIMPLE_INSTANCES_ID = "8fc4a9d2-7ccf-4233-afb8-796911839862";
 
   public List<String> getTenantsToQuery(EntityType entityType, boolean forceCrossTenantQuery) {
-    if (!forceCrossTenantQuery && !Boolean.TRUE.equals(entityType.getCrossTenantQueriesEnabled())) {
+    if (!forceCrossTenantQuery
+      && !Boolean.TRUE.equals(entityType.getCrossTenantQueriesEnabled())
+      && !COMPOSITE_INSTANCES_ID.equals(entityType.getId())) {
       return List.of(executionContext.getTenantId());
     }
     // Get the ECS tenant info first, since this comes from mod-users and should work in non-ECS environments
@@ -82,6 +85,23 @@ private List<Map<String, String>> getUserTenants(String consortiumId, String use
       .parse(userTenantResponse)
       .read("$.userTenants", List.class);
   }
+
+  public String getCentralTenantId() {
+    return getCentralTenantId(getEcsTenantInfo());
+  }
+
+  public boolean ecsEnabled() {
+    return ecsEnabled(getEcsTenantInfo());
+  }
+
+  public boolean isCentralTenant() {
+    return isCentralTenant(getEcsTenantInfo());
+  }
+
+  private boolean ecsEnabled(Map<String, String> ecsTenantInfo) {
+    return !(ecsTenantInfo == null || ecsTenantInfo.isEmpty());
+  }
+
   /**
    * Retrieve the primary affiliation for a user.
    * This retrieves the primary affiliation for an arbitrary user in the tenant.
@@ -90,7 +110,7 @@ private List<Map<String, String>> getUserTenants(String consortiumId, String use
    */
   @SuppressWarnings("unchecked") // JsonPath.parse is returning a plain List without a type parameter, and the TypeRef (vs Class) parameter to JsonPath.read is not supported by the JSON parser
   private Map<String, String> getEcsTenantInfo() {
-    String userTenantsResponse = ecsClient.get("user-tenants", Map.of("limit", "1"));
+    String userTenantsResponse = userTenantService.getUserTenantsResponse(executionContext.getTenantId());
     List<Map<String, String>> userTenants = JsonPath
       .parse(userTenantsResponse)
       .read("$.userTenants", List.class);
@@ -104,15 +124,7 @@ private String getCentralTenantId(Map<String, String> ecsTenantInfo) {
     return ecsTenantInfo != null ? ecsTenantInfo.get("centralTenantId") : null;
   }
 
-  public String getCentralTenantId() {
-    return getCentralTenantId(getEcsTenantInfo());
-  }
-
-  private boolean ecsEnabled(Map<String, String> ecsTenantInfo) {
-    return !(ecsTenantInfo == null || ecsTenantInfo.isEmpty());
-  }
-
-  public boolean ecsEnabled() {
-    return ecsEnabled(getEcsTenantInfo());
+  private boolean isCentralTenant(Map<String, String> ecsTenantInfo) {
+    return executionContext.getTenantId().equals(getCentralTenantId(ecsTenantInfo));
   }
 }
diff --git a/src/main/java/org/folio/fqm/service/EntityTypeFlatteningService.java b/src/main/java/org/folio/fqm/service/EntityTypeFlatteningService.java
@@ -5,7 +5,6 @@
 import com.jayway.jsonpath.JsonPath;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.folio.fqm.client.SimpleHttpClient;
 import org.folio.fqm.exception.EntityTypeNotFoundException;
 import org.folio.fqm.exception.InvalidEntityTypeDefinitionException;
 import org.folio.fqm.repository.EntityTypeRepository;
@@ -17,6 +16,7 @@
 import org.folio.querytool.domain.dto.Field;
 import org.folio.querytool.domain.dto.NestedObjectProperty;
 import org.folio.querytool.domain.dto.ObjectType;
+import org.folio.spring.FolioExecutionContext;
 import org.springframework.stereotype.Service;
 
 import java.util.*;
@@ -31,7 +31,8 @@ public class EntityTypeFlatteningService {
   private final EntityTypeRepository entityTypeRepository;
   private final ObjectMapper objectMapper;
   private final LocalizationService localizationService;
-  private final SimpleHttpClient ecsClient;
+  private final FolioExecutionContext executionContext;
+  private final UserTenantService userTenantService;
 
   public EntityType getFlattenedEntityType(UUID entityTypeId, String tenantId) {
     return getFlattenedEntityType(entityTypeId, null, tenantId);
@@ -317,8 +318,8 @@ private Stream<EntityTypeColumn> getFilteredColumns(Stream<EntityTypeColumn> unf
   }
 
   private boolean ecsEnabled() {
-    String rawJson = ecsClient.get("user-tenants", Map.of("limit", String.valueOf(1)));
-    DocumentContext parsedJson = JsonPath.parse(rawJson);
+    String userTenantsResponse = userTenantService.getUserTenantsResponse(executionContext.getTenantId());
+    DocumentContext parsedJson = JsonPath.parse(userTenantsResponse);
     // The value isn't needed here, this just provides an easy way to tell if ECS is enabled
     int totalRecords = parsedJson.read("totalRecords", Integer.class);
     return totalRecords > 0;

diff --git a/src/main/java/org/folio/fqm/service/EntityTypeService.java b/src/main/java/org/folio/fqm/service/EntityTypeService.java
@@ -60,7 +60,8 @@ public List<EntityTypeSummary> getEntityTypeSummary(Set<UUID> entityTypeIds, boo
       .map(entityType -> {
         EntityTypeSummary result = new EntityTypeSummary()
           .id(UUID.fromString(entityType.getId()))
-          .label(localizationService.getEntityTypeLabel(entityType.getName()));
+          .label(localizationService.getEntityTypeLabel(entityType.getName()))
+          .crossTenantQueriesEnabled(entityType.getCrossTenantQueriesEnabled());
         if (includeInaccessible) {
           return result.missingPermissions(
             permissionsService.getRequiredPermissions(entityType)
@@ -86,6 +87,8 @@ public List<EntityTypeSummary> getEntityTypeSummary(Set<UUID> entityTypeIds, boo
    */
   public EntityType getEntityTypeDefinition(UUID entityTypeId, boolean includeHidden, boolean sortColumns) {
     EntityType entityType = entityTypeFlatteningService.getFlattenedEntityType(entityTypeId, null);
+    boolean crossTenantEnabled = Boolean.TRUE.equals(entityType.getCrossTenantQueriesEnabled())
+      && crossTenantQueryService.isCentralTenant();
     List<EntityTypeColumn> columns  = entityType
       .getColumns()
       .stream()
@@ -96,7 +99,9 @@ public EntityType getEntityTypeDefinition(UUID entityTypeId, boolean includeHidd
         .sorted(nullsLast(comparing(Field::getLabelAlias, String.CASE_INSENSITIVE_ORDER)))
         .toList();
     }
-    return entityType.columns(columns);
+    return entityType
+      .columns(columns)
+      .crossTenantQueriesEnabled(crossTenantEnabled);
   }
 
   /**

diff --git a/src/main/java/org/folio/fqm/service/UserTenantService.java b/src/main/java/org/folio/fqm/service/UserTenantService.java
@@ -0,0 +1,26 @@
+package org.folio.fqm.service;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+import org.folio.fqm.client.SimpleHttpClient;
+import org.springframework.cache.annotation.Cacheable;
+import org.springframework.stereotype.Service;
+
+import java.util.Map;
+
+/**
+ * Service wrapper for caching responses from user-tenants API.
+ */
+@Service
+@RequiredArgsConstructor
+@Log4j2
+public class UserTenantService {
+
+  private final SimpleHttpClient userTenantsClient;
+
+  @Cacheable(value="userTenantCache", key="#tenantId")
+  public String getUserTenantsResponse(String tenantId) {
+    log.info("Retrieving user-tenants information for tenant {}", tenantId);
+    return userTenantsClient.get("user-tenants", Map.of("limit", String.valueOf(1)));
+  }
+}
diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -75,6 +75,7 @@ coffee-boots:
   cache:
     spec:
       queryCache: maximumSize=500,expireAfterWrite=1m
+      userTenantCache: maximumSize=100,expireAfterWrite=5h
 folio:
   is-eureka: false
   tenant:

diff --git a/src/main/resources/swagger.api/schemas/EntityTypeSummary.json b/src/main/resources/swagger.api/schemas/EntityTypeSummary.json
@@ -12,6 +12,11 @@
       "description": "Entity type label",
       "type": "string"
     },
+    "crossTenantQueriesEnabled": {
+      "description": "Indicates if this entity type supports cross-tenant queries",
+      "type": "boolean",
+      "default": false
+    },
     "missingPermissions": {
       "description": "List of missing permissions",
       "type": "array",

diff --git a/src/test/java/org/folio/fqm/service/CrossTenantQueryServiceTest.java b/src/test/java/org/folio/fqm/service/CrossTenantQueryServiceTest.java
@@ -35,6 +35,9 @@ class CrossTenantQueryServiceTest {
   @Mock
   private PermissionsService permissionsService;
 
+  @Mock
+  private UserTenantService userTenantService;
+
   @InjectMocks
   private CrossTenantQueryService crossTenantQueryService;
 
@@ -59,17 +62,20 @@ class CrossTenantQueryServiceTest {
               {
                   "id": "06192681-0df7-4f33-a38f-48e017648d69",
                   "userId": "a5e7895f-503c-4335-8828-f507bc8d1c45",
-                  "tenantId": "tenant_01"
+                  "tenantId": "tenant_01",
+                  "centralTenantId": "tenant_01"
               },
               {
                   "id": "3c1bfbe9-7d64-41fe-a358-cdaced6a631f",
                   "userId": "a5e7895f-503c-4335-8828-f507bc8d1c45",
-                  "tenantId": "tenant_02"
+                  "tenantId": "tenant_02",
+                  "centralTenantId": "tenant_01"
               },
               {
                   "id": "b167837a-ecdd-482b-b5d3-79a391a1dbf1",
                   "userId": "a5e7895f-503c-4335-8828-f507bc8d1c45",
                   "tenantId": "tenant_03",
+                  "centralTenantId": "tenant_01"
               }
           ]
       }
@@ -93,7 +99,7 @@ void shouldGetListOfTenantsToQuery() {
     List<String> expectedTenants = List.of("tenant_01", "tenant_02", "tenant_03");
 
     when(executionContext.getTenantId()).thenReturn(tenantId);
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO);
     when(ecsClient.get(eq("consortia/bdaa4720-5e11-4632-bc10-d4455cf252df/user-tenants"), anyMap())).thenReturn(USER_TENANT_JSON);
 
     List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(entityType, false);
@@ -112,18 +118,20 @@ void shouldRunIntraTenantQueryForNonInstanceEntityTypes() {
 
   @Test
   void shouldRunIntraTenantQueryForNonCentralTenant() {
-    List<String> expectedTenants = List.of("tenant_02");
-    when(executionContext.getTenantId()).thenReturn("tenant_02"); // Central is tenant_01
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO);
+    String tenantId = "tenant_02";
+    List<String> expectedTenants = List.of(tenantId);
+    when(executionContext.getTenantId()).thenReturn(tenantId); // Central is tenant_01
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO);
     List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(entityType, false);
     assertEquals(expectedTenants, actualTenants);
   }
 
   @Test
   void shouldRunIntraTenantQueryIfExceptionIsThrown() {
-    List<String> expectedTenants = List.of("tenant_01");
-    when(executionContext.getTenantId()).thenReturn("tenant_01");
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
+    String tenantId = "tenant_01";
+    List<String> expectedTenants = List.of(tenantId);
+    when(executionContext.getTenantId()).thenReturn(tenantId);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
     List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(entityType, false);
     assertEquals(expectedTenants, actualTenants);
   }
@@ -134,19 +142,32 @@ void shouldReturnTenantIdOnlyIfUserTenantsApiThrowsException() {
     List<String> expectedTenants = List.of("tenant_01");
 
     when(executionContext.getTenantId()).thenReturn(tenantId);
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
 
     List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(entityType, false);
     assertEquals(expectedTenants, actualTenants);
   }
 
+  @Test
+  void shouldAttemptCrossTenantQueryIfForceParamIsTrue() {
+    String tenantId = "tenant_01";
+    List<String> expectedTenants = List.of("tenant_01");
+
+    when(executionContext.getTenantId()).thenReturn(tenantId);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
+
+    List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(entityType, true);
+    verify(userTenantService, times(1)).getUserTenantsResponse(tenantId);
+    assertEquals(expectedTenants, actualTenants);
+  }
+
   @Test
   void shouldNotQueryTenantIfUserLacksTenantPermissions() {
     String tenantId = "tenant_01";
     List<String> expectedTenants = List.of("tenant_01", "tenant_02");
 
     when(executionContext.getTenantId()).thenReturn(tenantId);
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO);
     when(ecsClient.get(eq("consortia/bdaa4720-5e11-4632-bc10-d4455cf252df/user-tenants"), anyMap())).thenReturn(USER_TENANT_JSON);
     doNothing().when(permissionsService).verifyUserHasNecessaryPermissions("tenant_02", entityType, true);
     doThrow(MissingPermissionsException.class).when(permissionsService).verifyUserHasNecessaryPermissions("tenant_03", entityType, true);
@@ -163,23 +184,34 @@ void shouldQueryCentralTenantForSharedCompositeInstances() {
       .crossTenantQueriesEnabled(true);
 
     when(executionContext.getTenantId()).thenReturn(tenantId);
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO);
 
     List<String> actualTenants = crossTenantQueryService.getTenantsToQuery(instanceEntityType, false);
     assertEquals(expectedTenants, actualTenants);
   }
 
   @Test
   void shouldGetCentralTenantId() {
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO);
     String expectedId = "tenant_01";
+    when(executionContext.getTenantId()).thenReturn(expectedId);
+    when(userTenantService.getUserTenantsResponse(expectedId)).thenReturn(ECS_TENANT_INFO);
     String actualId = crossTenantQueryService.getCentralTenantId();
     assertEquals(expectedId, actualId);
   }
 
   @Test
   void shouldHandleErrorWhenGettingCentralTenantId() {
-    when(ecsClient.get(eq("user-tenants"), anyMap())).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
+    String tenantId = "tenant_01";
+    when(executionContext.getTenantId()).thenReturn(tenantId);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(ECS_TENANT_INFO_FOR_NON_ECS_ENV);
     assertNull(crossTenantQueryService.getCentralTenantId());
   }
+
+  @Test
+  void testIsCentralTenant() {
+    String tenantId = "tenant_01";
+    when(executionContext.getTenantId()).thenReturn(tenantId);
+    when(userTenantService.getUserTenantsResponse(tenantId)).thenReturn(USER_TENANT_JSON);
+    assertTrue(crossTenantQueryService.isCentralTenant());
+  }
 }