MODFQMMGR-746 Add LocalClient

Author: mweaver-ebsco

src/main/java/org/folio/fqm/client/LocaleClient.java

@@ -0,0 +1,63 @@
+package org.folio.fqm.client;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import feign.FeignException;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.stereotype.Component;
+import org.springframework.web.bind.annotation.GetMapping;
+
+import java.time.DateTimeException;
+import java.time.ZoneId;
+
+/**
+ * Client for the /locale API.
+ *
+ * @implNote This is a separate class from the internal LocaleClientRaw interface because Feign clients must be interfaces, disallowing any injection.
+ */
+@Log4j2
+@Component
+@RequiredArgsConstructor(onConstructor_ = @Autowired)
+public class LocaleClient {
+
+  private final ObjectMapper objectMapper;
+  private final LocaleClientRaw underlyingClient;
+
+  /**
+   * Provides raw access to the /locale API.
+   */
+  @FeignClient(name = "locale")
+  interface LocaleClientRaw {
+    @GetMapping("/locale")
+    String getLocaleSettings();
+  }
+
+  public record LocaleSettings(
+    String locale,
+    String currency,
+    String timezone,
+    String numberingSystem
+  ) {
+    public ZoneId getZoneId() {
+      try {
+        return ZoneId.of(timezone);
+      } catch (DateTimeException e) {
+        log.error("Invalid timezone '{}', defaulting to UTC.", timezone, e);
+        return ZoneId.of("UTC");
+      }
+    }
+  }
+
+  public LocaleSettings getLocaleSettings() {
+    try {
+      String response = underlyingClient.getLocaleSettings();
+      return objectMapper.readValue(response, LocaleSettings.class);
+    } catch (JsonProcessingException | FeignException | NullPointerException e) {
+      log.error("Failed to retrieve locale information. Defaulting to en-US, USD, UTC, latn.", e);
+      return new LocaleSettings("en-US", "USD", "UTC", "latn");
+    }
+  }
+}

src/main/java/org/folio/fqm/client/SettingsClient.java

@@ -6,7 +6,7 @@
 import org.folio.fqm.client.ModesOfIssuanceClient;
 import org.folio.fqm.client.OrganizationsClient;
 import org.folio.fqm.client.PatronGroupsClient;
-import org.folio.fqm.client.SettingsClient;
+import org.folio.fqm.client.LocaleClient;
 import org.folio.fqm.migration.strategies.MigrationStrategy;
 import org.folio.fqm.migration.strategies.impl.V0POCMigration;
 import org.folio.fqm.migration.strategies.impl.V10OrganizationStatusValueChange;
