SIP2-300: Always use root locale for currency values (#262)

Author: pfilippov-epam

README.md

@@ -63,7 +63,6 @@ FOLIO results for all supported (TBD) SIP2 commands.
 | Env Property                            | System Property                     | Required | Default Value  | Description                                                                                                                                                                                                                                                                                  |
 |-----------------------------------------|-------------------------------------|----------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `HEALTH_CHECK_PORT_ENV_VAR`             | `healthCheckPort`                   | -        | 8081           | Health check port                                                                                                                                                                                                                                                                            | 
-| `SIP2_TEMPLATE_LOCALE`                  | `templateLocale`                    | -        | root           | Locale being used for freemarker template processing. The root locale is the locale whose language, country, and variant are empty ("") strings. This is regarded as the base locale of all locales, and is used as the language/country neutral locale for the locale sensitive operations. |
 | `SIP2_TENANT_RESOLVERS`                 | `sip2TenantResolvers`               | -        | PORT,IP_SUBNET | Approach for tenant resolution during connect/login operations                                                                                                                                                                                                                               |
 | `SIP2_TENANT_USERNAME_PREFIX_DELIMITER` | `sip2TenantUsernamePrefixDelimiter` | -        | _              | Delimiter used for tenant resolution based on username prefix.                                                                                                                                                                                                                               |
 
@@ -121,7 +120,8 @@ command line arguments to point it to the right path (e.g. `-conf /path/to/confi
 | `optional`                     | boolean     | If a failure is caught while loading the tenant configuration from an optional store, the failure is logged, but the processing does not fail. Instead, the tenant configuration will be empty. |
 | `netServerOptions`             | JSON object | Configuration options for the server. These are Vertx options and are numerous. See: [NetServerOptions](https://vertx.io/docs/apidocs/io/vertx/core/net/NetServerOptions.html).                 |
 | `token_cache_capacity`         | int         | Max token cache size. Default size is 100.                                                                                                                                                      |
-Note: edge-sip2 now requires two config files: the main bootstrap sip2.conf and tenant configuration: sip2-tenants.conf. The additional config file is required to support multi-tenants and runtime reloading of tenant configuration without restarting the edge-sip2 module.
+
+> **Note:** `edge-sip2` now requires two config files: the main bootstrap sip2.conf and tenant configuration: sip2-tenants.conf. The additional config file is required to support multi-tenants and runtime reloading of tenant configuration without restarting the edge-sip2 module.
  
 Here is a sample sip2-tenants.conf file:
 ```json

pom.xml

@@ -428,6 +428,8 @@
         </configuration>
         <executions>
           <execution>
+            <id>verify-style</id>
+            <phase>process-classes</phase>
             <goals>
               <goal>check</goal>
             </goals>

src/main/java/org/folio/edge/sip2/domain/messages/PatronAccountInfo.java

@@ -5,9 +5,9 @@
 public class PatronAccountInfo {
   private String id;
   private String feeFineType;
-  private Double feeFineAmount;
-  private Double feeFineRemaining;
-  private Double feeFinePaid;
+  private String feeFineAmount;
+  private String feeFineRemaining;
+  private String feeFinePaid;
   private String itemBarcode;
   private OffsetDateTime feeCreationDate;
   private String feeFineId;
@@ -46,19 +46,19 @@ public void setFeeFineType(String feeFineType) {
     this.feeFineType = feeFineType;
   }
 
-  public Double getFeeFineAmount() {
+  public String getFeeFineAmount() {
     return feeFineAmount;
   }
 
-  public Double getFeeFineRemaining() {
+  public String getFeeFineRemaining() {
     return feeFineRemaining;
   }
 
-  public void setFeeFineAmount(Double feeFineAmount) {
+  public void setFeeFineAmount(String feeFineAmount) {
     this.feeFineAmount = feeFineAmount;
   }
 
-  public void setFeeFineRemaining(Double feeFineRemaining) {
+  public void setFeeFineRemaining(String feeFineRemaining) {
     this.feeFineRemaining = feeFineRemaining;
   }
 
@@ -86,11 +86,11 @@ public void setFeeDescription(String feeDescription) {
     this.feeDescription = feeDescription;
   }
 
-  public Double getFeeFinePaid() {
+  public String getFeeFinePaid() {
     return feeFinePaid;
   }
 
-  public void setFeeFinePaid(Double feeFinePaid) {
+  public void setFeeFinePaid(String feeFinePaid) {
     this.feeFinePaid = feeFinePaid;
   }
 }

src/main/java/org/folio/edge/sip2/handlers/freemarker/FreemarkerRepository.java

@@ -14,25 +14,20 @@
 import static org.folio.edge.sip2.parser.Command.RENEW_RESPONSE;
 import static org.folio.edge.sip2.parser.Command.REQUEST_SC_RESEND;
 import static org.folio.edge.sip2.parser.Command.SC_STATUS;
-import static org.folio.edge.sip2.utils.Utils.getEnvOrDefault;
 
 import freemarker.template.Configuration;
 import freemarker.template.Template;
 import freemarker.template.TemplateExceptionHandler;
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
 import java.util.EnumMap;
-import java.util.IllformedLocaleException;
 import java.util.Locale;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.folio.edge.sip2.parser.Command;
 
 public class FreemarkerRepository {
 
-  private static final String SIP2_LOCALE_PROPERTY = "sip2TemplateLocale";
-  private static final String SIP2_LOCALE_ENV_VAR = "SIP2_TEMPLATE_LOCALE";
-
   private EnumMap<Command, Template> templates;
   private final Logger log;
 
@@ -66,9 +61,6 @@ private void initializeTemplates() {
     configuration.setLogTemplateExceptions(false);
     configuration.setWrapUncheckedExceptions(true);
 
-    configuration.setLocale(getEnvOrDefault(
-        SIP2_LOCALE_PROPERTY, SIP2_LOCALE_ENV_VAR, ROOT, this::parseLocale));
-
     addTemplate(CHECKOUT_RESPONSE, "CheckoutResponse.ftl", configuration);
     addTemplate(CHECKIN_RESPONSE, "CheckinResponse.ftl", configuration);
     addTemplate(ACS_STATUS, "acs-status.ftl", configuration);
@@ -82,22 +74,9 @@ private void initializeTemplates() {
     addTemplate(RENEW_ALL_RESPONSE, "RenewAllResponse.ftl", configuration);
     addTemplate(FEE_PAID_RESPONSE, "FeePaidResponse.ftl", configuration);
     addTemplate(SC_STATUS, "acs-status.ftl", configuration);
-
-  }
-
-  private Locale parseLocale(String tag) {
-    try {
-      var locale = new Locale.Builder().setLanguageTag(tag).build();
-      log.info("parseLocale:: Freemarker locale: {}", locale);
-      return locale;
-    } catch (IllformedLocaleException e) {
-      log.warn("Invalid locale tag '{}', falling back to locale: root", tag);
-      return ROOT;
-    }
   }
 
   private void addTemplate(Command command, String templateName, Configuration configuration) {
-
     Template template;
 
     try {

src/main/java/org/folio/edge/sip2/repositories/FeeFinesRepository.java

@@ -2,6 +2,7 @@
 
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
+import static org.folio.edge.sip2.utils.Utils.getCurrencyValue;
 
 import io.vertx.core.Future;
 import io.vertx.core.json.JsonArray;
@@ -48,7 +49,6 @@ public class FeeFinesRepository {
   private final UsersRepository usersRepository;
   private Clock clock;
 
-
   @Inject
   FeeFinesRepository(IResourceProvider<IRequestData> resourceProvider,
       UsersRepository usersRepository,
@@ -92,9 +92,6 @@ public Future<JsonObject> getManualBlocksByUserId(
         .map(IResource::getResource);
   }
 
-
-
-
   /**
    * Get a patron's total fee amount.
    *
@@ -121,7 +118,6 @@ public Future<JsonObject> getFeeAmountByUserId(
         .map(IResource::getResource);
   }
 
-
   /**
    * Get a patron's account.
    *
@@ -509,7 +505,7 @@ public Future<FeePaidResponse> performFeePaidCommand(FeePaid feePaid, SessionDat
                 patronAccountInfo.setId(accountJson.getString("id"));
                 patronAccountInfo.setItemBarcode(accountJson.getString("barcode"));
                 patronAccountInfo.setFeeFineId(accountJson.getString("feeFineId"));
-                patronAccountInfo.setFeeFineAmount(accountJson.getDouble("amount"));
+                patronAccountInfo.setFeeFineAmount(getCurrencyValue(accountJson, "amount"));
                 String accountDate = getDateFromAccountJson(accountJson);
                 patronAccountInfo.setFeeCreationDate(accountDate != null
                     ? OffsetDateTime.parse(accountDate) : null);
@@ -621,8 +617,8 @@ private void updatePatronAccountInfoList(List<PatronAccountInfo> patronAccountIn
         String accountId = actionJson.getString("accountId");
         for (PatronAccountInfo patronAccountInfo : patronAccountInfoList) {
           if (patronAccountInfo.getId().equals(accountId)) {
-            patronAccountInfo.setFeeFineRemaining(actionJson.getDouble("balance"));
-            patronAccountInfo.setFeeFinePaid(actionJson.getDouble("amountAction"));
+            patronAccountInfo.setFeeFineRemaining(getCurrencyValue(actionJson, "balance"));
+            patronAccountInfo.setFeeFinePaid(getCurrencyValue(actionJson, "amountAction"));
             break;
           }
         }

src/main/java/org/folio/edge/sip2/repositories/PatronRepository.java

@@ -22,20 +22,22 @@
 import static org.folio.edge.sip2.domain.messages.enumerations.Summary.UNAVAILABLE_HOLDS;
 import static org.folio.edge.sip2.utils.JsonUtils.getChildString;
 import static org.folio.edge.sip2.utils.Utils.DEFAULT_USER_LOANS_LIMIT;
+import static org.folio.edge.sip2.utils.Utils.getCurrencyValue;
 
 import io.vertx.core.Future;
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
 import jakarta.inject.Inject;
 import java.math.BigDecimal;
-import java.math.MathContext;
+import java.math.RoundingMode;
 import java.time.Clock;
 import java.time.OffsetDateTime;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.Predicate;
@@ -432,12 +434,11 @@ private PatronInformationResponseBuilder populateFinesCount(JsonObject accounts,
   private PatronInformationResponseBuilder totalAmount(
       SessionData sessionData, JsonObject jo,
       PatronInformationResponseBuilder builder) {
-    Float total;
     if (jo != null) {
       final JsonArray arr = jo.getJsonArray(FIELD_ACCOUNTS);
-      total = getTotalRemaining(arr);
+      String total = getTotalRemaining(arr);
       log.debug(sessionData, "Total is {}", total);
-      return builder.feeAmount(total.toString());
+      return builder.feeAmount(total);
     }
     return null;
   }
@@ -447,19 +448,19 @@ private PatronStatusResponseBuilder totalAmount(
       PatronStatusResponseBuilder builder) {
 
     final JsonArray arr = jo.getJsonArray(FIELD_ACCOUNTS);
-    Float total = getTotalRemaining(arr);
+    String total = getTotalRemaining(arr);
     log.debug(sessionData, "Total is {}", total);
-    return builder.feeAmount(total.toString());
+    return builder.feeAmount(total);
   }
 
-  protected static Float getTotalRemaining(JsonArray accounts) {
+  protected static String getTotalRemaining(JsonArray accounts) {
     BigDecimal total = BigDecimal.ZERO;
     for (int i = 0; i < accounts.size(); i++) {
       BigDecimal bdValue = BigDecimal.valueOf(accounts.getJsonObject(i)
           .getFloat(FIELD_REMAINING));
       total = total.add(bdValue);
     }
-    return total.round(MathContext.DECIMAL32).floatValue();
+    return total.setScale(2, RoundingMode.HALF_UP).toPlainString();
   }
 
 
@@ -861,10 +862,9 @@ private List<PatronAccountInfo> getPatronAccountList(
       if (!"Open".equalsIgnoreCase(status) || (feeFineRemaining != null && feeFineRemaining <= 0)) {
         continue;
       }
-      Double feeFineAmount = jo.getNumber("amount") != null
-          ? jo.getNumber("amount").doubleValue() : null;
-      patronAccount.setFeeFineAmount(feeFineAmount);
-      patronAccount.setFeeFineRemaining(feeFineRemaining);
+      patronAccount.setFeeFineAmount(getCurrencyValue(jo, "amount"));
+      patronAccount.setFeeFineRemaining(feeFineRemaining != null
+          ? String.format(Locale.ROOT, "%.2f", feeFineRemaining) : null);
       patronAccount.setItemBarcode(jo.getString(FIELD_BARCODE));
       patronAccount.setId(jo.getString("id"));
       patronAccount.setFeeFineId(jo.getString("feeFineId"));

src/main/java/org/folio/edge/sip2/session/SessionData.java

@@ -5,6 +5,7 @@
 import java.security.SecureRandom;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Locale;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import lombok.RequiredArgsConstructor;
@@ -136,6 +137,7 @@ private static String generateRequestId() {
     return format("%06d%s", random.nextInt(1000000), "/sip2");
   }
 
+
   /**
    * Sets the tenant for the session and logs the change.
    *

src/main/java/org/folio/edge/sip2/utils/Utils.java

@@ -1,5 +1,7 @@
 package org.folio.edge.sip2.utils;
 
+import static java.util.Locale.ROOT;
+
 import io.micrometer.common.util.StringUtils;
 import io.vertx.core.json.JsonObject;
 import java.time.OffsetDateTime;
@@ -84,6 +86,11 @@ public static OffsetDateTime convertDateTime(OffsetDateTime instance, String tim
     return OffsetDateTime.ofInstant(instance.toInstant(), ZoneId.of(timeZone));
   }
 
+  public static String getCurrencyValue(JsonObject actionJson, String field) {
+    var fieldValue = actionJson.getDouble(field);
+    return fieldValue != null ? String.format(ROOT, "%.2f", fieldValue) : null;
+  }
+
   /**
    * Constructs a query string given a list of KV pairs parameters
    * a delimeter, and an "equal" delimeter.

src/main/resources/templates/lib.ftl

@@ -683,7 +683,7 @@
 </#macro>
 
 <#macro feeRemaining value>
-  <@variableLengthCurrencyField id="FA" value=value/>
+  <@variableLengthField id="FA" value=value/>
 </#macro>
 
 <#macro accountItemIdentifier value>
@@ -707,7 +707,7 @@
 </#macro>
 
 <#macro feePaid value>
-  <@variableLengthCurrencyField id="FG" value=value/>
+  <@variableLengthField id="FG" value=value/>
 </#macro>
 
 <#macro pickupServicePoint value>

src/test/java/org/folio/edge/sip2/api/FeePaidIT.java

@@ -0,0 +1,62 @@
+package org.folio.edge.sip2.api;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.folio.edge.sip2.support.Sip2TestCommand.sip2Exchange;
+
+import java.util.UUID;
+import org.folio.edge.sip2.api.support.AbstractErrorDetectionEnabledTest;
+import org.folio.edge.sip2.domain.messages.enumerations.CurrencyType;
+import org.folio.edge.sip2.domain.messages.enumerations.FeeType;
+import org.folio.edge.sip2.domain.messages.enumerations.PaymentType;
+import org.folio.edge.sip2.support.model.FeePaidCommand;
+import org.folio.edge.sip2.support.model.Sip2Command;
+import org.folio.edge.sip2.support.response.FeePaidResponseParser;
+import org.folio.edge.sip2.support.tags.IntegrationTest;
+import org.folio.edge.sip2.support.wiremock.WiremockStubs;
+import org.junit.jupiter.api.Test;
+
+@IntegrationTest
+class FeePaidIT extends AbstractErrorDetectionEnabledTest {
+
+  private static final String TIMEZONE = "Europe/Paris";
+
+  @Test
+  @WiremockStubs({
+      "/wiremock/stubs/mod-settings/200-get-locale.json",
+      "/wiremock/stubs/mod-settings/200-get-settings.json",
+      "/wiremock/stubs/mod-login/201-post-acs-login.json",
+      "/wiremock/stubs/mod-users/200-get-user-by-patron-identifier.json",
+      "/wiremock/stubs/mod-users-bl/200-get-user-by-id.json",
+      "/wiremock/stubs/mod-fee-fines/200-get-accounts-open-status.json",
+      "/wiremock/stubs/mod-fee-fines/201-post(accounts-bulk-pay).json",
+  })
+  void payFee_positive() throws Throwable {
+    executeInSession(
+        successLoginExchange(),
+        sip2Exchange(
+            feePaidCommand(),
+            sip2Result -> {
+              assertThat(sip2Result).isNotNull();
+              assertSuccessfulExchange(sip2Result);
+
+              var respMsg = sip2Result.getResponseMessage();
+              var response = new FeePaidResponseParser(delimiter, TIMEZONE).parse(respMsg);
+              assertThat(response.getPaymentAccepted()).isTrue();
+              assertThat(respMsg).contains("FG7.50");
+              assertThat(respMsg).contains("FA17.50");
+            }
+        ));
+  }
+
+  private static Sip2Command feePaidCommand() {
+    return FeePaidCommand.builder()
+        .paymentType(PaymentType.VISA)
+        .feeType(FeeType.HOLD_FEE)
+        .currencyType(CurrencyType.USD)
+        .feeAmount(7.5f)
+        .institutionId(TENANT_ID)
+        .patronIdentifier(PATRON_BARCODE)
+        .transactionId(UUID.randomUUID().toString())
+        .build();
+  }
+}