@@ -42,7 +42,7 @@ public class MigrationStrategyRepository {
   private final List<MigrationStrategy> migrationStrategies;
 
   public MigrationStrategyRepository(
-    SettingsClient settingsClient,
+    LocaleClient localeClient,
     LocationsClient locationsClient,
     LocationUnitsClient locationUnitsClient,
     ModesOfIssuanceClient modesOfIssuanceClient,
@@ -57,7 +57,7 @@ public MigrationStrategyRepository(
         new V1ModeOfIssuanceConsolidation(),
         new V2ResourceTypeConsolidation(),
         new V3RamsonsFieldCleanup(),
-        new V4DateFieldTimezoneAddition(settingsClient),
+        new V4DateFieldTimezoneAddition(localeClient),
         new V5UUIDNotEqualOperatorRemoval(),
         new V6ModeOfIssuanceValueChange(modesOfIssuanceClient),
         new V7PatronGroupsValueChange(patronGroupsClient),

src/main/java/org/folio/fqm/client/SettingsClientRaw.java

@@ -8,7 +8,7 @@
 import java.util.function.Supplier;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
-import org.folio.fqm.client.SettingsClient;
+import org.folio.fqm.client.LocaleClient;
 import org.folio.fqm.migration.MigrationUtils;
 import org.folio.fqm.migration.strategies.AbstractRegularMigrationStrategy;
 import org.folio.fqm.migration.types.MigratableFqlFieldAndCondition;
@@ -86,7 +86,7 @@ public String getMaximumApplicableVersion() {
     "users.user_updated_date"
   );
 
-  private final SettingsClient settingsClient;
+  private final LocaleClient localeClient;
 
   @Override
   public String getLabel() {
@@ -113,7 +113,7 @@ public SingleFieldMigrationResult<MigratableFqlFieldAndCondition> migrateFql(
         }
 
         if (state.get() == null) {
-          state.set(settingsClient.getTenantTimezone());
+          state.set(localeClient.getLocaleSettings().getZoneId());
         }
 
         try {

src/main/java/org/folio/fqm/migration/MigrationStrategyRepository.java

@@ -1,11 +1,10 @@
 package org.folio.fqm.repository;
 
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.jayway.jsonpath.DocumentContext;
 import com.jayway.jsonpath.JsonPath;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
+import org.folio.fqm.client.LocaleClient;
 import org.folio.fqm.client.SimpleHttpClient;
 import org.folio.fqm.service.SourceViewService;
 import org.jooq.DSLContext;
@@ -31,7 +30,6 @@ public class DataRefreshRepository {
   public static final Field<Double> EXCHANGE_RATE_FIELD = field("exchange_rate", Double.class);
   public static final String EXCHANGE_RATE_TABLE = "currency_exchange_rates";
   private static final String GET_EXCHANGE_RATE_PATH = "finance/exchange-rate";
-  private static final String GET_LOCALE_SETTINGS_PATH = "locale";
 
   private static final List<String> SYSTEM_SUPPORTED_CURRENCIES = List.of(
     "USD",
@@ -72,6 +70,7 @@ public class DataRefreshRepository {
   private final DSLContext jooqContext;
   private final SourceViewService sourceViewService;
   private final SimpleHttpClient simpleHttpClient;
+  private final LocaleClient localeClient;
 
   /**
    * Refresh the currency exchange rates for a tenant, based on the tenant's default system currency.
@@ -116,17 +115,7 @@ public boolean refreshExchangeRates(String tenantId) {
 
   private String getSystemCurrencyCode() {
     log.info("Getting system currency");
-    try {
-      String localeSettingsResponse = simpleHttpClient.get(GET_LOCALE_SETTINGS_PATH, Map.of());
-      ObjectMapper objectMapper = new ObjectMapper();
-      JsonNode localeSettingsNode = objectMapper.readTree(localeSettingsResponse);
-      return localeSettingsNode
-        .path("currency")
-        .asText();
-    } catch (Exception e) {
-      log.info("No system currency defined, defaulting to USD");
-      return "USD";
-    }
+    return localeClient.getLocaleSettings().currency();
   }
 
   private Double getExchangeRate(String fromCurrency, String toCurrency) {

src/main/java/org/folio/fqm/migration/strategies/impl/V4DateFieldTimezoneAddition.java

@@ -17,7 +17,7 @@
 import org.folio.fql.service.FqlValidationService;
 import org.folio.fqm.client.CrossTenantHttpClient;
 import org.folio.fqm.client.LanguageClient;
-import org.folio.fqm.client.SimpleHttpClient;
+import org.folio.fqm.client.LocaleClient;
 import org.folio.fqm.domain.dto.EntityTypeSummary;
 import org.folio.fqm.exception.EntityTypeInUseException;
 import org.folio.fqm.exception.EntityTypeNotFoundException;
@@ -78,7 +78,6 @@ public class EntityTypeService {
 
   private static final int COLUMN_VALUE_DEFAULT_PAGE_SIZE = 1000;
   private static final String LANGUAGES_FILEPATH = "languages.json5";
-  private static final String GET_LOCALE_SETTINGS_PATH = "locale";
   private static final List<String> EXCLUDED_CURRENCY_CODES = List.of(
     "XUA", "AYM", "AFA", "ADP", "ATS", "AZM", "BYB", "BYR", "BEF", "BOV", "BGL", "CLF", "COU", "CUC", "CYP", "NLG", "EEK", "XBA", "XBB",
     "XBC", "XBD", "FIM", "FRF", "XFO", "XFU", "GHC", "DEM", "XAU", "GRD", "GWP", "IEP", "ITL", "LVL", "LTL", "LUF", "MGF", "MTL", "MRO", "MXV",
@@ -99,7 +98,7 @@ public class EntityTypeService {
   private final LanguageClient languageClient;
   private final FolioExecutionContext folioExecutionContext;
   private final ClockService clockService;
-  private final SimpleHttpClient simpleHttpClient;
+  private final LocaleClient localeClient;
   private final TranslationService translationService;
 
   /**
@@ -392,10 +391,7 @@ private ColumnValues getLanguages(String searchText, List<String> tenantsToQuery
 
     Locale folioLocale;
     try {
-      String localeSettingsResponse = simpleHttpClient.get(GET_LOCALE_SETTINGS_PATH, Map.of());
-      ObjectMapper objectMapper = new ObjectMapper();
-      JsonNode localeSettingsNode = objectMapper.readTree(localeSettingsResponse);
-      String localeString = localeSettingsNode.path("locale").asText();
+      String localeString = localeClient.getLocaleSettings().locale();
       folioLocale = new Locale(localeString.substring(0, 2)); // Java locales are in form xx, FOLIO stores locales as xx-YY
     } catch (Exception e) {
       log.debug("No default locale defined. Defaulting to English for language translations.");

src/main/java/org/folio/fqm/repository/DataRefreshRepository.java

@@ -6,7 +6,7 @@
 import lombok.extern.log4j.Log4j2;
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.lang3.StringUtils;
-import org.folio.fqm.client.SettingsClient;
+import org.folio.fqm.client.LocaleClient;
 import org.folio.fqm.repository.ResultSetRepository;
 import org.folio.fqm.utils.EntityTypeUtils;
 import org.folio.querytool.domain.dto.EntityType;
@@ -49,7 +49,7 @@ public class ResultSetService {
 
   private final ResultSetRepository resultSetRepository;
   private final EntityTypeFlatteningService entityTypeFlatteningService;
-  private final SettingsClient settingsClient;
+  private final LocaleClient localeClient;
   private final FolioExecutionContext executionContext;
   private final TranslationService translationService;
 
@@ -75,7 +75,7 @@ private List<Map<String, Object>> getSortedContents(UUID entityTypeId, List<List
       );
 
     List<String> dateFields = localize ? EntityTypeUtils.getDateTimeFields(entityType) : List.of();
-    ZoneId tenantTimezone = localize ? settingsClient.getTenantTimezone() : null;
+    ZoneId tenantTimezone = localize ? localeClient.getLocaleSettings().getZoneId() : null;
     List<String> countryFields = EntityTypeUtils.getCountryLocalizationFieldPaths(entityType);
 
     return contentIds

src/main/java/org/folio/fqm/service/EntityTypeService.java

@@ -0,0 +1,63 @@
+package org.folio.fqm.client;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import feign.FeignException;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Spy;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+@ExtendWith(MockitoExtension.class)
+class LocaleClientTest {
+
+  private static final String LOCALE_JSON =
+    """
+    {
+      "locale": "en-US",
+      "currency": "USD",
+      "timezone": "America/New_York",
+      "numberingSystem": "latn"
+    }
+    """;
+
+  @InjectMocks
+  private LocaleClient localeClient;
+
+  @Mock
+  private LocaleClient.LocaleClientRaw underlyingClient;
+
+  @Spy
+  private ObjectMapper objectMapper = new ObjectMapper();
+
+  @Test
+  void testGetLocaleSettingsWhenPresent() {
+    when(underlyingClient.getLocaleSettings()).thenReturn(LOCALE_JSON);
+
+    LocaleClient.LocaleSettings expected = new LocaleClient.LocaleSettings("en-US", "USD", "America/New_York", "latn");
+    assertThat(localeClient.getLocaleSettings(), is(expected));
+  }
+
+  @Test
+  void testGetLocaleSettingsHandlesException() {
+    when(underlyingClient.getLocaleSettings())
+      .thenThrow(new FeignException.Unauthorized("", mock(feign.Request.class), null, null));
+
+    LocaleClient.LocaleSettings expectedDefault = new LocaleClient.LocaleSettings("en-US", "USD", "UTC", "latn");
+    assertThat(localeClient.getLocaleSettings(), is(expectedDefault));
+  }
+
+  @Test
+  void testGetLocaleSettingsHandlesInvalidJson() {
+    when(underlyingClient.getLocaleSettings()).thenReturn("invalid json");
+
+    LocaleClient.LocaleSettings expectedDefault = new LocaleClient.LocaleSettings("en-US", "USD", "UTC", "latn");
+    assertThat(localeClient.getLocaleSettings(), is(expectedDefault));
+  }
+}